ryo.rb 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad842754d7d2a619c1fd552527e519b41ddf36f704c7d4b02f2f367b0f2ee1d
-  data.tar.gz: 2457cc1cf78cfb725b8f35c5c0a4cce01c35896f0a3ed0ac32a19faeb45b0177
+  metadata.gz: 2b39f30dc20ead80a6704d27f1a10b9046ad6fe05d164ec4cb31b6606f225a33
+  data.tar.gz: 03db26bce85e7f1fad10d2b909284c32fc18f13cd999aa718ddd21d867d29a29
 SHA512:
-  metadata.gz: 9cc4d227f2a157b112ae5ae3275062e5ba1b1241d9122c89341859a342d05d558abf4f89bed034a629a5f4f9cda966a47e794f22e9e3fede8e136a758fcd2a1c
-  data.tar.gz: f513c798461f72270fa247cc927591ae1ec26dd3e0d9606ea7bf81936063fa0026847699f6d233c93505dc891e1111560cbbd7a53d019e0fb033166d58d036a1
+  metadata.gz: 95f73de92d97038eb2ef3c70c4fb97e02c84a0ed5fe9a7d73f198f392f4a04ca608170ab2011f537bac9779cb66c7214a1166040268d602aa592a540789e24e8
+  data.tar.gz: 51809089becfa72d4cadf79771cd944f1d31e8d658d03f4d00881c6d7eec6dbd58448cbabe3efada8e386a55c96b5298fb47470f76c125179ecf35ad9d1ddb1b

data/README.md

@@ -333,9 +333,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:
 

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/version.rb

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

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") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryo.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard