nestedtext 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f5f6f0ac6182999d4036976103b740552796029ffe77749a8cdf5d0d8d0167
-  data.tar.gz: c06dd5613b6c5296398a838e2419dd2addaf34b9712a1baec36ecd23e5d4c6f9
+  metadata.gz: 1b4a864ffef33a9d6138c701deb4e6ba95d27a0bcc40e8a2bdcb724b58db64e7
+  data.tar.gz: 78fd068eb2c14b44b1371c4a09e6208acedfefc169dbc72ee79df000797e91a0
 SHA512:
-  metadata.gz: 0dc821033f7813441756fcfb04e9b6a442993130462ff2572c7401b634149b538be4a831a7deb5fdb91a432be5f795d37b473fc6ac4dad5eb1e8b9c88762a5f9
-  data.tar.gz: ba7d69e4bfb3929c5dd5e0f037e88b7b13fac466aa011bccacf8095812f990c1e32b8c449df721514414cc8ce0b1c6f11723644cce13a5ee4330f549c793ee56
+  metadata.gz: dd46ca341047384eee141d5abc6d131214b45de60a51d3ab9b43292565f38e88a1c8a387543f9f37f27738fe99c553896458338f059f4da6a6420ca8884474a2
+  data.tar.gz: 9c73ab57b33f6d86feb0da4ca8a32402b8fd61e41d9eb0395adb3710a6176ede0ff018481af0655975c160382c23719ef6d4f70766906838453eda9bc46b72b7

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2022-01-26
+### Changed
+- **Breaking change**: strict mode now defaults to false for both the `load` and `dump` methods.
+- Internal rename of error classes to be more consistent.
+- Internal simplification of argument passing.
+
 ## [1.2.0] - 2022-01-25
 ### Changed
 - Hide core extension `String.normalize_line_endings` from users.

data/README.md

@@ -1,3 +1,10 @@
+<!--
+<p align="center">
+    <a href="#">
+        <img src="https://raw.githubusercontent.com/erikw/nestedtext-ruby/main/img/logo.webp" alt="Project logo" />
+    </a>
+</p>
+-->
 # NestedText Ruby Library [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=NestedText,%20the%20human%20friendly%20data%20format,%20has%20a%20now%20a%20ruby%20library%20for%20easy%20encoding%20and%20decoding&url=https://github.com/erikw/nestedtext-ruby&via=erik_westrup&hashtags=nestedtext,ruby,gem)
 [![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)
@@ -9,35 +16,119 @@
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/8409b6cdc3dc62a33f6f/maintainability)](https://codeclimate.com/github/erikw/nestedtext-ruby/maintainability)
 [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/8409b6cdc3dc62a33f6f/test_coverage)](https://codeclimate.com/github/erikw/nestedtext-ruby/test_coverage)
 [![SLOC](https://img.shields.io/tokei/lines/github/erikw/nestedtext-ruby)](#)
-[![License](https://img.shields.io/github/license/erikw/nestedtext-ruby)](LICENSE.txt)
+[![License](https://img.shields.io/github/license/erikw/nestedtext-ruby?color=informational)](LICENSE.txt)
 [![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/nestedtext-ruby)](https://github.com/Netflix/osstracker)
 
 
-Inspired by the `JSON` and `YAML` modules.
+A ruby library for the human friendly data format [NestedText](https://nestedtext.org/).
 
-This project will soon be released! :tada:
+<a href="#" ><img src="https://raw.githubusercontent.com/erikw/nestedtext-ruby/main/img/logo.webp" align="right" width="420px" alt="Project logo" /></a>
 
-On-going development is at branch [**dev**](https://github.com/erikw/nestedtext-ruby/tree/dev).
+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).
+
+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.
 
 # What is NestedText?
-TODO
+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.
+>
+> NestedText is convenient for configuration files, address books, account information, and the like. Because there is no need for quoting or escaping, it is particularly nice for holding code fragments.
 
-https://nestedtext.org/en/latest/alternatives.html
+*"Why do we need another data format?"* is the right question to ask. The answer is that the current popular formats (JSON, YAML, TOML, INI etc.) all have shortcomings which NestedText [addresses](https://nestedtext.org/en/latest/alternatives.html).
 
-## Examples
-TODO NT examples
+## Example
+Here's a full-fledged example of an address book (from the official docs):
+```nestedtext
+# Contact information for our officers
 
-# Usage
-TODO Link to lib docs
-TODO link to my test repo showin live usage. https://github.com/erikw/nestedtext-ruby-test
+president:
+    name: Katheryn McDaniel
+    address:
+        > 138 Almond Street
+        > Topeka, Kansas 20697
+    phone:
+        cell: 1-210-555-5297
+        home: 1-210-555-8470
+            # Katheryn prefers that we always call her on her cell phone.
+    email: KateMcD@aol.com
+    additional roles:
+        - board member
+
+vice president:
+    name: Margaret Hodge
+    ...
+```
 
+See the [language introduction](https://nestedtext.org/en/latest/basic_syntax.html) for more details.
 
 # Usage
+The full documentation can be found at [TODO](TODO). A minimal & fully working example of a project using this library can be found at [erikw/nestedtext-ruby-test](https://github.com/erikw/nestedtext-ruby-test).
+
 ## Decoding (reading NT)
+This is how you can decode NestedText from a string or directly from a file (`*.nt`) to Ruby object instances:
+
+### Any Top Level Type
+```ruby
+require 'nestedtext'
+
+ntstr = "- objitem1\n- list item 2"
+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.
+
+```
+key1: value1
+key2: value2
+```
+
+The NestedText types maps like this to Ruby:
+
+[NestedText](https://nestedtext.org/en/latest/basic_syntax.html) | Ruby | Comment
+---|---|---
+`String`    | `String`  |
+`List`      | `Array`   |
+`Dictionary`| `Hash`    |
+`String`    | `Symbol`  | when `strict: false`, otherwise Ruby Symbols are encoded as Custom Class (see below).
+*empty*     |  `nil`    | How empty strings and nil are handled depends on where it is used. This library follows how the official implementation does it.
+
+
+Thus you must know what you're parsing, or test what you decoded.
+
+### 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.
+
+```ruby
+require 'nestedtext'
+
+ntstr = "- objitem1\n- list item 2"
+array = NestedText::load(ntstr, top_class: Array)
+
+hash = NestedText::load_file("path/to/data.nt", top_class: Hash)
+
+# will raise NestedText::Error as we specify top level String but it will be Array.
+NestedText::load(ntstr, top_class: String)
+```
 
 ## Encoding (writing NT)
+This is how you can decode Ruby objects to a NestedText string or file:
+
+```ruby
+require 'nestedtext'
+
+data = ["i1", "i2"]
+
+ntstr = NestedText::dump(data)
+
+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:
 
-`#to_nt` method:
 ```irb
 irb> require 'nestedtext'
 irb> puts "a\nstring".to_nt
@@ -47,30 +138,97 @@ irb> puts ["i1", "i2", "i3"].to_nt
 - i1
 - i2
 - i3
-irb> puts({"k1" => "v1", "multiline\nkey" => "v2", "k3" => "multiline\nvalue"}.to_nt)
+irb> puts({"k1" => "v1", "multiline\nkey" => "v2", "k3" => ["a", "list"]}.to_nt)
 k1: v1
 : multiline
 : key
     > v2
 k3:
-    > multiline
-    > value
+    - a
+    - list
 ```
+
 ## Custom Classes Serialization
-This library has support for serialization/deserialization of custom classes as well.
-`strict: false` flag needed
+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.
+
+```ruby
+class Apple
+  def initialize(type, weight)
+    @type = type
+    @weight = weight
+  end
+
+  def encode_nt_with
+    [@type, @weight]
+  end
+end
+```
+
+When an apple instance will be serialized e.g. by `apple.to_nt`, NestedText will call `Apple.encode_nt_with` if it exist and let the returned data be encoded to represent the instance.
+
+
+To be able to get this instance back when deserializing the NestedText there must be a class method `Class.nt_create(data)`. When deserializing NestedText and the class `Apple` is detected, and the method `#nt_create` exist on the class, it will be called with the decoded data belonging to it. This method should create and return a new instance of the class. In the most simple case it's just translating this to a call to `#new`.
+
+In full, the `Apple` class should look like:
+
+```ruby
+class Apple
+  def self.nt_create(data)
+    new(*data)
+  end
+
+  def initialize(type, weight)
+    @type = type
+    @weight = weight
+  end
+
+  def encode_nt_with
+    [@type, @weight]
+  end
+end
+```
+
+An instance of this class would be encoded like this:
+
+```ruby
+irb> puts NestedText::dump(Apple.new("granny smith", 12))
+__nestedtext_class__: Apple
+data:
+    - granny smith
+    - 12
+```
+Note that the special key to denote the class name is subject to change in future versions and you **must not** rely on it.
+
+If you want to add some more super powers to your custom class, you can add the `#to_nt` shortcut by including the `NTEncodeMixin`:
+```ruby
+class Apple
+  include NestedText::NTEncodeMixin
+  ...
+end
+
+Apple.new("granny smith", 12).to_nt
+```
+
+
+**NOTE** that when deserializing a custom class, this custom class must be available when calling the `#dump*` methods e.g.
+```ruby
+require 'nestedtext'
+require_relative 'apple'  # This is needed if Apple is defined in apple.rb and not in this scope already.
+
+NestedText::load_file('path/to/apple_dump.nt')
+```
+
 See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.rb) for more real working examples.
 
 
 # Installation
 1. Add this gem to your ruby project's Gemfile
-   - Simply with `$ bundle add nestedtext` when standing in the project root
+   - Simply with `$ bundle add nestedtext` when standing inside your project
    - Or manually by adding to `Gemfile`
    ```ruby
      gem 'nestedtext'
    ```
    and then running `$ bundle install`.
-   ```
 1. Require the library and start using it!
    ```ruby
      require 'nestedtext'
@@ -89,20 +247,20 @@ See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.r
    $ git clone https://github.com/erikw/nestedtext-ruby.git && cd $(basename "$_" .git)
    ```
 1. Install a supported ruby version (see .gemspec) with a ruby version manager e.g. [rbenv](https://github.com/rbenv/rbenv), [asdf](http://asdf-vm.com/) or [RVM](https://rvm.io/rvm/install)
-1. run `$ script/setup` to install dependencies
-1. run `$ script/test` to run the tests
+1. run `$ script/setup` or `$ bundle install` to install dependencies
+1. run `$ script/test` or `bundle exec rake test` to run the tests
 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 manuall with `$ gem build *.gemscpec && gem install *.gem`
+   * or manually with `$ gem build *.gemscpec && gem install *.gem`
 
-Make sure that only intended constants and methods are exposed from the module `NestedText`. Check with
+Make sure that only intended constants and methods are exposed publicly from the module `NestedText`. Check with
 ```
 irb> require 'nestedtext'
 irb> NestedText.constants
 irb> NestedText.methods(false)
 ```
 
-## Releasing
+# Releasing
 Instructions for releasing on rubygems.org below. Optionally make a GitHub [release](https://github.com/erikw/nestedtext-ruby/releases) after this for the pushed git tag.
 
 ## (manually) Using bundler/gem_tasks rake tasks
@@ -131,7 +289,7 @@ $ git commit -am "Prepare vX.Y.Z" && git push
 $ git tag x.y.z && git push --tags
 ```
 
-or combined with gem-release
+or combined with gem-release:
 ```console
 $ vi CHANGELOG.md
 $ git commit -am "Update CHANGELOG.md" && git push
@@ -140,10 +298,11 @@ $ gem bump --version minor --tag --sign --push
 
 
 # Contributing
-Bug reports and pull requests are welcome on GitHub at [https://github.com/erikw/nestedtext-ruby](https://github.com/erikw/nestedtext-ruby).
+Bug reports and pull requests are welcome on GitHub at [erikw/nestedtext-ruby](https://github.com/erikw/nestedtext-ruby).
 
 # License
 The gem is available as open source with the [License](./LICENSE.txt).
 
-# Acknowledgement & Thanks
-Thanks to the data format authors making it easier making new implementations by providing an [official test suite](https://github.com/KenKundert/nestedtext_tests).
+# Acknowledgments
+* Thanks to the data format authors making it easier making new implementations by providing an [official test suite](https://github.com/KenKundert/nestedtext_tests).
+* Thanks to [pixteller](https://pixteller.com/) & [mp4.to](https://mp4.to/webp/) for offering the tools needed for creating an animated logo.

data/SECURITY.md

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

data/lib/nestedtext/decode.rb

@@ -7,13 +7,13 @@ require "logger"
 require "stringio"
 
 module NestedText
-  def self.load(ntstring, top_class: Object, strict: true)
+  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: strict).parse
   end
 
-  def self.load_file(filename, top_class: Object, strict: true)
+  def self.load_file(filename, top_class: Object, strict: false)
     raise Errors::WrongInputTypeError.new([String], filename) unless !filename.nil? && filename.is_a?(String)
 
     # Open explicitly in text mode to detect \r as line ending.

data/lib/nestedtext/dumper.rb

@@ -3,17 +3,18 @@ require "nestedtext/core_ext_internal"
 module NestedText
   using NestedText.const_get(:CoreExtInternal)
 
+  # Dumping with recursive DFS traversal of the object references.
   class Dumper
-    def initialize(opts = EncodeOptions.new)
-      @indentation = opts.indentation
-      @strict = opts.strict
-      @trace_cycles = nil
-      @trace_keys = nil
+    def initialize(indentation, strict)
+      @indentation = indentation
+      @strict = strict
+      @traced_cycles = nil
+      @traced_keys = nil
     end
 
     def dump(obj)
-      @trace_cycles = []
-      @trace_keys = []
+      @traced_cycles = []
+      @traced_keys = []
       dump_any obj
     end
 
@@ -47,7 +48,7 @@ module NestedText
       elsif !@strict
         key.to_s
       else
-        raise Errors::DumpHashKeyStrictString, key
+        raise Errors::DumpHashKeyStrictStringError, key
       end
     end
 
@@ -57,26 +58,24 @@ module NestedText
       target.replace indented
     end
 
-    # TODO: different name on method and instance var...
     def trace_cycles(obj)
-      raise Errors::DumpCyclicReferencesDetected, traced_key if @trace_cycles.include?(obj)
+      raise Errors::DumpCyclicReferencesDetectedError, traced_key if @traced_cycles.include?(obj)
 
-      @trace_cycles << obj
+      @traced_cycles << obj
       yield
     ensure
-      @trace_cycles.pop
+      @traced_cycles.pop
     end
 
-    # TODO: different name on method and instance var...
     def trace_keys(key)
-      @trace_keys << key
+      @traced_keys << key
       yield
     ensure
-      @trace_keys.pop
+      @traced_keys.pop
     end
 
     def traced_key
-      @trace_keys.last
+      @traced_keys.last
     end
 
     def dump_any(obj, depth: 0, **kwargs)
@@ -93,7 +92,7 @@ module NestedText
       end
     end
 
-    # TODO: document that @strict: false allows to_s on key object
+    # TODO: document that @strict==false allows to_s on key object
     def dump_hash(obj, depth: 0, **kwargs)
       rep = if obj.empty?
               "{}"

data/lib/nestedtext/encode.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "nestedtext/errors"
-require "nestedtext/encode_helpers"
 require "nestedtext/dumper"
 
 # Model after JSON
@@ -9,24 +8,22 @@ require "nestedtext/dumper"
 # NestedText.dump_file(obj, filename)
 
 module NestedText
-  # TODO: strict should maybe be false by default, as this is what ntpy does. If so, make the same for the load functions.
-  def self.dump(obj, io: nil, indentation: 4, strict: true)
+  def self.dump(obj, io: nil, indentation: 4, strict: false)
     # io - additionaly write the out result to IO and still return result.
 
-    raise Errors::DumpBadIO, io unless io.nil? || io.respond_to?(:write) && io.respond_to?(:fsync)
+    raise Errors::DumpBadIOError, io unless io.nil? || io.respond_to?(:write) && io.respond_to?(:fsync)
 
-    opts = EncodeOptions.new(indentation, strict)
-    dumper = Dumper.new(opts)
+    dumper = Dumper.new(indentation, strict)
     result = dumper.dump obj
     unless io.nil?
       io.write(result)
       io.fsync
     end
-    result
+    dumper.dump obj
   end
 
   def self.dump_file(obj, filename, **kwargs)
-    raise Errors::DumpFileBadPath, filename unless filename.is_a? String
+    raise Errors::DumpFileBadPathError, filename unless filename.is_a? String
 
     File.open(filename, mode = "wt") do |file|
       dump(obj, io: file, **kwargs)

data/lib/nestedtext/encode_helpers.rb

@@ -2,25 +2,15 @@ require "nestedtext/dumper"
 
 module NestedText
   module NTEncodeStrictMixin
-    def to_nt(indentation: 4, strict: true)
-      Dumper.new(EncodeOptions.new(indentation, strict)).dump self
+    def to_nt(**kwargs)
+      NestedText.dump(self, strict: true, **kwargs)
     end
   end
   private_constant :NTEncodeStrictMixin
 
   module NTEncodeMixin
-    def to_nt(indentation: 4)
-      Dumper.new(EncodeOptions.new(indentation, false)).dump self
+    def to_nt(**kwargs)
+      NestedText.dump(self, **kwargs)
     end
   end
-
-  class EncodeOptions
-    attr_reader :indentation, :strict
-
-    def initialize(indentation = 4, strict = true)
-      @indentation = indentation
-      @strict = strict
-    end
-  end
-  private_constant :EncodeOptions
 end

data/lib/nestedtext/errors.rb

@@ -16,7 +16,6 @@ module NestedText
       public_class_method :new # Prevent clients from instansiating.
     end
 
-    # TODO: rename all Subclasses to ParseXError, just like for Dump
     class ParseError < InternalError
       attr_reader :lineno, :colno, :message_raw
 
@@ -54,68 +53,68 @@ module NestedText
       end
     end
 
-    class LineTagUnknown < ParseError
+    class ParseLineTagUnknownError < ParseError
       def initialize(line, tag)
         super(line, line.indentation, "The Line tag #{tag} is not among the allowed ones #{Line::ALLOWED_LINE_TAGS}")
       end
     end
 
-    class LineTagNotDetected < ParseError
+    class ParseLineTagNotDetectedError < ParseError
       def initialize(line)
         super(line, line.indentation, "unrecognized line.")
       end
     end
 
-    class LineTypeExpectedListItem < ParseError
+    class ParseLineTypeExpectedListItemError < ParseError
       def initialize(line)
         super(line, line.indentation, "expected list item.")
       end
     end
 
-    class MultilineKeyNoValue < ParseError
+    class ParseMultilineKeyNoValueError < ParseError
       def initialize(line)
         super(line, line.indentation, "multiline key requires a value.")
       end
     end
 
-    class InlineDictSyntaxError < ParseError
+    class ParseInlineDictSyntaxError < ParseError
       def initialize(line, colno, wrong_char)
         super(line, line.indentation + colno, "expected ‘,’ or ‘}’, found ‘#{wrong_char}’.")
       end
     end
 
-    class InlineDictKeySyntaxError < ParseError
+    class ParseInlineDictKeySyntaxError < ParseError
       def initialize(line, colno, wrong_char)
         super(line, line.indentation + colno, "expected ‘:’, found ‘#{wrong_char}’.")
       end
     end
 
-    class InlineMissingValue < ParseError
+    class ParseInlineMissingValueError < ParseError
       def initialize(line, colno)
         super(line, line.indentation + colno, "expected value.")
       end
     end
 
-    class InlineListSyntaxError < ParseError
+    class ParseInlineListSyntaxError < ParseError
       def initialize(line, colno, wrong_char)
         super(line, line.indentation + colno, "expected ‘,’ or ‘]’, found ‘#{wrong_char}’.")
       end
     end
 
-    class InlineNoClosingDelimiter < ParseError
+    class ParseInlineNoClosingDelimiterError < ParseError
       def initialize(line, colno)
         super(line, line.indentation + colno, "line ended without closing delimiter.")
       end
     end
 
-    class InlineExtraCharactersAfterDelimiter < ParseError
+    class ParseInlineExtraCharactersAfterDelimiterError < ParseError
       def initialize(line, colno, extra_chars)
         character_str = extra_chars.length > 1 ? "characters" : "character"
         super(line, line.indentation + colno, "extra #{character_str} after closing delimiter: ‘#{extra_chars}’.")
       end
     end
 
-    class InvalidIndentation < ParseError
+    class ParseInvalidIndentationError < ParseError
       def initialize(line, ind_exp)
         prev_line = line.prev
         if prev_line.nil? && ind_exp == 0
@@ -137,19 +136,19 @@ module NestedText
       end
     end
 
-    class LineTypeNotExpected < ParseError
+    class ParseLineTypeNotExpectedError < ParseError
       def initialize(line, type_exps, type_act)
         super(line, line.indentation, "The current line was detected to be #{type_act}, but we expected to see any of [#{type_exps.join(", ")}] here.")
       end
     end
 
-    class LineTypeExpectedDictItem < ParseError
+    class ParseLineTypeExpectedDictItemError < ParseError
       def initialize(line)
         super(line, line.indentation, "expected dictionary item.")
       end
     end
 
-    class InvalidIndentationChar < ParseError
+    class ParseInvalidIndentationCharError < ParseError
       def initialize(line)
         printable_char = line.content[0].dump.gsub(/"/, "")
 
@@ -165,19 +164,19 @@ module NestedText
       end
     end
 
-    class DictDuplicateKey < ParseError
+    class ParseDictDuplicateKeyError < ParseError
       def initialize(line)
         super(line, line.indentation, "duplicate key: #{line.attribs["key"]}.")
       end
     end
 
-    class ParseCustomClassNotFound < ParseError
+    class ParseCustomClassNotFoundError < ParseError
       def initialize(line, class_name)
         super(line, line.indentation, "Detected an encode custom class #{class_name} however we can't find it, so it can't be deserialzied.")
       end
     end
 
-    class ParseCustomClassNoCreateMethod < ParseError
+    class ParseCustomClassNoCreateMethodError < ParseError
       def initialize(line, class_name)
         super(line, line.indentation, "Detected an encode custom class #{class_name} but it does not have a #nt_create method, so it can't be deserialzied.")
       end
@@ -185,13 +184,13 @@ module NestedText
 
     class AssertionError < InternalError; end
 
-    class LineScannerIsEmpty < AssertionError
+    class AssertionLineScannerIsEmptyError < AssertionError
       def initialize
         super("There is no more input to consume. You should have checked this with #empty? before calling.")
       end
     end
 
-    class InlineScannerIsEmpty < AssertionError
+    class AssertionInlineScannerIsEmptyError < AssertionError
       def initialize
         super("There is no more input to consume. You should have checked this with #empty? before calling.")
       end
@@ -216,13 +215,13 @@ module NestedText
       end
     end
 
-    class DumpCyclicReferencesDetected < DumpError
+    class DumpCyclicReferencesDetectedError < DumpError
       def initialize(culprit)
         super(culprit, "cyclic reference found: cannot be dumped.")
       end
     end
 
-    class DumpHashKeyStrictString < DumpError
+    class DumpHashKeyStrictStringError < DumpError
       def initialize(obj)
         super(obj, "keys must be strings.")
       end
@@ -230,9 +229,9 @@ module NestedText
 
     def self.raise_unrecognized_line(line)
       # [[:space:]] include all Unicode spaces e.g. non-breakable space which \s does not.
-      raise InvalidIndentationChar, line if line.content.chr =~ /[[:space:]]/
+      raise ParseInvalidIndentationCharError, line if line.content.chr =~ /[[:space:]]/
 
-      raise LineTagNotDetected, line
+      raise ParseLineTagNotDetectedError, line
     end
 
     class UnsupportedTopLevelTypeError < InternalError
@@ -247,19 +246,19 @@ module NestedText
       end
     end
 
-    class TopLevelTypeMismatchParsedType < InternalError
+    class TopLevelTypeMismatchParsedTypeError < InternalError
       def initialize(class_exp, class_act)
         super("The requested top level class #{class_exp.name} is not the same as the actual parsed top level class #{class_act}.")
       end
     end
 
-    class DumpBadIO < InternalError
+    class DumpBadIOError < InternalError
       def initialize(io)
         super("When giving the io argument, it must be of type IO (respond to #write, #fsync). Given: #{io.class.name}")
       end
     end
 
-    class DumpFileBadPath < InternalError
+    class DumpFileBadPathError < InternalError
       def initialize(path)
         super("Must supply a string to a file path that can be written to. Given: #{path}")
       end

data/lib/nestedtext/parser.rb

@@ -7,6 +7,7 @@ require "nestedtext/scanners"
 require "nestedtext/constants"
 
 module NestedText
+  # A LL(1) recursive descent parser for NT.
   class Parser
     def self.assert_valid_top_level_type(top_class)
       unless !top_class.nil? && top_class.is_a?(Class) && TOP_LEVEL_TYPES.map(&:object_id).include?(top_class.object_id)
@@ -15,7 +16,7 @@ module NestedText
     end
 
     # TODO: document that caller is responsible for closing IO after done with Parser.
-    def initialize(io, top_class, strict: true)
+    def initialize(io, top_class, strict: false)
       assert_valid_input_type io
       Parser.assert_valid_top_level_type(top_class)
       @top_class = top_class
@@ -32,13 +33,13 @@ module NestedText
         !result.nil? && ![Hash, Array, String].include?(result.class) && @strict
       when Hash.object_id
         result = {} if result.nil?
-        raise Errors::TopLevelTypeMismatchParsedType.new(@top_class, result) unless result.instance_of?(Hash)
+        raise Errors::TopLevelTypeMismatchParsedTypeError.new(@top_class, result) unless result.instance_of?(Hash)
       when Array.object_id
         result = [] if result.nil?
-        raise Errors::TopLevelTypeMismatchParsedType.new(@top_class, result) unless result.instance_of?(Array)
+        raise Errors::TopLevelTypeMismatchParsedTypeError.new(@top_class, result) unless result.instance_of?(Array)
       when String.object_id
         result = "" if result.nil?
-        raise Errors::TopLevelTypeMismatchParsedType.new(@top_class, result) unless result.instance_of?(String)
+        raise Errors::TopLevelTypeMismatchParsedTypeError.new(@top_class, result) unless result.instance_of?(String)
       else
         raise Errors::UnsupportedTopLevelTypeError, @top_class
       end
@@ -80,8 +81,8 @@ module NestedText
         line = @line_scanner.read_next
 
         Errors.raise_unrecognized_line(line) if line.tag == :unrecognized
-        raise Errors::LineTypeExpectedListItem, line unless line.tag == :list_item
-        raise Errors::InvalidIndentation.new(line, indentation) if line.indentation != indentation
+        raise Errors::ParseLineTypeExpectedListItemError, line unless line.tag == :list_item
+        raise Errors::ParseInvalidIndentationError.new(line, indentation) if line.indentation != indentation
 
         value = line.attribs["value"]
         if value.nil?
@@ -104,8 +105,8 @@ module NestedText
         line = @line_scanner.read_next
         first_line = line if first_line.nil?
         Errors.raise_unrecognized_line(line) if line.tag == :unrecognized
-        raise Errors::InvalidIndentation.new(line, indentation) if line.indentation != indentation
-        raise Errors::LineTypeExpectedDictItem, line unless %i[dict_item key_item].include? line.tag
+        raise Errors::ParseInvalidIndentationError.new(line, indentation) if line.indentation != indentation
+        raise Errors::ParseLineTypeExpectedDictItemError, line unless %i[dict_item key_item].include? line.tag
 
         value = nil
         key = nil
@@ -129,14 +130,14 @@ module NestedText
             value = ""
           else
             unless exp_types.member?(@line_scanner.peek.tag)
-              raise Errors::LineTypeNotExpected.new(line, exp_types, line.tag)
+              raise Errors::ParseLineTypeNotExpectedError.new(line, exp_types, line.tag)
             end
-            raise Errors::MultilineKeyNoValue, line unless @line_scanner.peek.indentation > indentation
+            raise Errors::ParseMultilineKeyNoValueError, line unless @line_scanner.peek.indentation > indentation
 
             value = parse_any(@line_scanner.peek.indentation)
           end
         end
-        raise Errors::DictDuplicateKey, line if result.key? key
+        raise Errors::ParseDictDuplicateKeyError, line if result.key? key
 
         result[key] = value
       end
@@ -147,12 +148,12 @@ module NestedText
         begin
           clazz = class_name == "nil" ? NilClass : Object.const_get(class_name, false)
         rescue NameError
-          raise Errors::ParseCustomClassNotFound.new(first_line, class_name)
+          raise Errors::ParseCustomClassNotFoundError.new(first_line, class_name)
         end
         if clazz.respond_to? :nt_create
           result = clazz.nt_create(result["data"])
         else
-          raise Errors::ParseCustomClassNoCreateMethod.new(first_line, class_name)
+          raise Errors::ParseCustomClassNoCreateMethodError.new(first_line, class_name)
         end
       end
 
@@ -163,8 +164,8 @@ module NestedText
       result = []
       while !@line_scanner.peek.nil? && @line_scanner.peek.indentation >= indentation
         line = @line_scanner.read_next
-        raise Errors::InvalidIndentation.new(line, indentation) if line.indentation != indentation
-        raise Errors::LineTypeNotExpected.new(line, %i[string_item], line.tag) unless line.tag == :string_item
+        raise Errors::ParseInvalidIndentationError.new(line, indentation) if line.indentation != indentation
+        raise Errors::ParseLineTypeNotExpectedError.new(line, %i[string_item], line.tag) unless line.tag == :string_item
 
         value = line.attribs["value"]
         result << value
@@ -178,16 +179,16 @@ module NestedText
         key << @inline_scanner.read_next
       end
       if @inline_scanner.empty?
-        raise Errors::InlineNoClosingDelimiter.new(@inline_scanner.line,
-                                                   @inline_scanner.pos)
+        raise Errors::ParseInlineNoClosingDelimiterError.new(@inline_scanner.line,
+                                                             @inline_scanner.pos)
       end
 
       last_char = @inline_scanner.read_next
       if last_char == "}" && key.empty?
-        raise Errors::InlineMissingValue.new(@inline_scanner.line, @inline_scanner.pos - 1)
+        raise Errors::ParseInlineMissingValueError.new(@inline_scanner.line, @inline_scanner.pos - 1)
       end
       unless last_char == ":"
-        raise Errors::InlineDictKeySyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1, last_char)
+        raise Errors::ParseInlineDictKeySyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1, last_char)
       end
 
       key.join.strip
@@ -214,13 +215,13 @@ module NestedText
           break unless @inline_scanner.peek == ","
         end
         if @inline_scanner.empty?
-          raise Errors::InlineNoClosingDelimiter.new(@inline_scanner.line,
-                                                     @inline_scanner.pos)
+          raise Errors::ParseInlineNoClosingDelimiterError.new(@inline_scanner.line,
+                                                               @inline_scanner.pos)
         end
         last_char = @inline_scanner.read_next
         unless last_char == "}"
-          raise Errors::InlineDictSyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1,
-                                                  last_char)
+          raise Errors::ParseInlineDictSyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1,
+                                                       last_char)
         end
 
       when "["
@@ -235,17 +236,17 @@ module NestedText
           break unless @inline_scanner.peek == ","
         end
         if @inline_scanner.empty?
-          raise Errors::InlineNoClosingDelimiter.new(@inline_scanner.line,
-                                                     @inline_scanner.pos)
+          raise Errors::ParseInlineNoClosingDelimiterError.new(@inline_scanner.line,
+                                                               @inline_scanner.pos)
         end
         last_char = @inline_scanner.read_next
 
         if last_char != "]"
           if result[-1] == ""
-            raise Errors::InlineMissingValue.new(@inline_scanner.line, @inline_scanner.pos - 1)
+            raise Errors::ParseInlineMissingValueError.new(@inline_scanner.line, @inline_scanner.pos - 1)
           else
-            raise Errors::InlineListSyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1,
-                                                    last_char)
+            raise Errors::ParseInlineListSyntaxError.new(@inline_scanner.line, @inline_scanner.pos - 1,
+                                                         last_char)
           end
         end
       else # Inline string
@@ -264,8 +265,8 @@ module NestedText
       @inline_scanner = InlineScanner.new(@line_scanner.read_next)
       result = parse_inline
       unless @inline_scanner.empty?
-        raise Errors::InlineExtraCharactersAfterDelimiter.new(@inline_scanner.line, @inline_scanner.pos,
-                                                              @inline_scanner.remaining)
+        raise Errors::ParseInlineExtraCharactersAfterDelimiterError.new(@inline_scanner.line, @inline_scanner.pos,
+                                                                        @inline_scanner.remaining)
       end
       unless result.is_a? Hash
         raise Errors::AssertionError,
@@ -279,8 +280,8 @@ module NestedText
       @inline_scanner = InlineScanner.new(@line_scanner.read_next)
       result = parse_inline
       unless @inline_scanner.empty?
-        raise Errors::InlineExtraCharactersAfterDelimiter.new(@inline_scanner.line, @inline_scanner.pos,
-                                                              @inline_scanner.remaining)
+        raise Errors::ParseInlineExtraCharactersAfterDelimiterError.new(@inline_scanner.line, @inline_scanner.pos,
+                                                                        @inline_scanner.remaining)
       end
       unless result.is_a? Array
         raise Errors::AssertionError,

data/lib/nestedtext/scanners.rb

@@ -15,7 +15,7 @@ module NestedText
     end
 
     def read_next
-      raise Errors::LineScannerIsEmpty if empty?
+      raise Errors::AssertionLineScannerIsEmptyError if empty?
 
       line = @next_line
       prepare_next_line
@@ -59,7 +59,7 @@ module NestedText
     end
 
     def read_next
-      raise Errors::InlineScannerIsEmpty if empty?
+      raise Errors::AssertionInlineScannerIsEmptyError if empty?
 
       @pos += 1
       @line.content[@pos - 1]
@@ -108,7 +108,7 @@ module NestedText
 
     def tag=(tag)
       @tag = tag
-      raise Errors::LineTagUnknown.new(self, tag) unless ALLOWED_LINE_TAGS.include?(@tag)
+      raise Errors::ParseLineTagUnknownError.new(self, tag) unless ALLOWED_LINE_TAGS.include?(@tag)
     end
 
     def to_s
@@ -147,7 +147,6 @@ module NestedText
       elsif @content[0] == "{"
         self.tag = :inline_dict
       elsif @content[0] == "["
-        # TODO: merge path of inline dict and list and just set :inline?
         self.tag = :inline_list
       elsif @content =~ PATTERN_DICT_ITEM
         self.tag = :dict_item

data/lib/nestedtext/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NestedText
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/nestedtext.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Erik Westrup"]
   spec.email         = ["erik.westrup@gmail.com"]
 
-  spec.summary       = "A ruby library implementation for the human friendly data format NestedText (https://nestedtext.org/)"
-  spec.description   = "A ruby library implementation 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.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"]
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{\A(?:test/|script/|\.github/|\.gitmodules|Rakefile|TODO\.txt|\.codeclimate\.yml|\.vimlocal|\.simplecov)})
+      f.match(%r{\A(?:img/|test/|script/|\.github/|\.gitmodules|Rakefile|TODO\.md|\.codeclimate\.yml|\.vimlocal|\.simplecov)})
     end
   end
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: warning
@@ -38,11 +38,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A ruby library implementation 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.
+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.
 email:
 - erik.westrup@gmail.com
 executables: []
@@ -99,6 +99,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: A ruby library implementation for the human friendly data format NestedText
-  (https://nestedtext.org/)
+summary: A ruby library for the human friendly data format NestedText (https://nestedtext.org/)
 test_files: []