ryo.rb 0.5.2 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad842754d7d2a619c1fd552527e519b41ddf36f704c7d4b02f2f367b0f2ee1d
-  data.tar.gz: 2457cc1cf78cfb725b8f35c5c0a4cce01c35896f0a3ed0ac32a19faeb45b0177
+  metadata.gz: c611c0e990fe0cdfd09ede551e1b457e93af7765de379d64b5dbdf6495e2b766
+  data.tar.gz: 24406b552991b2459da63847ff4b65071eb2e03cd846956e4a030f506fd5b908
 SHA512:
-  metadata.gz: 9cc4d227f2a157b112ae5ae3275062e5ba1b1241d9122c89341859a342d05d558abf4f89bed034a629a5f4f9cda966a47e794f22e9e3fede8e136a758fcd2a1c
-  data.tar.gz: f513c798461f72270fa247cc927591ae1ec26dd3e0d9606ea7bf81936063fa0026847699f6d233c93505dc891e1111560cbbd7a53d019e0fb033166d58d036a1
+  metadata.gz: 28dca6bc48b5aab85c3e08698a60e460142114623b3f914db25bbe83fa767cdd70bcb8bb4bf68d07188cc884840d696cbba81b96683d10a690d939979e0f5dfc
+  data.tar.gz: 325e58af48dc0cc6e85344ecedc006b6b331a2011432bc76069c374288bd676d2d918eee9807ee0194e8d2e31c0fe1dcbeda38b9c6a0f8982a1ea26ca0588457

data/.github/workflows/specs.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [3.1, 3.2, 3.3]
+        ruby: [3.2, 3.3]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
@@ -20,4 +20,4 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: bundle install
-    - run: bundle exec rspec
+    - run: rake ci

data/README.md

@@ -301,17 +301,16 @@ p ryo.then { 34 } # => 34
 #### Duck typing
 
 The documentation has used simple terms to describe the objects that Ryo works
-with: Hash and Array objects. But in reality, Ryo uses duck typing, so any object
-that implements `#each_pair` can be treated as a Hash object, and any object that
-implements `#each` can be treated as an Array object. Note that only
+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
 [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
 [Ryo::BasicObject.from](https://0x1eef.github.io/x/ryo.rb/Ryo/BasicObject.html#from-class_method)
-can handle Array/#each objects.
+can handle Array-like objects.
 
-Here's an example of how to turn your own custom object, which implements
-`#each_pair`, into a Ryo object:
+The following example implements `#each_pair`:
 
 ``` ruby
 require "ryo"
@@ -333,9 +332,12 @@ p point.x # => 5
 p point.y # => 10
 ```
 
-## Install
+## Documentation
+
+A complete API reference is available at
+[0x1eef.github.io/x/ryo.rb](https://0x1eef.github.io/x/ryo.rb)
 
-**Rubygems.org**
+## Install
 
 Ryo can be installed via rubygems.org:
 
@@ -350,7 +352,7 @@ Ryo can be installed via rubygems.org:
 
 Thanks to
 [@awfulcooking (mooff)](https://github.com/awfulcooking)
-for the helpful discussions, ideas, and advice
+for the helpful discussions
 
 ## License
 

data/Rakefile.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+desc "Run CI tasks"
+task :ci do
+  sh "bundle exec rubocop"
+  sh "bundle exec rspec spec/"
+end
+
+desc "Run tests"
+task :test do
+  sh "bundle exec rspec spec/"
+end
+task default: :test

data/lib/ryo/json.rb

@@ -10,33 +10,35 @@ module Ryo::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.
+  #  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}.
+  #  {Ryo::Object Ryo::Object}, or {Ryo::BasicObject Ryo::BasicObject}
+  #  Defaults to {Ryo::Object Ryo::Object}
   #
   # @raise [SystemCallError]
-  #  Might raise a number of Errno exceptions.
+  #  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)
+  #  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
+      object.from JSON.parse(File.binread(path))
+    elsif string
+      object.from JSON.parse(string)
+    else
+      raise ArgumentError, "No path or string provided"
+    end
   end
 
   Ryo.extend(self)

data/lib/ryo/reflect.rb

@@ -220,9 +220,9 @@ module Ryo::Reflect
   #
   # @return [::Object, ::BasicObject]
   #  Returns the return value of the method call.
-  def call_method(ryo, method, *args, &b)
+  def call_method(ryo, method, *, &b)
     kernel(:__send__)
-      .bind_call(ryo, method, *args, &b)
+      .bind_call(ryo, method, *, &b)
   end
 
   ##

data/lib/ryo/version.rb

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

data/lib/ryo/yaml.rb

@@ -0,0 +1,45 @@
+# 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.
+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
+      object.from YAML.load_file(path)
+    elsif string
+      object.from YAML.load(string)
+    else
+      raise ArgumentError, "No path or string provided"
+    end
+  end
+
+  Ryo.extend(self)
+end

data/ryo.rb.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.description = "Ryo implements prototype-based inheritance, in Ruby"
   gem.summary = gem.description
+  gem.required_ruby_version = ">= 3.2"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "rspec", "~> 3.10"

data/spec/ryo_json_spec.rb

@@ -5,22 +5,40 @@ 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") }
+  describe ".from_json" do
+    context "with a path" do
+      subject(:ryo) { described_class.from_json(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) }
+      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
 
-    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) }
+    context "with a string" do
+      subject(:ryo) { described_class.from_json(string: "{\"x\": 20, \"y\": 40}", object:) }
+
+      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
 end

data/spec/ryo_yaml_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "setup"
+require "ryo/yaml"
+require "fileutils"
+
+RSpec.describe Ryo::YAML do
+  describe ".from_yaml" do
+    context "with a path" do
+      subject(:ryo) { described_class.from_yaml(path:, object:) }
+      before { File.binwrite path, YAML.dump(x: 20, y: 40) }
+      after { FileUtils.rm(path) }
+      let(:path) { File.join(__dir__, "test.yaml") }
+
+      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
+
+    context "with a string" do
+      subject(:ryo) { described_class.from_yaml(string: "---\nx: 20\ny: 40\n", object:) }
+
+      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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryo.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.5
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -104,13 +104,13 @@ files:
 - ".bundle/config"
 - ".github/workflows/specs.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".projectile"
 - ".rubocop.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile.rb
 - lib/ryo.rb
 - lib/ryo/basic_object.rb
 - lib/ryo/builder.rb
@@ -122,6 +122,7 @@ files:
 - lib/ryo/object.rb
 - lib/ryo/reflect.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
@@ -146,6 +147,7 @@ files:
 - spec/ryo_prototypes_spec.rb
 - spec/ryo_reflect_spec.rb
 - spec/ryo_spec.rb
+- spec/ryo_yaml_spec.rb
 - spec/setup.rb
 homepage: https://github.com/0x1eef/ryo.rb#readme
 licenses:
@@ -159,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitlab-ci.yml

@@ -1,9 +0,0 @@
-stages:
-  - test
-
-test-ruby32:
-  stage: test
-  image: ruby:3.2.1
-  script:
-    - bundle install
-    - bundle exec rspec spec/