xml-mapping_extensions 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ceab85aed6813c2835984fc59ece8806dcbd31
-  data.tar.gz: aa7f145312c0a7c7fb97ba40f5620c1ad58b267c
+  metadata.gz: 159f916e7e1a374d68857ce63626f37b763312e3
+  data.tar.gz: 50ffcf3d3606eec904e7ce9faaecccf90905ac39
 SHA512:
-  metadata.gz: c9c052d3e34068555752d3a52a811d9710a4927611df2b7b3102eb29a406fc612f390c038e21510dcc470d1f9b4461749db57968a2585f024a82b9534f49fead
-  data.tar.gz: 43c32627ebebed41055496cc0807a536549a7acc5553afc8848cde3baf1f0b800e6e1480ea956c2c9e649212091da7d37bb6168cf14e0aa2a7a3d33782e0f343
+  metadata.gz: fdd87b9bb6d862300aac1b9bf993b9023f2704c6f788347868eb9eb89cd2a5911f92c321c4bba1af4a8520d3957f80b05678d7e75302b2b9e756bf61600d355a
+  data.tar.gz: fbc3c1cc7ba3627c21c6fe6cf2711031620f4638554a1d53d97e46c43547cb86426be36ef46eb4fb7bfbc5f78a1a341937a6342867710cc0a35bd93ad74f58c3

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.4.0 (16 May 2016)
+
+- Renamed `NamespacedElement` to `Namespaced` and made it an explicit include rather than auto-injected
+  metaprogramming craziness
+
 ## 0.3.7 (13 May 2016)
 
 - Made `Namespace#schema_location` optional.

data/README.md

@@ -16,8 +16,8 @@ Additional mapping nodes and other utility code for working with
     - [Example](#example)
   - [Provided implementations](#provided-implementations)
     - [Example](#example-1)
-    - [Reading XML:](#reading-xml)
-    - [Writing XML:](#writing-xml)
+    - [Reading](#reading)
+    - [Writing](#writing)
 - [Namespaces](#namespaces)
 
 
@@ -123,7 +123,7 @@ class MyElem
 end
 ```
 
-#### Reading XML:
+#### Reading
 
 ```ruby
 xml_str = '<my_elem>
@@ -156,7 +156,7 @@ Outputs
 #<MIME::Type:0x007f864bdc4f78 @friendly={"en"=>"Text File"}, @system=nil, @obsolete=false, @registered=true, @use_instead=nil, @signature=false, @content_type="text/plain", @raw_media_type="text", @raw_sub_type="plain", @simplified="text/plain", @i18n_key="text.plain", @media_type="text", @sub_type="plain", @docs=[], @encoding="quoted-printable", @extensions=["txt", "asc", "c", "cc", "h", "hh", "cpp", "hpp", "dat", "hlp", "conf", "def", "doc", "in", "list", "log", "markdown", "md", "rst", "text", "textile"], @references=["IANA", "RFC2046", "RFC3676", "RFC5147"], @xrefs={"rfc"=>["rfc2046", "rfc3676", "rfc5147"]}>
 ```
 
-#### Writing XML:
+#### Writing
 
 ```ruby
 elem = MyElem.new
@@ -189,7 +189,24 @@ The `Namespace` class encapsulates an XML namespace:
 namespace = Namespace.new(uri: 'http://example.org/px', schema_location: 'http://example.org/px.xsd')
 ```
 
-Setting a namespace on a mapped object will cause that namespace to be written out when the object is saved
+The `Namespaced` module extends `XML::Mapping` to add a `namespace` attribute and write the namespace
+out when saving to XML.
+
+```ruby
+class MyElem
+  include XML::MappingExtensions::Namespaced # instead of XML::Mapping
+
+  root_element_name 'my_elem'
+
+  date_node :plain_date, 'plain_date'
+  date_node :zulu_date, 'zulu_date', zulu: true
+  time_node :time, 'time'
+  uri_node :uri, 'uri'
+  mime_type_node :mime_type, 'mime_type'
+end
+```
+
+Setting a namespace on a namespaced object will cause that namespace to be written out when the object is saved
 to XML:
 
 ```ruby

data/lib/xml/mapping_extensions/namespace.rb

@@ -20,8 +20,8 @@ module XML
       # @param prefix [String, nil] the namespace prefix
       # @param schema_location [String, nil] the schema location(s)
       def initialize(uri:, prefix: nil, schema_location: nil)
-        @uri = uri.to_s
-        @prefix = prefix
+        @uri             = uri.to_s
+        @prefix          = prefix
         @schema_location = schema_location
       end
 
@@ -63,6 +63,7 @@ module XML
       def state
         [uri, prefix, schema_location]
       end
+
       protected :state
 
       def set_prefix_recursive(elem) # rubocop:disable Style/AccessorMethodName
@@ -71,35 +72,8 @@ module XML
         elem.name = "#{prefix}:#{elem.name}"
         elem.each_element { |e| set_prefix_recursive(e) }
       end
-      private :set_prefix_recursive
-    end
-  end
-
-  # Patches `XML::Mapping` to add a namespace attribute and write the namespace
-  # out when saving to XML.
-  module NamespacedElement
-
-    # @return [Namespace, nil] the namespace, if any
-    attr_accessor :namespace
 
-    # Overrides `XML::Mapping#pre_save` to set the XML namespace and schema location
-    # on the generated element.
-    def pre_save(options = { mapping: :_default })
-      xml = super(options)
-      namespace.set_default_namespace(xml) if namespace
-      xml
-    end
-
-    # Overrides `XML::Mapping#save_to_xml` to set the XML namespace prefix on
-    # the generated element, and all its descendants that have that namespace.
-    def save_to_xml(options = { mapping: :_default })
-      xml = super(options)
-      namespace.set_prefix(xml) if namespace
-      xml
+      private :set_prefix_recursive
     end
   end
-
-  module Mapping
-    prepend NamespacedElement
-  end
 end

data/lib/xml/mapping_extensions/namespaced.rb

@@ -0,0 +1,47 @@
+require 'uri'
+
+module XML
+  module MappingExtensions
+    # Extends `XML::Mapping` to add a `namespace` attribute and write the namespace
+    # out when saving to XML.
+    module Namespaced
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(XML::Mapping)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+        def namespace(ns = nil)
+          @namespace = ns if ns
+          @namespace
+        end
+      end
+
+      def namespace
+        self.class.namespace
+      end
+
+      # Hack to make sure these don't get defined till after `XML::Mapping`'s include
+      # hooks have a chance to define their super methods
+      module InstanceMethods
+        # Overrides `XML::Mapping#pre_save` to set the XML namespace and schema location
+        # on the generated element.
+        def pre_save(options = {mapping: :_default})
+          xml = super(options)
+          namespace.set_default_namespace(xml) if namespace
+          xml
+        end
+
+        # Overrides `XML::Mapping#save_to_xml` to set the XML namespace prefix on
+        # the generated element, and all its descendants that have that namespace.
+        def save_to_xml(options = {mapping: :_default})
+          xml = super(options)
+          namespace.set_prefix(xml) if namespace
+          xml
+        end
+      end
+    end
+  end
+end

data/lib/xml/mapping_extensions/version.rb

@@ -1,6 +1,6 @@
 module XML
   module MappingExtensions
     # The version of this gem
-    VERSION = '0.3.7'
+    VERSION = '0.4.0'
   end
 end

data/spec/unit/xml/mapping_extensions/namespaced_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+require 'xml/mapping_extensions/namespace'
+
+module XML
+  module MappingExtensions
+
+    UNPREFIXED = Namespace.new(uri: 'http://example.org/nse')
+    PREFIXED   = Namespace.new(uri: 'http://example.org/nse', prefix: 'px')
+
+    # TODO: both versions with schema location
+
+    class Unprefixed
+      include Namespaced
+      namespace UNPREFIXED
+      root_element_name 'unprefixed'
+      text_node :attr, '@attr'
+      text_node :text, 'text()'
+    end
+
+    class Prefixed
+      include Namespaced
+      namespace PREFIXED
+      root_element_name 'prefixed'
+      text_node :attr, '@attr'
+      text_node :text, 'text()'
+    end
+
+    describe Namespaced do
+      describe '#save_to_xml' do
+        it 'writes XML with a default namespace' do
+          obj = Unprefixed.new
+          obj.attr = 'attr value'
+          obj.text = 'text value'
+          expected = '<unprefixed xmlns="http://example.org/nse" attr="attr value">text value</unprefixed>'
+          expect(obj.write_xml).to be_xml(expected)
+        end
+        it 'writes XML with a prefixed namespace' do
+          obj = Prefixed.new
+          obj.attr = 'attr value'
+          obj.text = 'text value'
+          expected = '<px:prefixed xmlns:px="http://example.org/nse" attr="attr value">text value</unprefixed>'
+          expect(obj.write_xml).to be_xml(expected)
+        end
+      end
+
+      describe '#parse_xml' do
+        it 'parses XML with a default namespace'
+        it 'parses XML with a prefixed namespace'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mapping_extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -191,6 +191,7 @@ files:
 - lib/xml/mapping_extensions/date_node.rb
 - lib/xml/mapping_extensions/mime_type_node.rb
 - lib/xml/mapping_extensions/namespace.rb
+- lib/xml/mapping_extensions/namespaced.rb
 - lib/xml/mapping_extensions/node_base.rb
 - lib/xml/mapping_extensions/time_node.rb
 - lib/xml/mapping_extensions/typesafe_enum_node.rb
@@ -204,6 +205,7 @@ files:
 - spec/unit/xml/mapping_extensions/mapping_extensions_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
 - spec/unit/xml/mapping_extensions/namespace_spec.rb
+- spec/unit/xml/mapping_extensions/namespaced_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
 - spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb
@@ -242,6 +244,7 @@ test_files:
 - spec/unit/xml/mapping_extensions/mapping_extensions_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
 - spec/unit/xml/mapping_extensions/namespace_spec.rb
+- spec/unit/xml/mapping_extensions/namespaced_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
 - spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb