zip-container 4.0.2 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840b4e7e6338a773a393a94e42f87c7bff876ab520e0361e3378ac11fd8e4741
-  data.tar.gz: c441f69cb0988145551c09f837dc0d9a287c55452b1737ec4a43bf3740939ce8
+  metadata.gz: e3202589c6171c22a5a5ada78a4288c54b26df4af389370057ea91ad4cc67de9
+  data.tar.gz: 5e89d3760a90c36cf7ce9d18a9065bf6194eddfe8b07b4604b20362155d158a7
 SHA512:
-  metadata.gz: ebe9848aaa420c00e28ed4223d43ca1e186b1905ac6e3102b1ee7661f8edee5e07a68960577651d5206aa98530ea253590e9b25618b2f0aca2655bac98954b23
-  data.tar.gz: fec65830abe5391d805cfa2c3a417cfcc52cb47f1c99e5affebfb91b6262d3cd3292a39f4af5eea689cee4f4ff91568db0a797ee7dd706874e011b1e7798b297
+  metadata.gz: 271646c409d64c6b6286f79c00fae83ff354025d475f90f362365b6d862e204113a23f75a01d5a28e87ffc0938870af95c3868a013abee80bb5b79bf3957e5d2
+  data.tar.gz: 6cfb0c5f7a97f9b19a6f5e88c53de07dacbbe2facd1144b530c337e4eb360468cb2b8198d59850637974de9de37388d9d013a76df4f6661ae8f9fc22e075182f

data/{Changes.rdoc → CHANGES.md}

@@ -1,14 +1,48 @@
-= Changes log for the ZIP Container Ruby Gem
+# Changes log for the ZIP Container Ruby Gem
 
-== Version 3.0.2
+## Version 5.0.0
+
+* Fix warnings about uninitialized instance variables.
+* Set ManagedEntries#all_managed_entries to private.
+* Add a code of conduct.
+* Add contributing guidelines.
+* Move to README.md (and update).
+* Update minimum ruby version required to 2.7.
+* Update RubyZip version to v2.4.
+
+### Internal/tooling:
+
+* Update Rake version.
+* Update and add metadata in the gemspec.
+* Just use a constant for the gem version string.
+* Add a script to start IRB with ZipContainer loaded.
+* Switch from Coveralls to Simplecov.
+* Switch to use minitest for unit tests.
+* Switch from Travis CI to GitHub Actions.
+* Update Rubocop.
+* Skip certain tests in non-POSIX environments.
+* Fix managed directory test on Windows.
+
+## Version 4.0.2
+
+* Bump rubyzip version again.
+
+## Version 4.0.1
+
+* Don't package test files in the gem.
+* Add rubocop configuration.
+* Configure and fix many rubocop issues.
+* Updated rubyzip to fix vulnerability.
+
+## Version 3.0.2
 
 * Update rubyzip dependency to fix security vulnerability.
 
-== Version 3.0.1
+## Version 3.0.1
 
 * Fix deep content verification bug.
 
-== Version 3.0.0
+## Version 3.0.0
 
 * Refactor the malformed container error constructor.
 * Verifying entries only raises errors at the last moment.
@@ -22,7 +56,7 @@
 * Add a compatibility note about ContainerError.
 * Improve the Usage information in the ReadMe.
 
-== Version 2.2.0
+## Version 2.2.0
 
 * Fix pathname bug in ZipContainer::Dir.
 * Fixup docs to refer to containers rather than documents.
@@ -30,7 +64,7 @@
 * Add an internal compatibility method Dir#entries.
 * Add a compatibility method Dir#read.
 
-== Version 2.1.0
+## Version 2.1.0
 
 * Set up the Container superclass.
 * Open the container from the superclass.
@@ -47,7 +81,7 @@
 * Update dependencies.
 * Disambiguate the two test classes for File and Dir.
 
-== Version 2.0.0
+## Version 2.0.0
 
 * Change API: Container => File.
 * Refactor exceptions so we can shadow rubyzip exceptions.
@@ -70,25 +104,25 @@
 * Document removal of ZipContainer::Container in the ReadMe.
 * Update rubyzip version to latest (1.1.6).
 
-== Version 1.1.0
+## Version 1.1.0
 
 * Bump version of rubyzip to 1.1.4.
 
-== Version 1.0.0
+## Version 1.0.0
 
 * Update to use version 1.0.0 of rubyzip.
 
-== Version 0.9.0
+## Version 0.9.0
 
 * Generalize the Container Error class names.
 * Polish example scripts.
 
-== Version 0.8.0
+## Version 0.8.0
 
 * Abstract out all the underlying zip functionality and turn this library
   into a basic ZIP Container provider.
 
-== Version 0.5.0
+## Version 0.5.0
 
 * Add support for managed entries in the container.
 * Verify and "optional" functionality for ManagedEntry.
@@ -99,7 +133,7 @@
 * Make file validation more flexible.
 * Fix the source of failing validation messages.
 
-== Version 0.1.0
+## Version 0.1.0
 
 * Improvements to the reserved names code to allow sub-classing.
 * Move exceptions to a new source file.
@@ -118,7 +152,7 @@
 * Separate the opening and checking of a UCF document.
 * Documentation improvements and cleanup.
 
-== Version 0.0.2
+## Version 0.0.2
 
 * Update the main ReadMe file.
 * Add support for multiple reserved names and fix checks.
@@ -128,15 +162,17 @@
 * Add an example program to list UCF contents.
 * Add a method to directly iterate over UCF entries.
 
-== Version 0.0.1
+## Version 0.0.1
 
 * Very basic UCF facilities complete (plus examples).
 * Two ways of verifying UCF files.
 * API documentation added.
 * Add tests.
 
-== About this Changes file
+## About this Changes file
 
 This file is, at least in part, generated by the following command:
 
- $ git log --pretty=format:"* %s" --reverse --no-merges <commit-hash>..
+```shell
+$ git log --pretty=format:"* %s" --reverse --no-merges <commit-hash>..
+```

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rhaines@manchester.ac.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to the Ruby ZIP Container Library
+## Introduction
+
+**Thank you** for considering a contribution to the **Ruby ZIP Container Library**!
+
+**Please follow these guidelines.** Their purpose is to make both contributing and accepting contributions easier for all parties involved.
+
+There are many ways to contribute, e.g.:
+
+* Tell a friend or colleague about Ruby ZIP Container, or tweet about it
+* Write blog posts, tutorials, etc. about Ruby ZIP Container
+* Improve wording in any prose output
+* Improve automated tests, continuous integration, documentation, etc.
+
+## Ground Rules
+
+Your contribution to Ruby ZIP Container is valued, and it should be an enjoyable experience. To ensure this there is the Ruby ZIP Container
+[Code of Conduct](https://github.com/hainesr/ruby-zip-container/blob/main/CODE_OF_CONDUCT.md) which you are required to follow.
+
+Please always start any contribution that will change the contents of this repository from [an issue](https://github.com/hainesr/ruby-zip-container/issues). This may mean [creating a new issue](https://github.com/hainesr/ruby-zip-container/issues/new) if it's something that hasn't been requested so far. This way,
+
+* you can make sure that you don't invest your valuable time in something that may not be merged; and
+* we can make sure that your contribution is something that will improve Ruby ZIP Container, is in scope, and aligns with the roadmap for the Ruby ZIP Container and the Citation File Format.
+
+## Your First Contribution
+
+If you are unsure where to begin with your contribution to Ruby ZIP Container, have a look at the [open issues in this repository](https://github.com/hainesr/ruby-zip-container/issues), and see if you can identify one that you would like to work on.
+
+If you have never contributed to an open source project, you may find this tutorial helpful: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
+
+## Getting started
+
+This is the workflow for contributions to this repository:
+
+1. Take note of the [code of conduct](https://github.com/hainesr/ruby-zip-container/blob/main/CODE_OF_CONDUCT.md)
+1. [Create a new issue](https://github.com/hainesr/ruby-zip-container/issues/new) if needs be, and discuss the changes you want to make with the maintainers and community
+1. Fork the repository
+1. Create a branch in your fork of the repository
+1. Make changes in the new branch in your fork
+   * Please don't forget tests!
+   * If you add any classes, modules, methods, attributes, or constants, please document them
+1. Create a pull request
+1. Address any comments that come up during review
+1. If and when your pull request has been merged, you can delete your branch (or the whole forked repository)
+
+This workflow is loosely based on GitHub flow, and you can find more information in the [GitHub flow documentation](https://docs.github.com/en/get-started/quickstart/github-flow).
+
+### Working with tests and documentation
+
+There is a comprehensive test suite for Ruby ZIP Container, which also contains a collection of test ZIP Container files - both valid and invalid. Please add tests (and new test ZIP Container files if appropriate) for any new features you add, or bugs you squash. It is advised to run these tests locally on your computer prior to submitting a pull request. However, if that's not possible, you still can submit the pull request and later check the status of the tests for your pull request on GitHub.
+
+To run the tests, assuming that you have all the dependencies installed, simply run:
+```shell
+$ rake
+```
+
+To rebuild the documentation, if you have added to it or changed it:
+```shell
+$ rake rdoc
+```
+Then load `html/index.html` into a Web browser and double check it.
+
+## FAQ
+
+- **These guidelines do not address aspect XYZ! What should I do now?**
+
+  Please [submit an issue](https://github.com/hainesr/ruby-zip-container/issues/new), asking for clarification of and/or an addition to the guidelines.

data/Gemfile

@@ -33,3 +33,10 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# TODO: remove when JRuby 9.4.12.0 will be released and available on CI
+# Ref: https://github.com/jruby/jruby/issues/7262
+if RUBY_PLATFORM.include?('java')
+  gem 'jar-dependencies', '0.4.1'
+  gem 'ruby-maven', '3.3.13'
+end

data/{Licence.rdoc → LICENCE}

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

data/README.md

@@ -0,0 +1,41 @@
+# ZIP Container Ruby Library
+## Robert Haines
+
+A Ruby library for creating, editing and validating ZIP Container files.
+
+[![Gem Version](https://badge.fury.io/rb/zip-container.svg)](https://badge.fury.io/rb/zip-container)
+[![Tests](https://github.com/hainesr/ruby-zip-container/actions/workflows/tests.yml/badge.svg)](https://github.com/hainesr/ruby-zip-container/actions/workflows/tests.yml)
+[![Linter](https://github.com/hainesr/ruby-zip-container/actions/workflows/lint.yml/badge.svg)](https://github.com/hainesr/ruby-zip-container/actions/workflows/lint.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Maintainability](https://api.codeclimate.com/v1/badges/208195ace7c8f86e98d8/maintainability)](https://codeclimate.com/github/hainesr/ruby-zip-container/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/hainesr/ruby-zip-container/badge.svg)](https://coveralls.io/github/hainesr/ruby-zip-container)
+
+### Synopsis
+
+This is a Ruby library for working with ZIP Container files. See the [ODF](http://www.idpf.org/epub/30/spec/epub30-ocf.html) and [UCF](https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format) specifications for more details.
+
+If you are wanting to work with UCF files in particular, there is a Ruby Gem that builds on this one specifically for that. Please see:
+ * [GitHub](https://github.com/hainesr/ruby-ucf)
+ * [Rubygems](https://rubygems.org/gems/ucf)
+
+### Usage
+
+This library has two entry points.
+
+The main `ZipContainer::File` class largely mimics the rubyzip [`Zip::File`](https://www.rubydoc.info/gems/rubyzip/2.4.1/Zip/File) and [`Zip::FileSystem`](https://www.rubydoc.info/gems/rubyzip/2.4.1/Zip/FileSystem) APIs so much of what you can do with them are supported for ZIP Containers. There is also [API documentation](http://hainesr.github.io/ruby-zip-container/) with much more detail and any differences explained.
+
+The `ZipContainer::Dir` class 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 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.
+
+### Developing ZIP Container Ruby Library
+
+Please see our [Code of Conduct](https://github.com/hainesr/ruby-zip-container/blob/main/CODE_OF_CONDUCT.md) and our [contributor guidelines](https://github.com/hainesr/ruby-zip-container/blob/main/CONTRIBUTING.md).
+
+### Licence
+
+[3-Clause BSD Licence](https://opensource.org/license/bsd-3-clause). See LICENCE for details.

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2018 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -31,25 +31,22 @@
 # Author: Robert Haines
 
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'minitest/test_task'
 require 'rdoc/task'
 require 'rubocop/rake_task'
 
 task default: :test
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/ts_container.rb']
-  t.verbose = true
+Minitest::TestTask.create do |test|
+  test.test_globs = 'test/**/*_test.rb'
 end
 
 RDoc::Task.new do |r|
-  r.main = 'ReadMe.rdoc'
+  r.main = 'README.md'
   lib = Dir.glob('lib/**/*.rb')
-  r.rdoc_files.include('ReadMe.rdoc', 'Licence.rdoc', 'Changes.rdoc', lib)
-  r.options << '-t ZIP Container Format Ruby Library version ' \
-    "#{ZipContainer::Version::STRING}"
-  r.options << '-N'
+  r.rdoc_files.include('README.md', 'LICENCE', 'CHANGES.md', lib)
+  r.options << "-t ZIP Container Format Ruby Library version #{ZipContainer::VERSION}"
+  r.options << '--markup=markdown'
   r.options << '--tab-width=2'
 end
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'zip-container'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/examples/create-zip-container

@@ -64,7 +64,7 @@ begin
     # Add a explanation of this file.
     c.comment = 'This is an example Container file!'
   end
-rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => e
+  puts e
   exit 1
 end

data/examples/verify-zip-container

@@ -45,7 +45,7 @@ container_file = ARGV[0]
 
 begin
   ZipContainer::File.verify!(container_file)
-rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => e
+  puts e
   exit 1
 end

data/examples/zip-container-info

@@ -45,14 +45,14 @@ container_file = ARGV[0]
 
 begin
   container = ZipContainer::File.open(container_file)
-rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => e
+  puts e
   exit 1
 end
 
 puts "Archive: #{container}"
-puts "Container file size: #{File.size(container_file)} bytes, "\
-  "number of entries: #{container.size}"
+puts "Container file size: #{File.size(container_file)} bytes, " \
+     "number of entries: #{container.size}"
 
 total_size = 0
 total_comp = 0
@@ -66,5 +66,5 @@ container.each do |entry|
 end
 
 ratio = ((total_size - total_comp) / total_size.to_f) * 100
-puts "#{container.size} files, #{total_size} bytes uncompressed, "\
-  "#{total_comp} bytes compressed: #{ratio.round(1)}%"
+puts "#{container.size} files, #{total_size} bytes uncompressed, " \
+     "#{total_comp} bytes compressed: #{ratio.round(1)}%"

data/lib/zip-container/container.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2015 The University of Manchester, UK.
+# Copyright (c) 2014-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,14 +30,16 @@
 #
 # Author: Robert Haines
 
+require_relative 'errors'
+require_relative 'managed_entries'
+require_relative 'reserved_names'
+
 ##
 module ZipContainer
-
   # The superclass of anything that represents a Zip Container. That
   # representation could be as a Zip file (most commonly), as a directory or
   # something else.
   class Container
-
     include ReservedNames
     include ManagedEntries
 
@@ -111,9 +113,8 @@ module ZipContainer
     #   verify!(filename)
     #
     # Verify that the specified ZipContainer conforms to the specification.
-    # This method raises exceptions when errors are found or if there is
-    # something fundamental wrong with the container itself (e.g. it cannot be
-    # found).
+    # This method raises an error if there is something fundamental wrong
+    # with the container itself (e.g. it cannot be found).
     def self.verify!(filename)
       new(filename).verify!
     end
@@ -136,7 +137,7 @@ module ZipContainer
     # This method returns +false+ if there are any problems at all with the
     # container.
     def verify?
-      verify.empty? ? true : false
+      verify.empty?
     end
 
     # :call-seq:
@@ -153,5 +154,4 @@ module ZipContainer
       verify_managed_entries!
     end
   end
-
 end

data/lib/zip-container/dir.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# Copyright (c) 2014-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,10 +30,11 @@
 #
 # Author: Robert Haines
 
+require_relative 'container'
+
 require 'forwardable'
 
 module ZipContainer
-
   # This class represents a ZipContainer in directory format. See the
   # {OCF}[http://www.idpf.org/epub/30/spec/epub30-ocf.html] and
   # {UCF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
@@ -46,19 +47,12 @@ module ZipContainer
   #
   # There are code examples available with the source code of this library.
   class Dir < Container
-
     extend Forwardable
     def_delegators :@container, :close, :each, :path, :pos, :pos=, :rewind,
                    :seek, :tell
 
     private_class_method :new
 
-    # :stopdoc:
-    def initialize(location)
-      super(location)
-    end
-    # :startdoc:
-
     # :call-seq:
     #   create(pathname, mimetype) -> container
     #   create(pathname, mimetype) {|container| ...}
@@ -109,7 +103,6 @@ module ZipContainer
     end
 
     class Entries # :nodoc:
-
       include Enumerable
 
       Entry = Struct.new(:name, :ftype)
@@ -123,10 +116,8 @@ module ZipContainer
         end
       end
 
-      def each
-        @entries.each do |entry|
-          yield entry
-        end
+      def each(&block)
+        @entries.each(&block)
       end
     end
     # :startdoc:
@@ -224,5 +215,4 @@ module ZipContainer
     # Equal to
     # {::Dir.tell}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-tell]
   end
-
 end

data/lib/zip-container/{exceptions.rb → errors.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,20 +30,20 @@
 #
 # Author: Robert Haines
 
+require 'zip/errors'
+
 ##
 module ZipContainer
-
-  # The base of all exceptions raised by this library.
+  # The base of all errors raised by this library.
   module Error
   end
 
   # Shadow Zip::Error so the rubyzip API doesn't leak out.
   ZipError = ::Zip::Error
-  ZipError.send(:include, Error)
+  ZipError.include Error
 
-  # This exception is raised when a bad Container is detected.
+  # This error is raised when a bad Container is detected.
   class MalformedContainerError < RuntimeError
-
     include Error
 
     # :call-seq:
@@ -65,10 +65,9 @@ module ZipContainer
     end
   end
 
-  # This exception is raised when a clash occurs with a reserved or managed
+  # This error is raised when a clash occurs with a reserved or managed
   # name.
   class ReservedNameClashError < RuntimeError
-
     include Error
 
     # :call-seq:
@@ -79,5 +78,4 @@ module ZipContainer
       super("'#{name}' is reserved for internal use in this ZipContainer.")
     end
   end
-
 end