light_mapper 0.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec180a4b4062fa63e032fef32a556894a365dcb4
-  data.tar.gz: 40f8416865d57b19af6c16bf0b82fe4306261dc1
+SHA256:
+  metadata.gz: 309f037da546bc788d238d3fd43c7f92f1d117a1b885a30b7eaf65dc2947a445
+  data.tar.gz: f7a0c2c83eb49ce56ccbf1da8b102bf4325f868d9c35dee3a2dc36377f6c96f2
 SHA512:
-  metadata.gz: 35af7945db5ac71c6353fa873f46a86677a9bcea56e9d4645c57acfbb2a850dc48ff4ee1e847d46fad8ca4bfb7a856ce69cc330cc57a1bf204ebcf2aa7ba719a
-  data.tar.gz: 9e2693e1fbcc48e7a6a95c10d609aa3536303dcbad048bd52221516bbd96f3f1691775b6d1cceb75f7987c23f42fa4461e3c0dcc2b6f27aa003fba18f8efd8d9
+  metadata.gz: 9c306788435e091828219174645e0034c4bdfa8a096643d506e34258831bbefbbccf5dca2b0595720207796c301b01dc988abbd312d04391a9c0a5fc2b2d5dc2
+  data.tar.gz: 0fbd144a196b3edc3110c81e945d1d7ed6880f7d5cd8b82d34d1754bbdb3a32d7069254b03d5f8d977118c182fe8446734f555da92a144f130029c55c391ecce

data/.rubocop.yml

@@ -15,10 +15,6 @@ Style/Documentation:
 Style/PercentLiteralDelimiters:
   Enabled: false
 
-# Offense count: 2
-Style/RegexpLiteral:
-  MaxSlashes: 0
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -45,4 +41,4 @@ Metrics/LineLength:
 AllCops:
   Exclude:
     - '**/Guardfile'
-    - '**/light_parmas.gemspec'
+    - '**/light_mapper.gemspec'

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 script: bundle exec rake
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.1.4
+  - 3.1.2

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in light_mapper.gemspec
 gemspec
+
+ruby '2.7.4'

data/README.md

@@ -1,6 +1,10 @@
 # LightMapper
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/light_mapper.svg)](http://badge.fury.io/rb/light_mapper)
+[![Build Status](https://travis-ci.org/pniemczyk/light_mapper.svg?branch=0.2.0)](https://travis-ci.org/pniemczyk/light_mapper)
+[![Dependency Status](https://gemnasium.com/pniemczyk/light_mapper.svg)](https://gemnasium.com/pniemczyk/light_mapper)
+
+This is simple mapper for hash.
 
 ## Installation
 
@@ -20,7 +24,152 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic usage
+
+```ruby
+{
+  'FirstName' => 'Pawel',
+  'LastName'  => 'Niemczyk'
+}.extend(LightMapper).mapping(
+  'FirstName' => :first_name,
+  'LastName' => :last_name
+)
+```
+
+or
+
+```ruby
+LightMapper.mapping(
+  { 'FirstName' => 'Pawel', 'LastName'  => 'Niemczyk' },
+  { 'FirstName' => :first_name, 'LastName' => :last_name }
+)
+```
+
+result is obvious:
+
+```ruby
+{ first_name: 'Pawel', last_name: 'Niemczyk' }
+```
+
+The most popular usage:
+
+```ruby
+PersonMapper = {
+  'FirstName' => :first_name,
+  'LastName' => :last_name,
+  'Age' => 'age'
+}
+
+data = {
+  'FirstName' => 'Pawel',
+  'LastName'  => 'Niemczyk',
+  'Age' => 5
+}
+
+data.extend(LightMapper).mapping(PersonMapper)
+# {first_name: 'Pawel', last_name: 'Niemczyk', 'age': 5}
+```
+
+### When you require all keys
+
+```ruby
+{ 'FirstName' => 'Pawel' }.extend(LightMapper).mapping({'FirstName' => :first_name, 'LastName' => :last_name}, strict: true)
+```
+
+it will raise LightMapper::KeyMissing: LastName key not found; Full path LastName
+
+### When you want to pass string or symbol keys
+
+```ruby
+{
+  'FirstName' => 'Pawel',
+  second_name: 'Niemczyk'
+}.extend(LightMapper).mapping({
+                                'FirstName' => :first_name,
+                                'second_name' => :last_name
+                              }, any_keys: true)
+```
+
+result will be:
+
+```ruby
+{ first_name: 'Pawel', last_name: 'Niemczyk' }
+```
+
+### Support for nested hashes, arrays and objects (now we talking what it is capable of)
+
+```ruby
+{
+  'source' => { 'google' => { 'search_word' => 'ruby' } },
+  'user' => User.new(email: 'pawel@example.com', name: 'Pawel'),
+  'roles' => %w[admin manager user],
+  'mixed' => { users: [User.new(email: 'max@example.com', name: 'Max', manager: true), User.new(email: 'pawel@example.com', name: 'Pawel', manager: false)] },
+  'scores' => [ 10, 2, 5, 1000],
+  'last_4_payments' => [
+    { 'amount' => 100, 'currency' => 'USD' },
+    { 'amount' => 200, 'currency' => 'USD' },
+    { 'amount' => 300, 'currency' => 'USD' },
+    { 'amount' => 400, 'currency' => 'USD' }
+  ],
+  'array' => [
+    [1,2,3],
+    [4,5,6],
+    [
+      7,
+      8,
+      [':D']
+    ],
+  ]
+}.extend(LightMapper).mapping(
+  'source.google.search_word' => :word,
+  'user.email' => :email,
+  'user.as_json.name' => :name,
+  'roles.0' => :first_role,
+  ['roles', 1] => :middle_role,
+  'roles.last' => :last_role,
+  (->(source) { source[:mixed][:users].find { |user| user.manager }.email }) => :manager_email,
+  (->(source) { source[:mixed][:users].find { |user| user.manager }.name }) => :manager_name,
+  'mixed.users.last.name' => :last_user_name,
+  (->(source) { source[:last_4_payments].map(&:values).map(&:first).max }) => :quarterly_payment_amount,
+  'scores.sum' => :final_score,
+  'array.2.2.first' => :smile
+)
+```
+
+result will be:
+
+```ruby
+{ 
+  word: 'ruby', 
+  email: 'pawel@example.com',
+  name: 'Pawel',
+  first_role: 'admin',
+  last_role: 'user',
+  manager_email: 'max@example.com',
+  manager_name: 'Max',
+  last_user_name: 'Pawel',
+  quarterly_payment_amount: 1000,
+  final_score: 1017
+}
+```
+
+### Mappers selection via pattern matching
+
+```ruby
+GOOGLE_MAPPER   = { 'result.user.name' => :name }
+LINKEDIN_MAPPER = { 'result.client.display_name' => :word }
+
+data = { source: 'google', user: { name: 'test'}, 'result' => { 'user' => { 'name' => 'Pawel'} } } 
+mapper = case data
+         in source: 'google', user: {name:} then GOOGLE_MAPPER
+         in source: 'linkedin', client: {display_name:} then LINKEDIN_MAPPER
+         else
+           raise 'Unknown mapper'
+         end
+
+data.extend(LightMapper).mapping(mapper)
+# result { name: 'Pawel' }
+```
 
 ## Contributing
 

data/Rakefile

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

data/lib/light_mapper/version.rb

@@ -1,3 +1,3 @@
 module LightMapper
-  VERSION = '0.0.1'
+  VERSION = '1.0.4'
 end

data/lib/light_mapper.rb

@@ -1,16 +1,78 @@
 require 'light_mapper/version'
 
 module LightMapper
+  InvalidKey = Class.new(StandardError)
+  KeyMissing = Class.new(StandardError)
+
+  module Helper
+    def self.raise_key_missing(current, full_path, additional_message = nil)
+
+      raise KeyMissing, ["#{current} key not found; Full path #{full_path.map(&:to_s).join('.')}", additional_message].compact.join('; ')
+    end
+
+    def self.key_destructor(value)
+      case value
+      in String
+        value.split('.')
+      in Symbol
+        [value]
+      in Array
+        value
+      else
+        raise InvalidKey, "Invalid key type: #{value.class}"
+      end
+    end
+
+    def self.value_extractor(object, current, path, full_path, strict = false, any_keys = false)
+      result = case object
+               in Hash
+                 hash_key_extractor(object, current, full_path, strict, any_keys)
+               in Array
+                 array_key_extractor(object, current, full_path, strict, any_keys)
+              in NilClass
+                 nil
+              else
+                method_name = current.to_s.to_sym
+                object.respond_to?(method_name) ? object.send(method_name) : !strict ? nil : raise_key_missing(current, full_path)
+              end
+
+      path.compact.empty? ? result : value_extractor(result, path.first, path[1..-1], full_path, strict, any_keys)
+    end
+
+    def self.hash_key_extractor(object, current, full_path, strict, any_keys)
+      keys = any_keys ? [current, current.to_s, current.to_s.to_sym] : [current]
+      raise_key_missing(current, full_path) if strict && !keys.any? { |k| object.key?(k) }
+
+      object.values_at(*keys).compact.first
+    end
+
+    def self.array_key_extractor(object, current, full_path, strict, _any_keys)
+      index = current.to_s.match(/^(\d)+$/) ? current.to_i : nil
+
+      if index
+        raise_key_missing(current, full_path) if strict && index && object.size < index.next
+
+        object[index]
+      else
+        method_name = current.to_s.to_sym
+        raise_key_missing(current, full_path, "Array do not respond on #{method_name}") if strict && !object.respond_to?(method_name)
+
+        object.public_send(method_name)
+      end
+    end
+  end
+
   def mapping(mappings, opts = {})
     LightMapper.mapping(clone, mappings, opts)
   end
 
   def self.mapping(hash, mappings, opts = {})
-    require_keys = opts[:require_keys] == true
+    strict, any_keys = opts.values_at(:strict, :any_keys)
+    mappings.each_with_object({}) do |(k, v), h|
+      next h[v] = k.call(hash) if k.is_a?(Proc)
 
-    fetch_method = require_keys ? :fetch : :[]
-    {}.tap do |h|
-      mappings.each { |k, v| h[v] = hash.public_send(fetch_method, k) }
+      key_path = Helper.key_destructor(k)
+      h[v] = Helper.value_extractor(hash, key_path.first, key_path[1..-1], key_path, strict, any_keys)
     end
   end
 end

data/light_mapper.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 2.3'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'guard', '~> 2.12'

data/spec/lib/light_mapper_spec.rb

@@ -1,4 +1,17 @@
 require 'spec_helper'
+class User
+  attr_accessor :name, :email, :manager
+
+  def initialize(name:, email:, manager: false)
+    @name = name
+    @email = email
+    @manager = manager
+  end
+
+  def as_json
+    { 'name' => name, 'email' => email, 'manager' => manager }
+  end
+end
 
 describe LightMapper do
 
@@ -12,7 +25,7 @@ describe LightMapper do
       }
     end
 
-    let(:maper) do
+    let(:mapper) do
       {
         'A' => :a,
         'b' => 'z'
@@ -20,7 +33,7 @@ describe LightMapper do
     end
 
     it 'return correct hash' do
-      expect(subject.mapping(maper)).to eq(a: original_hash['A'], 'z' => original_hash['b'])
+      expect(subject.mapping(mapper)).to eq(a: original_hash['A'], 'z' => original_hash['b'])
     end
   end
 
@@ -32,7 +45,7 @@ describe LightMapper do
       }
     end
 
-    let(:maper) do
+    let(:mapper) do
       {
         'A' => :a,
         'c' => 'z'
@@ -40,7 +53,166 @@ describe LightMapper do
     end
 
     it 'raise KeyError when required key missing' do
-      expect { subject.mapping(maper, require_keys: true) }.to raise_error(KeyError)
+      expect { subject.mapping(mapper, strict: true) }.to raise_error(LightMapper::KeyMissing)
+    end
+  end
+
+  describe 'basic data mapping when any keys kind is allowed' do
+    let(:original_hash) do
+      {
+        'A' => 'test',
+        'b' => 1,
+        c: 10
+
+      }
+    end
+
+    let(:mapper) do
+      {
+        'A' => :a,
+        'c' => :c,
+        b: 'z'
+      }
+    end
+
+    it 'return correct hash' do
+      expect(subject.mapping(mapper, any_keys: true)).to eq(
+        a: original_hash['A'],
+        c: original_hash[:c],
+        'z' => original_hash['b']
+      )
+    end
+
+    describe 'raise KeyError' do
+      let(:mapper) do
+        {
+          'A' => :a,
+          'c' => :c,
+          k: 'z'
+        }
+      end
+
+      it ' when required key missing' do
+        expect { subject.mapping(mapper, strict: true, any_keys: true) }.to raise_error(LightMapper::KeyMissing)
+      end
+    end
+   end
+
+  describe 'more advanced mapping' do
+    let(:source) do
+      {
+        'source' => { 'google' => { 'search_word' => 'ruby' } },
+        'user' => User.new(email: 'pawel@example.com', name: 'Pawel'),
+        'roles' => %w[admin manager user],
+        'mixed' => { users: [User.new(email: 'max@example.com', name: 'Max', manager: true), User.new(email: 'pawel@example.com', name: 'Pawel', manager: false)] },
+        'scores' => [ 10, 2, 5, 1000],
+        'last_4_payments' => [
+          { 'amount' => 100, 'currency' => 'USD' },
+          { 'amount' => 200, 'currency' => 'USD' },
+          { 'amount' => 300, 'currency' => 'USD' },
+          { 'amount' => 400, 'currency' => 'USD' }
+        ],
+        'array' => [
+          [1,2,3],
+          [4,5,6],
+          [
+            7,
+            8,
+            [':D']
+          ],
+        ]
+      }
+    end
+
+    context 'with nested hash mapping' do
+      let(:mapping) { {'source.google.search_word' => :word} }
+
+      it 'return correct result' do
+        expect(source.extend(LightMapper).mapping(mapping)).to eq(word: 'ruby')
+      end
+    end
+
+    context 'with nested array mapping' do
+      let(:mapping) { {'array.2.2.first' => :result} }
+
+      it 'return correct result' do
+        expect(source.extend(LightMapper).mapping(mapping)).to eq(result: ':D')
+      end
+    end
+
+    context 'with nested object mapping' do
+      let(:mapping) { {'user.email' => :result} }
+
+      it 'return correct result' do
+        expect(source.extend(LightMapper).mapping(mapping)).to eq(result: 'pawel@example.com')
+      end
+    end
+
+    context 'with mapping proc' do
+      let(:mapping) { { (->(source) { source['last_4_payments'].last['amount'].to_s }) => :result } }
+
+      it 'return correct result' do
+        expect(source.extend(LightMapper).mapping(mapping)).to eq(result: '400')
+      end
+    end
+
+    context 'with mix of nested object types' do
+      let(:mapping) do
+        {
+          'source.google.search_word' => :word,
+          'user.email' => :email,
+          'user.as_json.name' => :name,
+          'roles.0' => :first_role,
+          ['roles', 1] => :middle_role,
+          'roles.last' => :last_role,
+          (->(source) { source['mixed'][:users].find { |user| user.manager }.email }) => :manager_email,
+          (->(source) { source['mixed'][:users].find { |user| user.manager }.name }) => :manager_name,
+          'mixed.users.last.name' => :last_user_name,
+          (->(source) { source['last_4_payments'].map(&:values).map(&:first).max }) => :quarterly_payment_amount,
+          'scores.sum' => :final_score,
+          'array.2.2.first' => :smile
+        }
+      end
+
+      it 'return correct result' do
+        expect(source.extend(LightMapper).mapping(mapping, any_keys: true)).to match({
+                                                                    word: 'ruby',
+                                                                    email: 'pawel@example.com',
+                                                                    name: 'Pawel',
+                                                                    final_score: 1017,
+                                                                    first_role: 'admin',
+                                                                    last_role: 'user',
+                                                                    manager_email: 'max@example.com',
+                                                                    manager_name: 'Max',
+                                                                    last_user_name: 'Pawel',
+                                                                    middle_role: 'manager',
+                                                                    quarterly_payment_amount: 400,
+                                                                    smile: ':D'
+                                                                  })
+      end
+
+      it 'return correct result base on proper key types' do
+        expect(source.extend(LightMapper).mapping(mapping)).to match({
+                                                                    word: 'ruby',
+                                                                    email: 'pawel@example.com',
+                                                                    name: 'Pawel',
+                                                                    final_score: 1017,
+                                                                    first_role: 'admin',
+                                                                    last_role: 'user',
+                                                                    manager_email: 'max@example.com',
+                                                                    manager_name: 'Max',
+                                                                    last_user_name: nil,
+                                                                    middle_role: 'manager',
+                                                                    quarterly_payment_amount: 400,
+                                                                    smile: ':D'
+                                                                  })
+      end
+
+      it 'raise KeyMissing error' do
+        expect { source.extend(LightMapper).mapping({'user.non_existence_method' => :result}, strict: true) }.to raise_error(LightMapper::KeyMissing)
+        expect { source.extend(LightMapper).mapping({'last_4_payments.4' => :result}, strict: true) }.to raise_error(LightMapper::KeyMissing)
+        expect { source.extend(LightMapper).mapping({'source.google.missing_key' => :result}, strict: true) }.to raise_error(LightMapper::KeyMissing)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light_mapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Pawel Niemczyk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2022-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ homepage: https://github.com/pniemczyk/light_mapper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,16 +155,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Very light hash mapper
 test_files: