resync-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 892297d37e81bd989c01ec1b8727c75944272ef5
-  data.tar.gz: 54e05162319203f118f59c2582ef2522cdf7e869
+  metadata.gz: 541947c7770153caf12143dc26d885166877c4bd
+  data.tar.gz: 5b7aa7977c089a5d09c7997d92088a695cece901
 SHA512:
-  metadata.gz: e6ae887ca08bda37140982c22c0f8cd6594f243a826464a9178d64e3f48e43340ffa20e50b853e4d09281ac3b831fa92c6ec6c23ad373c4a8ee476fb6a43957f
-  data.tar.gz: a841308856143cff35689d72676e4cb31e32207622b7f35582f56bd2524793ab56412d93236afa3400d6a31c593f74358e36064014ec2a4576023c4b4e3bfd20
+  metadata.gz: 2d4c7fa6f2ea310e34ff78c2fe956c99e1967ec4c4bba23d88a42cf5e0cc11ff5e4d84e8f88d2b79cf3f446132dbf97ab8e20ae903d90d58fa6306361c2e7c45
+  data.tar.gz: b23323bc0c7ca29050e4379d8596fb7d4b51f16f9f14fee80e62be12f0b4d2fd0fd34b541825d77b8d8f825b883cdf94bc569e007b02d8c8994dc9d341b5d34f

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.1.2
+
+- Change the `:zip_packages` extension method on `ResourceDump` and `ChangeDump` to return a lazy enumerable instead of preemptively downloading all packages. 
+
 # 0.1.1
 
 - Update to depend on [resync](https://github.com/dmolesUC3/resync) 0.1.1

data/lib/resync/client/dump.rb

@@ -1,4 +1,4 @@
-require_relative 'zip_package'
+require_relative 'zip_packages'
 
 module Resync
   # Extends {ChangeDump} and {ResourceDump} to provide
@@ -16,10 +16,11 @@ module Resync
       end
     end
 
-    # A list of the {ZipPackage}s for each resource
-    # @return [Array<ZipPackage>] the zip packages for each resource
+    # A list (downloaded lazily) of the {ZipPackage}s for each resource
+    # @return [ZipPackages] the zip packages for each resource
     def zip_packages
-      resources.map(&:zip_package)
+      @zip_packages ||= ZipPackages.new(resources)
     end
   end
+
 end

data/lib/resync/client/version.rb

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

data/lib/resync/client/zip_packages.rb

@@ -0,0 +1,51 @@
+module Resync
+  # Lazily retrieves and caches the zip packages for the specified
+  # list of resources. The packages are cached to temporary files
+  # which are deleted on exit; if they are deleted while the
+  # interpreter is running, the behavior is undefined (but bad things
+  # are likely to happen).
+  class ZipPackages
+    include Enumerable
+
+    # Creates a new {ZipPackages} wrapper for the specified list
+    # of resources.
+    # @param resources [Array<Resource>] The list of resources to
+    #   get zip packages for.
+    def initialize(resources)
+      @resources = resources
+      @packages = {}
+    end
+
+    # Gets the size of this list of packages.
+    # @return the size of the underlying array.
+    def size
+      @resources.size
+    end
+
+    # Gets the zip package at the specified index, downloading it
+    # if necessary.
+    #
+    # @return [ZipPackage] the zip package for the resource at the
+    #   specified index in the underlying array.
+    def [](key)
+      resource = @resources[key]
+      package_for(resource)
+    end
+
+    # Gets the zip package for the specified resource, downloading it
+    # if necessary.
+    # @return [ZipPackage] the package for the resource
+    def package_for(resource)
+      @packages[resource] ||= resource.zip_package
+    end
+
+    # Lazily iterates the given block for each zip package, downloading
+    # as necessary.
+    # @param &block [Block] The block to iterate
+    def each
+      @resources.lazy.each do |resource|
+        yield package_for(resource)
+      end
+    end
+  end
+end

data/resync-client.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'resync', '~> 0.1', '>= 0.1.1'
-  spec.add_dependency 'rubyzip', '~> 1.1.7'
+  spec.add_dependency 'rubyzip', '~> 1.1'
 
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
   spec.add_development_dependency 'rake', '~> 10.4'

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

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Resync
+  describe ZipPackages do
+    it 'is lazy' do
+      resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+
+      zip_packages = ZipPackages.new(resources)
+
+      zip_package = instance_double(ZipPackage)
+      expect(resources[0]).not_to receive(:zip_package)
+      expect(resources[1]).not_to receive(:zip_package)
+      expect(resources[2]).to receive(:zip_package).and_return(zip_package)
+
+      expect(zip_packages[2]).to be(zip_package)
+    end
+
+    it 'caches zip packages' do
+      resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+
+      zip_packages = ZipPackages.new(resources)
+
+      zip_package = instance_double(ZipPackage)
+      expect(resources[1]).to receive(:zip_package).once.and_return(zip_package)
+
+      expect(zip_packages[1]).to be(zip_package)
+      expect(zip_packages[1]).to be(zip_package)
+    end
+
+    it 'supports lazy iteration' do
+      manifests = Array.new(3) { instance_double(ChangeDumpManifest) }
+      all_packages = Array.new(3) do |index|
+        zip_package = instance_double(ZipPackage)
+        allow(zip_package).to receive(:manifest).and_return(manifests[index])
+        zip_package
+      end
+      resources = Array.new(3) do |index|
+        resource = Resource.new(uri: "http://example.org/res#{index}")
+        if index > 1
+          expect(resource).not_to receive(:zip_package)
+        else
+          expect(resource).to receive(:zip_package).and_return(all_packages[index])
+        end
+        resource
+      end
+
+      zip_packages = ZipPackages.new(resources)
+      zip_packages.each_with_index do |zip_package, index|
+        expect(zip_package.manifest).to be(manifests[index])
+        break if index >= 1
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resync-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resync
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +168,7 @@ files:
 - lib/resync/client/resync_extensions.rb
 - lib/resync/client/version.rb
 - lib/resync/client/zip_package.rb
+- lib/resync/client/zip_packages.rb
 - resync-client.gemspec
 - spec/data/examples/capability-list.xml
 - spec/data/examples/change-dump-manifest.xml
@@ -193,6 +194,7 @@ files:
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/resync_extensions_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
+- spec/unit/resync/client/zip_packages_spec.rb
 homepage: http://github.com/dmolesUC3/resync-client
 licenses:
 - MIT
@@ -213,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Client library for ResourceSync
@@ -242,4 +244,5 @@ test_files:
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/resync_extensions_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
+- spec/unit/resync/client/zip_packages_spec.rb
 has_rdoc: