skala 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cd834fb20b0e4148938d42dd92abecb54e49b8f
-  data.tar.gz: d9c1fc1820efddffa3777811aa8eeffc6034ae5d
+  metadata.gz: aae9b8b40ca397d60ff19d4b4e18388bff0c0394
+  data.tar.gz: b560ab30285fab610ba6b04de36c21f94070983f
 SHA512:
-  metadata.gz: 56346c0e4261433885405a632b7efc29b2561a6ac58ee7eb7e8cacc1118f62b9142217465696ccae3f36e7922776a98a219d1591df2dd2691691544940c61710
-  data.tar.gz: bef839d6c64e4a345705109535e9cad8ff74e416871366837b0d5135ad6d2c467661ebc87a7c4ba83c2452d790789592da456490fa2afc3a371309a6cd7aa35c
+  metadata.gz: 66c797c3536ab3e72c8be2c57d2eb59585df9757387663c0d48a454f770297d111a8a440728fb2d7f625eb14666899713f52b1740bfeae8e55cbae433854fc99
+  data.tar.gz: 5fe5fd9cfdea4785ed5b1ef1866a7813dbeb80385eab89bec1ecd82734f3370e6a17e3d8c876a70b23d94f8eeecae1b672a4f7eeba31f6df4a301fa7cb18e978

data/lib/skala/adapter.rb

@@ -5,8 +5,4 @@ class Skala::Adapter
   require_relative "./adapter/operation"
 
   include Skala::I18n
-
-  def initialize(*args)
-    self.class.load_locales_from_directory("#{File.dirname(__FILE__)}/locales")
-  end
 end

data/lib/skala/i18n.rb

@@ -1,42 +1,46 @@
+require "active_support"
+require "active_support/core_ext"
+require "mighty_tap"
 require "yaml"
 require_relative "../skala"
 
 module Skala::I18n
-  require_relative "./i18n/deep_merger"
-
   def self.included(klass)
-    unless klass.class_variable_defined?(:@@locales)
-      klass.class_variable_set(:@@locales, {})
-    end
-
     klass.extend(ClassMethods)
   end
 
   module ClassMethods
     def load_locales_from_directory(path)
-      # class_variable_get is needed to avoid implicite referencing the module instead of the including class
-      Dir.glob("#{File.expand_path(path)}/*.yml").inject(self.class_variable_get(:@@locales)) do |locales, filename|
-        DeepMerger.deep_merge!(locales, YAML.load_file(filename))
+      Dir.glob("#{File.expand_path(path)}/*.yml").inject({}) do |_locales, _filename|
+        _locales.mtap(:deep_merge!, YAML.load_file(_filename))
       end
     end
-  end
 
-  def translate(key, options = {})
-    raise "Destination locale missing!" if options[:locale].nil?
-   
-    fully_qualified_key = "#{options[:locale]}.#{key}"
-    keys_path = fully_qualified_key.split(".")
-    locales = self.class.class_variable_get(:@@locales)
-    
-    translated_key = keys_path.inject(locales) do |hash, hash_key|
-      unless hash.nil?
-        hash[hash_key.to_s] || hash[hash_key.to_sym]
-      end
-    end || keys_path.last
+    # override this to provide locales
+    def locales
+      {}
+    end
+
+    def translate(key, options = {})
+      raise "Destination locale missing!" if options[:locale].nil?
+     
+      fully_qualified_key = "#{options[:locale]}.#{key}"
+      keys_path = fully_qualified_key.split(".")
+      
+      translated_key = keys_path.inject(locales) do |hash, hash_key|
+        unless hash.nil?
+          hash[hash_key.to_s] || hash[hash_key.to_sym]
+        end
+      end || keys_path.last
 
-    translated_key.gsub(/%{[^}]+}+/) do |match|
-      interpolation_key = match.gsub(/(\A%{)|(}\Z)/, "")
-      options[interpolation_key.to_s] || options[interpolation_key.to_sym] || match
+      translated_key.gsub(/%{[^}]+}+/) do |match|
+        interpolation_key = match.gsub(/(\A%{)|(}\Z)/, "")
+        options[interpolation_key.to_s] || options[interpolation_key.to_sym] || match
+      end
     end
   end
