zip-container 1.1.0 → 2.0.0

data/test/tc_read.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013, 2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -37,38 +37,38 @@ class TestRead < Test::Unit::TestCase
 
   # Check that the null file does not verify.
   def test_verify_null_file
-    assert_raise(Zip::ZipError) do
-      ZipContainer::Container.verify!($file_null)
+    assert_raise(ZipContainer::ZipError) do
+      ZipContainer::File.verify!($file_null)
     end
 
-    refute(ZipContainer::Container.verify($file_null))
+    refute(ZipContainer::File.verify($file_null))
   end
 
   # Check that the empty container file does verify.
   def test_verify_empty_container
-    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-      ZipContainer::Container.verify!($empty)
+    assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::ZipError) do
+      ZipContainer::File.verify!($empty)
     end
 
-    assert(ZipContainer::Container.verify($empty))
+    assert(ZipContainer::File.verify($empty))
   end
 
   # Check that the empty zip file does not verify.
   def test_verify_empty_zip
     assert_raise(ZipContainer::MalformedContainerError) do
-      ZipContainer::Container.verify!($empty_zip)
+      ZipContainer::File.verify!($empty_zip)
     end
 
-    refute(ZipContainer::Container.verify($empty_zip))
+    refute(ZipContainer::File.verify($empty_zip))
   end
 
   # Check that a compressed mimetype file is detected.
   def test_verify_compressed_mimetype
     assert_raise(ZipContainer::MalformedContainerError) do
-      ZipContainer::Container.verify!($compressed_mimetype)
+      ZipContainer::File.verify!($compressed_mimetype)
     end
 
-    refute(ZipContainer::Container.verify($compressed_mimetype))
+    refute(ZipContainer::File.verify($compressed_mimetype))
   end
 
   # Check the raw mimetype bytes
@@ -83,8 +83,8 @@ class TestRead < Test::Unit::TestCase
   # Check reading files out of a container file and make sure we don't change
   # it.
   def test_read_files_from_container
-    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-      ZipContainer::Container.open($example) do |c|
+    assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::ZipError) do
+      ZipContainer::File.open($example) do |c|
         assert(c.on_disk?)
         refute(c.in_memory?)
 

data/test/tc_reserved_names.rb

@@ -34,7 +34,7 @@ require 'test/unit'
 require 'zip-container'
 
 # A class to test the overriding of reserved and managed names.
-class NewZipContainer < ZipContainer::Container
+class NewZipContainer < ZipContainer::File
 
   private_class_method :new
 
@@ -66,7 +66,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check the reserved names stuff all works correctly, baring in mind that
   # such comparisons for ZipContainer file should be case sensitive.
   def test_reserved_names
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert_equal(1, c.reserved_names.length)
       assert_equal(["mimetype"], c.reserved_names)
 
@@ -129,7 +129,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that nothing happens when trying to delete the mimetype file.
   def test_delete_mimetype
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert(c.file.exists?("mimetype"))
       assert_nil(c.remove("mimetype"))
       assert(c.file.exists?("mimetype"))
@@ -138,7 +138,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that nothing happens when trying to rename the mimetype file.
   def test_rename_mimetype
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert(c.file.exists?("mimetype"))
       assert_nil(c.rename("mimetype", "something-else"))
       assert(c.file.exists?("mimetype"))
@@ -149,7 +149,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that nothing happens when trying to replace the contents of the
   # mimetype file.
   def test_replace_mimetype
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert(c.file.exists?("mimetype"))
       assert_nil(c.replace("mimetype", $zip_empty))
       assert_equal("application/epub+zip", c.file.read("mimetype"))
@@ -159,7 +159,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that an exception is raised when trying to add file with a reserved
   # name.
   def test_add_reserved
-    ZipContainer::Container.open($empty) do |c|
+    ZipContainer::File.open($empty) do |c|
       assert_raises(ZipContainer::ReservedNameClashError) do
         c.add("mimetype", $zip_empty)
       end
@@ -191,7 +191,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the META-INF directory is detected as non-existent when trying
   # to delete it.
   def test_delete_metainf
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert_raises(Errno::ENOENT) do
         c.remove("META-INF")
       end
@@ -201,7 +201,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the META-INF directory is detected as non-existent when trying
   # to rename it.
   def test_rename_metainf
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert_raises(Errno::ENOENT) do
         c.rename("META-INF", "something-else")
       end
@@ -211,7 +211,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that an exception is raised when trying to create a directory with a
   # reserved name.
   def test_mkdir_reserved
-    ZipContainer::Container.open($empty) do |c|
+    ZipContainer::File.open($empty) do |c|
       assert_raises(ZipContainer::ReservedNameClashError) do
         c.mkdir("mimetype")
       end
@@ -246,7 +246,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that a file cannot be renamed to one of the reserved names.
   def test_rename_to_reserved
