haml-i18n-extractor 0.0.5 → 0.0.9

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmRjNTViYWFhY2M4ZDhjMGZmMzk2MGFmZTZhMGFjNDVhMjYyNWIwZg==
+  data.tar.gz: !binary |-
+    ZTc0YjQwN2M5OWRmMDIxNTY0NjNlYmI0YWU3Y2U5NTEzMzA1MDAyOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmMxNWRkZWI5ODE5YzFiNWZmZTQxZDllYTk4MmM4ZjJjYjIzM2U4OWFiNDhj
+    MzE3MjI2ZDMyNjUyNjgxZmQ4Njc0NzI2MzQzOTdhMmVmZDg5ZjI2YzIyYTI1
+    ZDJjODE2M2VkOTNhMzA3MTkwMjFhNzIwM2ViNDljNWI3MjUwYjk=
+  data.tar.gz: !binary |-
+    OWVlOGZmNGEzNjFkYTg5YWQ4Yjk0OGQ1YWZjMmQ5OTVhZjcwZmRiMDczYjE5
+    MjAyYmUzM2FlZmRiNWQ3YzY4MTljYjA5ZmM2ZWM1ZjI3N2M2ODhmNGQyOTZj
+    ODM0MTEwNjMzNTFhZTczNDE5ZmY4NDk4MjY1YzdlYzJhZjEyM2Y=

data/.gitignore

@@ -15,4 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-*.yml
+
+# hacks, these should not appear where thye are.
+*.yml
+test/support/ex1.i18n-extractor.haml

data/README.md

@@ -1,16 +1,19 @@
 # Haml::I18n::Extractor
 
-Extract strings likely to be translated from haml into locale file
+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.
 
-## Usage
+## Installation 
+
+`gem install haml-i18n-extractor`
 
-After installing this gem, you can run the binary in a rails app:
+However I don't upload gems to rubygems in my spare time, so if you want the latest code edge style, you can also simply clone this repo and install the gem from the root of the repo:
 
-`cd your-rails-app; haml-i18n-extractor .`
+`gem uninstall -x haml-i18n-extractor; rm *gem; gem build *gemspec; gem install --local *gem`
 
-## Notes
 
-Right now the design works on a per-file basis:
+## Usage
+
+- You can use the lib directly: 
 
 <pre>
 begin
@@ -23,13 +26,23 @@ rescue Haml::I18n::Extractor::NothingToTranslate
 end  
 </pre>
 
-This is pretty much beta - but it does work! Since it is beta, it does not overwrite anything but lets you decide what you want, and don't want.
+- You can also simply run the binary provided with the gem on a rails app:
+
+`cd your-rails-app-to-translate && haml-i18n-extractor .` 
 
-The workflow at the moment is, to run the binary, then do a `git diff` and see all the changes. 
+The workflow is an interactive one using highline which will allow you to choose if you want to:
 
-What you should be seeing for a "foo.haml" file is a dumped version "foo.i18n-extractor.haml" file which has the temporary representation of the file it tried to translate. It also dumps the corresponding i18n locale .yml file for the haml just translated in the current working directory, suffixed with the path of the haml file it was working on.
+1) overwrite the haml file.
+2) place a tmp haml file.
+3) pass, move on to the next haml file.
 
-## Before
+Run the binary and see!
+
+## Example output
+
+This should be a before and after picture of using this lib, whether directly in rubyland or using the executable:
+
+- Before running (old haml):
 
 <pre>
   shai@comp ~/p/project ‹master*› » cat app/views/admin/notifications/index.html.haml
@@ -55,9 +68,9 @@ What you should be seeing for a "foo.haml" file is a dumped version "foo.i18n-ex
   .nav= will_paginate(@consumer_notifications)
 </pre>
 
-## After: new haml, new yaml.
+- After running (new haml, new yaml):
 
-- Note how some of the strings are replaced, and the ones that shouldn't, aren't. Yup.
+Note how some of the strings are replaced, and the ones that shouldn't, aren't. Yup. Beautiful, right?
 
 Haml:
 
@@ -101,10 +114,14 @@ Yaml:
       nbsp;: ! '&nbsp;'
 </pre>
 
