yaml-translator 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffe3f59c087dcef0b5973e28a73c828e4974229d
-  data.tar.gz: f0ee54165cc8c72e25d514582df7fc9277e22f9f
+  metadata.gz: a0efca74a8185ea52ad088ae15d9b4842683f05f
+  data.tar.gz: 86e359f68864bc843576574ee02fac478182cfe8
 SHA512:
-  metadata.gz: 60de15923463ac663d6c0ff759b08833c73d1dae9463f3ac2705e99347ac4cc3cfbd51420feafc87457aee728e0d4b893bca21910b6a25da3ae3772b42661719
-  data.tar.gz: 603a03aae6f2b64d28e51d554bb755cf719dc220967bef487457925d503b5625adba5179a8cba1610c1cfa61661a64671579677909f009f0cf87cb2563189832
+  metadata.gz: 35c49f3c52a43d8bc96edb7903e829c94e699f9457d8ad633a9befd7516989d9cb7ab08a2f5a5509743c7d2372b9f323501ba0cbe7c117452c807089e227be33
+  data.tar.gz: adf189f897ff70ba6ec3ac9210438a0c8b19593a3890122b2cb600d19dac214f5ed1c2a66558d0a90c256e5a52af6d8e7fe98d1f3f6fdd064b13fff6208f9e1e

data/.gitignore

@@ -50,3 +50,4 @@ build-iPhoneSimulator/
 .rvmrc
 
 example/ja.yml
+example/de.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yaml-translator (0.2.1)
+    yaml-translator (0.3.0)
       easy_translate
 
 GEM

data/README.md

@@ -1,5 +1,8 @@
 # yaml-translator
 
