i18n_tyml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47e8bbaaab4574efa9947e3b2754cb592fc5cee4
+  data.tar.gz: 0cf63c876e223019c086a34b9d1f151f17c2cc5c
+SHA512:
+  metadata.gz: 7fb4aa855ff70b47831d3969688fdb487b1260b519e8d586df58d10cd017af41c98b89da39974e2c46cf0adb35a68319f1f0d1a10433cf75e55acaa0aea8f818
+  data.tar.gz: 83048ec30caa158a77e1808cf98d10d58e9a3646d388cbd543b981638f34fa0cd00c4f79acbb11d169f79e64a6c42e494ac38b64f6eb6fb2e23efb97b7088a8d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n_tyml.gemspec
+gemspec
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 William
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# I18nTyml
+
+Use this gem to find the missing translation by parsing I18n.t, and write missing values to yml file.
+
+It should be used with [i15r](https://github.com/balinterdi/i15r)
+
+The idea and part code is borrowed from (http://willbradley.name/2013/03/21/rails_localization_i18n_tools/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_tyml', :github => 'wingice/i18n_tyml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_tyml
+ 
+
+
+## Usage
+
+cd your project home
+
+```
+1. i15r app/views/xxxx/xxx.html.erb
+2. i18n_tyml app/views/xxxx/xxx.html.erb
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/wingice/i18n_tyml/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/i18n_tyml

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+# USAGE: 
+#  Run and redirect output to a file for best results.
+#   example: ruby pull-defaults.rb > my-results.yml
+#  For now, you'll have to add the root en: element and increase
+#   the indent level for it to be a valid locale YML.
+#  Uncomment lines 160 and 161 (the ones that call 
+#   replace_content_of_file_with_i18n_queries) to have this
+#   script remove :default strings from i18n tags it finds.
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+
+require "yaml"
+require "optparse"
+require "forwardable"
+require 'active_support/all'
+require 'nokogiri'
+require 'i18n_tyml'
+
+def parse_options(args)
+  args << "--help"  if args.empty?
+  options = {}
+  options[:path] = args[-1]
+  
+  opts = OptionParser.new do |ops|
+    ops.banner = "Usage: i18n_tyml [options] <path_or_file>, run in project home directory."
+    ops.on("-u", "--update", "Update the view files, remove the defaults part") do
+      options[:remove_default] = true
+    end
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts I18nTyml::VERSION
+    exit
+  end
+  
+  opts.parse!(args)
+  options
+end
+
+translation_mgr = I18nTyml::TranslationManager.new(parse_options(ARGV))
+missing_values = translation_mgr.search_missing().values
+
+missing_message_strings = missing_values.map { |ms| 
+  ms.map { |mv|
+    #puts "STRINGS: "+mv.first.inspect+" - "+mv[1]
+    mr = mv.first.gsub(/\./, '^')
+    #mr.gsub(/./, '^')
+    unless(mv[1].nil?)
+      mr += "^"+mv[1]
+    end
+    mr = mr.split('^').reverse.inject {|a, n| {n => a}}
+    #mr = hashify([mv.first],mv[1]) 
+    #puts "STRINGShash: "+mr.inspect
+    mr
+  }
+}
+
+missing = missing_message_strings.each_with_object({}) do |h, all_message_strings|
+  #puts "HHH: "+h.inspect
+  h.each do |r|
+    all_message_strings.deep_safe_merge!(r)
+  end
+end
+
+puts missing.to_yaml

data/i18n_tyml.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_tyml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_tyml"
+  spec.version       = I18nTyml::VERSION
+  spec.authors       = ["William"]
+  spec.email         = ["wingicelee@hotmail.com"]
+  spec.summary       = %q{Parse I18n.t function call from view files, and output with yaml format.}
+  spec.description   = %q{Parse I18n.t function call from view files, and output with yaml format..}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) } 
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/i18n_tyml/color_output.rb

@@ -0,0 +1,14 @@
+module ColorOutput
+  # snatched from rspec source
+  def colour(text, colour_code)
+    "#{colour_code}#{text}\e[0m"
+  end
+
+  def green(text); colour(text, "\e[32m"); end
+  def red(text); colour(text, "\e[31m"); end
+  def magenta(text); colour(text, "\e[35m"); end
+  def yellow(text); colour(text, "\e[33m"); end
+  def blue(text); colour(text, "\e[34m"); end
+
+end
+

data/lib/i18n_tyml/hash_deep_merge.rb

@@ -0,0 +1,31 @@
+class Hash
+  def has_nested_key?(key)
+    h = self
+    key.to_s.split('.').each do |segment|
+      return false unless h.respond_to?(:key?) && h.key?(segment)
+      h = h[segment]
+    end
+    true
+  end
+
+  # idea snatched from deep_merge in Rails source code
+  def deep_safe_merge(other_hash)
+    self.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      if oldval.class.to_s == 'Hash'
+        if newval.class.to_s == 'Hash'
+          oldval.deep_safe_merge(newval)
+        else
+          oldval
+        end
+      else
+        newval
+      end
+    end
+  end
+
+  def deep_safe_merge!(other_hash)
+    replace(deep_safe_merge(other_hash))
+  end
+end

data/lib/i18n_tyml/ruby_i18n_parser.rb

@@ -0,0 +1,15 @@
+module I18nTyml
+  class RubyI18nParser
+
+    I18N_DEFAULT_PATTERN =     /I18n\.t\(["']([\w\.]*?)["'][^"']*default[^"']*?["']([^"']*?)["']/
+
+    def self.get_locale_ref_array(file_content)
+      file_content.scan(I18N_DEFAULT_PATTERN)
+    end
+
+    def self.remove_default(file_content)
+      file_content.gsub(I18N_DEFAULT_PATTERN, 'I18n.t("\1"')
+    end
+  end
+end
+

data/lib/i18n_tyml/version.rb

@@ -0,0 +1,3 @@
+module I18nTyml
+  VERSION = "0.1.0"
+end

data/lib/i18n_tyml.rb

@@ -0,0 +1,111 @@
+require "i18n_tyml/version"
+require "i18n_tyml/hash_deep_merge"
+require "i18n_tyml/ruby_i18n_parser"
+
+module I18nTyml
+  class TranslationManager
+
+    def initialize(options)
+      @dest_path = options[:path]
+      @remove_default = options[:remove_default]
+      @existed_translations = Hash.new
+    end
+
+    def search_missing(lang=nil)
+      collect_translations
+
+      languages = lang ? [lang] : existed_trans.keys
+      get_missing(collect_trans_in_erb(), languages )
+    end
+
+    private
+    
+    def existed_trans
+      @existed_translations
+    end
+
+    def add_translations(trs)
+      existed_trans.deep_safe_merge!(trs)
+    end
+
+
+    def collect_translations
+      locales_pathes = ["config/locales/**/*.yml",
+                        "vendor/plugins/**/config/locales/**/*yml",
+                        "vendor/plugins/**/locale/**/*yml"]
+      locales_pathes.each do |path|
+        Dir.glob(path) do |file|
+          file_content = translations_in_file(file)
+          add_translations(file_content) if file_content
+        end
+      end
+    end
+
+    def collect_trans_in_erb
+      target_files().each_with_object({}) do |file, trans|
+        trs_in_file = translation_refs_in(file)
+        if trs_in_file.any?
+          trans[file] = trs_in_file
+        end
+      end
+    end
+
+    def target_files
+      path = @dest_path
+      path = path[0...-1] if path[-1..-1] == '/'
+      [path, Dir.glob("#{path}/**/*.erb"), Dir.glob("#{path}/**/*.rb") ].flatten
+    end
+
+
+    def read_content_of_file(file)
+      File.read(File.expand_path(file))
+    end
+
+    def write_content_to_file(file, output)
+      File.open(file, "w") { |f| f.puts output  }
+    end
+
+    
+    def translation_refs_in(file)
+      file_content = read_content_of_file(file)
+      results = I18nTyml::RubyI18nParser.get_locale_ref_array(file_content)
+      write_content_to_file(file, I18nTyml::RubyI18nParser.remove_default(file_content)) if @remove_default
+      results
+    end
+
+    def add_translations(trs)
+      existed_trans.deep_safe_merge!(trs)
+    end
+
+    def translations_in_file(yaml_file)
+      open(yaml_file) { |f| YAML.load(f.read) }
+    end
+
+
+    def get_missing(trans_in_code, languages)
+      languages.each_with_object({}) do |lang, missing|
+        get_missing_for_lang(trans_in_code, lang).each do |file, translation_refs|
+          missing[file] ||= []
+          missing[file].concat(translation_refs).uniq!
+        end
+      end
+    end
+
+    def get_missing_for_lang(trans_in_code, lang)
+      trans_in_code.map do |file, trans_with_defaults|
+        unmatched = trans_with_defaults.select {|q| has_trans?(lang, q[0]) == false  }
+        [file, unmatched.map { |q| [i18n_label(lang, q[0]), q[1]] }] if unmatched.size > 0
+      end.compact
+    end
+
+
+    def has_trans?(lang, i18n_key)
+      existed_trans[lang].has_nested_key?(i18n_key)
+    end
+
+    def i18n_label(lang, query)
+      "#{lang}.#{query}"
+    end
+  end
+end
+

data/spec/ruby_i18n_parser_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'i18n_tyml/ruby_i18n_parser'
+
+describe I18nTyml::RubyI18nParser do
+  let(:erb_1) { <<-END
+    <% provide(:title, "Edit") %>
+    <h1><%= I18n.t("companies.edit.edit", :default => "Edit") %></h1>
+    
+    <div class="row">
+        <div class="col-md-8 col-md-offset-2 well">
+    	<%= simple_form_for @company do |f| %>
+    	    <%= render 'shared/error_messages',:object =>@company %>
+    	    <%= f.input :name %> 
+    	    <%= f.input :description, :as => :text , input_html: { :rows => 6} %> 
+    	    <div>
+    		<%= f.submit I18n.t("companies.edit.update_company", :default => 'Update Company'), :class =>'btn btn-primary' %> 
+    		<%= link_to I18n.t("common.back", :default => 'Back'), :back, class:'btn btn-default' %>
+    	    </div>
+    	<% end %>
+        </div>
+    </div>
+
+  END
+  }
+
+  describe "Extract the I18n.t call" do
+    it {
+      expect(I18nTyml::RubyI18nParser.get_locale_ref_array(erb_1)).to eq [["companies.edit.edit", "Edit"],
+                                                                    ["companies.edit.update_company", "Update Company"],
+                                                                    ["common.back", "Back"]]
+    }
+  end
+  describe "remove_default" do
+    it "should remove default part from I18n.t funcation call" do
+      result_str =  <<-END
+    <% provide(:title, "Edit") %>
+    <h1><%= I18n.t("companies.edit.edit") %></h1>
+    
+    <div class="row">
+        <div class="col-md-8 col-md-offset-2 well">
+    	<%= simple_form_for @company do |f| %>
+    	    <%= render 'shared/error_messages',:object =>@company %>
+    	    <%= f.input :name %> 
+    	    <%= f.input :description, :as => :text , input_html: { :rows => 6} %> 
+    	    <div>
+    		<%= f.submit I18n.t("companies.edit.update_company"), :class =>'btn btn-primary' %> 
+    		<%= link_to I18n.t("common.back"), :back, class:'btn btn-default' %>
+    	    </div>
+    	<% end %>
+        </div>
+    </div>
+
+  END
+      expect(I18nTyml::RubyI18nParser.remove_default(erb_1)).to eq result_str
+    end 
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+current_dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(current_dir, "..", "lib")
+
+
+Dir["#{current_dir}/support/**/*.rb"].each do |file|
+  require file
+end
+
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: i18n_tyml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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 I18n.t function call from view files, and output with yaml format..
+email:
+- wingicelee@hotmail.com
+executables:
+- i18n_tyml
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/i18n_tyml
+- i18n_tyml.gemspec
+- lib/i18n_tyml.rb
+- lib/i18n_tyml/color_output.rb
+- lib/i18n_tyml/hash_deep_merge.rb
+- lib/i18n_tyml/ruby_i18n_parser.rb
+- lib/i18n_tyml/version.rb
+- spec/ruby_i18n_parser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Parse I18n.t function call from view files, and output with yaml format.
+test_files:
+- spec/ruby_i18n_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: