nestedtext 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfafdf3e9638459777da2f7209954955473758103c72533b58a66cc23f4020e3
-  data.tar.gz: 400fd879811f4d09c193da219ffa0ff61853ee0e51baac386c58b7016dfbe354
+  metadata.gz: b8601948a65f9660f63e8f84838452cd440219f3b188c09c0418d0dd557f1bfc
+  data.tar.gz: 8dd84452b7610602be994fb39d2d4c54e9c1912e901950257bc5db890ca6f92c
 SHA512:
-  metadata.gz: 708025814b4038b1b5c6eea70378762e1155ae73e933cc902a17d26d4ce3efbb2a5b52f7d535c385818e34484fe12278f981c253469d80a875e97aa8f25b20c1
-  data.tar.gz: fe87505719301bf79a71cdef1c9d89d71f9058318f5f59f1305ac79b0b69007b79976d6e288a4846824c6cc89323021b4b29df56b8f14f534cd59906d55b0843
+  metadata.gz: b94b31da3ac93c342a635d3ad7cc719af5c4f24567214aaf492ecc3db8153bbf744dec6525b46f7303f6ea9f6b5bf8639725e447d54854570a5cc59a41c39b9f
+  data.tar.gz: 2de78ff35eb164a9463160aad408ad44293a325a17b4d51881c6f8e48539b2fef2c304e4ebf58c99dc27ea716ff3e50d242b6f5a61c815f691e679d347fc67b6

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2022-01-27
+### Changed
+- Switch from rdoc to YARD to match rubydoc.info that is used automatically for Gems uploaded to rubygems.org.
+
 ## [3.0.0] - 2022-01-27
 ### Added
 - API documentation generated with rdoc.

data/README.md

@@ -16,7 +16,7 @@
 
 A ruby library for the human friendly data format [NestedText](https://nestedtext.org/).
 
-<a href="#" ><img src="https://raw.githubusercontent.com/erikw/nestedtext-ruby/main/img/logo.webp" align="right" width="420px" alt="Project logo" /></a>
+<a href="#" ><img src="img/logo.webp" align="right" width="420px" alt="Project logo" /></a>
 
 Provided is support for decoding a NestedText file or string to Ruby data structures, as well as encoding Ruby objects to a NestedText file or string. Furthermore there is support for serialization and deserialization of custom classes. The supported language version of the data format can be see in the badge above. This implementation pass all the [official tests](https://github.com/KenKundert/nestedtext_tests).
 
@@ -111,7 +111,7 @@ NestedText::dump_file(data, "path/to/data.nt")
 ### `#to_nt` Convenience
 To make it more convenient, the Ruby Core is extended with a `#to_nt` method on the supported types that will dump a String of the data structure. Here's an IRB session showing how it works:
 
-```irb
+```ruby
 irb> require 'nestedtext'
 irb> puts "a\nstring".to_nt
 > a
@@ -120,7 +120,10 @@ irb> puts ["i1", "i2", "i3"].to_nt
 - i1
 - i2
 - i3
-irb> puts({"k1" => "v1", "multiline\nkey" => "v2", "k3" => ["a", "list"]}.to_nt)
+irb> hash = {"k1" => "v1",
+            "multiline\nkey" => "v2",
+            "k3" => ["a", "list"]}
+irb> puts hash.to_nt
 k1: v1
 : multiline
 : key

data/lib/nestedtext/decode.rb

@@ -9,13 +9,13 @@ require "stringio"
 module NestedText
   # Decode a NestedText string to Ruby objects.
   #
-  # [ntstring] The string containing NestedText to be decoded.
-  # [top_class] Force the top level returned object to be of this type. Supported values are +Object+, +Array+, +Hash+ and +String+. Default is +Object+.
-  # [strict] If strict mode should be used. +true+ or +false+. Default is +false+
+  # @param ntstring [String] The string containing NestedText to be decoded.
+  # @param top_class [String] Force the top level returned object to be of this type. Supported values are +Object+, +Array+, +Hash+ and +String+.
+  # @param strict [Boolean] If strict mode should be used.
   #
-  # Returns the parsed object.
+  # @return [Object, nil] The parsed object.
   #
-  # Raises NestedText::Error if anything went wrong.
+  # @raise [NestedText::Error] if anything went wrong.
   def self.load(ntstring, top_class: Object, strict: false)
     raise Errors::WrongInputTypeError.new([String], ntstring) unless ntstring.nil? || ntstring.is_a?(String)
 
@@ -23,16 +23,15 @@ module NestedText
   end
 
   # Decode a NestedText stored in a given file.
-
-  # [filename] The file path to read NestedText to decode from.
-  # [top_class] Force the top level returned object to be of this type. Supported values are +Object+, +Array+, +Hash+ and +String+. Default is +Object+.
-  # [strict] If strict mode should be used. +true+ or +false+. Default is +false+
   #
-  # Returns the parsed object.
+  # @param filename [String] The file path to read NestedText to decode from.
+  # @param top_class [String] Force the top level returned object to be of this type. Supported values are +Object+, +Array+, +Hash+ and +String+.
+  # @param strict [Boolean] If strict mode should be used.
   #
-  # Raises NestedText::Error if anything went wrong.
+  # @return [Object, nil] The parsed object.
   #
-  # Raises +IOError+ on issue opening +filename+ for reading in text mode.
+  # @raise [NestedText::Error] if anything went wrong.
+  # @raise [IOError] on issue opening +filename+ for reading in text mode.
   def self.load_file(filename, top_class: Object, strict: false)
     raise Errors::WrongInputTypeError.new([String], filename) unless !filename.nil? && filename.is_a?(String)
 

data/lib/nestedtext/encode.rb

@@ -6,16 +6,14 @@ require "nestedtext/errors_internal"
 module NestedText
   # Encode a Ruby object to a NestedText string.
   #
-  # [obj] The object to encode to NestedText.
-  # [io] Additionally write the output to this IO object. The caller is responsible for that the IO is closed after the call to this method.
-  # [indentation] The indentation of nested levels to use.
-  # [strict] If strict mode should be used. +true+ or +false+. Default is +false+
+  # @param obj [Object] The object to encode to NestedText.
+  # @param io [IO] Additionally write the output to this IO object. The caller is responsible for that the IO is closed after the call to this method.
+  # @param indentation [Integer] The indentation of nested levels to use.
+  # @param strict [Boolean] If strict mode should be used.
   #
-  # Returns a String containing NestedText data.
-  #
-  # Raises NestedText::Error if anything went wrong.
-  #
-  # Raises whatever the passed +io+ can raise.
+  # @return A String containing NestedText data.
+  # @raise [NestedText::Error] if anything went wrong.
+  # @raise Whatever the +io+ can raise, if supplied.
   def self.dump(obj, io: nil, indentation: 4, strict: false)
     raise Errors::DumpBadIOError, io unless io.nil? || io.respond_to?(:write) && io.respond_to?(:fsync)
 
@@ -29,12 +27,17 @@ module NestedText
   end
 
   # Encode a Ruby object to a NestedText file.
+
+  # Apart from +filename+, this method behaves exactly like dump.
+  #
+  # @param (see dump)
+  # @param filename [String] The file path to write the NestedText result to. The conventional file extension is +.nt+.
   #
-  # [filename] The file path to write the NestedText result to. The conventional file extension is +.nt+.
   #
-  # Raises +IOError+ on issues opening the +filename+ for writing in text mode.
+  # @return (see dump)
+  # @raise (see dump)
+  # @raise [IOError] on issues opening the +filename+ for writing in text mode.
   #
-  # Apart from +filename+, this method behaves exactly like dump (taking same arguments, returning and raising the same values).
   def self.dump_file(obj, filename, **kwargs)
     raise Errors::DumpFileBadPathError, filename unless filename.is_a? String
 

data/lib/nestedtext/encode_helpers.rb

@@ -6,7 +6,7 @@ module NestedText
   module NTEncodeMixin
     # Encode this object to a NestedText string.
     #
-    # This method takes the same arguments as NestedText::dump.
+    # This method takes the same named arguments as {NestedText.dump}.
     def to_nt(**kwargs)
       NestedText.dump(self, strict: false, **kwargs)
     end

data/lib/nestedtext/error.rb

@@ -1,7 +1,7 @@
 module NestedText
   # Top level error to rescue on.
   #
-  # +Error+ is a subclass of +StandardError+ and behaves as expected e.g. +#message+.
+  # Error is a subclass of StandardError and behaves as expected e.g. #message.
   class Error < StandardError
     private_class_method :new
   end

data/lib/nestedtext/version.rb

@@ -2,5 +2,5 @@
 
 module NestedText
   # The version of this library.
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/nestedtext.rb

@@ -11,6 +11,6 @@ require_relative "nestedtext/version"
 # = NestedText
 # The main module in this library to use.
 #
-# See README.md for documentation on Types, Strict Mode and Custom Classes.
+# See {file:README.md} for documentation on Types, Strict Mode and Custom Classes.
 module NestedText
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Erik Westrup