property_string 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1599cc1dcb3a805c49f5d128df2d3c0a2a1d6de8d8f1348dba0e75a39d28827a
+  data.tar.gz: 4d62dcd17afbb2463114cb26a676b56ac25ea3f8da4adfdda0fadcdc5b7d48fb
+SHA512:
+  metadata.gz: 06d7eb0788c96fcd4a63d06f423b17568c1237f7070ffa19834cf4cde5036824d01da0cf5205dde497fb3e7f4bb5c75bd79bb5a92eb1cfadecbe69db32de82da
+  data.tar.gz: ab9f57a4adc63d312fc1acd376617e35ff170732174277ce85624a8563757202d600670a684cffe35d71e785500b662b9230135bfd71c4e89c0ab194080fa646

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in property_string.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Skye Shaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# PropertyString
+
+![PropertyString CI Status](https://github.com/sshaw/property_string/workflows/CI/badge.svg "PropertyString CI Status")
+
+Use Java-style property notation to execute method call chains on an object.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add property_string
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install property_string
+
+## Usage
+
+```rb
+# Object call chain
+product.company.name            # bar
+
+ps = PropertyString.new(product)
+ps["company.name"]              # bar
+
+# Object call chain with Array-like object
+user.posts[0].replied_to.name   # sshaw
+
+ps = PropertyString.new(user)
+ps["posts.0.replied_to.name"]       # sshaw
+
+# Method does not exist
+ps = PropertyString.new(product)
+ps["company.does_not_exist!"] # NoMethodError
+
+# Can work with a Hash
+h.dig(:some, "nested", :hash)   # foo
+
+ph = PropertyString(h)
+ph["some.nested.hash"]
+
+# Or an Array
+a[0][0][0]
+
+ph = PropertyString(a)
+ph["0.0.0"]
+
+# Ignore MethodMissing errors for unknown properties
+ps = PropertyString.new(product, :raise_if_method_missing => false)
+ps["company.does_not_exist!"] # nil
+
+# Fetching
+ps.fetch("posts.9999", "your default") # shaw
+ps.fetch("posts.9999") { |key| "some_default_for_#{key}" }
+```
+
+## See Also
+
+- [PropertyHash](https://github.com/sshaw/property_hash) - Access a nested Ruby Hash using Java-style properties as keys.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sshaw/property_string.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/property_string.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+class PropertyString
+  VERSION = "0.0.1"
+  KEY_NOT_FOUND = "__#{object_id}-not-found-placeholder-#{object_id}__"
+
+  def initialize(object, options = nil)
+    @object = object
+
+    @options = (options || {}).dup
+    @options[:raise_if_method_missing] = true unless @options.include?(:raise_if_method_missing)
+  end
+
+  def [](property)
+    value = fetch_property_chain(property)
+    value = nil if value == KEY_NOT_FOUND
+    value
+  end
+
+  def fetch(property, *default, &block)
+    fetch_default = -> do
+      raise KeyError, "property #{property} not found" unless default.any? || block_given?
+      block_given? ? block[property] : default[0]
+    end
+
+    value = nil
+
+    begin
+      value = fetch_property_chain(property)
+      return value unless value == KEY_NOT_FOUND
+    rescue NoMethodError => e
+      warn e if ENV["DEBUG"]
+      return fetch_default[]
+    end
+
+    fetch_default[]
+  end
+
+  def inspect
+    @object.inspect
+  end
+
+  private
+
+  def fetch_property_chain(property)
+    value = @object
+
+    chain = String(property).split(".")
+    chain.each do |prop|
+      value = prop.match?(/\A\d+\z/) ? find_index_value(value, prop) : find_non_index_value(value, prop)
+      break if value.nil? || value == KEY_NOT_FOUND
+    end
+
+    value
+  end
+
+  def find_non_index_value(value, prop)
+    if value.is_a?(Hash)
+      value = find_hash_value(value, prop)
+      value == KEY_NOT_FOUND ? nil : value
+    elsif @options[:raise_if_method_missing]
+      value.public_send(prop)
+    elsif value.respond_to?(prop)
+      value.public_send(prop)
+    end
+  end
+
+  def find_index_value(value, prop)
+    unless value.respond_to?(:[])
+      raise TypeError, "Cannot access index #{prop} on #{value.class}"
+    end
+
+    if !value.is_a?(Hash)
+      int_prop = prop.to_i
+      av = value[int_prop]
+      # Check if index even exists to determine if this should be a KEY_NOT_FOUND
+      return av if !av.nil? || !value.respond_to?(:size) || int_prop < value.size
+    else
+      hv = find_hash_value(value, prop)
+      return hv if hv != KEY_NOT_FOUND
+
+      int_index = prop.to_i
+      return value[int_index] if value.include?(int_index)
+    end
+
+    KEY_NOT_FOUND
+  end
+
+  def find_hash_value(hash, prop)
+    return hash[prop] if hash.include?(prop)
+
+    sym_prop = prop.to_sym
+    return hash[sym_prop] if hash.include?(sym_prop)
+
+    KEY_NOT_FOUND
+  end
+end

data/property_string.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/property_string"
+
+Gem::Specification.new do |spec|
+  spec.name = "property_string"
+  spec.version = PropertyString::VERSION
+  spec.authors = ["sshaw"]
+  spec.email = ["skye.shaw@gmail.com"]
+
+  spec.summary = "Use Java-style property notation to execute method call chains on an object."
+  spec.homepage = "https://github.com/sshaw/property_string"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: property_string
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sshaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/property_string.rb
+- property_string.gemspec
+homepage: https://github.com/sshaw/property_string
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/property_string
+  source_code_uri: https://github.com/sshaw/property_string
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Use Java-style property notation to execute method call chains on an object.
+test_files: []