zip-container 0.8.0 → 0.9.0

data/Changes.rdoc

@@ -1,5 +1,10 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 0.9.0
+
+* Generalize the Container Error class names.
+* Polish example scripts.
+
 == Version 0.8.0
 
 * Abstract out all the underlying zip functionality and turn this library

data/examples/{create-zip-container.rb → create-zip-container}

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # Copyright (c) 2013 The University of Manchester, UK.
 #
 # All rights reserved.
@@ -33,13 +34,22 @@
 require 'rubygems'
 require 'zip-container'
 
-ZIP_FILE = "example.zip"
-file = ARGV.length > 0 ? ARGV[0] : ZIP_FILE
+def usage
+  puts "Usage:\n  create-zip-container <zip-container-file>"
+  exit 1
+end
+
+usage unless ARGV.length == 1
 
-File.delete(file) if File.exists?(file)
+container_file = ARGV[0]
+
+if File.exists?(container_file)
+  puts "File '#{container_file}' already exists. Exiting."
+  exit 1
+end
 
 begin
-  ZipContainer::Container.create(file, "application/epub+zip") do |c|
+  ZipContainer::Container.create(container_file, "application/epub+zip") do |c|
 
     # Add a cheery greeting file from a string.
     c.file.open("greeting.txt", "w") do |f|
@@ -55,7 +65,7 @@ begin
     # Add a explanation of this file.
     c.comment = "This is an example Container file!"
   end
-rescue ZipContainer::MalformedZipContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
   puts err.to_s
   exit 1
 end

data/examples/{verify-zip-container.rb → verify-zip-container}

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # Copyright (c) 2013 The University of Manchester, UK.
 #
 # All rights reserved.
@@ -33,12 +34,18 @@
 require 'rubygems'
 require 'zip-container'
 
-ZIP_FILE = "example.zip"
-file = ARGV.length > 0 ? ARGV[0] : ZIP_FILE
+def usage
+  puts "Usage:\n  verify-zip-container <zip-container-file>"
+  exit 1
+end
+
+usage unless ARGV.length == 1
+
+container_file = ARGV[0]
 
 begin
-  ZipContainer::Container.verify!(file)
-rescue ZipContainer::MalformedZipContainerError, Zip::ZipError => err
+  ZipContainer::Container.verify!(container_file)
+rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
   puts err.to_s
   exit 1
 end

data/examples/zip-container-info

@@ -35,7 +35,7 @@ require 'rubygems'
 require 'zip-container'
 
 def usage
-  puts "zip-container-info zip-container-file"
+  puts "Usage:\n  zip-container-info <zip-container-file>"
   exit 1
 end
 
@@ -45,7 +45,7 @@ container_file = ARGV[0]
 
 begin
   container = ZipContainer::Container.open(container_file)
-rescue ZipContainer::MalformedZipContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
   puts err.to_s
   exit 1
 end

data/lib/zip-container/container.rb

@@ -358,12 +358,12 @@ module ZipContainer
       # Check mimetype file is present and correct.
       entry = @zipfile.find_entry(MIMETYPE_FILE)
 
-      raise MalformedZipContainerError.new("'mimetype' file is missing.") if entry.nil?
+      raise MalformedContainerError.new("'mimetype' file is missing.") if entry.nil?
       if entry.localHeaderOffset != 0
-        raise MalformedZipContainerError.new("'mimetype' file is not at offset 0 in the archive.")
+        raise MalformedContainerError.new("'mimetype' file is not at offset 0 in the archive.")
       end
       if entry.compression_method != ::Zip::ZipEntry::STORED
-        raise MalformedZipContainerError.new("'mimetype' file is compressed.")
+        raise MalformedContainerError.new("'mimetype' file is compressed.")
       end
 
       true

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

@@ -61,7 +61,7 @@ module ZipContainer
     # Verify this ManagedDirectory for correctness. ManagedFiles registered
     # within it are verified recursively.
     #
-    # A MalformedZipContainerError is raised if it does not pass verification.
+    # A MalformedContainerError is raised if it does not pass verification.
     def verify!
       super
       @files.values.each { |f| f.verify! }

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

@@ -111,15 +111,15 @@ module ZipContainer
     # :call-seq:
     #   verify!
     #
