nestedtext 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8601948a65f9660f63e8f84838452cd440219f3b188c09c0418d0dd557f1bfc
-  data.tar.gz: 8dd84452b7610602be994fb39d2d4c54e9c1912e901950257bc5db890ca6f92c
+  metadata.gz: 1e19886916af03f3d5ef28b374957b529721fc1302aefa86d37483052dfcc96e
+  data.tar.gz: 7b0b78e029f5138341ea101567d2668c97a9681bef2f2830282ad00341b80c29
 SHA512:
-  metadata.gz: b94b31da3ac93c342a635d3ad7cc719af5c4f24567214aaf492ecc3db8153bbf744dec6525b46f7303f6ea9f6b5bf8639725e447d54854570a5cc59a41c39b9f
-  data.tar.gz: 2de78ff35eb164a9463160aad408ad44293a325a17b4d51881c6f8e48539b2fef2c304e4ebf58c99dc27ea716ff3e50d242b6f5a61c815f691e679d347fc67b6
+  metadata.gz: 83a89a05ec0fba9ad2a397b16454b93de78751dda15d369b2a0704fc0e87bd426741b872a58fa236ff7814953eb6faa1a0681ac755c5eed4244560925863bfa5
+  data.tar.gz: 45e701d977422c34fc3ef2923b4a54c2bcb617fe973a867c343b7e16df94607ae0f2b5b22e515824e2245cdb4289b11fc88a11bdf12cc420e7552517c89e681a

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.2.0] - 2022-01-27
+### Changed
+- Switch from rdoc formatting syntax to Markdown with Redcarpet to be able to render README.md properly.
+
 ## [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.

data/lib/nestedtext/core_ext.rb

@@ -7,14 +7,22 @@ require "nestedtext/encode_helpers"
 # Or both: add encoding/decoding of more native classes, and allow decoding + applying a schema with 3rd party.
 # Or encourage using Marshal from core?
 
+# Extended with the `#to_nt` method.
 class String include NestedText::NTEncodeMixin; end
+
+# Extended with the `#to_nt` method.
 class Array include NestedText::NTEncodeMixin; end
+
+# Extended with the `#to_nt` method.
 class Hash include NestedText::NTEncodeMixin; end
 
+# Extended with NestedText support.
 class NilClass
   include NestedText::NTEncodeMixin
 
+  # Adds support for encoding and decoding nil.
   def self.nt_create(_data) = nil
 
+  # Adds support for encoding and decoding nil.
   def encode_nt_with() = ""
 end

data/lib/nestedtext/decode.rb

@@ -10,7 +10,7 @@ module NestedText
   # Decode a NestedText string to Ruby objects.
   #
   # @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 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.
   #
   # @return [Object, nil] The parsed object.
@@ -25,13 +25,13 @@ module NestedText
   # Decode a NestedText stored in a given file.
   #
   # @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 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.
   #
   # @return [Object, nil] The parsed object.
   #
   # @raise [NestedText::Error] if anything went wrong.
-  # @raise [IOError] on issue opening +filename+ for reading in text mode.
+  # @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

@@ -13,7 +13,7 @@ module NestedText
   #
   # @return A String containing NestedText data.
   # @raise [NestedText::Error] if anything went wrong.
-  # @raise Whatever the +io+ can raise, if supplied.
+  # @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)
 
@@ -28,15 +28,15 @@ module NestedText
 
   # Encode a Ruby object to a NestedText file.
 
-  # Apart from +filename+, this method behaves exactly like dump.
+  # 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+.
+  # @param filename [String] The file path to write the NestedText result to. The conventional file extension is `.nt`.
   #
   #
   # @return (see dump)
   # @raise (see dump)
-  # @raise [IOError] on issues opening the +filename+ for writing in text mode.
+  # @raise [IOError] on issues opening the `filename` for writing in text mode.
   #
   def self.dump_file(obj, filename, **kwargs)
     raise Errors::DumpFileBadPathError, filename unless filename.is_a? String

data/lib/nestedtext/version.rb

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

data/lib/nestedtext.rb

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

metadata

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