object_path 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 689740f5af00dc47ec9bfc6c7c6ca71193ce946578332438b2a5b83eb15fc992
+  data.tar.gz: '0791a5679cad9f5e1868cb9dcbe64e4b410213720c50a3af995dc9bfdd3d433c'
+SHA512:
+  metadata.gz: 86c6891047d3847c65d394add6f48579bf964113072c6bb12fa72e55d5d4a370ea207f36eddf3eb30165100d2add7d472831c2c3a82576a49f034ea999f7ce81
+  data.tar.gz: 0f9b2744025f83e80d75566da8db651d884fa1a0d2f29fcdb6ccf8c8debeb39d7a9a333cdf6da7c6775fe074b36dbb7b79b8a8469be40443404643e6670640e9

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,95 @@
+# Object Path Resolver
+
+Ruby class representing an path through an object graph.  Instance of the +ObjectPath+ class can be used to navigate through an object graph and the value(s) in the final step of the path are returned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'object_path'
+```
+
+And then execute:
+```
+bundle install
+```
+
+Or install it yourself as:
+```
+gem install object_path
+```
+
+## Usage
+
+Paths are defined as a set of steps.  These can be declared in a number of ways :-
+
+- As a +String+ with each step separated by a '/' delimiter.
+- As an array of +Strings+.
+- As an array of +Symbols+.
+- As an existing +ObjectPaths::ObjectPath+
+
+```ruby
+require 'object_paths/object_path'
+
+path = ObjectPaths::ObjectPath.new('address/street')
+path = ObjectPaths::ObjectPath.new(['address', 'street'])
+path = ObjectPaths::ObjectPath.new([:address, :street])
+path = ObjectPaths::ObjectPath.new(ObjectPaths::ObjectPath.new('address/street'))
+```
+
+The path can then be used to navigate through an object graph :-
+
+```ruby
+require 'object_paths/object_path'
+
+class Address
+  attr_accessor :street
+end
+
+class Person
+  attr_accessor :address
+end
+
+address1 = Address.new
+address1.street = '123 Main Street'
+
+address2 = Address.new
+address2.street = '456 High Street'
+
+person1 = Person.new
+person1.address = address1
+
+person2 = Person.new
+person2.address = address2
+
+path.resolve(person1) # => '123 Main Street'
+path.resolve(person2) # => '456 High Street'
+```
+
+If any step on the path is +Enumerable+ then the following steps with be resolved for each item and an +Array+ of results will be returned.  If multiple steps are +Enumerable+ then the process will be repeated for each item.  The resulting nested +Array+ will be flattened to a single +Array+. All +Array+ results are also comapected :-
+
+```ruby
+require 'object_paths/object_path'
+
+class Address
+  attr_accessor :street
+end
+
+class Person
+  attr_accessor :addresses
+end
+
+address1 = Address.new
+address1.street = '123 Main Street'
+address2 = Address.new
+address2.street = '456 High Street'
+
+person = Person.new
+person.addresses = [address1, address2]
+
+path = ObjectPaths::ObjectPath.new('addresses/street')
+path.resolve(person) # => ['123 Main Street', '456 High Street']
+```
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/array_object_path.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Extends the Array class to include a method that converts an array to an ObjectPath
+class Array
+  # Converts an array to an ObjectPath
+  #
+  # +Returns_ (ObjectPaths::ObjectPath) = the ObjectPath representation of the array
+  #
+  # Example:
+  #   %w[sub_model the_answer].to_object_path
+  #   # => #<ObjectPaths::ObjectPath:0x00007f8f9b0b3b08 @path_steps=["sub_model", "the_answer"]>
+  #
+  # _See_ *ObjectPaths::ObjectPath*
+  def to_object_path
+    ObjectPaths::ObjectPath.new(self)
+  end
+end

data/lib/object_paths/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ObjectPaths
+  module Errors
+    class IllegalObjectPathDefinitionType < StandardError
+    end
+  end
+end

data/lib/object_paths/object_path.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require_relative 'errors'
+require 'string_object_path'
+require 'array_object_path'
+
+module ObjectPaths
+  # = Object \Graph \Resolver
+  #
+  # Represents a path to a value in an object graph.  The steps in the path can be attributes,
+  # methods, or associations.  The path can be resolved to get the value(s) at the end of the path.
+  # If any step in the path is nil, the path resolves to nil.  If the step results in an array, the
+  # next step is applied to each element of the array, and the results are flattened.
+  #
+  # When initializing a ObjectPath, the path can be defined as an array of strings or symbols, a string
+  # with the steps separated by slashes, or another ObjectPath.
+  #
+  # To resolve a ObjectPath, call the resolve method with the root object to start from.  The result
+  # will be the value at the end of the path, or an array of values if the path resolves to an array.
+  #
+  # Example:
+  #  class Person
+  #    attr_accessor :name, :address
+  #  end
+  #
+  #  class Address
+  #    attr_accessor :street, :city
+  #  end
+  #
+  #  person = Person.new
+  #  person.name = 'John Doe'
+  #  address = Address.new
+  #  address.street = '123 Main St'
+  #  address.city = 'Anytown'
+  #  person.address = address
+  #
+  #  path = ObjectPaths::ObjectPath.new(%i[address city])
+  #  path.resolve(person) # => 'Anytown'
+  #
+  #  path = ObjectPaths::ObjectPath.new('address/city')
+  #  path.resolve(person) # => 'Anytown'
+  #
+  #  path = ObjectPaths::ObjectPath.new('address/name')
+  #  path.resolve(person) # => nil
+  class ObjectPath
+    attr_reader :path_steps
+
+    # Initializes a ObjectPath with a path definition.  The path definition can be an array of strings or
+    # symbols, a string with the steps separated by slashes, or another ObjectPath.
+    #
+    # Arguments:
+    #   +path_definition+ (Array, String, ObjectPath) - The definition of the path.
+    def initialize(path_definition)
+      case path_definition
+      when Array
+        @path_steps = path_definition.map(&:to_s)
+      when String
+        @path_steps = path_definition.split('/')
+      when ObjectPath
+        @path_steps = path_definition.path_steps
+      else
+        raise ObjectPaths::Errors::IllegalObjectPathDefinitionType
+      end
+    end
+
+    # Resolves the path to the value(s) at the end of the path.  If any step in the path is nil, the
+    # path resolves to nil.  If the step results in an array, the next step is applied to each
+    # element of the array, and the results are flattened.
+    #
+    # Arguments:
+    #   +object+ (Object) - The object to start resolving the path from.
+    #
+    # _Returns_ (Object) - The value at the end of the path, or an array of values if the path
+    # resolves to an array.
+    def resolve(object)
+      resolve_step(object, path_steps)
+    end
+
+    # Returns a human readable representation of the path.  The steps in the path are converted to
+    # human readable attribute names using the human_attribute_name method of the class.
+    #
+    # +klass+ (Class) - The class to use for humanizing the attribute names.
+    #
+    # _Returns_ (String) - The human readable representation of the path.
+    def human(klass)
+      path_steps.map do |step|
+        readable_attribute_name(klass, step)
+      end.join(' > ')
+    end
+
+    private
+
+    # Returns a human readable representation of an attribute name.  If the class does not respond
+    # to human_attribute_name, the attribute name is returned as a string.
+    #
+    # +klass+ (Class) - The class to use for humanizing the attribute names.
+    # +attribute+ (String) - The attribute name to humanize.
+    #
+    # _Returns_ (String) - The human readable representation of the attribute name.
+    def readable_attribute_name(klass, attribute)
+      return attribute.to_s unless klass.respond_to?(:human_attribute_name)
+
+      klass.human_attribute_name(attribute)
+    end
+
+    # Resolves a step in the path.  If the object does not respond to the method or attribute in the
+    # step, the path resolves to nil.  If the result of the step is an array, the next step is
+    # applied to each element of the array, and the results are flattened.
+    #
+    # +object+ (Object) - The object to resolve the step on.
+    # +sub_path+ (Array) - The remaining steps in the path to resolve.
+    #
+    # _Returns_ (Object) - The value at the end of the path, or an array of values if the path
+    # resolves to an array.
+    def resolve_step(object, sub_path)
+      return nil unless object.respond_to?(sub_path.first)
+
+      result = object.send(sub_path.first)
+      sub_path = sub_path.drop(1)
+      return result if result.nil? || sub_path.empty?
+
+      return resolve_step(result, sub_path) unless result.is_a?(Enumerable)
+
+      resolve_collection_step(result, sub_path)
+    end
+
+    # Resolves a step in the path when the result of the step is an array.  The next step is applied
+    # to each element of the array, and the results are flattened.
+    #
+    # +object+ (Object) - The array to resolve the step on.
+    # +sub_path+ (Array) - The remaining steps in the path to resolve.
+    #
+    # _Returns_ (Array) - The array of values at the end of the path.
+    def resolve_collection_step(object, sub_path)
+      return unless object.is_a?(Enumerable)
+
+      result = object.map { |item| resolve_step(item, sub_path) }.flatten.compact
+      result.empty? ? [] : result
+    end
+  end
+end

data/lib/object_paths/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ObjectPaths
+  VERSION = '1.0.1'
+end

data/lib/string_object_path.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Extends the String class to include a method that converts a string to an ObjectPath
+class String
+  # Converts a string to an ObjectPath
+  #
+  # +Returns_ (ObjectPaths::ObjectPath) = the ObjectPath representation of the string
+  #
+  # Example:
+  #  'sub_model/the_answer'.to_object_path
+  #  # => #<ObjectPaths::ObjectPath:0x00007f8f9b0b3b08 @path_steps=["sub_model", "the_answer"]>
+  #
+  # _See_ *ObjectPaths::ObjectPath*
+  def to_object_path
+    ObjectPaths::ObjectPath.new(self)
+  end
+end

data/object_path.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/object_paths/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'object_path'
+  spec.version               = ObjectPaths::VERSION
+  spec.authors               = ['Drew Thorp']
+  spec.email                 = ['gems@fishfur.com']
+  spec.summary               = 'Object representing a path through an object graph.'
+  spec.description           = 'Allow the creation of an object that holds the steps through an ' \
+                               'object graph to retrieve a value(s).'
+  spec.homepage              = 'https://github.com/Fish-Fur/object_path'
+  spec.license               = 'Apache-2.0'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 3.3.0'
+  spec.files = Dir[
+    'README.md', 'LICENSE',
+    'CHANGELOG.md', 'lib/**/*.rb',
+    'lib/**/*.rake',
+    'object_path.gemspec', '.github/*.md',
+    'Gemfile', 'Rakefile'
+  ]
+  spec.extra_rdoc_files = ['README.md']
+  spec.add_development_dependency 'rubocop', '~> 1.6'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: object_path
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Drew Thorp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Allow the creation of an object that holds the steps through an object
+  graph to retrieve a value(s).
+email:
+- gems@fishfur.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/array_object_path.rb
+- lib/object_paths/errors.rb
+- lib/object_paths/object_path.rb
+- lib/object_paths/version.rb
+- lib/string_object_path.rb
+- object_path.gemspec
+homepage: https://github.com/Fish-Fur/object_path
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Object representing a path through an object graph.
+test_files: []