Как я могу вызвать вспомогательные методы контроллера / представления из консоли в Ruby on Rails?

442

Когда я загружаюсь script/console, иногда я хочу поиграть с выводом контроллера или методом помощника вида.

Есть ли способы:

  • смоделировать запрос?
  • вызывать методы из экземпляра контроллера по указанному запросу?
  • проверить вспомогательные методы, либо через указанный экземпляр контроллера, либо другим способом?
ruby-on-rails console KCH
источник

Ответы:

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
KCH
источник
4
Я заметил, что не могу выполнить более одного app.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
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. Я обновил ответ, чтобы включить это.
Ник
Отличная идея. Я не думал об этом.
Марнен Лайбоу-Козер
5
Как я могу аутентифицировать консоль, чтобы я мог проверить контроллеры, которые требуют аутентификации?
Мягкий Fuzz
7
Вы должны иметь возможность размещать сообщения на странице входа в систему, например: app.post '/ session / new', {: username => "foo",: password => "pass"}. А затем продолжайте использовать ту же переменную app для получения страниц после этого.
Ник
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
Это помогает, когда вы пишете независимые сценарии ruby, которые будут запускаться с использованием rails runner, и им нужно вызывать методы в контроллере приложения. Спасибо
CodeExpress
@CodeExpress Это никогда не должно случиться. Вместо этого поместите методы в объект службы и вызовите службу как из ApplicationController, так и из вашего сценария.
Марнен Лайбоу-Козер
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/):)
Дориан
И это не всегда controler/action, зависит от ваших маршрутов, например, может быть /users/allи на карту Api::UsersController#index:)
Дориан
@ Дориан Ор rake routes. :)
Марнен Лайбоу-Козер
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 и будет удалена в будущих версиях.
яркая звезда
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
Камил Лелонек
вам также нужно отключить forgery_protectionApplicationController.allow_forgery_protection = false
Уильям Херри
Вау, это, наверное, проще. То, что я написал, с защитой от подделки. Вам не нужно отключать его, но я уверен, что это удобнее!
Хлоя
12

Вы можете получить доступ к своим методам в консоли Ruby on Rails, как показано ниже:

controller.method_name
helper.method_name
Jyothu
источник
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

Один из возможных подходов к тестированию методов 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
Разработчик Мариус Жиленас
источник