xml-mapping_extensions 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6415479b9ea2414249436f8273893c81b8bfbdb
-  data.tar.gz: 3ada581c17b547c1961e48dd72003a4bcba3c03a
+  metadata.gz: 50ceab85aed6813c2835984fc59ece8806dcbd31
+  data.tar.gz: aa7f145312c0a7c7fb97ba40f5620c1ad58b267c
 SHA512:
-  metadata.gz: fb643f42be329656e36d04acf0f759fbc0edcc8636147c2164182f8a7182ef6415b43fcab66331a7b88ff8b00e696155632a6b2fb3e4e133fb84e211e0c63f21
-  data.tar.gz: 54ab830f4b26b5b56d6d7afe3e5ca8b8d4f8b5feec004ea89b84bb0aa609b5c801a1fcd67d37601dff0fd94fba99cac8dcf5d6b07d44c0930607ab4bf867d4bd
+  metadata.gz: c9c052d3e34068555752d3a52a811d9710a4927611df2b7b3102eb29a406fc612f390c038e21510dcc470d1f9b4461749db57968a2585f024a82b9534f49fead
+  data.tar.gz: 43c32627ebebed41055496cc0807a536549a7acc5553afc8848cde3baf1f0b800e6e1480ea956c2c9e649212091da7d37bb6168cf14e0aa2a7a3d33782e0f343

data/.yardopts

@@ -1 +1,3 @@
---markup markdown
+--markup-provider=redcarpet
+--markup=markdown
+--default-return ''

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.3.7 (13 May 2016)
+
+- Made `Namespace#schema_location` optional.
+- Added `Namespace#to_s` to improve log and debug output.
+- Added hashing and equality to `Namespace`.
+
 ## 0.3.6 (2 May 2016)
 
 - Added `XML::MappingExtensions::Namespace`, with corresponding extension module

data/lib/xml/mapping_extensions/namespace.rb

@@ -12,17 +12,17 @@ module XML
       # @return [String, nil] the namespace prefix
       attr_reader :prefix
 
-      # @return [String] the schema location URI(s), as a space-separated string list
+      # @return [String, nil] the schema location URI(s), as a space-separated string list
       attr_reader :schema_location
 
       # Creates a new {Namespace}
       # @param uri [URI, String] the namespace URI
       # @param prefix [String, nil] the namespace prefix
-      # @param schema_location [String] the schema location(s)
-      def initialize(uri:, prefix: nil, schema_location:)
+      # @param schema_location [String, nil] the schema location(s)
+      def initialize(uri:, prefix: nil, schema_location: nil)
         @uri = uri.to_s
         @prefix = prefix
-        @schema_location = schema_location.to_s
+        @schema_location = schema_location
       end
 
       # Sets `uri` as the default (no-prefix) namespace on `elem`, with
@@ -30,6 +30,8 @@ module XML
       # @param elem [REXML::Element] The element to set the namespace on
       def set_default_namespace(elem) # rubocop:disable Style/AccessorMethodName
         elem.add_namespace(uri)
+        return unless schema_location
+        # TODO: Figure out xsi:noNamespaceSchemaLocation
         elem.add_namespace('xsi', 'http://www.w3.org/2001/XMLSchema-instance')
         elem.add_attribute('xsi:schemaLocation', schema_location)
       end
@@ -44,7 +46,24 @@ module XML
         root.add_namespace(prefix, uri)
       end
 
-      private
+      def to_s
+        "Namespace(uri: #{uri}, prefix: #{prefix || 'nil'}, schema_location: #{schema_location || 'nil'}"
+      end
+
+      def ==(other)
+        other.class == self.class && other.state == state
+      end
+
+      alias_method :eql?, :==
+
+      def hash
+        state.hash
+      end
+
+      def state
+        [uri, prefix, schema_location]
+      end
+      protected :state
 
       def set_prefix_recursive(elem) # rubocop:disable Style/AccessorMethodName
         return unless elem.namespace == uri
@@ -52,6 +71,7 @@ module XML
         elem.name = "#{prefix}:#{elem.name}"
         elem.each_element { |e| set_prefix_recursive(e) }
       end
+      private :set_prefix_recursive
     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.6'
+    VERSION = '0.3.7'
   end
 end

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

@@ -56,7 +56,6 @@ module XML
         expected = "<px:element #{namespace_attribs} attribute='123'>element text<px:child>child 1</px:child><px:child>child 2</px:child></px:element>"
 
         expect(obj.save_to_xml).to be_xml(expected)
-        puts(obj.write_xml)
       end
 
       it 'works without prefixes' do
@@ -74,7 +73,6 @@ module XML
         expected = "<element #{namespace_attribs} attribute='123'>element text<child>child 1</child><child>child 2</child></element>"
 
         expect(obj.save_to_xml).to be_xml(expected)
-        puts(obj.write_xml)
       end
     end
 

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

@@ -6,6 +6,9 @@ module XML
       describe '#set_default_namespace' do
         it 'sets the default namespace'
         it 'sets the schema location'
+        it 'allows a nil schema location'
+        it 'sets the no-namespace schema location'
+        it 'allows a nil no-namespace schema location'
       end
 
       describe '#set_prefix' do
@@ -13,6 +16,80 @@ module XML
         it 'clears the no-prefix namespace, if previously present'
         it 'leaves an unrelated no-prefix namespace intact'
       end
+
+      describe '#to_s' do
+        it 'includes the prefix, namespace, and schema location' do
+          uri             = 'http://example.org/px/'
+          prefix          = 'px'
+          schema_location = 'http://example.org/px.xsd'
+          namespace       = Namespace.new(uri: uri, prefix: prefix, schema_location: schema_location)
+          expect(namespace.to_s).to match(/Namespace.*#{uri}.*#{prefix}.*#{schema_location}/)
+        end
+
+        it 'accepts a nil prefix' do
+          uri             = 'http://example.org/px/'
+          schema_location = 'http://example.org/px.xsd'
+          namespace       = Namespace.new(uri: uri, schema_location: schema_location)
+          expect(namespace.to_s).to match(/Namespace.*#{uri}.*nil.*#{schema_location}/)
+        end
+
+        it 'accepts a nil schema_location' do
+          uri       = 'http://example.org/px/'
+          prefix    = 'px'
+          namespace = Namespace.new(uri: uri, prefix: prefix)
+          expect(namespace.to_s).to match(/Namespace.*#{uri}.*#{prefix}.*nil/)
+        end
+      end
+
+      describe 'equality' do
+        describe 'equal objects' do
+          before(:each) do
+            @ns1 = Namespace.new(uri: 'http://example.org/px/', prefix: 'px', schema_location: 'http://example.org/px.xsd')
+            @ns2 = Namespace.new(uri: 'http://example.org/px/', prefix: 'px', schema_location: 'http://example.org/px.xsd')
+          end
+
+          it 'are equal' do
+            expect(@ns1).to eq(@ns2)
+            expect(@ns2).to eq(@ns1)
+          end
+
+          it 'have the same hash code' do
+            expect(@ns1.hash).to eq(@ns2.hash)
+            expect(@ns2.hash).to eq(@ns1.hash)
+          end
+        end
+
+        describe 'unequal objects' do
+          before(:each) do
+            @nss = [
+              Namespace.new(uri: 'http://example.org/px/', prefix: 'px', schema_location: 'http://example.org/px.xsd'),
+              Namespace.new(uri: 'http://example.com/px/', prefix: 'px', schema_location: 'http://example.org/px.xsd'),
+              Namespace.new(uri: 'http://example.org/px/', prefix: 'px', schema_location: 'http://example.com/px.xsd'),
+              Namespace.new(uri: 'http://example.org/px/', prefix: 'px2', schema_location: 'http://example.org/px.xsd'),
+              Namespace.new(uri: 'http://example.org/px/', schema_location: 'http://example.org/px.xsd'),
+              Namespace.new(uri: 'http://example.org/px/', prefix: 'px')
+            ]
+          end
+
+          it 'are unequal' do
+            @nss.each do |ns1|
+              @nss.each do |ns2|
+                next if ns1.equal?(ns2)
+                expect(ns1).not_to eq(ns2)
+              end
+            end
+          end
+
+          it 'have different hash codes' do
+            @nss.each do |ns1|
+              @nss.each do |ns2|
+                next if ns1.equal?(ns2)
+                expect(ns1.hash).not_to eq(ns2.hash)
+              end
+            end
+          end
+        end
+      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.6
+  version: 0.3.7
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types