nestedtext 0.4.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ead461a4a23e4c1c481c2e7c4459055031c7455ebdb5706ebb16f16a727f3ae
-  data.tar.gz: a432bba7b1e8051f796b4420e7312e863c4d559724c8aa4b997e7ef6b70e1f68
+  metadata.gz: f906cf4ad95eb7c5db10e4aac5c9a8ef3fed91405dbad16572ed9a7c38fa7d05
+  data.tar.gz: c1189a45c17049006e0c81e589298ad9659e1bb42ce3889e31a863b279753663
 SHA512:
-  metadata.gz: d63fab4ee04eb32e5bf1a74a4888ccb42f8bb998167a9ee51ae9e2a4832290489b0295de23273601f2ed4d90e75d58dd3c59253ecdec585f8c0789441d52d692
-  data.tar.gz: d24c235aaf77b2c776856647783395a5ab8e9a97ef3d4e2e08b1bca37df4fe0d92e87a60a5c0b595660cee011499397e341b13f2b2dee445f1e54e09cd19f6fd
+  metadata.gz: 4dac3b9cc46cc628bcb5d804c13a986f3c9a5b7b207f02a84ac60caeff211cf416346e27af21b67485e41092e63b0c58de6f012a3a05b0a279a1f11edcdd3474
+  data.tar.gz: 13bc5644759667435b7c7da7ac60aaea5ab2236f9c4bd7a57856140967e9a2d9fc2ce60733df4076e500dcfc031a6954ccdc07a7c2d1fd1df60c280cf73cb13b

data/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2022-01-25
+### Added
+- Expose `NestedText::VERSION` for convenience to the clients.
+
+## [1.0.0] - 2022-01-25
+The library is now useful for clients!
+
+### Changed
+- Hide all internals in the module from clients.
+
+## [0.6.0] - 2022-01-24
+### Fixed
+- Move runtime dependencies from Gemfile to .gemspec.
+
+## [0.5.0] - 2022-01-24
+### Added
+- Publish Gem to GitHub Packages
+
 ## [0.4.0] - 2022-01-24
 - Iteration on CD GitHub Actins workflow.
 

data/Gemfile

@@ -12,7 +12,6 @@ gemspec
 # Reference: https://github.com/rubygems/bundler/pull/7222
 # However there's an argument for using gemspec too: https://bundler.io/guides/creating_gem.html#testing-our-gem
 group :development, :test do
-  gem "appraisal", "~> 2.4", require: false
   gem "gem-release", "~> 2.0", require: false
   gem "pry-byebug", "~> 3.9"
   gem "rake", "~> 13.0", require: false
@@ -26,6 +25,3 @@ group :test do
   gem "rubocop-rake", "~> 0.6", require: false
   gem "simplecov", "~> 0.21", require: false
 end
-
-gem "warning", "~> 1.2"
-gem "word_wrap", "~> 1.0"

data/README.md

@@ -1,9 +1,9 @@
-# NestedText Ruby Library [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Get%20a%20nifty%20tooltip%20for%20term%20definitions%20in%20your%20Jekyll%20blog%20with%20this%20plugin&url=https://github.com/erikw/nestedtext-ruby&via=erik_westrup&hashtags=jekyll,plugin)
+# 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)
 [![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/)
-[![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)
 [![Official Tests](https://img.shields.io/badge/%F0%9F%8F%81%20Official%20Tests-Passing-success)](https://github.com/KenKundert/nestedtext_tests/tree/585e95a73d94ac1f48e71a154e2db0ab67cf30fa)
+[![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)
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/8409b6cdc3dc62a33f6f/maintainability)](https://codeclimate.com/github/erikw/nestedtext-ruby/maintainability)
@@ -22,12 +22,14 @@ On-going development is at branch [**dev**](https://github.com/erikw/nestedtext-
 # What is NestedText?
 TODO
 
+https://nestedtext.org/en/latest/alternatives.html
+
 ## Examples
 TODO NT examples
 
 # Usage
 TODO Link to lib docs
-TODO link to my test repo showin live usage.
+TODO link to my test repo showin live usage. https://github.com/erikw/nestedtext-ruby-test
 
 
 # Usage
@@ -35,6 +37,25 @@ TODO link to my test repo showin live usage.
 
 ## Encoding (writing NT)
 
+`#to_nt` method:
+```irb
+irb> require 'nestedtext'
+irb> puts "a\nstring".to_nt
+> a
+> string
+irb> puts ["i1", "i2", "i3"].to_nt
+- i1
+- i2
+- i3
+irb> puts({"k1" => "v1", "multiline\nkey" => "v2", "k3" => "multiline\nvalue"}.to_nt)
+k1: v1
+: multiline
+: key
+    > v2
+k3:
+    > multiline
+    > value
+```
 ## Custom Classes Serialization
 This library has support for serialization/deserialization of custom classes as well.
 `strict: false` flag needed
@@ -70,9 +91,16 @@ See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.r
 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.  You can also run `$ script/console` for an interactive prompt that will allow you to experiment.
+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`
 
-To install this gem onto your local machine, run `$ bundle exec rake install`.
+Make sure that only intended constants and methods are exposed from the module `NestedText`. Check with
+```
+irb> require 'nestedtext'
+irb> NestedText.constants
+irb> NestedText.methods(false)
+```
 
 ## 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.

data/lib/nestedtext/constants.rb

@@ -2,4 +2,6 @@ require "stringio"
 module NestedText
   TOP_LEVEL_TYPES = [Object, Hash, Array, String]
   CUSTOM_CLASS_KEY = "__nestedtext_class__"
+
+  private_constant :TOP_LEVEL_TYPES, :CUSTOM_CLASS_KEY
 end

data/lib/nestedtext/core_ext.rb

@@ -5,12 +5,14 @@ require "nestedtext/encode_helpers"
 # Or both: add encoding/decoding of more native classes, and allow decoding + applying a schema with 3rd party.
 # Or encourage using Marshal from core?
 
-class String include NestedText::NTEncodeStrictMixing end
-class Array include NestedText::NTEncodeStrictMixing end
-class Hash include NestedText::NTEncodeStrictMixing end
+NT_MIXIN = NestedText.const_get(:NTEncodeStrictMixing)
+
+class String include NT_MIXIN end
+class Array include NT_MIXIN end
+class Hash include NT_MIXIN end
 
 class NilClass
-  include NestedText::NTEncodeStrictMixing
+  include NT_MIXIN
 
   def self.nt_create(_data) = nil
 

data/lib/nestedtext/decode.rb

@@ -2,7 +2,6 @@
 
 require "nestedtext/parser"
 require "nestedtext/errors"
-require "nestedtext/helpers"
 
 require "logger"
 require "stringio"
@@ -15,16 +14,12 @@ module NestedText
 
     raise Errors::WrongInputTypeError.new([String], ntstring) unless ntstring.nil? || ntstring.is_a?(String)
 
-    assert_valid_top_level_type top_class
-
     Parser.new(StringIO.new(ntstring), top_class, strict: strict).parse
   end
 
   def self.load_file(filename, top_class: Object, strict: true)
     raise Errors::WrongInputTypeError.new([String], filename) unless !filename.nil? && filename.is_a?(String)
 
-    assert_valid_top_level_type top_class
-
     # Open explicitly in text mode to detect \r as line ending.
     File.open(filename, mode = "rt") do |file|
       Parser.new(file, top_class, strict: strict).parse

data/lib/nestedtext/dumper.rb

@@ -174,4 +174,5 @@ module NestedText
       end
     end
   end
+  private_constant :Dumper
 end

data/lib/nestedtext/encode_helpers.rb

@@ -1,11 +1,13 @@
 require "nestedtext/dumper"
 
+# TODO: s/Mixing/Mixin/g
 module NestedText
   module NTEncodeStrictMixing
     def to_nt(indentation: 4, strict: true)
       Dumper.new(EncodeOptions.new(indentation, strict)).dump self
     end
   end
+  private_constant :NTEncodeStrictMixing
 
   module NTEncodeMixing
     def to_nt(indentation: 4)
@@ -21,4 +23,5 @@ module NestedText
       @strict = strict
     end
   end
+  private_constant :EncodeOptions
 end

data/lib/nestedtext/errors.rb

@@ -6,12 +6,19 @@ require "word_wrap/core_ext"
 require "nestedtext/constants"
 
 module NestedText
-  # Top level ParseError for clients to rescue.
-  class Error < StandardError; end
+  # Top level error for clients to rescue on.
+  # TODO hide #new so that client's cant create instance of it. Unit test this. https://ruby-doc.org/core-3.1.0/Module.html#private_class_method-method
+  class Error < StandardError
+    private_class_method :new
+  end
 
   module Errors
+    class InternalError < Error
+      public_class_method :new # Prevent clients from instansiating.
+    end
+
     # TODO: rename all Subclasses to ParseXError, just like for Dump
-    class ParseError < Error
+    class ParseError < InternalError
       attr_reader :lineno, :colno, :message_raw
 
       def initialize(line, colno, message)
@@ -177,25 +184,7 @@ module NestedText
       end
     end
 
-    class UnsupportedTopLevelTypeError < Error
-      def initialize(type_class)
-        super("The given top level type #{type_class&.name} is unsupported. Chose between #{TOP_LEVEL_TYPES.join(", ")}.")
-      end
-    end
-
-    class WrongInputTypeError < Error
-      def initialize(class_exps, class_act)
-        super("The given input type #{class_act.class.name} is unsupported. Expected to be of types #{class_exps.map(&:name).join(", ")}")
-      end
-    end
-
-    class TopLevelTypeMismatchParsedType < Error
-      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 AssertionError < Error; end
+    class AssertionError < InternalError; end
 
     class LineScannerIsEmpty < AssertionError
       def initialize
@@ -209,19 +198,7 @@ module NestedText
       end
     end
 
-    class DumpBadIO < Error
-      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 < Error
-      def initialize(path)
-        super("Must supply a string to a file path that can be written to. Given: #{path}")
-      end
-    end
-
-    class DumpError < Error
+    class DumpError < InternalError
       attr_reader :culprit
 
       def initialize(culprit, message)
@@ -258,5 +235,36 @@ module NestedText
 
       raise LineTagNotDetected, line
     end
+
+    class UnsupportedTopLevelTypeError < InternalError
+      def initialize(type_class)
+        super("The given top level type #{type_class&.name} is unsupported. Chose between #{TOP_LEVEL_TYPES.join(", ")}.")
+      end
+    end
+
+    class WrongInputTypeError < InternalError
+      def initialize(class_exps, class_act)
+        super("The given input type #{class_act.class.name} is unsupported. Expected to be of types #{class_exps.map(&:name).join(", ")}")
+      end
+    end
+
+    class TopLevelTypeMismatchParsedType < 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
+      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
+      def initialize(path)
+        super("Must supply a string to a file path that can be written to. Given: #{path}")
+      end
+    end
   end
+  private_constant :Errors
 end

data/lib/nestedtext/parser.rb

@@ -4,14 +4,20 @@ require "stringio"
 
 require "nestedtext/errors"
 require "nestedtext/scanners"
-require "nestedtext/helpers"
+require "nestedtext/constants"
 
 module NestedText
   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)
+        raise Errors::UnsupportedTopLevelTypeError, top_class
+      end
+    end
+
     # TODO: document that caller is responsible for closing IO after done with Parser.
     def initialize(io, top_class, strict: true)
       assert_valid_input_type io
-      NestedText.assert_valid_top_level_type(top_class)
+      Parser.assert_valid_top_level_type(top_class)
       @top_class = top_class
       @strict = strict
       @line_scanner = LineScanner.new(io)
@@ -284,4 +290,5 @@ module NestedText
       result
     end
   end
+  private_constant :Parser
 end

data/lib/nestedtext/scanners.rb

@@ -40,6 +40,7 @@ module NestedText
       @next_line = line
     end
   end
+  private_constant :LineScanner
 
   class InlineScanner
     attr_reader :line, :pos
@@ -68,6 +69,7 @@ module NestedText
       empty? ? nil : @line.content[@pos]
     end
   end
+  private_constant :InlineScanner
 
   class Line
     # Reference: https://nestedtext.org/en/latest/file_format.html
@@ -158,4 +160,5 @@ module NestedText
       end
     end
   end
+  private_constant :Line
 end

data/lib/nestedtext/version.rb

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

data/lib/nestedtext.rb

@@ -3,6 +3,7 @@
 require_relative "nestedtext/encode"
 require_relative "nestedtext/decode"
 require_relative "nestedtext/core_ext"
+require_relative "nestedtext/version"
 
 module NestedText
 end

data/nestedtext.gemspec

@@ -30,4 +30,7 @@ Gem::Specification.new do |spec|
     end
   end
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "warning", "~> 1.2"
+  spec.add_runtime_dependency "word_wrap", "~> 1.0"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: nestedtext
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
-dependencies: []
+date: 2022-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: word_wrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
@@ -40,7 +68,6 @@ files:
 - lib/nestedtext/encode.rb
 - lib/nestedtext/encode_helpers.rb
 - lib/nestedtext/errors.rb
-- lib/nestedtext/helpers.rb
 - lib/nestedtext/parser.rb
 - lib/nestedtext/scanners.rb
 - lib/nestedtext/version.rb

data/lib/nestedtext/helpers.rb

@@ -1,7 +0,0 @@
-module NestedText
-  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)
-      raise Errors::UnsupportedTopLevelTypeError, top_class
-    end
-  end
-end