attributes-mapper 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 895e84c722e2e5af0fa6b75967b76ef5c6a550aa62855549e3c037671ef90a36
-  data.tar.gz: '09914faa96f5420f3a29eac3a634b88185973b3f5022d932c4f50b3da33f4eee'
+  metadata.gz: b3f7da65f2ff2b70efa82e9d72635050aeddd9e23e16c7ce2e513111e25c5ff9
+  data.tar.gz: d6bd2568a29650daecc172f0eaca1ca1d2270c879e47630275e8b606d08a69e5
 SHA512:
-  metadata.gz: 6ca6e1a948e1861ac03d6b77be22c0237ee635c960444cb60f73219e37ce1d65cac1213e76b57fca80d50b595b1bfa3eda48dab6b7361f7410334cea799d090c
-  data.tar.gz: 2a2e0dae7ca0fdb3db436709361139f4c3af73454df35be8bedce48fd123f5108c7eeb1698186936f243beac1d00f7fc3d483e610d8f655fe8d75c6593329398
+  metadata.gz: 0e9c2757c99792f0509d48c7bc77852c146f5d2de81ce4ff3601b368f53f5f61800d1a8890260b4f896079203da844c5c84361e33d6a843c4b85f118010aec4a
+  data.tar.gz: 2b6f2a6eff2c7b8a3b824c35f624ff8448687ce15884611d9630a2f0b385271217470343e792c8cec0490b6e7dc72e4fdafacf98a4cbceb3e1ef83610fbd4f44

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/attributes-mapper.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.metadata["source_code_uri"] = gem.homepage
   gem.metadata["changelog_uri"] = "#{gem.homepage}/CHANGELOG.md"
 
-  gem.add_runtime_dependency 'json-path-builder', '~> 0.1.0'
+  gem.add_runtime_dependency 'json-path-builder', '~> 0.1.7'
   gem.add_runtime_dependency 'rordash', '~> 0.1.2'
 
   gem.add_development_dependency("codecov", "~> 0.6.0")

data/dev/setup.rb

@@ -12,6 +12,6 @@ require 'active_support/core_ext/enumerable'
 require 'active_support/configurable'
 require 'rudash'
 
-%w[../../lib/attributes_mapper ../../spec/spec_helper].each do |rel_path|
+%w[../../lib/attributes-mapper ../../spec/spec_helper].each do |rel_path|
   require File.expand_path(rel_path, Pathname.new(__FILE__).realpath)
 end

data/lib/attributes-mapper/version.rb

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

data/lib/attributes-mapper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rordash'
+require 'json-path-builder'
+
+require 'attributes-mapper/version'
+require 'attributes-mapper/configuration'
+require 'attributes-mapper/has_attributes'
+require 'attributes-mapper/builder'
+
+module AttributesMapper; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributes-mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Desmond O'Leary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-path-builder
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: rordash
   requirement: !ruby/object:Gem::Requirement
@@ -117,16 +117,16 @@ files:
 - bin/rubocop
 - bin/setup
 - dev/setup.rb
+- lib/attributes-mapper.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
+- spec/attributes-mapper_spec.rb
 - spec/coverage_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/omnitech-solutions/attributes-mapper
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Declarative attributes mapping

data/lib/attributes_mapper.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-module AttributesMapper; end