nestedtext 4.4.4 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a410ec7e459d25ba34479def67615871da49b1e5a64305a67ff8d8b7a77ea1c7
-  data.tar.gz: ca24d139c60380e864305bf86b08dacfe547c4ee2093ae6643e28b5b270259f6
+  metadata.gz: 22ac73186b0d9ba1785e2b84808b57345348a1e2a4cb9ca114b59062895664df
+  data.tar.gz: dfd5bf7254e65aecf7507bd7c43d084dd47e196dd84126f2c6fcb688dc70d53d
 SHA512:
-  metadata.gz: 5470c89488352a15b10f35248bfd60d2a98642473624ff34ff8e41ac414d42f27808134731bd9b4bb30ec2d98bf50d980af6ad651e79f16dbaae489aadb7764f
-  data.tar.gz: 5494a88a82d3f89eecf8b9dcf7bc97257b49df305210fe3ac36ebda75b1ecd485f358fe9546244cb118b0d74913afd91a1016c64cc428b7cda0b96456dbd00a5
+  metadata.gz: f3e646f14b4e81fe9211b797deec8bce368438a2f9d980d1f1279f908be84928fbc033df5415a716e37e5c6ed7ed4a66c53941d645540e044680f0185f218497
+  data.tar.gz: 03c9c3f9242c1b749a4fc3ecdbd5c84ff6f4eff832a6c2272e8fe2af1188a8244566ebf383b4dfb0149a9008ec11322d5910f2634e79c70c0756f52da3813eae

data/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.5.0] - 2022-06-09
+### Added
+- Guard filesystem watch and test executor.
+
+### Changed
+- Dumped file content should end with newline, following updated version 3.3.0 of the NestedText specification.
+
+## [4.4.6] - 2022-02-17
+### Fixed
+- rubydoc.info: don't force use hash value omission with rubycop. rubydoc.info is not on ruby 3.1 yet.
+
+## [4.4.5] - 2022-02-17
+### Fixed
+- rubydoc.info: try remove unused module require.
+
 ## [4.4.4] - 2022-02-17
 ### Fixed
 - rubydoc.info: revert reject instead of select

data/README.md

