nestedtext 4.2.0 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3fcbca130327597aa3a6f2205d5328ddf407a916c5a071906686b5013fca52
-  data.tar.gz: f143d0efe77a919566360830209e8ab36b8a0205feb0466c8c00b55a598da904
+  metadata.gz: 56edadbc6c19a780acc64f2dc5e7b433a7a5086b9c2ff5d19837d18fa84ef1cb
+  data.tar.gz: 0b65feaf1d2cd866c1700c19bf2329c4c0a01db97b48c7c3b18dd91ae1620969
 SHA512:
-  metadata.gz: 1835a85442d3080bb1084aeed972d787f12325b88f99c50528858596d4918eef73101eb9861fe7a78102a17f9ed27551034a8a237f55143f26d2e74deac3b9e7
-  data.tar.gz: 9998dd2a1d1a1afff99b5cc587a35e6cc240fe38a74c2b19fcb6dd38f3d907c414e1a644a8891832049cfa770eb2a047054e447f48bebbd4481e027eb0ad079f
+  metadata.gz: fa67ebde8e33b4e254f1ca484046113971141bb2fcd10e7b64aeb03cd4dab0912acfc465c521bf9a5647483536c478cc754c0602f79bf9a156c870c9e7d2974e
+  data.tar.gz: 9527268ebfae6a0646ce7f22f9af6f30bca4a70e8e65a233e94fd870054ebae374cc2a1aa58df4572d3128298ae8433fc8218633dcc2410665e8fd9ab895ff25

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.2.2] - 2022-02-12
+### Fixed
+- Better module documentation fix.
+
+## [4.2.1] - 2022-02-12
+### Fixed
+- Better module documentation.
+
 ## [4.2.0] - 2022-02-08
 ### Fixed
 - Proper Unicode character name lookup.

data/README.md

