route_translator 1.0.2 → 2.0.0

data/lib/route_translator.rb

@@ -2,7 +2,10 @@ require 'active_support'
 require 'action_controller'
 require 'action_mailer'
 require 'action_dispatch'
+
 require 'route_translator/route_set'
+require 'route_translator/routes_reloader'
+require 'route_translator/railtie' if defined?(Rails::Railtie)
 
 module RouteTranslator
 
@@ -15,10 +18,16 @@ module RouteTranslator
     ActionDispatch::Routing::UrlFor
   ].freeze
 
+  Configuration = Struct.new(:force_locale, :generate_unlocalized_routes, :translation_file)
+
   def self.locale_suffix locale
     locale.to_s.underscore
   end
 
+  def self.config
+    @config ||= Configuration.new
+  end
+
   # Attributes
 
   module Controller
@@ -40,6 +49,7 @@ module RouteTranslator
     end
   end
 
+  ActiveSupport.run_load_hooks(:route_translator, self)
 end
 
 # Add locale_suffix to controllers, views and mailers

data/lib/route_translator/railtie.rb

@@ -0,0 +1,23 @@
+module RouteTranslator
+  class Railtie < ::Rails::Railtie
+    config.route_translator = ActiveSupport::OrderedOptions.new
+
+    initializer "route_translator.set_configs" do |app|
+      options = app.config.route_translator
+      options.force_locale ||= false
+      options.generate_unlocalized_routes ||= false
+      options.translation_file ||= File.join(%w[config i18n-routes.yml])
+
+      ActiveSupport.on_load :route_translator do
+        options.each do |k, v|
+          k = "#{k}="
+          if config.respond_to?(k)
+            config.send k, v
+          else
+            raise "Invalid option key: #{k}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/route_translator/route_set.rb

@@ -24,11 +24,25 @@ module RouteTranslator
 
     #Use the translations from the specified file
     def translate_from_file(file_path = nil)
-      file_path ||= defined?(Rails) && File.join(Rails.root, %w(config i18n-routes.yml))
-      load_dictionary_from_file(file_path)
+      file_path = absolute_path(file_path)
+
+      reset_dictionary
+      Dir[file_path].each do |file|
+        add_dictionary_from_file(file)
+      end
       translate
     end
 
+private
+
+    def absolute_path (file_path)
+      file_path ||= RouteTranslator.config.translation_file
+      file_path = Rails.root.join(file_path) if defined?(Rails)
+      file_path
+    end
+
+public
+
     include Helpers
     include Translator
     include DictionaryManagement

data/lib/route_translator/route_set/translator.rb

@@ -10,9 +10,12 @@ module RouteTranslator
         original_routes = routes.dup
         original_named_routes = named_routes.routes.dup  # Hash {:name => :route}
 
+        # The filter method exists if the "routing-filter" gem is used
+        original_filters = set.respond_to?(:filters) ? set.filters.dup : []
+
         routes_to_create = []
         original_routes.each do |original_route|
-          if localized_routes && localized_routes.include?(original_route.to_s) then
+          if localized_routes && localized_routes.include?(original_route.to_s)
             translations_for(original_route).each do |translated_route_args|
               routes_to_create << translated_route_args
             end
@@ -20,6 +23,11 @@ module RouteTranslator
             route = untranslated_route original_route
             routes_to_create << route
           end
+          # Always generate unlocalized routes?
+          if RouteTranslator.config.generate_unlocalized_routes
+            route = untranslated_route original_route
+            routes_to_create << route
+          end
         end
 
         reset!
@@ -28,6 +36,10 @@ module RouteTranslator
           add_route(*r)
         end
 
+        if original_filters.any?
+          set.filters << original_filters
+          set.filters.flatten!
+        end
 
         Hash[original_named_routes.select{|k,v| localized_routes && localized_routes.include?(v.to_s)}].each_key do |route_name|
           named_routes.helpers.concat add_untranslated_helpers_to_controllers_and_views(route_name)
