如何在 Ruby on Rails 的控制台中调用控制器/视图辅助方法？

Posted

技术标签:

【中文标题】如何在 Ruby on Rails 的控制台中调用控制器/视图辅助方法？【英文标题】：How can I call controller/view helper methods from the console in Ruby on Rails? 【发布时间】：2010-09-14 03:24:21 【问题描述】：

当我加载script/console 时，有时我想使用控制器或视图辅助方法的输出。

有没有办法：

模拟请求？ 根据所述请求从控制器实例调用方法？ 通过所述控制器实例或其他方式测试辅助方法？

【问题讨论】：

100 年后，我仍然在谷歌上搜索 【参考方案1】：

要调用助手，请使用helper 对象：

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

如果您想使用默认情况下未包含的帮助程序（例如，因为您从 ApplicationController 中删除了 helper :all），只需包含该帮助程序即可。

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

至于处理controllers，我引用Nick's的回答：

> 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

【讨论】：

我观察到我不能执行多个app.get（随之而来的线程错误）。有没有办法可以刷新系统并执行更多获取？ 注意在 Rails 3.2 中这不起作用。我需要从控制台拨打url_for。为此，我做了app.url_for(...) 对于NoMethodError: undefined method `protect_against_forgery?' for nil:NilClass，在返回false的控制台中定义一个名为protect_against_forgery?的函数 如何设置当前登录用户？ @RudolfOlah 看来，如果您使用设备（或典狱长），您可以使用 ActionDispatch::Integration::Session.include(Warden::Test::Helpers); Warden.test_mode! ; app.login_as(User.find(1), scope: :user)。【参考方案2】：

从脚本/控制台调用控制器操作并查看/操作响应对象的简单方法是：

> 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，我没有尝试早期版本。

【讨论】：

应用程序对象的官方文档的链接会很好。 它是 ActionController::Integration::Session 类的一个实例。我已经更新了答案以包含它。 好主意。我没有想到这一点。 如何对控制台进行身份验证，以便检查需要身份验证的控制器？ 您应该可以发布到您的登录页面，例如：app.post '/session/new', :username => "foo", :password => "pass" .然后继续使用相同的“app”变量获取之后的页面。【参考方案3】：

如果您需要从控制台进行测试（在 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

库模块：

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

【讨论】：

这有助于您编写独立的 ruby​​ 脚本，这些脚本将使用 rails runner 运行并且它们需要调用应用程序控制器中的方法。谢谢 @CodeExpress 那不应该发生。相反，将方法放在服务对象中，并从 ApplicationController 和您的脚本中调用服务。【参考方案4】：

这是通过控制台执行此操作的一种方法：

>> 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 将其方法混合到您的对象中，让您查看它们的返回值。

【讨论】：

【参考方案5】：

如果方法是POST方法那么：

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

（此处的参数将根据您的适用性而定。）

否则如果是GET方法则：

app.get 'controller/action'

【讨论】：

要找到你想要的路径，app.methods.grep(/_path/) :) 并不总是controler/action，取决于您的路线，例如可以是 /users/all 并映射到 Api::UsersController#index :) @Dorian 或rake routes。 :)【参考方案6】：

以下是如何发出经过身份验证的 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

【讨论】：

NameError: undefined local variable or method app for main:Object 你还需要禁用forgery_protection ApplicationController.allow_forgery_protection = false 哇，这可能更容易。我写的是防伪保护。你不需要禁用它，但我相信它更方便！【参考方案7】：

另一种方法是使用 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”继续执行。还有扩展调试的选项，但这至少可以帮助您入门。

【讨论】：

> => 注意：调试器选项自 Ruby 2.0 起被忽略，它将在未来的版本中删除。【参考方案8】：

您可以在 Ruby on Rails 控制台中访问您的方法，如下所示：

controller.method_name
helper.method_name

【讨论】：

【参考方案9】：

在 Ruby on Rails 3 中，试试这个：

session = ActionDispatch::Integration::Session.new(Rails.application)
session.get(url)
body = session.response.body

正文将包含 URL 的 HTML。

How to route and render (dispatch) from a model in Ruby on Rails 3

【讨论】：

【参考方案10】：

较早的答案是调用助手，但以下将有助于调用控制器方法。我在 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 将被转储到控制台。

【讨论】：

【参考方案11】：

对于控制器，您可以在 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 变量？【参考方案12】：

在任何控制器操作或视图中，您都可以通过调用 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

【讨论】：

【参考方案13】：

在 Ruby on Rails 控制台中进行 Helper 方法测试的一种可能方法是：

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

然后重新加载：

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

【讨论】：

【参考方案14】：

如果您添加了自己的助手并且希望其方法在控制台中可用，请执行以下操作：

    在控制台执行include YourHelperName 您的辅助方法现在在控制台中可用，并在控制台中调用method_name(args) 使用它们。

示例：假设您在 'app/helpers/my_helper.rb` 中有 MyHelper（使用方法 my_method），然后在控制台中执行：

    include MyHelper my_helper.my_method

【讨论】：

以上是关于如何在 Ruby on Rails 的控制台中调用控制器/视图辅助方法？的主要内容，如果未能解决你的问题，请参考以下文章

如何在 ruby​​ on rails 中获取控制器和操作列表？

Ruby on Rails 如何使用 yield 进行布局？

Ruby on Rails 生成模型

从 Ruby on Rails 调用 PL/pgSQL 存储过程

Ruby on Rails 路由到控制器

Ruby on Rails 中一个共享视图的两个控制器