yahm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f213aa22618a1d60c870526fc85dc3e9b2a67357
-  data.tar.gz: 26023f9fb09290b29111cdc4e36b2e4d9dc5fd60
+  metadata.gz: 0522d4946a438ae61d4e9fdc77d59b6b249363b8
+  data.tar.gz: 19fc48e5d52f76931497cab5a2e319e20e907039
 SHA512:
-  metadata.gz: 9740821a0ed3d3cdfd3bff113d59ce86b4576b0f6c41e4425b4a296647c6fa300ced3225393ae30481b8a284eb1e7e0497970dbb820487aa0c1dbd2be4d62a87
-  data.tar.gz: 2c5f468c73d829df3173b35a882f425b12b94196d994dc44ab9dd6a2e154e65f88f8128ed07b11aaf2fb8666ae1cbc4b73cb20b6f925cf0f3c7316e7109dc5f8
+  metadata.gz: 085c44754437976e7109044724eb5f71006c130e82d0643296b88446f6377f84ffa248a31a00edf575072c8bbf91b62c72fe98e9f4c9e3a7353f54aad2771b79
+  data.tar.gz: 047fd6fc33b4d5f65258ee0467b52d9696b7de83130072784bcb062ace83611bd9c2401aaf73141373607987be6a7da72d035af7e059b9510b847483ba89d911

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/yahm.rb

@@ -1,5 +1,6 @@
 require "yahm/version"
 
-module Yahm
-  # Your code goes here...
+class Yahm
+  require "yahm/hash_mapper"
+  require "yahm/mapping"
 end

data/lib/yahm/hash_mapper.rb

@@ -0,0 +1,19 @@
+module Yahm::HashMapper
+  def define_mapper(mapper_method_name, options = {}, &block)
+    mapping = Yahm::Mapping.new
+
+    # evaluate the given block in mappings context
+    mapping = mapping.instance_eval(&block) || mapping
+
+    define_method mapper_method_name do |hash|
+      translated_hash = mapping.translate_hash(hash)
+      unless (setter_name = options[:call_setter]).nil?
+        self.send(setter_name, translated_hash)
+      end
+
+      translated_hash
+    end
+
+    self
+  end
+end

data/lib/yahm/mapping.rb

