ryo.rb 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e90c5b42d1b364a6be77786df22b887017d3ce4965822f7152af7bcb1c617748
-  data.tar.gz: ec5d807404158d8dd1e9df47ee1fa15fb6be64ae2086942fbe9c1fd834be7331
+  metadata.gz: 63de7b5fef56bfd65a818a1ee0b37617f90778c51f53688fa603c76b25bbfd47
+  data.tar.gz: 574f61630e3e966f85a73e149250741807ee0bebef9d69dd072a5e612eeabe3d
 SHA512:
-  metadata.gz: ef8f408777db206d7fa5e3c7ced8d8a5fdfdaa15ad6e39f25921de20c421f0bef90d1aa1e474cbc6f6ab23d17fa314bd6513d3b9e322732d4adf21fb6c76b9c9
-  data.tar.gz: db93fad9aa4eeffdecbba86fa2ec970851eb007d3fecf0602e631584091f28d06dd3997464306267012bf893319f5209813b8cb99024e0281a5048da39f2a0a5
+  metadata.gz: 6e5fdc169813d8ac506f06a3d5cf3adeeda8b693d4dedd8a85d0944405107579c5fdf10d1a3b21729cba5a20c244c94b32794d797ceb2f1408ff97b4ad37e271
+  data.tar.gz: 01dc1c068bc3c565d90b4662678e9bd7d59a508488c80bbcfcf09652f481a7a4df4fb779c50683440ebff5615c7ac6b138712298a5e99f7abf8859f1dd7f55d8

data/README.md

