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"

コントローラの扱いについては、ニックの答えを引用します。

> 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
1つしか実行できないことapp.getがわかります(スレッドエラーが発生します)。システムをフラッシュしてより多くのgetを実行する方法はありますか?
JellicleCat

2
Rails 3.2では、これは機能しません。url_forコンソールから呼び出す必要がありました。これを行うために私はやったapp.url_for(...)
ラファエル

1
以下のためにNoMethodError: undefined method `protect_against_forgery?' for nil:NilClass呼び出された関数定義protect_against_forgery?コンソール内をそのリターンfalse
キンゴジカ周

現在ログインしているユーザーを設定するにはどうすればよいですか?

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.

appオブジェクトはActionController :: Integration :: Sessionのインスタンスです

これはRuby on Rails 2.1および2.3を使用して動作し、以前のバージョンは試していません。


2
appオブジェクトに関する公式ドキュメントへのリンクがよいでしょう。
RajaRaviVarma 2012

これは、ActionController :: Integration :: Sessionクラスのインスタンスです。それを含めるように答えを更新しました。
ニック

いい案。私はこれを考えていませんでした。
Marnen Laibow-Koser 2012

5
コンソールを認証して、認証が必要なコントローラーを確認するにはどうすればよいですか?
マイルドファズ2013年

7
次のようなログインページに投稿できるはずです:app.post '/ session / new'、{:username => "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\" />"

レンダリング:

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
これは、Railsランナーを使用して実行され、アプリケーションコントローラーのメソッドを呼び出す必要がある独立したRubyスクリプトを記述する場合に役立ちます。ありがとう
CodeExpress

@CodeExpressそれは決して起こらないはずです。代わりに、サービスオブジェクトにメソッドを配置し、ApplicationControllerとスクリプトの両方からサービスを呼び出します。
Marnen Laibow-Koser

77

コンソールからこれを行う1つの方法を次に示します。

>> 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/):)
ドリアン

そして、それは常にではないcontroler/action可能性があり、例えば、あなたのルートに依存/users/allしてにマッピングApi::UsersController#index:)
ドリアン

@ドリアンまたはrake routes。:)
Marnen Laibow-Koser

14

これを行う別の方法は、Ruby on Railsデバッガーを使用することです。http://guides.rubyonrails.org/debugging_rails_applications.htmlに、デバッグに関するRuby on Railsガイドがあります。

基本的に、サーバーを-uオプションで起動します。

./script/server -u

そして、コントローラー、ヘルパーなどにアクセスしたいスクリプトにブレークポイントを挿入します。

class EventsController < ApplicationController
  def index
    debugger
  end
end

そして、リクエストを作成してコードのその部分にヒットすると、サーバーコンソールはプロンプトを返し、そこでコマンドプロンプトからリクエストを作成したり、オブジェクトを表示したりできます。終了したら、「cont」と入力して実行を続けます。拡張デバッグのオプションもありますが、これで少なくとも開始できます。


3
> =>注意:デバッガオプションはRuby 2.0以降無視され、将来のバージョンでは削除される予定です。
明るい星

13

例として精製所を使用して、認証されたPOSTリクエストを行う方法を次に示します。

# 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 2014

また、forgery_protectionを無効にする必要がありますApplicationController.allow_forgery_protection = false
ウィリアムヘリー

うわーそれはおそらく簡単です。私が書いたのは、偽造防止に関するものです。無効にする必要はありませんが、もっと便利だと思います!
クロエ

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

コントローラーアクションまたはビュー内で、consoleメソッドを呼び出すことによってコンソールを呼び出すことができます。

たとえば、コントローラでは:

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ですか?
ファビオ

2

Ruby on Railsコンソールでのヘルパーメソッドテストの可能なアプローチの1つは次のとおりです。

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)になり、コンソールでそれらを呼び出すことができます。

例:my_method'app / helpers / my_helper.rb`に(メソッドを含む)MyHelperがあるとしたら、コンソールで次のようにします:

  1. include MyHelper
  2. my_helper.my_method
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.