i18nliner 0.0.2 → 0.0.3

data/README.md

@@ -2,16 +2,6 @@
 
 [<img src="https://secure.travis-ci.org/jenseng/i18nliner.png" />](http://travis-ci.org/jenseng/i18nliner)
 
-yay readme-driven development!
-
-## TODO
-
-* rake tasks
-  * diff
-  * import
-
-====
-
 I18nliner is I18n made simple.
 
 No .yml files. Inline defaults. Optional keys. Inferred interpolation values.
@@ -87,8 +77,9 @@ translation? I18nliner makes keys optional, so you can just do this:
 I18n.t "My Account"
 ```
 
-I18nliner will create a [unique key](CONFIG.md) based on the translation (e.g.
-`:my_account`), so you don't have to.
+I18nliner will create a unique key based on the translation (e.g.
+`:my_account`), so you don't have to. See `I18nliner.inferred_key_format` for
+more information.
 
 This can actually be a **good thing**, because when the `en` changes, the key
 changes, which means you know you need to get it retranslated (instead of
@@ -104,7 +95,7 @@ value. So this:
 
 ```erb
 <p>
-  <%= t "Hello, %{user}. This request was a %{request_method}.", 
+  <%= t "Hello, %{user}. This request was a %{request_method}.",
         user: @user.name,
         request_method: request.method
   %>
@@ -237,7 +228,7 @@ before it hits ERB:
 ```
 
 In other words, it will infer wrappers from your (balanced) markup and
-[`link_to` calls](INFERRED_WRAPPERS.md), and will create placeholders for any
+`link_to` calls, and will create placeholders for any
 other (inline) ERB expressions. ERB statements (e.g.
 `<% if some_condition %>...`) and block expressions (e.g.
 `<%= form_for @person do %>...`) are *not* supported within a block
@@ -305,27 +296,16 @@ Does an i18nliner:check, and then extracts all default translations from your
 codebase, merges them with any other ones (from rails or pre-existing .yml
 files), and outputs them to `config/locales/generated/en.yml`.
 
-### Dynamic Translations
+#### Dynamic Translations
 
 Note that check and dump commands require all translation keys and
 defaults to be literals. This is because it reads your code, it doesn't
 run it. If you know what you are doing and want to pass in a variable or
-other expression, you can use the `t!` (or `translate!`) command. It works
+other expression, you can use the `t!` (or `translate!`) method. It works
 the same as `t` at runtime, but signals to the extractor that it shouldn't
 complain. You should only do this if you are sure that the specified
 key/string is extracted elsewhere or already in your yml.
 
-### i18nliner:diff
-
-Does an i18nliner:dump and creates a diff from a previous one (path or git
-commit hash). This is useful if you only want to see what has changed since a
-previous release of your app.
-
-### i18nliner:import
-
-Imports a translated yml file. Ensures that all placeholders and wrappers are
-present.
-
 #### .i18nignore and more
 
 By default, the check and dump tasks will look for inline translations in any

data/lib/i18nliner/base.rb

@@ -14,8 +14,9 @@ module I18nliner
   end
 
   def self.manual_translations
+    I18n.t(:foo) # ensure backend is initialized
     # TODO: support additional backends
-    I18n.backend.send(:translations)
+    I18n.backend.send(:translations)[I18n.default_locale]
   end
 
   def self.look_up(key)
@@ -44,4 +45,5 @@ module I18nliner
   setting :inferred_key_format,        :underscored_crc32
   setting :infer_interpolation_values, true
   setting :base_path,                  "./"
+  setting :underscored_key_length,     50
 end

data/lib/i18nliner/call_helpers.rb

@@ -35,7 +35,7 @@ module I18nliner
       key.downcase!
       key.gsub!(/[^a-z0-9_]+/, '_')
       key.gsub!(/\A_|_\z/, '')
-      key[0..50]
+      key[0...I18nliner.underscored_key_length]
     end
 
     def keyify_underscored_crc32(string)

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}.ya2yaml(:syck_compatible => true))
+          file.write({I18n.default_locale.to_s => @translations.expand_keys}.ya2yaml(:syck_compatible => true))
         end
         puts "Wrote default translations to #{yml_file}" unless @options[:silent]
       end

data/lib/i18nliner/commands/import.rb

@@ -0,0 +1,30 @@
+require 'i18nliner/commands/generic_command'
+require 'i18nliner/extractors/translation_hash'
+require 'active_support/core_ext/enumerable'
+Dir[File.join(File.dirname(__FILE__), "../processors/*.rb")].each do |file|
+  require "i18nliner/processors/#{File.basename(file)}"
+end
+
+module I18nliner
+  module Commands
+    class Import < GenericCommand
+      attr_reader :translations, :errors
+
+      def initialize(options)
+        super
+      end
+
+      def success?
+      end
+
+      def print_summary
+      end
+
+      def run
+        print_summary unless @options[:silent]
+        success?
+      end
+    end
+  end
+end
+

data/lib/i18nliner/extensions/core.rb

@@ -20,7 +20,7 @@ module I18nliner
 
       # can't super this one yet :-/
       def interpolate_hash_with_html_safety(string, values)
-        if string.html_safe? || values.values.any?(&:html_safe?)
+        if string.html_safe? || values.values.any?{ |v| v.is_a?(ActiveSupport::SafeBuffer) }
           string = ERB::Util.h(string) unless string.html_safe?
           values.each do |key, value|
             values[key] = ERB::Util.h(value) unless value.html_safe?

data/lib/i18nliner/extractors/translation_hash.rb

@@ -4,14 +4,25 @@ module I18nliner
       attr_accessor :line
 
       def self.new(hash = {})
-        hash.is_a?(self) ? hash : super().replace(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
+        end
+        result
+      end
+
       def initialize(*args)
         super
         @total_size = 0
       end
-  
+
       def []=(key, value)
         parts = key.split('.')
         leaf = parts.pop
@@ -28,7 +39,7 @@ module I18nliner
           hash = hash[part]
         end
         if hash[leaf]
-          if hash[leaf] != default
+          if hash[leaf] != value
             if hash[leaf].is_a?(Hash)
               raise KeyAsScopeError.new(@line, key)
             else
@@ -40,6 +51,16 @@ 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/spec/commands/check_spec.rb

@@ -10,6 +10,7 @@ describe I18nliner::Commands::Check do
     end
 
     it "should find errors" do
+      allow(I18nliner).to receive(:manual_translations).and_return({})
       checker = I18nliner::Commands::Check.new({:silent => true})
       checker.check_files
       checker.translations.values.should == ["welcome, %{name}", "Hello World", "*This* is a test, %{user}"]

data/spec/commands/dump_spec.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 require 'i18nliner/commands/dump'
+require 'i18nliner/extractors/translation_hash'
 require 'tmpdir'
 
 describe I18nliner::Commands::Dump do
@@ -14,7 +15,8 @@ describe I18nliner::Commands::Dump do
     end
 
     it "should dump translations in utf8" do
-      dumper = I18nliner::Commands::Dump.new({:silent => true, :translations => {'i18n' => "Iñtërnâtiônàlizætiøn"}})
+      translations = I18nliner::Extractors::TranslationHash.new('i18n' => "Iñtërnâtiônàlizætiøn")
+      dumper = I18nliner::Commands::Dump.new({:silent => true, :translations => translations})
       dumper.run
       File.read(dumper.yml_file).gsub(/\s+$/, '').should == <<-YML.strip_heredoc.strip
         ---

data/spec/extensions/core_spec.rb

@@ -60,12 +60,19 @@ describe I18nliner::Extensions::Core do
       result.should be_html_safe
     end
 
-    it "should html-escape the string and other values if any value is html-safe" do
+    it "should html-escape the string and other values if any value is html-safe strings" do
       markup = "<input>"
       result = i18n.interpolate_hash("type %{input} & you get this: %{output}", :input => markup, :output => markup.html_safe)
       result.should == "type &lt;input&gt; &amp; you get this: <input>"
       result.should be_html_safe
     end
+
+    it "should not html-escape the string if the html-safe values are not strings" do
+      markup = "<input>"
+      result = i18n.interpolate_hash("my favorite number is %{number} & my favorite color is %{color}", :number => 1, :color => "red")
+      result.should == "my favorite number is 1 & my favorite color is red"
+      result.should_not be_html_safe
+    end
   end
 end
 

data/spec/extractors/translation_hash_spec.rb

@@ -0,0 +1,38 @@
+require 'i18nliner/errors'
+require 'i18nliner/extractors/translation_hash'
+
+describe I18nliner::Extractors::TranslationHash do
+
+  describe "#[]=" do
+    let(:hash) { I18nliner::Extractors::TranslationHash.new }
+
+    it "should accept identical key/values" do
+      expect {
+        hash["foo"] = "Foo"
+        hash["foo"] = "Foo"
+      }.to_not raise_error
+      hash.should == {"foo" => "Foo"}
+    end
+
+    it "should reject mismatched values" do
+      expect {
+        hash["foo"] = "Foo"
+        hash["foo"] = "Bar"
+      }.to raise_error(I18nliner::KeyInUseError)
+    end
+
+    it "should not let you use a key as a scope" do
+      expect {
+        hash["foo"] = "Foo"
+        hash["foo.bar"] = "Bar"
+      }.to raise_error(I18nliner::KeyAsScopeError)
+    end
+
+    it "should not let you use a scope as a key" do
+      expect {
+        hash["foo.bar"] = "Bar"
+        hash["foo"] = "Foo"
+      }.to raise_error(I18nliner::KeyAsScopeError)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18nliner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -205,6 +205,7 @@ files:
 - lib/i18nliner/commands/color_formatter.rb
 - lib/i18nliner/commands/dump.rb
 - lib/i18nliner/commands/generic_command.rb
+- lib/i18nliner/commands/import.rb
 - lib/i18nliner/errors.rb
 - lib/i18nliner/erubis.rb
 - lib/i18nliner/extensions/controller.rb
@@ -233,6 +234,7 @@ files:
 - spec/extensions/view_spec.rb
 - spec/extractors/ruby_extractor_spec.rb
 - spec/extractors/translate_call_spec.rb
+- spec/extractors/translation_hash_spec.rb
 - spec/fixtures/app/models/invalid.rb
 - spec/fixtures/app/models/valid.rb
 - spec/pre_processors/erb_pre_processor_spec.rb
@@ -257,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: I18n made simple