zip-container 0.8.0

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

@@ -0,0 +1,88 @@
+# Copyright (c) 2013 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 'zip/zip_entry'
+
+module ZipContainer
+
+  # This module provides support for reserved names.
+  module ReservedNames
+
+    # :call-seq:
+    #   reserved_names -> Array
+    #
+    # Return a list of reserved file and directory names for this ZipContainer
+    # file.
+    #
+    # Reserved files and directories must be accessed directly by methods
+    # within Container (or subclasses of Container). This is because they are
+    # fundamental to the format and might need to exhibit certain properties
+    # (such as no compression) that must be preserved. The "mimetype" file is
+    # an example of such a reserved entry.
+    #
+    # To add a reserved name to a subclass of Container simply add it to the
+    # list in the constructor (you must call the super constructor first!):
+    #
+    #  class MyContainer < ZipContainer::Container
+    #    def initialize(filename)
+    #      super(filename)
+    #
+    #      register_reserved_name("my_reserved_name")
+    #    end
+    #  end
+    def reserved_names
+      @reserved_names ||= []
+    end
+
+    # :call-seq:
+    #   reserved_entry?(entry) -> boolean
+    #
+    # Is the given entry in the reserved list of names? A String or a
+    # Zip::ZipEntry object can be passed in here.
+    def reserved_entry?(entry)
+      name = entry.kind_of?(::Zip::ZipEntry) ? entry.name : entry
+      name.chop! if name.end_with? "/"
+      reserved_names.map { |n| n.downcase }.include? name.downcase
+    end
+
+    protected
+
+    # :call-seq:
+    #   register_reserved_name(name)
+    #
+    # Add a reserved name to the list.
+    def register_reserved_name(name)
+      @reserved_names ||= []
+      @reserved_names << name unless @reserved_names.include? name
+    end
+  end
+end

data/lib/zip-container/exceptions.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2013 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
+
+#
+module ZipContainer
+
+  # The base class of all other exceptions raised by this library.
+  class ZipContainerError < RuntimeError
+  end
+
+  # This exception is raised when a bad ZipContainer is detected.
+  class MalformedZipContainerError < ZipContainerError
+
+    # :call-seq:
+    #   new(reason = "")
+    #
+    # Create a new MalformedZipContainerError with an optional reason for why
+    # the ZipContainer file is malformed.
+    def initialize(reason = nil)
+      if reason.nil?
+        super("Malformed ZipContainer File.")
+      else
+        super("Malformed ZipContainer File: #{reason}")
+      end
+    end
+  end
+
+  # This exception is raised when a clash occurs with a reserved or managed
+  # name.
+  class ReservedNameClashError < ZipContainerError
+
+    # :call-seq:
+    #   new(name)
+    #
+    # Create a new ReservedNameClashError with the name of the clash supplied.
+    def initialize(name)
+      super("'#{name}' is reserved for internal use in this ZipContainer file.")
+    end
+  end
+
+end

data/test/tc_create.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2013 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 'tmpdir'
+require 'zip-container'
+
+class TestCreation < Test::Unit::TestCase
+
+  # Check creation of standard empty container files.
+  def test_create_standard_file
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ZipContainer::Container.create(filename, $mimetype) do |c|
+          assert(c.on_disk?)
+          refute(c.in_memory?)
+
+          assert(c.find_entry("mimetype").localHeaderOffset == 0)
+        end
+      end
+
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+        ZipContainer::Container.verify!(filename)
+      end
+    end
+  end
+
+  # Check creation of empty container files with a different mimetype.
+  def test_create_mimetype_file
+    mimetype = "application/x-something-really-odd"
+
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ZipContainer::Container.create(filename, mimetype) do |c|
+          assert(c.on_disk?)
+          refute(c.in_memory?)
+
+          assert(c.find_entry("mimetype").localHeaderOffset == 0)
+        end
+      end
+
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+        ZipContainer::Container.verify!(filename)
+      end
+    end
+  end
+
+  # Check creation of stuff in container files. Check the commit status a few
+  # times to ensure that what we expect to happen, happens.
+  def test_create_contents_file
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ZipContainer::Container.create(filename, $mimetype) do |c|
+          assert(c.on_disk?)
+          refute(c.in_memory?)
+
+          c.file.open("test.txt", "w") do |f|
+            f.print "testing"
+          end
+
+          assert(c.commit_required?)
+          assert(c.commit)
+          refute(c.commit_required?)
+          refute(c.commit)
+
+          c.dir.mkdir("dir1")
+          c.mkdir("dir2")
+
+          assert(c.commit_required?)
+          assert(c.commit)
+          refute(c.commit_required?)
+          refute(c.commit)
+
+          c.comment = "A comment!"
+
+          assert(c.commit_required?)
+          assert(c.commit)
+          refute(c.commit_required?)
+          refute(c.commit)
+        end
+      end
+
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError, Zip::ZipError) do
+        ZipContainer::Container.open(filename) do |c|
+          assert(c.on_disk?)
+          refute(c.in_memory?)
+
+          assert(c.file.exists?("test.txt"))
+          assert(c.file.exists?("dir1"))
+          assert(c.file.exists?("dir2"))
+          refute(c.file.exists?("dir3"))
+
+          text = c.file.read("test.txt")
+          assert_equal("testing", text)
+
+          assert_equal("A comment!", c.comment)
+
+          refute(c.commit_required?)
+          refute(c.commit)
+        end
+      end
+    end
+  end
+
+end

