ucf 2.0.2 → 3.0.0

metadata

@@ -1,207 +1,232 @@
 --- !ruby/object:Gem::Specification
 name: ucf
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Robert Haines
 - Finn Bacall
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2025-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 1.18.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 1.18.9
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.11'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.50.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.30.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: zip-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '6.0'
 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
   Container Format (OCF) (http://www.idpf.org/epub/30/spec/epub30-ocf.html).
 email:
-- support@mygrid.org.uk
+- robert.haines@manchester.ac.uk
 executables: []
 extensions: []
-extra_rdoc_files:
-- Changes.rdoc
-- Licence.rdoc
-- ReadMe.rdoc
+extra_rdoc_files: []
 files:
+- ".github/workflows/latest-docs.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
-- ".ruby-env"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
-- Changes.rdoc
+- ".rubocop.yml"
+- ".simplecov"
+- CHANGES.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- Licence.rdoc
+- LICENCE
+- README.md
 - Rakefile
-- ReadMe.rdoc
+- bin/console
+- bin/setup
 - examples/create-ucf
 - examples/ucfinfo
 - examples/verify-ucf
 - lib/ucf.rb
 - lib/ucf/dir.rb
 - lib/ucf/file.rb
-- lib/ucf/meta-inf.rb
+- lib/ucf/meta_inf.rb
 - lib/ucf/schema/OpenDocument-manifest-schema-v1.0-os.rng
 - lib/ucf/schema/container.rng
 - lib/ucf/version.rb
-- 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_file.rb
-- test/tc_managed_entries.rb
-- test/tc_read_dir.rb
-- test/tc_read_file.rb
-- test/tc_reserved_names.rb
-- test/ts_ucf.rb
 - ucf.gemspec
-- version.yml
-homepage: http://mygrid.github.io/ruby-ucf/
+homepage: https://github.com/hainesr/ruby-ucf
 licenses:
 - BSD
-metadata: {}
-post_install_message: 
-rdoc_options:
-- "-N"
-- "--tab-width=2"
-- "--main=ReadMe.rdoc"
+metadata:
+  bug_tracker_uri: https://github.com/hainesr/ruby-ucf/issues
+  changelog_uri: https://github.com/hainesr/ruby-ucf/blob/v3.0.0/Changelog.md
+  documentation_uri: https://hainesr.github.io/ruby-ucf
+  source_code_uri: https://github.com/hainesr/ruby-ucf/tree/v3.0.0
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Universal Container Format (UCF) Ruby Library
-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_file.rb
-- test/tc_managed_entries.rb
-- test/tc_read_dir.rb
-- test/tc_read_file.rb
-- test/tc_reserved_names.rb
-- test/ts_ucf.rb
+test_files: []

data/.ruby-env

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

data/.ruby-gemset

@@ -1 +0,0 @@
-ucf

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.2.1

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.1
-  - ruby-head
-  - rbx-2
-
-sudo: false
-
-cache: bundler
-
-matrix:
-  allow_failures:
-    - rvm: 1.9.3
-    - rvm: ruby-head
-    - rvm: rbx-2

data/ReadMe.rdoc

@@ -1,90 +0,0 @@
-= Universal Container Format (UCF) Ruby Library
-
-Authors::     Robert Haines
-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-2015 The University of Manchester, UK
-
-{<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.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master]
-
-== Synopsis
-
-This is a Ruby library for working with UCF documents. See
-{the specification}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
-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].
-
-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
-{that documentation as well}[http://mygrid.github.io/ruby-zip-container/] in
-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
-validated against a schema if they are present. If the
-{nokogiri gem}[https://rubygems.org/gems/nokogiri] is available then this
-library will use it to validate the contents of the <tt>container.xml</tt> and
-<tt>manifest.xml</tt> files. This functionality is not enforced on the user in
-case they are not using the META-INF directory and so would not need the extra
-dependency on nokogiri.
-
-== Backwards incompatibility warning!
-
-The UCF::Container class is deprecated in favour of UCF::File. These classes
-are functionally identical; it is just a change of name. The new name brings
-this API into closer alignment with the underlying
-{zip-container API}[http://mygrid.github.io/ruby-zip-container/]
-(ZipContainer::File).
-
-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
-number of optional features that are not yet provided.
-
-* Memory resident UCF documents. Presently all operations are performed on
-  documents 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].
-* Validation of all file contents in the META-INF directory. The
-  <tt>container.xml</tt> and <tt>manifest.xml</tt> files are validated but
-  others are not yet.
-* Digital signatures (this feature has been deferred until a future revision
-  of the UCF specification. It will be supported by this gem when it is added
-  to the specification).
-* Encryption (this feature has been deferred until a future revision of the
-  UCF specification. It will be supported by this gem when it is added to the
-  specification).

data/test/data/META-INF/container.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0"?>
-<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
-  <rootfiles>
-    <rootfile full-path="OEBPS/As You Like It.opf"
-      media-type="application/oebps-package+xml" />
-    <rootfile full-path="OEBPS/As You Like It.pdf"
-      media-type="application/pdf" />
-  </rootfiles>
-  <relationships xmlns:pdf="http://ns.adobe.com/pdf/2006">
-    <relationship type="metadata" target="$path.xmp"/>
-    <relationship type="pdf:annotation" target="$path.ann"/>
-  </relationships>
-</container>

data/test/data/META-INF/manifest.xml

@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE manifest:manifest PUBLIC "-//OpenOffice.org//DTD Manifest 1.0//EN" "Manifest.dtd">
-<manifest:manifest
-  xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
- <manifest:file-entry
-  manifest:media-type="application/vnd.oasis.opendocument.text"
-  manifest:full-path="/"/>
- <manifest:file-entry
-  manifest:media-type="application/vnd.sun.xml.ui.configuration"
-  manifest:full-path="Configurations2/"/>
- <manifest:file-entry
-  manifest:media-type="" manifest:full-path="Pictures/"/>
- <manifest:file-entry
-  manifest:media-type="text/xml" manifest:full-path="content.xml"/>
- <manifest:file-entry
-  manifest:media-type="text/xml" manifest:full-path="styles.xml"/>
- <manifest:file-entry
-  manifest:media-type="text/xml" manifest:full-path="meta.xml"/>
- <manifest:file-entry
-  manifest:media-type=""
-  manifest:full-path="Thumbnails/thumbnail.png"/>
- <manifest:file-entry
-  manifest:media-type="" manifest:full-path="Thumbnails/"/>
- <manifest:file-entry
-  manifest:media-type="text/xml" manifest:full-path="settings.xml"/>
-</manifest:manifest>

data/test/data/dirs/empty/mimetype

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

data/test/data/dirs/managed/greeting.txt

@@ -1 +0,0 @@
-Hello, World!

data/test/data/dirs/managed/mimetype

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

data/test/data/dirs/null/.gitkeep

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

data/test/tc_create_file.rb

@@ -1,142 +0,0 @@
-# Copyright (c) 2013-2015 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 'ucf'
-
-class TestCreateFile < Test::Unit::TestCase
-
-  # Check creation of standard empty ucf files.
-  def test_create_standard_file
-    Dir.mktmpdir do |dir|
-      filename = File.join(dir, "test.ucf")
-
-      assert_nothing_raised do
-        UCF::File.create(filename) do |c|
-          assert(c.on_disk?)
-          refute(c.in_memory?)
-
-          assert(c.find_entry("mimetype").local_header_offset == 0)
-        end
-      end
-
-      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
-        UCF::File.verify!(filename)
-      end
-    end
-  end
-
-  # Check creation of empty ucf 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.ucf")
-
-      assert_nothing_raised do
-        UCF::File.create(filename, mimetype) do |c|
-          assert(c.on_disk?)
-          refute(c.in_memory?)
-
-          assert(c.find_entry("mimetype").local_header_offset == 0)
-
-          assert_equal mimetype, c.read("mimetype")
-        end
-      end
-
-      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
-        UCF::File.verify!(filename)
-      end
-    end
-  end
-
-  # Check creation of stuff in ucf 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.ucf")
-
-      assert_nothing_raised do
-        UCF::File.create(filename) do |ucf|
-          assert(ucf.on_disk?)
-          refute(ucf.in_memory?)
-
-          ucf.file.open("test.txt", "w") do |f|
-            f.print "testing"
-          end
-
-          assert(ucf.commit_required?)
-          assert(ucf.commit)
-          refute(ucf.commit_required?)
-          refute(ucf.commit)
-
-          ucf.dir.mkdir("dir1")
-          ucf.mkdir("dir2")
-
-          assert(ucf.commit_required?)
-          assert(ucf.commit)
-          refute(ucf.commit_required?)
-          refute(ucf.commit)
-
-          ucf.comment = "A comment!"
-
-          assert(ucf.commit_required?)
-          assert(ucf.commit)
-          refute(ucf.commit_required?)
-          refute(ucf.commit)
-        end
-      end
-
-      assert_nothing_raised(ZipContainer::MalformedContainerError, ZipContainer::Error) do
-        UCF::File.open(filename) do |ucf|
-          assert(ucf.on_disk?)
-          refute(ucf.in_memory?)
-
-          assert(ucf.file.exists?("test.txt"))
-          assert(ucf.file.exists?("dir1"))
-          assert(ucf.file.exists?("dir2"))
-          refute(ucf.file.exists?("dir3"))
-
-          text = ucf.file.read("test.txt")
-          assert_equal("testing", text)
-
-          assert_equal("A comment!", ucf.comment)
-
-          refute(ucf.commit_required?)
-          refute(ucf.commit)
-        end
-      end
-    end
-  end
-
-end