@@ -2,7 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/nestedtext.svg)](https://badge.fury.io/rb/nestedtext)
 [![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/nestedtext?color=brightgreen&type=total&label=gem%20downloads)](https://rubygems.org/gems/nestedtext)
 [![Documentation](https://img.shields.io/badge/docs-API-informational?logo=readthedocs&logoColor=violet)](https://www.rubydoc.info/gems/nestedtext/NestedText)
-[![Data Format Version Supported](https://img.shields.io/badge/%F0%9F%84%BD%F0%9F%85%83%20Version%20Supported-3.2.1-blueviolet)](https://nestedtext.org/en/v3.2/)
+[![Data Format Version Supported](https://img.shields.io/badge/%F0%9F%84%BD%F0%9F%85%83%20Version%20Supported-3.3.0-blueviolet)](https://nestedtext.org/en/v3.3/)
 [![Official Tests](https://img.shields.io/badge/Official%20Tests-Passing-success?logo=cachet)](https://github.com/KenKundert/nestedtext_tests/)
 [![GitHub Actions: Continuous Integration](https://github.com/erikw/nestedtext-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/erikw/nestedtext-ruby/actions/workflows/ci.yml)
 [![GitHub Actions: Continuous Deployment](https://github.com/erikw/nestedtext-ruby/actions/workflows/cd.yml/badge.svg)](https://github.com/erikw/nestedtext-ruby/actions/workflows/cd.yml)
@@ -19,9 +19,9 @@ A ruby library for the human friendly data format [NestedText](https://nestedtex
 <!-- Use URL to hosted image, so that it shows up at rubydocs.info as well. Using relative image and yardoc option "--asset img:img" did not work. -->
 <a href="#" ><img src="https://raw.githubusercontent.com/erikw/nestedtext-ruby/main/img/logo.webp" align="right" width="420px" alt="nestedtext-ruby 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).
+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 seen in the badge above. This implementation pass all the [official tests](https://github.com/KenKundert/nestedtext_tests).
 
-This library is inspired Ruby stdlib modules `JSON` and `YAML` as well as the Python [reference implementation](https://github.com/KenKundert/nestedtext) of NestedText. Parsing is done with a LL(1) recursive descent parser and dumping with a recursive DFS traversal of the object references.
+This library is inspired by Ruby's stdlib modules `JSON` and `YAML` as well as the Python [reference implementation](https://github.com/KenKundert/nestedtext) of NestedText. Parsing is done with a LL(1) recursive descent parser and dumping with a recursive DFS traversal of the object references.
 
 To make this library practically useful, you should pair it with a [schema validator](#schema).
 
@@ -328,7 +328,6 @@ port_sum = servers.map { |server| server['port'] }.sum
 
 
 # Development
-
 1. Clone the repo
    ```console
    $ git clone https://github.com/erikw/nestedtext-ruby.git && cd $(basename "$_" .git)
@@ -339,6 +338,7 @@ port_sum = servers.map { |server| server['port'] }.sum
 1. You can also run `$ script/console` for an interactive prompt that will allow you to experiment.
 1. For local testing, install the gem on local machine with: `$ bundle exec rake install`.
    * or manually with `$ gem build *.gemscpec && gem install *.gem`
+1. Watch changes on file system and execute tests with `$ bundle exec guard`.
 
 
 Extra:
@@ -376,7 +376,7 @@ Just push a new semver tag and the workflow [cd.yml](.github/workflows/cd.yml) w
 ```console
 $ vi -p lib/nestedtext/version.rb CHANGELOG.md
 $ git commit -am "Prepare vX.Y.Z" && git push
-$ git tag x.y.z && git push --tags
+$ git tag vX.Y.Z && git push --tags
 ```
 
 or combined with gem-release:

data/lib/nestedtext/core_ext.rb

@@ -19,5 +19,5 @@ class NilClass
   def self.nt_create(_data) = nil
 
   # Adds support for encoding and decoding nil.
-  def encode_nt_with() = ''
+  def encode_nt_with = ''
 end

data/lib/nestedtext/decode.rb

@@ -3,7 +3,6 @@
 require 'nestedtext/parser'
 require 'nestedtext/errors_internal'
 
-require 'logger'
 require 'stringio'
 
 module NestedText
@@ -19,7 +18,7 @@ module NestedText
   def self.load(ntstring, top_class: Object, strict: false)
     raise Errors::WrongInputTypeError.new([String], ntstring) unless ntstring.nil? || ntstring.is_a?(String)
 
-    Parser.new(StringIO.new(ntstring), top_class, strict:).parse
+    Parser.new(StringIO.new(ntstring), top_class, strict: strict).parse
   end
 
   # Decode a NestedText stored in a given file.
@@ -37,7 +36,7 @@ module NestedText
 
     # Open explicitly in text mode to detect \r as line ending.
     File.open(filename, 'rt') do |file|
-      Parser.new(file, top_class, strict:).parse
+      Parser.new(file, top_class, strict: strict).parse
     end
   end
 end

data/lib/nestedtext/dumper.rb

@@ -84,13 +84,13 @@ module NestedText
     def dump_any(obj, depth: 0, **kwargs)
       trace_cycles(obj) do
         case obj
-        when Hash then dump_hash(obj, depth:, **kwargs)
-        when Array then dump_array(obj, depth:, **kwargs)
-        when String then dump_string(obj, depth:, **kwargs)
+        when Hash then dump_hash(obj, depth: depth, **kwargs)
+        when Array then dump_array(obj, depth: depth, **kwargs)
+        when String then dump_string(obj, depth: depth, **kwargs)
         when nil
-          @strict ? '' : dump_custom_class(nil, depth:, **kwargs)
+          @strict ? '' : dump_custom_class(nil, depth: depth, **kwargs)
         else
-          dump_custom_class(obj, depth:, **kwargs)
+          dump_custom_class(obj, depth: depth, **kwargs)
         end
       end
     end

data/lib/nestedtext/encode.rb

@@ -9,6 +9,7 @@ module NestedText
   # @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.
+  #                The file willl end with a newline.
   # @param indentation [Integer] The indentation of nested levels to use.
   # @param strict [Boolean] If strict mode should be used.
   #
@@ -21,7 +22,7 @@ module NestedText
     dumper = Dumper.new(indentation, strict)
     result = dumper.dump obj
     unless io.nil?
-      io.write(result)
+      io.write(result, "\n")
       io.fsync
     end
     dumper.dump obj

data/lib/nestedtext/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module NestedText
-  # The version of this library.
-  VERSION = '4.4.4'
+  VERSION = '4.5.0' # The version of this library.
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 4.4.4
+  version: 4.5.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A ruby library for the human friendly data format NestedText (https://nestedtext.org/)