ฉันจะเรียกเมธอดตัวช่วยควบคุม / มุมมองจากคอนโซลใน Ruby on Rails ได้อย่างไร


442

เมื่อฉันโหลดscript/consoleบางครั้งฉันต้องการเล่นกับเอาต์พุตของคอนโทรลเลอร์หรือเมธอดตัวช่วยดู

มีวิธีการ:

  • จำลองคำขอหรือไม่
  • วิธีการโทรจากอินสแตนซ์ของตัวควบคุมตามคำขอดังกล่าวหรือไม่
  • วิธีทดสอบผู้ช่วยไม่ว่าจะผ่านอินสแตนซ์ของตัวควบคุมที่ระบุหรืออีกวิธีหนึ่ง

คำตอบ:


479

ในการโทรหาผู้ช่วยเหลือให้ใช้helperวัตถุ:

$ ./script/console
>> helper.number_to_currency('123.45')
=> "R$ 123,45"

หากคุณต้องการใช้ตัวช่วยที่ไม่รวมอยู่ในค่าเริ่มต้น (พูดเพราะคุณลบออกhelper :allจากApplicationController) เพียงแค่รวมตัวช่วย

>> include BogusHelper
>> helper.bogus
=> "bogus output"

สำหรับการจัดการกับคอนโทรลเลอร์ฉันขออ้างอิงคำตอบของ Nick :

> app.get '/posts/1'
> response = app.response
# you now have a rails response object much like the integration tests

> response.body            # get you the HTML
> response.cookies         # hash of the cookies

# etc, etc

4
ฉันสังเกตว่าฉันไม่สามารถดำเนินการมากกว่าหนึ่งapp.get(ข้อผิดพลาดของเธรด ensues) มีวิธีที่ฉันสามารถล้างระบบและดำเนินการเพิ่มเติมได้หรือไม่
JellicleCat

2
หมายเหตุใน Rails 3.2 ไม่สามารถใช้งานได้ ฉันต้องการโทรurl_forจากคอนโซล เมื่อต้องการทำสิ่งนี้ฉันทำapp.url_for(...)
Raphael

