zip-container 0.9.0 → 1.0.0

data/Changes.rdoc

@@ -1,5 +1,9 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 1.0.0
+
+* Update to use version 1.0.0 of rubyzip.
+
 == Version 0.9.0
 
 * Generalize the Container Error class names.

data/Rakefile

@@ -65,7 +65,7 @@ Jeweler::Tasks.new do |s|
   s.add_development_dependency('rake', '~> 10.0.4')
   s.add_development_dependency('rdoc', '~> 4.0.1')
   s.add_development_dependency('jeweler', '~> 1.8.4')
-  s.add_runtime_dependency('rubyzip', '~> 0.9.9')
+  s.add_runtime_dependency('rubyzip', '~> 1.0.0')
 end
 
 Rake::TestTask.new do |t|

data/ReadMe.rdoc

@@ -7,6 +7,7 @@ Source code:: https://github.com/myGrid/ruby-zip-container
 Licence::     BSD (See Licence file or http://www.opensource.org/licenses/bsd-license.php)
 Copyright::   (c) 2013 The University of Manchester, UK
 
+{<img src="https://badge.fury.io/rb/zip-container.png" alt="Gem Version" />}[http://badge.fury.io/rb/zip-container]
 {<img src="https://codeclimate.com/github/myGrid/ruby-zip-container.png" />}[https://codeclimate.com/github/myGrid/ruby-zip-container]
 
 == Synopsis
@@ -16,11 +17,20 @@ This is a Ruby library for working with ZIP Container files. See the
 {UDF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
 specifications for more details.
 
-<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.
+== Backwards incompatibility warning!
+
+Version 1.0.0 and up of this gem uses version 1.0.0 and up of the
+{rubyzip}[https://rubygems.org/gems/rubyzip] library. This has a backwards
+incompatible API that may clash with other gems that you are using. Please see
+the {important note}[https://github.com/rubyzip/rubyzip/blob/master/README.md#important-note]
+in the rubyzip readme for a workaround.
+
+== Usage
+
+This library largely mimics the rubyzip Zip::File API so much of what you can
+do with that is supported for ZIP Containers. There is also
+{API documentation}[http://mygrid.github.io/ruby-zip-container/] with much more
+detail and any differences explained.
 
 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.
@@ -29,6 +39,4 @@ directory. See the contents of the tests directory for even more.
 
 The basic requirements of a ZIP Container are all implemented but memory
 resident ZIP Container files are not yet supported. Presently all operations
-are performed on files that are resident on disk as the underlying
-{rubyzip library}[https://github.com/aussiegeek/rubyzip] currently
-{cannot do anything else}[https://github.com/aussiegeek/rubyzip/issues/74].
+are performed on files that are resident on disk.

data/lib/zip-container/container.rb

@@ -31,7 +31,6 @@
 # Author: Robert Haines
 
 require 'forwardable'
-require 'zip/zipfilesystem'
 
 module ZipContainer
 
@@ -40,9 +39,9 @@ module ZipContainer
   # {UCF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
   # specifications for more details.
   #
-  # This class provides most of the facilities of the <tt>Zip::ZipFile</tt>
+  # This class provides most of the facilities of the <tt>Zip::File</tt>
   # class in the rubyzip gem. Please also consult the
-  # {rubyzip documentation}[http://rubydoc.info/gems/rubyzip/0.9.9/frames]
+  # {rubyzip documentation}[http://rubydoc.info/gems/rubyzip/1.1.0/frames]
   # alongside these pages.
   #
   # There are code examples available with the source code of this library.
@@ -79,9 +78,9 @@ module ZipContainer
 
       # Here we fake up the connection to the rubyzip filesystem classes so
       # that they also respect the reserved names that we define.
-      mapped_zip = ::Zip::ZipFileSystem::ZipFileNameMapper.new(self)
-      @fs_dir  = ::Zip::ZipFileSystem::ZipFsDir.new(mapped_zip)
-      @fs_file = ::Zip::ZipFileSystem::ZipFsFile.new(mapped_zip)
+      mapped_zip = ::Zip::FileSystem::ZipFileNameMapper.new(self)
+      @fs_dir  = ::Zip::FileSystem::ZipFsDir.new(mapped_zip)
+      @fs_file = ::Zip::FileSystem::ZipFsFile.new(mapped_zip)
       @fs_dir.file = @fs_file
       @fs_file.dir = @fs_dir
     end
@@ -93,8 +92,8 @@ module ZipContainer
     #
     # Create a new ZipContainer file on disk with the specified mimetype.
     def Container.create(filename, mimetype, &block)
-      ::Zip::ZipOutputStream.open(filename) do |stream|
-        stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::ZipEntry::STORED)
+      ::Zip::OutputStream.open(filename) do |stream|
+        stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::Entry::STORED)
         stream.write mimetype
       end
 
@@ -117,7 +116,7 @@ module ZipContainer
     #   Container.each_entry {|entry| ...}
     #
     # Iterate over the entries in the ZipContainer file. The entry objects
-    # returned by this method are Zip::ZipEntry objects. Please see the
+    # returned by this method are Zip::Entry objects. Please see the
     # rubyzip documentation for details.
     def Container.each_entry(filename, &block)
       c = new(filename)
@@ -351,7 +350,7 @@ module ZipContainer
     private
 
     def open_document(document)
-      ::Zip::ZipFile.new(document)
+      ::Zip::File.new(document)
     end
 
     def check_mimetype!
@@ -359,10 +358,10 @@ module ZipContainer
       entry = @zipfile.find_entry(MIMETYPE_FILE)
 
       raise MalformedContainerError.new("'mimetype' file is missing.") if entry.nil?
-      if entry.localHeaderOffset != 0
+      if entry.local_header_offset != 0
         raise MalformedContainerError.new("'mimetype' file is not at offset 0 in the archive.")
       end
-      if entry.compression_method != ::Zip::ZipEntry::STORED
+      if entry.compression_method != ::Zip::Entry::STORED
         raise MalformedContainerError.new("'mimetype' file is compressed.")
       end
 
@@ -406,16 +405,16 @@ module ZipContainer
     #   each {|entry| ...}
     #
     # Iterate over the entries in the ZipContainer file. The entry objects
-    # returned by this method are Zip::ZipEntry objects. Please see the
+    # returned by this method are Zip::Entry objects. Please see the
     # rubyzip documentation for details.
 
     ##
-    # :method:
+    # :method: entries
     # :call-seq:
     #   entries -> Enumerable
     #
     # Returns an Enumerable containing all the entries in the ZipContainer
-    # file The entry objects returned by this method are Zip::ZipEntry
+    # file The entry objects returned by this method are Zip::Entry
     # objects. Please see the rubyzip documentation for details.
 
     ##
@@ -431,7 +430,7 @@ module ZipContainer
     ##
     # :method: find_entry
     # :call-seq:
-    #   find_entry(entry) -> Zip::ZipEntry
+    #   find_entry(entry) -> Zip::Entry
     #
     # Searches for entries within the ZipContainer file with the specified
     # name. Returns +nil+ if no entry is found. See also +get_entry+.
@@ -439,7 +438,7 @@ module ZipContainer
     ##
     # :method: get_entry
     # :call-seq:
-    #   get_entry(entry) -> Zip::ZipEntry
+    #   get_entry(entry) -> Zip::Entry
     #
     # Searches for an entry within the ZipContainer file in a similar manner
     # to +find_entry+, but throws +Errno::ENOENT+ if no entry is found.
@@ -457,7 +456,7 @@ module ZipContainer
     ##
     # :method: glob
     # :call-seq:
-    #   glob(*args) -> Array of Zip::ZipEntry
+    #   glob(*args) -> Array of Zip::Entry
     #   glob(*args) {|entry| ...}
     #
     # Searches for entries within the ZipContainer file that match the given

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

@@ -30,8 +30,7 @@
 #
 # Author: Robert Haines
 
-require 'zip/zip_entry'
-
+#
 module ZipContainer
 
   # This module provides support for managed file and directory entries.
@@ -86,7 +85,7 @@ module ZipContainer
     #
     # Is the supplied entry/name a managed entry?
     def managed_entry?(entry, list = managed_entry_names)
-      name = entry.kind_of?(::Zip::ZipEntry) ? entry.name : entry
+      name = entry.kind_of?(::Zip::Entry) ? entry.name : entry
       name.chop! if name.end_with? "/"
       list.map { |n| n.downcase }.include? name.downcase
     end

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

@@ -30,8 +30,7 @@
 #
 # Author: Robert Haines
 
-require 'zip/zip_entry'
-
+#
 module ZipContainer
 
   # This module provides support for reserved names.
@@ -67,9 +66,9 @@ module ZipContainer
     #   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.
+    # Zip::Entry object can be passed in here.
     def reserved_entry?(entry)
-      name = entry.kind_of?(::Zip::ZipEntry) ? entry.name : entry
+      name = entry.kind_of?(::Zip::Entry) ? entry.name : entry
       name.chop! if name.end_with? "/"
       reserved_names.map { |n| n.downcase }.include? name.downcase
     end

data/lib/zip-container.rb

@@ -31,6 +31,8 @@
 # Author: Robert Haines
 
 require 'yaml'
+require 'zip/filesystem'
+
 require 'zip-container/exceptions'
 require 'zip-container/entries/reserved'
 require 'zip-container/entries/managed'

data/test/tc_create.rb

@@ -46,7 +46,7 @@ class TestCreation < Test::Unit::TestCase
           assert(c.on_disk?)
           refute(c.in_memory?)
 
-          assert(c.find_entry("mimetype").localHeaderOffset == 0)
+          assert(c.find_entry("mimetype").local_header_offset == 0)
         end
       end
 
@@ -68,7 +68,7 @@ class TestCreation < Test::Unit::TestCase
           assert(c.on_disk?)
           refute(c.in_memory?)
 
-          assert(c.find_entry("mimetype").localHeaderOffset == 0)
+          assert(c.find_entry("mimetype").local_header_offset == 0)
         end
       end
 

data/version.yml

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

data/zip-container.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "zip-container"
-  s.version = "0.9.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Haines"]
-  s.date = "2013-06-27"
+  s.date = "2013-12-19"
   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 = [
@@ -60,18 +60,18 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, ["~> 10.0.4"])
       s.add_development_dependency(%q<rdoc>, ["~> 4.0.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_runtime_dependency(%q<rubyzip>, ["~> 0.9.9"])
+      s.add_runtime_dependency(%q<rubyzip>, ["~> 1.0.0"])
     else
       s.add_dependency(%q<rake>, ["~> 10.0.4"])
       s.add_dependency(%q<rdoc>, ["~> 4.0.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_dependency(%q<rubyzip>, ["~> 0.9.9"])
+      s.add_dependency(%q<rubyzip>, ["~> 1.0.0"])
     end
   else
     s.add_dependency(%q<rake>, ["~> 10.0.4"])
     s.add_dependency(%q<rdoc>, ["~> 4.0.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<rubyzip>, ["~> 0.9.9"])
+    s.add_dependency(%q<rubyzip>, ["~> 1.0.0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 1.0.0
 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.