i15r 0.4.4 → 0.5.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby
+  - rbx-19mode
+script: "bundle exec rspec spec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i15r (0.4.4)
+    i15r (0.5.0)
 
 GEM
   remote: http://rubygems.org/

data/README.markdown

@@ -1,27 +1,31 @@
-# I15r
+# I15r ![Build Status](https://api.travis-ci.org/balinterdi/i15r.png)
+
 
 ## Summary
 
-I15r (Internationalizer) searches for all the non-i18n texts in your views in the given files/directory and replaces them with I18n messages. The message string is based on the file in which the text was found and the text itself that was replaced. 
+I15r (Internationalizer) searches for all the non-i18n texts in your views in
+the given files/directory and replaces them with I18n messages. The message
+string is based on the file in which the text was found and the text itself
+that was replaced.
 
 E.g
 
     (in file app/views/users/new.html.erb)
     <label for="user-name">Name</label>
     <input type="text" id="user-name" name="user[name]" />
-    
+
 will be replaced by:
 
     (in file app/views/users/new.html.erb)
     <label for="user-name"><%= I18n.t("users.new.name") %></label>
     <input type="text" id="user-name" name="user[name]" />
-    
-and 
+
+and
 
     (in file app/views/member/users/edit.html.erb)
     <label for="user-name">Name</label>
     <input type="text" id="user-name" name="user[name]" />
-    
+
 will be replaced by
 
     (in file app/views/member/users/edit.html.erb)
@@ -33,7 +37,11 @@ It can process erb and haml files.
 ## Installation
 
     gem install i15r
-    
+
+or put the following in your Gemfile:
+
+   gem 'i15r', '~> 0.4.4'
+
 ## Usage
 
 ### Convert a single file
@@ -43,18 +51,18 @@ It can process erb and haml files.
 ### Convert all files in a directory (deep search)
 
     i15r path/leading/to/directory
-    
+
 All files with an erb or haml suffix in that directory or somewhere in the hierarchy below will be converted.
 
 ### Dry run
 
 By default, i15r overwrites all the source files with the i18n message strings it generates. If you first want to see what would be replaced, you should do:
 
-    i15r app/views/users -p
+    i15r app/views/users -n
 
 or
 
-    i15r app/views/users --pretend
+    i15r app/views/users --dry-run
 
 ### Custom prefix
 
@@ -74,10 +82,21 @@ The file will then contain:
 
 ## Disclaimer (sort of)
 
-Please note that this is an early version mainly built up of examples I've come through doing client work. I am pretty sure there are a number of cases which i15r -at the moment- does not handle well (or at all). If you find such an example, please [let me know][issue_tracker] or if you feel motivated, submit a patch. Oh, yes, to prevent unwanted changes to your view files, you should use a SCM (that goes without saying, of course) and probably use the --pretend option.
+Please note that this is an early version mainly built up of examples I've come
+through doing client work. I am pretty sure there are a number of cases which
+i15r -at the moment- does not handle well (or at all). If you find such an
+example, please [let me know][issue_tracker] or if you feel motivated, submit a
+patch. Oh, yes, to prevent unwanted changes to your view files, you should use
+a SCM (that goes without saying, of course) and probably use the --pretend
+option.
 
 [issue_tracker]: http://github.com/balinterdi/i15r/issues
 
 ## Licensing, contribution
 
