i18n-inflector-rails 0.1.0 → 0.2.0

data/ChangeLog

@@ -1,3 +1,21 @@
+commit 15e330e957f34579fa95aa2036f0c06fd168ab54
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 16 07:06:57 2011 +0100
+
+    Documentation updated
+
+commit e10a3bbbc25c053529976d82a0304819b7235213
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 16 07:02:19 2011 +0100
+
+    additional_options.rb renamed to options.rb, HISTORY updated
+
+commit 097cc40da6bd9edec7231dd96a7b3197c5133888
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jan 16 06:46:28 2011 +0100
+
+    Added conditional checking if method to be called exists, dependencies fixed
+
 commit 807a61dea750e19bd52fb350d34609e259557bbd
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Fri Jan 14 18:05:40 2011 +0100

data/Gemfile

@@ -2,16 +2,15 @@
 
 source :gemcutter
 
-gem "i18n-inflector", "~>2.0.0"
-gem "railties", "~>3.0.0"
-gem "actionpack", "~>3.0.0"
+gem "i18n-inflector", "~>2.0"
+gem "railties", "~>3.0"
+gem "actionpack", "~>3.0"
 
 gem "hoe-yard", ">=0.1.2", :group => [:development, :test]
 gem "rspec", ">=2.3.0", :group => [:development, :test]
 gem "yard", ">=0.6.4", :group => [:development, :test]
 gem "bundler", ">=1.0.7", :group => [:development, :test]
 gem "hoe-bundler", ">=1.0.0", :group => [:development, :test]
-gem "hoe-yard", ">=0.1.2", :group => [:development, :test]
 gem "hoe", ">=2.8.0", :group => [:development, :test]
 
 # vim: syntax=ruby

data/Manifest.txt

@@ -17,6 +17,7 @@ init.rb
 lib/i18n-inflector-rails.rb
 lib/i18n-inflector-rails/errors.rb
 lib/i18n-inflector-rails/inflector.rb
+lib/i18n-inflector-rails/options.rb
 lib/i18n-inflector-rails/railtie.rb
 lib/i18n-inflector-rails/version.rb
 spec/inflector_spec.rb

data/README.rdoc

@@ -1,6 +1,6 @@
 = Simple I18n Inflector for Rails
 
-<b>i18n-inflector-rails version <tt>1.0</tt></b> (<b><tt>Sexparty</tt></b>)
+<b>i18n-inflector-rails version <tt>0.1</tt></b> (<b><tt>Sexparty</tt></b>)
 
 
 

data/Rakefile

@@ -41,14 +41,17 @@ Hoe.spec 'i18n-inflector-rails' do
   self.readme_file     = 'README.rdoc'
   self.history_file    = 'docs/HISTORY'
   
-  extra_deps          << ['i18n-inflector',   '~> 2.0.0'] <<
-                         ['railties',         '~> 3.0.0'] <<
-                         ['actionpack',       '~> 3.0.0']
+  extra_deps          << ['i18n-inflector',   '~> 2.0'] <<
+                         ['railties',         '~> 3.0'] <<
+                         ['actionpack',       '~> 3.0']
   extra_dev_deps      << ['rspec',            '>= 2.3.0'] <<
                          ['yard',             '>= 0.6.4'] <<
                          ['bundler',          '>= 1.0.7'] <<
-                         ['hoe-bundler',      '>= 1.0.0'] <<
-                         ['hoe-yard',         '>= 0.1.2']
+                         ['hoe-bundler',      '>= 1.0.0']
+  
+  unless extra_dev_deps.flatten.include?('hoe-yard')
+    extra_dev_deps << ['hoe-yard', '>= 0.1.2']
+  end
 end
 
 task 'Manifest.txt' do

data/docs/HISTORY

@@ -1,9 +1,15 @@
+=== 0.2.0 / 2011-01-15
+
+* 1 major enhancement
+
+  * Added switch that causes any method from current context to be tested if is callable
+
 === 0.1.0 / 2011-01-11
 
 * 2 major enhancements
 
   * Compatible with Rails 3
-  * no_inflection_method added disable previously added method as not affecting translate()
+  * no_inflection_method added; it disables previously added method from using by translate()
 
 === 0.0.1 / 2011-01-02
 

data/i18n-inflector-rails.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.5'
   s.specification_version = 3
 
-  s.add_dependency 'i18n-inflector',          '~> 2.0.0'
-  s.add_dependency 'railties',                '~> 3.0.0'
-  s.add_dependency 'actionpack',              '~> 3.0.0'
+  s.add_dependency 'i18n-inflector',          '~> 2.0'
+  s.add_dependency 'railties',                '~> 3.0'
+  s.add_dependency 'actionpack',              '~> 3.0'
   s.add_development_dependency 'rspec',       '>= 2.3.0'
   s.add_development_dependency 'yard',        '>= 1.0.7'
   s.add_development_dependency 'hoe-bundler', '>= 1.0.0'

data/lib/i18n-inflector-rails.rb

@@ -3,8 +3,11 @@
 require 'i18n-inflector'
 require 'i18n-inflector-rails/version'
 require 'i18n-inflector-rails/errors'
+require 'i18n-inflector-rails/options'
 require 'i18n-inflector-rails/inflector'
 
+I18n::Inflector::InflectionOptions.send(:include, I18n::Inflector::Rails::AdditionalOptions)
+
 if defined? Rails::Engine
 
   require 'i18n-inflector-rails/railtie'

data/lib/i18n-inflector-rails/inflector.rb

@@ -143,21 +143,35 @@ module I18n
         # @return [String] the translated string with inflection patterns
         #   interpolated
         def translate(*args)
-          test_locale = args.last.is_a?(Hash) ? args.last[:locale] : nil
+          opts_present  = args.last.is_a?(Hash)
+          if opts_present
+            options = args.last
+            test_locale = options[:locale]
+          else
+            options = {}
+          end
           test_locale ||= I18n.locale
-          return super unless I18n.backend.inflector.inflected_locale?(test_locale)
+          inflector = I18n.backend.inflector
+
+          # use standard translate if the locale is not supported
+          return super unless inflector.inflected_locale?(test_locale)
+
+          # read switch
+          verifies = options.delete(:inflector_verify_methods)
+          verifies = verifies.nil? ? inflector.options.verify_methods : verifies
 
           # collect inflection variables that are present in this context
-          subopts = t_prepare_inflection_options
+          subopts  = t_prepare_inflection_options(inflector, verifies)
   
           # jump to original translate if no variables are present
           return super if subopts.empty?
-  
-          options = args.last.is_a?(Hash) ? args.pop : {}
+
+          # pass options
+          args.pop if opts_present
           args.push subopts.merge(options)
           super
         end
-        
+
         alias_method :t, :translate
   
         protected
@@ -165,10 +179,12 @@ module I18n
         # This method tries to read +i18n_inflector_methods+ available in the current context.
         # 
         # @return [Hash] the inflection options (<tt>kind => value</tt>)
-        def t_prepare_inflection_options
+        def t_prepare_inflection_options(inflector, verifies)
           subopts = {}
+          return subopts if (verifies && !respond_to?(:i18n_inflector_methods))
           i18n_inflector_methods.each_pair do |m, obj|
-            next if obj.nil?
+            next if obj.nil?                        # method registered but disabled from usage
+            next if (verifies && !respond_to?(m))   # verify_methods enabled
             value = method(m).call
             proca = obj[:proc]
             kind  = obj[:kind]

data/lib/i18n-inflector-rails/options.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+#
+# Author::    Paweł Wilk (mailto:pw@gnu.org)
+# Copyright:: (c) 2011 by Paweł Wilk
+# License::   This program is licensed under the terms of {file:LGPL-LICENSE GNU Lesser General Public License} or {file:COPYING Ruby License}.
+# 
+# This file contains I18n::Inflector::Rails::AdditionalOptions module,
+# which extends I18n::Inflector::InflectionOptions so new switches controlling
+# inflector's behavior are available.
+
+module I18n
+  module Inflector
+    module Rails
+      
+      # This module adds options to {I18n::Inflector::InflectionOptions}
+      module AdditionalOptions
+
+        attr_writer :verify_methods
+
+        # When this is set to +true+ then
+        # inflection works a bit slower but
+        # checks whether any method exists before
+        # calling it. This switch is by default set
+        # to +false+.
+        # 
+        # By turning this switch on you're sure that
+        # there will be no +NameError+ (no method) exception
+        # raised during translation.
+        # 
+        # Alternatively you can turn this locally,
+        # for the specified translate call, by setting
+        # <tt>:inflector_verify_methods</tt> option to +true+.
+        #    
+        # @example Globally enabling methods verification
+        #   I18n.inflector.options.verify_methods = true
+        # @example Locally enabling methods verification
+        #   translate('welcome', :inflector_verify_methods => true)
+        def verify_methods
+          @verify_methods || false
+        end 
+
+        # This method resets inflector's
+        # switches to default values.
+        def reset
+          @verify_methods = false
+          super
+        end
+
+      end
+    end
+  end
+end

