zip-container 2.1.0 → 2.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmM2M2M1M2YyMWUwOTk2NWRkNjllMjU0MDc0ZjQ4NGU3OWRiNTFlMg==
+    NmZhNWQzYmVkZGVjNDczNTNjN2M3M2Q2ZmJjYmI5YTEzMDYwZTE0Nw==
   data.tar.gz: !binary |-
-    OWFjNzFmYjM4NTliZjc4ZGE0NTZjYzNhMjBiMjJjY2Q3NGVmZjdmMw==
+    Mzg5YjU5ZjYyYjMzOGUyZWU1ZTk5NjI4YWRmNTQwNTk1NTU1OGJmZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmQxZTFjNzY2NjEyZGIzM2IzOTc2ZGU1ZjlkM2IwMzljZmM4NmUyN2JmNWYx
-    ZGU4YWU0ZjYzOTU3MjU3ZWVhZjdlNzI4MjY3MzhkYTEyNmNkOGFjNWNkZjFh
-    NmE1YWU3YWFjMzM0ODI0YTM2YTc4NzU3MDYyYzE2MTVjMDZjMTc=
+    N2NjNjI1ZmJhNTQ5NzdiMGU3MjgxZTEwNjM5Zjk5NDgyMGYxYzRjZmYwMmNm
+    ODg2M2ZmZTllNjU2YjNmMWU2ZGQzOTlhYTE3ODAzNzI3NjY2YmRiY2JiYjg2
+    MjZkN2E5NTljMmIzYjIyNTcyZTE4ZDg3OGY4M2Q1NzkxOGJhZjc=
   data.tar.gz: !binary |-
-    MDBmMWJmMjE2YzY4ZjkxYWZiOWU2NzNhOTU3Njk4MDViYWIzOGYyMDEzZDlk
-    NTNiYTM4YmFmMjAwNDZmZGVlMjYxMTAxMDU3YTcyYWVmMmE1NjFjMGY5MGFm
-    YmE0MjQwOTFkZjk1MGM2ZDQyY2ZhMDViYTA0NWYyM2ZlMjk3YTU=
+    NzNhYjc1YmQ5MTg5YWU1ZDNlN2U0MDlkMDYxNDgxNDYxOTA2YWM5MzI2Njgz
+    MmRjOTkyNWM1NWMzZmE5ZDA1ZTBiNGJhMzRhNWZkMGU5MWEwMDBjNjcxNzUx
+    NDU2ZGMwNGEyNjBkYjFkM2Q3MzMwMzAzMzcyYjMyZTEwZjcyNjA=

data/Changes.rdoc

@@ -1,5 +1,13 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 2.2.0
+
+* Fix pathname bug in ZipContainer::Dir.
+* Fixup docs to refer to containers rather than documents.
+* Fix the base class in the recursive methods.
+* Add an internal compatibility method Dir#entries.
+* Add a compatibility method Dir#read.
+
 == Version 2.1.0
 
 * Set up the Container superclass.

data/lib/zip-container/dir.rb

@@ -48,8 +48,8 @@ module ZipContainer
   class Dir < Container
 
     extend Forwardable
-    def_delegators :@container, :close, :each, :path, :pos, :pos=, :read,
-      :rewind, :seek, :tell
+    def_delegators :@container, :close, :each, :path, :pos, :pos=, :rewind,
+      :seek, :tell
 
     private_class_method :new
 
@@ -60,14 +60,14 @@ module ZipContainer
     # :startdoc:
 
     # :call-seq:
-    #   create(pathname, mimetype) -> document
-    #   create(pathname, mimetype) {|document| ...}
+    #   create(pathname, mimetype) -> container
+    #   create(pathname, mimetype) {|container| ...}
     #
     # Create a new (or convert an existing) directory as a ZipContainer with
     # the specified mimetype.
     def self.create(pathname, mimetype, &block)
       ::Dir.mkdir(pathname) unless ::File.directory?(pathname)
-      ::File.write(full_path(MIMETYPE_FILE), mimetype)
+      ::File.write(::File.join(pathname, MIMETYPE_FILE), mimetype)
 
       # Now open the newly created container.
       c = new(pathname)
@@ -83,6 +83,53 @@ module ZipContainer
       c
     end
 
+    # :call-seq:
+    #   read
+    #   read(path) -> file contents
+    #
+    # Provides compatibility between directory and zip containers. If called
+    # without any parameters it acts like
+    # {::Dir.read}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-read] but
+    # if called with a path then it acts like
+    # {Zip::File#read}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/File#read-instance_method].
+    #
+    # Please see the documentation of the relevant method for more details.
+    def read(name = nil)
+      return @container.read if name.nil?
+
+      ::File.read(full_path(name))
+    end
+
+    # :stopdoc:
+    # For internal use only!
+    # This method and the Entry and Entries classes provide compatibility
+    # between zip-style and dir-style entries
+    def entries
+      Entries.new(@container)
+    end
+
+    class Entries
+      include Enumerable
+
+      Entry = Struct.new(:name, :ftype)
+
+      def initialize(dir)
+        @entries = []
+
+        dir.each do |name|
+          type = ::File.directory?(name) ? :directory : :file
+          @entries << Entry.new(name, type)
+        end
+      end
+
+      def each(&block)
+        @entries.each do |entry|
+          yield entry
+        end
+      end
+    end
+    # :startdoc:
+
     private
 
     # Prepend the full path of the directory name to whatever is passed in
@@ -155,14 +202,6 @@ module ZipContainer
     # Equal to
     # {::Dir.pos=}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-pos-3D]
 
-    ##
-    # :method: read
-    # :call-seq:
-    #   read -> string or nil
-    #
-    # Equal to
-    # {::Dir.read}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-read]
-
     ##
     # :method: rewind
     # :call-seq:

data/lib/zip-container/entries/entry.rb

@@ -60,7 +60,7 @@ module ZipContainer
     #
     # The fully qualified name of this ManagedEntry.
     def full_name
-      @parent.is_a?(ZipContainer::File) ? @name : "#{@parent.full_name}/#{@name}"
+      @parent.is_a?(ZipContainer::Container) ? @name : "#{@parent.full_name}/#{@name}"
     end
 
     # :call-seq:
@@ -78,7 +78,7 @@ module ZipContainer
     # Is this ManagedEntry hidden for normal operations?
     def hidden?
       # An entry is hidden if its parent is hidden.
-      @parent.is_a?(ZipContainer::File) ? @hidden : @hidden || @parent.hidden?
+      @parent.is_a?(ZipContainer::Container) ? @hidden : @hidden || @parent.hidden?
     end
 
     # :call-seq:
@@ -140,7 +140,7 @@ module ZipContainer
     #
     # Return the Container that this ManagedEntry resides in.
     def container
-      @parent.is_a?(ZipContainer::File) ? @parent : @parent.container
+      @parent.is_a?(ZipContainer::Container) ? @parent : @parent.container
     end
 
   end

data/lib/zip-container/file.rb

@@ -70,8 +70,8 @@ module ZipContainer
     # :startdoc:
 
     # :call-seq:
-    #   File.create(filename, mimetype) -> document
-    #   File.create(filename, mimetype) {|document| ...}
+    #   File.create(filename, mimetype) -> container
+    #   File.create(filename, mimetype) {|container| ...}
     #
     # Create a new ZipContainer file on disk with the specified mimetype.
     def self.create(filename, mimetype, &block)

data/test/data/dirs/managed/greeting.txt

@@ -0,0 +1 @@
+Hello, World!

data/test/data/dirs/managed/mimetype

@@ -0,0 +1 @@
+application/epub+zip

data/test/tc_create_dir.rb

@@ -36,23 +36,20 @@ require 'zip-container'
 
 class TestCreateDir < Test::Unit::TestCase
 
-  # Check that a mimetype which is not readable does not verify. We have to
-  # build this fixture programmatically as there's no way to add a file
-  # without read permissions into git.
-  def test_verify_unreadable_mimetype
+  def test_create_container
     Dir.mktmpdir do |dir|
-      container = File.join(dir, "unreadable")
-      Dir.mkdir(container)
-      mime_path = File.join(container, ZipContainer::Container::MIMETYPE_FILE)
-      File.open(mime_path, "w") { |file| file.write "MIMETYPE" }
-      File.chmod(0000, mime_path)
+      container = File.join(dir, "empty.container")
 
-      refute File.readable?(mime_path)
-      assert_raise(ZipContainer::MalformedContainerError) do
+      assert_nothing_raised do
+        ZipContainer::Dir.create(container, $mimetype) do |c|
+          assert File.exists?(File.join(container, "mimetype"))
+        end
+      end
+
+      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::ZipError) do
         ZipContainer::Dir.verify!(container)
       end
 
-      refute(ZipContainer::Dir.verify(container))
     end
   end
 

data/test/tc_managed_entries.rb

@@ -85,6 +85,28 @@ class ExampleZipContainer2 < ZipContainer::File
 
 end
 
+class ExampleDirContainer < ZipContainer::Dir
+
+  private_class_method :new
+
+  def initialize(filename)
+    super(filename)
+
+    valid = Proc.new { |contents| contents.match(/[Hh]ello/) }
+
+    test_file = ZipContainer::ManagedFile.new("test.txt")
+    register_managed_entry(ZipContainer::ManagedDirectory.new("dir",
+      :required => true, :entries => [test_file]))
+    register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt",
+      :required => true, :validation_proc => valid))
+  end
+
+  #def ExampleDirContainer.create(filename, &block)
+  #  super(filename, "application/example+zip", &block)
+  #end
+
+end
+
 class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example ZipContainer file does not validate as a
@@ -140,6 +162,38 @@ class TestManagedEntries < Test::Unit::TestCase
     end
   end
 
+  # Check that a subclassed container with managed files verifies correctly.
+  def test_verify_subclassed_dir_container
+    assert_nothing_raised do
+      ExampleDirContainer.verify!($dir_managed)
+    end
+  end
+
+  # Create a subclassed container. Check it doesn't verify at first; satisfy
+  # the conditions; then assert that it verifies correctly.
+  def test_create_subclassed_dir_container
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ExampleDirContainer.create(filename, $mimetype) do |c|
+          assert_raises(ZipContainer::MalformedContainerError) do
+            c.verify!
+          end
+
+          Dir.mkdir(File.join(filename, "dir"))
+          File.open(File.join(filename, "greeting.txt"), "w") do |f|
+            f.puts "Yo means hello."
+          end
+
+          assert_nothing_raised(ZipContainer::MalformedContainerError) do
+            c.verify!
+          end
+        end
+      end
+    end
+  end
+
   # Check that a ManagedZipContainer does not verify immediately after
   # creation.
   def test_create_bad_subclassed_container

data/test/tc_read_dir.rb

@@ -31,6 +31,7 @@
 # Author: Robert Haines
 
 require 'test/unit'
+require 'tmpdir'
 require 'zip-container'
 
 class TestReadDir < Test::Unit::TestCase
@@ -62,4 +63,24 @@ class TestReadDir < Test::Unit::TestCase
     refute(ZipContainer::Dir.verify($dir_dir_mimetype))
   end
 
+  # Check that a mimetype which is not readable does not verify. We have to
+  # build this fixture programmatically as there's no way to add a file
+  # without read permissions into git.
+  def test_verify_unreadable_mimetype
+    Dir.mktmpdir do |dir|
+      container = File.join(dir, "unreadable.container")
+      Dir.mkdir(container)
+      mime_path = File.join(container, ZipContainer::Container::MIMETYPE_FILE)
+      File.open(mime_path, "w") { |file| file.write "MIMETYPE" }
+      File.chmod(0000, mime_path)
+
+      refute File.readable?(mime_path)
+      assert_raise(ZipContainer::MalformedContainerError) do
+        ZipContainer::Dir.verify!(container)
+      end
+
+      refute(ZipContainer::Dir.verify(container))
+    end
+  end
+
 end

data/test/ts_container.rb

@@ -40,6 +40,7 @@ $mimetype = "application/epub+zip"
 $dir_null = "test/data/dirs/null"
 $dir_empty = "test/data/dirs/empty"
 $dir_dir_mimetype = "test/data/dirs/dir-mimetype"
+$dir_managed = "test/data/dirs/managed"
 $file_null = "test/data/null.file"
 $empty = "test/data/empty.container"
 $empty_zip = "test/data/empty.zip"

data/version.yml

@@ -1,4 +1,4 @@
 ---
   :major: 2
-  :minor: 1
+  :minor: 2
   :patch: 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,9 @@ files:
 - test/data/compressed_mimetype.container
 - test/data/dirs/dir-mimetype/mimetype/.gitkeep
 - test/data/dirs/empty/mimetype
+- test/data/dirs/managed/dir/.gitkeep
+- test/data/dirs/managed/greeting.txt
+- test/data/dirs/managed/mimetype
 - test/data/dirs/null/.gitkeep
 - test/data/empty.container
 - test/data/empty.zip
@@ -183,6 +186,9 @@ test_files:
 - test/data/compressed_mimetype.container
 - test/data/dirs/dir-mimetype/mimetype/.gitkeep
 - test/data/dirs/empty/mimetype
+- test/data/dirs/managed/dir/.gitkeep
+- test/data/dirs/managed/greeting.txt
+- test/data/dirs/managed/mimetype
 - test/data/dirs/null/.gitkeep
 - test/data/empty.container
 - test/data/empty.zip