attributes-mapper 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7374884ab90c0b7fca54225029a9d03a1e1c63774317a334bda4e141c3dc9d0
-  data.tar.gz: f14efe5a80d9c8db745593bfd462ee4db268b1b5c0e4b10b513bd181086652e0
+  metadata.gz: 4de21050a409102a97ed7a57ad9a4e3e407ae1c9236ee12bcf56ba065df09674
+  data.tar.gz: aa2537d23e5d13baa679133e50d046992a2a31a2b5abdd3ebad5ec1be5b6e745
 SHA512:
-  metadata.gz: 20c7c98145f99ae436ed07174c87cf145b3b8b86d8430c8e274bdebcbc15df0b11f74574b8b81c0c1646e299f3b2176691202bcd368f92b8e41a2c024740ee6d
-  data.tar.gz: 6431ea10562ce748be42951d94b59c13d8aba8eddf7ca97ce6a4bdb6ea46d726a2961031dc52bca748b329cc06a857ee4785bca9f882b2a606b27cafb85a51e0
+  metadata.gz: 804ff034798b639ba1c8cc522df79ecdfafa4403ef4fd320c626db053367d6da846dceecc56449197b20fda7cc6dda1b00fbc91e6cdf230c0804ea0ff757d9ca
+  data.tar.gz: 4aadd98e8b6d7e7caaaf4a741eb59231612770a733408d9a98ee064bc561d00d3c50ffc6ba2c723277d64d017f831c4fe5dcf26df8a5c3d2be84a14fc7e426b2

data/README.md

@@ -1,8 +1,9 @@
 # AttributesMapper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/attributes/mapper`. To experiment with that code, run `bin/console` for an interactive prompt.
+Builds upon `[json-path-builder](https://github.com/omnitech-solutions/json-path-builder)` to deliver a highly declarative and dynamic mapping of JSON/Hash Attributes
 
-TODO: Delete this and the text above, and describe your gem
+## Console
+run `irb -r ./dev/setup` for an interactive prompt.
 
 ## Installation
 
@@ -22,7 +23,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class UserAttributesMapper < AttributesMapper::Builder
+  configure do |config|
+    config.required_attributes = %i[name email]
+    config.optional_attributes = %i[age key]
+    config.scopes = { profile: 'user.profile', info: 'user.info' }
+  end
+
+  name { { from: :username, scope: :profile } } # corresponds to path `user.profile.username`
+  email { { from: :email, scope: :profile } } # corresponds to path `user.profile.email`
+  age { { from: :age, scope: :info } } # corresponds to path `user.info.age`
+  key { { from: :key } } # corresponds to path `key`
+end
+
+input = { user:
+            { profile:
+                {
+                  username: 'Joe Bloggs',
+                  email: 'joe@email.com'
+                },
+              info: {
+
+                age: 23
+              }
+            },
+          key: 'some-value'
+}
+
+builder = UserAttributesMapper.new(input).build
+builder.to_h #=> { name: 'Joe Bloggs', email: 'joe@email.com', age: 23, key: 'some-value' }
+```
 
 ## Development
 

data/dev/setup.rb

@@ -10,6 +10,7 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/json'
 require 'active_support/core_ext/enumerable'
 require 'active_support/configurable'
+require 'rudash'
 
 %w[../../lib/attributes_mapper ../../spec/spec_helper].each do |rel_path|
   require File.expand_path(rel_path, Pathname.new(__FILE__).realpath)

data/lib/attributes-mapper/builder.rb

@@ -0,0 +1,67 @@
+module AttributesMapper
+  class Builder
+    include HasAttributes
+
+    attr_reader :input
+
+    def initialize(input)
+      transformed_input = if configuration.apply_input_data_transform?
+                            configuration.apply_input_data_transform_proc.call(input)
+                          else
+                            input
+                          end
+
+      @input = Rordash::HashUtil.deep_symbolize_keys(transformed_input)
+      @mapped_input = {}
+    end
+
+    def build
+      @mapped_input = paths_builder.build_for(input).deep_symbolize_keys
+      self
+    end
+
+    def to_h
+      @mapped_input
+    end
+
+    def paths_builder
+      @paths_builder ||= begin
+        builder = JsonPath::Builder.new
+        if configuration.source_data_wrapper_class?
+          builder.with_wrapped_data_class(configuration.source_data_wrapper_class)
+        end
+        add_paths_to_builder(builder)
+        builder
+      end
+    end
+
+    private
+
+    def add_paths_to_builder(builder)
+      self.class.each_path_context_key_value_pair do |to, path_attrs|
+        params = path_attrs.merge(to: to)
+
+        if params.key?(SCOPE)
+          scope_path = self.class.find_path_by_scope_name(params[SCOPE])
+          builder.within(scope_path) { add_path_to_builder(builder, params) }
+        else
+          add_path_to_builder(builder, params)
+        end
+      end
+    end
+
+    def add_path_to_builder(builder, path_params)
+      builder.from(path_params[:from], **path_params.except(:from, SCOPE))
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      return @mapped_input[method_name] if @mapped_input.key?(method_name)
+
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @mapped_input.key?(method_name) || super
+    end
+  end
+end

data/lib/attributes-mapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AttributesMapper
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/attributes_mapper.rb

@@ -2,11 +2,15 @@
 
 require 'rordash'
 require 'json-path/builder'
+require 'json-path/default_data_wrapper'
+require 'json-path/path_context'
+require 'json-path/path_context_collection'
 
 %w[
   version
   configuration
   has_attributes
+  builder
 ].each do |filename|
   require File.expand_path("../attributes-mapper/#{filename}", Pathname.new(__FILE__).realpath)
 end

data/spec/attributes-mapper/builder_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module AttributesMapper
+  RSpec.describe Builder do
+    let(:subject_class) do
+      Class.new(described_class) do
+        configure do |config|
+          config.required_attributes = %i[name email]
+          config.optional_attributes = %i[age key]
+          config.scopes = { profile: 'user.profile', info: 'user.info' }
+        end
+
+        name { { from: :username, scope: :profile } }
+        email { { from: :email, scope: :profile } }
+        age { { from: :age, scope: :info } }
+        key { { from: :key } }
+      end
+    end
+
+    let(:name) { 'Joe Bloggs' }
+    let(:email) { 'joe@email.com' }
+    let(:age) { 23 }
+    let(:value) { 'some-value' }
+    let(:input) { { user: { profile: { username: name, email: email }, info: { age: age } }, key: value } }
+
+    subject(:built_builder) { subject_class.new(input).build }
+
+    describe '#build' do
+      it 'handles simple mappings' do
+        expect(built_builder.key).to eql(value)
+      end
+
+      it 'handle nested paths via declared scopes' do
+        expect(built_builder.name).to eql(name)
+        expect(built_builder.email).to eql(email)
+        expect(built_builder.age).to eql(age)
+      end
+    end
+
+    describe '#to_h' do
+      it 'maps input to the specified paths' do
+        expect(built_builder.to_h).to eq({ name: name, email: email, age: age, key: value })
+      end
+    end
+
+    describe '#method_missing' do
+      it 'returns the value of a mapped key' do
+        expect(built_builder.key).to eq(value)
+      end
+
+      it 'raises an error when the key does not exist' do
+        expect { built_builder.baz }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe '#respond_to_missing?' do
+      it 'returns true when the key exists' do
+        expect(built_builder.respond_to?(:name)).to be true
+      end
+
+      it 'returns false when the key does not exist' do
+        expect(built_builder.respond_to?(:baz)).to be false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributes-mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Desmond O'Leary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-path-builder
@@ -117,11 +117,13 @@ files:
 - bin/rubocop
 - bin/setup
 - dev/setup.rb
+- lib/attributes-mapper/builder.rb
 - lib/attributes-mapper/configuration.rb
 - lib/attributes-mapper/has_attributes.rb
 - lib/attributes-mapper/version.rb
 - lib/attributes_mapper.rb
 - sig/attributes/mapper.rbs
+- spec/attributes-mapper/builder_spec.rb
 - spec/attributes-mapper/configuration_spec.rb
 - spec/attributes-mapper/has_attributes_spec.rb
 - spec/attributes_mapper_spec.rb