-    # Verify this ManagedEntry raising a MalformedZipContainerError if it
+    # Verify this ManagedEntry raising a MalformedContainerError if it
     # fails.
     #
     # Subclasses should override this method if they require more complex
     # verification to be done.
     def verify!
       unless !@required || exists?
-        raise MalformedZipContainerError.new("Entry '#{full_name}' is required but "\
-          "missing.")
+        raise MalformedContainerError.new("Entry '#{full_name}' is required "\
+          "but missing.")
       end
     end
 

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

@@ -67,11 +67,11 @@ module ZipContainer
     # Verify this ManagedFile for correctness. The contents are validated if
     # required.
     #
-    # A MalformedZipContainerError is raised if it does not pass verification.
+    # A MalformedContainerError is raised if it does not pass verification.
     def verify!
       super
       unless (exists? ? validate : true)
-        raise MalformedZipContainerError.new("The contents of file "\
+        raise MalformedContainerError.new("The contents of file "\
           "'#{full_name}' do not pass validation.")
       end
     end

data/lib/zip-container/exceptions.rb

@@ -34,29 +34,29 @@
 module ZipContainer
 
   # The base class of all other exceptions raised by this library.
-  class ZipContainerError < RuntimeError
+  class ContainerError < RuntimeError
   end
 
-  # This exception is raised when a bad ZipContainer is detected.
-  class MalformedZipContainerError < ZipContainerError
+  # This exception is raised when a bad Container is detected.
+  class MalformedContainerError < ContainerError
 
     # :call-seq:
     #   new(reason = "")
     #
-    # Create a new MalformedZipContainerError with an optional reason for why
-    # the ZipContainer file is malformed.
+    # Create a new MalformedContainerError with an optional reason for why
+    # the Container file is malformed.
     def initialize(reason = nil)
       if reason.nil?
-        super("Malformed ZipContainer File.")
+        super("Malformed Container File.")
       else
-        super("Malformed ZipContainer File: #{reason}")
+        super("Malformed Container File: #{reason}")
       end
     end
   end
 
   # This exception is raised when a clash occurs with a reserved or managed
   # name.
-  class ReservedNameClashError < ZipContainerError
+  class ReservedNameClashError < ContainerError
 
     # :call-seq:
     #   new(name)

data/test/tc_create.rb

@@ -50,7 +50,7 @@ class TestCreation < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
         ZipContainer::Container.verify!(filename)
       end
     end
@@ -72,7 +72,7 @@ class TestCreation < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
         ZipContainer::Container.verify!(filename)
       end
     end
@@ -115,7 +115,7 @@ class TestCreation < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
         ZipContainer::Container.open(filename) do |c|
           assert(c.on_disk?)
           refute(c.in_memory?)

data/test/tc_managed_entries.rb

@@ -86,7 +86,7 @@ class TestManagedEntries < Test::Unit::TestCase
   def test_fail_verification
     refute(ManagedZipContainer.verify($example))
 
-    assert_raises(ZipContainer::MalformedZipContainerError) do
+    assert_raises(ZipContainer::MalformedContainerError) do
       ManagedZipContainer.verify!($example)
     end
   end
@@ -96,7 +96,7 @@ class TestManagedEntries < Test::Unit::TestCase
   def test_pass_verification
     assert(ExampleZipContainer.verify($example))
 
-    assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
       ExampleZipContainer.verify!($example)
     end
   end
@@ -106,7 +106,7 @@ class TestManagedEntries < Test::Unit::TestCase
   def test_pass_verification_2
     assert(ExampleZipContainer2.verify($example))
 
-    assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
       ExampleZipContainer2.verify!($example)
     end
   end
@@ -128,7 +128,7 @@ class TestManagedEntries < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError) do
         ZipContainer::Container.verify!(filename)
       end
     end
@@ -142,14 +142,14 @@ class TestManagedEntries < Test::Unit::TestCase
 
       assert_nothing_raised do
         ManagedZipContainer.create(filename, $mimetype) do |c|
-          assert_raises(ZipContainer::MalformedZipContainerError) do
+          assert_raises(ZipContainer::MalformedContainerError) do
             c.verify!
           end
         end
       end
 
       refute(ManagedZipContainer.verify(filename))
