josevalim-localized_templates 0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Thomas Preston-Werner
+
+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

@@ -0,0 +1,76 @@
+Copyright (c) 2008 José Valim (jose.valim@gmail.com)
+http://www.pagestacker.com/
+http://josevalim.blogspot.com/
+License: MIT
+Version: 0.2
+
+LocalizedTemplates
+==================
+
+This plugin uses Rails I18n (http://rails-i18n.org/) to allow templates localization.
+You can localize your views using the following naming convention:
+
+  <tt>pt-BR/projects/index.html.erb</tt>
+  <tt>en-US/projects/edit.rss.builder</tt>
+  
+  OR:
+
+  <tt>projects/pt-BR/index.html.erb</tt>
+  <tt>projects/en-US/index.html.erb</tt>
+
+And you can also localize rescue files:
+
+  <tt>public/pt-BR/404.html</tt>
+  <tt>public/en-US/404.html</tt>
+
+If you don't want to localize a file (like a xml file), simply don't change it and it will be
+rendered as default to all languages.
+
+Installation
+=================
+
+Install LocalizedTemplates is very easy. It is stored in GitHub, so if you have
+never installed a gem via GitHub run 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:
+
+  config.gem "josevalim-localized_templates",  :lib => "localized_templates", :source => "http://gems.github.com"
+
+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
+
+Changing the default locale
+=================
+
+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:
+
+    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! =)

data/Rakefile

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

data/init.rb

@@ -0,0 +1,3 @@
+# Load all source files in the lib directory.
+require 'localized_templates'
+require 'localized_rescue'

data/lib/localized_rescue.rb

@@ -0,0 +1,11 @@
+# = 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.
+# 
+require 'localized_rescue/actioncontroller/rescue'

data/lib/localized_rescue/actioncontroller/rescue.rb

@@ -0,0 +1,27 @@
+module ActionController
+  class Base
+
+    protected
+      # Attempts to render a static error page based on the <tt>status_code</tt> thrown,
+      # or just return headers if no such file exists. For example, if a 500 error is 
+      # being handled Rails will first attempt to render the file at the current locale
+      # such as <tt>public/en-US/500.html</tt>. Then the file with no locale
+      # <tt>public/500.html</tt>. If the files doesn't exist, the body of the response
+      # will be left empty.
+      #
+      def render_optional_error_file(status_code)
+        status = interpret_status(status_code)
+        locale_path = "#{Rails.public_path}/#{I18n.locale}/#{status[0,3]}.html" if I18n.locale
+        path = "#{Rails.public_path}/#{status[0,3]}.html"
+
+        if locale_path && File.exist?(locale_path)
+          render :file => locale_path, :status => status
+        elsif File.exist?(path)
+          render :file => path, :status => status
+        else
+          head status
+        end
+      end
+
+  end
+end

data/lib/localized_templates.rb

@@ -0,0 +1,28 @@
+# = Localized templates
+# 
+# This feature extends Rails template handling and allows the use of localized
+# templates like <code>projects/pt-BR/index.html.erb</code> or
+# <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
+# <code>prjects/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.
+#
+require 'localized_templates/actioncontroller/base'
+require 'localized_templates/actioncontroller/layout'
+require 'localized_templates/actionview/base'
+require 'localized_templates/actionview/partials'

data/lib/localized_templates/actioncontroller/base.rb

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,96 @@
+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/locale/action
+        elsif locale && template = _template_view_path_check(template_file_name.gsub(/\//, "/#{locale}/"))
+          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

@@ -0,0 +1,65 @@
+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).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

data/test/fixtures/en-US.yml

@@ -0,0 +1,2 @@
+"en-US":
+  about: "language fixture"

data/test/fixtures/layouts/default.html.erb

@@ -0,0 +1,3 @@
+<none>
+  <%= yield %>
+</none>

data/test/fixtures/projects/en-US/index.rss.builder

@@ -0,0 +1 @@
+xml.en_US "text"

data/test/fixtures/projects/index.html.erb

@@ -0,0 +1 @@
+none index view

data/test/fixtures/projects/index.rss.builder

@@ -0,0 +1 @@
+xml.none "text"

data/test/fixtures/projects/pt-BR/index.html.erb

@@ -0,0 +1 @@
+pt-BR index view

data/test/fixtures/pt-BR.yml

@@ -0,0 +1,2 @@
+"pt-BR":
+  about: "language fixture"

data/test/fixtures/pt-BR/layouts/default.html.erb

@@ -0,0 +1,3 @@
+<pt-BR>
+  <%= yield %>
+</pt-BR>

data/test/fixtures/public/500.html

@@ -0,0 +1 @@
+500 error fixture

data/test/fixtures/public/en-US/404.html

@@ -0,0 +1 @@
+404 en-US error fixture

data/test/fixtures/public/pt-BR/404.html

@@ -0,0 +1 @@
+404 pt-BR error fixture

data/test/localized_rescue_test.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/setup'
+require File.dirname(__FILE__) + '/../lib/localized_rescue.rb'
+
+class LocalizedRescueController < ActionController::Base
+  def index
+    render_optional_error_file params[:id]
+  end
+end
+
+class LocalizedRescueTest < Test::Unit::TestCase
+
+  def setup
+    @controller = LocalizedRescueController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_render_optional_error_file_without_localization
+    I18n.locale = 'en-US'
+    get :index, :id => 500
+
+    assert_response 500
+    body = File.read("#{FIXTURES_PATH}/public/500.html")
+    assert_equal body, @response.body
+  end
+
+  def test_render_optional_error_file_with_localization
+    I18n.locale = 'en-US' 
+    get :index, :id => 404
+
+    assert_response 404
+    body = File.read("#{FIXTURES_PATH}/public/en-US/404.html")
+    assert_equal body, @response.body
+
+    I18n.locale = 'pt-BR' 
+    get :index, :id => 404
+
+    assert_response 404
+    body = File.read("#{FIXTURES_PATH}/public/pt-BR/404.html")
+    assert_equal body, @response.body
+  end
+
+end

data/test/localized_templates_test.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/setup'
+require File.dirname(__FILE__) + '/../lib/localized_templates.rb'
+
+class ProjectsController < ActionController::Base
+  layout 'default'
+
+  def index
+    respond_to do |format|
+      format.html {
+        #
+      }
+      format.rss{
+        render :layout => false
+      }
+    end
+  end
+end
+
+class LocalizedTemplatesTest < Test::Unit::TestCase
+
+  def setup
+    @controller = ProjectsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_render_without_localization
+    I18n.locale = 'en-US'
+    get :index
+
+    assert_response 200
+    assert_equal "<none>\n  none index view\n</none>", @response.body
+  end
+
+  def test_render_rss_without_localization
+    I18n.locale = 'pt-BR'
+    @request.env['CONTENT_TYPE'] = Mime::EXTENSION_LOOKUP['rss'].to_s
+    get :index
+
+    assert_response 200
+    assert_equal "<none>text</none>\n", @response.body
+  end
+
+  def test_render_with_localization
+    I18n.locale = 'pt-BR'
+    get :index
+
+    assert_response 200
+    assert_equal "<pt-BR>\n  pt-BR index view\n</pt-BR>", @response.body
+  end
+
+  def test_render_rss_with_localization
+    I18n.locale = 'en-US'
+    @request.env['CONTENT_TYPE'] = Mime::EXTENSION_LOOKUP['rss'].to_s
+    get :index
+
+    assert_response 200
+    assert_equal "<en_US>text</en_US>\n", @response.body
+  end
+
+end

data/test/setup.rb

@@ -0,0 +1,15 @@
+# Those lines are plugin test settings
+ENV['RAILS_ENV'] = 'test'
+
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require 'test_help'
+
+FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+ActionController::Base.view_paths = FIXTURES_PATH
+Rails.public_path = "#{FIXTURES_PATH}/public"
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+I18n.locale = 'en-US'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: josevalim-localized_templates
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-29 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Templates localization for Rails 2.2
+email: jose.valim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/localized_rescue.rb
+- lib/localized_templates.rb
+- lib/localized_rescue/actioncontroller/rescue.rb
+- lib/localized_templates/actioncontroller/base.rb
+- lib/localized_templates/actioncontroller/layout.rb
+- lib/localized_templates/actionview/base.rb
+- lib/localized_templates/actionview/partials.rb
+has_rdoc: true
+homepage: http://github.com/josevalim/localized_templates
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Templates localization for Rails 2.2
+test_files: 
+- test/localized_rescue_test.rb
+- test/localized_templates_test.rb
+- test/setup.rb
+- test/fixtures/en-US.yml
+- test/fixtures/pt-BR.yml
+- test/fixtures/layouts/default.html.erb
+- test/fixtures/projects/index.html.erb
+- test/fixtures/projects/index.rss.builder
+- test/fixtures/projects/en-US/index.rss.builder
+- test/fixtures/projects/pt-BR/index.html.erb
+- test/fixtures/pt-BR/layouts/default.html.erb
+- test/fixtures/public/500.html
+- test/fixtures/public/en-US/404.html
+- test/fixtures/public/pt-BR/404.html