Rspec ignores default_url_options set in application_controller.rb

[adamtao]

Using Rails 3, I have a :scope in routes.rb:

scope "(/:locale)" do

  resources :products

end

In application_controller.rb I set the default :locale

def default_url_options(options={})

  {:locale => "en-US"}

end

In my views, this works when I test in my browser, but fails with Rspec:

<%= link_to product.name, product %>

While running specs I see:

No route matches {:action=>"show", :controller=>"products", :locale=>#<Product id: ...>}

So, Rspec is not using the default_url_options set in application_controller.rb.

Thanks

[dchelimsky]

What kind of spec is this failing in? Controller w/ render_views? View spec?

[adamtao]

View specs are giving me troubles. I haven't tried it with render_views in controller specs. I'll give it a try.

[dchelimsky]

I'm pretty sure this is a rails issue, not RSpec. For view specs, RSpec wraps ActionView::TestCase. Can you please try one of the RSpec examples that's failing as an ActionView::TestCase and tell me if you get a different result?

[adamtao]

Sorry, I've tried to figure this out, but I don't know how to test a view without the controller by using ActionView::TestCase. I couldn't find much helpful documentation either. Any hints?

[dchelimsky]

class WidgetShowTest < ActionView::TestCase
  def test_shows_a_widget
    render "widgets/show", :widget => Widget.new(:name => "ACME Widget")
    assert_match /ACME Widget/, rendered
  end
end

[adamtao]

Dave, it looks like your initial assessment was correct. The same test fails as an ActionView::TestCase. I'll figure out how to pass this to the rails team. Thanks.

[dchelimsky]

I'm going to go ahead and close this then. Please feel free to add comments here as you learn stuff.

[manuelmeurer]

Was this reported as a bug to the Rails team? If yes, could somebody post the link? Can't find it...

[adamtao]

Yes, here is the link:

https://rails.lighthouseapp.com/projects/8994/tickets/5998-actionviewtestcase-does-not-honor-default_url_options-set-in-application_controllerrb

It was recently marked invalid with a code sample of how testing should be done. I haven't had time to evaluate the response in conjunction with rspec.

[manuelmeurer]

Thanks, I will try to implement it that way with RSpec.

[manuelmeurer]

It worked for me by just monkeypatching the controller to be tested in a before(:all) filter:

class MyController
  def default_url_options(options = {})
    { :locale => params[:locale] }
  end
end

[nickurban]

If you want to change it everywhere, try dropping this into a file in spec/support

class ActionView::TestCase 
  class TestController
    def default_url_options
      {:locale => 'whatever'}
    end
  end
end

[phoet]

i needed to dig a little deeper to get all my spec up and running again with rails 3.1.3:

# workaround, to set default locale for ALL spec
class ActionView::TestCase::TestController
  def default_url_options(options={})
    { :locale => I18n.default_locale }
  end
end

class ActionDispatch::Routing::RouteSet
  def default_url_options(options={})
    { :locale => I18n.default_locale }
  end
end

[shioyama]

I've been using @phoet's patch for the past year or so, but the other day when I updated rails from 3.2.3 to 3.2.6, suddenly the problem returned. After some digging I found that an upgrade to journey from 1.0.3 to 1.0.4 was part of the problem, but I still had issues in my integration tests.

Specifically, this would fail:

describe "default_url_options test" do
  context 'test' do
    before do 
      I18n.locale = 'en'
      visit homepage_path
    end

    it "switches the locale to ja" do
      I18n.locale = 'ja'
      visit homepage_path
      page.should have_content("サインイン")
    end
  end
end

The locale would revert whatever it was initially set to, making it impossible to change midway through any particular spec. This used to work no problem.

After digging some more, I found what I think is the source of the problem in this commit to rails, which prioritizes the locale passed in through the options hash over whatever is set in default_url_options. As a result, @phoet's second patch above (to ActionDispatch::Routing::RouteSet) has no effect and any dependent specs fail.

To get around this, I replaced both patches above with this one, which solves the problem everywhere:

class ActionDispatch::Routing::RouteSet
  def url_for_with_locale_fix(options)
    url_for_without_locale_fix(options.merge(:locale => I18n.locale))
  end

  alias_method_chain :url_for, :locale_fix
end

I'd be eager to hear if anyone had the same problem when upgrading rails, or if there is something specific to my environment that is triggering this behaviour.

[oelmekki]

Thanks @shioyama , that was helpful. A remark, though :

url_for_without_locale_fix(options.merge(:locale => I18n.locale))

using this, you do not actually set a default, but you override locale param after user pass it to route helper. This is not a problem in your case because you use I18n.locale rather than I18n.default_locale and I suppose your code base do not try to redirect to other locale.

To actually emulate #default_url_options, the #merge should be reversed :

class ActionDispatch::Routing::RouteSet
  def url_for_with_locale_fix(options)
    url_for_without_locale_fix({:locale => I18n.default_locale}.merge(options))
  end

  alias_method_chain :url_for, :locale_fix
end