tilia-xml 1.2.0

data/test/xml/service_test.rb

@@ -0,0 +1,156 @@
+require 'test_helper'
+require 'stringio'
+
+module Tilia
+  module Xml
+    class ServiceTest < Minitest::Test
+      def setup
+        @util = Service.new
+      end
+
+      def test_get_reader
+        elems = { '{http://sabre.io/ns}test' => 'Test!' }
+
+        @util.element_map = elems
+
+        reader = @util.reader
+        assert_instance_of(Reader, reader)
+        assert_equal(elems, reader.element_map)
+      end
+
+      def test_get_writer
+        ns = { 'http://sabre.io/ns' => 's' }
+
+        @util.namespace_map = ns
+        writer = @util.writer
+
+        assert_instance_of(Writer, writer)
+        assert_equal(ns, writer.namespace_map)
+      end
+
+      def test_parse
+        xml = <<XML
+<root xmlns="http://sabre.io/ns">
+  <child>value</child>
+</root>
+XML
+        root_element = ''
+        result = @util.parse(xml, nil, root_element)
+        assert_equal('{http://sabre.io/ns}root', root_element)
+
+        expected = [
+          {
+            'name'       => '{http://sabre.io/ns}child',
+            'value'      => 'value',
+            'attributes' => {}
+          }
+        ]
+
+        assert_equal(expected, result)
+      end
+
+      def test_parse_stream
+        xml = <<XML
+<root xmlns="http://sabre.io/ns">
+  <child>value</child>
+</root>
+XML
+        stream = StringIO.new
+        stream.write xml
+        stream.rewind
+
+        root_element = ''
+        result = @util.parse(stream, nil, root_element)
+        assert_equal('{http://sabre.io/ns}root', root_element)
+
+        expected = [
+          {
+            'name'       => '{http://sabre.io/ns}child',
+            'value'      => 'value',
+            'attributes' => {}
+          }
+        ]
+
+        assert_equal(expected, result)
+      end
+
+      def test_expect
+        xml = <<XML
+<root xmlns="http://sabre.io/ns">
+  <child>value</child>
+</root>
+XML
+        result = @util.expect('{http://sabre.io/ns}root', xml)
+
+        expected = [
+          {
+            'name'       => '{http://sabre.io/ns}child',
+            'value'      => 'value',
+            'attributes' => {}
+          }
+        ]
+
+        assert_equal(expected, result)
+      end
+
+      def test_expect_stream
+        xml = <<XML
+<root xmlns="http://sabre.io/ns">
+  <child>value</child>
+</root>
+XML
+
+        stream = StringIO.new
+        stream.write xml
+        stream.rewind
+
+        result = @util.expect('{http://sabre.io/ns}root', xml)
+
+        expected = [
+          {
+            'name'       => '{http://sabre.io/ns}child',
+            'value'      => 'value',
+            'attributes' => {}
+          }
+        ]
+
+        assert_equal(expected, result)
+      end
+
+      def test_expect_wrong
+        xml = <<XML
+<root xmlns="http://sabre.io/ns">
+  <child>value</child>
+</root>
+XML
+        assert_raises(ParseException) { @util.expect('{http://sabre.io/ns}error', xml) }
+      end
+
+      def test_write
+        @util.namespace_map = { 'http://sabre.io/ns' => 's' }
+        result = @util.write(
+          '{http://sabre.io/ns}root',
+          '{http://sabre.io/ns}child' => 'value'
+        )
+
+        expected = <<XML
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabre.io/ns">
+ <s:child>value</s:child>
+</s:root>
+XML
+        assert_equal(expected, result)
+      end
+
+      def test_parse_clark_notation
+        expected = ['http://sabredav.org/ns', 'elem']
+        result = Service.parse_clark_notation('{http://sabredav.org/ns}elem')
+        assert_equal(expected, result)
+      end
+
+      def test_parse_clark_notation_fail
+        assert_raises(ArgumentError) { Service.parse_clark_notation('http://sabredav.org/ns}elem') }
+      end
+    end
+  end
+end

data/test/xml/writer_test.rb