+
+  def translate(*args)
+    self.class.translate(*args)
+  end
 end

data/lib/skala/version.rb

@@ -1,3 +1,3 @@
 module Skala
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/skala.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
+  spec.add_dependency "mighty_tap"
 
   spec.add_development_dependency "bundler",   "~> 1.7"
   spec.add_development_dependency "ox",        ">= 2.1.0"

data/spec/skala/adapter_spec.rb

@@ -1,30 +1,2 @@
 describe Skala::Adapter do
-  let(:adapter) { described_class.new() }
-
-  context "when a class is derived from #{described_class}" do
-    context "when the derived class overwrites .initialize" do
-      context "when the derived class calls super inside the overwritten .initalize" do
-        let(:derived_class) do
-          Class.new(described_class) do
-            def initialize
-              super
-
-              self.class.load_locales_from_directory(File.expand_path("#{File.dirname(__FILE__)}/../assets/locales"))
-            end
-          end
-        end
-
-        let(:derived_class_instance) do
-          derived_class.new
-        end
-
-        it "has access to the superclass locales" do
-          translation_key_known_by_superclass = "field_names.creator"
-          translation = derived_class_instance.translate(translation_key_known_by_superclass, locale: :de)
-          expected_translation = derived_class_instance.class.class_variable_get(:@@locales)["de"]["field_names"]["creator"]
-          expect(translation).to eq(expected_translation)
-        end
-      end
-    end
-  end
 end

data/spec/skala/i18n_spec.rb

@@ -6,86 +6,89 @@ describe Skala::I18n do
   end
 
   context "when included into a class" do
-    context "when the including class has a class variable named @@locales" do
-      let(:value_of_locales) do
-        { foo: "bar" }
-      end
-
-      let(:klass) do
-        Class.new.tap do |_klass|
-          _klass.class_variable_set(:@@locales, value_of_locales)
-          _klass.send(:include, described_class)
-        end
-      end
-
-      it "does not alter the existing class variable" do
-        expect(klass.class_variable_get(:@@locales)).to eq(value_of_locales)
-      end
+    it "defines a class method #load_locales_from_directory" do
+      expect(class_with_i18n_included).to respond_to(:load_locales_from_directory)
     end
 
-    context "when the including class has no class variable named @@locales" do
-      let(:klass) do
-        Class.new.tap do |_klass|
-          _klass.send(:include, described_class)
-        end
-      end
-
-      it "defines a class variable named @@locales as an empty hash" do
-        expect(klass.class_variable_get(:@@locales)).to eq({})
-      end
+    it "defines a class method #locales" do
+      expect(class_with_i18n_included).to respond_to(:locales)
     end
 
-    it "defines a class method #load_locales_from_directory" do
-      expect(class_with_i18n_included).to respond_to(:load_locales_from_directory)
+    it "defines a class method #translate" do
+      expect(class_with_i18n_included).to respond_to(:translate)
     end
-    
+
     it "defines an instance method .translate" do
       expect(class_with_i18n_included.new).to respond_to(:translate)
     end
   end
  
   describe "#load_locales_from_directory" do
-    it "loads all yaml encoded locales from a directory and adds them to @@locales" do
-      class_with_i18n_included.load_locales_from_directory(File.expand_path("#{File.dirname(__FILE__)}/../assets/locales"))
-      expect(class_with_i18n_included.class_variable_get(:@@locales)).not_to be_empty
+    it "loads all yaml encoded locales from a directory" do
+      loaded_locales =
+      class_with_i18n_included.load_locales_from_directory(
+        File.expand_path("#{File.dirname(__FILE__)}/../assets/locales")
+      )
+
+      expect(loaded_locales).not_to be_empty
     end
   end
-
+  
   describe "#translate" do
-    let(:object) do
-      class_with_i18n_included.new.tap do |_object|
-        _object.class.load_locales_from_directory(File.expand_path("#{File.dirname(__FILE__)}/../assets/locales"))
+    context "if the class defines .locales" do
+      let(:class_with_i18n_included_and_locales) do
+        Class.new(class_with_i18n_included).tap do |_klass|
+          def _klass.locales
+            load_locales_from_directory(
+              File.expand_path("#{File.dirname(__FILE__)}/../assets/locales")
+            )
+          end
+        end
       end
-    end
 
-    it "translates the given key into the language specified by the locale option" do
-      translated_key_de = object.translate("field_names.creator", locale: :de)
-      translated_key_en = object.translate("field_names.creator", locale: :en)
-      
-      expected_translation_de = object.class.class_variable_get(:@@locales)["de"]["field_names"]["creator"]
-      expected_translation_en = object.class.class_variable_get(:@@locales)["en"]["field_names"]["creator"]
+      let(:object) do
+        class_with_i18n_included_and_locales.new
+      end
 
-      expect(translated_key_de).to eq(expected_translation_de)
-      expect(translated_key_en).to eq(expected_translation_en)
-    end
+      it "translates the given key into the language specified by the locale option" do
+        translated_key_de = object.translate("field_names.creator", locale: :de)
+        translated_key_en = object.translate("field_names.creator", locale: :en)
+        
+        expected_translation_de = object.class.locales["de"]["field_names"]["creator"]
+        expected_translation_en = object.class.locales["en"]["field_names"]["creator"]
 
-    it "supports rails style interpolation" do
-      expected_date = "1. Januar 2015"
-      translated_key = object.translate("records.items.loan_status.expected", locale: :de, expected_date: expected_date)
-      expected_translation = object.class.class_variable_get(:@@locales)["de"]["records"]["items"]["loan_status"]["expected"].gsub("%{expected_date}", expected_date)
+        expect(translated_key_de).to eq(expected_translation_de)
+        expect(translated_key_en).to eq(expected_translation_en)
+      end
+      
+      it "supports rails style interpolation" do
+        expected_date = "1. Januar 2015"
+        translated_key = object.translate("records.items.loan_status.expected", locale: :de, expected_date: expected_date)
+        expected_translation = object.class.locales["de"]["records"]["items"]["loan_status"]["expected"].gsub("%{expected_date}", expected_date)
 
-      expect(translated_key).to eq(expected_translation)
-    end
+        expect(translated_key).to eq(expected_translation)
+      end
+      
+      context "when there is no translation" do
+        it "returns the last key path" do
+          expect(object.translate("foo.bar.muff", locale: :en)).to eq("muff")
+        end
+      end
 
-    context "when there is no translation" do
-      it "returns to last key path" do
-        expect(object.translate("foo.bar.muff", locale: :en)).to eq("muff")
+      context "when no locale option is given" do
+        it "raises an exception" do
+          expect { object.translate("field_names.creator") }.to raise_error
+        end
       end
     end
 
-    context "when no locale option is given" do
-      it "raises an exception" do
-        expect { object.translate("field_names.creator") }.to raise_error
+    context "if the class does not define .locales" do
+      let(:object) do
+        class_with_i18n_included.new
+      end      
+
+      it "returns the last key path" do
+        expect(object.translate("foo.bar.muff", locale: :en)).to eq("muff")
       end
     end
   end

data/spec/skala/transformation_spec.rb

@@ -27,20 +27,29 @@ describe Skala::Transformation do
   describe "#abort!" do
     let(:transformation) do
       Class.new(described_class) do
+        def abort_execution?
+          !!@abort_execution
+        end
+
+        def initialize(abort_execution = true)
+          @abort_execution = abort_execution
+        end
+
         sequence [
           -> (transformation) do
             transformation.target = "first_steps_output"
-            transformation.abort!
+            transformation.abort! if transformation.abort_execution?
           end,
           -> (transformation) do
             transformation.target = "second_steps_output"
           end
         ]
-      end.new
+      end
     end
 
     it "aborts the execution of the steps sequence" do
-      expect(transformation.apply to: {}).to eq("first_steps_output") 
+      expect(transformation.new.apply to: {}).to eq("first_steps_output")
+      expect(transformation.new(false).apply to: {}).to eq("second_steps_output")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skala
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mighty_tap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +171,6 @@ files:
 - lib/skala/adapter.rb
 - lib/skala/adapter/operation.rb
 - lib/skala/i18n.rb