-The source code of this gem can be found at [http://github.com/balinterdi/i15r/](http://github.com/balinterdi/i15r/). It is released under the MIT-LICENSE, so you can basically do anything with it. However, if you think your modifications only make the tool better, please send a pull request or patch and I will consider merging in your changes. Any suggestions or feedback are welcome to <balint@balinterdi.com>.
+The source code of this gem can be found at
+[http://github.com/balinterdi/i15r/](http://github.com/balinterdi/i15r/). It is
+released under the MIT-LICENSE, so you can basically do anything with it.
+However, if you think your modifications only make the tool better, please send
+a pull request or patch and I will consider merging in your changes. Any
+suggestions or feedback are welcome to <balint@balinterdi.com>.

data/bin/i15r

@@ -3,9 +3,44 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 
 require 'i15r'
+require 'i15r/version'
+require 'i15r/file_reader'
+require 'i15r/file_writer'
+require 'i15r/console_printer'
+require 'optparse'
 
-@i15r = I15R::Base.new
-@i15r.instance_eval do
-  parse_options(ARGV)
-  internationalize!(ARGV[-1])
+def parse_options(args)
+  options = {}
+  opts = OptionParser.new do |opts|
+    opts.banner = "Usage: ruby i15r.rb [options] <path_to_internationalize>"
+    opts.on("--prefix PREFIX",
+            "Apply PREFIX to generated I18n messages instead of deriving it from the path") do |prefix|
+      options[:prefix] = prefix
+    end
+    opts.on("-n", "--dry-run", "Do not write the files, just show the diff") do
+      options[:dry_run] = true
+    end
+    opts.on("--no-default", "Do not insert the replaced string as the :default in the I18n string") do
+      options[:add_default] = false
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
+
+    opts.on_tail("--version", "Show version") do
+      puts I15R::VERSION
+      exit
+    end
+  end
+
+  opts.parse!(args)
+  options
 end
+
+@i15r = I15R.new(I15R::FileReader.new,
+                 I15R::FileWriter.new,
+                 I15R::ConsolePrinter.new,
+                 parse_options(ARGV))
+@i15r.internationalize!(ARGV[-1])

data/lib/i15r.rb

@@ -1,6 +1,91 @@
-require 'i15r/base'
 require 'i15r/pattern_matcher'
-require 'i15r/version'
 
-module I15R
+class I15R
+  class AppFolderNotFound < Exception; end
+
+  class Config
+    def initialize(config)
+      @options = config
+    end
+
+    def prefix
+      @options.fetch(:prefix, nil)
+    end
+
+    def dry_run?
+      @options.fetch(:dry_run, false)
+    end
+
+    def add_default
+      @options.fetch(:add_default, true)
+    end
+  end
+
+  attr_reader :config
+
+  def initialize(reader, writer, printer, config={})
+    @reader = reader
+    @writer = writer
+    @printer = printer
+    @config = I15R::Config.new(config)
+  end
+
+  def config=(hash)
+    @config = I15R::Config.new(hash)
+  end
+
+  def file_path_to_message_prefix(file)
+    segments = File.expand_path(file).split('/').reject { |segment| segment.empty? }
+    subdir = %w(views helpers controllers models).find do |app_subdir|
+       segments.index(app_subdir)
+    end
+    if subdir.nil?
+      raise AppFolderNotFound, "No app. subfolders were found to determine prefix. Path is #{File.expand_path(file)}"
+    end
+    first_segment_index = segments.index(subdir) + 1
+    file_name_without_extensions = segments.last.split('.').first
+    if file_name_without_extensions and file_name_without_extensions[0] == '_'
+      file_name_without_extensions = file_name_without_extensions[1..-1]
+    end
+    path_segments = segments.slice(first_segment_index...-1)
+    if path_segments.empty?
+      file_name_without_extensions
+    else
+      "#{path_segments.join('.')}.#{file_name_without_extensions}"
+    end
+  end
+
+  def internationalize_file(path)
+    text = @reader.read(path)
+    prefix = config.prefix || file_path_to_message_prefix(path)
+    template_type = path[/(?:.*)\.(.*)$/, 1]
+    @printer.println("#{path}:")
+    @printer.println("")
+    i18ned_text = sub_plain_strings(text, prefix, template_type.to_sym)
+    @writer.write(path, i18ned_text) unless config.dry_run?
+  end
+
+  def display_indented_header(prefix)
+    puts "en:"
+    prefix_parts = prefix.split(".").each_with_index do |p, i|
+      p = "#{p}:"
+      #TODO: perhaps " "*i is simpler
+      (0..i).each { |i| p = "  " + p }
+      puts "#{p}"
+    end
+  end
+
+  def sub_plain_strings(text, prefix, file_type)
+    pm = I15R::PatternMatcher.new(prefix, file_type, :add_default => config.add_default)
+    transformed_text = pm.run(text) do |old_line, new_line|
+      @printer.print_diff(old_line, new_line)
+    end
+    transformed_text + "\n"
+  end
+
+  def internationalize!(path)
+    #TODO: Indicate if we're running in dry-run mode
+    files = File.directory?(path) ? Dir.glob("#{path}/**/*.{erb,haml}") : [path]
+    files.each { |file| internationalize_file(file) }
+  end
 end

data/lib/i15r/console_printer.rb

@@ -0,0 +1,13 @@
+class I15R
+  class ConsolePrinter
+    def println(text)
+      puts text
+    end
+
+    def print_diff(old_row, new_row)
+      puts "- #{old_row}"
+      puts "+ #{new_row}"
+      puts
+    end
+  end
+end

data/lib/i15r/file_reader.rb

@@ -0,0 +1,7 @@
+class I15R
+  class FileReader
+    def read(file)
+      File.read(File.expand_path(file))
+    end
+  end
+end

data/lib/i15r/file_writer.rb

@@ -0,0 +1,7 @@
+class I15R
+  class FileWriter
+    def write(path, content)
+      open(File.expand_path(path), "w") { |f| f.write(content) }
+    end
+  end
+end

data/lib/i15r/pattern_matcher.rb

@@ -1,3 +1,154 @@
-require 'i15r/pattern_matchers/base'
-require 'i15r/pattern_matchers/erb'
-require 'i15r/pattern_matchers/haml'
+class I15R
+  class PatternMatcher
+    HAML_SYMBOLS = ["%", "#", "{", "}", "(", ")", ".", "_", "-"]
+    PATTERNS = {
+      :erb => [
+        /<%=\s*link_to\s+(?<title>['"].+?['"])/,
+        /<%=.*label(_tag)?[^,]+?(?<label-title>(['"].+?['"]|:[[:alnum:]_]+))[^,]+%>.*$/,
+        /<%=.*label(_tag)?.*?,\s*(?<label-title>(['"].+?['"]|:[[:alnum:]_]+))/,
+        /<%=.*submit(_tag)?\s+(?<submit-text>(['"].+?['"]|:[[:alnum:]_]+))/,
+        />(?<tag-content>[[:space:][:alnum:][:punct:]]+?)<\//,
+        /<a\s+title=['"](?<link-title>.+?)['"]/,
+        /^\s*(?<pre-tag-text>[[:alnum:]]+[[:alnum:][:space:][:punct:]]*?)</
+      ],
+      :haml => [
+        /=.*link_to\s+(?<title>['"].+?['"]),/,
+        /=.*label(_tag)?[^,]+?(?<label-title>(['"].+?['"]|:[[:alnum:]_]+))[^,]*$/,
+        /=.*label(_tag)?.*?,\s*(?<label-title>(['"].+?['"]|:[[:alnum:]_]+))/,
+        /=.*submit(_tag)?\s+(?<submit-text>(['"].+?['"]|:[[:alnum:]_]+))/,
+        %r{^\s*(?<content>[[:space:][:alnum:]'/(),]+)$},
+        %r{^\s*[[#{HAML_SYMBOLS.join('')}][:alnum:]]+?\{.+?\}\s+(?<content>.+)$},
+        %r{^\s*[[#{HAML_SYMBOLS.join('')}][:alnum:]]+?\(.+?\)\s+(?<content>.+)$},
+        %r{^\s*[[#{(HAML_SYMBOLS - ['{', '}', '(', ')']).join('')}][:alnum:]]+?\s+(?<content>.+)$}
+      ]
+    }
+
+    def initialize(prefix, file_type, options={})
+      @prefix = prefix
+      @file_type = file_type
+      transformer_class = self.class.const_get("#{file_type.to_s.capitalize}Transformer")
+      @transformer = transformer_class.new(options[:add_default])
+    end
+
+    def translation_key(text)
+      #TODO: downcase does not work properly for accented chars, like 'Ú', see function in ActiveSupport that deals with this
+      #TODO: [:punct:] would be nice but it includes _ which we don't want to remove
+      key = text.strip.downcase.gsub(/[\s\/]+/, '_').gsub(/[!?.,:"';()]/, '')
+      "#{@prefix}.#{key}"
+    end
+
+    def run(text)
+      lines = text.split("\n")
+      new_lines = lines.map do |line|
+        new_line = line
+        PATTERNS[@file_type].detect do |pattern|
+          if m = pattern.match(line)
+            m.names.each do |group_name|
+              if /\w/.match(m[group_name])
+                new_line = @transformer.transform(m, m[group_name], line, translation_key(m[group_name]))
+              end
+            end
+          end
+        end
+        if block_given? and line != new_line
+          yield line, new_line
+        end
+        new_line
+      end
+      new_lines.join("\n")
+    end
+
+    class Transformer
+      def initialize(add_default)
+        @add_default = add_default
+      end
+
+      private
+        def i18n_string(key, original)
+          if @add_default
+            if original.to_s[0] == ':'
+              original = original.to_s[1..-1]
+            end
+            unless original[0] == "'" or original[0] == '"'
+              original = %("#{original}")
+            end
+            %(I18n.t("#{key}", :default => #{original}))
+          else
+            %(I18n.t("#{key}"))
+          end
+        end
+    end
+
+    class ErbTransformer < Transformer
+
+      def transform(match_data, match, line, translation_key)
+        return line if line.match /\bt\(/
+        if match_data.to_s.index("<%")
+          line.gsub(match, i18n_string(translation_key, match))
+        else
+          line.gsub(match, "<%= #{i18n_string(translation_key, match)} %>")
+        end
+      end
+
+    end
+
+    class HamlTransformer < Transformer
+
+      def transform(match_data, match, line, translation_key)
+        return line if line.match /\bt\(/
+        leading_whitespace = line[/^(\s+)/, 1]
+        no_leading_whitespace = if leading_whitespace
+          line[leading_whitespace.size..-1]
+        else
+          line
+        end
+        if ['/', '-'].include?(no_leading_whitespace[0])
+          return line
+        end
+
+        # Space can only occur in haml markup in an attribute list
+        # enclosed in { } or ( ). If the first segment has { or (
+        # we are still in the markup and need to go on to find the beginning
+        # of the string to be replaced
+        i = 0
+        haml_segment = true
+        attribute_list_start = nil
+        segments = no_leading_whitespace.split(/\s+/)
+        while haml_segment
+          s = segments[i]
+          if attribute_list_start
+            attribute_list_end = [')', '}'].detect { |sym| s.index(sym) }
+            if attribute_list_end
+              haml_segment = false
+            end
+          else
+            attribute_list_start = ['(', '{'].detect { |sym| s.index(sym) }
+            unless attribute_list_start
+              haml_segment = false
+            end
+          end
+          i += 1
+        end
+
+        until_first_whitespace = segments[0...i].join(' ')
+        if HAML_SYMBOLS.any? { |sym| until_first_whitespace.index(sym) }
+          haml_markup = until_first_whitespace
+          content = segments[i..-1].join(' ')
+          if haml_markup[-1] == '='
+            haml_markup += ' '
+          else
+            haml_markup += '= '
+          end
+        else
+          haml_markup = ''
+          content = no_leading_whitespace
+          content.insert(0, '= ') unless content[0] == '='
+        end
+
+        new_line = (leading_whitespace or '') + haml_markup + content
+        new_line.gsub(match.gsub(/\s+$/, ''), i18n_string(translation_key, match))
+      end
+    end
+
+  end
+end

data/lib/i15r/version.rb

@@ -1,3 +1,3 @@
-module I15R
-  VERSION = "0.4.4"
+class I15R
+  VERSION = "0.5.0"
 end