@@ -0,0 +1,260 @@
+require 'test_helper'
+require 'stringio'
+
+module Tilia
+  module Xml
+    class WriterTest < Minitest::Test
+      def setup
+        @writer = Tilia::Xml::Writer.new
+        @writer.namespace_map = { 'http://sabredav.org/ns' => 's' }
+        @writer.open_memory
+        @writer.set_indent(true)
+        @writer.start_document
+      end
+
+      def compare(input, output)
+        @writer.write(input)
+        assert_equal(output, @writer.output_memory)
+      end
+
+      # rubocop:disable Style/ClosingParenthesisIndentation
+      # Rubocop has a problem with the closing parenthesis of the long compare()
+      # statements, but IMO that's the best way.
+      def test_simple
+        compare(
+          { '{http://sabredav.org/ns}root' => 'text' },
+          <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">text</s:root>
+HI
+        )
+      end
+
+      def test_simple_quotes
+        compare({ '{http://sabredav.org/ns}root' => '"text"' }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">&quot;text&quot;</s:root>
+HI
+        )
+      end
+
+      def test_simple_attributes
+        compare(
+          {
+            '{http://sabredav.org/ns}root' => {
+              'value'      => 'text',
+              'attributes' => {
+                'attr1' => 'attribute value'
+              }
+            }
+          }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns" attr1="attribute value">text</s:root>
+HI
+        )
+      end
+
+      def test_mixed_syntax
+        compare(
+          {
+            '{http://sabredav.org/ns}root' => {
+              'single'   => 'value',
+              'multiple' => [
+                {
+                  'name'  => 'foo',
+                  'value' => 'bar'
+                },
+                {
+                  'name'  => 'foo',
+                  'value' => 'foobar'
+                }
+              ],
+              'attributes' => {
+                'value'      => nil,
+                'attributes' => {
+                  'foo' => 'bar'
+                }
+              },
+              'verbose' => { # RUBY
+                # 'name'       => 'verbose', # RUBY
+                'value'      => 'syntax',
+                'attributes' => {
+                  'foo' => 'bar'
+                }
+              }
+            }
+          }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <single>value</single>
+ <multiple>
+  <foo>bar</foo>
+  <foo>foobar</foo>
+ </multiple>
+ <attributes foo="bar"/>
+ <verbose foo="bar">syntax</verbose>
+</s:root>
+HI
+          )
+      end
+
+      def test_null
+        compare({ '{http://sabredav.org/ns}root' => nil }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns"/>
+HI
+          )
+      end
+
+      def test_array_format2
+        compare(
+          {
+            '{http://sabredav.org/ns}root' => [
+              {
+                'name'       => '{http://sabredav.org/ns}elem1',
+                'value'      => 'text',
+                'attributes' => {
+                  'attr1' => 'attribute value'
+                }
+              }
+            ]
+          }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <s:elem1 attr1="attribute value">text</s:elem1>
+</s:root>
+HI
+        )
+      end
+
+      def test_custom_namespace
+        compare(
+          {
+            '{http://sabredav.org/ns}root' => {
+              '{urn:foo}elem1' => 'bar'
+            }
+          }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <x1:elem1 xmlns:x1="urn:foo">bar</x1:elem1>
+</s:root>
+HI
+        )
+      end
+
+      def test_empty_namespace
+        # Empty namespaces are allowed, so we should support this.
+        compare({ '{http://sabredav.org/ns}root' => { '{}elem1' => 'bar' } }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <elem1 xmlns="">bar</elem1>
+</s:root>
+HI
+        )
+      end
+
+      def test_attributes
+        compare(
+          {
+            '{http://sabredav.org/ns}root' => [
+              {
+                'name'       => '{http://sabredav.org/ns}elem1',
+                'value'      => 'text',
+                'attributes' => {
+                  'attr1'                         => 'val1',
+                  '{http://sabredav.org/ns}attr2' => 'val2',
+                  '{urn:foo}attr3'                => 'val3'
+                }
+              }
+            ]
+          }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <s:elem1 attr1="val1" s:attr2="val2" x1:attr3="val3" xmlns:x1="urn:foo">text</s:elem1>
+</s:root>
+HI
+        )
+      end
+
+      def test_invalid_format
+        assert_raises(ArgumentError) do
+          compare(
+            {
+              '{http://sabredav.org/ns}root' => [
+                { 'incorrect' => '0', 'keynames' => 1 }
+              ]
+            },
+            ''
+          )
+        end
+      end
+
+      def test_base_element
+        compare({ '{http://sabredav.org/ns}root' => Tilia::Xml::Element::Base.new('hello') }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">hello</s:root>
+HI
+        )
+      end
+
+      def test_element_obj
+        compare({ '{http://sabredav.org/ns}root' => Tilia::Xml::Element::Mock.new }, <<HI
+<?xml version="1.0"?>
+<s:root xmlns:s="http://sabredav.org/ns">
+ <s:elem1>hiiii!</s:elem1>
+</s:root>
+HI
+        )
+      end
+
+      def test_empty_namespace_prefix
+        @writer.namespace_map['http://sabredav.org/ns'] = nil
+        compare({ '{http://sabredav.org/ns}root' => Tilia::Xml::Element::Mock.new }, <<HI
+<?xml version="1.0"?>
+<root xmlns="http://sabredav.org/ns">
+ <elem1>hiiii!</elem1>
+</root>
+HI
+        )
+      end
+
+      def test_write_element
+        @writer.write_element('{http://sabredav.org/ns}foo', 'content')
+
+        output = <<HI
+<?xml version="1.0"?>
+<s:foo xmlns:s="http://sabredav.org/ns">content</s:foo>
+HI
+        assert_equal(output, @writer.output_memory)
+      end
+
+      def test_write_element_complex
+        @writer.write_element('{http://sabredav.org/ns}foo', Tilia::Xml::Element::KeyValue.new('{http://sabredav.org/ns}bar' => 'test'))
+
+        output = <<HI
+<?xml version="1.0"?>
+<s:foo xmlns:s="http://sabredav.org/ns">
+ <s:bar>test</s:bar>
+</s:foo>
+HI
+        assert_equal(output, @writer.output_memory)
+      end
+
+      def test_write_bad_object
+        assert_raises(ArgumentError) { @writer.write(Class.new) }
+      end
+
+      def test_start_element_simple
+        @writer.start_element('foo')
+        @writer.end_element
+
+        output = <<HI
+<?xml version="1.0"?>
+<foo xmlns:s="http://sabredav.org/ns"/>
+HI
+        assert_equal(output, @writer.output_memory)
+      end
+      # rubocop:enable Style/ClosingParenthesisIndentation
+    end
+  end
+end