+yaml-translator is a gem that translates yaml format translation files into each language.  
+The translation method supports google translate api in built-in.
+
 [![Gem Version](https://badge.fury.io/rb/yaml-translator.svg)](https://badge.fury.io/rb/yaml-translator)
 [![Build Status](https://travis-ci.org/holyshared/yaml-translator.svg?branch=master)](https://travis-ci.org/holyshared/yaml-translator)
 [![Coverage Status](https://coveralls.io/repos/github/holyshared/yaml-translator/badge.svg?branch=master)](https://coveralls.io/github/holyshared/yaml-translator?branch=master)
@@ -10,17 +13,20 @@
 Translate the language file, do as follows.
 
 ```ruby
-require 'yaml'
-require 'yaml-translator'
-
+dir = File.dirname(__FILE__)
 adapter = ::YamlTranslator::Adapters::GoogleTranslateAdapter.new(ENV['GOOGLE_TRANSLATE_API_KEY'])
-
-yaml = "#{dir}/en.yml"
 translator = ::YamlTranslator::Translator.new(adapter)
 
-result = translator.translate_file(yaml, to: :ja)
-result.save_to('/path/to/directory') # Write a ja.yml
-result.save # Write a ja.yml (current directory)
+english_locale = ::YamlTranslator::Locale.load_file("#{dir}/en.yml")
+japanese_locale = english_locale.translate(translator, to: :ja)
+
+p japanese_locale.to_s # convert to japanese locale yaml format
+p japanese_locale.save_to(dir) # Write a ja.yml
+
+german_locale = english_locale.translate(translator, to: :de)
+
+p german_locale.to_s # convert to german locale yaml format
+p german_locale.save_to(dir) # Write a de.yml
 ```
 
 ## Run the test

data/example/google_translate.rb

@@ -6,7 +6,14 @@ require 'yaml-translator'
 dir = File.dirname(__FILE__)
 adapter = ::YamlTranslator::Adapters::GoogleTranslateAdapter.new(ENV['GOOGLE_TRANSLATE_API_KEY'])
 translator = ::YamlTranslator::Translator.new(adapter)
-result = translator.translate_file("#{dir}/en.yml", to: :ja)
 
-p result.to_s
-p result.save_to(dir)
+english_locale = ::YamlTranslator::Locale.load_file("#{dir}/en.yml")
+japanese_locale = english_locale.translate(translator, to: :ja)
+
+p japanese_locale.to_s
+p japanese_locale.save_to(dir)
+
+german_locale = english_locale.translate(translator, to: :de)
+
+p german_locale.to_s
+p german_locale.save_to(dir)

data/lib/yaml-translator/locale.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+
+module YamlTranslator
+  class Locale
+    attr_reader :lang, :values
+
+    def initialize(values, lang)
+      @lang = lang
+      @values = values
+    end
+
+    def translate(translator, options={})
+      translator.translate(self, options)
+    end
+
+    def save(dir=Dir.pwd)
+      write_file(File.join(dir, "#{lang}.yml"))
+    end
+
+    def save_to(dir)
+      save(dir)
+    end
+
+    def flatten_hash
+      flatten(values)
+    end
+
+    def to_s
+      YAML.dump(values)
+    end
+
+    class << self
+      def load_file(file)
+        lang = File.basename(file).gsub(/.(yml|yaml)/, '')
+        yaml = YAML.load(File.open(file, &:read))
+        self.new(yaml, lang)
+      end
+    end
+
+    private
+
+    # Covert to a flatten hash
+    def flatten(values={}, path=KeyPath.new)
+      result = {}
+      values.each_with_index do |(i, v)|
+        path.move_to(i)
+        if v.is_a?(Hash)
+          result.merge!(flatten(v, path))
+        else
+          result[path.to_s] = v
+        end
+        path.leave
+      end
+      result
+    end
+
+    def write_file(file_path)
+      File.write(file_path, to_s)
+    end
+  end
+end

data/lib/yaml-translator/translator.rb

@@ -3,37 +3,20 @@ require "yaml-translator/adapters"
 module YamlTranslator
   class Translator
     def initialize(adapter = Adapters::NoopAdaptor.new)
-      @path = KeyPath.new
       @adapter = adapter
     end
 
     # Translate target
     #
-    # @param [Hash] values Hash of translate target
-    # @return [TranslatedResult] translated result
-    def translate(values, options={})
-      TranslatedResult.new(rebuild(translate_tree(flatten(values), options)), options[:to])
-    end
-
-    # Translate target file
-    #
-    # @param [Hash] file YAML file of translate target
-    # @return [TranslatedResult] translated result
-    def translate_file(file, options={})
-      yaml = YAML.load(File.open(file, &:read))
-      translate(yaml)
+    # @param [Locale] locale of translate target
+    # @return [Locale] locale
+    def translate(locale, options={})
+      translated = @adapter.translate(locale.flatten_hash, options)
+      Locale.new(rebuild(translated), options[:to])
     end
 
     private
 
-    # Translate target
-    #
-    # @param [Hash] values Hash of translate target
-    # @return [Hash] translated hash
-    def translate_tree(values, options={})
-      @adapter.translate(values, options)
-    end
-
     # Returning the flattened structure to the tree structure
     #
     # @param [Hash] values flatten Hash
@@ -57,22 +40,5 @@ module YamlTranslator
       end
       result
     end
-
-    # Covert to a flat hash
-    # @param [Hash] values flatten target
-    # @return [Hash]
-    def flatten(values)
-      result = {}
-      values.each_with_index do |(i, v)|
-        @path.move_to(i)
-        if v.is_a?(Hash)
-          result.merge!(flatten(v))
-        else
-          result[@path.to_s] = v
-        end
-        @path.leave
-      end
-      result
-    end
   end
 end

data/lib/yaml-translator/version.rb

@@ -1,3 +1,3 @@
 module YamlTranslator
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/yaml-translator.rb

@@ -1,5 +1,5 @@
 require 'yaml-translator/version'
+require 'yaml-translator/locale'
 require 'yaml-translator/key_path'
 require 'yaml-translator/translator'
 require 'yaml-translator/adapters'
-require 'yaml-translator/translated_result'

data/spec/fixtures/en.yml

@@ -0,0 +1,7 @@
+---
+en:
+  bar: bar
+  foo: foo
+  foo1:
+    foo1: foo1-1
+    foo2: foo1-2

data/spec/yaml-translator/locale_spec.rb

@@ -0,0 +1,37 @@
+require 'rspec/temp_dir'
+
+describe YamlTranslator::Locale do
+  include_context 'uses temp dir'
+
+  let(:tmp_dir) { temp_dir }
+  let(:lang_file) { File.join(File.dirname(__FILE__), '/../fixtures/en.yml') }
+  let(:lang_file_content) { File.open(lang_file, &:read) }
+  let(:locale) { YamlTranslator::Locale.load_file(lang_file) }
+  let(:output_file) { File.join(tmp_dir, 'en.yml') }
+  let(:file_exist) { File.exist?(output_file) }
+
+  describe '#flatten_hash' do
+    let(:flatten_hash) do
+      {
+        'en.bar' => 'bar',
+        'en.foo'=> 'foo',
+        'en.foo1.foo1' => 'foo1-1',
+        'en.foo1.foo2' => 'foo1-2'
+      }
+    end
+    it 'should be return flatten hash' do
+      expect(locale.flatten_hash).to eq(flatten_hash)
+    end
+  end
+  describe '#to_s' do
+    it 'should be return yaml formatted string' do
+      expect(locale.to_s).to eq(lang_file_content)
+    end
+  end
+  describe '#save_to' do
+    before { locale.save_to(tmp_dir) }
+    it 'should be write a language file' do
+      expect(file_exist).to be true
+    end
+  end
+end

data/spec/yaml-translator/translator_spec.rb

@@ -3,16 +3,18 @@ describe YamlTranslator::Translator do
     let(:translator) { YamlTranslator::Translator.new }
     context 'when have root' do
       let(:yaml_tree) { load_yaml(:with_root) }
+      let(:locale) { YamlTranslator::Locale.new(yaml_tree, :en) }
       it 'translated tree' do
-        translated_tree = translator.translate(yaml_tree)
-        expect(translated_tree.values).to eq(yaml_tree)
+        translated_locale = translator.translate(locale)
+        expect(translated_locale.values).to eq(locale.values)
       end
     end
     context 'when have root' do
       let(:yaml_tree) { load_yaml(:no_root) }
+      let(:locale) { YamlTranslator::Locale.new(yaml_tree, :en) }
       it 'translated tree' do
-        translated_tree = translator.translate(yaml_tree)
-        expect(translated_tree.values).to eq(yaml_tree)
+        translated_locale = translator.translate(locale)
+        expect(translated_locale.values).to eq(locale.values)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-translator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Noritaka Horio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-04 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_translate
@@ -147,14 +147,15 @@ files:
 - lib/yaml-translator/adapters/google_translate_adapter.rb
 - lib/yaml-translator/adapters/noop_adapter.rb
 - lib/yaml-translator/key_path.rb
-- lib/yaml-translator/translated_result.rb
+- lib/yaml-translator/locale.rb
 - lib/yaml-translator/translator.rb
 - lib/yaml-translator/version.rb
+- spec/fixtures/en.yml
 - spec/fixtures/no_root.yml
 - spec/fixtures/with_root.yml
 - spec/helpers/locale_helper.rb
 - spec/spec_helper.rb
-- spec/yaml-translator/translated_result_spec.rb
+- spec/yaml-translator/locale_spec.rb
 - spec/yaml-translator/translator_spec.rb
 - yaml-translator.gemspec
 homepage: https://github.com/holyshared/yaml-translator
@@ -182,9 +183,10 @@ signing_key:
 specification_version: 4
 summary: Translate for the locales configuration file
 test_files:
+- spec/fixtures/en.yml
 - spec/fixtures/no_root.yml
 - spec/fixtures/with_root.yml
 - spec/helpers/locale_helper.rb
 - spec/spec_helper.rb
-- spec/yaml-translator/translated_result_spec.rb
+- spec/yaml-translator/locale_spec.rb
 - spec/yaml-translator/translator_spec.rb

data/lib/yaml-translator/translated_result.rb

@@ -1,30 +0,0 @@
-require 'yaml'
-
-module YamlTranslator
-  class TranslatedResult
-    attr_reader :lang, :values
-
-    def initialize(values, lang)
-      @lang = lang
-      @values = values
-    end
-
-    def save(dir=Dir.pwd)
-      write_file(File.join(dir, "#{lang}.yml"))
-    end
-
-    def save_to(dir)
-      save(dir)
-    end
-
-    def to_s
-      YAML.dump(@values)
-    end
-
-    private
-
-    def write_file(file_path)
-      File.write(file_path, to_s)
-    end
-  end
-end

data/spec/yaml-translator/translated_result_spec.rb

@@ -1,15 +0,0 @@
-require 'rspec/temp_dir'
-
-describe YamlTranslator::TranslatedResult do
-  let(:result) { YamlTranslator::TranslatedResult.new({ foo: 'bar' }, 'ja') }
-  describe '#save_to' do
-    let(:tmp_dir) { temp_dir }
-    let(:output_file) { File.join(tmp_dir, 'ja.yml') }
-    let(:file_exist) { File.exist?(output_file) }
-    include_context 'uses temp dir'
-    it 'should be write a language file' do
-      result.save_to(tmp_dir)
-      expect(file_exist).to be true
-    end
-  end
-end