fishman-i18n_routing 0.4.9

data/CHANGELOG.rdoc

@@ -0,0 +1,99 @@
+0.4.7 (February 14, 2011)
+
+* Fix bug in empty translation handling
+* Hack Rack::Mount to handle :locale constraints in top of i18n_locale
+* Fix requirements bug introduced by Rails 3.0.4
+* Add Gemfile with bundler for easy spec on different rails versions
+
+0.4.6 (February 14, 2011)
+
+* Handle empty translation
+
+0.4.5 (November 04, 2010)
+
+* Fixing Rails 3 scope bug with missing / and no translations
+
+0.4.4 (November 03, 2010)
+
+* Fix bug with locale with a dash like pt-br
+
+0.4.3 (October 10, 2010)
+
+* Named route can be translated by name or by path
+
+0.4.2 (September 20, 2010)
+
+* Fix a Rails3 bug, enabling again to do things like that: get :one, :two, :three
+
+0.4.1 (September 11, 2010)
+
+* Fix a Rails3 bug for named routes and prefixed path
+
+0.4.0 (September 08, 2010)
+
+* Full support for Rails 3.0.0
+
+0.3.8 (August 30, 2010)
+
+* Support the first Rails3 official release (but nested resources is still broken)
+
+0.3.7 (August 26, 2010)
+
+* Support Rails3 RC2 thanks to fwalch / Rails3 final will probably require a new version of i18n_routing
+* Not everything works on RC2 (nested resources), will be fixed when Rails3 will be officially released.
+
+0.3.6 (June 13, 2010)
+
+* Works even if translations are the same as the translated name
+
+0.3.5 (June 9, 2010)
+
+* Clean up some .to_sym in order to avoid unnecessary symbols during runtime
+* Works with both I18n.locale as string or as symbol
+* Try to fix a Pathname instead of string issue
+
+0.3.4 (June 3, 2010)
+
+* Fix Rails3 issue with nested single resource again and pluralize controller name as it should be
+
+0.3.3 (June 2, 2010)
+
+* Fix Rails3 issue with nested single resource
+
+0.3.2 (June 2, 2010)
+
+* Add automatically config/locales/*.yml in the i18n load path in order to fix Rails3 issue
+
+0.3.1 (May 27, 2010)
+
+* Add a small Rails3 verification
+
+0.3.0 (May 27, 2010)
+
+* Add support for translating path_names, member and collection
+* Fix Rails3 nested resources
+* All specs are now passing under both Rails 2.3.5 and Rails 3
+
+0.2.4 (Apr 21, 2010)
+
+* Fix latest Rails3 edge compatibility (previous rails3 beta version not supported any more)
+
+0.2.3 (Apr 21, 2010)
+
+* Works on ruby 1.9.2-head
+
+0.2.2 (Apr 21, 2010)
+
+* Add I18n gem dependency
+
+0.2.1 (Apr 09, 2010)
+
+* Minor Rails3 modification, added gemspec and pushed gem on gemcutter
+
+0.2.0 (Apr 07, 2010)
+
+* All specs pass for Rails2, including nested deep resources
+
+0.1.0 (Mar 22, 2010)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "rails", '3.0.6'
+gem 'rspec', '>=2.5.0'

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.6)
+      actionpack (= 3.0.6)
+      mail (~> 2.2.15)
+    actionpack (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+    activesupport (3.0.6)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.16)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.6)
+      actionmailer (= 3.0.6)
+      actionpack (= 3.0.6)
+      activerecord (= 3.0.6)
+      activeresource (= 3.0.6)
+      activesupport (= 3.0.6)
+      bundler (~> 1.0)
+      railties (= 3.0.6)
+    railties (3.0.6)
+      actionpack (= 3.0.6)
+      activesupport (= 3.0.6)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.6)
+  rspec (>= 2.5.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= I18nRouting
+
+I18n_routing is a plugin for Ruby on Rails that lets you easily translate your routes trough the I18n api included in Rails since version 2.2
+
+All necessary informations are available on the wiki: http://wiki.github.com/kwi/i18n_routing
+
+For any question, use the i18_routing google group: http://groups.google.com/group/i18n-routing
+
+Works with Rails 2.3 and Rails 3.0
+=> Rails3 beta and RC versions are no longer supported !
+
+== TODO for next releases (written the 9th of June)
+
+* Handle multiple translations for same resources name (Example: nested and not nested resources)
+* Handle namespace translation (and path_prefix on Rails3)
+
+== I18n gem version warning
+
+Be careful when running Rails 2.3 with the shipped i18n gem: this is an old i18n version and i18_routing will install the latest i18n version as a gem.
+This latest version may be incompatible with some old usages.
+Furthermore, if the i18n gem is present on your system, Rails will load it and skip the shipped version; Keep that in mind.
+
+== Contributors
+
+* kwi (Guillaume Luccisano)
+* bigtiger (Jim Remsik)
+* mixr (Reiner Dieterich)
+* fwalch
+* doubledrones: h13ronim (Marcin Michałowski)
+* rudionrails (Rudolf Schmidt)
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+# Now using RSpec 2
+
+desc "Run specs for current Rails version"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+  # t.ruby_opts = lambda {
+  #   @rails_spec_version ? ["-c --format specdoc -- rails_spec_version=#{@rails_spec_version}"] : ["-c --format specdoc"]
+  # }
+end
+
+task :default => :spec
+
+desc "Run Rails 2.x specs"
+task :rails2_spec do
+  @rails_spec_version = 2
+  Rake::Task['spec'].invoke
+end
+
+desc "Run Rails 3.x specs"
+task :rails3_spec do
+  @rails_spec_version = 3
+  Rake::Task['spec'].invoke
+end

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'i18n_routing'

data/lib/i18n_routing.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'i18n_routing_common'
+
+if Rails.version < '3'
+  require 'i18n_routing_rails2'
+else
+  require 'i18n_routing_rails3'
+end

data/lib/i18n_routing_common.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+# I18nRouting module for common usage methods
+module I18nRouting
+  def self.locale_escaped(locale)
+    locale.to_s.downcase.gsub('-', '_')
+  end
+  
+  # Return the correct translation for given values
+  def self.translation_for(name, type = :resources, option = nil)
+    # First, if an option is given, try to get the translation in the routes scope
+    if option
+      default = "{option}Noi18nRoutingTranslation"
+      t = I18n.t(option, :scope => "routes.#{name}.#{type}", :default => default)
+      return (t == default ? nil : t)
+    else
+      default = "{name}Noi18nRoutingTranslation"
+
+      # Try to get the translation in routes namescope first      
+      t = I18n.t(:as, :scope => "routes.#{name}", :default => default)
+
+      return t if t and t != default
+
+      t = I18n.t(name.to_s, :scope => type, :default => default)
+      return (t == default ? nil : t)
+    end
+  end
+
+  DefaultPathNames = [:new, :edit]
+  PathNamesKeys = [:path_names, :member, :collection]
+
+  # Return path names hash for given resource
+  def self.path_names(name, options)
+    h = (options[:path_names] || {}).dup
+    
+    path_names = DefaultPathNames
+    PathNamesKeys.each do |v|
+      path_names += options[v].keys if options[v] and Hash === options[v]
+    end
+    
+    path_names.each do |pn|
+      n = translation_for(name, :path_names, pn)
+      n = nil if n == pn.to_s
+      # Get default path_names in path_names scope if no path_names found
+      n ||= I18n.t(pn, :scope => :path_names, :default => name.to_s)
+
+      h[pn] = n if n and n != name.to_s
+    end
+
+    return h
+  end
+end

data/lib/i18n_routing_rails2.rb

@@ -0,0 +1,237 @@
+# encoding: utf-8
+
+#
+# WARNING : Old and dirty Rails 2.x code
+# Need clean up and intensive refactoring
+#
+
+module ActionController
+  module Routing
+    class Route #:nodoc:
+      alias_method :mkd_initialize, :initialize
+      def initialize(segments = [], requirements = {}, conditions = {})
+        @glang = requirements.delete(:glang)
+        mkd_initialize(segments, requirements, conditions)
+      end
+
+      private
+        alias_method :mkd_generation_requirements, :generation_requirements
+        # Add locale requirements to ensure good route is used when using url_for
+        def generation_requirements
+          r = mkd_generation_requirements
+          if @glang and !r.blank?
+            r << " and I18n.locale.to_sym == :'#{@glang}'"
+          end
+
+          return r
+        end
+    end
+  end
+end
+
+module ActionController
+  module Routing
+    class RouteSet #:nodoc:
+      attr :locales, true
+      attr :i18n_verbose, true
+
+      class Mapper
+        def localized(locales = I18n.available_locales, opts = {})
+          old_value = @set.locales
+          @set.locales = locales
+          @set.i18n_verbose ||= opts.delete(:verbose)
+          yield
+        ensure
+          @set.locales = old_value
+        end
+      end
+
+      class NamedRouteCollection #:nodoc:
+        alias_method :mkd_define_url_helper, :define_url_helper
+        def define_url_helper(route, name, kind, options)
+          gl = Thread.current[:globalized]
+
+          mkd_define_url_helper(route, name, kind, options)
+
+          if gl
+            selector = url_helper_name(name, kind)
+
+            rlang = if i = name.to_s.rindex("_#{gl}")
+              "#{selector.to_s[0, i]}_glang_#{gl}#{selector.to_s[i + "_#{gl}".size, selector.to_s.size]}"
+            elsif (gls = Thread.current[:globalized_s]) and i = name.to_s.rindex("_#{gls}")
+              "#{selector.to_s[0, i]}_glang_#{gls}#{selector.to_s[i + "_#{gls}".size, selector.to_s.size]}"
+            else
+              "glang_#{selector}"
+            end
+
+            # surcharge de l'helper
+            @module.module_eval <<-end_eval # We use module_eval to avoid leaks
+              alias_method :gl#{selector}, :#{selector}
+
+              def #{selector}(*args)
+                selector_g = '#{rlang}'.gsub('glang', I18nRouting.locale_escaped(I18n.locale)).to_sym
+
+                #logger.debug "Call routes : #{selector} => \#{selector_g} (#{rlang}) "
+                #puts "Call routes : #{selector} => \#{selector_g} (#{rlang}) Found:\#{respond_to? selector_g and selector_g != :#{selector}}"
+                if respond_to? selector_g and selector_g != :#{selector}
+                  send(selector_g, *args)
+                else
+                  gl#{selector}(*args)
+                end
+              end
+              protected :gl#{selector}
+            end_eval
+          end
+        end
+      end
+
+      alias_method :gl_add_named_route, :add_named_route
+      def add_named_route(name, path, options = {}) #:nodoc:
+        if @locales and !path.blank? and !Thread.current[:i18n_no_named_localization]
+          # Here, try to translate standard named routes
+          name = name.to_s
+
+          stored_locale = I18n.locale
+          @locales.each do |l|
+            I18n.locale = l
+            nt = "#{I18nRouting.locale_escaped(l)}_#{name}"
+            t = I18nRouting.translation_for(name, :named_routes) || I18nRouting.translation_for(path, :named_routes_path)
+            if nt != name and !t.blank?
+              gl_add_named_route(nt, t, options.merge(:glang => l))
+              puts("[I18n] > localize %-10s: %40s (%s) => %s" % ['route', name, l, t]) if @i18n_verbose
+            end
+          end
+          I18n.locale = stored_locale
+
+          old_v = Thread.current[:globalized]
+          Thread.current[:globalized] = true
+          gl_add_named_route(name, path, options)
+          Thread.current[:globalized] = old_v
+          return
+        end
+
+        gl_add_named_route(name, path, options)
+      end
+    end
+  end
+end
+
+module ActionController
+  module Resources
+    class Resource
+      alias_method :mkd_initialize, :initialize
+      def initialize(entities, options)
+        @real_path = options.delete(:real_path)
+        @real_path = @real_path.to_s.singularize if @real_path
+
+        mkd_initialize(entities, options)
+      end
+
+      def nesting_name_prefix
+        @real_path ? "#{shallow_name_prefix}#{@real_path}_" : "#{shallow_name_prefix}#{singular}_"
+      end
+
+      def nesting_path_prefix
+        @nesting_path_prefix ||= (@real_path ? "#{shallow_path_prefix}/#{path_segment}/:#{@real_path}_id" : "#{shallow_path_prefix}/#{path_segment}/:#{singular}_id")
+      end
+    end
+
+    def switch_globalized_state(state)
+      old_g = Thread.current[:globalized]
+      Thread.current[:globalized] = state
+      yield
+      Thread.current[:globalized] = old_g
+    end
+
+    def switch_no_named_localization(state)
+      old_g = Thread.current[:i18n_no_named_localization]
+      Thread.current[:i18n_no_named_localization] = state
+      yield
+      Thread.current[:i18n_no_named_localization] = old_g
+    end
+
+    def create_globalized_resources(type, namespace, *entities, &block)
+      Thread.current[:i18n_nested_deep] ||= 0
+      Thread.current[:i18n_nested_deep] += 1
+
+      if @set.locales
+        name = entities.dup.shift.to_s
+
+        options = entities.extract_options!
+        opts = options.dup
+
+        locales = @set.locales
+        localized(nil) do
+          stored_locale = I18n.locale
+          locales.each do |l|
+            I18n.locale = l
+            nt = "#{I18nRouting.locale_escaped(l)}_#{name}"
+            if nt != name and !(t = I18nRouting.translation_for(name, namespace)).blank?
+              opts[:as] = t
+              opts[:glang] = l
+              opts[:controller] ||= name.to_s.pluralize
+              opts[:real_path] = opts[:singular] || name
+              opts[:path_names] = I18nRouting.path_names(name, options)
+              path_prefix_t = I18n.t(:path_prefix, :scope => :"routes.#{name}", :default => "NoPathPrefixTranslation")
+              opts[:path_prefix] = path_prefix_t unless path_prefix_t == "NoPathPrefixTranslation"
+
+              localized([l]) do
+                switch_no_named_localization(true) do
+                  send(type, nt.to_sym, opts, &block)
+                end
+              end
+              puts("[I18n] > localize %-10s: %40s (%s) => %s" % [namespace, nt, l, t]) if @set.i18n_verbose
+            end
+          end
+          I18n.locale = stored_locale
+
+
+          if Thread.current[:i18n_nested_deep] < 2
+            switch_no_named_localization(nil) do
+              switch_globalized_state(true) do
+                send(type, *(entities << options), &block)
+              end
+            end
+          end
+        end
+
+      else
+        send(type, *entities, &block)
+      end
+
+      Thread.current[:i18n_nested_deep] -= 1
+    end
+
+    alias_method :gl_resources, :resources
+    def resources(*entities, &block)
+      create_globalized_resources(:gl_resources, :resources, *entities, &block)
+    end
+
+    alias_method :gl_resource, :resource
+    def resource(*entities, &block)
+      create_globalized_resources(:gl_resource, :resource, *entities, &block)
+    end
+
+    private
+    alias_method :gl_action_options_for, :action_options_for
+    def action_options_for(action, resource, method = nil, resource_options = {})
+      opts = gl_action_options_for(action, resource, method, resource_options)
+
+      if Thread.current[:globalized]
+        Thread.current[:globalized] = resource.plural
+        if resource.uncountable?
+          Thread.current[:globalized] = resource.plural.to_s + '_index'
+        end
+        Thread.current[:globalized_s] = resource.singular
+      else
+        Thread.current[:globalized] = nil
+        Thread.current[:globalized_s] = nil
+      end
+      if resource.options[:glang]
+        opts[:glang] = resource.options[:glang]
+      end
+
+      opts
+    end
+  end
+end