i18nliner 0.0.6 → 0.0.7

data/README.md

@@ -331,16 +331,10 @@ modification.
 
 I18nliner requires at least Ruby 1.9.3 and Rails 3.
 
-## What about JavaScript/Handlebars?
-
-[Coming](https://github.com/jenseng/i18nliner-js) [soon](https://github.com/fivetanley/i18ninliner-handlebars).
-I18nliner was inspired by some [I18n extensions](https://github.com/instructure/canvas-lms/tree/master/lib/i18n_extraction)
-I did in [Canvas-LMS](https://github.com/instructure/canvas-lms). While
-it also has the JavaScript/Handlebars equivalents, they are tightly
-coupled to Canvas-LMS and are written in Ruby. So basically we're talking
-a full reimplementation in JavaScript using
-[esprima](http://esprima.org/) instead of the [shameful, brittle, regexy hack](http://cdn.memegenerator.net/instances/400x/24091937.jpg)
-that is js_extractor.
+## Related Projects
+
+* [i18nliner-js](https://github.com/jenseng/i18nliner-js)
+* [i18nliner-handlebars](https://github.com/fivetanley/i18nliner-handlebars)
 
 ## License
 

data/lib/i18nliner/call_helpers.rb

@@ -7,8 +7,8 @@ module I18nliner
     ALLOWED_PLURALIZATION_KEYS = [:zero, :one, :few, :many, :other]
     REQUIRED_PLURALIZATION_KEYS = [:one, :other]
 
-    def normalize_key(key, scope = Scope.root)
-      scope.normalize_key(key.to_s)
+    def normalize_key(key, scope, inferred)
+      scope.normalize_key(key.to_s, inferred)
     end
 
     def normalize_default(default, translate_options = {}, options = {})
@@ -78,6 +78,7 @@ module I18nliner
     def key_provided?(key_or_default = nil, default_or_options = nil, maybe_options = nil, *others)
       return false if key_or_default.is_a?(Hash)
       return true if key_or_default.is_a?(Symbol)
+      raise ArgumentError.new("invalid key_or_default argument. expected String, Symbol or Hash, got #{key_or_default.class}") unless key_or_default.is_a?(String)
       return true if default_or_options.is_a?(String)
       return true if maybe_options
       return true if key_or_default =~ /\A\.?(\w+\.)+\w+\z/
@@ -90,21 +91,26 @@ module I18nliner
       (hash.keys - ALLOWED_PLURALIZATION_KEYS).size == 0
     end
 
-    def infer_arguments(args, meta = {})
+    def infer_arguments(args)
+      raise ArgumentError.new("wrong number of arguments (#{args.size} for 1..3)") if args.empty? || args.size > 3
       if args.size == 2 && args[1].is_a?(Hash) && args[1][:default]
         return args
       end
 
       has_key = key_provided?(*args)
-      meta[:inferred_key] = !has_key
       args.unshift infer_key(args[0]) unless has_key
 
+      default = nil
       default_or_options = args[1]
       if args[2] || default_or_options.is_a?(String) || pluralization_hash?(default_or_options)
-        options = args[2] ||= {}
-        options[:default] = args.delete_at(1) if options.is_a?(Hash)
+        default = args.delete_at(1)
       end
       args << {} if args.size == 1
+      options = args[1]
+      raise ArgumentError.new("invalid default translation. expected Hash or String, got #{default.class}") unless default.nil? || default.is_a?(String) || default.is_a?(Hash)
+      raise ArgumentError.new("invalid options argument. expected Hash, got #{options.class}") unless options.is_a?(Hash)
+      options[:default] = default if default
+      options[:i18n_inferred_key] = true unless has_key
       args
     end
 

data/lib/i18nliner/extensions/core.rb

@@ -9,7 +9,8 @@ module I18nliner
         key, options = *CallHelpers.infer_arguments(args)
 
         scope = options.delete(:i18n_scope) || Scope.root
-        key = CallHelpers.normalize_key(key, scope)
+        inferred_key = options.delete(:i18n_inferred_key)
+        key = CallHelpers.normalize_key(key, scope, inferred_key)
 
         if default = options[:default]
           options[:default] = CallHelpers.normalize_default(default, options)
@@ -22,6 +23,8 @@ module I18nliner
         end
 
         result
+      rescue ArgumentError
+        raise
       end
       alias :t :translate
       alias :t! :translate

data/lib/i18nliner/extensions/view.rb

@@ -14,11 +14,12 @@ module I18nliner
         # 1. the user did something weird (e.g. <%= t{ "haha" } %>)
         # 2. the erb pre processor missed it somehow (bug)
         raise InvalidBlockUsageError.new("block translate calls need to be output (i.e. `<%=`) and the block body must be of the form `%>your string<%`") if block_given?
-        raise ArgumentError.new("wrong number of arguments (0 for 1..3)") if args.empty? || args.size > 3
         key, options = CallHelpers.infer_arguments(args)
         options = inferpolate(options) if I18nliner.infer_interpolation_values
         options[:i18n_scope] = i18n_scope
         super(key, options)
+      rescue ArgumentError
+        raise
       end
       alias :t :translate
       alias :t! :translate

data/lib/i18nliner/extractors/translate_call.rb

@@ -29,7 +29,7 @@ module I18nliner
       end
 
       def normalize
-        @key = normalize_key(@key, @scope) unless @meta[:inferred_key]
+        @key = normalize_key(@key, @scope, @options[:i18n_inferred_key])
         @default = normalize_default(@default, @options || {}, {:remove_whitespace => @scope.remove_whitespace?})
       end
 
@@ -77,15 +77,11 @@ module I18nliner
       # default_string [, options]
       # default_hash, options
       def normalize_arguments(args)
-        raise InvalidSignatureError.new(@line, args) if args.empty?
-
-        @key, @options, *others = infer_arguments(args, @meta)
-
-        raise InvalidSignatureError.new(@line, args) if !others.empty?
-        raise InvalidSignatureError.new(@line, args) unless @key.is_a?(Symbol) || @key.is_a?(String)
-        raise InvalidSignatureError.new(@line, args) unless @options.nil? || @options.is_a?(Hash)
-        @default = @options.delete(:default) if @options
+        @key, @options = infer_arguments(args)
+        @default = @options.delete(:default)
         raise InvalidSignatureError.new(@line, args) unless @default.nil? || @default.is_a?(String) || @default.is_a?(Hash)
+      rescue ArgumentError
+        raise InvalidSignatureError.new(@line, args)
       end
 
       def validate_interpolation_values(key, default)

data/lib/i18nliner/pre_processors/erb_pre_processor.rb

@@ -237,7 +237,7 @@ module I18nliner
         end
 
         def options_to_ruby(options)
-          return if options.size == 0
+          options["i18n_inferred_key"] = "true"
           options.map do |key, value|
             ":" << key << " => (" << value << ")"
           end.join(", ")

data/lib/i18nliner/scope.rb

@@ -14,7 +14,7 @@ module I18nliner
       @context = options.fetch(:context, nil)
     end
 
-    def normalize_key(key)
+    def normalize_key(key, inferred)
       if allow_relative? && (key = key.dup) && key.sub!(/\A\./, '')
         scope + key
       else

data/lib/i18nliner.rb

@@ -3,6 +3,6 @@ require 'i18nliner/base'
 
 require 'i18nliner/extensions/core'
 I18n.send :extend, I18nliner::Extensions::Core
-I18n::RESERVED_KEYS << :i18n_scope
+I18n::RESERVED_KEYS << :i18n_scope << :i18n_inferred_key
 
 require 'i18nliner/railtie' if defined?(Rails)

data/spec/extensions/controller_spec.rb

@@ -6,8 +6,9 @@ describe I18nliner::Extensions::Controller do
   let(:i18n) do
     Module.new do
       extend(Module.new do
-        def translate(*args)
-          I18n.translate(*args)
+        def translate(key, options)
+          options.delete(:i18n_inferred_key)
+          I18n.translate(key, options)
         end
 
         def controller_name

data/spec/extensions/model_spec.rb

@@ -5,11 +5,6 @@ require 'i18nliner/call_helpers'
 describe I18nliner::Extensions::Model do
   let(:i18n) do
     Module.new do
-      extend(Module.new do
-        def translate(*args)
-          I18n.translate(*args)
-        end
-      end)
       extend I18nliner::Extensions::Model
     end
   end
@@ -20,7 +15,7 @@ describe I18nliner::Extensions::Model do
       i18n.stub(:foo).and_return("FOO")
       I18nliner::CallHelpers.stub(:infer_key).and_return(:key)
 
-      expect(I18n).to receive(:translate).with(:key, :default => "hello %{foo}", :foo => "FOO", :i18n_scope => i18n.i18n_scope)
+      expect(I18n).to receive(:translate).with(:key, :default => "hello %{foo}", :foo => "FOO", :i18n_scope => i18n.i18n_scope, :i18n_inferred_key => true)
       i18n.translate("hello %{foo}")
     end
 

data/spec/extensions/view_spec.rb

@@ -6,8 +6,9 @@ describe I18nliner::Extensions::View do
   let(:i18n) do
     Module.new do
       extend(Module.new do
-        def translate(*args)
-          I18n.translate(*args)
+        def translate(key, options)
+          options.delete(:i18n_inferred_key)
+          I18n.translate(key, options)
         end
       end)
       extend I18nliner::Extensions::View

data/spec/pre_processors/erb_pre_processor_spec.rb

@@ -17,12 +17,12 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
 
     it "should transform t block expressions" do
       process("<%= t do %>hello world!<% end %>").should ==
-        '<%= t :key, "hello world!" %>'
+        '<%= t :key, "hello world!", :i18n_inferred_key => (true) %>'
     end
 
     it "should remove extraneous whitespace from the default" do
       process("<%= t do %> ohai!  lulz\t <% end %>").should ==
-        '<%= t :key, "ohai! lulz" %>'
+        '<%= t :key, "ohai! lulz", :i18n_inferred_key => (true) %>'
     end
 
     # so that line numbers are close-ish when you get an error in a
@@ -39,7 +39,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED.strip_heredoc
-        <%= t :key, "ohai! %{test} lulz", :test => (test)
+        <%= t :key, "ohai! %{test} lulz", :test => (test), :i18n_inferred_key => (true)
 
 
 
@@ -57,7 +57,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         SOURCE
       should == <<-EXPECTED
         <%= form_for do %>
-          <%= t :key, "Your Name" %>
+          <%= t :key, "Your Name", :i18n_inferred_key => (true) %>
           <input>
         <% end %>
         EXPECTED
@@ -87,7 +87,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "*bold*, or even **combos** get wrapper'd", :wrappers => ["<b>\\\\1</b>", "<a href=\\\"#\\\"><i><img>\\\\1</i></a>"] %>
+        <%= t :key, "*bold*, or even **combos** get wrapper'd", :i18n_inferred_key => (true), :wrappers => ["<b>\\\\1</b>", "<a href=\\\"#\\\"><i><img>\\\\1</i></a>"] %>
         EXPECTED
     end
 
@@ -104,7 +104,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "You should *create a profile*. idk why **this link** has concatention", :wrappers => [link_to("\\\\1", "/profile"), link_to("\\\\1", "/zomg")] %>
+        <%= t :key, "You should *create a profile*. idk why **this link** has concatention", :i18n_inferred_key => (true), :wrappers => [link_to("\\\\1", "/profile"), link_to("\\\\1", "/zomg")] %>
         EXPECTED
     end
 
@@ -115,7 +115,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "Your account rep is *%{user_name}*", :user_name => (@user.name), :wrappers => [link_to("\\\\1", "/user/\#{@user.id}")] %>
+        <%= t :key, "Your account rep is *%{user_name}*", :user_name => (@user.name), :i18n_inferred_key => (true), :wrappers => [link_to("\\\\1", "/user/\#{@user.id}")] %>
         EXPECTED
     end
 
@@ -129,7 +129,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "the wrappers for **these** **links** are the same, as are the ones for *these* *tags*", :wrappers => ["<b>\\\\1</b>", link_to("\\\\1", url)] %>
+        <%= t :key, "the wrappers for **these** **links** are the same, as are the ones for *these* *tags*", :i18n_inferred_key => (true), :wrappers => ["<b>\\\\1</b>", link_to("\\\\1", url)] %>
         EXPECTED
     end
 
@@ -140,7 +140,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "Hello, %{name}", :name => (name) %>
+        <%= t :key, "Hello, %{name}", :name => (name), :i18n_inferred_key => (true) %>
         EXPECTED
     end
 
@@ -151,7 +151,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "Go to *your account*", :wrappers => ["<a href=\\"/asdf\\" title=\\"\#{name}\\">\\\\1</a>"] %>
+        <%= t :key, "Go to *your account*", :i18n_inferred_key => (true), :wrappers => ["<a href=\\"/asdf\\" title=\\"\#{name}\\">\\\\1</a>"] %>
         EXPECTED
     end
 
@@ -165,7 +165,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "Go to *your account*", :wrappers => ["<a href=\\"/asdf\\" title=\\"\#{t :key, \"manage account stuffs, %{name}\", :name => (name)}\\">\\\\1</a>"] %>
+        <%= t :key, "Go to *your account*", :i18n_inferred_key => (true), :wrappers => ["<a href=\\"/asdf\\" title=\\"\#{t :key, \"manage account stuffs, %{name}\", :name => (name), :i18n_inferred_key => (true)}\\">\\\\1</a>"] %>
         EXPECTED
     end
 
@@ -176,7 +176,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "Create %{input_name_count} groups", :input_name_count => ("<input name=\\"count\\">".html_safe) %>
+        <%= t :key, "Create %{input_name_count} groups", :input_name_count => ("<input name=\\"count\\">".html_safe), :i18n_inferred_key => (true) %>
         EXPECTED
     end
 
@@ -187,7 +187,7 @@ describe I18nliner::PreProcessors::ErbPreProcessor do
         <% end %>
         SOURCE
       should == <<-EXPECTED
-        <%= t :key, "© %{year} ACME Corp. All Rights Reserved. Our lawyers > your lawyers", :year => (year) %>
+        <%= t :key, "© %{year} ACME Corp. All Rights Reserved. Our lawyers > your lawyers", :year => (year), :i18n_inferred_key => (true) %>
         EXPECTED
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18nliner
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport