celsius 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a521e978a4541083a2873c57a94f08ea02c1e79
-  data.tar.gz: 22df803f547fc9accbca5da2d7ca60ddcafb8759
+  metadata.gz: 347a4f4d7898e806d74c07e71f0c0f303ac52d5f
+  data.tar.gz: 0757d90d257529ef4005b5edea762707e5b09d1c
 SHA512:
-  metadata.gz: 9f1c01cbd35521cfc11aaf768179b57f0429890f7c9d544a4fdfcb062c4550a5b8adff30e61dd398e535e71628dc78116536f8c0cfc9596bef34d22e28350484
-  data.tar.gz: d5c9392cbf1e18db04749e762454f37408c07bf88fb7ba40edea704245f035af28490d8adf1702401bbdbcd59d809a5d460a6fad445ddd1dadf240724082b3d5
+  metadata.gz: 6d119c40a39c4cd69bf00e8bb286580e623adf72fd40185612282d00fd1d9f7aad1335bd11a3ea1a4d77a199627625b2df072c252fd47a99bdfe6c253a2e79f7
+  data.tar.gz: 15dd8d70fdf9bfb6c2953a373ad6c5908426ae520135a66821c4c2f4496ec023156102e59c8e459f665144d587805af000dbba5c4973825194ca04cfa4281fc7

data/Gemfile

@@ -7,3 +7,5 @@ gem "pry",                "~> 0.9.12.6"
 gem "pry-nav",            "~> 0.2.3"
 gem "pry-stack_explorer", "~> 0.4.9.1"
 gem "pry-syntax-hacks",   "~> 0.0.6"
+
+gem "deep_merger", path: "~/github/ubpb/deep_merger"

data/README.md

@@ -1,4 +1,4 @@
-# Celsius
+# Celsius [![Code Climate](https://codeclimate.com/github/ubpb/celsius/badges/gpa.svg)](https://codeclimate.com/github/ubpb/celsius)
 
 TODO: Write a gem description
 

data/celsius.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "deep_merger", ">= 0.0.2"
+  spec.add_dependency "deep_merger", ">= 0.1.0"
 
   spec.add_development_dependency "bundler",   ">= 1.5"
   spec.add_development_dependency "rspec",     ">= 3.0.0", "< 4.0.0"

data/lib/celsius/adapter.rb

@@ -1,2 +1,10 @@
+require "celsius"
+require "celsius/i18n"
+
 class Celsius::Adapter
+  include Celsius::I18n
+
+  def initialize(*args)
+    self.class.load_locales_from_directory("#{File.dirname(__FILE__)}/locales")
+  end
 end

data/lib/celsius/hash.rb

@@ -0,0 +1,34 @@
+require "celsius"
+
+module Celsius::Hash
+  #
+  # This module provides some helper functions for dealing with hashes
+  #
+  def self.deep_find_key(object, key)
+    results = []
+
+    if key.is_a?(Array)
+      key.inject(object) do |memo, key_element|
+        deep_find_key(memo, key_element)
+      end
+    else
+      if object.is_a?(Array)
+        # flatten(1) prevents unintend array nesting due to recursion
+        results.concat object.map { |value| deep_find_key(value, key) }.flatten(1)
+      elsif object.is_a?(Hash)
+        if object.has_key?(key.to_s) || object.has_key?(key.to_sym)
+          results << (object[key.to_s] || object[key.to_sym])
+        else
+          # its easier to concat an empty array than checking for nil
+          results.concat deep_find_key(object.values, key) || []
+        end
+      end
+
+      # remove nils
+      results.compact!
+
+      # in case nothing was found, return nil to ease detecting this case
+      results.empty? ? nil : results
+    end
+  end
+end

data/lib/celsius/i18n.rb

@@ -0,0 +1,35 @@
+require "deep_merger"
+require "yaml"
+
+module Celsius::I18n
+  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))
+      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)
+    
+    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
+  end
+end

data/lib/celsius/locales/de.yml

@@ -0,0 +1,9 @@
+de:
+  field_names:
+    _all: Alle Felder
+    _score: Relevanz
+    created: Erscheinungsjahr
+    creator: Autor/Herausgeber
+    identifier: Identifikator
+    subject: Schlagwort
+    title: Titel

data/lib/celsius/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  field_names:
+    _all: All fields
+    _score: Score
+    created: Created
+    creator: Creator
+    identifier: Identifier
+    subject: Subject
+    title: Title

data/lib/celsius/transformation/step.rb

@@ -0,0 +1,22 @@
+class Celsius::Transformation::Step
+  attr_accessor :transformation
+
+  def initialize(transformation)
+    @transformation = transformation
+  end
+
+  #
+  # Each step has transparent access to all methods of it's transformation
+  #
+  def method_missing(method_name, *args, &block)
+    if @transformation.respond_to?(method_name)
+      @transformation.send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    @transformation.respond_to?(method_name) || super
+  end
+end

