tilia-xml 1.2.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28be5b537419a6fafec89b07fefe33804b849b9e
-  data.tar.gz: e4add19ea231c5f6ba8940249797be097803dc1d
+  metadata.gz: cc343c81cf2926d463564160710e7170958bd9b6
+  data.tar.gz: 038f07bad13be27bb76899e61999a6a4abb00a62
 SHA512:
-  metadata.gz: 1b5dea05efe58faa1c195df67b00cf19fa186da0edde4db221d4ea7da6c08ad2be921af7f27e65cd74b80914917eab29750c9cf131e5f4b153f22fb99a54c065
-  data.tar.gz: 284d2411eee690d48bfa30790a116e08bf9db3f7de7f430388cdbb25b597fbc18a19af31ef486509f87e0d6d959bc738b265901bb93a677d9d834411ba1341a6
+  metadata.gz: be1fb4bb139f40a59b54fbc2206bb02154b880206be9ab48a0ccf70523782872a56d6eaac128897fec723aee2b0a80a11b933747ebb553d2ec6c582f666c0d36
+  data.tar.gz: c487226c4d30694e94e2a8335b5172c9433ef64dbb18fe688851a07385ae515d04db5ef5ff6ad388a73f8f6a94c1351f70d188b77db5e9d28a50673a883a33e4

data/.simplecov

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

data/CHANGELOG.sabre.md

@@ -1,6 +1,27 @@
 ChangeLog
 =========
 
+1.3.0 (2015-12-29)
+------------------
+
+* The `Service` class adds a new `mapValueObject` method which provides basic
+  capabilities to map between ValueObjects and XML.
+* #61: You can now specify serializers for specific classes, allowing you
+  separate the object you want to serialize from the serializer. This uses the
+  `$classMap` property which is defined on both the `Service` and `Writer`.
+* It's now possible to pass an array of possible root elements to
+  `Sabre\Xml\Service::expect()`.
+* Moved some parsing logic to `Reader::getDeserializerForElementName()`,
+  so people with more advanced use-cases can implement their own logic there.
+* #63: When serializing elements using arrays, the `value` key in the array is
+  now optional.
+* #62: Added a `keyValue` deserializer function. This can be used instead of
+  the `Element\KeyValue` class and is a lot more flexible. (@staabm)
+* Also added an `enum` deserializer function to replace
+  `Element\Elements`.
+* Using an empty string for a namespace prefix now has the same effect as
+  `null`.
+
 1.2.0 (2015-08-30)
 ------------------
 

data/Gemfile

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

data/Gemfile.lock

@@ -1,31 +1,37 @@
+PATH
+  remote: .
+  specs:
+    tilia-xml (1.3.0)
+      activesupport (>= 4.0)
+      libxml-ruby (>= 2.8)
+      tilia-uri (~> 1.0, >= 1.0.1.1)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.4)
+    activesupport (4.2.5.1)
       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)
+    ast (2.2.0)
     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)
+    parser (2.3.0.2)
+      ast (~> 2.2)
     powerpack (0.1.1)
-    rainbow (2.0.0)
+    rainbow (2.1.0)
     rake (10.4.2)