@@ -0,0 +1,54 @@
+class Yahm::Mapping
+  def initialize
+    @rules = []
+    @translated_hash = nil
+  end
+
+  def map(str, options = {})
+    @rules.push [str, options]
+    self
+  end
+
+  def translate_hash(input_hash)
+    @break = true if @rules.length == 5
+    @translated_hash = {}
+
+    @rules.each do |rule|
+      process_rule(input_hash, rule)
+    end
+
+    @translated_hash
+  end
+
+  private
+
+  def process_rule(input_hash, rule)
+    sanitized_source_path = rule.first
+    .sub(/^\//, "")
+    .gsub(/\[(\d+)\]/, "/\\1")
+    .split("/")
+    .map do |element|
+      if element[/\A\d+\Z/]
+        element.to_i
+      else
+        element.to_sym
+      end
+    end
+
+    sanitized_target_path = rule.last[:to].sub(/^\//, "").split("/").map(&:to_sym)
+    target_parent_path = sanitized_target_path.slice(0, sanitized_target_path.length - 1)
+
+    source_value = sanitized_source_path.inject(input_hash) { |hash, key| hash[key] }
+
+    unless (processed_by_method_name = rule.last[:processed_by]).nil?
+      source_value = if source_value.is_a?(Array)
+        source_value.map(&processed_by_method_name)
+      else
+        source_value.send(processed_by_method_name)
+      end
+    end
+
+    target_hash_parent_element = target_parent_path.inject(@translated_hash) { |hash, key| hash[key.to_sym] ||= {} }
+    target_hash_parent_element.merge!({ sanitized_target_path.last => source_value })
+  end
+end

data/lib/yahm/version.rb

@@ -1,3 +1,3 @@
-module Yahm
-  VERSION = "0.0.1"
+class Yahm
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "yahm"
+require "pry"
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/yahm/hash_mapper_spec.rb

@@ -0,0 +1,48 @@
+require_relative "../spec_helper"
+
+describe Yahm::HashMapper do
+  context "when extending a class" do
+    let(:class_extended_with_hash_mapper) do
+      class MyClass
+        extend Yahm::HashMapper
+      end
+    end
+
+    it "adds a class method called #define_mapper" do
+      expect(class_extended_with_hash_mapper.methods).to include(:define_mapper)
+    end
+  end
+
+  describe "#define_mapper" do
+    let(:class_extended_with_hash_mapper) do
+      class ClassExtendedWithHashMapper
+        extend Yahm::HashMapper
+
+        define_mapper :my_mapper do
+        end
+      end
+    end
+
+    it "adds a named mapper method to the instances of the extended class" do
+      expect(class_extended_with_hash_mapper.new).to respond_to(:my_mapper)
+    end
+
+    context "when called with an option called 'call_setter'" do
+      let(:class_extended_with_hash_mapper) do
+        class ClassExtendedWithHashMapper
+          extend Yahm::HashMapper
+
+          attr_accessor :my_result
+
+          define_mapper :my_mapper, call_setter: :my_result= do
+          end
+        end
+      end
+
+      it "calls a method with the given name with the result of the mapping" do
+        (instance = class_extended_with_hash_mapper.new).my_mapper({})
+        expect(instance.my_result).not_to be_nil
+      end
+    end
+  end
+end

data/spec/yahm/mapping_spec.rb

@@ -0,0 +1,52 @@
+require_relative "../spec_helper"
+
+describe Yahm::Mapping do
+  it "is a class used internally by Yahm::HashMapper#define_mapper" do
+  end
+
+  describe ".map" do
+    let(:mapping) { Yahm::Mapping.new }
+
+    it "adds a mapping rule to a mapping" do
+      mapping.map("/foo", to: "bar")
+      expect(mapping.instance_variable_get :@rules).not_to be_nil
+    end
+  end
+  
+  describe ".translate_hash" do
+    let(:mapping) do
+      _mapping = Yahm::Mapping.new
+      _mapping.map "/record_id",       to: "/id"
+      _mapping.map "/record/title",    to: "/tile"
+      _mapping.map "/record/isbns",    to: "/my_data/isbns"
+      _mapping.map "/record/isbns[1]", to: "/main_isbn"                     # when an array, one can specifiy which element to choose
+      _mapping.map "/record/count",    to: "/count", :processed_by => :to_i # processed_by specifies a method which post_processes to value
+      _mapping
+    end
+
+    let(:input_hash) do
+      {
+        record_id: "some_id123",
+        record: {
+          title: "some title",
+          isbns: [
+            "3-86680-192-0",
+            "3-680-08783-7"
+          ],
+          count: "3"
+        }
+      }
+    end
+
+    it "translates a given hash according to @rules" do
+      expect(mapping.translate_hash(input_hash)).to eq({
+        :id=>"some_id123",
+        :tile=>"some title",
+        :my_data=>{:isbns=>["3-86680-192-0", "3-680-08783-7"]},
+        :main_isbn=>"3-680-08783-7",
+        :count=>3
+      })
+    end
+  end
+
+end

data/spec/yahm_spec.rb

@@ -0,0 +1,8 @@
+require_relative "./spec_helper"
+
+describe Yahm do
+  it "has a module called HashMapper" do
+    expect(Yahm.const_defined? :HashMapper).to be_true
+    expect(Yahm::HashMapper.class.is_a? Module)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Sievers
@@ -116,12 +116,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yahm.rb
+- lib/yahm/hash_mapper.rb
+- lib/yahm/mapping.rb
 - lib/yahm/version.rb
+- spec/spec_helper.rb
+- spec/yahm/hash_mapper_spec.rb
+- spec/yahm/mapping_spec.rb
+- spec/yahm_spec.rb
 - yahm.gemspec
 homepage: https://github.com/ubpb/yahm
 licenses:
@@ -147,4 +154,8 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Yet another ruby hash mapper
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yahm/hash_mapper_spec.rb
+- spec/yahm/mapping_spec.rb
+- spec/yahm_spec.rb