slimkeyfy 0.0.1

data/lib/slimkeyfy/slimutils/hash_merging.rb

@@ -0,0 +1,84 @@
+class SlimKeyfy::Slimutils::Merger
+  def self.merge_hashes(old_translations={}, new_translations={})
+    key = new_translations.keys.first
+    new_translations[key].keys.each do |top_key|
+      new_translations[key][top_key]
+    end
+    old_translations.merge(new_translations["translation_key"])
+  end
+
+  def self.merge_single_translation(translations, translation_key, translation)
+    k = translation_key
+    name = k.split(".").last
+    value = extract_value(k, translations)
+    if value != nil and value != translation then
+      name = enhance_key_on_collision(translations, name)
+      k = generate_dotted_key(k, name)
+    end
+    h = key_to_hash(k, translation)
+    translations = translations.deep_merge(h)
+    [translations, k, translation]
+  end
+
+  def self.enhance_key_on_collision(translations, translation_key_name)
+    num = 1
+    k = "#{translation_key_name}_#{num}"
+    while extract_value(k, translations) != nil do
+      k = "#{translation_key_name}_#{num}"
+      num += 1
+    end
+    k
+  end
+
+  def self.generate_dotted_key(old_dotted_key, new_name)
+    "#{old_dotted_key.split(".")[0..-2].join(".")}.#{new_name}"
+  end
+
+  def self.key_to_hash(dotted_key, translation)
+    {dotted_key => translation}.explode
+  end
+
+  def self.extract_value(dotted_key, translations, default=nil)
+    key, value = dotted_key.split(".", 2)
+    if key != nil and translations.has_key?(key) then
+      if value != nil then
+        extract_value(value, translations[key])
+      else
+        translations[key]
+      end
+    else
+      default
+    end
+  end
+end
+
+class Object
+  def recursive_send(*args)
+    args.inject(self) { |obj, m| obj.send(m.shift, *m) }
+  end
+end
+
+class Hash
+  def deep_merge(second)
+    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    self.merge(second, &merger)
+  end
+  
+  # https://gist.github.com/potatosalad/760726
+  # auto creates children
+  # from: http://rubyworks.github.com/facets/doc/api/core/Hash.html
+  def self.autonew(*args)
+    leet = lambda { |hsh, key| hsh[key] = new( &leet ) }
+    new(*args,&leet)
+  end
+ 
+  def explode(divider = '.')
+    h = Hash.autonew
+    for k,v in self.dup
+      tree = k.split(divider).map { |x| [ :[], x ] }
+      tree.push([ :[]=, tree.pop[1], v ])
+      h.recursive_send(*tree)
+    end
+    h
+  end
+end

data/lib/slimkeyfy/slimutils/key_generator.rb

@@ -0,0 +1,70 @@
+class SlimKeyfy::Slimutils::BaseKeyGenerator
+  def self.generate_key_base_from_path(file_path, file_extension)
+    key_name = case file_extension
+      when "slim" then 
+        [subdir_name(file_path), filename(file_path)].join(".") 
+      when "rb" then 
+        sub = subdir_name(file_path, "controllers")
+        fname = filename(file_path)
+        if sub != nil and !sub.strip.empty? then
+          "#{sub}.#{fname}"
+        else
+          fname
+        end
+      else nil end
+    key_name
+  end
+  def self.filename(file_path)
+    return "" if file_path.nil?
+    if file_path.end_with?(".html.slim") then
+      fname = File.basename(file_path, ".html.slim")
+    elsif file_path.end_with?(".slim") then
+      fname = File.basename(file_path, ".slim")
+    elsif file_path.end_with?(".rb") then
+      fname = File.basename(file_path, ".rb")
+    else return "" end
+    fname = fname[1..-1] if fname.start_with?("_")
+    fname
+  end
+  def self.subdir_name(file_path, delim="views")
+    return "" if file_path.nil?
+    dirs = file_path.split("/").drop_while{|e| e != delim }
+    return "" if dirs.empty?
+    strip_dirs_and_file = dirs.pop(dirs.size-1)
+    strip_dirs_and_file[0..-2].join(".")
+  end
+end
+
+class SlimKeyfy::Slimutils::TranslationKeyGenerator
+  VALID = /[^0-9a-z]/i
+  DEFAULT_KEY_NAME = "default_key"
+
+  def initialize(translation)
+    @translation = translation
+  end
+
+  def generate_key_name
+    normalized_translation = ""
+    if not (@translation.nil? or @translation.empty?) then
+      normalized_translation = @translation.gsub(VALID, "_").gsub(/[_]+/, "_").downcase
+      normalized_translation = normalized_translation.split("_")[0..3].join("_")
+    end
+    return DEFAULT_KEY_NAME if is_not_valid?(normalized_translation.strip)
+    strip_underscores(normalized_translation)
+  end
+
+  def is_not_valid?(normalized_translation)
+    (normalized_translation.strip == "_" or normalized_translation.empty?)
+  end
+
+  def strip_underscores(s)
+    if s.start_with?("_") then
+      s = s[1..-1]
+    end
+    if s.end_with?("_") then
+      s = s[0..-2]
+    end
+    s
+  end
+end
+

data/lib/slimkeyfy/slimutils/yaml_processor.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+
+class SlimKeyfy::Slimutils::YamlProcessor
+
+  attr_reader :locale, :yaml_output, :yaml_hash
+
+  def initialize(locale, key_base, yaml_output=nil)
+    @locale = locale
+    @key_base = key_base
+    @yaml_output = process_output_file(yaml_output)
+    @yaml_hash = load_hash
+  end
+
+  def process_output_file(yaml_output)
+    if yaml_output.nil? then
+      dir_of_key = @key_base.split(".").first
+      yaml_output = default_yaml(dir_of_key, @locale)
+    end
+    path = File.expand_path(yaml_output.to_s)
+    if File.exist?(path) then 
+      path
+    else
+      SlimKeyfy::Slimutils::FileWriter.write(path, "---")
+      path
+    end
+  end
+
+  def store!
+    merged = {@locale => @yaml_hash}
+    SlimKeyfy::Slimutils::FileWriter.write(@yaml_output, merged.to_yaml)
+  end
+
+  def load_hash
+    h = YAML::load_file(@yaml_output)
+    if h then h[@locale]
+    else {} end
+  end
+
+  def default_yaml(key, locale)
+    File.expand_path("./config/locales/#{key}.#{locale}.yml")
+  end
+
+  def merge!(translation_key, translation)
+    @yaml_hash, translation_key, translation = SlimKeyfy::Slimutils::Merger.merge_single_translation(@yaml_hash, translation_key, translation)
+    [translation_key, translation]
+  end
+
+  def delete_translations(translations)
+    return if translations.nil? or translations.empty? or @yaml_hash.empty?
+    translations.each do |k, v|
+      path = k.split('.')
+      leaf = path.pop
+      path.inject(@yaml_hash){|h, el| h[el]}.delete(leaf)
+    end
+  end
+end

data/lib/slimkeyfy/slimutils.rb

@@ -0,0 +1,8 @@
+module SlimKeyfy::Slimutils
+
+end
+
+require 'slimkeyfy/slimutils/file_utils'
+require 'slimkeyfy/slimutils/hash_merging'
+require 'slimkeyfy/slimutils/key_generator'
+require 'slimkeyfy/slimutils/yaml_processor'

data/lib/slimkeyfy/transformer/base_transformer.rb

