json_in_kdl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 990ce9fd0c428a01599d5a40f05c10aec43f3fef8af30749023caa6397455b83
+  data.tar.gz: 8e138c02007b4e3fcea4f42f7a71023a37ebd261d85254f4505a6a483c88637b
+SHA512:
+  metadata.gz: ea9d72eccf0efe4ec7220c86067e5662aa43c6cd0d76e3b747aa15eb876304712707d16b1a3f568be4b2c91ae0978eb6cd2f0df52c979b098e0ae72000f622d4
+  data.tar.gz: 304da5d8fef546f3024d42c0d60b593c357afd8cab3aee1f636e82d0ab6950afa951b64170eb40ae19748287cb7708830e3ce8e894a25ee4f8b54dfcb2126802

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_in_kdl.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    json_in_kdl (0.1.0)
+      kdl (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    kdl (1.0.3)
+      simpleidn (~> 0.2.1)
+    minitest (5.16.1)
+    rake (13.0.6)
+    simpleidn (0.2.1)
+      unf (~> 0.1.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  json_in_kdl!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# JsonInKdl
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_in_kdl`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add json_in_kdl
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install json_in_kdl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_in_kdl.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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"]
+end
+
+task default: :test

data/json_in_kdl.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/json_in_kdl/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "json_in_kdl"
+  spec.version = JsonInKdl::VERSION
+  spec.authors = ["Danielle Smith"]
+  spec.email = ["danini@hey.com"]
+
+  spec.summary = "JSON-in-KDL (aka JiK)"
+  spec.description = "Allows JSON to be encoded as KDL"
+  spec.homepage = "https://github.com/kdl-org/kdl/blob/main/JSON-IN-KDL.md"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/danini-the-panini/json-in-kdl-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/danini-the-panini/json-in-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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "kdl", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/json_in_kdl/decoder.rb

@@ -0,0 +1,66 @@
+module JsonInKdl
+  module Decoder
+    class << self
+      def decode(kdl)
+        raise Error, "JiK must have exactly one root node" unless kdl.nodes.size == 1
+
+        decode_node(kdl.nodes.first, true)
+      end
+
+      private
+
+      def decode_node(node, top = false)
+        case node.name
+        when 'object'
+          decode_object(node)
+        when 'array'
+          decode_array(node)
+        when '-'
+          decode_primitive(node, top)
+        else
+          raise Error, "JiK node names must be one of object, array, or '-'"
+        end
+      end
+
+      def decode_object(node)
+        raise Error, "JiK object nodes should not have any arguments" unless node.arguments.empty?
+
+        hash = {}
+        node.properties.each do |key, value|
+          raise Error, "JiK object properties should not have a type" if value.type
+          hash[key] = value.value
+        end
+        node.children.each do |child|
+          raise Error, "JiK object children should have a type" unless child.type
+          hash[child.type] = decode_node(child)
+        end
+        hash
+      end
+
+      def decode_array(node)
+        raise Error, "JiK array nodes should not have any properties" unless node.properties.empty?
+
+        array = []
+        node.arguments.each do |arg|
+          raise Error, "JiK array arguments should not have a type" if arg.type
+          array << arg.value
+        end
+        node.children.each do |child|
+          raise Error, "JiK array children should not have a type" if child.type
+          array << decode_node(child)
+        end
+        array
+      end
+
+      def decode_primitive(node, top)
+        raise Error, "JiK primitive nodes should only have a single argument" unless node.arguments.size == 1
+        raise Error, "JiK primitive nodes should not have any properties" unless node.properties.empty?
+        raise Error, "JiK primitive nodes should not have any children" unless node.children.empty?
+        raise Error, "JiK primitive node argument should not have a type" if node.arguments.first.type
+        raise Error, "JiK primitive nodes should not have a type" if top && node.type
+
+        return node.arguments.first.value
+      end
+    end
+  end
+end

data/lib/json_in_kdl/encoder.rb

@@ -0,0 +1,57 @@
+module JsonInKdl
+  module Encoder
+    class << self
+      def encode(json)
+        return ::KDL::Document.new([json_to_node(json)])
+      end
+
+      private
+
+      def json_to_node(json)
+        case json
+        when TrueClass, FalseClass, NilClass, Numeric, String
+          primitive_to_node(json)
+        when Hash
+          object_to_node(json)
+        when Array
+          array_to_node(json)
+        else
+          raise Error, "#{json.inspect} is not a JSON type"
+        end
+      end
+  
+      def primitive_to_node(value)
+        return ::KDL::Node.new('-', [::KDL::Value.from(value)])
+      end
+  
+      def object_to_node(hash)
+        props = {}
+        children = []
+        hash.each do |key, value|
+          if children.any? || value.is_a?(Hash) || value.is_a?(Array)
+            node = json_to_node(value)
+            node.type = key
+            children << node
+          else
+            props[key] = ::KDL::Value.from(value)
+          end
+        end
+        return ::KDL::Node.new('object', [], props, children)
+      end
+  
+      def array_to_node(array)
+        attributes = []
+        children = []
+        array.each do |value|
+          if children.any? || value.is_a?(Hash) || value.is_a?(Array)
+            node = json_to_node(value)
+            children << node
+          else
+            attributes << ::KDL::Value.from(value)
+          end
+        end
+        return ::KDL::Node.new('array', attributes, {}, children)
+      end
+    end
+  end
+end

data/lib/json_in_kdl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonInKdl
+  VERSION = "0.1.0"
+end

data/lib/json_in_kdl.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "kdl"
+require "json"
+require_relative "json_in_kdl/version"
+require_relative "json_in_kdl/encoder"
+require_relative "json_in_kdl/decoder"
+
+module JsonInKdl
+  class Error < StandardError; end
+
+  class << self
+    def encode(json)
+      Encoder.encode(json)
+    end
+
+    def encode_string(string)
+      Encoder.encode(JSON.parse(string))
+    end
+
+    def decode(kdl)
+      Decoder.decode(kdl)
+    end
+
+    def decode_string(string)
+      Decoder.decode(::KDL.parse_document(kdl))
+    end
+  end
+end

data/sig/json_in_kdl.rbs

@@ -0,0 +1,4 @@
+module JsonInKdl
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: json_in_kdl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danielle Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kdl
+  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: Allows JSON to be encoded as KDL
+email:
+- danini@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_in_kdl.gemspec
+- lib/json_in_kdl.rb
+- lib/json_in_kdl/decoder.rb
+- lib/json_in_kdl/encoder.rb
+- lib/json_in_kdl/version.rb
+- sig/json_in_kdl.rbs
+homepage: https://github.com/kdl-org/kdl/blob/main/JSON-IN-KDL.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kdl-org/kdl/blob/main/JSON-IN-KDL.md
+  source_code_uri: https://github.com/danini-the-panini/json-in-kdl-rb
+  changelog_uri: https://github.com/danini-the-panini/json-in-kdl-rb/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: JSON-in-KDL (aka JiK)
+test_files: []