ucf 1.1.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTcxNDgzZjJjNmQ1ZTg2ZmE5OTdhMGE2M2Y1YmVlZTdhNzc2MmVkMg==
+    ZDM5YTE4OGEzZTkwYTZjZGQ0ODNlZmRmYzI1ZjFhYzdmYmNjMDBiMA==
   data.tar.gz: !binary |-
-    Zjc0YjZkMmVmYTU4NzAwMDA5NzNhNzQ2ZmRmNjEyNjAyOTg4MmZlNQ==
+    NTNiMmFkYWM3NmMxODY1MGQ2OTVlODNmZGIyYjFhNDk1YzRhYTI4Mw==
 SHA512:
   metadata.gz: !binary |-
-    YzNiM2ViNGEwZWJjZmMyN2JjM2I1NjZlMWU1ZjY0OWFhNjMzODM5ZWJiNTU5
-    ZGVhMTU0M2FiNWZjMzhiYzE0OGYzMTU2NTY1ZTEzNjA3MzI2YmVhOTgzNmUy
-    YjVjNGQxZTJhM2NiYjU2YmRlNTU4Y2Q0ZDQ2YTUzOTc1OGIzNWE=
+    MDU2YTJlZDk0MGZjYjZiNDU5OTBjOWUyOThiYWZjMjZiYTUwYTI1MjZkOTYx
+    NjJlZGNhNDZjOTU3YjRjY2M2NjI2NDIzZDlmZDM0ZjM3MDI1NDJkODI4NWY1
+    N2M0NmIyZmE3MDIxOTc5ZDY1ZTBjMWMzMTBhM2ViNTZjMjY5NmI=
   data.tar.gz: !binary |-
-    ZTExMjM0OGYyNWJhZGE2OWM4MDg4ZjMzMzAyM2I0N2YzMTNiMmI1NDkxZWFj
-    OWFlNjA0M2YyMjY0YTVmY2ZlOWM0MTQ5YTkxMGM0OGIwNzNmMTg4ODI4YmI1
-    NTcyYWZjY2E0NjM5NjUyZmFhMzAxNGRiOGNlOWUzMjU1ZmNjOWU=
+    ZDY0NjYzNTc2MzQyM2YxNTVkOGJhMDAzYzcwODIzYTg5M2VlNWM1OTM3Mjcy
+    MmQwNjUwYWE3Y2NlMmI3ODY4MjBiODQxZWIwODUzMmM4ZjJiNWM1NzAwZTg2
+    NGUyNTVmYTVlNGUwMjliODcwMTA4ODJkZmMyYTdmOWMwYmRlZmQ=

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.5
+  - 2.2.0
   - ruby-head
   - rbx-2
 

data/Changes.rdoc

@@ -1,5 +1,12 @@
 = Changes log for the UCF Ruby Gem
 
+== Version 2.0.0
+
+* Add ruby 2.2.0 to the Travis test matrix.
+* Update examples and tests to use the latest API.
+* Add some usage information to the ReadMe.
+* Update to version 3.0.1 of zip-container.
+
 == Version 1.1.0
 
 * Tidy up gemspec and update dependency versions.

data/Licence.rdoc

@@ -1,4 +1,4 @@
-Copyright (c) 2013, 2014 The University of Manchester, UK.
+Copyright (c) 2013-2015 The University of Manchester, UK.
 
 All rights reserved.
 

data/ReadMe.rdoc

@@ -5,12 +5,12 @@ Contact::     mailto:support@mygrid.org.uk
 Homepage::    http://mygrid.github.io/ruby-ucf
 Source code:: https://github.com/myGrid/ruby-ucf
 Licence::     BSD (See Licence file or http://www.opensource.org/licenses/bsd-license.php)
-Copyright::   (c) 2013, 2014 The University of Manchester, UK
+Copyright::   (c) 2013-2015 The University of Manchester, UK
 
-{<img src="https://badge.fury.io/rb/ucf.png" alt="Gem Version" />}[http://badge.fury.io/rb/ucf]
-{<img src="https://codeclimate.com/github/myGrid/ruby-ucf.png" />}[https://codeclimate.com/github/myGrid/ruby-ucf]
+{<img src="https://badge.fury.io/rb/ucf.svg" alt="Gem Version" />}[http://badge.fury.io/rb/ucf]
+{<img src="https://codeclimate.com/github/myGrid/ruby-ucf.svg" />}[https://codeclimate.com/github/myGrid/ruby-ucf]
 {<img src="https://travis-ci.org/myGrid/ruby-ucf.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/myGrid/ruby-ucf]
-{<img src="https://coveralls.io/repos/myGrid/ruby-ucf/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master]
+{<img src="https://coveralls.io/repos/myGrid/ruby-ucf/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master]
 
 == Synopsis
 
@@ -51,6 +51,25 @@ this API into closer alignment with the underlying
 
 UCF::Container is not available from version 1.0.0 onwards.
 
+== Usage
+
+This library has two entry points.
+
+The main UCF::File class is a specialization of
+{ZipContainer::File}[http://mygrid.github.io/ruby-zip-container/3.0.0/ZipContainer/File.html]
+which largely mimics the rubyzip
+{Zip::File}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/File] and
+{Zip::FileSystem}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/FileSystem]
+APIs.
+
+The UCF::Dir class is a based upon the
+{ZipContainer::Dir}[http://mygrid.github.io/ruby-zip-container/3.0.0/ZipContainer/Dir.html]
+class which mimics, where possible, the core ruby
+{Dir API}[http://ruby-doc.org/core-1.9.3/Dir.html].
+
+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.
+
 == What this library can not do yet
 
 The basic requirements of a UCF document are all implemented but there are a

data/examples/create-ucf

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -50,7 +50,7 @@ if File.exists?(ucffile)
 end
 
 begin
-  UCF::Container.create(ucffile) do |c|
+  UCF::File.create(ucffile) do |c|
 
     # Add a cheery greeting file from a string.
     c.file.open("greeting.txt", "w") do |f|
@@ -66,7 +66,7 @@ begin
     # Add a explanation of this file.
     c.comment = "This is an example UCF file!"
   end
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
   puts err.to_s
   exit 1
 end

data/examples/ucfinfo

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -45,8 +45,8 @@ usage unless ARGV.length == 1
 ucffile = ARGV[0]
 
 begin
-  ucf = UCF::Container.open(ucffile)
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+  ucf = UCF::File.open(ucffile)
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
   puts err.to_s
   exit 1
 end

data/examples/verify-ucf

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -45,8 +45,8 @@ usage unless ARGV.length == 1
 ucffile = ARGV[0]
 
 begin
-  UCF::Container.verify!(ucffile)
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+  UCF::File.verify!(ucffile)
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
   puts err.to_s
   exit 1
 end

data/test/tc_create_file.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -50,7 +50,7 @@ class TestCreateFile < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
         UCF::File.verify!(filename)
       end
     end
@@ -74,7 +74,7 @@ class TestCreateFile < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
         UCF::File.verify!(filename)
       end
     end
@@ -117,7 +117,7 @@ class TestCreateFile < Test::Unit::TestCase
         end
       end
 
-      assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
         UCF::File.open(filename) do |ucf|
           assert(ucf.on_disk?)
           refute(ucf.in_memory?)

data/test/tc_managed_entries.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -98,7 +98,7 @@ class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example UCF document does not validate as a ManagedUCF.
   def test_fail_verification
-    refute(ManagedUCF.verify($ucf_example))
+    refute(ManagedUCF.verify?($ucf_example))
 
     assert_raises(ZipContainer::MalformedContainerError) do
       ManagedUCF.verify!($ucf_example)
@@ -107,7 +107,7 @@ class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example UCF document does validate as an ExampleUCF.
   def test_pass_verification
-    assert(ExampleUCF.verify($ucf_example))
+    assert(ExampleUCF.verify?($ucf_example))
 
     assert_nothing_raised(ZipContainer::MalformedContainerError) do
       ExampleUCF.verify!($ucf_example)
@@ -116,7 +116,7 @@ class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example UCF document does validate as an ExampleUCF2.
   def test_pass_verification_2
-    assert(ExampleUCF2.verify($ucf_example))
+    assert(ExampleUCF2.verify?($ucf_example))
 
     assert_nothing_raised(ZipContainer::MalformedContainerError) do
       ExampleUCF2.verify!($ucf_example)
@@ -125,7 +125,7 @@ class TestManagedEntries < Test::Unit::TestCase
 
   # Check that the example UCF directory validates.
   def test_pass_verification_dir
-    assert(ExampleUCFDir.verify($dir_mngd))
+    assert(ExampleUCFDir.verify?($dir_mngd))
 
     assert_nothing_raised(ZipContainer::MalformedContainerError) do
       ExampleUCFDir.verify!($dir_mngd)
@@ -170,7 +170,7 @@ class TestManagedEntries < Test::Unit::TestCase
         end
       end
 
-      refute(ManagedUCF.verify(filename))
+      refute(ManagedUCF.verify?(filename))
       assert_raises(ZipContainer::MalformedContainerError) do
         ManagedUCF.verify!(filename)
       end
@@ -191,7 +191,7 @@ class TestManagedEntries < Test::Unit::TestCase
         end
       end
 
-      assert(ManagedUCF.verify(filename))
+      assert(ManagedUCF.verify?(filename))
       assert_nothing_raised(ZipContainer::MalformedContainerError) do
         ManagedUCF.verify!(filename)
       end
@@ -228,7 +228,7 @@ class TestManagedEntries < Test::Unit::TestCase
         end
       #end
 
-      assert(ExampleUCF2.verify(filename))
+      assert(ExampleUCF2.verify?(filename))
       assert_nothing_raised(ZipContainer::MalformedContainerError) do
         ExampleUCF2.verify!(filename)
       end

data/test/tc_read_dir.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# Copyright (c) 2014, 2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -41,7 +41,7 @@ class TestReadDir < Test::Unit::TestCase
       UCF::Dir.verify!($dir_null)
     end
 
-    refute(UCF::Dir.verify($dir_null))
+    refute(UCF::Dir.verify?($dir_null))
   end
 
   # Check that the empty container directory does verify.
@@ -50,7 +50,7 @@ class TestReadDir < Test::Unit::TestCase
       UCF::Dir.verify!($dir_empty)
     end
 
-    assert(UCF::Dir.verify($dir_empty))
+    assert(UCF::Dir.verify?($dir_empty))
   end
 
 end

data/test/tc_read_file.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -37,29 +37,31 @@ class TestReadFile < Test::Unit::TestCase
 
   # Check that the null file does not verify.
   def test_verify_null_file
-    assert_raise(Zip::ZipError) do
+    assert_raise(ZipContainer::Error) do
       UCF::File.verify!($file_null)
     end
 
-    refute(UCF::File.verify($file_null))
+    assert_raise(ZipContainer::Error) do
+      UCF::File.verify?($file_null)
+    end
   end
 
   # Check that the empty ucf file does verify.
   def test_verify_empty_ucf
-    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
       UCF::File.verify!($ucf_empty)
     end
 
-    assert(UCF::File.verify($ucf_empty))
+    assert(UCF::File.verify?($ucf_empty))
   end
 
   # Check that the example ucf file does verify.
   def test_verify_example_ucf
-    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
       UCF::File.verify!($ucf_example)
     end
 
-    assert(UCF::File.verify($ucf_example))
+    assert(UCF::File.verify?($ucf_example))
   end
 
   # Check that the empty zip file does not verify.
@@ -68,7 +70,7 @@ class TestReadFile < Test::Unit::TestCase
       UCF::File.verify!($zip_empty)
     end
 
-    refute(UCF::File.verify($zip_empty))
+    refute(UCF::File.verify?($zip_empty))
   end
 
   # Check that a compressed mimetype file is detected.
@@ -77,7 +79,7 @@ class TestReadFile < Test::Unit::TestCase
       UCF::File.verify!($ucf_compressed_mimetype)
     end
 
-    refute(UCF::File.verify($ucf_compressed_mimetype))
+    refute(UCF::File.verify?($ucf_compressed_mimetype))
   end
 
   # Check the raw mimetype bytes
@@ -91,7 +93,7 @@ class TestReadFile < Test::Unit::TestCase
 
   # Check reading files out of a ucf file and make sure we don't change it.
   def test_read_files_from_ucf
-    assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
+    assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
       UCF::File.open($ucf_example) do |ucf|
         assert(ucf.on_disk?)
         refute(ucf.in_memory?)

data/test/tc_reserved_names.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -54,7 +54,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that the reserved names verify correctly.
   def test_verify_reserved_name
-    assert(NewUCF.verify($ucf_example))
+    assert(NewUCF.verify?($ucf_example))
 
     assert_nothing_raised(ZipContainer::MalformedContainerError) do
       NewUCF.verify!($ucf_example)

data/ucf.gemspec

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -62,5 +62,5 @@ Gem::Specification.new do |s|
   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"
+  s.add_runtime_dependency "zip-container", "~> 3.0.1"
 end

data/version.yml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ucf
 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-12-17 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 3.0.1
 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