-      assert_raises(ZipContainer::MalformedZipContainerError) do
+      assert_raises(ZipContainer::MalformedContainerError) do
         ManagedZipContainer.verify!(filename)
       end
     end
@@ -171,7 +171,7 @@ class TestManagedEntries < Test::Unit::TestCase
       end
 
       assert(ManagedZipContainer.verify(filename))
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError) do
         ManagedZipContainer.verify!(filename)
       end
     end
@@ -198,7 +198,7 @@ class TestManagedEntries < Test::Unit::TestCase
 
       assert_nothing_raised do
         ExampleZipContainer2.create(filename) do |c|
-          assert_raises(ZipContainer::MalformedZipContainerError) do
+          assert_raises(ZipContainer::MalformedContainerError) do
             c.verify!
           end
 
@@ -206,7 +206,7 @@ class TestManagedEntries < Test::Unit::TestCase
             f.puts "Goodbye!"
           end
 
-          assert_raises(ZipContainer::MalformedZipContainerError) do
+          assert_raises(ZipContainer::MalformedContainerError) do
             c.verify!
           end
 
@@ -214,14 +214,14 @@ class TestManagedEntries < Test::Unit::TestCase
             f.puts "Hello, Y'All!"
           end
 
-          assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+          assert_nothing_raised(ZipContainer::MalformedContainerError) do
             c.verify!
           end
         end
       end
 
       assert(ExampleZipContainer2.verify(filename))
-      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError) do
         ExampleZipContainer2.verify!(filename)
       end
     end

data/test/tc_read.rb

@@ -46,7 +46,7 @@ class TestRead < Test::Unit::TestCase
 
   # Check that the empty container file does verify.
   def test_verify_empty_container
-    assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
       ZipContainer::Container.verify!($empty)
     end
 
@@ -55,7 +55,7 @@ class TestRead < Test::Unit::TestCase
 
   # Check that the empty zip file does not verify.
   def test_verify_empty_zip
-    assert_raise(ZipContainer::MalformedZipContainerError) do
+    assert_raise(ZipContainer::MalformedContainerError) do
       ZipContainer::Container.verify!($empty_zip)
     end
 
@@ -64,7 +64,7 @@ class TestRead < Test::Unit::TestCase
 
   # Check that a compressed mimetype file is detected.
   def test_verify_compressed_mimetype
-    assert_raise(ZipContainer::MalformedZipContainerError) do
+    assert_raise(ZipContainer::MalformedContainerError) do
       ZipContainer::Container.verify!($compressed_mimetype)
     end
 
@@ -83,7 +83,7 @@ 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::MalformedZipContainerError, Zip::ZipError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
       ZipContainer::Container.open($example) do |c|
         assert(c.on_disk?)
         refute(c.in_memory?)

data/test/tc_reserved_names.rb

@@ -58,7 +58,7 @@ class TestReservedNames < Test::Unit::TestCase
   def test_verify_reserved_name
     assert(NewZipContainer.verify($example))
 
-    assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
       NewZipContainer.verify!($example)
     end
   end

data/version.yml

@@ -1,4 +1,4 @@
 ---
   :major: 0
-  :minor: 8
+  :minor: 9
   :patch: 0

data/zip-container.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "zip-container"
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Haines"]
-  s.date = "2013-06-26"
+  s.date = "2013-06-27"
   s.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."
   s.email = ["support@mygrid.org.uk"]
   s.extra_rdoc_files = [
@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
     "Licence.rdoc",
     "Rakefile",
     "ReadMe.rdoc",
-    "examples/create-zip-container.rb",
-    "examples/verify-zip-container.rb",
+    "examples/create-zip-container",
+    "examples/verify-zip-container",
     "examples/zip-container-info",
     "lib/zip-container.rb",
     "lib/zip-container/container.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,8 +91,8 @@ files:
 - Licence.rdoc
 - Rakefile
 - ReadMe.rdoc
-- examples/create-zip-container.rb
-- examples/verify-zip-container.rb
+- examples/create-zip-container
+- examples/verify-zip-container
 - examples/zip-container-info
 - lib/zip-container.rb
 - lib/zip-container/container.rb