1
สำหรับNoMethodError: undefined method `protect_against_forgery?' for nil:NilClassกำหนดฟังก์ชั่นที่เรียกว่าprotect_against_forgery?ภายในคอนโซลที่ส่งคืนfalse
Sida Zhou

ฉันจะตั้งค่าผู้ใช้ที่เข้าสู่ระบบในปัจจุบันได้อย่างไร?

1
@RudolfOlah ดูเหมือนว่าถ้าคุณกำลังใช้อุปกรณ์ (หรือผู้คุม) ActionDispatch::Integration::Session.include(Warden::Test::Helpers); Warden.test_mode! ; app.login_as(User.find(1), scope: :user)คุณสามารถทำมันได้ด้วย
eloyesp

148

วิธีที่ง่ายในการเรียกการดำเนินการควบคุมจากสคริปต์ / คอนโซลและดู / จัดการกับวัตถุการตอบสนองคือ:

> app.get '/posts/1'
> response = app.response
# You now have a Ruby on Rails response object much like the integration tests

> response.body            # Get you the HTML
> response.cookies         # Hash of the cookies

# etc., etc.

วัตถุของแอพเป็นตัวอย่างของActionController :: Integration :: Session

สิ่งนี้ใช้ได้กับฉันโดยใช้ Ruby on Rails 2.1 และ 2.3 และฉันไม่ได้ลองรุ่นก่อนหน้านี้


2
ลิงก์ไปยังเอกสารอย่างเป็นทางการเกี่ยวกับวัตถุของแอปจะดี
RajaRaviVarma

เป็นตัวอย่างของ ActionController :: Integration :: Session class ฉันได้อัปเดตคำตอบเพื่อรวมที่
นิค

ความคิดที่ดี. ฉันไม่ได้คิดถึงเรื่องนี้
Marnen Laibow-Koser

5
ฉันจะรับรองความถูกต้องของคอนโซลได้อย่างไรเพื่อให้ฉันสามารถตรวจสอบคอนโทรลเลอร์ที่ต้องมีการตรวจสอบสิทธิ์ได้
Mild Fuzz

7
คุณควรโพสต์ไปที่หน้าเข้าสู่ระบบของคุณเช่น: app.post '/ session / new', {: ชื่อผู้ใช้ => "foo",: password => "pass"} จากนั้นใช้ตัวแปร "แอป" ต่อไปเพื่อรับหน้าเว็บหลังจากนั้น
Nick

108

หากคุณต้องการทดสอบจากคอนโซล (ทดสอบกับ Ruby on Rails 3.1 และ 4.1):

การดำเนินการควบคุมการโทร:

app.get '/'
   app.response
   app.response.headers  # => { "Content-Type"=>"text/html", ... }
   app.response.body     # => "<!DOCTYPE html>\n<html>\n\n<head>\n..."

ApplicationController วิธีการ:

foo = ActionController::Base::ApplicationController.new
foo.public_methods(true||false).sort
foo.some_method

ผู้ช่วยเส้นทาง:

app.myresource_path     # => "/myresource"
app.myresource_url      # => "http://www.example.com/myresource"

ดูผู้ช่วยเหลือ:

foo = ActionView::Base.new

foo.javascript_include_tag 'myscript' #=> "<script src=\"/javascripts/myscript.js\"></script>"

helper.link_to "foo", "bar" #=> "<a href=\"bar\">foo</a>"

ActionController::Base.helpers.image_tag('logo.png')  #=> "<img alt=\"Logo\" src=\"/images/logo.png\" />"

Render:

views = Rails::Application::Configuration.new(Rails.root).paths["app/views"]
views_helper = ActionView::Base.new views
views_helper.render 'myview/mytemplate'
views_helper.render file: 'myview/_mypartial', locals: {my_var: "display:block;"}
views_helper.assets_prefix  #=> '/assets'

วิธีการ ActiveSupport:

require 'active_support/all'
1.week.ago
=> 2013-08-31 10:07:26 -0300
a = {'a'=>123}
a.symbolize_keys
=> {:a=>123}

โมดูล Lib:

> require 'my_utils'
 => true
> include MyUtils
 => Object
> MyUtils.say "hi"
evaluate: hi
 => true

1
สิ่งนี้จะช่วยเมื่อคุณเขียนสคริปต์ ruby ​​อิสระที่จะรันโดยใช้ rails runner และพวกเขาจำเป็นต้องเรียกใช้เมธอดใน application controller ขอบคุณ
CodeExpress

@ CodeExpress ที่ไม่ควรเกิดขึ้น ให้วางเมธอดในเซอร์วิสอ็อบเจ็กต์และเรียกใช้เซอร์วิสจากทั้ง ApplicationController และสคริปต์ของคุณ
Marnen Laibow-Koser

77

นี่เป็นวิธีหนึ่งในการทำสิ่งนี้ผ่านคอนโซล:

>> foo = ActionView::Base.new
=> #<ActionView::Base:0x2aaab0ac2af8 @assigns_added=nil, @assigns={}, @helpers=#<ActionView::Base::ProxyModule:0x2aaab0ac2a58>, @controller=nil, @view_paths=[]>

>> foo.extend YourHelperModule
=> #<ActionView::Base:0x2aaab0ac2af8 @assigns_added=nil, @assigns={}, @helpers=#<ActionView::Base::ProxyModule:0x2aaab0ac2a58>, @controller=nil, @view_paths=[]>

>> foo.your_helper_method(args)
=> "<html>created by your helper</html>"

การสร้างอินสแตนซ์ใหม่ของActionView::Baseช่วยให้คุณเข้าถึงวิธีการดูปกติที่ผู้ช่วยของคุณใช้ จากนั้นขยายYourHelperModuleวิธีการผสมลงในวัตถุของคุณเพื่อให้คุณสามารถดูค่าที่ส่งคืนได้


15

หากวิธีการเป็นPOSTวิธีการแล้ว:

app.post 'controller/action?parameter1=value1&parameter2=value2'

(พารามิเตอร์ที่นี่จะเป็นไปตามการบังคับใช้ของคุณ)

ถ้ามันเป็นGETวิธีการแล้ว:

app.get 'controller/action'

1
และเพื่อค้นหาเส้นทางที่คุณต้องการapp.methods.grep(/_path/):)
Dorian

และก็ไม่ได้เสมอcontroler/actionขึ้นอยู่กับเส้นทางของคุณเช่นอาจจะมี/users/allและแผนที่เพื่อApi::UsersController#index:)
Dorian

@Dorian rake routesหรือ :)
Marnen Laibow-Koser

14

อีกวิธีในการทำเช่นนี้คือการใช้ดีบัก Ruby on Rails มีคู่มือ Ruby on Rails เกี่ยวกับการดีบักที่http://guides.rubyonrails.org/debugging_rails_applications.html

โดยทั่วไปให้สตาร์ทเซิร์ฟเวอร์ด้วยตัวเลือก -u:

./script/server -u

จากนั้นแทรกเบรกพอยต์ลงในสคริปต์ของคุณที่คุณต้องการเข้าถึงตัวควบคุมผู้ช่วย ฯลฯ

class EventsController < ApplicationController
  def index
    debugger
  end
end

และเมื่อคุณทำการร้องขอและกดส่วนนั้นในรหัสคอนโซลของเซิร์ฟเวอร์จะส่งคืนพร้อมท์ที่คุณสามารถทำการร้องขอดูวัตถุและอื่น ๆ จากพรอมต์คำสั่ง เมื่อเสร็จแล้วเพียงพิมพ์ 'ต่อ' เพื่อดำเนินการต่อ นอกจากนี้ยังมีตัวเลือกสำหรับการแก้ไขข้อบกพร่องเพิ่มเติม แต่อย่างน้อยคุณควรเริ่มต้น


3
> => ประกาศ: ตัวเลือกการดีบักเกอร์จะถูกละเว้นตั้งแต่ Ruby 2.0 และจะถูกลบในรุ่นอนาคต
bright-star

13

นี่คือวิธีสร้างคำขอ POST ที่ได้รับการรับรองความถูกต้องโดยใช้ Refinery เป็นตัวอย่าง:

# Start Rails console
rails console
# Get the login form
app.get '/community_members/sign_in'
# View the session
app.session.to_hash
# Copy the CSRF token "_csrf_token" and place it in the login request.
# Log in from the console to create a session
app.post '/community_members/login', {"authenticity_token"=>"gT7G17RNFaWUDLC6PJGapwHk/OEyYfI1V8yrlg0lHpM=",  "refinery_user[login]"=>'chloe', 'refinery_user[password]'=>'test'}
# View the session to verify CSRF token is the same
app.session.to_hash
# Copy the CSRF token "_csrf_token" and place it in the request. It's best to edit this in Notepad++
app.post '/refinery/blog/posts', {"authenticity_token"=>"gT7G17RNFaWUDLC6PJGapwHk/OEyYfI1V8yrlg0lHpM=", "switch_locale"=>"en", "post"=>{"title"=>"Test", "homepage"=>"0", "featured"=>"0", "magazine"=>"0", "refinery_category_ids"=>["1282"], "body"=>"Tests do a body good.", "custom_teaser"=>"", "draft"=>"0", "tag_list"=>"", "published_at(1i)"=>"2014", "published_at(2i)"=>"5", "published_at(3i)"=>"27", "published_at(4i)"=>"21", "published_at(5i)"=>"20", "custom_url"=>"", "source_url_title"=>"", "source_url"=>"", "user_id"=>"56", "browser_title"=>"", "meta_description"=>""}, "continue_editing"=>"false", "locale"=>:en}

คุณอาจพบว่ามีประโยชน์เช่นกันหากคุณได้รับข้อผิดพลาด:

app.cookies.to_hash
app.flash.to_hash
app.response # long, raw, HTML

2
NameError: undefined local variable or method app for main:Object
Kamil Lelonek

คุณต้องปิดการใช้งาน Forgery_protectionApplicationController.allow_forgery_protection = false
William Herry

ว้าวนั่นอาจจะง่ายกว่า สิ่งที่ฉันเขียนคือการป้องกันการปลอมแปลง คุณไม่จำเป็นต้องปิดการใช้งาน แต่ฉันแน่ใจว่าสะดวกกว่า!
Chloe

12

คุณสามารถเข้าถึงวิธีการของคุณในคอนโซล Ruby on Rails ดังนี้:

controller.method_name
helper.method_name


7

คำตอบก่อนหน้าคือเรียกผู้ช่วยเหลือ แต่ต่อไปนี้จะช่วยให้วิธีการโทรควบคุม ฉันเคยใช้สิ่งนี้กับ Ruby on Rails 2.3.2

ก่อนเพิ่มรหัสต่อไปนี้ไปยังไฟล์. irbrc ของคุณ (ซึ่งสามารถอยู่ในไดเรกทอรีบ้านของคุณ)

class Object
   def request(options = {})
     url=app.url_for(options)
     app.get(url)
     puts app.html_document.root.to_s
  end
end

จากนั้นในคอนโซล Ruby on Rails คุณสามารถพิมพ์สิ่งที่ต้องการ ...

request(:controller => :show, :action => :show_frontpage)

... และ HTML จะถูกเทไปยังคอนโซล


3

ภายในแอคชั่นหรือมุมมองคอนโทรลเลอร์คุณสามารถเรียกใช้คอนโซลได้โดยการเรียกใช้เมธอดคอนโซล

ตัวอย่างเช่นในคอนโทรลเลอร์:

class PostsController < ApplicationController
  def new
    console
    @post = Post.new
  end
end

หรือในมุมมอง:

<% console %>

<h2>New Post</h2>

สิ่งนี้จะสร้างคอนโซลภายในมุมมองของคุณ คุณไม่จำเป็นต้องสนใจตำแหน่งของการโทรคอนโซล มันจะไม่ถูกแสดงผลในจุดที่เรียกใช้ แต่ถัดจากเนื้อหา HTML ของคุณ

ดู: http://guides.rubyonrails.org/debugging_rails_applications.html


3

สำหรับคอนโทรลเลอร์คุณสามารถสร้างอินสแตนซ์ของออบเจ็กต์ควบคุมในคอนโซล Ruby on Rails

ตัวอย่างเช่น,

class CustomPagesController < ApplicationController

  def index
    @customs = CustomPage.all
  end

  def get_number
    puts "Got the Number"
  end

  protected

  def get_private_number
    puts 'Got private Number'
  end

end

custom = CustomPagesController.new
2.1.5 :011 > custom = CustomPagesController.new
 => #<CustomPagesController:0xb594f77c @_action_has_layout=true, @_routes=nil, @_headers={"Content-Type"=>"text/html"}, @_status=200, @_request=nil, @_response=nil>
2.1.5 :014 > custom.get_number
Got the Number
 => nil

# For calling private or protected methods,
2.1.5 :048 > custom.send(:get_private_number)
Got private Number
 => nil

มันได้ผล! แต่ฉันจะอัพเดทตัวแปรการกระทำได้อย่างไร เช่น def show response = @user.contributions end ฉันจะเขียนทับ@userตัวแปรได้อย่างไร?
FábioAraújo

2

วิธีหนึ่งที่เป็นไปได้สำหรับการทดสอบวิธี Helper ในคอนโซล Ruby on Rails คือ:

Struct.new(:t).extend(YourHelper).your_method(*arg)

และสำหรับการรีโหลดทำ:

reload!; Struct.new(:t).extend(YourHelper).your_method(*arg)

1

หากคุณเพิ่มผู้ช่วยของคุณเองและคุณต้องการให้วิธีการนั้นพร้อมใช้งานในคอนโซลให้ทำ:

  1. ในคอนโซลดำเนินการ include YourHelperName
  2. ขณะนี้วิธีการช่วยเหลือของคุณพร้อมใช้งานในคอนโซลแล้วและใช้วิธีการโทรmethod_name(args)ในคอนโซล

ตัวอย่าง: สมมติว่าคุณมี MyHelper (ด้วยเมธอดmy_method) ใน 'app / helpers / my_helper.rb` จากนั้นในคอนโซลให้ทำดังนี้:

  1. include MyHelper
  2. my_helper.my_method
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.