-    ZipContainer::Container.open($example) do |c|
+    ZipContainer::File.open($example) do |c|
       assert_raises(ZipContainer::ReservedNameClashError) do
         c.rename("dir/code.rb", "mimetype")
       end
@@ -270,7 +270,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the ruby-like File and Dir classes respect reserved and managed
   # names.
   def test_file_dir_ops_reserved
-    ZipContainer::Container.open($empty) do |c|
+    ZipContainer::File.open($empty) do |c|
       assert_raises(ZipContainer::ReservedNameClashError) do
         c.file.open("mimetype", "w") do |f|
           f.puts "TESTING"

data/test/tc_util.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2014 The University of Manchester, UK.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the names of The University of Manchester nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# Author: Robert Haines
+
+require 'test/unit'
+require 'zip-container'
+
+class Util
+  include ZipContainer::Util
+end
+
+class TestUtil < Test::Unit::TestCase
+
+  def setup
+    @util = Util.new
+  end
+
+  def test_entry_name_strings
+    assert_equal("test", @util.entry_name("test"))
+    assert_equal("test", @util.entry_name("test/"))
+    assert_equal("test/test", @util.entry_name("test/test"))
+    assert_equal("test/test", @util.entry_name("test/test/"))
+  end
+
+  def test_entry_name_entries
+    assert_equal("test", @util.entry_name(Zip::Entry.new("fake.zip", "test")))
+    assert_equal("test", @util.entry_name(Zip::Entry.new("fake.zip", "test/")))
+    assert_equal("test/test",
+      @util.entry_name(Zip::Entry.new("fake.zip", "test/test")))
+    assert_equal("test/test",
+      @util.entry_name(Zip::Entry.new("fake.zip", "test/test/")))
+  end
+
+  def test_entry_name_odd_things
+    uri = URI.parse("http://www.example.com/path")
+    assert_equal(uri, @util.entry_name(uri))
+  end
+
+end

data/test/ts_container.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013, 2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -42,8 +42,11 @@ $empty = "test/data/empty.container"
 $empty_zip = "test/data/empty.zip"
 $compressed_mimetype = "test/data/compressed_mimetype.container"
 $example = "test/data/example.container"
+$subclass = "test/data/subclassed.container"
 
 # Run test cases.
+require 'tc_util'
+require 'tc_exceptions'
 require 'tc_create'
 require 'tc_read'
 require 'tc_reserved_names'

data/version.yml

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

data/zip-container.gemspec

@@ -54,10 +54,11 @@ Gem::Specification.new do |s|
   s.has_rdoc         = true
   s.extra_rdoc_files = [ "Changes.rdoc", "Licence.rdoc", "ReadMe.rdoc" ]
   s.rdoc_options     = [ "-N", "--tab-width=2", "--main=ReadMe.rdoc" ]
+  s.required_ruby_version = ">= 1.9.3"
   s.add_development_dependency("rake", "~> 10.0.4")
   s.add_development_dependency("bundler", "~> 1.5")
   s.add_development_dependency("rdoc", "~> 4.0.1")
   s.add_development_dependency('coveralls')
-  s.add_runtime_dependency("rubyzip", "~> 1.1.4")
+  s.add_runtime_dependency("rubyzip", "~> 1.1.6")
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.1.6
 description: A Ruby library for working with ZIP Container Format files. See http://www.idpf.org/epub/30/spec/epub30-ocf.html
   for the OCF specification and https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format
   for the UCF specification.
@@ -105,23 +105,28 @@ files:
 - examples/verify-zip-container
 - examples/zip-container-info
 - lib/zip-container.rb
-- lib/zip-container/container.rb
 - lib/zip-container/entries/directory.rb
 - lib/zip-container/entries/entry.rb
 - lib/zip-container/entries/file.rb
 - lib/zip-container/entries/managed.rb
 - lib/zip-container/entries/reserved.rb
 - lib/zip-container/exceptions.rb
+- lib/zip-container/file.rb
+- lib/zip-container/util.rb
 - lib/zip-container/version.rb
 - test/data/compressed_mimetype.container
 - test/data/empty.container
 - test/data/empty.zip
 - test/data/example.container
 - test/data/null.file
+- test/data/subclassed.container
+- test/helpers/entry_lists.rb
 - test/tc_create.rb
+- test/tc_exceptions.rb
 - test/tc_managed_entries.rb
 - test/tc_read.rb
 - test/tc_reserved_names.rb
+- test/tc_util.rb
 - test/ts_container.rb
 - version.yml
 - zip-container.gemspec
@@ -140,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -158,8 +163,12 @@ test_files:
 - test/data/empty.zip
 - test/data/example.container
 - test/data/null.file
+- test/data/subclassed.container
+- test/helpers/entry_lists.rb
 - test/tc_create.rb
+- test/tc_exceptions.rb
 - test/tc_managed_entries.rb
 - test/tc_read.rb
 - test/tc_reserved_names.rb
+- test/tc_util.rb
 - test/ts_container.rb