@@ -105,7 +117,16 @@ module RouteTranslator
       def translate_path(path, locale)
         final_optional_segments = path.slice!(/(\(.+\))$/)
         new_path = path.split("/").map{|seg| translate_path_segment(seg, locale)}.join('/')
-        new_path = "/#{locale.downcase}#{new_path}" unless default_locale?(locale)
+
+        # Add locale prefix if it's not the default locale,
+        # or forcing locale to all routes,
+        # or already generating actual unlocalized routes
+        if !default_locale?(locale) ||
+          RouteTranslator.config.force_locale ||
+          RouteTranslator.config.generate_unlocalized_routes
+          new_path = "/#{locale.downcase}#{new_path}"
+        end
+
         new_path = "/" if new_path.blank?
         "#{new_path}#{final_optional_segments}"
       end

data/lib/route_translator/routes_reloader.rb

@@ -0,0 +1,15 @@
+require "rails"
+
+module Rails
+  class Application
+      alias :reload_routes_without_translator! :reload_routes!
+      def reload_routes!
+        result = reload_routes_without_translator!
+
+        self.routes.default_locale = I18n.default_locale
+        self.routes.translate_from_file
+
+        result
+      end
+  end
+end

data/lib/route_translator/test_request.rb

@@ -0,0 +1,11 @@
+module ActionDispatch
+  class TestRequest < Request
+    def initialize(env = {})
+      super(DEFAULT_ENV.merge(env))
+
+      self.host        = 'test.host'
+      self.remote_addr = '0.0.0.0'
+      self.user_agent  = 'Rails Testing'
+    end
+  end
+end

data/lib/route_translator/version.rb

@@ -1,3 +1,3 @@
 module RouteTranslator
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/test/route_translator_test.rb

@@ -1,11 +1,14 @@
 require 'test/unit'
 require 'mocha'
 
+require "rails"
+require "action_controller/railtie"
+
 require 'route_translator'
+require "route_translator/test_request"
 
 require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
-
 class PeopleController < ActionController::Base;  end
 class ProductsController < ActionController::Base;  end
 
@@ -17,12 +20,34 @@ class TranslateRoutesTest < ActionController::TestCase
     I18n.default_locale = locale
   end
 
+  def config_force_locale(boolean)
+    RouteTranslator.config.force_locale = boolean
+  end
+
+  def config_generate_unlocalized_routes(boolean)
+    RouteTranslator.config.generate_unlocalized_routes = boolean
+  end
+
+  def config_translation_file (file)
+    RouteTranslator.config.translation_file = file
+  end
+
   def setup
+    setup_application
+
     @controller = ActionController::Base.new
     @view = ActionView::Base.new
     @routes = ActionDispatch::Routing::RouteSet.new
   end
 
+  def teardown
+    config_force_locale false
+    config_generate_unlocalized_routes false
+    config_default_locale_settings("en")
+    routes_file ""
+    FileUtils.rm_rf "#{tmp_path}/log"
+  end
+
   def test_unnamed_root_route
     @routes.draw do
       localized do
@@ -313,6 +338,77 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_unrecognized_route '/es/productos', :controller => 'products', :action => 'index', :locale => 'es'
   end
 
+  def test_force_locale
+    @routes.draw do
+      localized do
+        match 'people', :to => 'people#index', :as => 'people'
+      end
+    end
+
+    config_default_locale_settings 'en'
+    config_force_locale true
+
+    @routes.translate_from_file(File.expand_path('locales/routes.yml', File.dirname(__FILE__)))
+
+    assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_unrecognized_route '/people', :controller => 'people', :action => 'index'
+  end
+
+  def test_generate_unlocalized_routes
+    @routes.draw do
+      localized do
+        match 'people', :to => 'people#index', :as => 'people'
+      end
+    end
+
+    config_default_locale_settings 'en'
+    config_generate_unlocalized_routes true
+
+    @routes.translate_from_file(File.expand_path('locales/routes.yml', File.dirname(__FILE__)))
+
+    assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_routing '/people', :controller => 'people', :action => 'index'
+  end
+
+  def test_config_translation_file
+    @routes.draw do
+      localized do
+        root :to => 'people#index'
+      end
+    end
+
+    config_default_locale_settings 'es'
+    config_translation_file File.expand_path('locales/routes.yml', File.dirname(__FILE__))
+
+    @routes.translate_from_file
+
+    assert_routing '/', :controller => 'people', :action => 'index', :locale => 'es'
+    assert_routing '/en', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_unrecognized_route '/es', :controller => 'people', :action => 'index', :locale => 'es'
+  end
+
+  def test_auto_translate
+
+    routes_file <<-RUBY
+      Rails.application.routes.draw do
+        localized do
+          root :to => 'people#index'
+        end
+      end
+    RUBY
+
+    config_default_locale_settings 'es'
+    config_translation_file File.expand_path('locales/routes.yml', File.dirname(__FILE__))
+
+    app.reload_routes!
+
+    @routes = app.routes
+
+    assert_routing '/', :controller => 'people', :action => 'index', :locale => 'es'
+    assert_routing '/en', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_unrecognized_route '/es', :controller => 'people', :action => 'index', :locale => 'es'
+  end
+
   def test_action_controller_gets_locale_setter
     ActionController::Base.instance_methods.include?('set_locale_from_url')
   end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+
 class StubbedI18nBackend
   @@translations = {
     'es' => { 'people' => 'gente'},
@@ -13,8 +14,6 @@ class StubbedI18nBackend
   def self.available_locales
     @@translations.keys
   end
-
-
 end
 
 module RouteTranslator
@@ -32,6 +31,49 @@ module RouteTranslator
       !(defined?(ActionPack) && ActionPack::VERSION::MAJOR == 3 && ActionPack::VERSION::MINOR > 0)
     end
 
+    def setup_application
+      return if defined?(@@app)
+
+      app = @@app = Class.new(Rails::Application)
+      app.config.active_support.deprecation = :stderr
+      app.paths["log"] = "#{tmp_path}/log/test.log"
+      app.initialize!
+      Rails.application = app
+    end
+
+    def app
+      @@app
+    end
+
+    def tmp_path(*args)
+      @tmp_path ||= File.join(File.dirname(__FILE__), "tmp")
+      File.join(@tmp_path, *args)
+    end
+
+    def app_path(*args)
+      tmp_path(*%w[app] + args)
+    end
+
+    def routes_file(contents)
+      fn = File.join(app_path, routes_config)
+      FileUtils.mkdir_p File.dirname(fn)
+      File.open(fn, 'w') do |f|
+        f.puts contents
+      end
+      app.routes_reloader.paths.unshift(fn)
+    end
+
+    def routes_config
+      @@routes_config ||= File.join("config", "routes.rb")
+    end
+
+    def print_routes (route_set)
+      require 'rails/application/route_inspector'
+      inspector = Rails::Application::RouteInspector.new
+      puts inspector.format(route_set.routes, ENV['CONTROLLER']).join "\n"
+    rescue LoadError
+    end
+
     def assert_helpers_include(*helpers)
       helpers.each do |helper|
         ['url', 'path'].each do |suffix|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -20,7 +20,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -36,10 +52,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/route_translator.rb
+- lib/route_translator/railtie.rb
 - lib/route_translator/route_set.rb
 - lib/route_translator/route_set/dictionary_management.rb
 - lib/route_translator/route_set/helpers.rb
 - lib/route_translator/route_set/translator.rb
+- lib/route_translator/routes_reloader.rb
+- lib/route_translator/test_request.rb
 - lib/route_translator/version.rb
 - lib/tasks/route_translator.rake
 - test/locales/routes.yml
@@ -65,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Translate your Rails routes in a simple manner