i18n_auto_scoping 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+0.2.0 (Apr 12, 2010)
+
+* Releasing Gem
+
+0.1.0 (Apr 08, 2010)
+
+* Initial release

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,16 @@
+= I18nAutoScoping
+
+I18nAutoScoping is a plugin for Ruby on Rails that lets you easily add auto-scope in your I18n translation.
+It is very useful if you do not want to add every time the scope in your views ! Especially if your are working on big projects !
+
+All necessary informations are available on the wiki : http://wiki.github.com/kwi/i18n_autoscoping
+
+* I18nAutoScoping is thread safe.
+* I18nAutoScoping works with Rails 2.x and Rails 3
+
+== TODO
+
+* Another bug fix ?
+
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+
+desc "Run specs for current Rails version"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'i18n_auto_scoping'

data/lib/action_view_extension.rb

@@ -0,0 +1,19 @@
+# Auto scoping for ActionView
+module ActionView
+  class Base
+    alias_method :i18n_auto_scoping_aliased_render, :render
+
+    # To set a default scope for all render
+    def render(opts = {}, *args)
+      old_auto_scope_in_render = Thread.current[:last_i18n_auto_scope_render_in_render]
+      old_auto_scope = Thread.current[:last_i18n_auto_scope_render]
+      Thread.current[:last_i18n_auto_scope_render_in_render] = true
+      Thread.current[:last_i18n_auto_scope_render] = nil
+
+      i18n_auto_scoping_aliased_render(opts, *args)
+    ensure
+      Thread.current[:last_i18n_auto_scope_render] = old_auto_scope
+      Thread.current[:last_i18n_auto_scope_render_in_render] = old_auto_scope_in_render
+    end
+  end
+end

data/lib/i18n_auto_scoping.rb

