json-path-builder 0.1.0

data/spec/json-path/builder_spec.rb

@@ -0,0 +1,168 @@
+module JsonPath
+  RSpec.describe Builder do
+    let(:key) { "some-value" }
+    let(:other_key) { "some-other-value" }
+    let(:list) { %w[some-list-value-1 some-list-value-2] }
+
+    let(:input) { { key: key, other_key: other_key, list: list }.as_json }
+
+    subject(:instance) { described_class.new }
+
+    describe '.from' do
+      it 'handles simple path mapping' do
+        %i[key other_key].each { |k| instance.from(k) }
+
+        expect(instance.build_for(input)).to eql({ key: key, other_key: other_key })
+      end
+
+      it 'handles renaming path name' do
+        instance.from(:other_key, to: :another_key)
+
+        expect(instance.build_for(input)).to eql({ another_key: other_key })
+      end
+
+      it 'handles transformations' do
+        instance.from(:key, transform: proc { |v| v.upcase })
+
+        expect(instance.build_for(input)).to eql({ key: key.upcase })
+      end
+    end
+
+    describe '.from_each' do
+      it 'handles simple path mapping' do
+        instance.from_each(:list)
+
+        expect(instance.build_for(input)).to eql({ list: list })
+      end
+
+      it 'handles renaming path name' do
+        instance.from(:list, to: :another_list_key)
+
+        expect(instance.build_for(input)).to eql({ another_list_key: list })
+      end
+
+      it 'handles transformations' do
+        instance.from_each(:list, transform: proc { |v| v.upcase })
+
+        expect(instance.build_for(input)).to eql({ list: list.map(&:upcase) })
+      end
+
+      it 'handles skipping items' do
+        instance.from_each(:list, skip_if: proc { |v| v == 'some-list-value-1' })
+
+        expect(instance.build_for(input)).to eql({ list: ['some-list-value-2'] })
+      end
+    end
+
+    describe '#within' do
+      let(:email) { 'email@domain.com' }
+      let(:user_id) { 1 }
+      let(:input) { { root: { deep: { profile: { email: email, uid: user_id } } } }.as_json }
+
+      it 'uses scope to simplify dot notation' do
+        builder = described_class.new
+        builder.within('root.deep.profile') do |b|
+          b.from(:email)
+          b.from(:uid, to: :user_id)
+        end
+
+        expect(builder.build_for(input)).to eql({ email: email, user_id: user_id })
+      end
+    end
+
+    describe '#with_wrapped_data_class' do
+      let(:email) { 'email@domain.com' }
+      let(:user_id) { 123 }
+      let(:input) { { profile: { email: email } }.as_json }
+      let(:user) { double(:user, id: user_id) }
+      let(:user_repo) { double(:user_repo, find_by: user) }
+
+      let(:wrapped_data_class) do
+        Class.new(SimpleDelegator) do
+          class << self
+            attr_accessor :user_repo
+          end
+
+          def user
+            self.class.user_repo.find_by(email: dig('profile', 'email'))
+          end
+        end
+      end
+
+      before do
+        wrapped_data_class.user_repo = user_repo
+      end
+
+      it 'wraps input data in wrapped class' do
+        builder = described_class.new
+        builder.with_wrapped_data_class(wrapped_data_class)
+        transform = proc do |_email, path_context|
+          path_context.wrapped_source_data.user.id
+        end
+
+        builder.from('profile.email', to: :user_id, transform: transform)
+        expect(builder.build_for(input)).to eql({ user_id: user_id })
+      end
+    end
+
+    describe '#wrapped_data_class' do
+      context 'with custom data class' do
+        let(:wrapper_class) { Class.new(DefaultDataWrapper) }
+
+        it 'returns custom class' do
+          instance.with_wrapped_data_class(wrapper_class)
+
+          expect(instance.data_wrapper_class).to eql(wrapper_class)
+        end
+      end
+
+      context 'without custom data class' do
+        let(:custom_wrapper) { nil }
+
+        it 'returns default class' do
+          expect(instance.data_wrapper_class).to eql(DefaultDataWrapper)
+        end
+      end
+    end
+
+    # describe PathsBuilder::PathContext do
+    #   let(:key) { "some-value" }
+    #   let(:other_key) { "some-other-value" }
+    #   let(:list) { %w[some-list-value-1 some-list-value-2] }
+    #
+    #   let(:input) { { key: key, other_key: other_key, list: list }.as_json }
+    #   let(:builder) { PathsBuilder.new }
+    #   let(:path_context) { builder.path_context_collection.first }
+    #
+    #   before(:each) do
+    #     builder.from(:key, to: :another_key, transform: proc { |val| val.upcase })
+    #     builder.with_source_data(input)
+    #   end
+    #
+    #
+    #   it 'returns path context instance' do
+    #     expect(path_context).to be_instance_of(described_class)
+    #   end
+    #
+    #   describe '#wrapped_source_data' do
+    #     subject { path_context.wrapped_source_data }
+    #
+    #     context 'with custom data class' do
+    #       let(:wrapper_class) { Sharplaunch::PropertyListingDataWrapper }
+    #
+    #       before(:each) { builder.with_wrapped_data_class(wrapper_class) }
+    #
+    #       it 'returns custom class' do
+    #         expect(subject).to be_an_instance_of(wrapper_class)
+    #       end
+    #     end
+    #
+    #     context 'without custom data wrapper class' do
+    #       it 'returns default wrapper instance' do
+    #         expect(subject).to be_instance_of(PathsBuilder::DefaultDataWrapper)
+    #       end
+    #     end
+    #   end
+    # end
+  end
+end