data/lib/i18n-inflector-rails/version.rb

@@ -15,7 +15,7 @@ module I18n
       # @private
       EMAIL       = 'pw@gnu.org'
       # @private
-      VERSION     = '0.1.0'
+      VERSION     = '0.2.0'
       # @private
       NAME        = 'i18n-inflector-rails'
       # @private
@@ -23,7 +23,7 @@ module I18n
       # @private
       URL         = 'https://rubygems.org/gems/i18n-inflector-rails/'
       # @private
-      DESCRIPTION = 'This plug-in provides I18n Inflector module bindings for Rails.'
+      DESCRIPTION = 'Plug-in that provides I18n Inflector module integration with Rails.'
 
     end
   end

data/spec/inflector_spec.rb

@@ -3,6 +3,22 @@ require 'spec_helper'
 class ApplicationController < ActionController::Base;       end
 class InflectedTranslateController < ApplicationController; end
 
+describe I18n.inflector.options.class do
+
+  context "instance I18n.inflector.options" do
+
+    it "should contain verify_methods switch" do
+      I18n.inflector.options.should respond_to :verify_methods
+    end
+
+    it "should have default value set to false" do
+      I18n.inflector.options.verify_methods.should == false
+    end
+
+  end
+
+end
+
 describe ApplicationController do
 
   before do
@@ -28,7 +44,7 @@ describe ApplicationController do
    I18n.backend.store_translations(:xx, 'to_be'   => 'Oh @{i:I am|you:You are|it:It is}')
 
   end
-  
+
   describe ".inflection_method" do
     
     before do
@@ -145,10 +161,17 @@ describe ApplicationController do
         inflection_method :person
       end
 
+      class NomethodController < InflectedTranslateController
+        inflection_method :nonexistent => :gender
+        def translate_male;     translate('welcome') end
+        def translate_male_opt; translate('welcome', :inflector_verify_methods => true) end
+      end
+
       @controller             = InflectedTranslateController.new
       @person_controller      = InflectedLambdedController.new
       @personprim_controller  = InflectedLambdedPrimController.new
-      
+      @nomethod_controller    = NomethodController.new
+
       @expected_hash = {:users_gender=>{:kind=>:gender, :proc=>nil},
                         :time=>{:kind=>:time, :proc=>nil}}
 
@@ -186,6 +209,16 @@ describe ApplicationController do
         @person_controller.translated_person.should == 'Oh It is'
       end
 
+      it "should raise exception when method does not exists" do
+        lambda{@nomethod_controller.translated_male}.should raise_error(NameError)
+      end
+
+      it "should not raise when method does not exists and verify_methods is enabled" do
+        lambda{@nomethod_controller.translate_male_opt}.should_not raise_error(NameError)
+        I18n.inflector.options.verify_methods = true
+        lambda{@nomethod_controller.translate_male}.should_not raise_error(NameError)
+      end
+
     end
     
     describe "#t" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Wilk"
@@ -34,7 +34,7 @@ cert_chain:
   NK3TIZaPCh1S2/ES6wXNvjQ+5EnEEL9j/pSEop9DYEBPaM2WDVR5i0jJTAaRWw==
   -----END CERTIFICATE-----
 
-date: 2011-01-14 00:00:00 +01:00
+date: 2011-01-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,8 +47,7 @@ dependencies:
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        version: "2.0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -62,8 +61,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   prerelease: false
   version_requirements: *id002
@@ -77,8 +75,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   prerelease: false
   version_requirements: *id003
@@ -157,24 +154,9 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: hoe-yard
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 2
-        version: 0.1.2
-  type: :development
-  prerelease: false
-  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: hoe
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -186,8 +168,8 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *id010
-description: This plug-in provides I18n Inflector module bindings for Rails.
+  version_requirements: *id009
+description: Plug-in that provides I18n Inflector module integration with Rails.
 email: 
 - pw@gnu.org
 executables: []
@@ -216,6 +198,7 @@ files:
 - lib/i18n-inflector-rails.rb
 - lib/i18n-inflector-rails/errors.rb
 - lib/i18n-inflector-rails/inflector.rb
+- lib/i18n-inflector-rails/options.rb
 - lib/i18n-inflector-rails/railtie.rb
 - lib/i18n-inflector-rails/version.rb
 - spec/inflector_spec.rb
@@ -236,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4495580092988893056
+      hash: 2397947838501194867
       segments: 
       - 0
       version: "0"
@@ -245,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4495580092988893056
+      hash: 2397947838501194867
       segments: 
       - 0
       version: "0"