resync 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caaf4841db1483e0ee12a97a0c8feda2860ff307
-  data.tar.gz: 9042ffbe49a75096c1c8dca81aba9928180ba692
+  metadata.gz: 406859fe6a51bf6ff5b90b58ef0ec0f1b6ed1867
+  data.tar.gz: ce626f5a9adabe17fa4af8c21e2aa70da299a3f2
 SHA512:
-  metadata.gz: 5d39cab4a6c3fc47078d1a8d5f9bcad996f82f07d11ca6906d801679e42452d64baeaf63c9c4e20d839618f00ddb6d15e4848f7993e9193bf1bcd2c309b5de27
-  data.tar.gz: c5f5cbc3479c46d519e0adfce8b7663e3fcd00a18775895059ab33c408b41ab9aca9138961e5a29a46a36701b17b0657cfc307a99c9204118cfefc3c4cfd5924
+  metadata.gz: 8f6728c7ccb7d6b2d96cb37e58dc0a8bcfcff95ba0edcc018bf3fc440d7a8befb9889e0fcf40122954a85830404d5125a08030b29f61cddd2b7a799586033137
+  data.tar.gz: 4f42a290b7f90f94825255d8cdd1af737eb18a076e15b8724223df14b1e4d9aad8f647e30f6262c635cd919e4fb0ab56adfb0506e18a8271d609f6b40d5392dc

data/.rubocop.yml

@@ -18,6 +18,3 @@ Style/EmptyLinesAroundModuleBody:
 Style/EmptyLinesAroundBlockBody:
   Enabled: false
 
-# Allow %r notation for regexes with a single / character
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.3.1
+
+- Use [XML::MappingExtensions](https://github.com/dmolesUC3/xml-mapping_extensions) for some XML mapping infrastructure
+
 ## 0.3.0
 
 - Return simple arrays for resources, instead of fancy lazy enumerables

data/lib/resync/version.rb

@@ -1,4 +1,4 @@
 module Resync
   # The version of this gem.
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/lib/resync/xml.rb

@@ -1,6 +1,8 @@
 require 'uri'
 require 'time'
 require 'xml/mapping'
+require 'xml/mapping_extensions'
+
 require_relative 'types'
 
 module Resync
@@ -56,83 +58,11 @@ module Resync
     end
     private_class_method :can_parse
 
-    # ------------------------------------------------------------
-    # Time
-
-    # Maps +Time+ objects.
-    class TimeNode < ::XML::Mapping::SingleAttributeNode
-      def initialize(*args)
-        path, *args = super(*args)
-        @path = ::XML::XXPath.new(path)
-        args
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
-      def extract_attr_value(xml)
-        value = default_when_xpath_err { @path.first(xml).text }
-        value ? Time.iso8601(value).utc : nil
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#set_attr_value+.
-      def set_attr_value(xml, value)
-        @path.first(xml, ensure_created: true).text = value.iso8601
-      end
-    end
-
-    ::XML::Mapping.add_node_class TimeNode
-
-    # ------------------------------------------------------------
-    # URI
-
-    # Maps +URI+ objects.
-    class UriNode < ::XML::Mapping::SingleAttributeNode
-      def initialize(*args)
-        path, *args = super(*args)
-        @path = ::XML::XXPath.new(path)
-        args
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
-      def extract_attr_value(xml)
-        val = default_when_xpath_err { @path.first(xml).text }
-        URI(val.strip)
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#set_attr_value+.
-      def set_attr_value(xml, value)
-        @path.first(xml, ensure_created: true).text = value.to_s
-      end
-    end
-
-    ::XML::Mapping.add_node_class UriNode
-
-    # ------------------------------------------------------------
-    # Resync::Types
-
-    class EnumNode < ::XML::Mapping::SingleAttributeNode
-      def initialize(*args)
-        path, *args = super(*args)
-        @path = ::XML::XXPath.new(path)
-        args
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
-      def extract_attr_value(xml)
-        enum_class = self.class::ENUM_CLASS
-        enum_class.parse(default_when_xpath_err { @path.first(xml).text })
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#set_attr_value+.
-      def set_attr_value(xml, value)
-        @path.first(xml, ensure_created: true).text = value.to_s
-      end
-    end
-
     # ------------------------------------------------------------
     # Resync::Types::Change
 
     # Maps +Resync::Types::Change+ values.
-    class ChangeNode < EnumNode
+    class ChangeNode < ::XML::MappingExtensions::EnumNodeBase
       ENUM_CLASS = Resync::Types::Change
     end
 
@@ -142,69 +72,28 @@ module Resync
     # Resync::Types::Changefreq
 
     # Maps +Resync::Types::ChangeFrequency+ values.
-    class ChangefreqNode < EnumNode
+    class ChangefreqNode < ::XML::MappingExtensions::EnumNodeBase
       ENUM_CLASS = Resync::Types::ChangeFrequency
     end
 
     ::XML::Mapping.add_node_class ChangefreqNode
 
-    # ------------------------------------------------------------
-    # MIME::Type
-
-    # Maps +MIME::Type+ values.
-    class MimeTypeNode < ::XML::Mapping::SingleAttributeNode
-      def initialize(*args)
-        path, *args = super(*args)
-        @path = ::XML::XXPath.new(path)
-        args
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
-      def extract_attr_value(xml)
-        mime_type = default_when_xpath_err { @path.first(xml).text }
-        return nil unless mime_type
-        return mime_type if mime_type.is_a?(MIME::Type)
-
-        mt = MIME::Types[mime_type].first
-        return mt if mt
-
-        MIME::Type.new(mime_type)
-      end
-
-      # Implements +::XML::Mapping::SingleAttributeNode#set_attr_value+.
-      def set_attr_value(xml, value)
-        @path.first(xml, ensure_created: true).text = value.to_s
-      end
-    end
-
-    ::XML::Mapping.add_node_class MimeTypeNode
-
     # ------------------------------------------------------------
     # Whitespace-separated hashcode list
 
     # Maps the whitespace-separated list of hash codes in a +<rs:ln>+
     # or +<rs:md>+ tag to a hash of digest values keyed by hash algorithm.
     # (See {Resync::Descriptor#hashes}.)
-    class HashCodesNode < ::XML::Mapping::SingleAttributeNode
-      def initialize(*args)
-        path, *args = super(*args)
-        @path = ::XML::XXPath.new(path)
-        args
-      end
+    class HashCodesNode < ::XML::MappingExtensions::NodeBase
 
-      # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
-      def extract_attr_value(xml)
-        hashes = default_when_xpath_err { @path.first(xml).text }
-        return {} unless hashes
-        return hashes if hashes.is_a?(Hash)
-        hashes.split(/[[:space:]]+/).map { |hash| hash.split(':') }.to_h
+      def to_value(xml_text)
+        return {} unless xml_text
+        return xml_text if xml_text.is_a?(Hash)
+        xml_text.split(/[[:space:]]+/).map { |hash| hash.split(':') }.to_h
       end
 
-      # Implements +::XML::Mapping::SingleAttributeNode#set_attr_value+.
-      def set_attr_value(xml, value)
-        return if value.empty?
-        hash_str = value.map { |k, v| "#{k}:#{v}" }.join(' ')
-        @path.first(xml, ensure_created: true).text = hash_str
+      def to_xml_text(value)
+        value.map { |k, v| "#{k}:#{v}" }.join(' ') if value && !value.empty?
       end
     end
 

data/resync.gemspec

@@ -25,11 +25,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mime-types', '~> 2.5'
   spec.add_dependency 'ruby-enum', '~> 0.4'
   spec.add_dependency 'xml-mapping', '~> 0.10'
+  spec.add_dependency 'xml-mapping_extensions', '~> 0.1.0'
 
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 0.29.1'
+  spec.add_development_dependency 'rubocop', '~> 0.32'
   spec.add_development_dependency 'simplecov', '~> 0.9.2'
   spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
   spec.add_development_dependency 'yard', '~> 0.8'

data/spec/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: ../.rubocop.yml
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/spec/rspec_custom_matchers.rb

@@ -4,6 +4,7 @@ require 'equivalent-xml'
 RSpec::Matchers.define :be_xml do |expected|
 
   def to_nokogiri(xml)
+    return nil unless xml
     case xml
     when Nokogiri::XML::Element
       xml
@@ -13,6 +14,8 @@ RSpec::Matchers.define :be_xml do |expected|
       to_nokogiri(Nokogiri::XML(xml))
     when REXML::Element
       to_nokogiri(xml.to_s)
+    else
+      fail "be_xml() expected XML, got #{xml.class}"
     end
   end
 

data/spec/spec_helper.rb

@@ -31,6 +31,6 @@ end
 require 'rspec_custom_matchers'
 
 # ------------------------------------------------------------
-# Stash::Harvester
+# Resync
 
 require 'resync'

data/spec/unit/resync/xml/xml_spec.rb

@@ -30,6 +30,13 @@ module Resync
         expect(elem).to be_xml(xml_str)
       end
 
+      it 'parses a file as an XML document' do
+        file = File.new('spec/data/examples/example-1.xml')
+        elem = XML.element(file)
+        expect(elem).to be_a(REXML::Element)
+        expect(elem.name).to eq('urlset')
+      end
+
       it 'fails when it gets something other than XML' do
         data = 12_345
         expect { XML.element(data) }.to raise_exception

data/spec/unit/resync/xml_parser_spec.rb

@@ -31,6 +31,12 @@ module Resync
         expect(urlset).to be_a(ResourceList)
       end
 
+      it 'parses a file' do
+        file = File.new('spec/data/examples/example-1.xml')
+        urlset = XMLParser.parse(file)
+        expect(urlset).to be_a(ResourceList)
+      end
+
       it 'parses an XML fragment' do
         data = '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:rs="http://www.openarchives.org/rs/terms/">
                   <rs:md capability="resourcelist" at="2013-01-03T09:00:00Z"/>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resync
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: xml-mapping_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: '0.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: '0.32'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +226,7 @@ files:
 - lib/resync/xml.rb
 - lib/resync/xml_parser.rb
 - resync.gemspec
+- spec/.rubocop.yml
 - spec/acceptance/xml_parser_spec.rb
 - spec/data/changedump-index.xml
 - spec/data/examples/README.md
@@ -275,7 +290,6 @@ files:
 - spec/unit/resync/shared/sorted_list_examples.rb
 - spec/unit/resync/shared/uri_field_examples.rb
 - spec/unit/resync/source_description_spec.rb
-- spec/unit/resync/xml/timenode_spec.rb
 - spec/unit/resync/xml/xml_spec.rb
 - spec/unit/resync/xml_parser_spec.rb
 homepage: http://github.com/dmolesUC3/resync
@@ -298,11 +312,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Utility library for ResourceSync
 test_files:
+- spec/.rubocop.yml
 - spec/acceptance/xml_parser_spec.rb
 - spec/data/changedump-index.xml
 - spec/data/examples/README.md
@@ -366,7 +381,6 @@ test_files:
 - spec/unit/resync/shared/sorted_list_examples.rb
 - spec/unit/resync/shared/uri_field_examples.rb
 - spec/unit/resync/source_description_spec.rb
-- spec/unit/resync/xml/timenode_spec.rb
 - spec/unit/resync/xml/xml_spec.rb
 - spec/unit/resync/xml_parser_spec.rb
 has_rdoc: 

data/spec/unit/resync/xml/timenode_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-module Resync
-  module XML
-
-    class Elem
-      include ::XML::Mapping
-      time_node :time, '@time', default_value: nil
-
-      def self.from_str(time_str)
-        xml_string = "<elem time='#{time_str}'/>"
-        doc = REXML::Document.new(xml_string)
-        load_from_xml(doc.root)
-      end
-    end
-
-    describe TimeNode do
-
-      def time(str)
-        Elem.from_str(str).time
-      end
-
-      it 'parses a date with hours, minutes, and seconds' do
-        actual = time('1997-07-16T19:20:30')
-        expected = Time.new(1997, 7, 16, 19, 20, 30)
-        expect(actual).to be_time(expected)
-      end
-
-      it 'parses a date with hours, minutes, seconds, and fractional seconds' do
-        actual = time('1997-07-16T19:20:30.45')
-        expected = Time.new(1997, 7, 16, 19, 20, 30.45)
-        expect(actual).to be_time(expected)
-      end
-
-      it 'parses a UTC "zulu" time (time zone designator "Z")' do
-        actual = time('1997-07-16T19:20:30.45Z')
-        expected = Time.new(1997, 7, 16, 19, 20, 30.45, '+00:00')
-        expect(actual).to be_time(expected)
-      end
-
-      it 'parses a time with a numeric timezone offset' do
-        actual = time('1997-07-16T19:20:30.45+01:30')
-        expected = Time.new(1997, 7, 16, 19, 20, 30.45, '+01:30')
-        expect(actual).to be_time(expected)
-      end
-    end
-  end
-end