nestedtext 4.1.1 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f4f42bb53a95de58265c884fe295ef58fb4bf80f869d56405a098884af7881
-  data.tar.gz: bb17a3c4cd2659803e30c35dc44e9750177d432759f052924da2c7712490813f
+  metadata.gz: 56513304eda35a4c2f2c4f2c426e2660c9f83a910da5f1375a60ceb0108aa5a3
+  data.tar.gz: 5d17dba47a2a6e45f79337c987d94e8c59dc167d27066eb0c73865d0e3812df2
 SHA512:
-  metadata.gz: e52d4d2eaa0638edef762a0f5f3d23f7e353a712edfb0c21848ee928ba40074f8b88275b5c882e6d407ae3513f9cc8fdcddd3b2b43f3ad1c193101b31821ae6b
-  data.tar.gz: 6905f86f7d455e39dda52b8c7bf070adc9d9708940c7410465932e280406d0d2fb6bc5c0fcd7f1c358dc13270db1fc4ef33e38aabe195ee08d83b4aa79b6b56b
+  metadata.gz: d4b76b4d832c0a669dbbebb46bc6e7a5ce62ec47b4bfe2440ae40450fbd4370fc8ea438510b8ae990eebe458829d7f1af9812414149f329912f77983ae3ccb71
+  data.tar.gz: 3b3f0d7dd473beadbdf85c87ecef2f72c5b1634a9e3b93fbe7d5173a902815594e4f34f02b6ce00d0bc1eab842e8bdb08b852e416c12e1672b21c0ab6684db81

data/.yardopts

@@ -0,0 +1,18 @@
+--title "NestedText API Documentation"
+--readme README.md
+--embed-mixin NTEncodeMixin
+--exclude /server/templates/
+--exclude /yard/rubygems/
+--markup markdown
+--markup-provider redcarpet
+lib/nestedtext.rb
+lib/nestedtext/core_ext.rb
+lib/nestedtext/decode.rb
+lib/nestedtext/encode_helpers.rb
+lib/nestedtext/encode.rb
+lib/nestedtext/error.rb
+lib/nestedtext/version.rb
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.txt

data/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.3.1] - 2022-02-17
+### Fixed
+- Include .yardopts in gem for rubydoc.info
+
+## [4.3.0] - 2022-02-17
+### Fixed
+- Try fix rubydoc.info missing class methods.
+
+## [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.
+
 ## [4.1.1] - 2022-01-28
 ### Fixed
 - Don't trigger CI when CD will run all tests anyways.

data/README.md

@@ -3,7 +3,7 @@
 [![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/)
-[![Official Tests](https://img.shields.io/badge/Official%20Tests-Passing-success?logo=cachet)](https://github.com/KenKundert/nestedtext_tests/tree/585e95a73d94ac1f48e71a154e2db0ab67cf30fa)
+[![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)
 [![GitHub Actions: CodeQL Analysis](https://github.com/erikw/nestedtext-ruby/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/erikw/nestedtext-ruby/actions/workflows/codeql-analysis.yml)
@@ -23,6 +23,8 @@ Provided is support for decoding a NestedText file or string to Ruby data struct
 
 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.
 
+To make this library practically useful, you should pair it with a [schema validator](#schema).
+
 # What is NestedText?
 Citing from the official [introduction](https://nestedtext.org/en/latest/index.html) page:
 > NestedText is a file format for holding structured data to be entered, edited, or viewed by people. It organizes the data into a nested collection of dictionaries, lists, and strings without the need for quoting or escaping. A unique feature of this file format is that it only supports one scalar type: strings.  While the decision to eschew integer, real, date, etc. types may seem counter intuitive, it leads to simpler data files and applications that are more robust.
@@ -72,14 +74,14 @@ obj1 = NestedText::load(ntstr)
 obj2 = NestedText::load_file("path/to/data.nt")
 ```
 
-The type of the returned object depends on the top level type in the NestedText data and will be of corresponding native Ruby type. In the example above, `obj1` will be an `Array` and obj2 will be `Hash` if `data.nt` looks like e.g.
+The type of the returned object depends on the top level type in the NestedText data and will be of corresponding native Ruby type. In the example above, `obj1` will be an `Array` and `obj2` will be `Hash` if `data.nt` looks like e.g.
 
 ```
 key1: value1
 key2: value2
 ```
 
-Thus you must know what you're parsing, or test what you decoded.
+Thus you must know what you're parsing, or test what you decoded after.
 
 ### Explicit Top Level Type
 If you already know what you expect to have, you can guarantee that this is what you will get by telling either function what the expected top type is. If not, an error will be raised.
@@ -144,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
@@ -159,7 +161,7 @@ Ruby | NestedText | Comment
 ---|---|---
 `nil`        | *Custom Class Encoding* | (1.)
 `Symbol`     | `String` |
-Custom Class | *Custom Class Encoding* | If the [Custom Class](#custom-classes-serialization) implements `#encode_nt_with` (2.)
+Custom Class | *Custom Class Encoding* | If the [Custom Class](#custom-classes-serialization) implements `#encode_nt_with`
 Other Class | String | `#to_s` will be called if there is no `#encode_nt_with`
 
 
@@ -172,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
@@ -245,6 +247,66 @@ Apple.new("granny smith", 12).to_nt
 
 See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.rb) for more real working examples.
 
+# 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 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).
+
+## 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, a `conf.nt` file could look like:
+```yaml
+-
+  name: global-service
+  ip: 192.167.1.1
+  port: 8080
+-
+  name: aux-service
+  ip: 17.245.14.2
+  port: 67
+  # Unstable server, don't use this
+  stable: false
+```
+
+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
+# Define schema for our list of servers
+schema = RSchema.define do
+  array(
+    hash(
+      'name' => _String,
+      'ip' => _String,
+      'port' => _Integer,
+      optional('stable') => boolean
+    )
+  )
+end
+
+# The coercer will automatially convert types
+coercer = RSchema::CoercionWrapper::RACK_PARAMS.wrap(schema)
+
+# Parse config file with NestedText
+data = NestedText.load_file('conf.nt')
+
+# Validate
+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
 1. Add this gem to your ruby project's Gemfile
@@ -321,7 +383,7 @@ or combined with gem-release:
 ```console
 $ vi CHANGELOG.md
 $ git commit -am "Update CHANGELOG.md" && git push
-$ gem bump --version minor --tag --sign --push
+$ gem bump --version minor --tag --push --sign
 ```
 
 

data/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 2.x.x   | :white_check_mark: |
-| < 2.0.0 | :x:                |
+| 4.x.x   | :white_check_mark: |
+| < 4.0.0 | :x:                |
 
 
 ## Reporting a Vulnerability

data/lib/nestedtext/decode.rb

@@ -15,7 +15,6 @@ module NestedText
   # @param strict [Boolean] If strict mode should be used.
   #
   # @return [Object, nil] The parsed object.
-  #
   # @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)
@@ -31,7 +30,6 @@ module NestedText
   # @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.
   def self.load_file(filename, top_class: Object, strict: false)

data/lib/nestedtext/encode.rb

@@ -28,17 +28,15 @@ 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`.
   #
-  #
   # @return (see dump)
   # @raise (see dump)
   # @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/errors_internal.rb

@@ -1,7 +1,8 @@
 # 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'
 require 'nestedtext/error'
@@ -140,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
 
@@ -162,14 +164,14 @@ module NestedText
 
     class ParseInvalidIndentationCharError < ParseError
       def initialize(line)
-        printable_char = line.content[0].dump.gsub(/"/, '')
+        char = line.content[0]
+        # Official-tests kludge; Translate rubys \u00 to python's unicodedata.name \x format.
+        printable_char = char.dump.gsub(/"/, '').gsub(/\\u0*/, '\x').downcase
 
-        # Looking for non-breaking space is just to be compatible with official tests.
         explanation = ''
-        if printable_char == '\\u00A0'
-          printable_char = '\\xa0'
-          explanation = ' (NO-BREAK SPACE)'
-        end
+        # 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}."
         super(line, line.indentation, message)
@@ -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.1.1'
+  VERSION = '4.3.1'
 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

data/nestedtext.gemspec

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
 
-require_relative "lib/nestedtext/version"
+require_relative 'lib/nestedtext/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "nestedtext"
+  spec.name          = 'nestedtext'
   spec.version       = NestedText::VERSION
-  spec.authors       = ["Erik Westrup"]
-  spec.email         = ["erik.westrup@gmail.com"]
+  spec.authors       = ['Erik Westrup']
+  spec.email         = ['erik.westrup@gmail.com']
 
-  spec.summary       = "A ruby library for the human friendly data format NestedText (https://nestedtext.org/)"
-  spec.description   = "A ruby library for the human friendly data format NestedText (https://nestedtext.org/). There 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. Support for v3.2.1 of the data format will all official tests passing."
-  spec.homepage      = "https://github.com/erikw/nestedtext-ruby/"
-  spec.license       = "MIT"
-  spec.required_ruby_version = [">= 3.0", "< 4"]
+  spec.summary       = 'A ruby library for the human friendly data format NestedText (https://nestedtext.org/)'
+  spec.description   = 'A ruby library for the human friendly data format NestedText (https://nestedtext.org/). There 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. Support for v3.2.1 of the data format will all official tests passing.'
+  spec.homepage      = 'https://github.com/erikw/nestedtext-ruby/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = ['>= 3.0', '< 4']
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/erikw/nestedtext-ruby/"
-  spec.metadata["changelog_uri"] = "https://github.com/erikw/nestedtext-ruby/blob/main/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/erikw/nestedtext-ruby/'
+  spec.metadata['changelog_uri'] = 'https://github.com/erikw/nestedtext-ruby/blob/main/CHANGELOG.md'
 
   # For push to GitHub packages to work.
   # Reference: https://github.community/t/unable-to-push-rubygem-to-package-registry-the-expected-resource-was-not-found/14596/7
   spec.metadata = {
-    "github_repo" => "git@github.com:erikw/nestedtext-ruby.git"
+    'github_repo' => 'git@github.com:erikw/nestedtext-ruby.git',
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").select do |f|
-      f.match(%r{\A(?:lib/|CHANGELOG.md|CONTRIBUTING.md|LICENSE.txt|README.md|SECURITY.md|nestedtext.gemspec)})
+      f.match(%r{\A(?:lib/|CHANGELOG.md|CONTRIBUTING.md|LICENSE.txt|README.md|SECURITY.md|nestedtext.gemspec|.yardopts)})
     end
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "warning", "~> 1.2"
-  spec.add_runtime_dependency "word_wrap", "~> 1.0"
+  spec.add_runtime_dependency 'unicode_utils', '~> 1.4'
+  spec.add_runtime_dependency 'warning', '~> 1.2'
+  spec.add_runtime_dependency 'word_wrap', '~> 1.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.3.1
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -49,6 +63,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.txt
@@ -74,6 +89,7 @@ licenses:
 - MIT
 metadata:
   github_repo: git@github.com:erikw/nestedtext-ruby.git
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: