nestedtext 1.2.0 → 3.0.0

data/lib/nestedtext/{errors.rb → errors_internal.rb}

@@ -4,19 +4,14 @@ require "word_wrap"
 require "word_wrap/core_ext"
 
 require "nestedtext/constants"
+require "nestedtext/error"
 
 module NestedText
-  # Top level error for clients to rescue on.
-  class Error < StandardError
-    private_class_method :new
-  end
-
   module Errors
     class InternalError < Error
-      public_class_method :new # Prevent clients from instansiating.
+      public_class_method :new # Prevent users from instansiating.
     end
 
-    # TODO: rename all Subclasses to ParseXError, just like for Dump
     class ParseError < InternalError
       attr_reader :lineno, :colno, :message_raw
 
@@ -54,68 +49,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 +132,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 +160,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 +180,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 +211,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 +225,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 +242,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

@@ -2,11 +2,12 @@
 
 require "stringio"
 
-require "nestedtext/errors"
+require "nestedtext/errors_internal"
 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)
@@ -14,8 +15,7 @@ module NestedText
       end
     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 +32,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 +80,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 +104,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 +129,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 +147,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 +163,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 +178,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 +214,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 +235,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 +264,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 +279,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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "nestedtext/errors"
+require "nestedtext/errors_internal"
 
 module NestedText
   class LineScanner
@@ -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,6 @@
 # frozen_string_literal: true
 
 module NestedText
-  VERSION = "1.2.0"
+  # The version of this library.
+  VERSION = "3.0.0"
 end

data/lib/nestedtext.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "nestedtext/encode"
-require_relative "nestedtext/decode"
 require_relative "nestedtext/core_ext"
+require_relative "nestedtext/decode"
+require_relative "nestedtext/encode"
+require_relative "nestedtext/encode_helpers"
+require_relative "nestedtext/error"
 require_relative "nestedtext/version"
 
+##
+# = NestedText
+# The main module in this library to use.
+#
+# See README.md for documentation on Types, Strict Mode and Custom Classes.
 module NestedText
 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"]
@@ -25,8 +25,8 @@ 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)})
+    `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)})
     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: 3.0.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: warning
@@ -38,26 +38,20 @@ 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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
-- OSSMETADATA
 - README.md
 - SECURITY.md
 - lib/nestedtext.rb
@@ -68,7 +62,8 @@ files:
 - lib/nestedtext/dumper.rb
 - lib/nestedtext/encode.rb
 - lib/nestedtext/encode_helpers.rb
-- lib/nestedtext/errors.rb
+- lib/nestedtext/error.rb
+- lib/nestedtext/errors_internal.rb
 - lib/nestedtext/parser.rb
 - lib/nestedtext/scanners.rb
 - lib/nestedtext/version.rb
@@ -99,6 +94,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: []

data/.editorconfig

@@ -1,24 +0,0 @@
-# Modified version of https://github.com/ruby/ruby/blob/master/.editorconfig
-
-root = true
-
-[*]
-end_of_line = lf
-indent_size = 4
-indent_style = space
-insert_final_newline = true
-tab_width = 4
-trim_trailing_whitespace = true
-
-[*.rb]
-indent_size = 2
-
-[*.gemspec]
-indent_size = 2
-
-[*.yml]
-indent_size = 2
-
-[test/nestedtext/encode_test.rb]
-# So we can test trailing whitespace strings.
-trim_trailing_whitespace = unset

data/.gitignore

@@ -1,21 +0,0 @@
-# Contrary to ruby apps, ruby gems should not check in Gemfile.lock.
-# Reference: https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
-/Gemfile.lock
-
-# Bundle local config
-/.bundle/
-
-# Package gem from $(rake install)
-/pkg/
-# When built from $(gem build *.gemspec)
-/*.gem
-
-# minitest
-/test/html_reports/
-/test/reports/
-
-# simplecov
-/coverage/
-
-# byebug
-/.byebug_history