i18nliner 0.0.4 → 0.0.5

data/lib/i18nliner/call_helpers.rb

@@ -11,12 +11,29 @@ module I18nliner
       scope.normalize_key(key.to_s)
     end
 
-    def normalize_default(default, translate_options = {})
+    def normalize_default(default, translate_options = {}, options = {})
       default = infer_pluralization_hash(default, translate_options)
-      default.strip! if default.is_a?(String)
+      normalize_whitespace!(default, options)
       default
     end
 
+    def normalize_whitespace!(default, options)
+      if default.is_a?(Hash)
+        default.each { |key, value| normalize_whitespace!(value, options) }
+        return
+      end
+
+      return unless default.is_a?(String)
+
+      if options[:remove_whitespace]
+        default.gsub!(/\s+/, ' ')
+        default.strip!
+      else
+        default.sub!(/\s*\n\z/, '')
+        default.lstrip!
+      end
+    end
+
     def infer_pluralization_hash(default, translate_options)
       return default unless default.is_a?(String) &&
                             default =~ /\A[\w\-]+\z/ &&
@@ -27,7 +44,7 @@ module I18nliner
     def infer_key(default, translate_options = {})
       return unless default && (default.is_a?(String) || default.is_a?(Hash))
       default = default[:other].to_s if default.is_a?(Hash)
-      keyify(normalize_default(default, translate_options))
+      keyify(normalize_default(default, translate_options, :remove_whitespace => true))
     end
 
     def keyify_underscored(string)
@@ -73,12 +90,13 @@ module I18nliner
       (hash.keys - ALLOWED_PLURALIZATION_KEYS).size == 0
     end
 
-    def infer_arguments(args)
+    def infer_arguments(args, meta = {})
       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_or_options = args[1]

data/lib/i18nliner/commands/dump.rb

@@ -16,7 +16,7 @@ module I18nliner
       def run
         FileUtils.mkdir_p File.dirname(yml_file)
         File.open(yml_file, "w") do |file|
-          file.write({I18n.default_locale.to_s => @translations.expand_keys}.ya2yaml(:syck_compatible => true))
+          file.write({I18n.default_locale.to_s => @translations}.ya2yaml(:syck_compatible => true))
         end
         puts "Wrote default translations to #{yml_file}" unless @options[:silent]
       end

data/lib/i18nliner/controller_scope.rb

@@ -0,0 +1,16 @@
+require "i18nliner/scope"
+
+module I18nliner
+  class ControllerScope < Scope
+    def scope
+      # best guess at current action, ymmv. we only add the action at this
+      # point because the scope already has the controller path
+      # see abstract_controller/translation.rb for reference
+      if context.current_defn
+        "#{super}.#{context.current_defn}"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/i18nliner/erubis.rb

@@ -1,4 +1,4 @@
-require 'action_view/template/handlers/erb'
+require 'action_view/template'
 require 'i18nliner/pre_processors/erb_pre_processor'
 
 module I18nliner

data/lib/i18nliner/extensions/controller.rb

@@ -7,12 +7,12 @@ module I18nliner
     module Controller
       include Inferpolation
 
-      PATH = "app/controllers"
-      ALLOW_RELATIVE = Rails.version >= '4'
+      def i18n_scope; end
 
       def translate(*args)
         key, options = CallHelpers.infer_arguments(args)
         options = inferpolate(options) if I18nliner.infer_interpolation_values
+        options[:i18n_scope] = i18n_scope
         super(key, options)
       end
       alias :t :translate

data/lib/i18nliner/extensions/core.rb

@@ -7,11 +7,20 @@ module I18nliner
     module Core
       def translate(*args)
         key, options = *CallHelpers.infer_arguments(args)
-        wrappers = options.delete(:wrappers)
+
+        scope = options.delete(:i18n_scope) || Scope.root
+        key = CallHelpers.normalize_key(key, scope)
+
+        if default = options[:default]
+          options[:default] = CallHelpers.normalize_default(default, options)
+        end
+
+        wrappers = options.delete(:wrappers) || options.delete(:wrapper)
         result = super(key, options)
         if wrappers
           result = apply_wrappers(result, wrappers)
         end
+
         result
       end
       alias :t :translate
@@ -42,7 +51,8 @@ module I18nliner
 
       def apply_wrappers(string, wrappers)
         string = string.html_safe? ? string.dup : ERB::Util.h(string)
-        if wrappers.is_a?(Array)
+        unless wrappers.is_a?(Hash)
+          wrappers = Array(wrappers)
           wrappers = Hash[wrappers.each_with_index.map{ |w, i| ['*' * (1 + i), w]}]
         end
         wrappers.sort_by{ |k, v| -k.length }.each do |k, v|

data/lib/i18nliner/extensions/model.rb

@@ -7,13 +7,13 @@ module I18nliner
     module Model
       include Inferpolation
 
-      PATH = "app/models"
-      ALLOW_RELATIVE = false
+      def i18n_scope; end
 
       def translate(*args)
         key, options = CallHelpers.infer_arguments(args)
         options = inferpolate(options) if I18nliner.infer_interpolation_values
-        I18n.t(key, options)
+        options[:i18n_scope] = i18n_scope
+        I18n.translate(key, options)
       end
       alias :t :translate
       alias :t! :translate
@@ -23,6 +23,10 @@ module I18nliner
         I18n.localize(*args)
       end
       alias :l :localize
+
+      def self.included(klass)
+        klass.extend(self)
+      end
     end
   end
 end

data/lib/i18nliner/extensions/view.rb

@@ -7,8 +7,7 @@ module I18nliner
     module View
       include Inferpolation
 
-      PATH = "app/views"
-      ALLOW_RELATIVE = true
+      def i18n_scope; end
 
       def translate(*args)
         # if a block gets through to here, it either means:
@@ -18,6 +17,7 @@ module I18nliner
         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)
       end
       alias :t :translate

data/lib/i18nliner/extractors/ruby_extractor.rb

@@ -22,10 +22,23 @@ module I18nliner
         process(@sexps)
       end
 
+      attr_reader :current_defn
+      def process_defn(exp)
+        exp.shift
+        @current_defn = exp.shift
+        process exp.shift until exp.empty?
+        @current_defn = nil
+        s()
+      end
+
       def process_call(exp)
         exp.shift
-        receiver = process(exp.shift)
-        receiver = receiver.last if receiver
+        receiver_exp = exp.shift
+        receiver = nil
+        if receiver_exp
+          receiver = receiver_exp[0] == :const ? receiver_exp.last : UnsupportedExpression
+          process(receiver_exp)
+        end
         method = exp.shift
 
         if extractable_call?(receiver, method)
@@ -52,7 +65,7 @@ module I18nliner
 
       def process_translate_call(receiver, method, args)
         scope = receiver ? Scope.root : @scope
-        call = TranslateCall.new(@scope, @current_line, method, args)
+        call = TranslateCall.new(scope, @current_line, method, args, :explicit_receiver => !receiver.nil?)
         call.translations.each &@block
       end
 

data/lib/i18nliner/extractors/sexp_helper.rb

@@ -28,6 +28,7 @@ module I18nliner
         elsif stringish?(lhs)
           string_from(lhs) + rhs.last
         else
+          process(lhs)
           UnsupportedExpression
         end
       end

data/lib/i18nliner/extractors/translate_call.rb

@@ -10,10 +10,11 @@ module I18nliner
 
       attr_reader :key, :default
 
-      def initialize(scope, line, method, args)
+      def initialize(scope, line, method, args, meta = {})
         @scope = scope
         @line = line
         @method = method
+        @meta = meta
 
         normalize_arguments(args)
 
@@ -28,8 +29,8 @@ module I18nliner
       end
 
       def normalize
-        @key = normalize_key(@key, @scope)
-        @default = normalize_default(@default, @options || {})
+        @key = normalize_key(@key, @scope) unless @meta[:inferred_key]
+        @default = normalize_default(@default, @options || {}, {:remove_whitespace => @scope.remove_whitespace?})
       end
 
       def translations
@@ -78,7 +79,7 @@ module I18nliner
       def normalize_arguments(args)
         raise InvalidSignatureError.new(@line, args) if args.empty?
 
-        @key, @options, *others = infer_arguments(args)
+        @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)

data/lib/i18nliner/extractors/translation_hash.rb

@@ -4,18 +4,10 @@ module I18nliner
       attr_accessor :line
 
       def self.new(hash = {})
-        hash.is_a?(self) ? hash : super().replace(flatten(hash))
-      end
-
-      def self.flatten(hash, result = {}, prefix = "")
-        hash.each do |key, value|
-          if value.is_a?(Hash)
-            flatten(value, result, "#{prefix}#{key}.")
-          else
-            result["#{prefix}#{key}"] = value
-          end
+        hash.inject(super()) do |result, (key, value)|
+          result.store(key.to_s, value.is_a?(Hash) ? new(value) : value)
+          result
         end
-        result
       end
 
       def initialize(*args)
@@ -51,16 +43,6 @@ module I18nliner
           hash.store(leaf, value)
         end
       end
-
-      def expand_keys
-        result = {}
-        each do |key, value|
-          parts = key.split(".")
-          last = parts.pop
-          parts.inject(result){ |h, k2| h[k2] ||= {}}[last] = value
-        end
-        result
-      end
     end
   end
 end

data/lib/i18nliner/processors/erb_processor.rb

@@ -22,10 +22,15 @@ module I18nliner
         end
       end
 
+      VIEW_PATH = %r{\A(.*/)?app/views/(.*?)\.(erb|html\.erb)\z}
       def scope_for(path)
-        scope = path.gsub(/(\A|.*\/)app\/views\/|\.html\z|(\.html)?\.erb\z/, '')
-        scope = scope.gsub(/\/_?/, '.')
-        Scope.new(scope, :allow_relative => true)
+        scope = path.dup
+        if scope.sub!(VIEW_PATH, '\2')
+          scope = scope.gsub(/\/_?/, '.')
+          Scope.new(scope, :allow_relative => true, :remove_whitespace => true, :context => self)
+        else
+          Scope.root
+        end
       end
     end
   end

data/lib/i18nliner/processors/ruby_processor.rb

@@ -1,6 +1,7 @@
 require 'i18nliner/processors/abstract_processor'
 require 'i18nliner/extractors/ruby_extractor'
 require 'i18nliner/scope'
+require 'i18nliner/controller_scope'
 
 module I18nliner
   module Processors
@@ -21,8 +22,21 @@ module I18nliner
         File.read(file)
       end
 
-      def scope_for(path)
-        Scope.root
+      if defined?(::Rails) && ::Rails.version > '4'
+        CONTROLLER_PATH = %r{\A(.*/)?app/controllers/(.*)_controller\.rb\z}
+        def scope_for(path)
+          scope = path.dup
+          if scope.sub!(CONTROLLER_PATH, '\2')
+            scope = scope.gsub(/\/_?/, '.')
+            ControllerScope.new(scope, :allow_relative => true, :context => self)
+          else
+            Scope.root
+          end
+        end
+      else
+        def scope_for(path)
+          Scope.root
+        end
       end
 
       def pre_process(source)

data/lib/i18nliner/scope.rb

@@ -1,16 +1,17 @@
 module I18nliner
   class Scope
     attr_reader :scope
+    attr_reader :allow_relative
+    attr_reader :context
+    alias :allow_relative? :allow_relative
+    attr_accessor :remove_whitespace
+    alias :remove_whitespace? :remove_whitespace
 
     def initialize(scope = nil, options = {})
       @scope = scope ? "#{scope}." : scope
-      @options = {
-        :allow_relative => false
-      }.merge(options)
-    end
-
-    def allow_relative?
-      @options[:allow_relative]
+      @allow_relative = options.fetch(:allow_relative, false)
+      @remove_whitespace = options.fetch(:remove_whitespace, false)
+      @context = options.fetch(:context, nil)
     end
 
     def normalize_key(key)
@@ -24,5 +25,9 @@ module I18nliner
     def self.root
       @root ||= new
     end
+
+    def root?
+      scope.blank?
+    end
   end
 end

data/spec/extensions/controller_spec.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+require 'i18nliner/extensions/controller'
+require 'i18nliner/call_helpers'
+
+describe I18nliner::Extensions::Controller do
+  let(:i18n) do
+    Module.new do
+      extend(Module.new do
+        def translate(*args)
+          I18n.translate(*args)
+        end
+
+        def controller_name
+          "foo"
+        end
+      end)
+      extend I18nliner::Extensions::Controller
+    end
+  end
+
+
+  describe "#translate" do
+    it "should inferpolate" 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)
+      i18n.translate("hello %{foo}")
+    end
+
+    it "should pass along its scope to I18n.t" do
+      expect(I18n).to receive(:translate).with(:key, :default => "foo", :i18n_scope => i18n.i18n_scope)
+      i18n.translate(:key, "foo")
+    end
+  end
+end
+
+

data/spec/extensions/core_spec.rb

@@ -28,15 +28,36 @@ describe I18nliner::Extensions::Core do
       i18n.translate("Hello %{name}", :name => "bob")
     end
 
-    it "should apply wrappers" do
-      result = i18n.translate("Hello *bob*. Click **here**", :wrappers => ['<b>\1</b>', '<a href="/">\1</a>'])
-      result.should == "Hello <b>bob</b>. Click <a href=\"/\">here</a>"
-      result.should be_html_safe
+    it "should infer pluralization hashes" do
+      expect(i18n).to receive(:simple_translate).with("light_6feedaaa", :default => {:one => "1 light", :other => "%{count} lights"}, count: 1)
+      i18n.translate("light", :count => 1)
     end
 
-    it "should html-escape the default when applying wrappers" do
-      i18n.translate("*bacon* > narwhals", :wrappers => ['<b>\1</b>']).
-        should == "<b>bacon</b> &gt; narwhals"
+    context "with wrappers" do
+      it "should apply a single wrapper" do
+        result = i18n.translate("Hello *bob*.", :wrapper => '<b>\1</b>')
+        result.should == "Hello <b>bob</b>."
+      end
+
+      it "should be html-safe" do
+        result = i18n.translate("Hello *bob*.", :wrapper => '<b>\1</b>')
+        result.should be_html_safe
+      end
+
+      it "should apply multiple wrappers" do
+        result = i18n.translate("Hello *bob*. Click **here**", :wrappers => ['<b>\1</b>', '<a href="/">\1</a>'])
+        result.should == "Hello <b>bob</b>. Click <a href=\"/\">here</a>"
+      end
+
+      it "should apply multiple wrappers with arbitrary delimiters" do
+        result = i18n.translate("Hello !!!bob!!!. Click ???here???", :wrappers => {'!!!' => '<b>\1</b>', '???' => '<a href="/">\1</a>'})
+        result.should == "Hello <b>bob</b>. Click <a href=\"/\">here</a>"
+      end
+
+      it "should html-escape the default when applying wrappers" do
+        i18n.translate("*bacon* > narwhals", :wrappers => ['<b>\1</b>']).
+          should == "<b>bacon</b> &gt; narwhals"
+      end
     end
   end
 

data/spec/extensions/model_spec.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+require 'i18nliner/extensions/model'
+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
+
+
+  describe "#translate" do
+    it "should inferpolate" 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)
+      i18n.translate("hello %{foo}")
+    end
+
+    it "should pass along its scope to I18n.t" do
+      expect(I18n).to receive(:translate).with(:key, :default => "foo", :i18n_scope => i18n.i18n_scope)
+      i18n.translate(:key, "foo")
+    end
+  end
+end
+
+
+

data/spec/extensions/view_spec.rb

@@ -20,7 +20,7 @@ describe I18nliner::Extensions::View 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")
+      expect(I18n).to receive(:translate).with(:key, :default => "hello %{foo}", :foo => "FOO", :i18n_scope => i18n.i18n_scope)
       i18n.translate("hello %{foo}")
     end
 
@@ -37,6 +37,11 @@ describe I18nliner::Extensions::View do
         i18n.translate
       }.to raise_error /wrong number of arguments/
     end
+
+    it "should pass along its scope to I18n.t" do
+      expect(I18n).to receive(:translate).with(:key, :default => "foo", :i18n_scope => i18n.i18n_scope)
+      i18n.translate(:key, "foo")
+    end
   end
 end
 

data/spec/processors/erb_processor_spec.rb

@@ -1,5 +1,6 @@
 require 'i18nliner/processors/erb_processor'
 require 'i18nliner/extractors/translation_hash'
+require 'i18nliner/scope'
 
 describe I18nliner::Processors::ErbProcessor do
   before do
@@ -7,6 +8,22 @@ describe I18nliner::Processors::ErbProcessor do
     @processor = I18nliner::Processors::ErbProcessor.new(@translations)
   end
   
+  describe "#scope_for" do
+    context "with an erb template" do
+      subject { @processor.scope_for("app/views/foos/show.html.erb") }
+
+      specify { expect(subject).to be_allow_relative }
+      specify { expect(subject).to be_remove_whitespace }
+      specify { expect(subject.scope).to eq "foos.show." }
+    end
+
+    context "with anything else" do
+      subject { @processor.scope_for("foo.erb") }
+
+      specify { expect(subject).to be I18nliner::Scope.root }
+    end
+  end
+
   describe "#check_contents" do
     it "should extract valid translation calls" do
       @processor.check_contents(<<-SOURCE)

data/spec/processors/ruby_processor_spec.rb

@@ -0,0 +1,28 @@
+require 'i18nliner/processors/ruby_processor'
+require 'i18nliner/extractors/translation_hash'
+require 'i18nliner/scope'
+
+describe I18nliner::Processors::RubyProcessor do
+  before do
+    @translations = I18nliner::Extractors::TranslationHash.new
+    @processor = I18nliner::Processors::RubyProcessor.new(@translations)
+  end
+
+  describe "#scope_for" do
+    if defined?(::Rails) && ::Rails.version > '4'
+      context "with a controller" do
+        subject { @processor.scope_for("app/controllers/foos/bars_controller.rb") }
+
+        specify { expect(subject).to be_allow_relative }
+        specify { expect(subject.scope).to eq "foos.bars." }
+      end
+    end
+
+    context "with any old ruby file" do
+      subject { @processor.scope_for("foo.rb") }
+
+      specify { expect(subject).to be I18nliner::Scope.root }
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18nliner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: globby
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,7 @@ files:
 - lib/i18nliner/commands/dump.rb
 - lib/i18nliner/commands/generic_command.rb
 - lib/i18nliner/commands/import.rb
+- lib/i18nliner/controller_scope.rb
 - lib/i18nliner/errors.rb
 - lib/i18nliner/erubis.rb
 - lib/i18nliner/extensions/controller.rb
@@ -213,7 +214,6 @@ files:
 - lib/i18nliner/extensions/inferpolation.rb
 - lib/i18nliner/extensions/model.rb
 - lib/i18nliner/extensions/view.rb
-- lib/i18nliner/extractors/abstract_extractor.rb
 - lib/i18nliner/extractors/ruby_extractor.rb
 - lib/i18nliner/extractors/sexp_helper.rb
 - lib/i18nliner/extractors/translate_call.rb
@@ -229,8 +229,10 @@ files:
 - lib/tasks/i18nliner.rake
 - spec/commands/check_spec.rb
 - spec/commands/dump_spec.rb
+- spec/extensions/controller_spec.rb
 - spec/extensions/core_spec.rb
 - spec/extensions/inferpolation_spec.rb
+- spec/extensions/model_spec.rb
 - spec/extensions/view_spec.rb
 - spec/extractors/ruby_extractor_spec.rb
 - spec/extractors/translate_call_spec.rb
@@ -239,6 +241,7 @@ files:
 - spec/fixtures/app/models/valid.rb
 - spec/pre_processors/erb_pre_processor_spec.rb
 - spec/processors/erb_processor_spec.rb
+- spec/processors/ruby_processor_spec.rb
 homepage: http://github.com/jenseng/i18nliner
 licenses: []
 post_install_message: 

data/lib/i18nliner/extractors/abstract_extractor.rb

@@ -1,33 +0,0 @@
-module I18nliner
-  module Extractors
-    module AbstractExtractor
-      def initialize(options = {})
-        @scope = options[:scope] || ''
-        @translations = TranslationHash.new(options[:translations] || {})
-        @total = 0
-        super()
-      end
-
-      def look_up(key)
-        @translations[key]
-      end
-
-      def add_translation(full_key, default)
-        @total += 1
-        @translations[full_key] = default
-      end
-
-      def total_unique
-        @translations.total_size
-      end
-
-      def self.included(base)
-        base.instance_eval do
-          attr_reader :total
-          attr_accessor :translations, :scope
-        end
-      end
-    end
-  end
-end
-