haml-i18n-extractor 0.0.19 → 0.0.20

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzYwYzZlM2U0ZTJjZjRjMTI4NzUzOGQ5YTJhZTZjNmJkN2RjZWM5MA==
+    OTBmMTFhZDE4NTI3ZjQ1ZjlkNjJiMTgxOGZhZjc0ODI4MzM0M2YxOQ==
   data.tar.gz: !binary |-
-    ZTI2N2EzYmQxN2YyMzZmNjU1OGY5N2Q1MGY4ZWYwNGNiODcwOWVlNg==
+    MjVmYTU2MTY3ZjcxMDAzYTM2MjAzZDEzMWM3MmRkNGM1YTVlNzYxYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmJjOTk2ZmU0YTI2MzZmZWZkZTI4YjQ5MzVjOTNhNmRiZTE5ZWQwYzkxY2Zi
-    ZjE4NmNlZGI0NWFmYjQ4NjAwMWY1ZDE5YmIxMjg1NGMzN2UzNjMzNmExNWFh
-    ZGIwZGI0ZmU5NzQ0YmFmNDEwOTg3YWFkMTE0N2Q3NDE0NTliZDU=
+    MWMyMzQyNmQ5YWNiZGUxOWVkYzA1NDdhZjJkYzY2ZWUyYjdjNzk3MjQwNzhk
+    MmU1MzBjZjkyNjMyMTlhMDcxZTIyNWZhNjNlZGVmM2E0NzNmYjk0NGU1YTUx
+    YTJlNTFkYTRjOTY1ZmNiZThhODlkMmUyZTQ1NDg1NzRiMjE4M2Y=
   data.tar.gz: !binary |-
-    M2IzYjJjNTdjMzMwYTU5NmJhODgxMTA4YzNiNDUzOTA4Yjk1MDNjZDc1MGE1
-    YTU2YWNkMmIxY2Q0MGEyMGM3OWMxODhiMjc4YmMyMDExM2U5NzZjYjQzYjI2
-    OTk1ZWNmYzVkNGE1MmY1NTJkNGVhOTNkMTk1MDg5NWEyMGEwMDI=
+    ZTcwMWFiYTI5ZmM0ZmMwNzUyNGU4Y2Y2OTIzZTBjODE1MDUzYmU0MmJhYTYw
+    ODQ0MzE4YTM3ZjBhZDYxZjU1OTQ4YjRlOTBlYWNkZjdiZjlkYTc4MzJmYTBk
+    OGVkMTAzMTQ5ZGQ2ZmRkY2VkZmZjNWFmZGJiZjdlMmM2Yjk1NTg=

data/README.md

@@ -2,9 +2,9 @@
 
 Extract strings likely to be translated from haml templates for I18n translation. Replace the text, create yaml files, do all things you thought macros would solve, but didn't end up really saving THAT much time. Automate that pain away.
 
-# Idempotent
+# Use it over and over again
 
-It's idempotent, which means you can run this library/executable against the same haml file after you've already translated the keys, and it won't try to retranslate already translated text. Pretty cool.
+It doesn't translate already translated keys, or things it identfies that are not text. What this means is that you can run this library/executable against the same haml file(s) after you've already translated stuff, and it will only look at things you really need and not any prior stuff. Pretty great. Try it, and see.
 
 ## Usage
 
@@ -33,7 +33,12 @@ Check out the quite brief movie/swf file demo of this lib's executable in `demo/
 
 [Demo](http://shairosenfeld.com/haml-i18n-extractor-demo.swf)
 
-One thing missing there just added is the "tag" functionality, which enables you to tag a line you want to review for later, if you are unsure you want to replace it. It will create a list of /file/path:42 tags for you to go and revisit later.
+Things that have been added since recording demo:
+
+- A "tag" functionality, which enables you to tag a line you want to review for later, if you are unsure you want to replace it. It will create a list of /file/path:42 tags for you to go and revisit later.
+- You can use "Next" if you're in the middle of processing a file and go to the next file.
+
+Have any other ideas? Let me know or better yet, submit a pull request.
 
 ## Example output
 

data/lib/haml-i18n-extractor/core-ext/hash.rb

@@ -1,14 +1 @@
-# @date = Hash.recursive_init
-# @date[month][day][hours][min][sec] = 1
-# @date now equals {month=>{day=>{hours=>{min=>{sec=>1}}}}}
-class Hash
-  def self.recursive_init
-    new do |hash, key|
-      unless key.nil?
-        hash[key] = recursive_init
-      end
-    end
-  end
-end
-
 require 'active_support/core_ext/hash/deep_merge'

data/lib/haml-i18n-extractor/version.rb

@@ -1,7 +1,7 @@
 module Haml
   module I18n
     class Extractor
-      VERSION = "0.0.19"
+      VERSION = "0.0.20"
     end
   end
 end

data/lib/haml-i18n-extractor/workflow.rb

@@ -3,7 +3,10 @@ module Haml
     class Extractor
       class Workflow
 
+        attr_reader :extractors
+
         def initialize(project_path)
+          @extractors = []
           @project_path = project_path
           @prompter = Haml::I18n::Extractor::Prompter.new
           unless File.directory?(@project_path)
@@ -56,8 +59,9 @@ module Haml
           options = {:type => type} # overwrite or dump haml
           options.merge!({:prompt_per_line => true}) # per-line prompts
           begin
-            @ex1 = Haml::I18n::Extractor.new(haml_path, options)
-            @ex1.run
+            @extractor = Haml::I18n::Extractor.new(haml_path, options)
+            @extractors << @extractor
+            @extractor.run
           rescue Haml::I18n::Extractor::InvalidSyntax
             @prompter.syntax_error(haml_path)
           end

data/lib/haml-i18n-extractor/yaml_tool.rb

@@ -22,10 +22,12 @@ module Haml
 
         # {:en => {:view_name => {:key_name => :string_name } } }
         def yaml_hash
-          yml = HashWithIndifferentAccess.recursive_init
+          yml = Hash.new
           @locale_hash.map do |line_no, info|
             unless info[:keyname].nil?
-              yml[i18n_scope][standardized_viewname(info[:path])][standarized_keyname(info[:keyname])] = info[:replaced_text]
+              keyspace = [i18n_scope,standardized_viewnames(info[:path]), standarized_keyname(info[:keyname]),
+                          info[:replaced_text]].flatten
+              yml.deep_merge!(nested_hash({},keyspace))
             end
           end
           yml = hashify(yml)
@@ -57,7 +59,7 @@ module Haml
 
         # {:foo => {:bar => {:baz => :mam}, :barrr => {:bazzz => :mammm} }}
         def hashify(my_hash)
-          if my_hash.is_a?(HashWithIndifferentAccess)
+          if my_hash.is_a?(Hash)
             result = Hash.new
             my_hash.each do |k, v|
               result[k.to_s] = hashify(v)
@@ -68,6 +70,17 @@ module Haml
           end
         end
 
+        # [1,2,3] => {1 => {2 => 3}}
+        def nested_hash(hash,array)
+          elem = array.shift
+          if array.size == 1
+            hash[elem] = array.last
+          else
+            hash[elem] = {}
+            nested_hash(hash[elem],array)
+          end
+          hash
+        end
         def i18n_scope
           :en
         end
@@ -78,12 +91,21 @@ module Haml
           $1
         end
 
-        # assuming rails format, app/views/users/index.html.haml return users
-        def standardized_viewname(pth)
-          Pathname.new(pth).dirname.to_s.split("/").last
+        # assuming rails format, app/views/users/index.html.haml return [users]
+        # app/views/admin/users/index.html.haml return [admin, users]
+        # app/views/admin/users/with_namespace/index.html.haml return [admin, users, with_namespace]
+        # otherwise, just grab the last one.
+        def standardized_viewnames(pth)
+          array_of_dirs = Pathname.new(pth).dirname.to_s.split("/")
+          index = array_of_dirs.index("views")
+          if index
+            array_of_dirs[index+1..-1]
+          else
+            [array_of_dirs.last]
+          end
         end
 
-     end
+      end
     end
   end
 end

data/test/extractor_test.rb

@@ -52,7 +52,7 @@ module Haml
     end
 
     test "with a prompt_per_line option takes user input into consideration for yaml" do
-      hax_shit
+      TestHelper.hax_shit
       h = Haml::I18n::Extractor.new(file_path("ex1.haml"), :prompt_per_line => true)
       user_input = "D" # dump
       File.readlines(file_path("ex1.haml")).size.times do
@@ -66,7 +66,7 @@ module Haml
     end
 
     test "with a prompt_per_line option user can tag a line for later review" do
-      hax_shit
+      TestHelper.hax_shit
       if File.exist?(Haml::I18n::Extractor::TaggingTool::DB)
         assert_equal File.readlines(Haml::I18n::Extractor::TaggingTool::DB), []
       end
@@ -103,16 +103,8 @@ module Haml
       assert_equal File.exists?(@ex1.haml_writer.path), true
     end
 
-    def hax_shit
-      Dir.glob("*yml").map {|p| FileUtils.rm(p) } # HAX, TODO: handle with yaml files correctly (config/en.yml)
-      Dir.glob("config/locales/*yml").map {|p| FileUtils.rm(p) } # HAX, TODO: handle with yaml files correctly (config/en.yml)
-      if File.exists?(Haml::I18n::Extractor::TaggingTool::DB)
-        FileUtils.rm_rf(Haml::I18n::Extractor::TaggingTool::DB) # HAX, TODO: setup/teardown
-      end
-    end
-
     test "it writes the locale info to an out file when run" do
-      hax_shit
+      TestHelper.hax_shit
       assert_equal File.exists?(@ex1.yaml_tool.locale_file), false
       @ex1.run
       assert_equal File.exists?(@ex1.yaml_tool.locale_file), true

data/test/integration_test.rb

@@ -0,0 +1,19 @@
+module Haml
+  class IntegrationTest < MiniTest::Unit::TestCase
+
+    def setup
+      TestHelper.setup_project_directory!
+    end
+
+    def teardown
+      TestHelper.teardown_project_directory!
+    end
+
+    test "it can handle namespaced views" do
+      workflow = TestHelper.mock_full_project_user_interaction!
+      namespaced_extractor = workflow.extractors.select{|ex| ex.haml_writer.path.match /namespace/ }.last
+      assert namespaced_extractor.yaml_tool.yaml_hash["en"]["namespace"], "namespace key works"
+    end
+
+  end
+end

data/test/tagging_tool_test.rb

@@ -11,6 +11,7 @@ module Haml
     end
 
     test "It uses a file which it uses to keep track of user tagged lines" do
+      TestHelper.hax_shit
       assert ! File.exists?(FILE), "no tagging file should exist"
       Haml::I18n::Extractor::TaggingTool.new
       assert File.exists?(FILE), "tagging file should be created on init"

data/test/test_helper.rb

@@ -94,11 +94,37 @@ module TestHelper
   TMPDIR = File.join(File.dirname(__FILE__) +  "/tmp/")
   PROJECT_DIR = File.join(TMPDIR, "workflow/")
 
+  def self.mock_full_project_user_interaction!
+    automate_user_interaction = ""
+    6.times do                            # should be number of files we're testing on
+      automate_user_interaction << "O"    # overwrite file
+      50.times do                         # should be number of lines in file,
+        # this should do right now.
+        automate_user_interaction << "y"  # replace line
+      end
+    end
+    @workflow = Haml::I18n::Extractor::Workflow.new(TestHelper::PROJECT_DIR)
+    with_highline(automate_user_interaction) do
+      @workflow.run
+    end
+    @workflow
+  end
+
+
+  def self.hax_shit
+    Dir.glob("*yml").map {|p| FileUtils.rm(p) } # HAX, TODO: handle with yaml files correctly (config/en.yml)
+    Dir.glob("config/locales/*yml").map {|p| FileUtils.rm(p) } # HAX, TODO: handle with yaml files correctly (config/en.yml)
+    if File.exists?(Haml::I18n::Extractor::TaggingTool::DB)
+      FileUtils.rm_rf(Haml::I18n::Extractor::TaggingTool::DB) # HAX, TODO: setup/teardown
+    end
+  end
+
   def self.setup_project_directory!
     # mimic a rails app.
     view1 = File.join(PROJECT_DIR, "app", "views", "view1")
     view2 = File.join(PROJECT_DIR, "app", "views", "view2")
-    [ view1, view2 ].map do |dir|
+    view3 = File.join(PROJECT_DIR, "app", "views", "namespace", "view3")
+    [ view1, view2, view3 ].map do |dir|
       FileUtils.mkdir_p(dir)
       ["thing.haml", "thang.haml"].map do |fn|
         haml_text=<<EOH
@@ -121,11 +147,11 @@ module TestHelper
       %td.data= cn.notification.data
       %td.success= cn.success
       %td.reported_to= cn.reported_to
-.nav= will_paginate(@consumer_notifications)     
+.nav= will_paginate(@consumer_notifications)
 EOH
-        File.open(File.join(dir, fn), "w") do |f|
-          f.write haml_text
-        end
+      File.open(File.join(dir, fn), "w") do |f|
+        f.write haml_text
+      end
       end
     end
     # config dir

data/test/workflow_test.rb

@@ -3,57 +3,37 @@ require 'test_helper'
 module Haml
   class WorkflowTest < MiniTest::Unit::TestCase
 
-  def setup
-    TestHelper.setup_project_directory! # tests here rely on this setup...
-    @workflow = Haml::I18n::Extractor::Workflow.new(TestHelper::PROJECT_DIR)
-  end
-
-  def teardown
-    TestHelper.teardown_project_directory!
-  end
+    def setup
+      TestHelper.setup_project_directory! # tests here rely on this setup...
+      @workflow = TestHelper.mock_full_project_user_interaction! 
+    end
 
-  def full_project_user_interaction
-    automate_user_interaction = ""
-    6.times do                            # should be number of files we're testing on
-      automate_user_interaction << "O"    # overwrite file
-      50.times do                         # should be number of lines in file,
-                                          # this should do right now.
-        automate_user_interaction << "y"  # replace line
-      end
+    def teardown
+      TestHelper.teardown_project_directory!
     end
-    automate_user_interaction
- end
 
-  def test_it_should_work_on_a_directory_mkay
-    filename = "#{TestHelper::PROJECT_DIR}app/views/bar/thang.haml"
-    bad_worfklow = Haml::I18n::Extractor::Workflow.new(filename)
-    assert false, "should raise"
+    def test_it_should_work_on_a_directory_mkay
+      filename = "#{TestHelper::PROJECT_DIR}app/views/bar/thang.haml"
+      bad_worfklow = Haml::I18n::Extractor::Workflow.new(filename)
+      assert false, "should raise"
     rescue Haml::I18n::Extractor::NotADirectory
       assert true, "workflow works on a directory bubba."
-  end
-
-  def test_it_finds_all_haml_files
-    assert_equal @workflow.files.size, 4
-  end
+    end
 
-  def test_outputs_stats
-    with_highline do
-      @workflow.start_message
-      assert @output.string.match(/Found 4 haml files/), "Outputs stats"
+    def test_it_finds_all_haml_files
+      assert_equal @workflow.files.size, 6
     end
-  end
 
-  def test_yaml_file_in_config
-    with_highline(full_project_user_interaction) do
-      @workflow.run
+    def test_outputs_stats
+      with_highline do
+        @workflow.start_message
+        assert @output.string.match(/Found 6 haml files/), "Outputs stats"
+      end
     end
-  end
 
-  def test_run_works
-    with_highline(full_project_user_interaction) do
-      @workflow.run
+    def test_yaml_file_in_config
+      TestHelper.mock_full_project_user_interaction!
     end
-  end
 
   end
 end

data/test/yaml_tool_test.rb

@@ -5,6 +5,7 @@ module Haml
 
     def setup
       @temp_locale_dir = "./test/tmp/"
+      TestHelper.setup_project_directory!
     end
 
     def setup_locale_hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml-i18n-extractor
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Shai Rosenfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -200,6 +200,7 @@ files:
 - test/extractor_test.rb
 - test/haml_reader_test.rb
 - test/haml_writer_test.rb
+- test/integration_test.rb
 - test/prompter_test.rb
 - test/support/bad.haml
 - test/support/ex1.haml
@@ -239,6 +240,7 @@ test_files:
 - test/extractor_test.rb
 - test/haml_reader_test.rb
 - test/haml_writer_test.rb
+- test/integration_test.rb
 - test/prompter_test.rb
 - test/support/bad.haml
 - test/support/ex1.haml