-    rubocop (0.34.2)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
+    rubocop (0.37.0)
+      parser (>= 2.3.0.2, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
     ruby-progressbar (1.7.5)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -33,23 +39,22 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     thread_safe (0.3.5)
-    tilia-uri (1.0.1)
-      activesupport (~> 4.2)
+    tilia-uri (1.0.1.1)
+      activesupport (>= 4.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unicode-display_width (0.3.1)
     yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 4.2)
-  libxml-ruby (~> 2.8)
   minitest (~> 5.8)
   rake
-  rubocop (~> 0.34)
+  rubocop (~> 0.36)
   simplecov (~> 0.10)
-  tilia-uri (~> 1.0)
+  tilia-xml!
   yard (~> 0.8)
 
 BUNDLED WITH

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015 Jakob Sack (tilia@jakobsack.de)
+Copyright (C) 2015-2016 Jakob Sack (tilia@jakobsack.de)
 
 All rights reserved.
 

data/LICENSE.sabre

@@ -1,4 +1,4 @@
-Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/)
+Copyright (C) 2009-2016 fruux GmbH (https://fruux.com/)
 
 All rights reserved.
 

data/lib/tilia/xml.rb

@@ -12,15 +12,18 @@ module Tilia
     require 'tilia/xml/xml_deserializable'
     require 'tilia/xml/xml_serializable'
     require 'tilia/xml/context_stack_trait'
+    require 'tilia/xml/deserializer'
     require 'tilia/xml/element'
     require 'tilia/xml/parse_exception'
     require 'tilia/xml/lib_xml_exception'
     require 'tilia/xml/reader'
+    require 'tilia/xml/serializer'
     require 'tilia/xml/service'
     require 'tilia/xml/version'
     require 'tilia/xml/writer'
   end
 
+  # Container to avoid pass-by-reference quirks
   class Box
     attr_accessor :value
 

data/lib/tilia/xml/context_stack_trait.rb

@@ -42,14 +42,23 @@ module Tilia
       # @return [Hash]
       attr_accessor :namespace_map
 
-      protected
-
-      # Backups of previous contexts.
+      # This is a list of custom serializers for specific classes.
       #
-      # @return [Array]
-      attr_accessor :context_stack
-
-      public
+      # The writer may use this if you attempt to serialize an object with a
+      # class that does not implement XmlSerializable.
+      #
+      # Instead it will look at this classmap to see if there is a custom
+      # serializer here. This is useful if you don't want your value objects
+      # to be responsible for serializing themselves.
+      #
+      # The keys in this classmap need to be fully qualified PHP class names,
+      # the values must be callbacks. The callbacks take two arguments. The
+      # writer class, and the value that must be written.
+      #
+      # function (Writer writer, object value)
+      #
+      # @return [Hash]
+      attr_accessor :class_map
 
       # Create a new "context".
       #
@@ -59,20 +68,11 @@ module Tilia
       #
       # @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)
+          @element_map.deep_dup,
+          @context_uri.deep_dup,
+          @namespace_map.deep_dup,
+          @class_map.deep_dup
         ]
       end
 
@@ -83,16 +83,20 @@ module Tilia
         (
           @element_map,
           @context_uri,
-          @namespace_map
+          @namespace_map,
+          @class_map
         ) = @context_stack.pop
       end
 
-      # TODO: document
-      def initialize_context_stack_attributes
+      # Initializes instance variables
+      def initialize(*args)
         @element_map = {}
         @namespace_map = {}
         @context_uri = ''
         @context_stack = []
+        @class_map = {}
+
+        super
       end
     end
   end

data/lib/tilia/xml/deserializer.rb

