ryo.rb 0.5.5 → 0.5.7

data/lib/ryo.rb

@@ -15,6 +15,9 @@
 #   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"
   require_relative "ryo/builder"
@@ -30,13 +33,11 @@ module Ryo
 
   ##
   # @param [<Ryo::Object, Ryo::BasicObject>] ryo
-  #  A Ryo object.
-  #
+  #  A Ryo object
   # @param [Module] mod
-  #  A module to extend a Ryo object with.
-  #
+  #  The module to extend a Ryo object with
   # @return [<Ryo::Object, Ryo::BasicObject>]
-  #  Returns a Ryo object extended by **mod**.
+  #  Returns an extended Ryo object
   def self.extend!(ryo, mod)
     kernel(:extend).bind_call(ryo, mod)
   end
@@ -45,10 +46,9 @@ module Ryo
   # Duplicates a Ryo object, and its prototype(s).
   #
   # @param [<Ryo::Object, Ryo::BasicObject>] ryo
-  #  A Ryo object.
-  #
+  #  A Ryo object
   # @return [<Ryo::Object, Ryo::BasicObject>]
-  #  Returns a duplicated Ryo object.
+  #  Returns a duplicated Ryo object
   def self.dup(ryo)
     duplicate = extend!(
       kernel(:dup).bind_call(ryo),
@@ -61,13 +61,12 @@ module Ryo
   end
 
   ##
-  # Creates a memoized Ryo value.
+  # Creates a memoized Ryo value
   #
   # @param [Proc] b
-  #  A Proc that is memoized after being accessed for the first time.
-  #
+  #  A Proc that is memoized after being accessed for the first time
   # @return [Ryo::Memo]
-  #  Returns an instance of {Ryo::Memo Ryo::Memo}.
+  #  Returns an instance of {Ryo::Memo Ryo::Memo}
   def self.memo(&b)
     Ryo::Memo.new(&b)
   end
@@ -76,36 +75,32 @@ module Ryo
   end
 
   ##
-  # Creates a Ryo object by recursively walking a Hash object.
+  # Creates a Ryo object by recursively walking a Hash object
   #
   # @param props (see Ryo::Builder.build)
   # @param prototype (see Ryo::Builder.build)
-  #
   # @return [Ryo::Object]
-  #  Returns an instance of {Ryo::Object Ryo::Object}.
+  #  Returns an instance of {Ryo::Object Ryo::Object}
   def self.from(props, prototype = nil)
     Ryo::Object.from(props, prototype)
   end
 
   ##
-  # Returns the prototype of self, or "nil" if self has no prototype.
-  #
   # @return [<Ryo::Object, Ryo::BasicObject>, nil]
+  #  Returns the prototype of self, or nil if self has no prototype
   def __proto__
     @_proto
   end
 
   ##
+  # @note
+  #  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
-  #  A property name.
-  #
+  #  The name of a property
   # @return [<Object, BasicObject>, nil]
-  #  Returns the value at **property**, or nil.
-  #
-  # @note
-  #  This method will first try to read **property** from self, and if
-  #  it is not found on self the chain of prototypes will be traversed
-  #  through instead.
+  #  Returns the property's value, or nil
   def [](property)
     property = property.to_s
     if Ryo.property?(self, property)
@@ -118,14 +113,11 @@ module Ryo
   end
 
   ##
-  # Assigns a property to self.
+  # Assign a property
   #
   # @param [String] property
-  #  A property name.
-  #
+  #  The name of a property
   # @param [<Object,BasicObject>] value
-  #  The value.
-  #
   # @return [void]
   def []=(property, value)
     Ryo.define_property(self, property.to_s, value)
@@ -133,10 +125,8 @@ module Ryo
 
   ##
   # @param [<Ryo::Object, Ryo::BasicObject>, Hash, #to_h] other
-  #  An object to compare against.
-  #
   # @return [Boolean]
-  #  Returns true **other** is equal to self.
+  #  Returns true **other** is equal to self
   def ==(other)
     if Ryo.ryo?(other)
       @_table == Ryo.table_of(other)
@@ -150,14 +140,14 @@ module Ryo
 
   ##
   # @return [String]
-  #  Returns a String representation of a Ryo object.
+  #  Returns a String representation of a Ryo object
   def inspect
     Ryo.inspect_object(self)
   end
 
   ##
   # @return [Hash]
-  #  Returns the hash table used by a Ryo object.
+  #  Returns the lookup table of a Ryo object
   def to_h
     Ryo.table_of(self, recursive: true)
   end
@@ -200,9 +190,8 @@ end
 ##
 # @param props (see Ryo::Builder.build)
 # @param prototype (see Ryo::Builder.build)
-#
 # @return [Ryo::Object]
-#  Returns a Ryo object.
+#  Returns a Ryo object
 def Ryo(props, prototype = nil)
   Ryo::Object.create(props, prototype)
 end

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/{ryo.rb/examples → examples/ryo.rb}/1.0_prototypes_point_object.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/1.1_prototypes_ryo_fn.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/2.0_iteration_each.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/2.1_iteration_map.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/2.2_iteration_ancestors.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

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

@@ -1,17 +1,18 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 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

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"
@@ -5,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/examples → examples/ryo.rb}/4.0_basicobject_ryo_basicobject.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/4.1_basicobject_ryo_basicobject_from.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/5_collisions_resolution_strategy.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/6_beyond_hash_objects.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "setup"

data/share/{ryo.rb/examples → examples/ryo.rb}/7_ryo_memo.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 require_relative "setup"
 require "ryo"
 

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_enumerable_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Ryo::Enumerable do
     end
 
     context "when verifying the map operation returns a new object" do
-      subject { Ryo.kernel(:equal?).bind_call(point_b, point_c) }
+      subject { Module.instance_method(:equal?).bind_call(point_b, point_c) }
       it { is_expected.to be(false) }
     end
   end

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_reflect_spec.rb

@@ -170,6 +170,14 @@ RSpec.describe Ryo::Reflect do
         it { expect(table["point"]["point"]).to be_instance_of(Hash) }
         it { is_expected.to eq("point" => {"point" => {"x" => 1, "y" => 1}}) }
       end
+
+      context "when a Ryo object references an Array" do
+        let(:ryo) { Ryo(points: [Ryo(x: 1, y: 1)]) }
+        it { expect(table).to be_instance_of(Hash) }
+        it { expect(table["points"]).to be_instance_of(Array) }
+        it { expect(table["points"][0]).to be_instance_of(Hash) }
+        it { is_expected.to eq("points" => [{"x" => 1, "y" => 1}]) }
+      end
     end
   end
 end

data/spec/ryo_spec.rb

@@ -113,7 +113,7 @@ RSpec.describe Ryo do
     end
 
     context "when verifying the source and duplicate are distinct objects" do
-      subject { Ryo.kernel(:equal?).bind_call(point_c, dup) }
+      subject { Module.instance_method(:equal?).bind_call(point_c, dup) }
       it { is_expected.to eq(false) }
     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.5
+  version: 0.5.7
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 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
@@ -121,23 +134,26 @@ files:
 - lib/ryo/memo.rb
 - lib/ryo/object.rb
 - lib/ryo/reflect.rb
+- lib/ryo/utils.rb
 - 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
@@ -168,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+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,13 +0,0 @@
-# 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]