@@ -0,0 +1,122 @@
+module I18nAutoScoping
+  module ActionControllerDefaultScope
+
+    def set_default_i18n_scope
+      I18n::Scope.default = "controllers/#{params[:controller]}"
+    end
+
+  end
+  
+  module I18nExtension
+
+    def self.included(mod)
+      mod.class_eval do
+        class << self
+          alias_method :i18n_auto_scoping_backend=, :backend=
+        
+          def backend=(backend)
+            r = send(:i18n_auto_scoping_backend=, backend)
+            # When assigning a new backend, we try to extend it :
+            extend_backend_for_i18n_auto_scoping
+            r
+          end
+
+          def extend_backend_for_i18n_auto_scoping
+            # Only extend the backend for auto scoping if it had not been already done
+            if !backend.methods.include?('i18n_auto_scoping_translate')
+              backend.extend ::I18nAutoScoping::BackendExtension
+            end
+
+          end
+        end
+      
+      end
+    end
+
+  end
+
+  module BackendExtension
+
+    def self.extended(k)
+      k.class_eval do
+        alias_method :i18n_auto_scoping_translate, :translate
+        
+        # Override translate method in order to set autoscoping
+        def translate(locale, key, options = {})
+          # Set the default scope if needed
+          if !options.has_key?(:scope) or options[:scope] == :autoscoping
+            options[:scope] = I18n::Scope.default 
+          end
+          i18n_auto_scoping_translate(locale, key, options)
+        end
+      end
+    end
+
+  end
+end
+
+#i18n extension for having default namespacing
+module I18n
+  module Scope
+    class << self
+      # Set a default scope
+      def default=(scope)
+        Thread.current[:i18n_default_scope] = (scope.is_a?(String)) ? scope.gsub('/', '.') : scope
+      end
+
+      def default
+        # Temporarly default scope go first
+        return Thread.current[:i18n_temporarly_default_scope] if Thread.current[:i18n_temporarly_default_scope]
+        
+        # Then, if we are in a render, we try to get the current scope by scanning the caller stack
+        if Thread.current[:last_i18n_auto_scope_render_in_render]
+          # Cache the analyse of the caller stack result for performance
+          return (Thread.current[:last_i18n_auto_scope_render] ||= get_scope_views_context)
+        end
+
+        # Finally, if there is no scope before, return the default scope
+        Thread.current[:i18n_default_scope]
+      end
+
+      # Inspired from : http://github.com/yar/simple_loc_compat
+      # Return the current view file, only work in app/views folder
+      def get_scope_views_context
+        stack_to_analyse = caller
+        latest_app_file = caller.detect { |level| level =~ /.*\/app\/views\// }
+        return nil unless latest_app_file
+        
+        scope = latest_app_file.match(/([^:]+):\d+.*/)[1]
+        path = scope.split('/app/views/').last
+        scope = File.basename(path, File.extname(path))
+        # If there is a second extension we keep it, in order to work with .erb.html or .erb.iphone, etc...
+        scope = "#{File.dirname(path)}/#{scope}" if File.dirname(path) != '.'
+
+        scope.gsub!('/', '.')
+
+        scope.to_sym
+      end
+
+      def temporarly_change(scope)
+        old = Thread.current[:i18n_temporarly_default_scope]
+        Thread.current[:i18n_temporarly_default_scope] = scope
+        r = yield
+        Thread.current[:i18n_temporarly_default_scope] = old
+        return r
+      end
+    end
+  end
+end
+
+
+if defined? ActionView
+  require 'action_view_extension'
+end
+
+I18n.send :include, I18nAutoScoping::I18nExtension
+I18n.extend_backend_for_i18n_auto_scoping
+
+# Auto namespacing default in controller : controllers/controller_name
+if defined? ActionController
+  ActionController::Base.send :include, I18nAutoScoping::ActionControllerDefaultScope
+  ActionController::Base.send :before_filter, :set_default_i18n_scope
+end

data/spec/app/views/_partial.erb

@@ -0,0 +1 @@
+<%= I18n.t(:hi) %>

data/spec/app/views/folder/_partial.erb

@@ -0,0 +1 @@
+<%= I18n.t(:hi) %>

data/spec/app/views/nested.erb

@@ -0,0 +1 @@
+<%= render :partial => 'partial' %>

data/spec/app/views/nested_nested.erb

@@ -0,0 +1 @@
+<%= render 'folder/partial' %>

data/spec/app/views/view.erb

@@ -0,0 +1 @@
+<%= I18n.t(:hi) %>

data/spec/app/views/view_with_temporarly_change.erb

@@ -0,0 +1,3 @@
+<%= I18n::Scope.temporarly_change(:test_scope) do
+  I18n.t(:hi)
+end %>

data/spec/i18n_auto_scoping/i18n_auto_scoping_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe :i18n_auto_scoping do
+  before(:all) do
+    @v = ActionView::Base.new([File.join(File.dirname(__FILE__), '../app/views/')], {}, FakeController.new)
+  end
+
+  it "should still keep working without scope" do
+    I18n.t(:hi).should == 'Hello'
+  end
+
+  it "should still keep working with scope" do
+    I18n.t(:hi, :scope => :bam).should == 'Hello in Bam'
+  end
+
+  it "Should works with scope temporarly changed" do
+    I18n::Scope.temporarly_change(:test_scope) do
+      I18n.t(:hi).should == 'Hello in Test Scope'
+    end
+  end
+
+  it "Should works with action view template" do
+    @v.render(:file => 'view').should == 'Hello in view'
+  end
+
+  it "Should work with action view partial without the underscore" do
+    @v.render('partial').should == 'Hello in partial'
+  end
+
+  it "Should works with action view nested template" do
+    @v.render(:file => 'nested').should == 'Hello in partial'
+  end
+
+  it "Should works with action view nested nested template" do
+    @v.render(:file => 'nested_nested').should == 'Hello in nested partial'
+  end
+  
+  it "Should works with scope temporarly changed in view" do
+    @v.render(:file => 'view_with_temporarly_change').should == 'Hello in Test Scope'
+  end
+
+end

data/spec/locales/en.yml

@@ -0,0 +1,13 @@
+:en:
+  :hi: 'Hello'
+  :test_scope:
+    :hi: 'Hello in Test Scope'
+  :bam:
+    :hi: 'Hello in Bam'
+  :view:
+    :hi: 'Hello in view'
+  :_partial:
+    :hi: 'Hello in partial'
+  :folder:
+    :_partial:
+      :hi: 'Hello in nested partial'

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'spec'
+
+require 'i18n'
+require 'action_controller'
+require 'action_view'
+
+# Add I18n load_path
+I18n.load_path = (I18n.load_path << Dir[File.join(File.dirname(__FILE__), 'locales', '*.yml')]).uniq
+
+require File.dirname(__FILE__) + '/../init.rb'
+
+class FakeController
+  def self.method_missing(meth)
+    return nil
+  end
+
+  def params
+    {:controller => :fake, :action => :show}
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_auto_scoping
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: I18nAutoScoping is a plugin for Ruby on Rails that lets you easily add auto-scope in your I18n translation. It is very useful if you do not want to add every time the scope in your views ! Especially if your are working on big projects !
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/action_view_extension.rb
+- lib/i18n_auto_scoping.rb
+- spec/app/views/_partial.erb
+- spec/app/views/folder/_partial.erb
+- spec/app/views/nested.erb
+- spec/app/views/nested_nested.erb
+- spec/app/views/view.erb
+- spec/app/views/view_with_temporarly_change.erb
+- spec/i18n_auto_scoping/i18n_auto_scoping_spec.rb
+- spec/locales/en.yml
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/i18n_auto_scoping
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: i18n_auto_scoping
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: I18nAutoScoping lets you easily add auto-scope in your I18n translations for your Rails' views.
+test_files: []
+