@@ -146,7 +146,7 @@ Ruby | [NestedText](https://nestedtext.org/en/latest/basic_syntax.html)
 
 
 ### Strict Mode
-The strict mode determines how classes other than the basic types `String`, `Array` and `Hash` are handled during encoding and decoding. By **default** strict mode is turned **off**.
+The strict mode determines how classes other than the basic types `String`, `Array` and `Hash` are handled during encoding and decoding. By **default** strict mode is **false**.
 
 With `strict: true`
 Ruby | NestedText | Comment
@@ -174,7 +174,7 @@ Other Class | String | `#to_s` will be called if there is no `#encode_nt_with`
 ## Custom Classes Serialization
 This library has support for serialization/deserialization of custom classes as well. This is done by letting the objects tell NestedText what data should be used to represent the object instance with the `#encode_nt_with` method (inspired by `YAML`'s `#encode_with` method). All objects being recursively referenced from a root object being serialized must either implement this method or be one of the core supported NestedText data types from the table above.
 
-A class implementing `#encode_nt_with` is referred to as `Custom Class` in this document.
+A class implementing `#encode_nt_with` is referred to as a `Custom Class` in this document.
 
 ```ruby
 class Apple
@@ -250,8 +250,8 @@ See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.r
 # Schema
 The point of NestedText is to not get in to business of supporting ambiguous types. That's why all values are simple strings. Having only simple strings is not useful in practice though. This is why NestedText is intended to be paired with a [Schema Validator](https://nestedtext.org/en/latest/schemas.html)!
 
-A schema validators can:
-* assert that the parsed values are like the expected
+A schema validator can:
+* assert that the parsed values are of the expected types
 * automatically convert them to Ruby class instances like Integer, Float, etc.
 
 The reference implementation in Python [lists](https://nestedtext.org/en/latest/examples.html) a few examples of Python validators. Here below is an example of how this Ruby implementation of NestedText can be paired it with [RSchema](https://github.com/tomdalling/rschema).
@@ -259,7 +259,7 @@ The reference implementation in Python [lists](https://nestedtext.org/en/latest/
 ## Example with RSchema
 The full and working example can be found at [erikw/nestedtext-ruby-test](https://github.com/erikw/nestedtext-ruby-test/blob/main/parse_validate.rb).
 
-Let's say that you have a program that should connect to a few servers. The list of servers should be stored in a configuration file. With NestedText, this file could look like:
+Let's say that you have a program that should connect to a few servers. The list of servers should be stored in a configuration file. With NestedText, a `conf.nt` file could look like:
 ```yaml
 -
   name: global-service
@@ -273,7 +273,7 @@ Let's say that you have a program that should connect to a few servers. The list
   stable: false
 ```
 
-After parsing this file with this NestedText library, the values for all keys will be string. But for to make practical use of this, we would of course like the values for `port` to be `Integer`, and `stable` should have a value of either `true` or `false`. RSchema can do this conversion for us!
+After parsing this file with this NestedText library, the values for all keys will be string. But to make practical use of this, we would of course like the values for the `port` keys to be `Integer`, and `stable` should have a value of either `true` or `false`. RSchema can do this conversion for us!
 
 
 ```ruby
@@ -296,18 +296,16 @@ coercer = RSchema::CoercionWrapper::RACK_PARAMS.wrap(schema)
 data = NestedText.load_file('conf.nt')
 
 # Validate
-result = coercer.validate(data_success)
-
-if result.valid?
-  servers = result.value
-  # Now 'servers' is known to be valid and have the types specified in the schema.
-  # Thus, we can use it now!
-  stable_servers = servers.select { |server| server['stable'] }
-  # Not a meaningful sum - just demonstrating that 'port's are integers and not strings anymore!
-  port_sum = servers.map { |server| server['port'] }.sum
-else
-  puts result.error
-end
+result = coercer.validate(data)
+raise result.error.to_s unless result.valid?
+
+# Now we have validated data of the right type specified in the schema!
+servers = result.value
+
+# Let's use the values for something in our app
+stable_servers = servers.select { |server| server['stable'] }
+# Not a meaningful sum - just demonstrating that 'port' values are integers and not strings anymore!
+port_sum = servers.map { |server| server['port'] }.sum
 ```
 
 # Installation

data/lib/nestedtext/errors_internal.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'word_wrap'
-require 'word_wrap/core_ext'
+# require 'word_wrap'
+# require 'word_wrap/core_ext'
 require 'unicode_utils'
 
 require 'nestedtext/constants'
@@ -141,9 +141,10 @@ module NestedText
                   else
                     'invalid indentation.'
                   end
-        # Need to wrap like official tests. #wrap always add an extra \n we need to chop off.
-        message_wrapped = message.wrap(70).chop
-        super(line, ind_exp, message_wrapped)
+        # Official-tests kludge; Need to wrap like official tests. #wrap always add an extra \n we need to chop off.
+        # Seems not be needed anymore
+        # message_wrapped = message.wrap(70).chop
+        super(line, ind_exp, message)
       end
     end
 
@@ -164,11 +165,12 @@ module NestedText
     class ParseInvalidIndentationCharError < ParseError
       def initialize(line)
         char = line.content[0]
-        # Official-test kludge; Translate rubys \u00 to python's unicodedata.name \x format.
+        # Official-tests kludge; Translate rubys \u00 to python's unicodedata.name \x format.
         printable_char = char.dump.gsub(/"/, '').gsub(/\\u0*/, '\x').downcase
 
         explanation = ''
-        # Official-test kludge; ASCII chars have printable names too, but they are not used in reference implementation.
+        # Official-tests kludge; ASCII chars have printable names too,
+        # but they are not used in reference implementation.
         explanation = " (#{UnicodeUtils.char_name(char)})" unless char.ord < 128
 
         message = "invalid character in indentation: '#{printable_char}'#{explanation}."
@@ -225,7 +227,7 @@ module NestedText
 
     class DumpUnsupportedTypeError < DumpError
       def initialize(obj, culprit)
-        # Needed to pass official test.
+        # Official-tests kludge; translate to Python names
         class_name = obj.is_a?(Integer) ? 'int' : obj.class.name
         super(culprit, "unsupported type (#{class_name}).")
       end

data/lib/nestedtext/version.rb

@@ -2,5 +2,5 @@
 
 module NestedText
   # The version of this library.
-  VERSION = '4.2.0'
+  VERSION = '4.2.2'
 end

data/lib/nestedtext.rb

@@ -7,9 +7,12 @@ require_relative 'nestedtext/encode_helpers'
 require_relative 'nestedtext/error'
 require_relative 'nestedtext/version'
 
-##
 # # NestedText
-# The main module in this library to use.
+# A ruby library for the human friendly data format NestedText (https://nestedtext.org/).
+#
+# 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.
 #
 # See {file:README.md} for documentation on Types, Strict Mode and Custom Classes.
 module NestedText

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.2
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils