bisu 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91a21fb208a5322f64116f20e4b82e6108085b8d
-  data.tar.gz: 9a8b0eef2a85596da38cc1e51da31f699d5c6f94
+  metadata.gz: 6986c97d7458f01354dfea511217a6fe565e8623
+  data.tar.gz: 13ef8e986f57451ec5170612794ca098c285f0be
 SHA512:
-  metadata.gz: cc959379b26785e7f50b44461908985ef491eb94d6e765390145ca3416c130305c3ba7877837f9fbafefa9d149bd9816e72bf6d82c92dbc97c0cc9fe5bde58b3
-  data.tar.gz: faa8f17d79bf8579a6a5810e858f19e5adfff2635a213429e641ecbd1f8fe1e8373d27491f10182568b71859abe0349aa3a59c7ddb3c024e264fda38498b409b
+  metadata.gz: 91712afc1636778325e5119513a76173a4a8623fe7ec1b36e06bd97cafc8f180f3a311840e234d33f294c752ee243fe247a7d9ab708c38301607d4f475dd4348
+  data.tar.gz: 500e7bcc77107d003d032c71e53d5a79b6579a52ea3c1a0250e91e71f693edff0e0aecb2c9b8125ed52e5d536032e9e61acaef67122f6e94692bae899405d735

data/Gemfile

@@ -7,3 +7,4 @@ gem 'xml-simple', '~> 1.1'
 
 gem 'webmock',    '~> 1.20'
 gem 'rspec'
+gem 'rspec-its'

data/Gemfile.lock

@@ -16,6 +16,9 @@ GEM
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
@@ -33,6 +36,7 @@ PLATFORMS
 DEPENDENCIES
   colorize (~> 0.7)
   rspec
+  rspec-its
   safe_yaml (~> 1.0)
   webmock (~> 1.20)
   xml-simple (~> 1.1)

data/lib/bisu/config.rb

@@ -1,38 +1,54 @@
-require "yaml"
-
 module Bisu
-  module Config
-    extend self
+  class Config
+    def initialize(hash:)
+      @hash = hash.deep_symbolize
+      @hash.validate_structure!(EXPECTED_HASH)
+    end
 
-    def parse(file_name)
-      unless file_name
-        Logger.error("Config file not provided")
-        return nil
-      end
+    def to_h
+      @hash
+    end
 
-      unless File.exists?(file_name)
-        Logger.error("Could not find config file #{file_name}")
-        return nil
-      end
+    def dictionary
+      @hash[:dictionary]
+    end
+
+    def type
+      @hash[:type]
+    end
 
-      begin
-        deep_sym(YAML::load_file(file_name))
-      rescue Exception => e
-        Logger.error("Could not parse config file #{file_name}: #{e}")
-        return nil
+    def localize_files
+      @hash[:translate].each do |t|
+        @hash[:languages].each do |l|
+          downcase_locale = l[:locale].downcase.gsub("-", "_").gsub(" ", "_")
+          yield(t[:in], (t[:"out_#{downcase_locale}"] || t[:out]) % l, l[:language], l[:locale])
+        end
       end
     end
 
     private
 
-    def deep_sym(obj)
-      if obj.is_a?(Array)
-        obj.map { |v| deep_sym(v) }
-      elsif obj.is_a?(Hash)
-        obj.inject({}) { |memo, (k,v)| memo[k.to_sym] = deep_sym(v); memo }
-      else
-        obj
-      end
-    end
+    EXPECTED_HASH = {
+      type: Hash,
+      elements: {
+        type: { type: String },
+        dictionary: { type: Hash, elements: {
+          sheet_id: { type: String },
+          keys_column: { type: String }
+        } },
+        translate: { type: Array, elements: {
+          type: Hash, elements: {
+            in: { type: String },
+            out: { type: String }
+          }
+        } },
+        languages: { type: Array, elements: {
+          type: Hash, elements: {
+            locale: { type: String },
+            language: { type: String }
+          }
+        } }
+      }
+    }
   end
 end

data/lib/bisu/google_sheet.rb

@@ -8,7 +8,7 @@ module Bisu
       @key_column = keys_column_title
     end
 
-    def to_hash
+    def to_h
       raw = raw_data(@sheet_id)
 
       Logger.info("Parsing Google Sheet...")

data/lib/bisu/localizer.rb

@@ -2,7 +2,7 @@ module Bisu
   class Localizer
     def initialize(dictionary, type)
       @dict = dictionary
-      @type = type.downcase.to_sym
+      @type = type.to_s.downcase.to_sym
 
       unless [:ios, :android, :ror].include?(@type)
         Logger.error("Unknown type #{@type}")

data/lib/bisu/object_extension.rb

@@ -0,0 +1,41 @@
+Object.class_eval do
+  def deep_symbolize
+    case self
+    when Array
+      self.map { |v| v.deep_symbolize }
+    when Hash
+      self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v.deep_symbolize; memo }
+    else
+      self
+    end
+  end
+
+  def validate_structure!(structure, error_prefix=[])
+    return if self == nil && structure[:optional]
+
+    prepend_error = error_prefix.empty? ? "" : (["self"] + error_prefix + [": "]).join
+
+    unless self.is_a? structure[:type]
+      raise ArgumentError.new("#{prepend_error}Expected #{structure[:type]}, got #{self.class}")
+    end
+
+    return unless structure[:elements]
+
+    case self
+    when Array
+      self.each_with_index do |e, i|
+        e.validate_structure!(structure[:elements], error_prefix + ["[#{i}]"])
+      end
+    when Hash
+      mandatory_keys = structure[:elements].map { |k,s| k unless s[:optional] }.compact
+
+      unless (missing = mandatory_keys - self.keys).empty?
+        raise ArgumentError.new("#{prepend_error}Missing keys: #{missing.join(', ')}")
+      end
+
+      structure[:elements].each do |key, structure|
+        self[key].validate_structure!(structure, error_prefix + ["[:#{key}]"])
+      end
+    end
+  end
+end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.2.4'
-  VERSION_UPDATED_AT = '2016-10-23'
+  VERSION = '1.3.0'
+  VERSION_UPDATED_AT = '2016-11-02'
 end

data/lib/bisu.rb

@@ -1,10 +1,13 @@
+require 'optparse'
+require 'yaml'
+
 require 'bisu/logger'
+require 'bisu/object_extension'
 require 'bisu/config'
 require 'bisu/google_sheet'
 require 'bisu/dictionary'
 require 'bisu/localizer'
 require 'bisu/version'
-require 'optparse'
 
 module Bisu
   extend self
@@ -12,20 +15,19 @@ module Bisu
   def run(options)
     options = command_line_options(options)
 
-    if config = Bisu::Config.parse("translatable.yml")
-      google_sheet = Bisu::GoogleSheet.new(config[:sheet_id], config[:keys_column])
-      dictionary   = Bisu::Dictionary.new(google_sheet.to_hash)
-      localizer    = Bisu::Localizer.new(dictionary, config[:type])
+    if config_file = open_file("translatable.yml", "r", true)
+      config       = Bisu::Config.new(hash: YAML::load(config_file))
+      google_sheet = Bisu::GoogleSheet.new(config.dictionary[:sheet_id], config.dictionary[:keys_column])
+      dictionary   = Bisu::Dictionary.new(google_sheet.to_h)
+      localizer    = Bisu::Localizer.new(dictionary, config.type)
 
-      config[:in].each do |in_path|
-        config[:out].each do |out|
-          unless dictionary.has_language?(out[:kb_language])
-            Logger.error("Unknown language #{out[:kb_language]}")
-            return false
-          end
-
-          localize_file(localizer, out[:locale], out[:kb_language], options[:default_language], in_path, out[:path] || config[:out_path])
+      config.localize_files do |in_path, out_path, language, locale|
+        unless dictionary.has_language?(language)
+          Logger.error("Unknown language #{language}")
+          return false
         end
+
+        localize_file(localizer, locale, language, options[:default_language], in_path, out_path)
       end
     end
 
@@ -57,22 +59,25 @@ module Bisu
     opts_hash
   end
 
-  def localize_file(localizer, locale, language, default_language, in_path, out_path)
-    in_name = File.basename(in_path)
-    out_name = in_name.gsub(/\.translatable$/, "")
-
-    unless in_name.match /\.translatable$/
-      Logger.error("Expected .translatable file. Got '#{in_name}'")
-      return false
+  def open_file(file_name, method, should_exist)
+    if !File.file?(File.expand_path(file_name))
+      if should_exist
+        Logger.error("File #{file_name} not found!")
+        return nil
+      else
+        FileUtils.mkdir_p(File.dirname(file_name))
+      end
     end
 
-    out_path = out_path % { locale: locale, android_locale: locale.gsub("-", "-r"), out_name: out_name }
+    File.open(File.expand_path(file_name), method)
+  end
+
+  def localize_file(localizer, locale, language, default_language, in_path, out_path)
+    Logger.info("Translating #{in_path} to #{language} > #{out_path}...")
 
     return false unless in_file  = open_file(in_path,  "r", true)
     return false unless out_file = open_file(out_path, "w", false)
 
-    Logger.info("Translating #{in_path} to #{language} > #{out_path}...")
-
     in_file.each_line do |line|
       out_file.write(localizer.localize(line, language, locale, default_language))
     end
@@ -83,17 +88,4 @@ module Bisu
 
     true
   end
-
-  def open_file(file_name, method, should_exist)
-    if !File.file?(File.expand_path(file_name))
-      if should_exist
-        Logger.error("File #{file_name} not found!")
-        return nil
-      else
-        FileUtils.mkdir_p(File.dirname(file_name))
-      end
-    end
-
-    File.open(File.expand_path(file_name), method)
-  end
 end

data/spec/fixtures/sample.translatable.yml

@@ -0,0 +1,17 @@
+type: iOS
+
+dictionary:
+  sheet_id: sheet-id
+  keys_column: keys-column
+
+translate:
+  - in: hole19/Localizable.strings.translatable
+    out: hole19/%{locale}.lproj/Localizable.strings
+  - in: hole19/Countries.strings.translatable
+    out: hole19/%{locale}.lproj/Countries.strings
+
+languages:
+  - locale: en
+    language: english
+  - locale: en-US
+    language: english

data/spec/lib/bisu/config_spec.rb

@@ -0,0 +1,53 @@
+describe Bisu::Config do
+  subject(:config) { Bisu::Config.new(hash: hash) }
+
+  let(:hash) { {
+    type: "BisuOS",
+    dictionary: {
+      sheet_id:    "abc1234567890",
+      keys_column: "key_name"
+    },
+    translate: [
+      { in:        "path/to/file/to/1.ext.translatable",
+        out:       "path/to/final-%{locale}/1.ext",
+        out_en_us: "path/to/default/1.ext"
+      },
+      { in:        "path/to/file/to/2.ext.translatable",
+        out:       "path/to/final-%{locale}/2.ext",
+        out_en_us: "path/to/default/2.ext"
+      },
+    ],
+    languages: [
+      { locale: "en-US",      language: "english"    },
+      { locale: "pt",         language: "portuguese" },
+      { locale: "pt-PT",      language: "portuguese" },
+      { locale: "pt-Batatas", language: "portuguese" }
+    ]
+  } }
+
+  context "when hash is missing params" do
+    before { hash.delete(:type) }
+    it { expect { config }.to raise_error /missing keys/i }
+  end
+
+  its(:to_h)       { should eq(hash) }
+  its(:type)       { should eq("BisuOS") }
+  its(:dictionary) { should eq({ sheet_id: "abc1234567890", keys_column: "key_name" }) }
+
+  describe "#localize_files" do
+    it "yields 5 times with the expected arguments" do
+      expect { |b|
+        config.localize_files(&b)
+      }.to yield_successive_args(
+        ["path/to/file/to/1.ext.translatable", "path/to/default/1.ext",          "english",    "en-US"     ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt/1.ext",         "portuguese", "pt"        ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-PT/1.ext",      "portuguese", "pt-PT"     ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-Batatas/1.ext", "portuguese", "pt-Batatas"],
+        ["path/to/file/to/2.ext.translatable", "path/to/default/2.ext",          "english",    "en-US"     ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt/2.ext",         "portuguese", "pt"        ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-PT/2.ext",      "portuguese", "pt-PT"     ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-Batatas/2.ext", "portuguese", "pt-Batatas"]
+      )
+    end
+  end
+end

data/spec/{bisu → lib/bisu}/google_sheet_spec.rb

@@ -1,5 +1,5 @@
 describe Bisu::GoogleSheet do
-  subject(:to_hash) { Bisu::GoogleSheet.new(sheet_id, key_column).to_hash }
+  subject(:to_h) { Bisu::GoogleSheet.new(sheet_id, key_column).to_h }
 
   let(:sheet_id) { "abc1234567890" }
   let(:url_info)  { "https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full" }
@@ -17,20 +17,20 @@ describe Bisu::GoogleSheet do
     end
 
     it do
-      expect { to_hash }.not_to raise_error
+      expect { to_h }.not_to raise_error
     end
 
     it "returns an hash" do
-      expect(to_hash).to include("kConnectEmail")
-      expect(to_hash["kConnectEmail"]).to include("korean")
-      expect(to_hash["kConnectEmail"]).to include("spanish" => "Conéctate con Email")
+      expect(to_h).to include("kConnectEmail")
+      expect(to_h["kConnectEmail"]).to include("korean")
+      expect(to_h["kConnectEmail"]).to include("spanish" => "Conéctate con Email")
     end
 
     context "but the key column is not present in the first sheet" do
       let(:key_column) { "expecting_another_key_column" }
 
       it do
-        expect { to_hash }.to raise_error /Cannot find key column/
+        expect { to_h }.to raise_error /Cannot find key column/
       end
     end
   end
@@ -39,7 +39,7 @@ describe Bisu::GoogleSheet do
     before { stub_request(:get, url_info).to_return(:status => 400, :body => "Not Found", :headers => {}) }
 
     it do
-      expect { to_hash }.to raise_error /Cannot access sheet/
+      expect { to_h }.to raise_error /Cannot access sheet/
     end
   end
 
@@ -47,7 +47,7 @@ describe Bisu::GoogleSheet do
     before { stub_request(:get, url_info).to_return(:status => 302, :body => "<HTML></HTML>", :headers => {}) }
 
     it do
-      expect { to_hash }.to raise_error /Cannot access sheet/
+      expect { to_h }.to raise_error /Cannot access sheet/
     end
   end
 
@@ -55,7 +55,7 @@ describe Bisu::GoogleSheet do
     before { stub_request(:get, url_info).to_return(:status => 200, :body => "This is not XML; { this: \"is json\" }", :headers => {}) }
 
     it do
-      expect { to_hash }.to raise_error /Cannot parse. Expected XML/
+      expect { to_h }.to raise_error /Cannot parse. Expected XML/
     end
   end
 end

data/spec/{bisu → lib/bisu}/localizer_spec.rb

@@ -85,8 +85,6 @@ describe Bisu::Localizer do
     end
 
     it "does not throw an error when key parameters where given" do
-      Bisu::Logger.silent_mode = false
-
       expect {
         localizer.localize("$k1ParameterKey{name:%1$s}$", language, locale)
       }.to not_change { Bisu::Logger.summary[:warn] }

data/spec/lib/bisu/object_extension_spec.rb

@@ -0,0 +1,100 @@
+describe Object do
+
+  describe "#deep_symbolize" do
+    subject { obj.deep_symbolize }
+
+    context "when object is an Hash" do
+      let(:obj) { { "key1" => "value1", key2: "value2" } }
+      it { should eq({ key1: "value1", key2: "value2" }) }
+
+      context "with inner Hashes" do
+        before { obj["key2"] = { "key3" => { "key4" => "value4" } } }
+        it { should eq({ key1: "value1", key2: { key3: { key4: "value4" } }}) }
+      end
+    end
+
+    context "when object is an Array" do
+      let(:obj) { ["value1"] }
+      it { should eq obj }
+
+      context "with inner Hashes" do
+        let(:obj) { [{ "key1" => "value1" }, { "key2" => "value2" }] }
+        it { should eq([{ key1: "value1" }, { key2: "value2" }]) }
+      end
+    end
+
+    context "when object is something else" do
+      let(:obj) { "value1" }
+      it { should eq obj }
+    end
+  end
+
+  describe "#validate_structure!" do
+    subject { obj.validate_structure!(structure) }
+
+    context "when object type differs of the structure type" do
+      let(:obj) { "a string" }
+      let(:structure) { { type: Integer } }
+      it { expect { subject }.to raise_error /expected Integer, got String/i }
+    end
+
+    context "when object is a Nil" do
+      let(:obj) { nil }
+      let(:structure) { { type: Integer } }
+      it { expect { subject }.to raise_error /expected Integer, got NilClass/i }
+
+      context "but is also optional" do
+        before { structure[:optional] = true }
+        it { expect { subject }.not_to raise_error }
+      end
+    end
+
+    context "when object is an Array" do
+      let(:obj) { ["elem1", "elem2"] }
+      let(:structure) { { type: Array } }
+      it { expect { subject }.not_to raise_error }
+
+      context "given an element structure" do
+        before { structure[:elements] = { type: String } }
+        it { expect { subject }.not_to raise_error }
+
+        context "which is not respected" do
+          before { structure[:elements] = { type: Integer } }
+          it { expect { subject }.to raise_error /expected Integer, got String/i }
+        end
+      end
+    end
+
+    context "when object is an Hash" do
+      let(:obj) { { key1: "value1", key2: "value2", key3: "value3" } }
+      let(:structure) { { type: Hash } }
+      it { expect { subject }.not_to raise_error }
+
+      context "when given an element structure" do
+        let(:structure) { { type: Hash, elements: { key1: { type: String }, key2: { type: String }, key3: { type: String } } } }
+        it { expect { subject }.not_to raise_error }
+
+        context "which is not respected" do
+          before { obj[:key2] = {} }
+          it { expect { subject }.to raise_error /expected String, got Hash/i }
+        end
+
+        context "when missing keys" do
+          before do
+            obj.delete(:key1)
+            obj.delete(:key3)
+          end
+          it { expect { subject }.to raise_error /missing keys: key1, key3/i }
+
+          context "which are optional" do
+            before do
+              structure[:elements][:key1][:optional] = true
+              structure[:elements][:key3][:optional] = true
+            end
+            it { expect { subject }.not_to raise_error }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/bisu_spec.rb

@@ -0,0 +1,35 @@
+describe Bisu do
+  subject(:run) { Bisu.run([]) }
+
+  context "when there is a translatable.yml" do
+    let(:file) { File.open("spec/fixtures/sample.translatable.yml") }
+
+    before do
+      allow(Bisu).to receive(:open_file).and_return(file)
+      allow_any_instance_of(Bisu::GoogleSheet).to receive(:to_h).and_return({
+        "kKey" => { "english" => "Value" }
+      })
+      allow(Bisu).to receive(:localize_file)
+    end
+
+    it { expect { run }.not_to raise_error }
+
+    it "logs an error" do
+      expect {
+        run
+      }.to not_change { Bisu::Logger.summary[:warn] }
+       .and not_change { Bisu::Logger.summary[:error] }
+    end
+  end
+
+  context "when translatable.yml does not exist locally" do
+    it { expect { run }.not_to raise_error }
+
+    it "logs an error" do
+      expect {
+        run
+      }.to not_change { Bisu::Logger.summary[:warn] }
+       .and change { Bisu::Logger.summary[:error] }.by(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'bisu'
 require 'webmock/rspec'
+require 'rspec/its'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -89,15 +89,18 @@ files:
 - lib/bisu/google_sheet.rb
 - lib/bisu/localizer.rb
 - lib/bisu/logger.rb
+- lib/bisu/object_extension.rb
 - lib/bisu/version.rb
-- spec/bisu/config_spec.rb
-- spec/bisu/dictionary_spec.rb
-- spec/bisu/google_sheet_spec.rb
-- spec/bisu/localizer_spec.rb
-- spec/bisu/logger_spec.rb
+- spec/fixtures/sample.translatable.yml
 - spec/fixtures/sample_kb_public_info.html
 - spec/fixtures/sample_kb_public_sheet.html
-- spec/fixtures/sample_translatable.yml
+- spec/lib/bisu/config_spec.rb
+- spec/lib/bisu/dictionary_spec.rb
+- spec/lib/bisu/google_sheet_spec.rb
+- spec/lib/bisu/localizer_spec.rb
+- spec/lib/bisu/logger_spec.rb
+- spec/lib/bisu/object_extension_spec.rb
+- spec/lib/bisu_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hole19/bisu
 licenses:

data/spec/bisu/config_spec.rb

@@ -1,35 +0,0 @@
-describe Bisu::Config do
-  subject { Bisu::Config.parse(file_path) }
-
-  context "given a yml file" do
-    let(:file_path) { "spec/fixtures/sample_translatable.yml" }
-
-    it "should parse the yml with deep key symbolization" do
-      expect(subject).to eq({
-        type:        "BisuOS",
-        sheet_id:    "abc1234567890",
-        keys_column: "key_name",
-        in:          [
-          "path/to/file/to/1.ext.translatable",
-          "path/to/file/to/2.ext.translatable"
-        ],
-        out_path:    "path/to/final-%{locale}/%{out_name}",
-        out:         [
-          { locale: "en",    kb_language: "english", path: "path/to/default/%{out_name}" },
-          { locale: "pt",    kb_language: "portuguese" },
-          { locale: "pt-PT", kb_language: "portuguese" }
-        ]
-      })
-    end
-  end
-
-  context "given an inexistent file" do
-    let(:file_path) { "does_not_exist" }
-    it { should be nil }
-  end
-
-  context "given no file path" do
-    let(:file_path) { nil }
-    it { should be nil }
-  end
-end

data/spec/fixtures/sample_translatable.yml

@@ -1,18 +0,0 @@
-type: BisuOS
-
-sheet_id: abc1234567890
-keys_column: key_name
-
-in:
-  - path/to/file/to/1.ext.translatable
-  - path/to/file/to/2.ext.translatable
-
-out_path: path/to/final-%{locale}/%{out_name}
-out:
-  - locale: en
-    kb_language: english
-    path: path/to/default/%{out_name}
-  - locale: pt
-    kb_language: portuguese
-  - locale: pt-PT
-    kb_language: portuguese