+## Feedback
+
+Can use github issues to address any concern you have, or simply email me, with the contact info here: [http://shairosenfeld.com/](http://shairosenfeld.com/)
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/Rakefile

@@ -23,8 +23,6 @@ end
 Rake::TestTask.new do |t|
   t.libs << 'lib' << 'test'
   t.test_files = Dir["test/**/*_test.rb"]
-  t.warning = true
-  t.verbose = true
 end
 
 task :default => :test

data/TODO

@@ -1,5 +1,20 @@
-- Have an interactive mode: define workflow(s) for using this lib/tool.
-- Remove the ex1.output ex1.i18n-extractor duplication. (or move to tmp dir)
+- Remove the ex1.output ex1.i18n-extractor duplication. (or move to tmp dir):
+    Move to test/tmp a-la the way workflow is working.
+- Ensure that yaml file gets written to the right directory, and does a deep merge.
 - Add {} to disallowed characters
-- Add yaml fixtures and compare those 
-- handled email suffixes (foo.en.html.haml etc)
+- Add yaml fixtures and compare those
+- handled email suffixes (foo.en.html.haml etc)
+- admin/bla should be namespaced such as: en.admin.bla vs just en.bla in the yml file?
+- add to README 'it is idempotent...' :P
+- add herbgobbler (ERB) and this to another more generalized repo for translating templates?
+- Refactor tests: split out what is integration vs unit, too much coupling.
+
+## chage the workflow to work per-line
+
+   regarding overwriting or not:
+     right now just leave be (tmp file). figure out later.
+        pass in opts...
+   cleanup workflow - keep around
+     but no prompting, just handle a rails project dir.
+     move any prompting in workflow into prompter.
+   if the user says 'no' on a line, make sure to not replace it!

data/bin/haml-i18n-extractor

@@ -3,29 +3,15 @@
 require 'haml-i18n-extractor'
 
 if ARGV.empty?
+  puts "Usage: <haml-i18n-extractor> --version"
   puts "Usage: <haml-i18n-extractor> [path]"
   abort
 end
 
-relative_path = ARGV[0]
-absolute_path = File.expand_path(relative_path)
-
-all_files = Dir.glob("**/*")
-haml_paths = all_files.select do |file|
-  file.match /.haml$/
+if ARGV[0] == "--version"
+  puts Haml::I18n::Extractor::VERSION
+  abort
 end
 
-# right now, this should create a copy of the haml file in that directory with a special suffix for review.
-# review it, see what fails, fix, etc.
-
-haml_paths.each do |haml_path|
-  begin
-    puts "extracting strings for #{haml_path}"
-    @ex1 = Haml::I18n::Extractor.new(haml_path)
-    @ex1.run
-  rescue Haml::I18n::Extractor::InvalidSyntax
-    puts "There was an error with #{haml_path}"
-  rescue Haml::I18n::Extractor::NothingToTranslate
-    puts "Nothing to translate for #{haml_path}"
-  end
-end
+workflow = Haml::I18n::Extractor::Workflow.new(File.expand_path(ARGV[0]))
+workflow.run

data/haml-i18n-extractor.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'nokogiri'
+  gem.add_development_dependency 'highline'
 
 end

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

@@ -5,22 +5,27 @@ module Haml
       def self.debug?
         ENV['DEBUG']
       end
-      
+
       class InvalidSyntax < StandardError ; end
-      class NothingToTranslate < StandardError ; end
+      class NotADirectory < StandardError ; end
       class NotDefinedLineType < StandardError ; end
 
       LINE_TYPES_ALL = [:text, :not_text, :loud, :silent, :element]
       LINE_TYPES_ADD_EVAL = [:text, :element]
-      
+
       attr_reader :haml_reader, :haml_writer
-      attr_reader :locale_hash, :yaml_tool
+      attr_reader :locale_hash, :yaml_tool, :type
 
-      def initialize(haml_path)
+      def initialize(haml_path, opts = {})
+        @type = opts[:type]
+        @prompt_per_line = opts[:prompt_per_line]
         @haml_reader = Haml::I18n::Extractor::HamlReader.new(haml_path)
         validate_haml(@haml_reader.body)
-        @haml_writer = Haml::I18n::Extractor::HamlWriter.new(haml_path)
+        @haml_writer = Haml::I18n::Extractor::HamlWriter.new(haml_path, {:type => @type})
         @yaml_tool = Haml::I18n::Extractor::YamlTool.new
+        # hold all the processed lines
+        @body = []
+        # holds a line_no => {info_about_line_replacemnts_or_not}
         @locale_hash = {}
       end
 
@@ -30,55 +35,96 @@ module Haml
         @haml_writer.write_file
         @yaml_tool.write_file
       end
-      
+
       def assign_new_body
         @haml_writer.body = new_body
       end
-      
+
       def assign_yaml
         @yaml_tool.locale_hash = @locale_hash
       end
-      
+
       def assign_replacements
         assign_new_body
         assign_yaml
       end
 
-      # processes the haml document, replaces the input body to an output body of replacements. also sets an in memory hash of replacement info
-      # to be used later by the yaml tool.
-      # keep indentation to use later when printing out.
-      def new_body
-        new_lines = []
-        file_has_been_parsed = false
+     def new_body
         @haml_reader.lines.each_with_index do |orig_line, line_no|
-          orig_line.chomp!
-          orig_line.rstrip.match(/([ \t]+)?(.*)/)
-          whitespace_indentation = $1
-          orig_line = $2
-          line_type, line_match = Haml::I18n::Extractor::TextFinder.new(orig_line).process_by_regex
-          if line_match && !line_match.empty?
-            file_has_been_parsed = true
-            replacer = Haml::I18n::Extractor::TextReplacer.new(orig_line, line_match, line_type)
-            @locale_hash[line_no] = replacer.replace_hash.dup.merge!({:path => @haml_reader.path })
-            new_lines << "#{whitespace_indentation}#{replacer.replace_hash[:modified_line]}"
+          process_line(orig_line,line_no)
+        end
+        @body.join("\n")
+      end
+
+      # this is the bulk of it:
+      # where we end up setting body info and locale_hash.
+      # not _write_, just set that info in memory in correspoding locations.
+      # refactor more?
+      def process_line(orig_line, line_no)
+        orig_line.chomp!
+        orig_line, whitespace = handle_line_whitespace(orig_line)
+        line_type, line_match = handle_line_finding(orig_line)
+        should_be_replaced, text_to_replace, locale_hash = handle_line_replacing(orig_line, line_match, line_type, line_no)
+        if should_be_replaced
+          if prompt_per_line?
+            Haml::I18n::Extractor::Prompter.new(orig_line,text_to_replace).ask_user
+            user_approves = Haml::I18n::Extractor::Prompter.new(orig_line,text_to_replace).ask_user
           else
-            @locale_hash[line_no] = { :modified_line => nil,:keyname => nil,:replaced_text => nil, :path => nil }
-            new_lines << "#{whitespace_indentation}#{orig_line}"
+            user_approves = true
           end
         end
-        raise NothingToTranslate if !file_has_been_parsed
-        new_lines.join("\n")
+        append_to_locale_hash(line_no, locale_hash)
+        if user_approves
+          add_to_body("#{whitespace}#{text_to_replace}")
+        else
+          add_to_body("#{whitespace}#{orig_line}")
+        end
+        return should_be_replaced
+      end
+
+      def prompt_per_line?
+        !!@prompt_per_line
       end
-      
+
       private
-      
+
+      def handle_line_replacing(orig_line, line_match, line_type, line_no)
+        if line_match && !line_match.empty?
+          replacer = Haml::I18n::Extractor::TextReplacer.new(orig_line, line_match, line_type)
+          hash = replacer.replace_hash.dup.merge!({:path => @haml_reader.path })
+          [ true, hash[:modified_line], hash ]
+        else
+          hash = { :modified_line => nil,:keyname => nil,:replaced_text => nil, :path => nil }
+          [ false, orig_line, hash ]
+        end
+      end
+
+      def append_to_locale_hash(line_no, hash)
+        @locale_hash[line_no] = hash
+      end
+
+      def handle_line_finding(orig_line)
+        Haml::I18n::Extractor::TextFinder.new(orig_line).process_by_regex
+      end
+
+      def handle_line_whitespace(orig_line)
+        orig_line.rstrip.match(/([ \t]+)?(.*)/)
+        whitespace_indentation = $1
+        orig_line = $2
+        [ orig_line, whitespace_indentation ]
+      end
+
+      def add_to_body(ln)
+        @body << ln
+      end
+
       def validate_haml(haml)
         parser = Haml::Parser.new(haml, Haml::Options.new)
         parser.parse
         rescue Haml::SyntaxError
           raise InvalidSyntax, "invalid syntax for haml #{@haml_reader.path}"
       end
-      
+
     end
   end
 end

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

@@ -13,8 +13,8 @@ module Haml
           @lines = file.readlines
           file.rewind
         end
-        
+
       end
     end
   end
-end
+end

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

@@ -3,10 +3,17 @@ module Haml
     class Extractor
       class HamlWriter
 
-        attr_accessor :path, :lines, :body
+        attr_accessor :path, :lines, :body, :type
 
-        def initialize(orig_path)
-          @path = orig_path.gsub(/.haml$/, ".i18n-extractor.haml")
+        def initialize(orig_path, options = {})
+          @type = options[:type] || :dump # safe default.
+          
+          if overwrite?
+            @path = orig_path
+          elsif dump?
+            @path = orig_path.gsub(/.haml$/, ".i18n-extractor.haml")
+          end
+          
         end
 
         def write_file
@@ -15,6 +22,14 @@ module Haml
           f.close
         end
 
+        def overwrite?
+          @type == :overwrite
+        end
+        
+        def dump?
+          @type == :dump
+        end
+        
       end
     end
   end

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

@@ -0,0 +1,16 @@
+module Haml
+  module I18n
+    class Extractor
+      module Helpers
+        module Highline
+
+          def highlight(str, color = :yellow)
+            "<%= color('#{str.to_s}', :black, :on_#{color}) %>"
+          end
+
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,38 @@
+require 'highline'
+require 'highline/import'
+
+module Haml
+  module I18n
+    class Extractor
+      class Prompter
+
+        include Helpers::Highline
+
+        def initialize(orig_line, replaced_line)
+          @orig_line = orig_line
+          @replaced_line = replaced_line
+        end
+
+        def ask_user
+          say(highlight("Replace this line:"))
+          say("\n")
+          say(@orig_line.inspect)
+          say("\n")
+          say(highlight("With this line?"))
+          say("\n")
+          say(@replaced_line.inspect)
+          say("\n")
+          answer = ask(highlight('y/n?')) do |q|
+                     q.echo      = false
+                     q.character = true
+                     q.validate  = /\A[yn]\Z/
+          end
+          answer == 'y'
+        end
+
+      end
+    end
+  end
+end
+
+

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

@@ -32,7 +32,7 @@ module Haml
           if @haml == ""
             return Haml::Parser::Line.new("", "", "", 0, @parser, false)
           end
-          
+
           match = @haml.rstrip.scan(/(([ \t]+)?(.*?))(?:\Z|\r\n|\r|\n)/m)
           match.pop
           haml_line ||= match.each_with_index.map do |(full, whitespace, text), index|

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

@@ -1,7 +1,7 @@
 module Haml
   module I18n
     class Extractor
-      VERSION = "0.0.5"
+      VERSION = "0.0.9"
     end
   end
 end

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

@@ -0,0 +1,90 @@
+require 'highline'
+require 'highline/import'
+
+module Haml
+  module I18n
+    class Extractor
+      class Workflow
+
+        include Helpers::Highline
+
+        def initialize(project_path)
+          @project_path = project_path
+          unless File.directory?(@project_path)
+            raise Extractor::NotADirectory, "#{@project_path} needs to be a directory!"
+          end
+        end
+
+        def files
+          @haml_files ||= Dir.glob(@project_path + "/**/*").select do |file|
+           file.match /.haml$/
+          end
+        end
+
+
+        # FIXME, use prompter to do any prompting in this class TODO
+        #
+        def output_stats
+          say(highlight("Wowza! Found #{files.size} haml files!\n\n", :red))
+          say("#{files.join("\n")}\n\n")
+        end
+
+        CHOICES = {O: :overwrite, D: :dump, N: :next}
+
+        def process_file?(file)
+          o = %{[#{highlight(:O)}]verwrite}
+          d = %{[#{highlight(:D)}]ump}
+          n = %{[#{highlight(:N)}]ext}
+          say("#{o} OR #{d} OR #{n}\n")
+          say("Choose the right option for")
+          say("#{index_for(file)} #{highlight(file)}")
+          choices = CHOICES.keys.map(&:to_s)
+          prompt = "Your choice #{highlight(choices)}?"
+          answer = ask(prompt) do |q|
+                     q.echo      = false
+                     q.character = true
+                     q.validate  = /\A[#{choices}r]\Z/
+                   end
+          return :overwrite if answer == 'O'
+          return :overwrite if answer == 'R' # cheat 'replace'
+          return :dump if answer == 'D'
+        end
+
+        def run
+          output_stats
+          files.each do |haml_path|
+            type = process_file?(haml_path)
+            if type
+              process(haml_path, type)
+            else
+              say(highlight("Not processing") + " file #{haml_path}.")
+            end
+          end
+        end_message
+        end
+
+        private
+
+        def end_message
+          say(highlight("\n\n\nNow run a git diff or such and see what changed!"))
+        end
+
+        def index_for(file)
+          highlight((files.index(file) + 1).to_s)
+        end
+
+        def process(haml_path, type)
+          say(highlight("#{type}-d file") + " #{haml_path}\n\n")
+          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
+          rescue Haml::I18n::Extractor::InvalidSyntax
+            say("Haml Syntax error fo #{haml_path}. Please inspect further.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/haml-i18n-extractor.rb

@@ -1,7 +1,10 @@
 require "haml-i18n-extractor/version"
+require "haml-i18n-extractor/helpers"
 require "haml-i18n-extractor/text_finder"
 require "haml-i18n-extractor/text_replacer"
 require "haml-i18n-extractor/haml_reader"
 require "haml-i18n-extractor/haml_writer"
 require "haml-i18n-extractor/yaml_tool"
-require "haml-i18n-extractor/extractor"
+require "haml-i18n-extractor/extractor"
+require "haml-i18n-extractor/prompter"
+require "haml-i18n-extractor/workflow"

data/test/extractor_test.rb

@@ -7,10 +7,37 @@ module Haml
       @ex1 = Haml::I18n::Extractor.new(file_path("ex1.haml"))
     end
 
-    test "it can process the haml and replace it with other text!" do
+    test "it can process the haml and replace it with other text" do
       @ex1.run
     end
 
+    test "with a type of overwrite or dump affecting haml writer" do
+      h = Haml::I18n::Extractor.new(file_path("ex1.haml"), :type => :overwrite)
+      assert_equal h.haml_writer.overwrite?, true
+      h = Haml::I18n::Extractor.new(file_path("ex1.haml"))
+      assert_equal h.haml_writer.overwrite?, false
+    end
+
+    test "with a prompt_per_line option which prompts the user-per line" do
+      h = Haml::I18n::Extractor.new(file_path("ex1.haml"), :prompt_per_line => true)
+      assert_equal h.prompt_per_line?, true
+      h = Haml::I18n::Extractor.new(file_path("ex1.haml"))
+      assert_equal h.prompt_per_line?, false
+    end
+
+    test "with a prompt_per_line option takes user input into consideration" do
+      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
+        user_input << "n" # do not replace lines
+      end
+      with_highline(user_input) do
+        h.run
+      end
+      # no changes were made cause user was all like 'uhhh, no thxk'
+      assert_equal File.read(h.haml_writer.path), File.read(file_path("ex1.haml"))
+    end
+
     test "can not initialize if the haml is not valid syntax" do
       begin
         Haml::I18n::Extractor.new(file_path("bad.haml"))
@@ -20,11 +47,6 @@ module Haml
       end
     end
 
-    test "can initialize if the haml is valid syntax" do
-      # setup method initializes
-      assert true, "extractor can initialize"
-    end
-
     test "it can replace a string body and have expected output" do
       expected_output = File.read(file_path("ex1.output.haml"))
       assert_equal @ex1.new_body, expected_output
@@ -36,7 +58,7 @@ module Haml
       @ex1.run
       assert_equal File.exists?(@ex1.haml_writer.path), true
     end
-    
+
     test "it writes the locale info to an out file when run" do
       assert_equal File.exists?(@ex1.yaml_tool.locale_file), false
       @ex1.run
@@ -44,16 +66,6 @@ module Haml
       assert_equal YAML.load(File.read(@ex1.yaml_tool.locale_file)), @ex1.yaml_tool.yaml_hash
     end
 
-    test "it raises if there is nothing to translate" do
-      begin
-        @nothing_to_translate = Haml::I18n::Extractor.new(file_path("nothing_to_translate.haml"))
-        assert_equal @ex1.yaml_tool.locale_hash, nil
-        @nothing_to_translate.run
-      rescue Haml::I18n::Extractor::NothingToTranslate
-        assert true, "NothingToTranslate raised"
-      end
-    end
-
     test "sends a hash over of replacement info to its yaml tool when run" do
       @ex1 = Haml::I18n::Extractor.new(file_path("ex1.haml"))
       assert_equal @ex1.yaml_tool.locale_hash, nil
@@ -69,10 +81,11 @@ module Haml
           @ex1.haml_writer.body = File.read(file_path("bad.haml"))
           @ex1.run
         end
+        assert false, "should raise"
       rescue Haml::I18n::Extractor::InvalidSyntax
         assert true, "it should not allow invalid output to be written"
       end
     end
     
   end
-end
+end

data/test/haml_reader_test.rb

@@ -3,9 +3,9 @@ require 'fileutils'
 
 module Haml
   class HamlReaderTest < MiniTest::Unit::TestCase
-    
+
     TEMP_FILE_PATH = "/tmp/foo_haml_extractor_test"
-    
+
     def setup
       FileUtils.rm_rf(TEMP_FILE_PATH)
       10.times do |index|

data/test/haml_writer_test.rb

@@ -4,7 +4,7 @@ require 'fileutils'
 module Haml
   class HamlWriterTest < MiniTest::Unit::TestCase
 
-    ORIG_TEMP_FILE_PATH = "/tmp/foo_haml_extractor_test.haml"
+    ORIG_TEMP_FILE_PATH = File.join(TestHelper::TMPDIR, "foo_haml_extractor_test.haml")
 
     def setup
       File.open(ORIG_TEMP_FILE_PATH, "w") do |f|
@@ -18,15 +18,19 @@ module Haml
       FileUtils.rm_rf(ORIG_TEMP_FILE_PATH)
     end
 
-    test "is initialized with an array of lines, an original path and constructs a body and path with it" do
+    test "it can dump the file and that is the default" do
       @writer = Haml::I18n::Extractor::HamlWriter.new(ORIG_TEMP_FILE_PATH)
-      assert_equal @writer.path, "/tmp/foo_haml_extractor_test.i18n-extractor.haml"
+      @writer.body = "This is what it is"
+      @writer.write_file
+      assert_equal @writer.path, "#{TestHelper::TMPDIR}foo_haml_extractor_test.i18n-extractor.haml"
+      assert_equal File.read(@writer.path), "This is what it is\n"
     end
-    
-    test "it can write the file" do
-      @writer = Haml::I18n::Extractor::HamlWriter.new(ORIG_TEMP_FILE_PATH)
+
+    test "it can overwrite the file" do
+      @writer = Haml::I18n::Extractor::HamlWriter.new(ORIG_TEMP_FILE_PATH, {:type => :overwrite})
       @writer.body = "This is what it is"
       @writer.write_file
+      assert_equal @writer.path, ORIG_TEMP_FILE_PATH # we ovewrote the original one.
       assert_equal File.read(@writer.path), "This is what it is\n"
     end
 

data/test/prompter_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+module Haml
+  class PrompterTest < MiniTest::Unit::TestCase
+
+    def test_asks_to_process_line_yes
+      with_highline("y") do
+        assert_equal Haml::I18n::Extractor::Prompter.new("orig", "replace").ask_user, true
+      end
+    end
+
+    def test_asks_to_process_line_no
+      with_highline("n") do
+        assert_equal Haml::I18n::Extractor::Prompter.new("orig", "replace").ask_user, false
+      end
+    end
+
+ end
+end
+
+
+

data/test/support/ex1.haml

@@ -25,4 +25,4 @@
                   %a{:href => url_for([:admin, :accounts])}
                     %span Accounts
         - if true
-          What is@ supposed to be, is supposed to be! ~
+          What is@ supposed to be, is supposed to be! ~

data/test/test_helper.rb

@@ -13,8 +13,8 @@ require 'action_view'
 require 'nokogiri'
 require 'rails'
 require 'fileutils'
-
 require 'pry'
+
 module Declarative
   def test(name, &block)
     define_method("test #{name}", &block)
@@ -79,6 +79,18 @@ def file_path(name)
   File.dirname(__FILE__) + "/support/#{name}"
 end
 
+def with_highline(input = nil, &blk)
+  old_terminal = $terminal
+  @input     = input ? StringIO.new(input) : StringIO.new
+  @output    = StringIO.new
+  $terminal = HighLine.new(@input, @output)
+  yield
+ensure
+  $terminal = old_terminal
+end
+
+
+
 def without_rails_mode
   Object.send(:remove_const, :Rails) if defined?(Rails)
   yield
@@ -96,3 +108,55 @@ EOR
   yield
 end
 
+module TestHelper
+
+  TMPDIR = File.join(File.dirname(__FILE__) +  "/tmp/")
+  PROJECT_DIR = File.join(TMPDIR, "workflow/")
+
+  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|
+      FileUtils.mkdir_p(dir)
+      ["thing.haml", "thang.haml"].map do |fn|
+        haml_text=<<EOH
+%h1 Notifications
+
+.nav= will_paginate(@consumer_notifications)
+%table.themed{cellspacing: 0}
+  %thead
+    %tr
+      %th.first Type #{fn}_#{dir}
+      %th Identifier #{fn}_#{dir}
+      %th Data #{fn}_#{dir}
+      %th Success #{fn}_#{dir}
+      %th Reported To #{fn}_#{dir}
+      %th.last &nbsp; #{fn}_#{dir}
+  - @consumer_notifications.each do |cn|
+    %tr
+      %td.type= cn.notification.type
+      %td.identifier= cn.notification.identifier
+      %td.data= cn.notification.data
+      %td.success= cn.success
+      %td.reported_to= cn.reported_to
+.nav= will_paginate(@consumer_notifications)     
+EOH
+        File.open(File.join(dir, fn), "w") do |f|
+          f.write haml_text
+        end
+      end
+    end
+    # config dir
+    FileUtils.mkdir_p(File.join(PROJECT_DIR, "config/locales"))
+    # for testing we're only working on .haml files.
+    File.open(File.join(view1, "not_haml.rb"), "w") do |f|
+      f.write "puts :not_haml"
+    end
+  end
+
+  def self.teardown_project_directory!
+    FileUtils.rm_rf(PROJECT_DIR)
+  end
+  
+end

data/test/text_finder_test.rb

@@ -3,12 +3,12 @@ require 'test_helper'
 module Haml
   class StringFinderTest < MiniTest::Unit::TestCase
 
-    # empty line 
+    # empty line
     test "empty line does not explode" do
       assert_equal find_text(""), ""
       assert_equal find_type(""), :text
     end
-    
+
     # regular text mode
     test "regular text without whitespaces" do
       assert_equal find_text("iphone"), "iphone"

data/test/workflow_test.rb

@@ -0,0 +1,67 @@
+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 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
+
+  def test_outputs_stats
+    with_highline do
+      @workflow.output_stats
+      assert @output.string.match(/Found 4 haml files/), "Outputs stats"
+    end
+  end
+
+  def test_asks_to_process_file_yes
+    with_highline("O") do
+      assert_equal @workflow.process_file?(@workflow.files.first), :overwrite
+    end
+  end
+
+  def test_asks_to_process_file_no
+    with_highline("N") do
+      assert_equal @workflow.process_file?(@workflow.files.first), nil
+    end
+  end
+  
+  def test_asks_to_process_file_dump
+    with_highline("D") do
+      assert_equal @workflow.process_file?(@workflow.files.first), :dump
+    end
+  end
+
+  def test_run_works
+    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
+    with_highline(automate_user_interaction ) do
+      @workflow.run
+    end
+  end
+
+  end
+end

metadata

@@ -1,93 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: haml-i18n-extractor
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.9
 platform: ruby
 authors:
 - Shai Rosenfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70132069387120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70132069387120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70132069386340 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70132069386340
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70132069385240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70132069385240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rbench
-  requirement: &70132069384520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70132069384520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70132069383420 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70132069383420
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70132069382460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70132069382460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70132069397680 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70132069397680
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Parse the texts out of the haml files into localization files
 email:
 - shaiguitar@gmail.com
@@ -110,59 +144,62 @@ files:
 - lib/haml-i18n-extractor/extractor.rb
 - lib/haml-i18n-extractor/haml_reader.rb
 - lib/haml-i18n-extractor/haml_writer.rb
+- lib/haml-i18n-extractor/helpers.rb
+- lib/haml-i18n-extractor/prompter.rb
 - lib/haml-i18n-extractor/text_finder.rb
 - lib/haml-i18n-extractor/text_replacer.rb
 - lib/haml-i18n-extractor/version.rb
+- lib/haml-i18n-extractor/workflow.rb
 - lib/haml-i18n-extractor/yaml_tool.rb
 - test/extractor_test.rb
 - test/haml_reader_test.rb
 - test/haml_writer_test.rb
+- test/prompter_test.rb
 - test/support/bad.haml
 - test/support/ex1.haml
-- test/support/ex1.i18n-extractor.haml
 - test/support/ex1.output.haml
 - test/support/nothing_to_translate.haml
 - test/support/nothing_to_translate.i18n-extractor.haml
 - test/test_helper.rb
 - test/text_finder_test.rb
 - test/text_replacer_test.rb
+- test/workflow_test.rb
 - test/yaml_tool_test.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Parse the texts out of the haml files into localization files
 test_files:
 - test/extractor_test.rb
 - test/haml_reader_test.rb
 - test/haml_writer_test.rb
+- test/prompter_test.rb
 - test/support/bad.haml
 - test/support/ex1.haml
-- test/support/ex1.i18n-extractor.haml
 - test/support/ex1.output.haml
 - test/support/nothing_to_translate.haml
 - test/support/nothing_to_translate.i18n-extractor.haml
 - test/test_helper.rb
 - test/text_finder_test.rb
 - test/text_replacer_test.rb
+- test/workflow_test.rb
 - test/yaml_tool_test.rb
-has_rdoc: 

data/test/support/ex1.i18n-extractor.haml

@@ -1,28 +0,0 @@
-#header.page
-  %p#brand= link_to t('.some_place'), '/'
-  #menu
-    %ul.header-links
-      - if true
-        - if false
-          %li
-            %a#cheese-rice{:href => url_for([:admin, :dashboard])}
-              %span.thing-ok= t('.admin')
-            #bla
-              %ul#admin-dropdown-box
-                %li
-                  %a{:href => url_for([:admin, :dashboard])}
-                    %span= t('.admin_dashboard')
-                %li
-                  %a{:href => url_for([:admin, :stacks])}
-                    %span= t('.stacks')
-                %li
-                  %a{:href => url_for([:admin, :environments])}
-                    %span t('.alerts')
-                %li
-                  %a{:href => url_for([:admin, :environments])}
-                    %span= t('.alerts')
-                %li
-                  %a{:href => url_for([:admin, :accounts])}
-                    %span= t('.accounts')
-        - if true
-          = t('.what_is_supposed_to_be_is_supp')