josevalim-localized_templates 0.3.1 → 0.4

data/README

@@ -1,10 +1,8 @@
-Copyright (c) 2008 José Valim (jose.valim@gmail.com)
-http://www.pagestacker.com/
-http://josevalim.blogspot.com/
+LocalizedTemplates
 License: MIT
-Version: 0.3.1
+Version: 0.4
 
-LocalizedTemplates
+Description
 ==================
 
 This plugin uses Rails I18n (http://rails-i18n.org/) to allow templates localization.
@@ -21,16 +19,17 @@ And you can also localize rescue files:
 If you don't want to localize a file (like a xml file), simply don't move it and it will be
 rendered as default to all languages.
 
+This is an alternative to Rails 2.3 templates localization schema. If you are
+localizing almost all of your views, it definitely suits you better because
+your views will be better organized.
+
 Installation
 =================
 
-Install LocalizedTemplates is very easy. It is stored in GitHub, so if you have
-never installed a gem via GitHub run the following:
+Install LocalizedTemplates is very easy. If you are running run on Rails 2.3
+just do the following:
 
   gem sources -a http://gems.github.com
-
-Then install the gem:
-
   sudo gem install josevalim-localized_templates
 
 In RAILS_ROOT/config/environment.rb:
@@ -39,33 +38,23 @@ In RAILS_ROOT/config/environment.rb:
 
 If you want it as plugin, just do:
 
-    cd myapp
-    git clone git://github.com/josevalim/localized_templates.git
-    rm -rf vendor/plugins/localized_templates/.git
-
-Adding a new locale
-=================
-
-To add a new locale, simply create a new file in config/locales. You can make your life easier by copying an existing
-locale and basing your new locale on it.
-
-Check installed locales
-=================
-
-To display a list of all locales installed in config/locales, you can use the following rake command:
-
-  rake locales
+   script/plugin install git://github.com/josevalim/localized_templates.git
 
-Changing the default locale
-=================
+If you are running on Rails 2.2, you should use version 0.3.1:
 
-If you want to use a default locale other than en-US, you have to tell the i18n plugin the locale you want to use by
-default. Simply put the following line in an initializer in config/initializers or include it in your environment.rb:
+    cd myapp
+    git clone git://github.com/josevalim/localized_tempaltes.git
+    cd vendor/plugins/localized_templates
+    git checkout v0.3.1
+    rm -rf ./.git
 
-    I18n.default_locale = 'de-AT'
 
 Bugs and Feedback
 =================
 
-If you discover any bugs, please send me an e-mail to jose.valim@gmail.com
-If you have positive feedback, that's fine too! =)
+If you discover any bugs, please send an e-mail to jose.valim@gmail.com
+If you just want to give some positive feedback or drop a line, that's fine too! =)
+
+Copyright (c) 2009 José Valim
+http://www.pagestacker.com/
+http://josevalim.blogspot.com/

data/Rakefile

@@ -2,17 +2,18 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-desc 'Run tests.'
+desc 'Run tests for Localized Templates.'
 Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc 'Generate documentation.'
+desc 'Generate documentation for Localized Templates.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SimpleLocalization'
+  rdoc.title    = 'Localized Templates'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/lib/localized_templates.rb

@@ -1,5 +1,2 @@
 require 'localized_rescue/actioncontroller/rescue'
-require 'localized_templates/actioncontroller/base'
-require 'localized_templates/actioncontroller/layout'
-require 'localized_templates/actionview/base'
-require 'localized_templates/actionview/partials'
+require 'localized_templates/actionview/paths'

data/lib/localized_templates/actionview/paths.rb

@@ -0,0 +1,29 @@
+module ActionView #:nodoc:
+  class PathSet < Array #:nodoc:
+
+    def find_template(original_template_path, format = nil)
+      return original_template_path if original_template_path.respond_to?(:render)
+      template_path = original_template_path.sub(/^\//, '')
+
+      each do |load_path|
+        if format && (template = load_path["#{I18n.locale}/#{template_path}.#{format}"])
+          return template
+        elsif format && (template = load_path["#{template_path}.#{format}"])
+          return template
+        elsif template = load_path["#{I18n.locale}/#{template_path}"]
+          return template
+        elsif template = load_path[template_path]
+          return template
+        # Try to find html version if the format is javascript
+        elsif format == :js && template = load_path["#{I18n.locale}/#{template_path}.html"]
+          return template
+        elsif format == :js && template = load_path["#{template_path}.html"]
+          return template
+        end
+      end
+
+      Template.new(original_template_path, self)
+    end
+
+  end
+end

data/test/localized_rescue_test.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/setup'
-require File.dirname(__FILE__) + '/../lib/localized_rescue.rb'
 
 class LocalizedRescueController < ActionController::Base
   def index
@@ -7,7 +6,7 @@ class LocalizedRescueController < ActionController::Base
   end
 end
 
-class LocalizedRescueTest < Test::Unit::TestCase
+class LocalizedRescueTest < ActionController::TestCase
 
   def setup
     @controller = LocalizedRescueController.new
@@ -40,4 +39,4 @@ class LocalizedRescueTest < Test::Unit::TestCase
     assert_equal body, @response.body
   end
 
-end
+end

data/test/localized_templates_test.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/setup'
-require File.dirname(__FILE__) + '/../lib/localized_templates.rb'
 
 class ProjectsController < ActionController::Base
   layout 'default'
@@ -16,7 +15,7 @@ class ProjectsController < ActionController::Base
   end
 end
 
-class LocalizedTemplatesTest < Test::Unit::TestCase
+class LocalizedTemplatesTest < ActionController::TestCase
 
   def setup
     @controller = ProjectsController.new
@@ -29,7 +28,7 @@ class LocalizedTemplatesTest < Test::Unit::TestCase
     get :index
 
     assert_response 200
-    assert_equal "<none>\n  none index view\n</none>", @response.body
+    assert_equal "<none>noneindexview</none>", @response.body.gsub(/\s/, '')
   end
 
   def test_render_rss_without_localization
@@ -38,7 +37,7 @@ class LocalizedTemplatesTest < Test::Unit::TestCase
     get :index
 
     assert_response 200
-    assert_equal "<none>text</none>\n", @response.body
+    assert_equal "<none>text</none>", @response.body.gsub(/\s/, '')
   end
 
   def test_render_with_localization
@@ -46,7 +45,7 @@ class LocalizedTemplatesTest < Test::Unit::TestCase
     get :index
 
     assert_response 200
-    assert_equal "<pt-BR>\n  pt-BR index view\n</pt-BR>", @response.body
+    assert_equal "<pt-BR>pt-BRindexview</pt-BR>", @response.body.gsub(/\s/, '')
   end
 
   def test_render_rss_with_localization
@@ -55,7 +54,7 @@ class LocalizedTemplatesTest < Test::Unit::TestCase
     get :index
 
     assert_response 200
-    assert_equal "<en_US>text</en_US>\n", @response.body
+    assert_equal "<en_US>text</en_US>", @response.body.gsub(/\s/, '')
   end
 
-end
+end

data/test/setup.rb

@@ -1,15 +1,29 @@
 # Those lines are plugin test settings
-ENV['RAILS_ENV'] = 'test'
+require 'test/unit'
+require 'rubygems'
 
-require File.dirname(__FILE__) + '/../../../../config/environment'
-require 'test_help'
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/test_process'
+
+require File.dirname(__FILE__) + '/../lib/localized_templates.rb'
 
 FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
 ActionController::Base.view_paths = FIXTURES_PATH
-Rails.public_path = "#{FIXTURES_PATH}/public"
+
+# Mock Rails! :)
+#
+class Rails
+  def self.public_path
+    "#{FIXTURES_PATH}/public"
+  end
+end
 
 ActionController::Routing::Routes.draw do |map|
   map.connect ':controller/:action/:id'
 end
 
-I18n.locale = 'en-US'
+I18n.locale = 'en-US'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-localized_templates
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: "0.4"
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -13,7 +13,7 @@ date: 2008-12-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Templates localization for Rails 2.2
+description: Another templates localization schema for Rails 2.3
 email: jose.valim@gmail.com
 executables: []
 
@@ -26,13 +26,8 @@ files:
 - README
 - Rakefile
 - lib/localized_templates.rb
-- lib/localized_rescue/README
 - lib/localized_rescue/actioncontroller/rescue.rb
-- lib/localized_templates/README
-- lib/localized_templates/actioncontroller/base.rb
-- lib/localized_templates/actioncontroller/layout.rb
-- lib/localized_templates/actionview/base.rb
-- lib/localized_templates/actionview/partials.rb
+- lib/localized_templates/actionview/paths.rb
 has_rdoc: true
 homepage: http://github.com/josevalim/localized_templates
 post_install_message: 
@@ -59,7 +54,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Templates localization for Rails 2.2
+summary: Another templates localization schema for Rails 2.3
 test_files: 
 - test/localized_rescue_test.rb
 - test/localized_templates_test.rb

data/lib/localized_rescue/README

@@ -1,10 +0,0 @@
-Localized rescue
-----------------
-
-This feature extends Rails rescue handling and allows the use of localized
-rescues like <code>en-US/404.html</code> on the public dir. The plugin will
-then pick the rescue page matching the currently used locale
-(<code>I18n#locale</code>).
-
-If the localized rescue page isn't found, the plugin will render the
-<code>404.html</code> file if it exists.

data/lib/localized_templates/README

@@ -1,24 +0,0 @@
-Localized templates
--------------------
-
-This feature extends Rails template handling and allows the use of localized
-templates on the root of your views folder like <code>pt-BR/projects/index.html.erb</code>.
-The plugin will pick the template matching the currently used locale
-(<code>I18n#locale</code>).
-
-If the localized template isn't found, the plugin will try to render the default
-<code>projects/index.html.erb</code>. If <code>index.html.erb</code> doesn't
-exist, a 404 will be raised.
-
-If you have a template that is the same for all languages (like a xml file)
-just keep it without localization: <code>index.xml.builder</code>.
-
-Theoretically, we just need to overwrite _pick_template and _pick_partial_template
-methods in order to have LocalizedTemplates, but memoize doesn't help
-since it doesn't see locale changes and would memoize values for only one locale.
-
-We can fix this by passing the locale to _pick_template as argument or creating a
-localized memoize, that would memoize different values based on the locale.
-
-For now, we will use the first solution: pass the locale to _pick_template. As
-consequence, we need to overwrite all methods that call _pick_template.

data/lib/localized_templates/actioncontroller/base.rb

@@ -1,12 +0,0 @@
-module ActionController
-  class Base
-
-    private
-      def template_exists?(template_name = default_template_name)
-        @template.send(:_pick_template, template_name, I18n.locale) ? true : false
-      rescue ActionView::MissingTemplate
-        false
-      end
-
-  end
-end

data/lib/localized_templates/actioncontroller/layout.rb

@@ -1,12 +0,0 @@
-module ActionController
-  class Base
-
-    private
-      def layout_directory?(layout_name)
-        @template.__send__(:_pick_template, "#{File.join('layouts', layout_name)}.#{@template.template_format}", I18n.locale) ? true : false
-      rescue ActionView::MissingTemplate
-        false
-      end
-
-  end
-end

data/lib/localized_templates/actionview/base.rb

@@ -1,93 +0,0 @@
-module ActionView
-  class Base
-    @@exempt_from_layout = Set.new([/\.rjs$/])
-
-    # Renders the template present at <tt>template_path</tt> (relative to the view_paths array).
-    # The hash in <tt>local_assigns</tt> is made available as local variables.
-    def render(options = {}, local_assigns = {}, &block) #:nodoc:
-      local_assigns ||= {}
-
-      if options.is_a?(String)
-        ActiveSupport::Deprecation.warn(
-          "Calling render with a string will render a partial from Rails 2.3. " +
-          "Change this call to render(:file => '#{options}', :locals => locals_hash)."
-        )
-
-        render(:file => options, :locals => local_assigns)
-      elsif options == :update
-        update_page(&block)
-      elsif options.is_a?(Hash)
-        options = options.reverse_merge(:locals => {})
-        if options[:layout]
-          _render_with_layout(options, local_assigns, &block)
-        elsif options[:file]
-          _pick_template(options[:file], I18n.locale).render_template(self, options[:locals])
-        elsif options[:partial]
-          render_partial(options)
-        elsif options[:inline]
-          InlineTemplate.new(options[:inline], options[:type]).render(self, options[:locals])
-        elsif options[:text]
-          options[:text]
-        end
-      end
-    end
-
-    private
-      def _pick_template(template_path, locale = nil)
-        return template_path if template_path.respond_to?(:render)
-
-        path = template_path.sub(/^\//, '')
-        if m = path.match(/(.*)\.(\w+)$/)
-          template_file_name, template_file_extension = m[1], m[2]
-        else
-          template_file_name = path
-        end
-
-        # Try to render locale/controller/action
-        if locale && template = _template_view_path_check("#{locale}/#{template_file_name}")
-          template
-        # Try to render controller/action
-        elsif template = _template_view_path_check(template_file_name)
-          template
-        else
-          template = Template.new(template_path, view_paths)
-
-          if self.class.warn_cache_misses && logger
-            logger.debug "[PERFORMANCE] Rendering a template that was " +
-              "not found in view path. Templates outside the view path are " +
-              "not cached and result in expensive disk operations. Move this " +
-              "file into #{view_paths.join(':')} or add the folder to your " +
-              "view path list"
-          end
-
-          template
-        end
-      end
-      memoize :_pick_template
-      
-      def _template_view_path_check(template_file_name)
-        # OPTIMIZE: Checks to lookup template in view path
-        if template = self.view_paths["#{template_file_name}.#{template_format}"]
-          template
-        elsif template = self.view_paths[template_file_name]
-          template
-        elsif (first_render = @_render_stack.first) && first_render.respond_to?(:format_and_extension) &&
-            (template = self.view_paths["#{template_file_name}.#{first_render.format_and_extension}"])
-          template
-        elsif template_format == :js && template = self.view_paths["#{template_file_name}.html"]
-          @template_format = :html
-          template
-        else
-          nil
-        end
-      end
-
-      def _exempt_from_layout?(template_path) #:nodoc:
-        template = _pick_template(template_path, I18n.locale).to_s
-        @@exempt_from_layout.any? { |ext| template =~ ext }
-      rescue ActionView::MissingTemplate
-        return false
-      end
-
-  end
-end

data/lib/localized_templates/actionview/partials.rb

@@ -1,65 +0,0 @@
-module ActionView
-  class Base
-
-    private
-      def render_partial(options = {}) #:nodoc:
-        local_assigns = options[:locals] || {}
-
-        case partial_path = options[:partial]
-        when String, Symbol, NilClass
-          if options.has_key?(:collection)
-            render_partial_collection(options)
-          else
-            _pick_partial_template(partial_path, I18n.locale).render_partial(self, options[:object], local_assigns)
-          end
-        when ActionView::Helpers::FormBuilder
-          builder_partial_path = partial_path.class.to_s.demodulize.underscore.sub(/_builder$/, '')
-          local_assigns.merge!(builder_partial_path.to_sym => partial_path)
-          render_partial(:partial => builder_partial_path, :object => options[:object], :locals => local_assigns)
-        when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope
-          render_partial_collection(options.except(:partial).merge(:collection => partial_path))
-        else
-          object = partial_path
-          render_partial(
-            :partial => ActionController::RecordIdentifier.partial_path(object, controller.class.controller_path),
-            :object => object,
-            :locals => local_assigns
-          )
-        end
-      end
-
-      def render_partial_collection(options = {}) #:nodoc:
-        return nil if options[:collection].blank?
-
-        partial = options[:partial]
-        spacer = options[:spacer_template] ? render(:partial => options[:spacer_template]) : ''
-        local_assigns = options[:locals] ? options[:locals].clone : {}
-        as = options[:as]
-
-        index = 0
-        options[:collection].map do |object|
-          _partial_path ||= partial ||
-            ActionController::RecordIdentifier.partial_path(object, controller.class.controller_path)
-          template = _pick_partial_template(_partial_path, I18n.locale)
-          local_assigns[template.counter_name] = index
-          result = template.render_partial(self, object, local_assigns.dup, as)
-          index += 1
-          result
-        end.join(spacer)
-      end
-
-      def _pick_partial_template(partial_path, locale = nil) #:nodoc:
-        if partial_path.include?('/')
-          path = File.join(File.dirname(partial_path), "_#{File.basename(partial_path)}")
-        elsif controller
-          path = "#{controller.class.controller_path}/_#{partial_path}"
-        else
-          path = "_#{partial_path}"
-        end
-
-        _pick_template(path, locale)
-      end
-      memoize :_pick_partial_template
-
-  end
-end