hash_remapper 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd1eb9b9c2a9a1ed5379213e72f50a3dc5dcbf93d4fd6deedb4e5a90c9cb4e7d
-  data.tar.gz: c565d0549390a2d4264e170aa74ef1d7e106201f8f38674a627d1c6aa4b3e6d1
+  metadata.gz: c683439dd0fa1c9ed4829b996ef023248412faa7c40062da5195e6c7f639b610
+  data.tar.gz: 169160ed106c2da575ebbd2e8ee3a09432fdecfcb100af63f899ac08ccafd689
 SHA512:
-  metadata.gz: 9ac29a074171eac2b77c34b00a703b800bfaa9e0ceb3a8d1c498a09d1c8db4ecd616cc298ee2cc4e5b52f01183c4d697be4857fd2e3fcd25580eeb6cd822576c
-  data.tar.gz: b8d7a86a12c5c375031bb3a9a42bc972f94f6d46bb4c0690f52177b1bf2215a496479783a877e069d9522f72346adde9827336fea3001714e69e4f0dbce8f5fc
+  metadata.gz: 10b4f4686588c177567f5f7a0653970b71e18f7bd2919166b9bca568c4ab80a020b69b7ecdd96cce2d3291359c02e7ba6ad43447053f577a768ea41c31360ed0
+  data.tar.gz: 78fdc8e7fba05285373ac1dd8395b6d5aeec76b892ddffb1508cd79c1a34dda19283da5e7014065e30f96ce7eccbba6758231fb93f0868534f584509da600c8a

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/README.md

