xml_in_kdl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd2877c988925b9a88007a1903e8e37af9467b41b42291b2be12558b00e286d4
+  data.tar.gz: 63e89b10da00d6891f5a42e784dfdcc928968cc191cc8d8c5e552c7fe31ca300
+SHA512:
+  metadata.gz: 752285a593c4becb8b57f3fda7a61d54a7db7f0e0ef1afb424ae287e84fd228617df9ab93390f2b11084ee540cdb77e9a2a83641ce1835dc9d8c9cba29c6fea2
+  data.tar.gz: ad06c71e423144d38da8e9e3e8b1117d0dc724b916129bd32ed9a51016b1fc9a266e183ca3a177fb040faa3d2ea055bd7677f05393f1052b6f1979abbb793c00

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    xml_in_kdl (0.1.0)
+      kdl (~> 1.0)
+      nokogiri (~> 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    kdl (1.0.3)
+      simpleidn (~> 0.2.1)
+    minitest (5.16.1)
+    nokogiri (1.13.6-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.0)
+    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
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  xml_in_kdl!
+
+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 @@
+# XmlInKdl
+
+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/xml_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 xml_in_kdl
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install xml_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]/xml_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/lib/xml_in_kdl/decoder.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module XmlInKdl
+  class Decoder
+    def initialize(kdl)
+      @kdl = kdl
+      @xml_doc = ::Nokogiri::XML::Document.new
+    end
+
+    def self.decode(kdl)
+      new(kdl).decode
+    end
+
+    def decode
+      @kdl.nodes.each do |kdl_node|
+        xml_node = decode_node(kdl_node)
+        @xml_doc.add_child(xml_node) unless xml_node.nil?
+      end
+      @xml_doc
+    end
+
+    private
+
+    def decode_node(node)
+      case node.name
+      when /^\?/
+        decode_directive(node)
+      when '!'
+        decode_comment(node)
+      when /^!/
+        decode_doctype(node)
+      when '-'
+        decode_text(node)
+      else
+        decode_element(node)
+      end
+    end
+
+    DIRECTIVE_ERROR_STRING = "XiK directive nodes must only contain properties"
+    def decode_directive(directive)
+      raise Error, DIRECTIVE_ERROR_STRING unless directive.children.empty? && directive.arguments.empty?
+      raise Error, DIRECTIVE_ERROR_STRING if directive.properties.values.any? { |v| !v.is_a?(::KDL::Value::String) }
+
+      if directive.properties['version']
+        @xml_doc = ::Nokogiri::XML::Document.new(directive.properties['version'].value)
+      end
+      if directive.properties['encoding']
+        @xml_doc.encoding = directive.properties['encoding'].value
+      end
+      # TODO: more directives, e.g. "standalone"
+      nil
+    end
+
+    COMMENT_ERROR_STRING = "XiK comment nodes must contain exactly one string argument and nothing else"
+    def decode_comment(comment)
+      raise Error, COMMENT_ERROR_STRING unless comment.children.empty? && comment.properties.empty?
+      raise Error, COMMENT_ERROR_STRING unless comment.arguments.size == 1
+      raise Error, COMMENT_ERROR_STRING unless comment.arguments.first.is_a?(::KDL::Value::String)
+
+      ::Nokogiri::XML::Comment.new(@xml_doc, comment.arguments.first.value)
+    end
+
+    DOCTYPE_ERORR_STRING = "XiK doctype nodes must contain 1 to 3 string arguments and nothing else"
+    def decode_doctype(doctype)
+      raise Error, DOCTYPE_ERORR_STRING unless doctype.children.empty? && doctype.properties.empty?
+      raise Error, DOCTYPE_ERORR_STRING unless doctype.arguments.size >= 1 && doctype.arguments.size <= 3
+      raise Error, DOCTYPE_ERORR_STRING unless doctype.arguments.all? { |arg| arg.is_a?(::KDL::Value::String) }
+
+      args = doctype.arguments.map(&:value)
+      args << nil while args.length < 3
+      @xml_doc.create_internal_subset(*args)
+      nil
+    end
+
+    TEXT_ERORR_STRING = "XiK text nodes must contain exactly one string argument and nothing else"
+    def decode_text(text)
+      raise Error, TEXT_ERORR_STRING unless text.children.empty? && text.properties.empty?
+      raise Error, TEXT_ERORR_STRING unless text.arguments.size == 1
+      raise Error, TEXT_ERORR_STRING unless text.arguments.first.is_a?(::KDL::Value::String)
+
+      decode_string(text.arguments.first)
+    end
+
+    STRING_ERROR_STRING = "XiK values must be strings"
+    def decode_string(string)
+      raise Error, STRING_ERROR_STRING unless string.is_a?(::KDL::Value::String)
+
+      ::Nokogiri::XML::Text.new(string.value, @xml_doc)
+    end
+
+    ELEMENT_ERROR_STRING = "XiK elements must have either one string argument OR any number of children"
+    def decode_element(element)
+      if element.children.empty?
+        raise Error, ELEMENT_ERROR_STRING unless element.arguments.size <= 1
+      else
+        raise Error, ELEMENT_ERROR_STRING unless element.arguments.empty?
+      end
+      raise Error, STRING_ERROR_STRING if element.properties.values.any? { |v| !v.is_a?(::KDL::Value::String) }
+
+      node = @xml_doc.create_element(element.name, element.properties.transform_values { |v| v.value.to_s })
+      if element.arguments.empty?
+        element.children.each do |kdl_child|
+          xml_child = decode_node(kdl_child)
+          node.add_child(xml_child) unless xml_child.nil?
+        end
+      else
+        node.add_child(decode_string(element.arguments.first)) unless element.arguments.empty?
+      end
+      node
+    end
+  end
+end

