resync-client 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd8d1fac9a7feece07634eca0cb2b9b4e9d2ce93
-  data.tar.gz: 27e94c732902e0f9b42be6ce9ec9df74f16d641a
+  metadata.gz: b55fd1ce8dd18d7acd6b75515e5a31393d5e114f
+  data.tar.gz: fa122d38b47bb1399663f89b730b6cd763b1f603
 SHA512:
-  metadata.gz: 188aab78224fc2e642aa7759a3c9c5a4a97d156c332ef66df771d6a305758126b64352ff9651d6c68ccff3bb3da226d1f47d7f83b22ff0abc5576ed1bc13d0f9
-  data.tar.gz: 4eebbc3ba5cb6ecb5115eec09015d22fca5155a4da3fb79e6b4c99ac99c935fbda05cc93d4b444483f4a0273483306560df4d0e2bf5859a879106049e4c10b89
+  metadata.gz: 71704d10c967d97d1d260b79d405ac047c2c38a3c41dbacca9b2ffdff5477aa2898a324f10cb734e6f92bd42dc89fbe073f23715454b0dfa75308408264d5c7f
+  data.tar.gz: e171456275ef6cbc7416781343977d4f0e8b7f243253a5fcb238e0ef0e51957599bb9e0ee350ca0704f9e4c980f639c1c78f12c31f464a0b1a47591ec7212c5e

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.3.3
+
+- Make `#all_zip_packages` on `ChangeDump` and `ResourceDump` return `Enumerator::Lazy` to improve interoperation with the corresponding methods on `ResourceDumpIndex/ChangeDumpIndex`
+
 # 0.3.2
 
 - Added utility methods to `CapabilityList` to simplify downloading and parsing ResourceSync documents by capability

data/lib/resync/client/mixins/dump.rb

@@ -26,19 +26,19 @@ module Resync
           @zip_packages ||= resources.map { |r| Lazy.promise { r.zip_package } }
         end
 
-        # Aliases +:zip_packages+ as +:all_zip_packages+ for transparent
-        # interoperability between +ResourceDump+ and +ResourceDumpIndex+,
-        # +ChangeDump+ and +ChangeDumpIndex+
-        def self.prepended(ext)
-          ext.send(:alias_method, :all_zip_packages, :zip_packages)
-        end
-
       end
     end
   end
 
   class ResourceDump
     prepend Client::Mixins::Dump
+
+    # Delegates to {#zip_packages} for interoperation with {DumpIndex#all_zip_packages}.
+    # @return [Enumerator::Lazy<Resync::Resource>] a lazy enumeration of the packages for each
+    #    resource
+    def all_zip_packages
+      zip_packages.lazy
+    end
   end
 
   class ChangeDump
@@ -59,6 +59,11 @@ module Resync
       end
     end
 
-    alias_method :all_zip_packages, :zip_packages
+    # Delegates to {#zip_packages} for interoperation with {ChangeDumpIndex#all_zip_packages}.
+    # @return [Enumerator::Lazy<Resync::Resource>] a lazy enumeration of the packages for each
+    #    resource
+    def all_zip_packages(in_range: nil)
+      zip_packages(in_range: in_range).lazy
+    end
   end
 end

data/lib/resync/client/mixins/dump_index.rb

@@ -11,7 +11,7 @@ module Resync
         # Downloads and parses each resource list and returns a flattened enumeration
         # of all zip packages in each contained list. Each contained list is only downloaded
         # as needed, and only downloaded once.
-        # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of resources
+        # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of packages
         def all_zip_packages
           resources.lazy.flat_map do |r|
             package_for(r)
@@ -43,7 +43,7 @@ module Resync
     # and +until_time+, in non-strict mode (only excluding those lists provably not in the range,
     # i.e., including packages without +from_time+ or +until_time+).
     # @param in_range [Range<Time>] the range of times to filter by
-    # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of resources
+    # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of packages
     def all_zip_packages(in_range: nil)
       if in_range
         dump_resources = change_lists(in_range: in_range, strict: false)

data/lib/resync/client/version.rb

@@ -1,6 +1,6 @@
 module Resync
   class Client
     # The version of this gem.
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
   end
 end

data/spec/data/resourcedump/resourcedump.xml

@@ -7,7 +7,7 @@
          at="2015-05-22T16:06:04Z"
          completed="2015-05-05T16:23:20Z"/>
   <url>
-    <loc>http://example.com/resourcedump.zip</loc>
+    <loc>http://example.com/bitstream-package.zip</loc>
     <rs:md type="application/zip"
            length="1334"
            at="2015-05-22T16:06:04Z"

data/spec/unit/resync/client/dump_spec.rb

@@ -6,10 +6,10 @@ module Resync
     describe '#zip_packages' do
       it 'transparently exposes bitstreams' do
         path = 'spec/data/resourcedump/resourcedump.xml'
-        package_uri = URI('http://example.com/resourcedump.zip')
+        package_uri = URI('http://example.com/bitstream-package.zip')
 
         client = instance_double(Client)
-        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/bitstream-package.zip')
 
         dump = XMLParser.parse(File.read(path))
         dump.client = client
@@ -81,21 +81,24 @@ module Resync
     end
 
     describe '#all_zip_packages' do
-      it 'is an alias for #zip_packages' do
+      it 'delegates to #zip_packages, lazily' do
         path = 'spec/data/resourcedump/resourcedump.xml'
-        package_uri = URI('http://example.com/resourcedump.zip')
+        package_uri = URI('http://example.com/bitstream-package.zip')
 
         client = instance_double(Client)
-        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/bitstream-package.zip')
 
         dump = XMLParser.parse(File.read(path))
         dump.client = client
 
         all_zip_packages = dump.all_zip_packages
-        expect(all_zip_packages.size).to eq(1)
-        expect(all_zip_packages[0]).to be_a(Client::Zip::ZipPackage)
+        expect(all_zip_packages).to be_a(Enumerator::Lazy)
 
-        bitstreams = all_zip_packages[0].bitstreams
+        all_zip_packages_array = all_zip_packages.to_a
+        expect(all_zip_packages_array.size).to eq(1)
+        expect(all_zip_packages_array[0]).to be_a(Client::Zip::ZipPackage)
+
+        bitstreams = all_zip_packages_array[0].bitstreams
         expect(bitstreams.size).to eq(2)
         expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
         expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))
@@ -110,7 +113,7 @@ module Resync
         package_uri = URI('http://example.com/changedump.zip')
 
         client = instance_double(Client)
-        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/bitstream-package.zip')
 
         dump = XMLParser.parse(File.read(path))
         dump.client = client
@@ -182,21 +185,24 @@ module Resync
     end
 
     describe '#all_zip_packages' do
-      it 'is an alias for #zip_packages' do
+      it 'delegates to #zip_packages, lazily' do
         path = 'spec/data/resourcedump/changedump.xml'
         package_uri = URI('http://example.com/changedump.zip')
 
         client = instance_double(Client)
-        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/bitstream-package.zip')
 
         dump = XMLParser.parse(File.read(path))
         dump.client = client
 
-        zip_packages = dump.all_zip_packages
-        expect(zip_packages.size).to eq(1)
-        expect(zip_packages[0]).to be_a(Client::Zip::ZipPackage)
+        all_zip_packages = dump.all_zip_packages
+        expect(all_zip_packages).to be_a(Enumerator::Lazy)
 
-        bitstreams = zip_packages[0].bitstreams
+        all_zip_packages_array = all_zip_packages.to_a
+        expect(all_zip_packages_array.size).to eq(1)
+        expect(all_zip_packages_array[0]).to be_a(Client::Zip::ZipPackage)
+
+        bitstreams = all_zip_packages_array[0].bitstreams
         expect(bitstreams.size).to eq(2)
         expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
         expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))

data/spec/unit/resync/client/zip_package_spec.rb

@@ -6,7 +6,7 @@ module Resync
       describe ZipPackage do
         describe '#new' do
           it 'accepts a path to a ZIP file' do
-            path = 'spec/data/resourcedump/resourcedump.zip'
+            path = 'spec/data/resourcedump/bitstream-package.zip'
             pkg = ZipPackage.new(path)
             zipfile = pkg.zipfile
             expect(zipfile).to be_a(::Zip::File)
@@ -14,19 +14,19 @@ module Resync
           end
 
           it 'accepts a Zip::File object' do
-            zipfile = ::Zip::File.open('spec/data/resourcedump/resourcedump.zip')
+            zipfile = ::Zip::File.open('spec/data/resourcedump/bitstream-package.zip')
             pkg = ZipPackage.new(zipfile)
             expect(pkg.zipfile).to eq(zipfile)
           end
 
           it 'extracts a manifest' do
-            pkg = ZipPackage.new('spec/data/resourcedump/resourcedump.zip')
+            pkg = ZipPackage.new('spec/data/resourcedump/bitstream-package.zip')
             manifest = pkg.manifest
             expect(manifest).to be_a(Resync::ResourceDumpManifest)
           end
 
           it 'extracts entries' do
-            pkg = ZipPackage.new('spec/data/resourcedump/resourcedump.zip')
+            pkg = ZipPackage.new('spec/data/resourcedump/bitstream-package.zip')
             bitstreams = pkg.bitstreams
             expect(bitstreams.size).to eq(2)
 
@@ -42,7 +42,7 @@ module Resync
           end
 
           it 'provides direct access to bitstreams for each resource in the manifest' do
-            pkg = ZipPackage.new('spec/data/resourcedump/resourcedump.zip')
+            pkg = ZipPackage.new('spec/data/resourcedump/bitstream-package.zip')
             bitstreams = pkg.bitstreams
 
             manifest = pkg.manifest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resync-client
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazy
@@ -231,10 +231,10 @@ files:
 - spec/data/examples/resource-list-index.xml
 - spec/data/examples/resource-list.xml
 - spec/data/examples/source-description.xml
+- spec/data/resourcedump/bitstream-package.zip
 - spec/data/resourcedump/changedump.xml
 - spec/data/resourcedump/manifest.xml
 - spec/data/resourcedump/resourcedump.xml
-- spec/data/resourcedump/resourcedump.zip
 - spec/data/resourcedump/resources/res1
 - spec/data/resourcedump/resources/res2
 - spec/data/simulator/capability-list.xml
@@ -297,10 +297,10 @@ test_files:
 - spec/data/examples/resource-list-index.xml
 - spec/data/examples/resource-list.xml
 - spec/data/examples/source-description.xml
+- spec/data/resourcedump/bitstream-package.zip
 - spec/data/resourcedump/changedump.xml
 - spec/data/resourcedump/manifest.xml
 - spec/data/resourcedump/resourcedump.xml
-- spec/data/resourcedump/resourcedump.zip
 - spec/data/resourcedump/resources/res1
 - spec/data/resourcedump/resources/res2
 - spec/data/simulator/capability-list.xml