data/test/tc_managed_entries.rb

@@ -0,0 +1,230 @@
+# Copyright (c) 2013 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 'tmpdir'
+require 'zip-container'
+
+# Classes to test managed entries.
+class ManagedZipContainer < ZipContainer::Container
+
+  private_class_method :new
+
+  def initialize(filename)
+    super(filename)
+    register_managed_entry(ZipContainer::ManagedDirectory.new("src", true))
+    register_managed_entry(ZipContainer::ManagedDirectory.new("test"))
+    register_managed_entry(ZipContainer::ManagedDirectory.new("lib"))
+    register_managed_entry(ZipContainer::ManagedFile.new("index.html", true))
+  end
+
+end
+
+class ExampleZipContainer < ZipContainer::Container
+
+  private_class_method :new
+
+  def initialize(filename)
+    super(filename)
+    register_managed_entry(ZipContainer::ManagedDirectory.new("dir", true))
+    register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt", true))
+  end
+
+end
+
+class ExampleZipContainer2 < ZipContainer::Container
+
+  private_class_method :new
+
+  def initialize(filename)
+    super(filename)
+
+    valid = Proc.new { |contents| contents.match(/[Hh]ello/) }
+    register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt",
+      true, valid))
+  end
+
+  def ExampleZipContainer2.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
+  # ManagedZipContainer.
+  def test_fail_verification
+    refute(ManagedZipContainer.verify($example))
+
+    assert_raises(ZipContainer::MalformedZipContainerError) do
+      ManagedZipContainer.verify!($example)
+    end
+  end
+
+  # Check that the example ZipContainer file does validate as an
+  # ExampleZipContainer.
+  def test_pass_verification
+    assert(ExampleZipContainer.verify($example))
+
+    assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+      ExampleZipContainer.verify!($example)
+    end
+  end
+
+  # Check that the example ZipContainer file does validate as an
+  # ExampleZipContainer2.
+  def test_pass_verification_2
+    assert(ExampleZipContainer2.verify($example))
+
+    assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+      ExampleZipContainer2.verify!($example)
+    end
+  end
+
+  # Check that a standard Container can be created
+  def test_create_standard_container
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ZipContainer::Container.create(filename, $mimetype) do |c|
+          c.mkdir("META-INF")
+          assert(c.file.exists?("META-INF"))
+
+          c.file.open("META-INF/container.xml", "w") do |f|
+            f.puts "<?xml version=\"1.0\"?>"
+          end
+          assert(c.file.exists?("META-INF/container.xml"))
+        end
+      end
+
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+        ZipContainer::Container.verify!(filename)
+      end
+    end
+  end
+
+  # Check that a ManagedZipContainer does not verify immediately after
+  # creation.
+  def test_create_bad_subclassed_container
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ManagedZipContainer.create(filename, $mimetype) do |c|
+          assert_raises(ZipContainer::MalformedZipContainerError) do
+            c.verify!
+          end
+        end
+      end
+
+      refute(ManagedZipContainer.verify(filename))
+      assert_raises(ZipContainer::MalformedZipContainerError) do
+        ManagedZipContainer.verify!(filename)
+      end
+    end
+  end
+
+  # Check that a ManagedZipContainer does verify when required objects are
+  # added.
+  def test_create_subclassed_container
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ManagedZipContainer.create(filename, $mimetype) do |c|
+          c.dir.mkdir("src")
+          c.file.open("index.html", "w") do |f|
+            f.puts "<html />"
+          end
+        end
+      end
+
+      assert(ManagedZipContainer.verify(filename))
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+        ManagedZipContainer.verify!(filename)
+      end
+    end
+  end
+
+  def test_create_subclassed_mimetype
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ExampleZipContainer2.create(filename) do |c|
+          assert(c.file.exists?("mimetype"))
+          assert_equal("application/example+zip", c.file.read("mimetype"))
+        end
+      end
+    end
+  end
+
+  # Check that a ExampleZipContainer2 will only verify when required objects
+  # are added with the correct contents.
+  def test_create_subclassed_container_with_content_verification
+    Dir.mktmpdir do |dir|
+      filename = File.join(dir, "test.container")
+
+      assert_nothing_raised do
+        ExampleZipContainer2.create(filename) do |c|
+          assert_raises(ZipContainer::MalformedZipContainerError) do
+            c.verify!
+          end
+
+          c.file.open("greeting.txt", "w") do |f|
+            f.puts "Goodbye!"
+          end
+
+          assert_raises(ZipContainer::MalformedZipContainerError) do
+            c.verify!
+          end
+
+          c.file.open("greeting.txt", "w") do |f|
+            f.puts "Hello, Y'All!"
+          end
+
+          assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+            c.verify!
+          end
+        end
+      end
+
+      assert(ExampleZipContainer2.verify(filename))
+      assert_nothing_raised(ZipContainer::MalformedZipContainerError) do
+        ExampleZipContainer2.verify!(filename)
+      end
+    end
+  end
+
+end