-- lib/skala/i18n/deep_merger.rb
 - lib/skala/transformation.rb
 - lib/skala/transformation/step.rb
 - lib/skala/version.rb
@@ -167,7 +180,6 @@ files:
 - spec/assets/transformation/some_class.rb
 - spec/skala/adapter/operation_spec.rb
 - spec/skala/adapter_spec.rb
-- spec/skala/i18n/deep_merger_spec.rb
 - spec/skala/i18n_spec.rb
 - spec/skala/transformation/step_spec.rb
 - spec/skala/transformation_spec.rb
@@ -203,7 +215,6 @@ test_files:
 - spec/assets/transformation/some_class.rb
 - spec/skala/adapter/operation_spec.rb
 - spec/skala/adapter_spec.rb
-- spec/skala/i18n/deep_merger_spec.rb
 - spec/skala/i18n_spec.rb
 - spec/skala/transformation/step_spec.rb
 - spec/skala/transformation_spec.rb

data/lib/skala/i18n/deep_merger.rb

@@ -1,45 +0,0 @@
-require_relative "../i18n"
-
-module Skala::I18n::DeepMerger
-  def self.deep_merge!(destination, source, options = {})
-    if destination.kind_of?(Array)
-      if source.kind_of?(Array)
-        # array into array
-        source.each do |element|
-          self.deep_merge!(destination, element, options)
-        end
-      elsif source.kind_of?(Hash)
-        # hash into array
-        destination.push(source)
-      else
-        # literal into array
-        destination.push(source)
-      end
-    elsif destination.kind_of?(Hash)
-      if source.kind_of?(Array)
-        # array into hash
-        raise ArgumentError, "Cannot merge array into hash!"
-      elsif source.kind_of?(Hash)
-        # hash into hash
-        destination.merge!(source) do |key, destination_value, source_value|
-          self.deep_merge!(destination_value, source_value, options)
-          destination_value
-        end
-      else
-        # literal into hash
-        raise ArgumentError, "Cannot merge literal into hash!"
-      end
-    else
-      if source.kind_of?(Array)
-        # array into literal
-        raise ArgumentError, "Cannot merge array into literal!"
-      elsif source.kind_of?(Hash)
-        # hash into literal
-        raise ArgumentError, "Cannot merge hash into literal!"
-      else
-        # literal into literal
-        destination = source # in fact a useless assignment to fit into the overall semantic
-      end
-    end
-  end
-end

data/spec/skala/i18n/deep_merger_spec.rb

@@ -1,35 +0,0 @@
-describe Skala::I18n::DeepMerger do
-  describe ".deep_merge!" do
-    describe "merges arrays into arrays" do
-      it "merges two arrays of literals" do
-        source = [1,"2",:f]
-        destination = [:"3", 5, "foo"]
-        described_class.deep_merge!(destination, source)
-        expect(destination).to eq([:"3", 5, "foo", 1, "2", :f])
-      end
-
-      it "merges two arrays of hashes" do
-        source = [{c:3}]
-        destination = [{a: 1}, {b:2}]
-        described_class.deep_merge!(destination, source)
-        expect(destination).to eq([{:a=>1}, {:b=>2}, {:c=>3}])
-      end
-    end
-
-    describe "merges hashes into hashes" do
-      it "merges two simple hashes" do
-        source = { c: 3 }
-        destination = { a: 1, b: 2 }
-        described_class.deep_merge!(destination, source)
-        expect(destination).to eq({:a=>1, :b=>2, :c=>3})
-      end
-
-      it "merges two nested hashes" do
-        source = { a: { type: "multi_value", values: [2,3] }, b: { value: "123" } }
-        destination = { a: { values: [1]}, b: { type: "id" } }
-        described_class.deep_merge!(destination, source)
-        expect(destination).to eq({:a=>{:values=>[1, 2, 3], :type=>"multi_value"}, :b=>{:type=>"id", :value=>"123"}})
-      end
-    end
-  end
-end