@@ -0,0 +1,241 @@
+module Tilia
+  module Xml
+    # This class provides a number of 'deserializer' helper functions.
+    # These can be used to easily specify custom deserializers for specific
+    # XML elements.
+    #
+    # You can either use these functions from within the element_map in the
+    # Service or Reader class, or you can call them from within your own
+    # deserializer functions.
+    module Deserializer
+      # The 'keyValue' deserializer parses all child elements, and outputs them as
+      # a "key=>value" array.
+      #
+      # For example, keyvalue will parse:
+      #
+      # <?xml version="1.0"?>
+      # <s:root xmlns:s="http://sabredav.org/ns">
+      #   <s:elem1>value1</s:elem1>
+      #   <s:elem2>value2</s:elem2>
+      #   <s:elem3 />
+      # </s:root>
+      #
+      # Into:
+      #
+      # [
+      #   "{http://sabredav.org/ns}elem1" => "value1",
+      #   "{http://sabredav.org/ns}elem2" => "value2",
+      #   "{http://sabredav.org/ns}elem3" => null,
+      # ]
+      #
+      # If you specify the 'namespace' argument, the deserializer will remove
+      # the namespaces of the keys that match that namespace.
+      #
+      # For example, if you call keyValue like this:
+      #
+      # key_value(reader, 'http://sabredav.org/ns')
+      #
+      # it's output will instead be:
+      #
+      # [
+      #   "elem1" => "value1",
+      #   "elem2" => "value2",
+      #   "elem3" => null,
+      # ]
+      #
+      # Attributes will be removed from the top-level elements. If elements with
+      # the same name appear twice in the list, only the last one will be kept.
+      #
+      #
+      # @param [Reader] reader
+      # @param [String, nil] namespace
+      # @return [Hash]
+      def self.key_value(reader, namespace = nil)
+        # If there's no children, we don't do anything.
+        if reader.empty_element?
+          reader.next
+          return {}
+        end
+
+        values = {}
+
+        reader.read
+        loop do
+          if reader.node_type == ::LibXML::XML::Reader::TYPE_ELEMENT
+            if namespace && reader.namespace_uri == namespace
+              values[reader.local_name] = reader.parse_current_element['value']
+            else
+              clark = reader.clark
+              values[clark] = reader.parse_current_element['value']
+            end
+          else
+            reader.read
+          end
+
+          break if reader.node_type == ::LibXML::XML::Reader::TYPE_END_ELEMENT
+        end
+
+        reader.read
+
+        values
+      end
+
+      # The 'enum' deserializer parses elements into a simple list
+      # without values or attributes.
+      #
+      # For example, Elements will parse:
+      #
+      # <?xml version="1.0"? >
+      # <s:root xmlns:s="http://sabredav.org/ns">
+      #   <s:elem1 />
+      #   <s:elem2 />
+      #   <s:elem3 />
+      #   <s:elem4>content</s:elem4>
+      #   <s:elem5 attr="val" />
+      # </s:root>
+      #
+      # Into:
+      #
+      # [
+      #   "{http://sabredav.org/ns}elem1",
+      #   "{http://sabredav.org/ns}elem2",
+      #   "{http://sabredav.org/ns}elem3",
+      #   "{http://sabredav.org/ns}elem4",
+      #   "{http://sabredav.org/ns}elem5",
+      # ]
+      #
+      # This is useful for 'enum'-like structures.
+      #
+      # If the namespace argument is specified, it will strip the namespace
+      # for all elements that match that.
+      #
+      # For example,
+      #
+      # enum(reader, 'http://sabredav.org/ns')
+      #
+      # would return:
+      #
+      # [
+      #   "elem1",
+      #   "elem2",
+      #   "elem3",
+      #   "elem4",
+      #   "elem5",
+      # ]
+      #
+      # @param [Reader] reader
+      # @param [String, nil] namespace
+      # @return [Array<String>]
+      def self.enum(reader, namespace = nil)
+        # If there's no children, we don't do anything.
+        if reader.empty_element?
+          reader.next
+          return []
+        end
+
+        reader.read
+        current_depth = reader.depth
+
+        values = []
+        loop do
+          unless reader.node_type == ::LibXML::XML::Reader::TYPE_ELEMENT
+            break unless reader.depth >= current_depth && reader.next
+            next
+          end
+
+          values << if namespace && namespace == reader.namespace_uri
+                      reader.local_name
+                    else
+                      reader.clark
+                    end
+
+          break unless reader.depth >= current_depth && reader.next
+        end
+
+        reader.next
+        values
+      end
+
+      # The valueObject deserializer turns an xml element into a PHP object of
+      # a specific class.
+      #
+      # This is primarily used by the mapValueObject function from the Service
+      # class, but it can also easily be used for more specific situations.
+      #
+      # @param [Reader] reader
+      # @param [Class] klass
+      # @param [String] namespace
+      # @return object
+      def self.value_object(reader, klass, namespace)
+        value_object = klass.new
+
+        if reader.empty_element?
+          reader.next
+          return {}
+        end
+
+        default_properties = {}
+        value_object.instance_variables.each do |name|
+          default_properties[name] = value_object.instance_variable_get(name)
+        end
+
+        reader.read
+        loop do
+          if reader.node_type == ::LibXML::XML::Reader::TYPE_ELEMENT && reader.namespace_uri == namespace
+            var_name = "@#{reader.local_name}".to_sym
+            if default_properties.key?(var_name)
+              if default_properties[var_name].is_a?(Array)
+                value_object.instance_variable_get(var_name) << reader.parse_current_element['value']
+              else
+                value_object.instance_variable_set(var_name, reader.parse_current_element['value'])
+              end
+            else
+              # Ignore property
+              reader.next
+            end
+          else
+            reader.read
+          end
+
+          break unless reader.node_type != ::LibXML::XML::Reader::TYPE_END_ELEMENT
+        end
+
+        reader.read
+        value_object
+      end
+
+      # This deserializer helps you deserialize xml structures that look like
+      # this:
+      #
+      # <collection>
+      #    <item>...</item>
+      #    <item>...</item>
+      #    <item>...</item>
+      # </collection>
+      #
+      # Many XML documents use  patterns like that, and this deserializer
+      # allow you to get all the 'items' as an array.
+      #
+      # In that previous example, you would register the deserializer as such:
+      #
+      # reader.element_map['{}collection'] = function(reader) {
+      #     return repeating_elements(reader, '{}item')
+      # }
+      #
+      # The repeatingElements deserializer simply returns everything as an array.
+      #
+      # @param [Reader] reader
+      # @param [String] child_element_name Element name in clark-notation
+      # @return Array
+      def self.repeating_elements(reader, child_element_name)
+        result = []
+
+        reader.parse_get_elements.each do |element|
+          result << element['value'] if element['name'] == child_element_name
+        end
+
+        result
+      end
+    end
+  end
+end