data/lib/xml_in_kdl/encoder.rb

@@ -0,0 +1,65 @@
+module XmlInKdl
+  module Encoder
+    class << self
+      def encode(xml)
+        encoding_node = encode_encoding(xml.encoding)
+        children = xml.children.map { |c| encode_node(c) }
+        ::KDL::Document.new([encoding_node, *children].compact)
+      end
+
+      private
+
+      def encode_node(node)
+        case node
+        when Nokogiri::XML::Element
+          encode_element(node)
+        when Nokogiri::XML::Text
+          encode_text(node)
+        when Nokogiri::XML::DTD
+          encode_dtd(node)
+        when Nokogiri::XML::Comment
+          encode_comment(node)
+        end
+      end
+
+      def encode_element(element)
+        arguments = []
+        children = []
+        properties = element.attributes.map { |key, value| [key, ::KDL::Value.from(value.value)] }.to_h
+        if !properties.empty? || element.children.any? { |c| c.is_a?(Nokogiri::XML::Element) }
+          children = element.children.map { |c| encode_node(c) }.compact
+        elsif element.children.first.is_a?(Nokogiri::XML::Text)
+          content = element.children.first.content.strip
+          arguments = [::KDL::Value.from(element.children.first.content.strip)] unless content.empty?
+        end
+        ::KDL::Node.new(element.name, arguments, properties, children)
+      end
+
+      def encode_text(text)
+        content = squish(text.content)
+        return nil if content.strip.empty?
+
+        ::KDL::Node.new('-', [::KDL::Value.from(content)])
+      end
+
+      def encode_dtd(dtd)
+        args = [dtd.name, dtd.external_id, dtd.system_id].compact.map { |x| ::KDL::Value.from(x) }
+        ::KDL::Node.new('!doctype', args)
+      end
+
+      def encode_encoding(encoding)
+        return nil if encoding.nil?
+
+        ::KDL::Node.new('?xml', [], { 'encoding' => KDL::Value.from(encoding) })
+      end
+
+      def squish(string)
+        string.gsub(/(^\s+|\s+$)/, ' ')
+      end
+
+      def encode_comment(comment)
+        ::KDL::Node.new('!', [::KDL::Value.from(comment.content)])
+      end
+    end
+  end
+end

data/lib/xml_in_kdl/version.rb

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

data/lib/xml_in_kdl.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "kdl"
+require "nokogiri"
+require_relative "xml_in_kdl/version"
+require_relative "xml_in_kdl/encoder"
+require_relative "xml_in_kdl/decoder"
+
+module XmlInKdl
+  class Error < StandardError; end
+
+  class << self
+    def encode(xml)
+      Encoder.encode(xml)
+    end
+
+    def encode_string(xml)
+      encode(::Nokogiri::XML(xml))
+    end
+
+    def decode(kdl)
+      Decoder.decode(kdl)
+    end
+
+    def decode_string(kdl)
+      decode(::KDL.parse_document(kdl))
+    end
+  end
+end

data/sig/xml_in_kdl.rbs

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

data/xml_in_kdl.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/xml_in_kdl/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "xml_in_kdl"
+  spec.version = XmlInKdl::VERSION
+  spec.authors = ["Danielle Smith"]
+  spec.email = ["danini@hey.com"]
+
+  spec.summary = "XML-in-KDL (aka XiK)"
+  spec.description = "Allows XML to be encoded as KDL"
+  spec.homepage = "https://github.com/kdl-org/kdl/blob/main/XML-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/xml-in-kdl-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/danini-the-panini/xml-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"
+  spec.add_dependency "nokogiri", "~> 1.13"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: xml_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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: Allows XML to be encoded as KDL
+email:
+- danini@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xml_in_kdl.rb
+- lib/xml_in_kdl/decoder.rb
+- lib/xml_in_kdl/encoder.rb
+- lib/xml_in_kdl/version.rb
+- sig/xml_in_kdl.rbs
+- xml_in_kdl.gemspec
+homepage: https://github.com/kdl-org/kdl/blob/main/XML-IN-KDL.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kdl-org/kdl/blob/main/XML-IN-KDL.md
+  source_code_uri: https://github.com/danini-the-panini/xml-in-kdl-rb
+  changelog_uri: https://github.com/danini-the-panini/xml-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: XML-in-KDL (aka XiK)
+test_files: []