data/tilia-xml.gemspec

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), 'lib', 'tilia', 'xml', 'version')
+Gem::Specification.new do |s|
+  s.name        = 'tilia-xml'
+  s.version     = Tilia::Xml::Version::VERSION
+  s.licenses    = ['BSD-3-Clause']
+  s.summary     = 'Port of the sabre-xml library to ruby.'
+  s.description = "Port of the sabre-xml library to ruby.\n\nThe Tilia XML parser is the only XML library that you may not hate."
+  s.author      = 'Jakob Sack'
+  s.email       = 'tilia@jakobsack.de'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/tilia/tilia-xml'
+  s.add_runtime_dependency 'activesupport', '~> 4.2'
+  s.add_runtime_dependency 'libxml-ruby', '~> 2.8'
+  s.add_runtime_dependency 'tilia-uri', '~> 1.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: tilia-xml
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Jakob Sack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: tilia-uri
+  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: |-
+  Port of the sabre-xml library to ruby.
+
+  The Tilia XML parser is the only XML library that you may not hate.
+email: tilia@jakobsack.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.sabre.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.sabre
+- README.md
+- Rakefile
+- lib/tilia/xml.rb
+- lib/tilia/xml/context_stack_trait.rb
+- lib/tilia/xml/element.rb
+- lib/tilia/xml/element/base.rb
+- lib/tilia/xml/element/cdata.rb
+- lib/tilia/xml/element/elements.rb
+- lib/tilia/xml/element/key_value.rb
+- lib/tilia/xml/element/uri.rb
+- lib/tilia/xml/element/xml_fragment.rb
+- lib/tilia/xml/lib_xml_exception.rb
+- lib/tilia/xml/parse_exception.rb
+- lib/tilia/xml/reader.rb
+- lib/tilia/xml/service.rb
+- lib/tilia/xml/version.rb
+- lib/tilia/xml/writer.rb
+- lib/tilia/xml/xml_deserializable.rb
+- lib/tilia/xml/xml_serializable.rb
+- test/test_helper.rb
+- test/xml/context_stack_test.rb
+- test/xml/element/cdata_test.rb
+- test/xml/element/eater.rb
+- test/xml/element/elements_test.rb
+- test/xml/element/key_value_test.rb
+- test/xml/element/mock.rb
+- test/xml/element/uri_test.rb
+- test/xml/element/xml_fragment_test.rb
+- test/xml/infite_loop_test.rb
+- test/xml/reader_test.rb
+- test/xml/service_test.rb
+- test/xml/writer_test.rb
+- tilia-xml.gemspec
+homepage: https://github.com/tilia/tilia-xml
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Port of the sabre-xml library to ruby.
+test_files: []
+has_rdoc: