ucf 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTZhODA5Mzk1MDg1NWRlNzI4ZDk1M2IzZTEyNjAyNjVlNjYyYzNiZg==
+    ZTcxNDgzZjJjNmQ1ZTg2ZmE5OTdhMGE2M2Y1YmVlZTdhNzc2MmVkMg==
   data.tar.gz: !binary |-
-    YzBlMWZkNmI5M2M1MzgzOTAzYTYxYTBmOTZhZjZkNmYwOGExNTdjOA==
+    Zjc0YjZkMmVmYTU4NzAwMDA5NzNhNzQ2ZmRmNjEyNjAyOTg4MmZlNQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDc2YTAxOGUwMTc2N2ZhZTg2ZjJjNzUxMjJmNWJjOGJhOTJhZTRkMDFjY2M2
-    YjExZTIwMzIyZThhMjY5NmExYjE5MmYzMWIxNzZjYWFhN2YwMGVlNWM1NWQ3
-    YmNlOTAyMTUwNmQ4MjNjY2NlOWVkYzFlZDdhZTI0MTE2YmZhMDM=
+    YzNiM2ViNGEwZWJjZmMyN2JjM2I1NjZlMWU1ZjY0OWFhNjMzODM5ZWJiNTU5
+    ZGVhMTU0M2FiNWZjMzhiYzE0OGYzMTU2NTY1ZTEzNjA3MzI2YmVhOTgzNmUy
+    YjVjNGQxZTJhM2NiYjU2YmRlNTU4Y2Q0ZDQ2YTUzOTc1OGIzNWE=
   data.tar.gz: !binary |-
-    ZGNlZmI1ZTBlNjNkMWZmOTEyYzFlNWUzZGFiZDU2NmJhMjFkMDdlMGM1NmY4
-    YzQzMjI1NjA3MzFhYjk1Njc3Yjg4MDA3NGQyYTAyMDQ5OWU4OTkyMjRlOTY1
-    ZTY3MDUyOWM2ZDI3ZTNjNjkxYjllZmIyM2E4Y2Q5YzU5YmU4MmY=
+    ZTExMjM0OGYyNWJhZGE2OWM4MDg4ZjMzMzAyM2I0N2YzMTNiMmI1NDkxZWFj
+    OWFlNjA0M2YyMjY0YTVmY2ZlOWM0MTQ5YTkxMGM0OGIwNzNmMTg4ODI4YmI1
+    NTcyYWZjY2E0NjM5NjUyZmFhMzAxNGRiOGNlOWUzMjU1ZmNjOWU=

data/.ruby-env

@@ -0,0 +1 @@
+RUBYLIB=./lib:../lib

data/.travis.yml

@@ -1,10 +1,16 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.5
   - ruby-head
   - rbx-2
+
+sudo: false
+
+cache: bundler
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/Changes.rdoc

@@ -1,5 +1,15 @@
 = Changes log for the UCF Ruby Gem
 
+== Version 1.1.0
+
+* Tidy up gemspec and update dependency versions.
+* Add test-unit to the deps so we can test in ruby 2.2.
+* Setup gem caching for Travis.
+* Test using ruby 2.1.5 in Travis.
+* Disambiguate the create and read test names.
+* Update zip-container dependency to 2.2.
+* Add the UCF::Dir class to create exploded containers.
+
 == Version 1.0.0
 
 * Rename UCF::Container to UCF::File.

data/ReadMe.rdoc

@@ -19,12 +19,6 @@ This is a Ruby library for working with UCF documents. See
 for more details. UCF is a type of EPUB and very similar to the
 {EPUB Open Container Format (OCF)}[http://www.idpf.org/epub/30/spec/epub30-ocf.html].
 
-<b>This library is a work in progress!</b> Until we release version 1.0.0 you
-can expect the API to change in incompatible ways, although we will try to
-keep this to an absolute minimum. Once version 1.0.0 is released we will be
-following the principles of {Semantic Versioning}[http://semver.org/] for our
-version numbering scheme.
-
 Most of this library's API is provided by the underlying
 {zip-container gem}[https://rubygems.org/gems/zip-container] so you will need
 to consult
@@ -34,6 +28,9 @@ addition to this.
 There are some examples of how to use the library provided in the examples
 directory. See the contents of the tests directory for even more.
 
+We follow the principles of {Semantic Versioning}[http://semver.org/] for our
+releases.
+
 == Files in the META-INF directory
 
 The UCF specification requires that files in the META-INF directory are

data/lib/ucf.rb

@@ -37,6 +37,7 @@ require 'zip-container'
 
 require 'ucf/version'
 require 'ucf/meta-inf'
+require 'ucf/dir'
 require 'ucf/file'
 
 # This is a ruby library to read and write UCF files in PK Zip format. See the

data/lib/ucf/dir.rb

@@ -0,0 +1,83 @@
+# 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
+
+#
+module UCF
+
+  # This class represents a UCF document - also known as an EPUB and very
+  # similar to the
+  # {EPUB Open Container Format (OCF)}[http://www.idpf.org/epub/30/spec/epub30-ocf.html].
+  # See the
+  # {UCF specification}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
+  # for more details.
+  #
+  # This class is a specialization of ZipContainer::Dir so you should see the
+  # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
+  # for much more information and a list of all the other methods available in
+  # this class. RDoc does not list inherited methods, unfortunately.
+  #
+  # There are code examples available with the source code of this library.
+  class Dir < ZipContainer::Dir
+
+    private_class_method :new
+
+    # :stopdoc:
+    DEFAULT_MIMETYPE = "application/epub+zip"
+
+    def initialize(filename)
+      super(filename)
+
+      # Initialize the managed entries and register the META-INF directory.
+      initialize_managed_entries(MetaInf.new)
+    end
+    # :startdoc:
+
+    # :call-seq:
+    #   create(filename) -> UCF::Dir
+    #   create(filename, mimetype) -> UCF::Dir
+    #   create(filename) {|ucf| ...}
+    #   create(filename, mimetype) {|ucf| ...}
+    #
+    # Create a new UCF document directory on disk and open it for editing. A
+    # custom mimetype for the container may be specified but if not the
+    # default, "application/epub+zip", will be used.
+    #
+    # Please see the
+    # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
+    # for much more information and a list of all the other methods available
+    # in this class. RDoc does not list inherited methods, unfortunately.
+    def self.create(filename, mimetype = DEFAULT_MIMETYPE, &block)
+      super(filename, mimetype, &block)
+    end
+
+  end
+end

data/test/data/dirs/empty/mimetype

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

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/data/dirs/null/.gitkeep

@@ -0,0 +1 @@
+This dir should be "empty", which in this case just means no "mimetype" file.

data/test/{tc_create.rb → tc_create_file.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.
 #
@@ -34,7 +34,7 @@ require 'test/unit'
 require 'tmpdir'
 require 'ucf'
 
-class TestCreation < Test::Unit::TestCase
+class TestCreateFile < Test::Unit::TestCase
 
   # Check creation of standard empty ucf files.
   def test_create_standard_file
@@ -46,13 +46,7 @@ class TestCreation < Test::Unit::TestCase
           assert(c.on_disk?)
           refute(c.in_memory?)
 
-          # At this point we can still use the version of zip-container that
-          # uses the old version of the rubyzip API...
-          if Gem.loaded_specs["zip-container"].version < Gem::Version.create("1.0")
-            assert(c.find_entry("mimetype").localHeaderOffset == 0)
-          else
-            assert(c.find_entry("mimetype").local_header_offset == 0)
-          end
+          assert(c.find_entry("mimetype").local_header_offset == 0)
         end
       end
 
@@ -74,13 +68,7 @@ class TestCreation < Test::Unit::TestCase
           assert(c.on_disk?)
           refute(c.in_memory?)
 
-          # At this point we can still use the version of zip-container that
-          # uses the old version of the rubyzip API...
-          if Gem.loaded_specs["zip-container"].version < Gem::Version.create("1.0")
-            assert(c.find_entry("mimetype").localHeaderOffset == 0)
-          else
-            assert(c.find_entry("mimetype").local_header_offset == 0)
-          end
+          assert(c.find_entry("mimetype").local_header_offset == 0)
 
           assert_equal mimetype, c.read("mimetype")
         end

data/test/tc_managed_entries.rb

@@ -79,6 +79,21 @@ class ExampleUCF2 < UCF::File
 
 end
 
+class ExampleUCFDir < UCF::Dir
+
+  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",
+       :required => true, :validation_proc => valid))
+  end
+
+end
+
 class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example UCF document does not validate as a ManagedUCF.
@@ -108,6 +123,15 @@ class TestManagedEntries < Test::Unit::TestCase
     end
   end
 
+  # Check that the example UCF directory validates.
+  def test_pass_verification_dir
+    assert(ExampleUCFDir.verify($dir_mngd))
+
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
+      ExampleUCFDir.verify!($dir_mngd)
+    end
+  end
+
   # Check that a standard UCF Container can be created and things within it
   # are verified correctly.
   def test_create_standard_container

data/test/tc_read_dir.rb

@@ -0,0 +1,56 @@
+# 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 'ucf'
+
+class TestReadDir < Test::Unit::TestCase
+
+  # Check that the empty directory does not verify.
+  def test_verify_empty_directory
+    assert_raise(ZipContainer::MalformedContainerError) do
+      UCF::Dir.verify!($dir_null)
+    end
+
+    refute(UCF::Dir.verify($dir_null))
+  end
+
+  # Check that the empty container directory does verify.
+  def test_verify_empty_container
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
+      UCF::Dir.verify!($dir_empty)
+    end
+
+    assert(UCF::Dir.verify($dir_empty))
+  end
+
+end

data/test/{tc_read.rb → tc_read_file.rb}

@@ -33,7 +33,7 @@
 require 'test/unit'
 require 'ucf'
 
-class TestRead < Test::Unit::TestCase
+class TestReadFile < Test::Unit::TestCase
 
   # Check that the null file does not verify.
   def test_verify_null_file

data/test/ts_ucf.rb

@@ -33,7 +33,10 @@
 require "coveralls"
 Coveralls.wear!
 
-# Example data files.
+# Example data files and directories.
+$dir_null  = "test/data/dirs/null"
+$dir_empty = "test/data/dirs/empty"
+$dir_mngd  = "test/data/dirs/managed"
 $file_null = "test/data/null.file"
 $ucf_empty = "test/data/empty.ucf"
 $zip_empty = "test/data/empty.zip"
@@ -42,7 +45,8 @@ $ucf_example = "test/data/example.ucf"
 $meta_inf_dir = "test/data/META-INF"
 
 # Run test cases.
-require 'tc_create'
-require 'tc_read'
+require 'tc_create_file'
+require 'tc_read_dir'
+require 'tc_read_file'
 require 'tc_reserved_names'
 require 'tc_managed_entries'

data/ucf.gemspec

@@ -35,13 +35,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ucf/version"
 
 Gem::Specification.new do |s|
-  s.name = "ucf"
-  s.version = UCF::Version::STRING
-  s.authors = ["Robert Haines"]
-  s.email = ["support@mygrid.org.uk"]
-  s.homepage = "http://mygrid.github.io/ruby-ucf/"
-  s.platform         = Gem::Platform::RUBY
-  s.summary = "Universal Container Format (UCF) Ruby Library"
+  s.name        = "ucf"
+  s.version     = UCF::Version::STRING
+  s.authors     = ["Robert Haines"]
+  s.email       = ["support@mygrid.org.uk"]
+  s.homepage    = "http://mygrid.github.io/ruby-ucf/"
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Universal Container Format (UCF) Ruby Library"
   s.description = "A Ruby library for working with Universal Container "\
     "Format files - a type of EPUB document. See the UCF specification "\
     "(https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format) "\
@@ -54,12 +54,13 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- test/*`.split($/)
   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.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_development_dependency("nokogiri", "~> 1.6")
-  s.add_runtime_dependency("zip-container", "~> 2.0")
+  s.add_development_dependency "rake", "~> 10.4"
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rdoc", "~> 4.1"
+  s.add_development_dependency "test-unit", "~> 3.0"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "nokogiri", "~> 1.6"
+  s.add_runtime_dependency "zip-container", "~> 2.2"
 end

data/version.yml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ucf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 description: A Ruby library for working with Universal Container Format files - a
   type of EPUB document. See the UCF specification (https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format)
   for details. They are very similar, although not as restrictive, as the EPUB Open
@@ -108,6 +122,7 @@ extra_rdoc_files:
 - ReadMe.rdoc
 files:
 - .gitignore
+- .ruby-env
 - .ruby-gemset
 - .ruby-version
 - .travis.yml
@@ -120,6 +135,7 @@ files:
 - examples/ucfinfo
 - examples/verify-ucf
 - lib/ucf.rb
+- lib/ucf/dir.rb
 - lib/ucf/file.rb
 - lib/ucf/meta-inf.rb
 - lib/ucf/schema/OpenDocument-manifest-schema-v1.0-os.rng
@@ -128,13 +144,18 @@ files:
 - test/data/META-INF/container.xml
 - test/data/META-INF/manifest.xml
 - test/data/compressed_mimetype.ucf
+- test/data/dirs/empty/mimetype
+- test/data/dirs/managed/greeting.txt
+- test/data/dirs/managed/mimetype
+- test/data/dirs/null/.gitkeep
 - test/data/empty.ucf
 - test/data/empty.zip
 - test/data/example.ucf
 - test/data/null.file
-- test/tc_create.rb
+- test/tc_create_file.rb
 - test/tc_managed_entries.rb
-- test/tc_read.rb
+- test/tc_read_dir.rb
+- test/tc_read_file.rb
 - test/tc_reserved_names.rb
 - test/ts_ucf.rb
 - ucf.gemspec
@@ -170,12 +191,17 @@ test_files:
 - test/data/META-INF/container.xml
 - test/data/META-INF/manifest.xml
 - test/data/compressed_mimetype.ucf
+- test/data/dirs/empty/mimetype
+- test/data/dirs/managed/greeting.txt
+- test/data/dirs/managed/mimetype
+- test/data/dirs/null/.gitkeep
 - test/data/empty.ucf
 - test/data/empty.zip
 - test/data/example.ucf
 - test/data/null.file
-- test/tc_create.rb
+- test/tc_create_file.rb
 - test/tc_managed_entries.rb
-- test/tc_read.rb
+- test/tc_read_dir.rb
+- test/tc_read_file.rb
 - test/tc_reserved_names.rb
 - test/ts_ucf.rb