data/lib/celsius/transformation.rb

@@ -0,0 +1,46 @@
+require "celsius"
+
+class Celsius::Transformation
+  #
+  # class methods
+  #
+  class << self
+    attr_accessor :steps
+  end
+
+  # since a transformation can have many steps, writing a "require" for each is tedious
+  def self.require_directory(directory)
+    Dir.glob("#{File.expand_path(directory)}/*.rb").each do |filename|
+      require filename
+    end
+  end
+
+  # convenience wrapper for @steps setter to enhance readability
+  def self.sequence(value)
+    self.steps = value
+  end
+
+  #
+  # instance methods
+  #
+  attr_accessor :source
+  attr_accessor :target
+
+  def apply(options = {})
+    if (@source = options[:source] ||= options[:to]).nil?
+      raise ArgumentError, "No source given to apply transformation to!"
+    end
+
+    @target = options[:target]
+
+    self.class.steps.flatten.each do |step|
+      if step.is_a?(Class)
+        step.new(self).call
+      else
+        step.call(self)
+      end
+    end
+
+    return @target
+  end
+end

data/lib/celsius/version.rb

@@ -1,3 +1,3 @@
 module Celsius
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/celsius.rb

@@ -1,38 +1,9 @@
 require "celsius/version"
-require "deep_merger"
 
 module Celsius
   require "celsius/adapter"
-
-  def self.deep_clone(object)
-    Marshal.load(Marshal.dump(object))
-  end
-
-  def self.deep_merge!(destination, source, options = {})
-    DeepMerger.deep_merge!(source, destination, options)
-  end
-
-  def self.deep_stringify_keys(hash)
-    Celsius.deep_stringify_keys!(Celsius.deep_clone(hash))
-  end
-
-  #
-  private
-  #
-
-  # http://stackoverflow.com/questions/8379596/how-do-i-convert-a-ruby-hash-so-that-all-of-its-keys-are-symbols
-  def self.deep_stringify_keys!(hash_or_element)
-    case hash_or_element
-    when Hash
-      Hash[
-        hash_or_element.map do |key, value|
-          [ key.respond_to?(:to_s) ? key.to_s : key, deep_stringify_keys(value) ]
-        end
-      ]
-    when Enumerable
-      hash_or_element.map { |value| deep_stringify_keys(value) }
-    else
-      hash_or_element
-    end
-  end
+  require "celsius/hash"
+  require "celsius/i18n"
+  require "celsius/transformation"
+  require "celsius/transformation/step"
 end

data/spec/assets/locales/de.yml

@@ -0,0 +1,9 @@
+de:
+  field_names:
+    _all: Alle Felder
+    _score: Relevanz
+    created: Erscheinungsjahr
+    creator: Autor/Herausgeber
+    identifier: Identifikator
+    subject: Schlagwort
+    title: Titel

data/spec/assets/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  field_names:
+    _all: All fields
+    _score: Score
+    created: Created
+    creator: Creator
+    identifier: Identifier
+    subject: Subject
+    title: Title

data/spec/assets/transformation/some_class.rb

@@ -0,0 +1,2 @@
+class SomeClass
+end

data/spec/celsius/adapter_spec.rb

@@ -0,0 +1,28 @@
+describe Celsius::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
+            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/celsius/hash_spec.rb

@@ -0,0 +1,60 @@
+require "celsius/hash"
+
+describe Celsius::Hash do
+  describe ".deep_find_key" do
+    let(:hash) do
+      {
+        query: {
+          bool: [
+            {
+              query_string: {
+                query: "a"
+              }
+            },
+            {
+              query_string: {
+                query: "b"
+              }
+            },
+            {
+              match: {
+                some_field: "some_value"
+              }
+            }
+          ]
+        },
+        facets: {
+          creator: {
+            terms: {
+              field: "facet_creator"
+            }
+          },
+          lang: {
+            terms: {
+              field: "facet_lang",
+            }
+          }
+        }
+      }
+    end
+
+    it "returns values matching the given key" do
+      expected_result = [
+        hash[:query][:bool][0][:query_string],
+        hash[:query][:bool][1][:query_string],
+      ]
+
+      expect(described_class.deep_find_key(hash, :query_string)).to eq(expected_result)
+    end
+
+    context "if given an array of keys" do
+      it "tries to find each element based on the former elements result" do
+        expected_result = [
+          hash[:facets][:creator]
+        ]
+
+        expect(described_class.deep_find_key(hash, [:facets, :creator])).to eq(expected_result)
+      end
+    end
+  end
+end

data/spec/celsius/i18n_spec.rb

@@ -0,0 +1,86 @@
+require "celsius/i18n"
+
+describe Celsius::I18n do
+  let(:class_with_i18n_included) do
+    Class.new.tap do |klass|
+      klass.include(Celsius::I18n)
+    end
+  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.include(Celsius::I18n)
+        end
+      end
+
+      it "does not alter the existing class variable" do
+        expect(klass.class_variable_get(:@@locales)).to eq(value_of_locales)
+      end
+    end
+
+    context "when the including class has no class variable named @@locales" do
+      let(:klass) do
+        Class.new.tap do |_klass|
+          _klass.include(Celsius::I18n)
+        end
+      end
+
+      it "defines a class variable named @@locales as an empty hash" do
+        expect(klass.class_variable_get(:@@locales)).to eq({})
+      end
+    end
+
+    it "defines a class method #load_locales_from_directory" do
+      expect(class_with_i18n_included).to respond_to(:load_locales_from_directory)
+    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
+    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"))
+      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"]
+
+      expect(translated_key_de).to eq(expected_translation_de)
+      expect(translated_key_en).to eq(expected_translation_en)
+    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")
+      end
+    end
+
+    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
+end

data/spec/celsius/transformation/step_spec.rb

@@ -0,0 +1,36 @@
+describe Celsius::Transformation::Step do
+  context "when initialized with a transformation" do
+    let(:transformation) do
+      Class.new(Celsius::Transformation) do
+        def some_transformation_method
+          true
+        end
+      end.new
+    end
+
+    let(:step) do
+      described_class.new(transformation)
+    end
+
+    describe "#transformation" do
+      it "allows access to the transformation" do
+        expect(step.transformation).to be(transformation)
+      end
+    end
+
+    context "if a unknown method is called" do
+      context "if the transformation has a matching method" do
+        it "calls the method on the transformation" do
+          expect(step).to respond_to(:some_transformation_method)
+          expect(step.some_transformation_method).to eq(transformation.some_transformation_method)
+        end
+      end
+
+      context "if the transformation has no matching method" do
+        it "raises an error" do
+          expect { step.some_unknown_method }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/celsius/transformation_spec.rb

@@ -0,0 +1,60 @@
+describe Celsius::Transformation do
+  describe ".require_directory" do
+    it "requires all *.rb files in the given directory" do
+      described_class.require_directory "#{File.dirname(__FILE__)}/../assets/transformation"
+      expect(defined?(SomeClass)).to eq("constant")
+    end
+  end
+
+  describe "#sequence" do
+    let(:steps_array) do
+      [ -> { } ]
+    end
+
+    let(:transformation) do
+      steps = steps_array
+
+      Class.new(described_class) do
+        sequence steps
+      end
+    end
+
+    it "is a wrapper for the steps setter" do
+      expect(transformation.steps).to be(steps_array)
+    end
+  end
+
+  describe "#apply" do
+    let(:transformation) do
+      step_class = Class.new(described_class::Step) do
+        def call
+          transformation.target = source.dup
+        end
+      end
+
+      step_lambda = -> (transformation) do
+        transformation.target.upcase!
+      end
+
+      Class.new(described_class) do
+        sequence [
+          step_class,
+          step_lambda
+        ]
+      end.new
+    end
+
+    context "if no :source or :to option is given" do
+      it "raises an error" do
+        expect { transformation.apply }.to raise_error(ArgumentError)
+      end
+    end
+
+    it "applies the transformation" do
+      some_string = "foo"
+
+      expect(transformation.apply(to: some_string)).to eq(some_string.upcase)
+      expect(some_string).to eq("foo")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celsius
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,21 @@ files:
 - celsius.gemspec
 - lib/celsius.rb
 - lib/celsius/adapter.rb
+- lib/celsius/hash.rb
+- lib/celsius/i18n.rb
+- lib/celsius/locales/de.yml
+- lib/celsius/locales/en.yml
+- lib/celsius/transformation.rb
+- lib/celsius/transformation/step.rb
 - lib/celsius/version.rb
+- spec/assets/locales/de.yml
+- spec/assets/locales/en.yml
+- spec/assets/transformation/some_class.rb
+- spec/celsius/adapter_spec.rb
+- spec/celsius/hash_spec.rb
+- spec/celsius/i18n_spec.rb
+- spec/celsius/transformation/step_spec.rb
+- spec/celsius/transformation_spec.rb
 - spec/celsius_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ubpb/celsius
@@ -124,10 +138,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: celsius-0.2.0
+summary: celsius-0.4.0
 test_files:
+- spec/assets/locales/de.yml
+- spec/assets/locales/en.yml
+- spec/assets/transformation/some_class.rb
+- spec/celsius/adapter_spec.rb
+- spec/celsius/hash_spec.rb
+- spec/celsius/i18n_spec.rb
+- spec/celsius/transformation/step_spec.rb
+- spec/celsius/transformation_spec.rb
 - spec/celsius_spec.rb
 - spec/spec_helper.rb