kdl 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d22aaf844ad47e14321925d2ef8d3346b0960fe5d284ca191fb25231571d2c
-  data.tar.gz: c22e4025f6ed2f42654e899123f46a46f195ce7b14d002b2c240d6b24222871a
+  metadata.gz: 9ded4c2fceb98dde6ae4421034c52e2c26ca36894da75def6bc358de10339dce
+  data.tar.gz: 00c0e2c08400aed4edddd124c337cd3a5169557bb74666d9cb5cbbc3821fd7aa
 SHA512:
-  metadata.gz: a810a2fbd5c1d3336e89bff3a59af3e93aa9d1c1fc80c37e5f02e93d9b96bec0a6cf6ad448b8c6d624d380dee65a5c99290c4352edb3acca5b673a4728c8aa45
-  data.tar.gz: b1af0ff7997fac32d3d4640866b788cf884cfac8ca342e6de02296c59f5ef58b4d230d0a67be17cc687c98dd6ad15f0f21b729c2dbcd27f3ffadf2d5169f70ee
+  metadata.gz: 655e6cb06085648a3aab37298e1214ebda9cc64c8576e5b6ca8528f2d86e8376c14755fdcbd946999f30598189d95f31850de223f563a3c08099d71912714f61
+  data.tar.gz: cb7e37ea4400ec877fa7c3cbb584d88eb6686194a0c1545b99c2331725195da826a62f33bfe2e01f3b5d371c1d0429db7f550d26ad8b15cbc84e2c7b6fc0a580

data/.github/workflows/ruby.yml

@@ -17,18 +17,19 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0.0-preview1]
+        ruby: [2.4, 2.5, 2.6, 2.7, 3.0, head]
 
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
+      with:
+        submodules: true
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: gem install bundler && bundle install
+        bundler-cache: true # install and cache dependencies
     - name: Build parser
       run: bundle exec racc lib/kdl/kdl.yy
     - name: Run tests

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/kdl-org"]
+	path = test/kdl-org
+	url = git@github.com:kdl-org/kdl

data/README.md

@@ -1,6 +1,6 @@
 # KDL
 
-[![Actions Status](https://github.com/jellymann/kdl-rb/workflows/Ruby/badge.svg)](https://github.com/jellymann/kdl-rb\/actions)
+[![Actions Status](https://github.com/danini-the-panini/kdl-rb/workflows/Ruby/badge.svg)](https://github.com/danini-the-panini/kdl-rb/actions)
 
 This is a Ruby implementation of the [KDL Document Language](https://kdl.dev)
 
@@ -28,6 +28,20 @@ require 'kdl'
 KDL.parse_document(a_string) #=> KDL::Document
 ```
 
+You can optionally provide your own type annotation handlers:
+
+```ruby
+KDL.parse_document(a_string, type_parsers: {
+  'foo' => -> (value, type) {
+    Foo.new(value.value, type: type)
+  }
+})
+```
+
+The `foo` proc will be called with instances of Value or Node with the type annotation `(foo)`.
+
+Parsers are expected to have a `call` method that takes the Value or Node, and the type annotation itself, as arguments, and is expected to return either an instance of Value or Node (depending on the input type) or `nil` to return the original value as is. Take a look at [the built in parsers](lib/kdl/types) as a reference.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -36,7 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jellymann/kdl-rb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/danini-the-panini/kdl-rb.
 
 
 ## License

data/Rakefile

@@ -1,10 +1,15 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+file 'lib/kdl/kdl.tab.rb' => ['lib/kdl/kdl.yy'] do
+  raise "racc command failed" unless system 'bin/racc lib/kdl/kdl.yy'
+end
+task :racc => 'lib/kdl/kdl.tab.rb'
+
+Rake::TestTask.new(:test => :racc) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
   t.options = '--pride'
 end
 

data/bin/console

@@ -10,5 +10,7 @@ require "kdl"
 # require "pry"
 # Pry.start
 
+system 'bin/rake racc'
+
 require "irb"
 IRB.start(__FILE__)

data/bin/racc

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'racc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("racc", "racc")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -6,3 +6,4 @@ set -vx
 bundle install
 
 # Do any other automated setup that you need to do here
+bin/rake racc

data/kdl.gemspec

@@ -3,18 +3,18 @@ require_relative 'lib/kdl/version'
 Gem::Specification.new do |spec|
   spec.name          = "kdl"
   spec.version       = KDL::VERSION
-  spec.authors       = ["Daniel Smith"]
+  spec.authors       = ["Danielle Smith"]
   spec.email         = ["danini@hey.com"]
 
   spec.summary       = %q{KDL Document Language}
   spec.description   = %q{Ruby implementation of the KDL Document Language Spec}
   spec.homepage      = "https://kdl.dev"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/jellymann/kdl-rb"
-  spec.metadata["changelog_uri"] = "https://github.com/jellymann/kdl-rb/releases"
+  spec.metadata["source_code_uri"] = "https://github.com/danini-the-panini/kdl-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/danini-the-panini/kdl-rb/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end + ['lib/kdl/kdl.tab.rb']
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'racc', '~> 1.5'
+  spec.add_dependency 'simpleidn', '~> 0.2.1'
 end

data/lib/kdl/document.rb

@@ -7,9 +7,8 @@ module KDL
     end
 
     def to_s
-      @nodes.map(&:to_s).join("\n")
+      @nodes.map(&:to_s).join("\n") + "\n"
     end
-    alias inspect to_s
 
     def ==(other)
       return false unless other.is_a?(Document)