@@ -55,21 +55,19 @@ p point.multiply.call(2)
 # [10, 20]
 ```
 
-#### Ryo.lazy
+#### Ryo.memo
 
-The following example demonstrates a lazy Ryo value.
-[`Ryo.lazy`](https://0x1eef.github.io/x/ryo.rb/Ryo.html#lazy-class_method)
-creates a lazy value that is not evaluated until a property is accessed
-for the first time. It is similar to a Ryo function but it does not require
-that the `#call` method be used, and after the property is accessed for the
-first time the lazy value is replaced by the evaluated value:
+The following example demonstrates
+[`Ryo.memo`](https://0x1eef.github.io/x/ryo.rb/Ryo.html#memo-class_method).
+`Ryo.memo` returns a value that becomes memoized after a property is
+accessed for the first time. It is similar to a Ryo function:
 
 ```ruby
 require "ryo"
 
-point_x = Ryo(x: Ryo.lazy { 5 })
-point_y = Ryo({y: Ryo.lazy { 10 }}, point_x)
-point = Ryo({sum: Ryo.lazy { x + y }}, point_y)
+point_x = Ryo(x: Ryo.memo { 5 })
+point_y = Ryo({y: Ryo.memo { 10 }}, point_x)
+point = Ryo({sum: Ryo.memo { x + y }}, point_y)
 print "point.x = ", point.x, "\n"
 print "point.y = ", point.y, "\n"
 print "point.sum = ", point.sum, "\n"
@@ -359,7 +357,7 @@ are available as sources.
 
 ```ruby
 # Gemfile
-gem "ryo.rb", github: "0x1eef/ryo.rb", tag: "v0.4.6"
+gem "ryo.rb", github: "0x1eef/ryo.rb", tag: "v0.4.7"
 ```
 
 **Rubygems.org**

data/lib/ryo/json.rb

@@ -0,0 +1,41 @@
+##
+# 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.
+module Ryo::JSON
+  require "json"
+  extend self
+
+  ##
+  # @param [String] path
+  #  The path to a JSON file.
+  #
+  # @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_file(path, object: Ryo::Object)
+    from_json File.binread(path), object:
+  end
+
+  ##
+  # @param [String] blob
+  #  A blob of JSON.
+  #
+  # @param [Ryo] object
+  #  {Ryo::Object Ryo::Object}, or {Ryo::BasicObject Ryo::BasicObject}.
+  #  Defaults to {Ryo::Object Ryo::Object}.
+  #
+  # @return (see Ryo::JSON#from_json_file)
+  def from_json(blob, object: Ryo::Object)
+    object.from JSON.parse(blob)
+  end
+
+  Ryo.extend(self)
+end

data/lib/ryo/{lazy.rb → memo.rb}

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-class Ryo::Lazy < Ryo::Function
+class Ryo::Memo < Ryo::Function
 end

data/lib/ryo/reflect.rb

@@ -251,10 +251,11 @@ module Ryo::Reflect
   #
   # @return [Boolean]
   #  Returns true when the given object is an instance
-  #  of {Ryo::Lazy Ryo::Lazy}.
-  def lazy?(obj)
-    Ryo::Lazy === obj
+  #  of {Ryo::Memo Ryo::Memo}.
+  def memo?(obj)
+    Ryo::Memo === obj
   end
+  alias_method :lazy?, :memo?
 
   ##
   # @example

data/lib/ryo/version.rb

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

data/lib/ryo.rb

@@ -21,7 +21,7 @@ module Ryo
   require_relative "ryo/basic_object"
   require_relative "ryo/object"
   require_relative "ryo/function"
-  require_relative "ryo/lazy"
+  require_relative "ryo/memo"
   require_relative "ryo/enumerable"
 
   extend Ryo::Reflect
@@ -61,15 +61,18 @@ module Ryo
   end
 
   ##
-  # Creates a lazy Ryo value.
+  # Creates a memoized Ryo value.
   #
   # @param [Proc] b
-  #  A proc that is evaluated when a property is first accessed.
+  #  A Proc that is memoized after being accessed for the first time.
   #
-  # @return [Ryo::Lazy]
-  #  Returns an instance of {Ryo::Lazy Ryo::Lazy}.
-  def self.lazy(&b)
-    Ryo::Lazy.new(&b)
+  # @return [Ryo::Memo]
+  #  Returns an instance of {Ryo::Memo Ryo::Memo}.
+  def self.memo(&b)
+    Ryo::Memo.new(&b)
+  end
+  class << Ryo
+    alias_method :lazy, :memo
   end
 
   ##
@@ -107,7 +110,7 @@ module Ryo
     property = property.to_s
     if Ryo.property?(self, property)
       v = @_table[property]
-      Ryo.lazy?(v) ? self[property] = v.call : v
+      Ryo.memo?(v) ? self[property] = v.call : v
     else
       return unless @_proto
       Ryo.call_method(@_proto, property)
@@ -158,6 +161,7 @@ module Ryo
   def to_h
     Ryo.table_of(self, recursive: true)
   end
+  alias_method :to_hash, :to_h
 
   ##
   # @private

data/spec/readme_spec.rb

@@ -72,8 +72,8 @@ RSpec.describe "README.md examples" do
     it { is_expected.to eq("5\n10") }
   end
 
-  context "when given 7_ryo_lazy.rb" do
-    let(:file) { "7_ryo_lazy.rb" }
+  context "when given 7_ryo_memo.rb" do
+    let(:file) { "7_ryo_memo.rb" }
     it { is_expected.to eq("point.x = 5\npoint.y = 10\npoint.sum = 15") }
   end
 end

data/spec/ryo_basic_object_spec.rb

@@ -64,5 +64,12 @@ RSpec.describe Ryo::BasicObject do
     it { expect(h).to be_instance_of(Hash) }
     it { expect(h["wheels"]).to be_instance_of(Hash) }
     it { expect(h).to eq({"name" => "ford", "wheels" => {"quantity" => 4}}) }
+
+    context "when given to Hash#merge" do
+      subject { {}.merge(car) }
+      let(:car) { Ryo(name: "ford") }
+      it { is_expected.to be_instance_of(Hash) }
+      it { is_expected.to eq({"name" => "ford"}) }
+    end
   end
 end

data/spec/ryo_json_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "setup"
+require "ryo/json"
+require "fileutils"
+
+RSpec.describe Ryo::JSON do
+  describe ".from_json_file" do
+    subject(:ryo) { described_class.from_json_file(path, object:) }
+    before { File.binwrite path, JSON.dump(x: 20, y: 40) }
+    after { FileUtils.rm(path) }
+    let(:path) { File.join(__dir__, "test.json") }
+
+    context "with Ryo::Object" do
+      let(:object) { Ryo::Object }
+      it { is_expected.to be_instance_of(Ryo::Object) }
+      it { is_expected.to eq("x" => 20, "y" => 40) }
+    end
+
+    context "with Ryo::BasicObject" do
+      let(:object) { Ryo::BasicObject }
+      it { expect(Ryo::BasicObject === ryo).to be(true) }
+      it { is_expected.to eq("x" => 20, "y" => 40) }
+    end
+  end
+end

data/spec/ryo_object_spec.rb

@@ -59,6 +59,13 @@ RSpec.describe "Ryo objects" do
     it { expect(h).to be_instance_of(Hash) }
     it { expect(h["wheels"]).to be_instance_of(Hash) }
     it { expect(h).to eq({"name" => "ford", "wheels" => {"quantity" => 4}}) }
+
+    context "when given to Hash#merge" do
+      subject { {}.merge(car) }
+      let(:car) { Ryo(name: "ford") }
+      it { is_expected.to be_instance_of(Hash) }
+      it { is_expected.to eq({"name" => "ford"}) }
+    end
   end
 
   describe "when a property overshadows a method" do

data/spec/ryo_spec.rb

@@ -127,4 +127,20 @@ RSpec.describe Ryo do
       it { is_expected.to eq(true) }
     end
   end
+
+  describe ".memo" do
+    let(:point) do
+      Ryo(x: Ryo.memo { "5".dup }, y: Ryo.memo { "10".dup })
+    end
+
+    it "returns a value" do
+      expect(point.x).to eq("5")
+      expect(point.y).to eq("10")
+    end
+
+    it "memoizes a value" do
+      expect(point.x).to equal(point.x)
+      expect(point.y).to equal(point.y)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryo.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -116,8 +116,9 @@ files:
 - lib/ryo/builder.rb
 - lib/ryo/enumerable.rb
 - lib/ryo/function.rb
+- lib/ryo/json.rb
 - lib/ryo/keywords.rb
-- lib/ryo/lazy.rb
+- lib/ryo/memo.rb
 - lib/ryo/object.rb
 - lib/ryo/reflect.rb
 - lib/ryo/version.rb
@@ -134,11 +135,12 @@ files:
 - 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_lazy.rb
+- share/ryo.rb/examples/7_ryo_memo.rb
 - share/ryo.rb/examples/setup.rb
 - spec/readme_spec.rb
 - spec/ryo_basic_object_spec.rb
 - spec/ryo_enumerable_spec.rb
+- spec/ryo_json_spec.rb
 - spec/ryo_keywords_spec.rb
 - spec/ryo_object_spec.rb
 - spec/ryo_prototypes_spec.rb