resync 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30958a3d136a05395b75151c4396cc3a396d8dc0
-  data.tar.gz: 1380f44a55d5305a1cf46988cbbc604f6672ad8f
+  metadata.gz: caaf4841db1483e0ee12a97a0c8feda2860ff307
+  data.tar.gz: 9042ffbe49a75096c1c8dca81aba9928180ba692
 SHA512:
-  metadata.gz: 2262fa5a7028254fb4144772ec3cfe44982596a1cd69f8114afad7a4c9f1db5de0f2de0de7d0f25990ce6cf8c0a3d16fb35eaeb504c3f877fe6a6f2ab31660de
-  data.tar.gz: 885631b5db2dae906e938f2a125c75f7f020d98dfbe2b964bd8ea6fe68ff3e3ba684137fd34ab2ff635ed94639e5c8b482eba457440de410d7830abc6d1c26a3
+  metadata.gz: 5d39cab4a6c3fc47078d1a8d5f9bcad996f82f07d11ca6906d801679e42452d64baeaf63c9c4e20d839618f00ddb6d15e4848f7993e9193bf1bcd2c309b5de27
+  data.tar.gz: c5f5cbc3479c46d519e0adfce8b7663e3fcd00a18775895059ab33c408b41ab9aca9138961e5a29a46a36701b17b0657cfc307a99c9204118cfefc3c4cfd5924

data/.travis.yml

@@ -1,2 +1,6 @@
 language: ruby
 
+addons:
+  code_climate:
+    repo_token: 7dbef7673e0f4ec8af5632f48fad7260cdaed36bb461620916ca08c988800af1
+    

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.3.0
+
+- Return simple arrays for resources, instead of fancy lazy enumerables
+
 ## 0.2.2
 
 - Added `#changes` method to `ChangeList` and `ChangeDumpManifest`, allowing filtering by change type and modified time

data/README.md

