light_mapper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec180a4b4062fa63e032fef32a556894a365dcb4
-  data.tar.gz: 40f8416865d57b19af6c16bf0b82fe4306261dc1
+  metadata.gz: 739e3317c888c4ead5db06449dee80bf264cff23
+  data.tar.gz: 353f10793c1cd990659934465b064fe035771f55
 SHA512:
-  metadata.gz: 35af7945db5ac71c6353fa873f46a86677a9bcea56e9d4645c57acfbb2a850dc48ff4ee1e847d46fad8ca4bfb7a856ce69cc330cc57a1bf204ebcf2aa7ba719a
-  data.tar.gz: 9e2693e1fbcc48e7a6a95c10d609aa3536303dcbad048bd52221516bbd96f3f1691775b6d1cceb75f7987c23f42fa4461e3c0dcc2b6f27aa003fba18f8efd8d9
+  metadata.gz: 6748d296cb4d18fa6c2f49e6777ec4e269e5eb19c961baa6e57677d8014958aa59c8464cbda208da8ff8b5b5a975974bdfffd86eaf9e6ae3ad00a68f619c8f68
+  data.tar.gz: b52174375c53a98b10c09664096fa01ee0a6ec18e841c06a0f12571cd704580c48935c907faec8b32dd77aa6e60a05b518a969ff986f9e3d5e55a62db339131c

data/README.md

@@ -1,6 +1,6 @@
 # LightMapper
 
-TODO: Write a gem description
+This is simple mapper for hash.
 
 ## Installation
 
@@ -20,7 +20,71 @@ 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
+)
+```
+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)
+```
+
+### When you require all keys
+
+```ruby
+{
+  'FirstName' => 'Pawel'
+}.extend(LightMapper, require_keys: true).mapping(
+  'FirstName' => :first_name,
+  'LastName' => :last_name
+)
+```
+
+it will raise KeyError
+
+### When you want to pass string or symbol keys
+
+```ruby
+{
+  'FirstName' => 'Pawel',
+  second_name: 'Niemczyk'
+}.extend(LightMapper, any_keys_kind: true).mapping(
+  'FirstName' => :first_name,
+  'second_name' => :last_name
+)
+```
+
+result will be:
+
+```ruby
+{ first_name: 'Pawel', last_name: 'Niemczyk' }
+```
 
 ## Contributing
 

data/lib/light_mapper.rb

@@ -6,11 +6,24 @@ module LightMapper
   end
 
   def self.mapping(hash, mappings, opts = {})
-    require_keys = opts[:require_keys] == true
+    require_keys  = opts[:require_keys]  == true
+    any_keys_kind = opts[:any_keys_kind] == true
+    fetch_method  = if any_keys_kind
+      if require_keys
+        -> (hash, key) { hash.fetch(key.to_s, hash.fetch(key.to_sym)) }
+      else
+        -> (hash, key) { hash[key.to_s] || hash[key.to_sym] }
+      end
+    else
+      if require_keys
+        -> (hash, key) { hash.fetch(key) }
+      else
+        -> (hash, key) { hash[key] }
+      end
+    end
 
-    fetch_method = require_keys ? :fetch : :[]
     {}.tap do |h|
-      mappings.each { |k, v| h[v] = hash.public_send(fetch_method, k) }
+      mappings.each { |k, v| h[v] = fetch_method.call(hash, k) }
     end
   end
 end

data/lib/light_mapper/version.rb

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

data/spec/lib/light_mapper_spec.rb

@@ -43,4 +43,48 @@ describe LightMapper do
       expect { subject.mapping(maper, require_keys: true) }.to raise_error(KeyError)
     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(:maper) do
+      {
+        'A' => :a,
+        'c' => :c,
+        b: 'z'
+      }
+    end
+
+    it 'return correct hash' do
+      expect(subject.mapping(maper, any_keys_kind: true)).to eq(
+        a: original_hash['A'],
+        c: original_hash[:c],
+        'z' => original_hash['b']
+      )
+    end
+
+    describe 'raise KeyError' do
+      let(:maper) do
+        {
+          'A' => :a,
+          'c' => :c,
+          k: 'z'
+        }
+      end
+
+      it ' when required key missing' do
+        expect { subject.mapping(maper, require_keys: true, any_keys_kind: true) }.to raise_error(KeyError)
+      end
+    end
+  end
+
+  it 'nested keys'
+  it 'value conversion'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: light_mapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pawel Niemczyk