@@ -5,6 +5,7 @@
 </p>
 
 > A little lib which maps original keys to the new ones <sup>[*](#features)</sup>
+> [![Build Status](https://travis-ci.org/smileart/hash_remapper.svg?branch=master)](https://travis-ci.org/smileart/hash_remapper)
 
 ## Installation
 
@@ -29,13 +30,13 @@ Or install it yourself as:
 * preprocess a value with a lambda [3](#lambda)
 * allows to remap the keys within preprocessing [4](#preprocessing)
 * allows to keep data subsets only [5](#subset)
-* allows to include data with the original keynames [6](#originals)
+* allows to include data with the original key names [6](#originals)
 * allows to use global context to create composite fields [7](#composite)
 * merges values if the key already exists and supports #merge [8](#merge)
 * replaces values if the key already exists and doesn't support #merge [9](#replace)
 * allows to assign static defaults through lambdas [10](#defaults)
 * allows to remap to the deep values within the context [11](#deep)
-* allows to create completely new keys [12](#new_keys)
+* allows to create completely new keys (including nested ones) [12](#new_keys)
 
 ## Usage
 
@@ -167,7 +168,7 @@ HashRemapper.remap(
 # }
 ```
 
-## <a name="originals">6</a>: Include data with the original keyname
+## <a name="originals">6</a>: Include data with the original key name
 
 ```rb
 HashRemapper.remap(
@@ -266,7 +267,7 @@ HashRemapper.remap(
 # }
 ```
 
-## <a name="new_keys">12</a>: Create completely new keys
+## <a name="new_keys">12</a>: Create completely new keys (including nested ones)
 
 ```rb
 HashRemapper.remap(
@@ -280,6 +281,54 @@ HashRemapper.remap(
 #   magic_number: 42,
 #   absolutely_new_key: 'shiny new value'
 # }
+
+HashRemapper.remap(
+  original_hash,
+  _: [[:nested, :new, :key], :test]
+)
+
+# =>
+# {
+#   nested: {
+#     new: {
+#       key: 42
+#     }
+#   }
+# }
+
+
+# mapping a deep target from a deep source (BEWARE an old digging API <= v0.1.0)
+HashRemapper.remap(
+  original_hash,
+  _: [[:nested, :new, :key], [:nested,  :really, :deep]]
+)
+
+# =>
+# {
+#   nested: {
+#     new: {
+#       key: true
+#     }
+#   }
+# }
+
+
+# mapping a deep target from a deep source (new digging API >= v0.2.0)
+HashRemapper.remap(
+  original_hash,
+  _: [[:new, :deeply, :nested, :value], {path: 'recursive.*.number', strict: false, default: 3.14}]
+)
+
+# =>
+# {
+#   new: {
+#     deeply: {
+#       nested: {
+#         value: [21, 42, 3.14]
+#       }
+#     }
+#   }
+# }
 ```
 
 ## Development

data/exmaples/weather.rb

@@ -0,0 +1,42 @@
+require 'json'
+require_relative '../lib/hash_remapper'
+
+# https://samples.openweathermap.org/data/2.5/weather?q=London,uk&appid=b6907d289e10d714a6e88b30761fae22
+weather = JSON.parse('{"coord":{"lon":-0.13,"lat":51.51},"weather":[{"id":300,"main":"Drizzle","description":"light intensity drizzle","icon":"09d"}],"base":"stations","main":{"temp":280.32,"pressure":1012,"humidity":81,"temp_min":279.15,"temp_max":281.15},"visibility":10000,"wind":{"speed":4.1,"deg":80},"clouds":{"all":90},"dt":1485789600,"sys":{"type":1,"id":5091,"message":0.0103,"country":"GB","sunrise":1485762037,"sunset":1485794875},"id":2643743,"name":"London","cod":200}')
+
+k_to_c = ->(kelvin) { "#{(kelvin - 273.15).floor}˚C" } # notice the difference with the next example
+
+remapped_weather = HashRemapper.remap(
+  weather,
+  # deep keys creation instead of automerge
+  _conditions: [[:current_conditions, :description], {path: 'weather.0', lambda: ->(res){ "#{res[:description]}".capitalize }} ],
+  _temperature: [[:current_conditions, :temperature], {path: 'main.temp', lambda: k_to_c}],
+
+  _clouds: [[:clouds_coverage, :percentage], {path: 'clouds.all'}],
+  'visibility' => ->(vis, _) { [:visibility, "#{vis / 1000}km"] },
+  ['sys', 'country'] => ->(country, _) { [[:place, :country], country] },
+  'name' => ->(city, _) { [[:place, :city], city] },
+  'coord' => :geo_coordinates
+)
+
+p remapped_weather
+
+# =================================================================================================================================
+
+k_to_c = ->(kelvin) { { temperature: "#{(kelvin - 273.15).floor}˚C" } } # notice the difference with the previous example
+
+remapped_weather = HashRemapper.remap(
+  weather,
+  # automerge on "conflict"
+  _conditions: [:current_conditions, {path: 'weather.0', lambda: ->(res){ { description: "#{res[:description]}".capitalize }}} ],
+  _temperature: [:current_conditions, {path: 'main.temp', lambda: k_to_c}], # automerge
+  _clouds: [[:clouds_coverage, :percentage], {path: 'clouds.all'}],
+  'visibility' => ->(vis, _) { [:visibility, "#{vis / 1000}km"] },
+  ['sys', 'country'] => ->(country, _) { [[:place, :country], country] },
+  'name' => ->(city, _) { [[:place, :city], city] },
+
+  # notice the nested HashRemapper (alternatively https://devdocs.io/rails~5.0/hash#method-i-deep_symbolize_keys could be used on overall result)
+  'coord' => ->(coord, _) { [:geo_coordinates, HashRemapper.remap(coord, 'lon' => :lon, 'lat' => :lat)] },
+)
+
+p remapped_weather

data/hash_remapper.gemspec

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 # coding: utf-8
 
-lib = File.expand_path('./lib', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-# to avoid double const init warning
-require_relative './lib/hash_remapper'
+require 'hash_remapper/version'
 
-Gem::Specification.new do |spec|
+HashRemapper::GEMSPEC = Gem::Specification.new do |spec|
   spec.name          = 'hash_remapper'
   spec.version       = HashRemapper::VERSION
   spec.authors       = ['Serge Bedzhyk']
@@ -26,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'hash_digger', '~> 0.0', '>= 0.0.4'
+
   spec.add_development_dependency 'bundler',        '~> 2.0'
   spec.add_development_dependency 'byebug',         '~> 11.0'
   spec.add_development_dependency 'inch',           '>= 0.9.0.rc1'
@@ -36,6 +37,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubygems-tasks', '~> 0.2'
   spec.add_development_dependency 'simplecov',      '~> 0.15'
   spec.add_development_dependency 'yard',           '~> 0.9'
-
-  spec.add_runtime_dependency 'hash_digger',        '~> 0.0'
 end

data/lib/hash_remapper.rb

@@ -3,11 +3,11 @@
 require 'set'
 require 'hash_digger'
 
+require 'letters' if ENV['DEBUG']
+require 'byebug'  if ENV['DEBUG']
+
 # Utility class to map original Hash keys to the new ones
 class HashRemapper
-  # Current Library Version
-  VERSION = '0.3.0'
-
   class << self
     # Remaps `data` Hash by renaming keys, creating new ones and
     # optionally aggregating values
@@ -22,19 +22,20 @@ class HashRemapper
     #
     # @param [Hash] data the original Hash to remap
     # @param [Boolean] pass_trough the flag to pass the original key/value pairs (default: false)
-    # @param [Hash] mapping the Hash which in the simplest case tells how to rename keys
+    # @param [Hash] mapping the Hash which in the simplest case tells how to rename keys (source: :target)
     #
     # @return [Hash] remapped version of the original Hash
     #                (selected keys only or all the keys if we passed originals)
     def remap(data, pass_trough = false, mapping)
       mapping = pass_trough_mapping(data, mapping) if pass_trough
 
-      mapping.each_with_object({}) do |(from, to), acc|
+      mapping.each_with_object(Hash.new { |hash, key| hash[key] = Hash.new(&hash.default_proc) }) do |(from, to), acc|
         key, value = try_callable(from, to, data, acc) ||
-                     try_digging(to, data) ||
+                     try_digging(from, to, data, acc) ||
+                     try_nesting(from, to, data, acc) ||
                      [to, data[from]]
 
-        acc[key] = value
+        set_value(acc, key, value)
         acc
       end
     end
@@ -53,11 +54,11 @@ class HashRemapper
     def try_callable(from, to, data, acc)
       return unless to.respond_to?(:call)
 
-      target_name, target_data = to.call(data[from], data)
+      target_name, target_data = to.call(data.dig(*from), data)
 
-      if acc.key?(target_name) && acc[target_name].respond_to?(:merge)
-        target_data = acc[target_name].merge(target_data)
-      end
+      target_data = acc.dig(*target_name).respond_to?(:merge) && target_data.respond_to?(:merge) ?
+                      acc.dig(*target_name).merge(target_data) :
+                      target_data
 
       [target_name, target_data]
     end
@@ -66,34 +67,45 @@ class HashRemapper
     # (if the mapping value is enumerable)
     # @see https://github.com/smileart/hash_digger
     #
-    # @param [Array] to the target key to map to ([new_key, digging_path, strict_flag])
+    # @param [Array] to the target key to map to ([new_key, {path: 'a.*.b', strict: false, lambda: ->(res){ … }}])
     # @param [Hash] data the whole original Hash to use as the digging target
     #
     # @return [Array(Object,Object)] key and its value to put to the resulting Hash
-    def try_digging(to, data)
+    def try_digging(_from, to, data, acc)
       return unless to.respond_to?(:each)
 
       digger_args = to.fetch(1)
 
       # v0.1.0 backward compartability layer ([new_key, [:digg, :path, :keys]])
       return [to.first, data.dig(*to.last)] if digger_args.kind_of?(Array)
+      return unless digger_args.respond_to?(:fetch)
 
       lambda = digger_args.fetch(:lambda) { nil }
 
       # @see https://github.com/DamirSvrtan/fasterer — fetch_with_argument_vs_block
       # @see https://github.com/smileart/hash_digger — digger args
-      [
-        to.fetch(0),
-        HashDigger::Digger.dig(
-          data: data,
-          path: digger_args.fetch(:path) { '*' },
-          strict: digger_args.fetch(:strict) { true },
-          default: digger_args.fetch(:default) { nil },
-          &lambda
-        )
+      target_name = to.fetch(0)
+
+      source_data = HashDigger::Digger.dig(
+        data: data,
+        path: digger_args.fetch(:path) { '*' },
+        strict: digger_args.fetch(:strict) { true },
+        default: digger_args.fetch(:default) { nil },
+        &lambda
+      )
+
+      return [
+        target_name,
+        acc.dig(*target_name).respond_to?(:merge) && source_data.respond_to?(:merge) ?
+          acc.dig(*target_name).merge(source_data) :
+          source_data
       ]
     end
 
+    def try_nesting(_from, to, data, _acc)
+      [to.fetch(0), data[to.fetch(1)]] if to.respond_to?(:fetch)
+    end
+
     # Method which automatically prepares direct mapping (e.g. { :a => :a })
     # for the keys that weren't used in the mapping Hash (to pass them through "as is")
     #
@@ -110,5 +122,16 @@ class HashRemapper
 
       mapping.merge(pass_trough_mapping)
     end
+
+    def set_value(data, key, value)
+      unless key.respond_to?(:each)
+        data[key] = value
+        return data
+      end
+
+      last_key = key.pop
+
+      data.dig(*key)[last_key] = value
+    end
   end
 end

data/lib/hash_remapper/version.rb

@@ -0,0 +1,4 @@
+class HashRemapper
+  # Current Library Version
+  VERSION = '0.4.2'
+end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: hash_remapper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Serge Bedzhyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-09 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_digger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +170,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: hash_digger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
 description: A little lib which maps original keys to the new ones and more
 email: smileart21@gmail.com
 executables: []
@@ -182,9 +188,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exmaples/weather.rb
 - hash_remapper.gemspec
 - img/hash_remapper.png
 - lib/hash_remapper.rb
+- lib/hash_remapper/version.rb
 homepage: https://github.com/smileart/hash_remapper
 licenses:
 - MIT