tilia-xml 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3fb4181ed07ce2430cb07b7fb523b084bf745a2
+  data.tar.gz: c47a873a3d33f0605a0f5427b42beae183a8b2c6
+SHA512:
+  metadata.gz: e67f3310cad179234b9539320a0930ab2f0056438d9f49fda16cabb0640ee9f12bb51f64e108e72f2bf9687186213aef77227bacbe9bd6bad0b98e99f5629d2b
+  data.tar.gz: 35c16b92d5fabb186167abcb33c47c8d4f35c0866326724585fa41b3c656d0bbdac050bc48164a601879fbec5f9ed4c564655014d49f1dd84c091e561a0f2c1b

data/.gitignore

@@ -0,0 +1,19 @@
+# Gem files
+/*.gem
+
+# backup files
+*~
+
+# swap files
+*.swp
+*.kate-swp
+
+# file manager files
+*.directory
+
+# coverage
+/coverage
+
+# documentation
+/doc
+/.yardoc

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# Disable metrics - we stick to the sabre coding
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# ['word', 'array'] looks better when aligned with other arrays that can't use
+# %w() syntax
+Style/WordArray:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end
+

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.3

data/CHANGELOG.sabre.md

@@ -0,0 +1,167 @@
+ChangeLog
+=========
+
+1.2.0 (2015-08-30)
+------------------
+
+* #53: Added `parseGetElements`, a function like `parseInnerTree`, except
+  that it always returns an array of elements, or an empty array.
+
+
+1.1.0 (2015-06-29)
+------------------
+
+* #44, #45: Catching broken and invalid XML better and throwing
+  `Sabre\Xml\LibXMLException` whenever we encounter errors. (@stefanmajoor,
+   @DaanBiesterbos)
+
+
+1.0.0 (2015-05-25)
+------------------
+
+* No functional changes since 0.4.3. Marking it as 1.0.0 as a promise for
+  API stability.
+* Using php-cs-fixer for automated CS enforcement.
+
+
+0.4.3 (2015-04-01)
+-----------------
+
+* Minor tweaks for the public release.
+
+
+0.4.2 (2015-03-20)
+------------------
+
+* Removed `constants.php` again. They messed with PHPUnit and don't really
+  provide a great benefit.
+* #41: Correctly handle self-closing xml elements.
+
+
+0.4.1 (2015-03-19)
+------------------
+
+* #40: An element with an empty namespace (xmlns="") is not allowed to have a
+  prefix. This is now fixed.
+
+
+0.4.0 (2015-03-18)
+------------------
+
+* Added `Sabre\Xml\Service`. This is intended as a simple way to centrally
+  configure xml applications and easily parse/write things from there. #35, #38.
+* Renamed 'baseUri' to 'contextUri' everywhere.
+* #36: Added a few convenience constants to `lib/constants.php`.
+* `Sabre\Xml\Util::parseClarkNotation` is now in the `Sabre\Xml\Service` class.
+
+
+0.3.1 (2015-02-08)
+------------------
+
+* Added `XmlDeserializable` to match `XmlSerializable`.
+
+
+0.3.0 (2015-02-06)
+------------------
+
+* Added `$elementMap` argument to parseInnerTree, for quickly overriding
+  parsing rules within an element.
+
+
+0.2.2 (2015-02-05)
+------------------
+
+* Now depends on sabre/uri 1.0.
+
+
+0.2.1 (2014-12-17)
+------------------
+
+* LibXMLException now inherits from ParseException, so it's easy for users to
+  catch any exception thrown by the parser.
+
+
+0.2.0 (2014-12-05)
+------------------
+
+* Major BC Break: method names for the Element interface have been renamed
+  from `serializeXml` and `deserializeXml` to `xmlSerialize` and
+  `xmlDeserialize`. This is so that it matches PHP's `JsonSerializable`
+  interface.
+* #25: Added `XmlSerializable` to allow people to write serializers without
+  having to implement a deserializer in the same class.
+* #26: Renamed the `Sabre\XML` namespace to `Sabre\Xml`. Due to composer magic
+  and the fact that PHP namespace are case-insensitive, this should not affect
+  anyone, unless you are doing exact string matches on class names.
+* #23: It's not possible to automatically extract or serialize Xml fragments
+  from documents using `Sabre\Xml\Element\XmlFragment`.
+
+
+0.1.0 (2014-11-24)
+------------------
+
+* #16: Added ability to override `elementMap`, `namespaceMap` and `baseUri` for
+  a fragment of a document during reading an writing using `pushContext` and
+  `popContext`.
+* Removed: `Writer::$context` and `Reader::$context`.
+* #15: Added `Reader::$baseUri` to match `Writer::$baseUri`.
+* #20: Allow callbacks to be used instead of `Element` classes in the `Reader`.
+* #25: Added `readText` to quickly grab all text from a node and advance the
+  reader to the next node.
+* #15: Added `Sabre\XML\Element\Uri`.
+
+
+0.0.6 (2014-09-26)
+------------------
+
+* Added: `CData` element.
+* #13: Better support for xml with no namespaces. (@kalmas)
+* Switched to PSR-4 directory structure.
+
+
+0.0.5 (2013-03-27)
+------------------
+
+* Added: baseUri property to the Writer class.
+* Added: The writeElement method can now write complex elements.
+* Added: Throwing exception when invalid objects are written.
+
+
+0.0.4 (2013-03-14)
+------------------
+
+* Fixed: The KeyValue parser was skipping over elements when there was no
+  whitespace between them.
+* Fixed: Clearing libxml errors after parsing.
+* Added: Support for CDATA.
+* Added: Context properties.
+
+
+0.0.3 (2013-02-22)
+------------------
+
+* Changed: Reader::parse returns an array with 1 level less depth.
+* Added: A LibXMLException is now thrown if the XMLReader comes across an error.
+* Fixed: Both the Elements and KeyValue parsers had severe issues with
+  nesting.
+* Fixed: The reader now detects when the end of the document is hit before it
+  should (because we're still parsing an element).
+
+
+0.0.2 (2013-02-17)
+------------------
+
+* Added: Elements parser.
+* Added: KeyValue parser.
+* Change: Reader::parseSubTree is now named parseInnerTree, and returns either
+  a string (in case of a text-node), or an array (in case there were child
+  elements).
+* Added: Reader::parseCurrentElement is now public.
+
+
+0.0.1 (2013-02-07)
+------------------
+
+* First alpha release
+
+Project started: 2012-11-13. First experiments in June 2009.

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#tilia-uri/tilia@jakobsack.de
+
+This library is a port of [sabre/uri](http://github.com/fruux/sabre-uri). The ruby code should match the php code as good as possible. For more information refer to the [coding guidelines](https://tilia.github.io/coding_guidelines).
+
+If you are having an issue [search the open issues](https://github.com/tilia/tilia-uri/issues) or create an issue and we'll help point you in the right direction.
+
+## Submitting a Pull Request
+
+* Fork the project on Github
+* Install development dependencies (`bundle install`)
+* Create a topic branch for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
+* Ensure that all tests pass (`bundle exec rake`)
+* Create a [pull request](https://github.com/tilia/tilia-uri/pulls) on Github (these are also a great place to start a conversation around a patch as early as possible)
+
+## Testing
+
+To run the tests:
+
+    $ rake
+
+If nothing complains, congratulations!

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Internal dependencies
+gem 'tilia-uri', '~> 1.0'
+
+# External dependencies
+gem 'activesupport', '~> 4.2'
+gem 'libxml-ruby', '~> 2.8'
+
+# Testing
+gem 'rake'
+gem 'minitest', '~> 5.8'
+gem 'simplecov', '~> 0.10'
+gem 'rubocop', '~> 0.34'
+gem 'yard', '~> 0.8'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    libxml-ruby (2.8.0)
+    minitest (5.8.1)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rubocop (0.34.2)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tilia-uri (1.0.1)
+      activesupport (~> 4.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.2)
+  libxml-ruby (~> 2.8)
+  minitest (~> 5.8)
+  rake
+  rubocop (~> 0.34)
+  simplecov (~> 0.10)
+  tilia-uri (~> 1.0)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2015 Jakob Sack (tilia@jakobsack.de)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Tilia nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.sabre

@@ -0,0 +1,27 @@
+Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Sabre nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,30 @@
+tilia/xml
+=========
+
+[![Build Status](https://travis-ci.org/tilia/tilia-xml.svg?branch=master)](https://travis-ci.org/tilia/tilia-xml)
+
+**tilia/xml is a port of [sabre/xml](https://github.com/fruux/sabre-xml)**
+
+The sabre/xml library is a specialized XML reader and writer.
+
+
+Installation
+------------
+
+Simply add tilia-xml to your Gemfile and bundle it up:
+
+```ruby
+  gem 'tilia-xml', '~> 1.2'
+```
+
+
+Contributing
+------------
+
+See [Contributing](CONTRIBUTING.md)
+
+
+License
+-------
+
+tilia-xml is licensed under the terms of the [three-clause BSD-license](LICENSE).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.libs << 'test'
+end
+RuboCop::RakeTask.new do |t|
+  t.options = ['--format', 'html', '--out', 'coverage/rubocop.html']
+end
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'README.md']
+end
+
+task(default: :test)

data/lib/tilia/xml/context_stack_trait.rb

@@ -0,0 +1,99 @@
+module Tilia
+  module Xml
+    # Context Stack
+    #
+    # The Context maintains information about a document during either reading or
+    # writing.
+    #
+    # During this process, it may be neccesary to override this context
+    # information.
+    #
+    # This trait allows easy access to the context, and allows the end-user to
+    # override its settings for document fragments, and easily restore it again
+    # later.
+    module ContextStackTrait
+      # This is the element map. It contains a list of XML elements (in clark
+      # notation) as keys and PHP class names as values.
+      #
+      # The PHP class names must implement Sabre\Xml\Element.
+      #
+      # Values may also be a callable. In that case the function will be called
+      # directly.
+      #
+      # @return [Hash]
+      attr_accessor :element_map
+
+      # A context_uri pointing to the document being parsed / written.
+      # This uri may be used to resolve relative urls that may appear in the
+      # document.
+      #
+      # The reader and writer don't use this property, but as it's an extremely
+      # common use-case for parsing XML documents, it's added here as a
+      # convenience.
+      #
+      # @return [String]
+      attr_accessor :context_uri
+
+      # This is a list of namespaces that you want to give default prefixes.
+      #
+      # You must make sure you create this entire list before starting to write.
+      # They should be registered on the root element.
+      #
+      # @return [Hash]
+      attr_accessor :namespace_map
+
+      protected
+
+      # Backups of previous contexts.
+      #
+      # @return [Array]
+      attr_accessor :context_stack
+
+      public
+
+      # Create a new "context".
+      #
+      # This allows you to safely modify the element_map, context_uri or
+      # namespace_map. After you're done, you can restore the old data again
+      # with popContext.
+      #
+      # @return [void]
+      def push_context
+        dup_or_obj = lambda do |obj|
+          if obj.nil?
+            nil
+          elsif obj.is_a? Fixnum
+            obj
+          else
+            obj.dup
+          end
+        end
+
+        @context_stack << [
+          dup_or_obj.call(@element_map),
+          dup_or_obj.call(@context_uri),
+          dup_or_obj.call(@namespace_map)
+        ]
+      end
+
+      # Restore the previous "context".
+      #
+      # @return [void]
+      def pop_context
+        (
+          @element_map,
+          @context_uri,
+          @namespace_map
+        ) = @context_stack.pop
+      end
+
+      # TODO: document
+      def initialize_context_stack_attributes
+        @element_map = {}
+        @namespace_map = {}
+        @context_uri = ''
+        @context_stack = []
+      end
+    end
+  end
+end

data/lib/tilia/xml/element/base.rb

@@ -0,0 +1,73 @@
+module Tilia
+  module Xml
+    module Element
+      # The Base XML element is the standard parser & generator that's used by the
+      # XML reader and writer.
+      #
+      # It spits out a simple PHP array structure during deserialization, that can
+      # also be directly injected back into Writer::write.
+      class Base
+        include Element
+
+        protected
+
+        # PHP value to serialize.
+        attr_accessor :value
+
+        public
+
+        # Constructor
+        #
+        # @param value
+        def initialize(value = nil)
+          @value = value
+        end
+
+        # The xml_serialize metod is called during xml writing.
+        #
+        # Use the writer argument to write its own xml serialization.
+        #
+        # An important note: do _not_ create a parent element. Any element
+        # implementing XmlSerializable should only ever write what's considered
+        # its 'inner xml'.
+        #
+        # The parent of the current element is responsible for writing a
+        # containing element.
+        #
+        # This allows serializers to be re-used for different element names.
+        #
+        # If you are opening new elements, you must also close them again.
+        #
+        # @param [Writer] writer
+        # @return [void]
+        def xml_serialize(writer)
+          writer.write(@value)
+        end
+
+        # The deserialize method is called during xml parsing.
+        #
+        # This method is called statictly, this is because in theory this method
+        # may be used as a type of constructor, or factory method.
+        #
+        # Often you want to return an instance of the current class, but you are
+        # free to return other data as well.
+        #
+        # Important note 2: You are responsible for advancing the reader to the
+        # next element. Not doing anything will result in a never-ending loop.
+        #
+        # If you just want to skip parsing for this element altogether, you can
+        # just call reader->next();
+        #
+        # reader->parseInnerTree() will parse the entire sub-tree, and advance to
+        # the next element.
+        #
+        # @param [Reader] reader
+        # @return mixed
+        def self.xml_deserialize(reader)
+          sub_tree = reader.parse_inner_tree
+          sub_tree
+        end
+      end
+    end
+  end
+end

data/lib/tilia/xml/element/cdata.rb

@@ -0,0 +1,53 @@
+module Tilia
+  module Xml
+    module Element
+      # CDATA element.
+      #
+      # This element allows you to easily inject CDATA.
+      #
+      # Note that we strongly recommend avoiding CDATA nodes, unless you definitely
+      # know what you're doing, or you're working with unchangable systems that
+      # require CDATA.
+      class Cdata
+        include XmlSerializable
+
+        protected
+
+        # CDATA element value.
+        #
+        # @return [String]
+        attr_accessor :value
+
+        public
+
+        # Constructor
+        #
+        # @param [String] value
+        def initialize(value)
+          @value = value
+        end
+
+        # The xml_serialize metod is called during xml writing.
+        #
+        # Use the writer argument to write its own xml serialization.
+        #
+        # An important note: do _not_ create a parent element. Any element
+        # implementing XmlSerializble should only ever write what's considered
+        # its 'inner xml'.
+        #
+        # The parent of the current element is responsible for writing a
+        # containing element.
+        #
+        # This allows serializers to be re-used for different element names.
+        #
+        # If you are opening new elements, you must also close them again.
+        #
+        # @param [Writer] writer
+        # @return [void]
+        def xml_serialize(writer)
+          writer.write_cdata(@value)
+        end
+      end
+    end
+  end
+end