@@ -1,4 +1,5 @@
-# resync
+# resync [![Build Status](https://travis-ci.org/dmolesUC3/resync.png?branch=master)](https://travis-ci.org/dmolesUC3/resync) [![Code Climate](https://codeclimate.com/github/dmolesUC3/resync.png)](https://codeclimate.com/github/dmolesUC3/resync) [![Inline docs](http://inch-ci.org/github/dmolesUC3/resync.png)](http://inch-ci.org/github/dmolesUC3/resync)
+
 
 A Ruby gem for working with the [ResourceSync](http://www.openarchives.org/rs/1.0/resourcesync) web synchronization framework.
 
@@ -90,3 +91,4 @@ When reading a ResourceSync document from XML and writing it back out, `<rs:ln>`
 #### Namespace weirdness
 
 The [XML::Mapping](https://github.com/multi-io/xml-mapping) library `resync` uses doesn't support namespaces, so namespace handling in `resync` is a bit hacky. In particular, you may see strange behavior when using `<rs:ln>`, `<rs:md>`, `<url>`, or `<sitemap>` tags outside the context of a `<urlset>`/`<sitemapindex>`.
+

data/lib/resync/shared/base_change_index.rb

@@ -12,7 +12,7 @@ module Resync
     # @param in_range [Range<Time>] the range of times to filter by
     # @param strict [Boolean] +true+ if resources without +from_time+ or +until_time+ should be
     #   excluded, +false+ if they should be included.
-    # @return [Enumerator::Lazy<Resource>] those change lists whose +from_time+ *or* +until_time+
+    # @return [Array<Resource>] those change lists whose +from_time+ *or* +until_time+
     #   falls within +in_range+
     def change_lists(in_range:, strict: true)
       resources.select do |r|

data/lib/resync/shared/base_change_list.rb

@@ -6,7 +6,7 @@ module Resync
     # Filters the list of changes by change type, modification time, or both.
     # @param of_type [Types::Change] the change type
     # @param in_range [Range<Time>] the range of modification times
-    # @return [Enumerator::Lazy<Resource>] the matching changes, or all changes
+    # @return [Array<Resource>] the matching changes, or all changes
     #   if neither +of_type+ nor +in_range+ is specified.
     def changes(of_type: nil, in_range: nil)
       resources.select do |r|

data/lib/resync/shared/base_resource_list.rb

@@ -9,7 +9,7 @@ module Resync
   # they represent (e.g. +resourcelist+, +changelist+).
   #
   # @!attribute [r] resources
-  #   @return [Util::IndexableLazy<Resource>] the +<url>+ or +<sitemap>+ elements contained in this list.
+  #   @return [Array<Resource>] the +<url>+ or +<sitemap>+ elements contained in this list.
   class BaseResourceList < Augmented
     include ::XML::Mapping
 
@@ -40,7 +40,7 @@ module Resync
 
     # Sets the +resources+ list. +nil+ is treated as an empty list.
     def resources=(value)
-      @resources = Util::IndexableLazy.new(value || [])
+      @resources = value || []
     end
 
     # Sets the metadata.
@@ -61,7 +61,7 @@ module Resync
 
     # Finds resources with the specified capability.
     # @param capability [String] the capability.
-    # @return [Enumerator::Lazy<Resource>] those resources having that capability, or an empty array if none exist.
+    # @return [Array<Resource>] those resources having that capability, or an empty array if none exist.
     def resources_for(capability:)
       resources.select { |r| r.capability == capability }
     end
@@ -80,7 +80,7 @@ module Resync
     # @param time_range [Range[Time]] the range of acceptable times (inclusive or exclusive)
     # @param time_attr [Symbol] the time type to filter on: +:modified_time+, +:at_time+,
     #   +:completed_time+, +:from_time+ or +:until_time+
-    # @return [Enumerator::Lazy<Resource>] a lazy enumeration of the resources within the specified range.
+    # @return [Array<Resource>] a lazy enumeration of the resources within the specified range.
     def resources_in(time_range:, time_attr:)
       resources.select { |r| time_range.cover?(r.send(time_attr)) }
     end

data/lib/resync/version.rb

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

data/lib/resync/xml.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'time'
 require 'xml/mapping'
+require_relative 'types'
 
 module Resync
   # Helper methods and modules related to reading and writing XML.
@@ -106,10 +107,9 @@ module Resync
     ::XML::Mapping.add_node_class UriNode
 
     # ------------------------------------------------------------
-    # Resync::Types::Change
+    # Resync::Types
 
-    # Maps +Resync::Types::Change+ values.
-    class ChangeNode < ::XML::Mapping::SingleAttributeNode
+    class EnumNode < ::XML::Mapping::SingleAttributeNode
       def initialize(*args)
         path, *args = super(*args)
         @path = ::XML::XXPath.new(path)
@@ -118,7 +118,8 @@ module Resync
 
       # Implements +::XML::Mapping::SingleAttributeNode#extract_attr_value+.
       def extract_attr_value(xml)
-        Resync::Types::Change.parse(default_when_xpath_err { @path.first(xml).text })
+        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+.
@@ -127,28 +128,22 @@ module Resync
       end
     end
 
+    # ------------------------------------------------------------
+    # Resync::Types::Change
+
+    # Maps +Resync::Types::Change+ values.
+    class ChangeNode < EnumNode
+      ENUM_CLASS = Resync::Types::Change
+    end
+
     ::XML::Mapping.add_node_class ChangeNode
 
     # ------------------------------------------------------------
     # Resync::Types::Changefreq
 
-    # Maps +Resync::Types::Changefreq+ values.
-    class ChangefreqNode < ::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)
-        Resync::Types::ChangeFrequency.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
+    # Maps +Resync::Types::ChangeFrequency+ values.
+    class ChangefreqNode < EnumNode
+      ENUM_CLASS = Resync::Types::ChangeFrequency
     end
 
     ::XML::Mapping.add_node_class ChangefreqNode

data/resync.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.9.2'
   spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
   spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,12 @@
 # ------------------------------------------------------------
-# SimpleCov setup
+# SimpleCov/CodeClimate setup
 
 if ENV['COVERAGE']
+  if ENV['CODECLIMATE_REPO_TOKEN']
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+  end
+
   require 'simplecov'
   require 'simplecov-console'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resync
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby gem for working with the ResourceSync web synchronization framework
 email:
 - david.moles@ucop.edu
@@ -194,7 +208,6 @@ files:
 - lib/resync/types/change.rb
 - lib/resync/types/change_frequency.rb
 - lib/resync/util.rb
-- lib/resync/util/indexable_lazy.rb
 - lib/resync/version.rb
 - lib/resync/xml.rb
 - lib/resync/xml_parser.rb
@@ -262,7 +275,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/util/indexable_lazy_spec.rb
 - spec/unit/resync/xml/timenode_spec.rb
 - spec/unit/resync/xml/xml_spec.rb
 - spec/unit/resync/xml_parser_spec.rb
@@ -354,7 +366,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/util/indexable_lazy_spec.rb
 - spec/unit/resync/xml/timenode_spec.rb
 - spec/unit/resync/xml/xml_spec.rb
 - spec/unit/resync/xml_parser_spec.rb

data/lib/resync/util/indexable_lazy.rb

@@ -1,18 +0,0 @@
-require 'delegate'
-
-module Resync
-  module Util
-    class IndexableLazy < SimpleDelegator
-
-      def initialize(array)
-        super(array.lazy)
-        @array = array
-      end
-
-      def [](key)
-        @array[key]
-      end
-
-    end
-  end
-end

data/spec/unit/resync/util/indexable_lazy_spec.rb

@@ -1,133 +0,0 @@
-require 'spec_helper'
-
-module Resync
-  module Util
-    describe IndexableLazy do
-
-      before(:each) do
-        @size = 3
-        @array = Array.new(@size) { instance_double(Object) }
-        @lazy = IndexableLazy.new(@array)
-      end
-
-      describe '#size' do
-        it 'returns the size of the underlying array' do
-          expect(@lazy.size).to eq(@size)
-        end
-      end
-
-      describe '#[]' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          (0...@lazy.size).each do |i|
-            expect(@lazy[i]).to eq(@array[i])
-            break if @lazy[i].to_s == '1'
-          end
-        end
-      end
-
-      describe '#each' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          @lazy.each do |v|
-            break if v.to_s == '1'
-          end
-        end
-      end
-
-      describe '#each_with_index' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          @lazy.each_with_index do |v, i|
-            break if v.to_s == '1' || i > 1
-          end
-        end
-      end
-
-      describe '#each_with_object' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          acc = []
-          @lazy.each_with_object(acc) do |v, obj|
-            obj << v.to_s
-            break if obj[-1] == '1'
-          end
-          expect(acc).to eq(%w(0 1))
-        end
-      end
-
-      describe '#find' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          expect(@lazy.find { |v| v.to_s == '1' }).to be(@array[1])
-        end
-      end
-
-      describe '#find_index' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          expect(@lazy.find_index { |v| v.to_s == '1' }).to eq(1)
-        end
-      end
-
-      describe '#take_while' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          expect(@lazy.take_while { |v| v.to_s == '0' }.to_a).to eq([@array[0]])
-        end
-      end
-
-      describe '#map' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          mapped = @lazy.map(&:to_s)
-          expect(mapped.take(2).to_a).to eq(%w(0 1))
-        end
-      end
-
-      describe '#take' do
-        it 'is lazy' do
-          expect(@array[0]).to receive(:to_s).and_return('0')
-          expect(@array[1]).to receive(:to_s).and_return('1')
-          expect(@array[2]).not_to receive(:to_s)
-
-          expect(@lazy.take(2).map(&:to_s).to_a).to eq(%w(0 1))
-        end
-      end
-
-      describe '#select' do
-        it 'is lazy' do
-          expect(@array[0]).not_to receive(:to_s)
-          expect(@array[1]).not_to receive(:to_s)
-          expect(@array[2]).not_to receive(:to_s)
-
-          @lazy.select(&:to_s)
-        end
-      end
-    end
-  end
-end