data/spec/json-path/default_data_wrapper_spec.rb

@@ -0,0 +1,33 @@
+module JsonPath
+  RSpec.describe DefaultDataWrapper do
+    describe '#[]' do
+      context 'when the wrapped object is a hash with string keys' do
+        let(:data) { { 'name' => 'John', 'age' => 30 } }
+        let(:wrapper) { described_class.new(data) }
+
+        it 'returns the value associated with the symbol key' do
+          expect(wrapper[:name]).to eq('John')
+          expect(wrapper[:age]).to eq(30)
+        end
+
+        it 'does not modify the original hash' do
+          expect { wrapper[:name] }.not_to(change { data })
+        end
+      end
+
+      context 'when the wrapped object is a hash with symbol keys' do
+        let(:data) { { name: 'John', age: 30 } }
+        let(:wrapper) { described_class.new(data) }
+
+        it 'returns the value associated with the symbol key' do
+          expect(wrapper[:name]).to eq('John')
+          expect(wrapper[:age]).to eq(30)
+        end
+
+        it 'does not modify the original hash' do
+          expect { wrapper[:name] }.not_to(change { data })
+        end
+      end
+    end
+  end
+end

data/spec/json-path/path_context_collection_spec.rb

@@ -0,0 +1,46 @@
+module JsonPath
+  # rubocop:disable Layout/LineLength,RSpec/MessageSpies,RSpec/StubbedMock
+  RSpec.describe PathContextCollection do
+    describe '#reject_from_paths!' do
+      let(:path_context1) { instance_double(PathContext, from: 'path1') }
+      let(:path_context2) { instance_double(PathContext, from: 'path2') }
+      let(:path_context3) { instance_double(PathContext, from: 'path3') }
+
+      it 'removes elements from the collection with matching from paths' do
+        collection = described_class.new([])
+        collection.push(path_context1, path_context2, path_context3)
+
+        collection.reject_from_paths!(%w[path1 path3])
+
+        expect(collection).to include(path_context2)
+        expect(collection).not_to include(path_context1, path_context3)
+      end
+    end
+
+    describe '#add_path' do
+      let(:paths_builder) { instance_double(Builder) }
+      let(:iterable_data) { true }
+      let(:transform) { proc { |data| data.upcase } }
+      let(:defaults) { { foo: 'bar' } }
+      let(:fallback_proc) { proc { 'fallback' } }
+      let(:skip_if_proc) { proc { |data| data.nil? } }
+      let(:path_context) { instance_double(PathContext) }
+
+      before do
+        allow(PathContext).to receive(:new).and_return(path_context)
+      end
+
+      it 'adds a new PathContext object to the collection' do
+        collection = described_class.new([])
+        expect(PathContext).to receive(:new).with('path', paths_builder, to: nil, iterable_data: iterable_data,
+                                                                         transform: transform, use_builder: true, defaults: defaults, fallback_proc: fallback_proc, skip_if_proc: skip_if_proc).and_return(path_context)
+
+        result = collection.add_path('path', paths_builder, iterable_data: iterable_data, transform: transform,
+                                                            defaults: defaults, fallback_proc: fallback_proc, skip_if_proc: skip_if_proc)
+
+        expect(result).to include(path_context)
+      end
+    end
+  end
+  # rubocop:enable Layout/LineLength,RSpec/MessageSpies,RSpec/StubbedMock
+end

data/spec/json-path/path_context_spec.rb

@@ -0,0 +1,90 @@
+module JsonPath
+  RSpec.describe PathContext do
+    let(:builder) { double("PathsBuilder", nested_paths: []) }
+    let(:data) { { foo: "bar" } }
+    let(:transform) { :iso8601 }
+    let(:json_path) { "foo" }
+    let(:defaults) { nil }
+    let(:path_context) do
+      described_class.new(json_path, builder, iterable_data: false, transform: transform, use_builder: false,
+                                              defaults: defaults, fallback_proc: nil, skip_if_proc: nil)
+    end
+
+    describe "#initialize" do
+      context "when json_path is blank" do
+        let(:json_path) { '   ' }
+
+        it "raises an ArgumentError" do
+          expect { path_context }.to raise_error(ArgumentError, "`from` must be filled")
+        end
+      end
+
+      context "when transform is not a symbol or a valid transform key" do
+        let(:transform) { "not_a_symbol_or_valid_transform" }
+
+        it "raises an ArgumentError" do
+          expect do
+            path_context
+          end.to raise_error(ArgumentError,
+                             "`transform`: 'not_a_symbol_or_valid_transform' must be one of [:iso8601, :date]")
+        end
+      end
+    end
+
+    describe "#parent" do
+      context "when the builder has a parent_path_context" do
+        let(:parent_path_context) { double("PathContext") }
+
+        before { allow(builder).to receive(:parent_path_context).and_return(parent_path_context) }
+
+        it "returns the parent_path_context" do
+          expect(path_context.parent).to eq(parent_path_context)
+        end
+      end
+
+      context "when the builder does not have a parent_path_context" do
+        before { allow(builder).to receive(:parent_path_context).and_return(nil) }
+
+        it "returns nil" do
+          expect(path_context.parent).to be_nil
+        end
+      end
+    end
+
+    describe "#defaults?" do
+      context "when defaults is an empty hash" do
+        let(:defaults) { {} }
+
+        it "returns false" do
+          expect(path_context.defaults?).to be false
+        end
+      end
+
+      context "when defaults is a non-empty hash" do
+        let(:defaults) { { baz: "qux" } }
+
+        it "returns true" do
+          expect(path_context.defaults?).to be true
+        end
+      end
+    end
+
+    describe "#transformable?" do
+      context "when transform is a Proc" do
+        let(:transform) { ->(val) { val.to_s.upcase } }
+
+        it "returns true" do
+          expect(path_context.transformable?).to be true
+        end
+      end
+
+      context "when transform is not a Proc" do
+        let(:transform) { nil }
+
+        it "returns false" do
+          expect(path_context.transformable?).to be false
+        end
+      end
+    end
+  end
+end

data/spec/json_path_builder_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe JsonPathBuilder do
+  it "has a version number" do
+    expect(JsonPathBuilder::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require File.join(__dir__, "..", 'dev', 'setup')
+require Pathname.new(__dir__).realpath.join('coverage_helper').to_s
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: json-path-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Desmond O'Leary
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rordash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: Declarative mapping JSON/Hash data structures
+email:
+- desoleary@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- dev/setup.rb
+- json_path_builder.gemspec
+- lib/json-path/builder.rb
+- lib/json-path/default_data_wrapper.rb
+- lib/json-path/path_context.rb
+- lib/json-path/path_context_collection.rb
+- lib/json-path/version.rb
+- lib/json_path.rb
+- sig/json_path_builder.rbs
+- spec/coverage_helper.rb
+- spec/json-path/builder_spec.rb
+- spec/json-path/default_data_wrapper_spec.rb
+- spec/json-path/path_context_collection_spec.rb
+- spec/json-path/path_context_spec.rb
+- spec/json_path_builder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/omnitech-solutions/json-path-builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/omnitech-solutions/json-path-builder
+  source_code_uri: https://github.com/omnitech-solutions/json-path-builder
+  changelog_uri: https://github.com/omnitech-solutions/json-path-builder/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Declarative mapping JSON/Hash data structures
+test_files: []