ryo.rb 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d4a31df7a8e4862600d2e3072df9320d95cdd805fdef5028cd1c6154a9786c2
-  data.tar.gz: 862aa59d0f09c4ebcabb9c5552f390dc8456a5964601c48d866a84a01e871443
+  metadata.gz: 2b39f30dc20ead80a6704d27f1a10b9046ad6fe05d164ec4cb31b6606f225a33
+  data.tar.gz: 03db26bce85e7f1fad10d2b909284c32fc18f13cd999aa718ddd21d867d29a29
 SHA512:
-  metadata.gz: 57bab86f4003fb0aa40c43fa2fc41d335b26ead6c99522d97227f25279b5f45330c7fc9edf66b4682508d4cf13593be6d1ce55ab8507263cad75fa99605651c0
-  data.tar.gz: 384411a195dbd7699dfa9f8b3a253588e477b28b04210c3a8452285f47778d149f090750b352de9bf9e95f19fb679127062b2fcce90aac5d0bc99224f452cf3c
+  metadata.gz: 95f73de92d97038eb2ef3c70c4fb97e02c84a0ed5fe9a7d73f198f392f4a04ca608170ab2011f537bac9779cb66c7214a1166040268d602aa592a540789e24e8
+  data.tar.gz: 51809089becfa72d4cadf79771cd944f1d31e8d658d03f4d00881c6d7eec6dbd58448cbabe3efada8e386a55c96b5298fb47470f76c125179ecf35ad9d1ddb1b

data/Gemfile

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
 source "https://rubygems.org"
-gem "test-cmd.rb", github: "0x1eef/test-cmd.rb", tag: "v0.4.0"
 gemspec

data/README.md

@@ -333,11 +333,14 @@ p point.x # => 5
 p point.y # => 10
 ```
 
-## <a id='install'>Install</a>
+## Documentation
 
-**Rubygems.org**
+A complete API reference is available at
+[0x1eef.github.io/x/ryo.rb](https://0x1eef.github.io/x/ryo.rb)
 
-Ryo can be installed via rubygems.org.
+## Install
+
+Ryo can be installed via rubygems.org:
 
     gem install ryo.rb
 
@@ -350,11 +353,10 @@ Ryo can be installed via rubygems.org.
 
 Thanks to
 [@awfulcooking (mooff)](https://github.com/awfulcooking)
-for the helpful discussions and advice.
+for the helpful discussions, ideas, and advice
 
 ## License
 
-[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
 <br>
-See [LICENSE](./LICENSE).
-
+See [LICENSE](./LICENSE)

data/lib/ryo/builder.rb

@@ -26,7 +26,7 @@ module Ryo::Builder
   #  returned in its place.
   def self.build(buildee, props, prototype = nil)
     if Ryo.ryo?(props)
-      build(builedee, Ryo.table_of(props), prototype || Ryo.prototype_of(props))
+      build(buildee, Ryo.table_of(props), prototype || Ryo.prototype_of(props))
     else
       ryo = buildee.new
       Ryo.set_prototype_of(ryo, prototype)

data/lib/ryo/json.rb

@@ -1,3 +1,5 @@
+# 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
@@ -8,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/version.rb

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

data/ryo.rb.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |gem|
   gem.licenses = ["MIT"]
   gem.files = `git ls-files`.split($/)
   gem.require_paths = ["lib"]
-  gem.description = "Ryo implements prototype-based inheritance, in Ruby."
+  gem.description = "Ryo implements prototype-based inheritance, in Ruby"
   gem.summary = gem.description
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "rspec", "~> 3.10"
   gem.add_development_dependency "rubocop-rspec", "~> 2.12"
   gem.add_development_dependency "standard", "~> 1.9"
-  gem.add_development_dependency "test-cmd.rb", "~> 0.4"
+  gem.add_development_dependency "test-cmd.rb", "~> 0.12"
 end

data/spec/readme_spec.rb

@@ -5,7 +5,7 @@ require "test-cmd"
 
 RSpec.describe "README.md examples" do
   run_example = ->(file) do
-    Test::Cmd.cmd("ruby share/ryo.rb/examples/#{file}")
+    cmd("ruby", "share/ryo.rb/examples/#{file}")
   end
 
   subject do

data/spec/ryo_json_spec.rb

@@ -6,7 +6,7 @@ require "fileutils"
 
 RSpec.describe Ryo::JSON do
   describe ".from_json_file" do
-    subject(:ryo) { described_class.from_json_file(path, object:) }
+    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") }

data/spec/ryo_object_spec.rb

@@ -5,6 +5,15 @@ require_relative "setup"
 RSpec.describe "Ryo objects" do
   let(:car) { Ryo(name: "Car") }
 
+  describe "Kernel#Ryo" do
+    context "when given a Ryo object" do
+      subject { Ryo(ryo) }
+      let(:ryo) { Ryo(name: "Car") }
+
+      it { is_expected.to be_instance_of(Ryo::Object) }
+    end
+  end
+
   describe "#respond_to?" do
     context "when a property is defined" do
       subject { car.respond_to?(:name) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryo.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -86,15 +86,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-description: Ryo implements prototype-based inheritance, in Ruby.
+        version: '0.12'
+description: Ryo implements prototype-based inheritance, in Ruby
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -166,8 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Ryo implements prototype-based inheritance, in Ruby.
+summary: Ryo implements prototype-based inheritance, in Ruby
 test_files: []