object_path 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e639630fbd749f814f4bb316676b307e74e2a1877c732e6bb861b8474ba86dc
-  data.tar.gz: 7049bab0d6b47ccce8449409e3e2a2967243c9c6183973541b637571a9cbf8db
+  metadata.gz: 73b11a2ea0353715c8934f80433bc5b5175d3f88781be4fbc2d3ce39a3ef8b56
+  data.tar.gz: f8fd262ce4e472dd1156afd5c579aa78c979d4dca5f4de4114699b261deae1fe
 SHA512:
-  metadata.gz: bca5a06ffc24a2aede49ea6f5792db68eb1e543394bb826d38462ba01598859c937cfae98872ff9535091287f3b435fe84f511a82de9265e974e43fcc9f928b2
-  data.tar.gz: 83e1d1519badebe66310c444cb485e6661ac83dbcf9422ed17f645b1146f4cfc5a1e4809236c03ea0b2591ef4d008383a1f3e1f03dfce82c58a4ae7d84c9aec3
+  metadata.gz: 7f7346b4b1252e7c9a8f79362dec99f4d83f00509b8b338106fb15a5fbec97d4c815105d913f237e1dd5014e36a5e8756963b1b357228913fe4940cc451a58c6
+  data.tar.gz: 0a25bf7d3d9d6e25730f134667d8d02ae282b055e2e07e4d66cca893ba1d0bd3ab1b330323b26494bcf2fc0daa1f6550bb111ee406e9ae86b45deb3cf7c394b3

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - "bin/**/*"
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/MultipleExpectations:
+  Max: 2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# Unreleased
+- No changes yet
+
+# 1.1.0 / 2025-06-08
+
+## Development
+
+- Converted testing to RSpec
+- Added RuboCop to the default rake task
+- Added RuboCop for rake
+- Added RuboCop for RSpec
+- Added module to provide helper methods for working with Object Paths
+  - Added class & instance methods for creating Object Paths
+  - Added method to directly resolve Object Paths against the current instance
+
 # 1.0.2 / 2024-09-18
 
 ## Documentation

data/README.md

@@ -103,3 +103,38 @@ require 'object_paths/object_path'
 ['address', 'street'].to_object_path
 %i[address street].to_object_path
 ```
+
+### Class/Module Support
+
+The +ObjectPaths::ModelSupport+ module can be included in a class or module to provide additional methods for working with Object Paths.  This includes the +object_path+ class & instance  methods which can be used to define a path witch a cleaner syntax than `ObjectPaths::ObjectPath.new`.
+
+```ruby
+require 'object_paths/model_support'
+class Address
+  include ObjectPaths::ModelSupport
+end
+
+Address.object_path('street') # => ObjectPaths::ObjectPath
+Address.new.object_path('street') # => ObjectPaths::ObjectPath
+```
+
+The resulting path object is not in anyway directly tied to the enclosing class.  The methods are just syntactic sugar for creating a new Object Path.
+
+The +object_path!+ method can be used to directly resolve the path against the current instance of the class or module.  This is useful for quickly resolving a path without having to create a new Object Path instance.
+
+```ruby
+require 'object_paths/model_support'
+
+class Address
+  include ObjectPaths::ModelSupport
+
+  attr_accessor :street
+
+  def initialize(street)
+    @street = street
+  end
+end
+
+address = Address.new('123 Main Street')
+address.object_path!('street') # => '123 Main Street'
+```

data/Rakefile

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-desc 'Run tests'
-task default: :test
+task default: %i[spec rubocop]

data/lib/object_paths/model_support.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'object_paths/object_path'
+
+module ObjectPaths
+  # Adds convenience & helper  methods to to models, classes and modules to ease the creation, use
+  # and resolution of ObjectPaths.
+  module ModelSupport
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Adds a convenience method to the object level for creating ObjectPaths.
+    #
+    # @param path_definition [String, Array] The path definition to convert into an ObjectPath.
+    # @return [ObjectPaths::ObjectPath] The created ObjectPath.
+    def object_path(path_definition)
+      ObjectPaths::ObjectPath.new(path_definition)
+    end
+
+    # Resolves the ObjectPath against the current object.
+    #
+    # @param path_definition [String, Array] The path definition to resolve.
+    # @return [Object, nil] The resolved object or nil if the path cannot be resolved.
+    def object_path!(path_definition)
+      object_path(path_definition)&.resolve(self)
+    end
+
+    # ClassMethods module provides class-level methods for ObjectPaths.
+    module ClassMethods
+      # Adds a convenience method to the class level for creating ObjectPaths.
+      #
+      # @param path_definition [String, Array] The path definition to convert into an ObjectPath.
+      # @return [ObjectPaths::ObjectPath] The created ObjectPath.
+      def object_path(path_definition)
+        ObjectPaths::ObjectPath.new(path_definition)
+      end
+    end
+  end
+end

data/lib/object_paths/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: object_path
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
-- Drew Thorp
+- drewthorp
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-09-18 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'
+date: 2025-06-08 00:00:00.000000000 Z
+dependencies: []
 description: Allow the creation of an object that holds the steps through an object
   graph to retrieve a value(s).
 email:
@@ -33,21 +19,27 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/array_object_path.rb
 - lib/object_paths/errors.rb
+- lib/object_paths/model_support.rb
 - lib/object_paths/object_path.rb
 - lib/object_paths/version.rb
 - lib/string_object_path.rb
-- object_path.gemspec
+- object_path.gemspec_old
 homepage: https://github.com/Fish-Fur/object_path
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/Fish-Fur/object_path
+  source_code_uri: https://github.com/Fish-Fur/object_path
+  changelog_uri: https://github.com/Fish-Fur/object_path
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -56,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile

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