@@ -0,0 +1,42 @@
+class SlimKeyfy::Transformer::BaseTransformer
+  TRANSLATED = /t\s*\(?\s*(".*?"|'.*?')\s*\)?/
+  STRING = /(\".*\"|\'.*\')/
+  STRING_WITHOUT_QUOTES = /("(?<double_quot>.*)"|'(?<single_quot>.*)')/
+
+  def initialize(word, yaml_processor=nil)
+    @word = word
+    @yaml_processor = yaml_processor
+  end
+
+  def nil_elem
+    [nil, nil]
+  end
+
+  def should_not_be_processed?(tokens)
+    (tokens.nil? or tokens.size < 2)
+  end
+
+  def matches_string?(translation)
+    m = translation.match(STRING_WITHOUT_QUOTES)
+    return false if m.nil?
+    (m[:double_quot] != nil or m[:single_quot] != nil)
+  end
+
+  def match_string(translation)
+    m = translation.match(STRING_WITHOUT_QUOTES)
+    return translation if m.nil?
+    (m[:double_quot] != nil) ? m[:double_quot] : ((m[:single_quot] != nil) ? m[:single_quot] : translation)
+  end
+
+  def update_hashes(translation)
+    @word.update_translation_key_hash(@yaml_processor, translation)
+  end
+
+  def controller?
+    false
+  end
+
+  def slim?
+    false
+  end
+end

data/lib/slimkeyfy/transformer/controller_transformer.rb

@@ -0,0 +1,20 @@
+class SlimKeyfy::Transformer::ControllerTransformer < SlimKeyfy::Transformer::BaseTransformer
+  TAGS = /(text|notice|message|alert|raise|subject|flash\[:[a-z]+\])/
+  CONNECTING_SYMBOLS = /\s*(:|=>?)?\s*/
+  REGEX = /(?<tag>#{TAGS}#{CONNECTING_SYMBOLS})(?<translation>#{STRING})/
+
+  def transform
+    m = @word.line.match(REGEX)
+    if m != nil then
+      translation = match_string(m[:translation])
+      translation_key = update_hashes(translation)
+      localized = @word.line.gsub(m[:translation], translation_key)
+      return [localized, @word.translations]
+    end
+    nil_elem
+  end
+
+  def controller?
+    true
+  end
+end

data/lib/slimkeyfy/transformer/slim_transformer.rb

@@ -0,0 +1,92 @@
+class SlimKeyfy::Transformer::SlimTransformer < SlimKeyfy::Transformer::BaseTransformer
+
+  HTML_TAGS = /^(?<html_tag>'|\||([a-z\.]+[0-9\-]*)+)/
+  EQUALS = /(([a-z\.]+[0-9\-]*)*=.*)/
+
+  BEFORE =        /(?<before>.*)/
+  TRANSLATION =   /(?<translation>(".*?"|'.*?'))/
+  AFTER =         /(?<after>,?.*)?/
+
+  HTML_ARGUMENTS = {
+    hint:               /(?<html_tag>hint:\s*)/,
+    link_to:            /(?<html_tag>link_to\s*\(?)/,
+    inconified:         /(?<html_tag>(iconified\s*\(?))/,
+    placeholder:        /(?<html_tag>placeholder:\s*)/,
+    title:              /(?<html_tag>title:\s*)/,
+    label:              /(?<html_tag>[a-z]*_?label:\s*)/,
+    optionals:          /(?<html_tag>(default|include_blank|alt):\s*)/,
+    input:              /(?<html_tag>[a-z]*\.?input:?\s*)/,
+    button:             /(?<html_tag>[a-z]*\.?button:?\s*(\:[a-z]+\s*,\s*)?)/,
+    tag:                /(?<html_tag>(submit|content)_tag[\:\(]?\s*)/,
+    data_naive:         /(?<html_tag>data:\s*\{\s*(confirm|content):\s*)/
+  }
+
+  LINK_TO = /#{HTML_ARGUMENTS[:link_to]}#{TRANSLATION}/
+
+  def regex_list
+    HTML_ARGUMENTS.map{|_, regex| /#{BEFORE}#{regex}#{TRANSLATION}#{AFTER}/ }
+  end
+
+  def transform
+    return nil_elem if should_not_be_processed?(@word.as_list)
+    unindented_line = @word.unindented_line
+
+    result = 
+    if unindented_line.match(EQUALS) then
+      parse_html_arguments(unindented_line)
+    elsif @word.head.match(HTML_TAGS) then
+      parse_html
+    else nil_elem end
+
+    return nil_elem if (result.last.nil? or result.last.empty?)
+
+    result
+  end
+
+  def parse_html
+    return nil_elem if @word.line.match(TRANSLATED)
+
+    tagged_with_equals = SlimKeyfy::Transformer::Whitespacer.convert_slim(@word.head)
+    body = @word.tail.join(" ")
+    body, tagged_with_equals = SlimKeyfy::Transformer::Whitespacer.convert_nbsp(body, tagged_with_equals)
+
+    if body.match(LINK_TO) != nil then
+      body = link_tos(body)
+    end
+    
+    translation_key = update_hashes(body)
+    normalize_translation("#{tagged_with_equals} #{translation_key}")
+  end
+
+  def parse_html_arguments(line)
+    regex_list.each do |regex|
+      line.scan(regex) do |m_data|
+        before, html_tag = m_data[0], m_data[1]
+        translation, after = match_string(m_data[2]), m_data[3]
+        translation_key = update_hashes(translation)
+        line = "#{before}#{html_tag}#{translation_key}#{after}"
+      end
+    end
+    normalize_translation(line)
+  end
+
+  def link_tos(line)
+    m = line.match(LINK_TO)
+    if m != nil then
+      _, translation = m[:html_tag], match_string(m[:translation])
+      translation_key = update_hashes(translation)
+      line = line.gsub(m[:translation], translation_key)
+      link_tos(line)
+    else
+      line
+    end
+  end
+
+  def normalize_translation(translation)
+    ["#{@word.indentation}#{translation}", @word.translations]
+  end
+
+  def slim?
+    true
+  end
+end

data/lib/slimkeyfy/transformer/whitespacer.rb

@@ -0,0 +1,48 @@
+class SlimKeyfy::Transformer::Whitespacer
+
+  HTML = /([a-z\.]+[0-9\-]*)+/
+  HTML_TAGS = /^(?<html_tag>'|\||#{HTML})/
+
+  def self.convert_slim(s)
+    m = s.match(HTML_TAGS)
+
+    return s if m.nil? or m[:html_tag].nil?
+    return s if has_equals_tag?(s, m[:html_tag])
+    tag = m[:html_tag]
+
+    case tag
+    when /\|/ then
+      s.gsub("|", "=")
+    when /\'/ then
+      s.gsub("'", "=>")
+    when HTML then
+      s.gsub(s, "#{s}=")
+      else s end
+  end
+
+  def self.convert_nbsp(body, tag)
+    lead = leading_nbsp(body)
+    trail = trailing_nsbp(body, tag)
+
+    body = lead ? body.sub("&nbsp;", "") : body
+    body = trail ? body.reverse.sub(";psbn&", "").reverse : body
+
+    tag = tag.gsub(tag, "#{tag}#{lead}#{trail}")
+    [body.gsub("&nbsp;", " "), tag.gsub("=><", "=<>")]
+  end
+
+  def self.leading_nbsp(body)
+    return "<"  if body.start_with?("&nbsp;")
+    ""
+  end
+
+  def self.trailing_nsbp(body, tag)
+    return "" if tag.start_with?("=>")
+    return ">"  if body.end_with?("&nbsp;")
+    ""
+  end
+
+  def self.has_equals_tag?(s, html_tag)
+    s.gsub(html_tag, "").strip.start_with?("=")
+  end
+end

data/lib/slimkeyfy/transformer/word.rb

@@ -0,0 +1,49 @@
+class SlimKeyfy::Transformer::Word
+  attr_reader :line, :tokens, :indentation
+  attr_accessor :translations
+
+  def initialize(line, key_base, extension)
+    @line = line
+    @key_base = key_base
+    @extension = extension
+    @indentation = " " * (@line.size - unindented_line.size)
+    @translations = {}
+  end
+
+  def as_list(delim=" ")
+    @line.split(delim)
+  end
+
+  def unindented_line
+    @line.sub(/^\s*/, "")
+  end
+
+  def head
+    as_list.first
+  end
+
+  def tail
+    as_list.drop(1)
+  end
+
+  def i18nString(translation_key)
+    if @extension == "rb" then
+      "t('#{@key_base}.#{translation_key}')"
+    else
+      "t('.#{translation_key}')"
+    end
+  end
+
+  def update_translation_key_hash(yaml_processor, translation)
+    translation_key = SlimKeyfy::Slimutils::TranslationKeyGenerator.new(translation).generate_key_name
+    translation_key_with_base = "#{@key_base}.#{translation_key}"
+    translation_key_with_base, translation = yaml_processor.merge!(translation_key_with_base, translation) unless yaml_processor.nil?
+    @translations.merge!({translation_key_with_base => translation})
+    i18nString(extract_updated_key(translation_key_with_base))
+  end
+
+  def extract_updated_key(translation_key_with_base)
+    return "" if (translation_key_with_base.nil? or translation_key_with_base.empty?)
+    translation_key_with_base.split(".").last
+  end
+end

data/lib/slimkeyfy/transformer.rb

@@ -0,0 +1,9 @@
+module SlimKeyfy::Transformer
+
+end
+
+require 'slimkeyfy/transformer/word'
+require 'slimkeyfy/transformer/whitespacer'
+require 'slimkeyfy/transformer/base_transformer'
+require 'slimkeyfy/transformer/slim_transformer'
+require 'slimkeyfy/transformer/controller_transformer'

data/lib/slimkeyfy/version.rb

@@ -0,0 +1,3 @@
+module SlimKeyfy
+  VERSION = "0.0.1"
+end

data/lib/slimkeyfy.rb

@@ -0,0 +1,12 @@
+
+module SlimKeyfy
+  
+  def self.translate(args)
+    SlimKeyfy::Console::Commandline.new(args).run
+  end
+  
+end
+
+require 'slimkeyfy/slimutils'
+require 'slimkeyfy/console'
+require 'slimkeyfy/transformer'

data/slimkeyfy.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'slimkeyfy/version'
+
+Gem::Specification.new do |s|
+  s.name               = "slimkeyfy"
+  s.version            = SlimKeyfy::VERSION
+  s.platform           = Gem::Platform::RUBY
+  s.homepage    = %q{https://phraseapp.com/}
+  s.authors     = ["Dynport GmbH"]
+  s.summary     = %q{Extract plain strings from slim templates to replace them with calls to I18n's t() method.}
+  s.description = %q{Replace plain text strings in your slim templates and Rails controllers with calls to I18n t() method. Keys and YAML output files will be automatically generated and filled in.}
+  s.email       = ["info@phraseapp.com"]
+  git_files     = `git ls-files | grep -v spec/`.split("\n") rescue ''
+  s.files       = git_files
+  s.test_files  = s.files.grep(%r{^(spec)/})
+  s.executables = ["slimkeyfy"]
+  s.require_paths = ["lib"]
+  s.add_development_dependency('rspec')
+end

data/vendor/bundle/bin/htmldiff

@@ -0,0 +1,25 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/matthias/.rvm/rubies/ruby-2.1.1/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'htmldiff', version)

data/vendor/bundle/bin/ldiff

@@ -0,0 +1,25 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/matthias/.rvm/rubies/ruby-2.1.1/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'ldiff', version)

data/vendor/bundle/bin/rspec

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rspec-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'rspec-core', version
+load Gem.bin_path('rspec-core', 'rspec', version)

data/vendor/bundle/build_info/diff-lcs-1.2.5.info

@@ -0,0 +1 @@
+

data/vendor/bundle/build_info/rspec-3.0.0.info

@@ -0,0 +1 @@
+

data/vendor/bundle/build_info/rspec-core-3.0.2.info

@@ -0,0 +1 @@
+

data/vendor/bundle/build_info/rspec-expectations-3.0.2.info

@@ -0,0 +1 @@
+

data/vendor/bundle/build_info/rspec-mocks-3.0.2.info

@@ -0,0 +1 @@
+

data/vendor/bundle/build_info/rspec-support-3.0.2.info

@@ -0,0 +1 @@
+

data/vendor/bundle/gems/diff-lcs-1.2.5/.autotest

@@ -0,0 +1,3 @@
+require 'rubygems'
+
+# vim: syntax=ruby

data/vendor/bundle/gems/diff-lcs-1.2.5/.hoerc

@@ -0,0 +1,2 @@
+---
+exclude: !ruby/regexp /(tmp|swp)$|CVS|TAGS|\.(svn|git|hg|DS_Store|idea)|Gemfile\.lock|research\/|\.gemspec$/

data/vendor/bundle/gems/diff-lcs-1.2.5/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/vendor/bundle/gems/diff-lcs-1.2.5/.travis.yml

@@ -0,0 +1,22 @@
+---
+after_script:
+- rake travis:after -t
+before_script:
+- gem install hoe-travis --no-rdoc --no-ri
+- rake travis:before -t
+language: ruby
+notifications:
+  email: true
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - 1.8.7
+  - jruby-19mode
+  - jruby-head
+  - jruby-18mode
+  - rbx-19mode
+  - rbx-18mode
+  - ree
+script: rake travis