hash-mapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1c56d04bcaafe897567fb67d702384f63ba055317e33986a9ffef7fd59039cf
+  data.tar.gz: c8186acb1376d11698734052311f364595fb889fe8b9cd6d327b9f17bcb60588
+SHA512:
+  metadata.gz: 5d0eead6cfadd731678cc539f72851b015c0a66304b4a794c212611645571cedd75c8147168265bc55023655a2c1651c93ba05b5286420e89f0aa38736e6392d
+  data.tar.gz: 2978665cb5a9e565ae04b3135c9f4fee2dba50a9cb333c46d6723939e081a95ff808746b772c8f379e0368f55033fb51f56849c796a3487fa7ce974ac2c31b31

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "20"

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'hashie'
+gem 'rspec', group: :test
+

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    hashie (4.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hashie
+  rspec
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2019 Volkan Unsal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# hash-mapper
+
+Map a Ruby hash into another Ruby hash.
+
+## Usage
+
+```ruby
+m = HashMapper.new do
+  key :name, source: :Name
+  key :last_name, source: :LastName, :allow_nil, then: proc { |o| o.value + '!' }
+  key :full_name, source: [:Name, :LastName], then: proc { |o|
+    "#{o.value.first} W. #{o.value.second}"
+  }
+  key :surname, eq: 'Wheeler'
+  key :zip
+  merge { |o| { extra: o.Name + '!' } }
+end
+m.run(Name: 'Bob', LastName: 'Fuller', zip: 'Boo!')
+# => {name: 'Bob', last_name: 'Bob', full_name: 'Bob W. Fuller', surname: 'Wheeler', extra: 'Bob!', zip: 'Boo!' }
+```
+
+## Installation
+
+```
+gem install hash-mapper
+```
+
+## License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,8 @@
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList["spec/*_spec.rb"]
+  t.verbose = true
+end
+
+task default: :spec

data/hash-mapper.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash-mapper"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Volkan Unsal"]
+  spec.email         = ["spocksplanet@gmail.com"]
+
+  spec.summary       = %q{Map a Ruby hash into another Ruby hash..}
+  spec.description   = %q{Map a Ruby hash into another Ruby hash..}
+  spec.homepage      = "https://github.com/volkanunsal/hash-mapper"
+  spec.license       = "MIT"
+  spec.metadata      = {
+    "homepage_uri"      => "https://github.com/volkanunsal/hash-mapper",
+    "source_code_uri"   => "https://github.com/volkanunsal/hash-mapper"
+  }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rspec", "~> 3.7"
+end

data/lib/hash-mapper.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hashie"
+require "hash-mapper/dsl"
+
+class HashMapper
+  VERSION = "0.0.1"
+
+  def initialize(opts = [], &blk)
+    @opts = case opts
+            when Array
+              { keep: opts }
+            when Hash
+              opts
+            end
+    @mapper = Dsl.new
+    @mapper.evaluate(&blk) unless blk.nil?
+  end
+
+  def run(object = {}, state = {})
+    object = object
+    state = state.dup
+    state = process_initializer(object, state)
+    _run(object, state)
+  end
+  alias call run
+
+  private
+
+    def process_initializer(object, state)
+      keep = @opts[:keep] || []
+      exclude = @opts[:except] || []
+
+      # Sanity check
+      raise ArgumentError.new('The option :keep must be an array.') unless keep.kind_of?(Array)
+
+      # Sanity check
+      raise ArgumentError.new('The option :except must be an array.') unless exclude.kind_of?(Array)
+
+      unless keep.empty?
+        # Ensure we only pick the keys that are in the input object.
+        keep.select { |k| object.has_key?(k) }.each do |k|
+          state[k] = object[k]
+        end
+      end
+
+      unless exclude.empty?
+        object.each do |k, v|
+          state[k] = k unless exclude.include?(v)
+        end
+      end
+
+      state
+    end
+
+    class Context
+      attr_reader :input, :value, :state
+      attr_writer :state
+
+      def initialize(input, state, value)
+        @input = input
+        @state = state
+        @value = value
+      end
+    end
+
+    class Input < Hashie::Mash
+      disable_warnings
+    end
+
+    def _run(input, state)
+      input = Input.new(input)
+
+      @mapper.each_key do |config|
+        name = config.name
+        source = config.source
+        then_block = config.then_block
+        create = config.create
+        allow_nil = config.allow_nil
+        merge = config.merge
+        if_key = config.if_key
+        value = config.value
+
+        # Skip the iteration if the if_key condition is not met.
+        next if if_key && if_key.all? { |k| input.key?(k) } == false
+
+        if merge
+          # TODO: test
+          next if source && !source.all? { |k| input.key?(k) }
+
+          # If the source has only one element, just take its value.
+          value = if source.size == 1
+                    input.send(source.first)
+                  elsif source.size > 1
+                    source.map { |k| input.send(k) }
+                  end
+
+          ctx = Context.new(input, state, value)
+
+          res = then_block.call(ctx)
+          state.merge!(res) if res.kind_of?(Hash)
+
+          next
+        # If the keys in the source are present OR key is creatable...
+        elsif source.any? { |k| input.key?(k) } && value.nil?
+          # If the source has only one element, just take its value.
+          value = if source.size == 1
+                    input.send(source.first)
+                  elsif source.size > 1
+                    source.map { |k| input.send(k) }
+                  end
+
+          ctx = Context.new(input, state, value)
+
+          # If there is a then_block, pass it the ctx. And assign its outcome
+          # to the key.
+          value = then_block.call(ctx) unless then_block.nil?
+        elsif create
+          ctx = Context.new(input, state, nil)
+
+          # if there is a then_block, pass it the ctx. And assign its outcome
+          # to the key.
+          value = then_block.call(ctx) unless then_block.nil?
+        end
+
+        # If the key is creatable or the value is non-nil,
+        # assign value to the key in the state.
+        state[name] = value if allow_nil || !value.nil?
+      end
+
+      state
+    end
+end

data/lib/hash-mapper/combinder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# see: http://djellemah.com/blog/2013/10/09/instance-eval-with-access-to-outside-scope/
+class Combinder < BasicObject
+  def initialize(obj, saved_binding)
+    @obj, @saved_binding = obj, saved_binding
+  end
+
+  def __bound_self__
+    @saved_binding.eval('self')
+  end
+
+  def method_missing(meth, *args, &blk)
+    # methods in dsl object are called in preference to self outside the block
+    if @obj.respond_to?(meth)
+      # dsl method, so call it
+      @obj.send meth, *args, &blk
+    else
+      __bound_self__.send meth, *args, &blk
+    end
+  end
+
+  def respond_to_missing?(meth, _include_all)
+    __bound_self__.respond_to?(meth) || @obj.respond_to?(meth)
+  end
+end

data/lib/hash-mapper/dsl.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative './combinder'
+
+class HashMapper
+  class Dsl
+    attr_reader :keys
+
+    def initialize(&block)
+      @keys = []
+      evaluate(&block) if block_given?
+    end
+
+    def each_key
+      @keys.each { |k| yield(k) }
+    end
+
+    def evaluate(&block)
+      case block.arity
+      when 0
+        Combinder.new(self, block.binding).instance_eval(&block)
+      when 1
+        yield self
+      else
+        raise "Too many args for block"
+      end
+    end
+
+    class Key
+      attr_reader *%i[name source create then_block merge allow_nil if_key value]
+
+      def initialize(name: nil, source: nil, create: nil, then_block: nil, merge: nil, allow_nil: nil, if_key: nil, value: nil)
+        @name = name
+        @source = source
+        @create = create
+        @then_block = then_block
+        @merge = merge
+        @allow_nil = allow_nil
+        @if_key = if_key
+        @value = value
+      end
+    end
+
+    def merge(*opts, &block)
+      hash_opts = opts.select { |v| v.kind_of?(Hash) }.inject(&:merge) || {}
+      source = hash_opts.fetch(:source) { [] }
+      then_block = block || hash_opts[:then]
+
+      # Normalize source
+      source =  case source
+                when Array
+                  source
+                when Symbol
+                  [source]
+                end
+
+      @keys.push Key.new(merge: true, then_block: then_block, source: source)
+    end
+
+    # opts -
+    #   source - Symbol | [Symbol]
+    #   create - Symbol
+    #   allow_nil - Symbol
+    #
+    def key(name, *opts)
+      hash_opts = opts.select { |v| v.kind_of?(Hash) }.inject(&:merge) || {}
+      source = hash_opts[:source]
+      then_block = hash_opts[:then]
+      value = hash_opts[:eq]
+      if_key = hash_opts.fetch(:if_key) { [] }
+      create = opts.empty? || opts.include?(:create) || opts.include?(:allow_nil)
+      allow_nil = opts.include?(:allow_nil)
+
+      # TODO: validate the option keys.
+
+      # Normalize source
+      source =  case source
+                when Array
+                  source
+                when Symbol
+                  [source]
+                else
+                  # Use the key as value source when source is missing
+                  [name]
+                end
+
+      # Normalize if_key
+      if_key =  case if_key
+                when Array
+                  if_key
+                when Symbol
+                  [if_key]
+                end
+
+      # -- Sanity check
+      raise ArgumentError.new("A :then block is required if a key has multiple sources.") if source.size > 1 && !then_block
+
+      @keys.push Key.new(
+        name: name,
+        source: source,
+        create: create,
+        allow_nil: allow_nil,
+        then_block: then_block,
+        if_key: if_key,
+        value: value
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: hash-mapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Volkan Unsal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Map a Ruby hash into another Ruby hash..
+email:
+- spocksplanet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- hash-mapper.gemspec
+- lib/hash-mapper.rb
+- lib/hash-mapper/combinder.rb
+- lib/hash-mapper/dsl.rb
+homepage: https://github.com/volkanunsal/hash-mapper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/volkanunsal/hash-mapper
+  source_code_uri: https://github.com/volkanunsal/hash-mapper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Map a Ruby hash into another Ruby hash..
+test_files: []