ryo.rb 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae979c4fc47c5c25d26b0c215807a7ebd867dc5abd596277dda692c36c5c3445
-  data.tar.gz: 3cf89103180d9d6280698b93520eb80dc9af2e3ff4cbebb84c54b1089bed12e6
+  metadata.gz: fbd00dab052b65ba426cdaa4ac900adc2daca2e23d1cbe5919a19e31bce30e45
+  data.tar.gz: 6757fd8be13568acb58fa6e0e5ec3ff395ab56bb14354dd6bbd024665998ff1d
 SHA512:
-  metadata.gz: 795a2ab471038483d47fa39103996ec756da3437098b27091bb3b6e1f6534202ebc508e33f8d38bda4dfee8ae835465947da0c8adb2c13805480f13b4f54f4fe
-  data.tar.gz: edd4fd919629134e9479a91469084dbbdaf5507ce6aef91b7e1779720bff76ad1aec675dd31de42a05c7a8375d4c0ca27ce5aba260059b18fa526ec755bc7a0a
+  metadata.gz: 13896d019d82fdb27003ead6dd60a34a8f2c09efb2aa018b74f520d8dbc5c79e775d5637ba66e715089221aad160dc7a00477cd0a908777ed9e5098c8eccf552
+  data.tar.gz: 3bfc72a7632226f9b67899045869fbec25a505276d5d595c5f13dc7a288924a4510d1b5e7ec69c120bff981fae887684953e6a223e481920dbf77d880c3448d1

data/.github/workflows/specs.yml

@@ -19,5 +19,5 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle install
-    - run: rake ci
+    - run: ruby -S bundle install
+    - run: ruby -S bundle exec rake ci

data/.rubocop.yml

@@ -22,6 +22,8 @@ Style/LambdaCall:
   Enabled: false
 Lint/AssignmentInCondition:
   Enabled: false
+Style/ArgumentsForwarding:
+  Enabled: false
 
 ##
 # Disabled cops (rspec)

data/README.md

@@ -173,9 +173,7 @@ p Ryo.find(point) { |k,v| v == 5 }.x # => point_x.x
 The [`Ryo.from`](https://0x1eef.github.io/x/ryo.rb/Ryo.html#from-class_method) method has
 the same interface as the [`Ryo`](https://0x1eef.github.io/x/ryo.rb/top-level-namespace.html#Ryo-instance_method)
 method, but it is implemented to recursively walk a Hash object and create Ryo objects
-from other Hash objects found along the way. Recursion is not the default behavior
-because it has the potential to be slow when given a complex Hash object that's
-very large - otherwise there shouldn't be a noticeable performance impact.
+from other Hash objects found along the way.
 
 The following example demonstrates [`Ryo.from`](https://0x1eef.github.io/x/ryo.rb/Ryo.html#from-class_method):
 
@@ -183,14 +181,20 @@ The following example demonstrates [`Ryo.from`](https://0x1eef.github.io/x/ryo.r
 #!/usr/bin/env ruby
 require "ryo"
 
-point = Ryo.from({
-  x: {to_i: 0},
-  y: {to_i: 10}
+person = Ryo.from({
+  name: "John",
+  age: 30,
+  address: {
+    street: "123 Main St",
+    city: "Anytown",
+    state: "AS",
+    zip: 12345
+  }
 })
-p [point.x.to_i, point.y.to_i]
+p [person.name, person.age, person.address.city]
 
 ##
-# [0, 10]
+# ["John", 30, "Anytown"]
 ```
 
 #### Ryo.from with an Array
@@ -205,14 +209,14 @@ example demonstrates how that works in practice:
 require "ryo"
 
 points = Ryo.from([
-  {x: {to_i: 2}},
+  {x: 2},
   "foobar",
-  {y: {to_i: 4}}
+  {y: 4}
 ])
 
-p points[0].x.to_i
+p points[0].x
 p points[1]
-p points[2].y.to_i
+p points[2].y
 
 ##
 # 2
@@ -225,8 +229,7 @@ p points[2].y.to_i
 All methods that can create Ryo objects support turning a Struct, or OpenStruct object
 into a Ryo object. The following example demonstrates how
 [`Ryo.from`](https://0x1eef.github.io/x/ryo.rb/Ryo.html#from-class_method)
-can recursively turn an OpenStruct object into Ryo objects. The example also assigns
-a prototype to the Ryo object created from the OpenStruct:
+can recursively turn an OpenStruct object into Ryo objects:
 
 ``` ruby
 #!/usr/bin/env ruby
@@ -234,10 +237,9 @@ require "ryo"
 require "ostruct"
 
 point = Ryo.from(
-  OpenStruct.new(x: {to_i: 5}),
-  Ryo.from(y: {to_i: 10})
+  OpenStruct.new(x: 5, y: 10)
 )
-p [point.x.to_i, point.y.to_i]
+p [point.x, point.y]
 
 ##
 # [5, 10]
@@ -293,11 +295,11 @@ p [point.x.to_i, point.y.to_i]
 #### Resolution strategy
 
 When a property and method collide, Ryo tries to
-find the best resolution. Since Ryo properties don't
-accept arguments, and methods can - we are able to
-distinguish a method from a Ryo property by the presence
-or absence of an argument. Consider the following example,
-where a property collides with the `Kernel#then` method:
+find the best resolution. Because Ryo properties don't
+accept arguments, and methods can - we can distinguish a
+method from a Ryo property by the presence or absence of
+an argument in at least some cases. Consider the following
+example, where a property collides with the `Kernel#then` method:
 
 ```ruby
 #!/usr/bin/env ruby
@@ -316,10 +318,10 @@ p ryo.then { 34 } # => 34
 
 The documentation has used simple terms to describe
 the objects that Ryo works with: Hash and Array objects.
-But that doesn't quite capture the fact that Ryo
-uses duck typing: any object that implements `#each_pair`
-is similar to a Hash, and any object that implements
-`#each` is similar to an Array. Note that only
+But that doesn't quite capture that Ryo is implemented with
+duck typing: any object that implements `#each_pair`
+could be used instead of a Hash, and any object that
+implements `#each` could be used instead of an Array. Note that only
 [Ryo.from](https://0x1eef.github.io/x/ryo.rb/Ryo.html#from-class_method),
 [Ryo::Object.from](https://0x1eef.github.io/x/ryo.rb/Ryo/Object.html#from-class_method)
 and

data/lib/ryo/json.rb

@@ -1,45 +1,40 @@
 # frozen_string_literal: true
 
 ##
-# The {Ryo::JSON Ryo::JSON} module provides a number of methods
-# for coercing JSON data into a Ryo object. It must be required
-# separately to Ryo (ie: require "ryo/json"), and the methods of
-# this module are then available on the {Ryo Ryo} module.
+# The {Ryo::JSON Ryo::JSON} module provides a number of options
+# for coercing JSON data into a Ryo object. The methods of
+# this module are available on the {Ryo Ryo} module as singleton
+# methods
 module Ryo::JSON
-  require "json"
   extend self
 
   ##
   # @example
   #   Ryo.from_json(path: "/foo/bar/baz.json")
   #   Ryo.from_json(string: "[]")
-  #
   # @param [String] path
   #  The path to a JSON file
-  #
   # @param [String] string
   #  A blob of JSON
-  #
   # @param [Ryo] object
   #  {Ryo::Object Ryo::Object}, or {Ryo::BasicObject Ryo::BasicObject}
   #  Defaults to {Ryo::Object Ryo::Object}
-  #
   # @raise [SystemCallError]
   #  Might raise a number of Errno exceptions
-  #
   # @return [Ryo::Object, Ryo::BasicObject]
   #  Returns a Ryo object
   def from_json(path: nil, string: nil, object: Ryo::Object)
     if path && string
       raise ArgumentError, "Provide a path or string but not both"
     elsif path
+      require "json" unless defined?(JSON)
       object.from JSON.parse(File.binread(path))
     elsif string
+      require "json" unless defined?(JSON)
       object.from JSON.parse(string)
     else
       raise ArgumentError, "No path or string provided"
     end
   end
-
   Ryo.extend(self)
 end

data/lib/ryo/keywords.rb

@@ -2,8 +2,8 @@
 
 ##
 # The {Ryo::Keywords Ryo::Keywords} module implements Ryo equivalents
-# to some of JavaScript's keywords - for example: the **in** and **delete**
-# operators. The instance methods of this module are available as singleton
+# for some of JavaScript's keywords (eg: the **in** and **delete** operators).
+# The instance methods of this module are available as singleton
 # methods on the {Ryo} module.
 module Ryo::Keywords
   ##
@@ -24,44 +24,32 @@ module Ryo::Keywords
   alias_method :function, :fn
 
   ##
-  # Equivalent to JavaScript's **in** operator.
-  #
+  # Equivalent to JavaScript's **in** operator
   # @param [<Ryo::Object, Ryo::BasicObject>] ryo
-  #  A Ryo object.
-  #
+  #  A Ryo object
   # @param [<String, #to_s>] property
-  #  A property name.
-  #
+  #  A property name
   # @return [Boolean]
-  #  Returns true when **property** is a member of **ryo**, or its prototype chain.
+  #  Returns true when **property** is a member of **ryo**, or its prototype chain
   def in?(ryo, property)
     return false unless ryo
     property?(ryo, property) || in?(prototype_of(ryo), property)
   end
 
   ##
-  # The {#delete} method deletes a property from a Ryo object.
-  # More or less equivalent to JavaScript's "delete" operator.
-  #
-  # @note
-  #  This method does not delete properties from the prototype(s)
-  #  of a Ryo object. <br>
-  #  For that - see {Ryo::Reflect#delete! Ryo::Reflect#delete!}.
-  #
+  # The {#delete} method deletes a property from a Ryo object
+  # @see Ryo::Reflect#delete!
   # @param [<Ryo::Object, Ryo::BasicObject>] ryo
-  #  A Ryo object.
-  #
+  #  A Ryo object
   # @param [<String, #to_s>] property
-  #  A property name.
-  #
+  #  A property name
+  # @param [Integer] ancestors
+  #  The number of prototypes to traverse.
+  #  Defaults to the entire prototype chain.
   # @return [void]
-  def delete(ryo, property)
-    property = property.to_s
-    if property?(ryo, property)
-      table_of(ryo).delete(property)
-    else
-      return if getter_defined?(ryo, property)
-      define_method!(ryo, property) { ryo[property] }
+  def delete(ryo, property, ancestors: nil)
+    each_ryo(ryo, ancestors:) do
+      Ryo.property?(_1, property) ? table_of(_1).delete(property) : nil
     end
   end
 end

data/lib/ryo/reflect.rb

@@ -125,22 +125,6 @@ module Ryo::Reflect
   ##
   # @group Ryo-specific
 
-  ##
-  # The {#delete!} method deletes a property from a Ryo object,
-  # and from the prototypes in its prototype chain
-  #
-  # @see Ryo::Keywords#delete
-  # @param [<Ryo::Object, Ryo::BasicObject>] ryo
-  #  A Ryo object
-  # @param [<String, #to_s>] property
-  #  The name of a property
-  # @return [void]
-  def delete!(ryo, property)
-    [ryo, *prototype_chain_of(ryo)].each do
-      Ryo.delete(_1, property.to_s)
-    end
-  end
-
   ##
   # @param [<Ryo::Object, Ryo::BasicObject>] ryo
   #  A Ryo object

data/lib/ryo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ryo
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end

data/lib/ryo/yaml.rb

@@ -1,45 +1,40 @@
 # frozen_string_literal: true
 
 ##
-# The {Ryo::YAML Ryo::YAML} module provides a number of methods
-# for coercing YAML data into a Ryo object. It must be required
-# separately to Ryo (ie: require "ryo/yaml"), and the methods of
-# this module are then available on the {Ryo Ryo} module.
+# The {Ryo::YAML Ryo::YAML} module provides a number of options
+# for coercing YAML data into a Ryo object. The methods of
+# this module are available as singleton methods on the {Ryo Ryo}
+# module
 module Ryo::YAML
-  require "yaml"
   extend self
 
   ##
   # @example
   #   Ryo.from_yaml(path: "/foo/bar/baz.yaml")
   #   Ryo.from_yaml(string: "---\nfoo: bar\n")
-  #
   # @param [String] path
   #  The path to a YAML file
-  #
   # @param [String] string
   #  A blob of YAML
-  #
   # @param [Ryo] object
   #  {Ryo::Object Ryo::Object}, or {Ryo::BasicObject Ryo::BasicObject}
   #  Defaults to {Ryo::Object Ryo::Object}
-  #
   # @raise [SystemCallError]
   #  Might raise a number of Errno exceptions
-  #
   # @return [Ryo::Object, Ryo::BasicObject]
   #  Returns a Ryo object
   def from_yaml(path: nil, string: nil, object: Ryo::Object)
     if path && string
       raise ArgumentError, "Provide a path or string but not both"
     elsif path
+      require "yaml" unless defined?(YAML)
       object.from YAML.load_file(path)
     elsif string
+      require "yaml" unless defined?(YAML)
       object.from YAML.load(string)
     else
       raise ArgumentError, "No path or string provided"
     end
   end
-
   Ryo.extend(self)
 end

data/lib/ryo.rb

@@ -15,6 +15,8 @@
 #   point = Ryo.assign(Ryo({}), {x: 0}, {y: 0})
 #   point.x # => 0
 module Ryo
+  require_relative "ryo/json"
+  require_relative "ryo/yaml"
   require_relative "ryo/utils"
   require_relative "ryo/reflect"
   require_relative "ryo/keywords"
@@ -92,9 +94,9 @@ module Ryo
 
   ##
   # @note
-  #  This method will first query self for a property,
-  #  and if the property is not found the query is sent
-  #  to {Ryo#__proto__ Ryo#__proto__} instead
+  #  This method will first look for a property on self,
+  #  and if it is not found then it will forward the query
+  #  onto `Ryo#__proto__`
   # @param [String] property
   #  The name of a property
   # @return [<Object, BasicObject>, nil]

data/ryo.rb.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rubocop-rspec", "~> 2.12"
   gem.add_development_dependency "standard", "~> 1.9"
   gem.add_development_dependency "test-cmd.rb", "~> 0.12"
+  gem.add_development_dependency "rake", "~> 13.2"
 end

data/share/examples/ryo.rb/3.0_recursion_ryo_from.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "setup"
+require "ryo"
+
+person = Ryo.from({
+  name: "John",
+  age: 30,
+  address: {
+    street: "123 Main St",
+    city: "Anytown",
+    state: "AS",
+    zip: 12345
+  }
+})
+p [person.name, person.age, person.address.city]
+
+##
+# ["John", 30, "Anytown"]

data/share/{ryo.rb/examples → examples/ryo.rb}/3.1_recursion_ryo_from_with_array.rb

@@ -5,14 +5,14 @@ require_relative "setup"
 require "ryo"
 
 points = Ryo.from([
-  {x: {to_i: 2}},
+  {x: 2},
   "foobar",
-  {y: {to_i: 4}}
+  {y: 4}
 ])
 
-p points[0].x.to_i
+p points[0].x
 p points[1]
-p points[2].y.to_i
+p points[2].y
 
 ##
 # 2

data/share/{ryo.rb/examples → examples/ryo.rb}/3.2_recursion_ryo_from_with_openstruct.rb

@@ -6,10 +6,9 @@ require "ryo"
 require "ostruct"
 
 point = Ryo.from(
-  OpenStruct.new(x: {to_i: 5}),
-  Ryo.from(y: {to_i: 10})
+  OpenStruct.new(x: 5, y: 10)
 )
-p [point.x.to_i, point.y.to_i]
+p [point.x, point.y]
 
 ##
 # [5, 10]

data/share/ryo.rb/NEWS

@@ -0,0 +1,11 @@
+# -*- mode: org -*-
+
+* vNEXT
+
+**** Automatically require ~ryo/json~, ~ryo/yaml~
+Both files are now required in ~lib/ryo.rb~, so they can be used
+without requiring them separately
+
+**** ~Ryo.delete!~ => ~Ryo.delete~
+Other than the rename:  ~Ryo.delete~ accepts an ~ancestors~ option,
+and by default traverses the entire prototype chain

data/spec/readme_spec.rb

@@ -5,7 +5,7 @@ require "test-cmd"
 
 RSpec.describe "README.md examples" do
   run_example = ->(file) do
-    cmd("ruby", "share/ryo.rb/examples/#{file}")
+    cmd("ruby", "share/examples/ryo.rb/#{file}")
   end
 
   subject do
@@ -39,7 +39,7 @@ RSpec.describe "README.md examples" do
 
   context "when given 3.0_recursion_ryo_from.rb" do
     let(:file) { "3.0_recursion_ryo_from.rb" }
-    it { is_expected.to eq("[0, 10]") }
+    it { is_expected.to eq("[\"John\", 30, \"Anytown\"]") }
   end
 
   context "when given 3.1_recursion_ryo_from_with_array.rb" do

data/spec/ryo_json_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "setup"
-require "ryo/json"
+require "json"
 require "fileutils"
 
 RSpec.describe Ryo::JSON do

data/spec/ryo_keywords_spec.rb

@@ -47,7 +47,7 @@ RSpec.describe Ryo::Keywords do
       context "when a property is deleted from point_b" do
         subject { point_b.x }
         before { Ryo.delete(point_b, "x") }
-        it { is_expected.to eq(0) }
+        it { is_expected.to eq(nil) }
       end
 
       context "when a property is deleted from both point_a / point_b" do

data/spec/ryo_prototypes_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe "Prototypes" do
       subject { node_2.name }
       let(:node_1) { Ryo({name: "Node 1"}, root) }
       before { Ryo.delete(node_1, "name") }
-      it { is_expected.to eq("root") }
+      it { is_expected.to eq(nil) }
     end
   end
 end

data/spec/ryo_yaml_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "setup"
-require "ryo/yaml"
+require "yaml"
 require "fileutils"
 
 RSpec.describe Ryo::YAML do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryo.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
 description: Ryo implements prototype-based inheritance, in Ruby
 email:
 - 0x1eef@protonmail.com
@@ -108,7 +122,6 @@ files:
 - ".rubocop.yml"
 - ".yardopts"
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile.rb
 - lib/ryo.rb
@@ -125,20 +138,22 @@ files:
 - lib/ryo/version.rb
 - lib/ryo/yaml.rb
 - ryo.rb.gemspec
-- share/ryo.rb/examples/1.0_prototypes_point_object.rb
-- share/ryo.rb/examples/1.1_prototypes_ryo_fn.rb
-- share/ryo.rb/examples/2.0_iteration_each.rb
-- share/ryo.rb/examples/2.1_iteration_map.rb
-- share/ryo.rb/examples/2.2_iteration_ancestors.rb
-- share/ryo.rb/examples/3.0_recursion_ryo_from.rb
-- share/ryo.rb/examples/3.1_recursion_ryo_from_with_array.rb
-- share/ryo.rb/examples/3.2_recursion_ryo_from_with_openstruct.rb
-- share/ryo.rb/examples/4.0_basicobject_ryo_basicobject.rb
-- share/ryo.rb/examples/4.1_basicobject_ryo_basicobject_from.rb
-- share/ryo.rb/examples/5_collisions_resolution_strategy.rb
-- share/ryo.rb/examples/6_beyond_hash_objects.rb
-- share/ryo.rb/examples/7_ryo_memo.rb
-- share/ryo.rb/examples/setup.rb
+- share/examples/ryo.rb/1.0_prototypes_point_object.rb
+- share/examples/ryo.rb/1.1_prototypes_ryo_fn.rb
+- share/examples/ryo.rb/2.0_iteration_each.rb
+- share/examples/ryo.rb/2.1_iteration_map.rb
+- share/examples/ryo.rb/2.2_iteration_ancestors.rb
+- share/examples/ryo.rb/3.0_recursion_ryo_from.rb
+- share/examples/ryo.rb/3.1_recursion_ryo_from_with_array.rb
+- share/examples/ryo.rb/3.2_recursion_ryo_from_with_openstruct.rb
+- share/examples/ryo.rb/4.0_basicobject_ryo_basicobject.rb
+- share/examples/ryo.rb/4.1_basicobject_ryo_basicobject_from.rb
+- share/examples/ryo.rb/5_collisions_resolution_strategy.rb
+- share/examples/ryo.rb/6_beyond_hash_objects.rb
+- share/examples/ryo.rb/7_ryo_memo.rb
+- share/examples/ryo.rb/setup.rb
+- share/ryo.rb/LICENSE
+- share/ryo.rb/NEWS
 - spec/readme_spec.rb
 - spec/ryo_basic_object_spec.rb
 - spec/ryo_enumerable_spec.rb
@@ -169,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.13
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Ryo implements prototype-based inheritance, in Ruby

data/share/ryo.rb/examples/3.0_recursion_ryo_from.rb

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "setup"
-require "ryo"
-
-point = Ryo.from({
-  x: {to_i: 0},
-  y: {to_i: 10}
-})
-p [point.x.to_i, point.y.to_i]
-
-##
-# [0, 10]