ucf 2.0.2 → 3.0.0

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ucf'
+
+# 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-ucf

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -44,29 +46,28 @@ usage unless ARGV.length == 1
 
 ucffile = ARGV[0]
 
-if File.exists?(ucffile)
+if File.exist?(ucffile)
   puts "File '#{ucffile}' already exists. Exiting."
   exit 1
 end
 
 begin
   UCF::File.create(ucffile) do |c|
-
     # Add a cheery greeting file from a string.
-    c.file.open("greeting.txt", "w") do |f|
-      f.puts "Hello, World!"
+    c.file.open('greeting.txt', 'w') do |f|
+      f.puts 'Hello, World!'
     end
 
     # Create a subdirectory.
-    c.dir.mkdir("dir")
+    c.dir.mkdir('dir')
 
     # Copy this example code in straight from a file.
-    c.add("dir/code.rb", __FILE__)
+    c.add('dir/code.rb', __FILE__)
 
     # Add a explanation of this file.
-    c.comment = "This is an example UCF file!"
+    c.comment = 'This is an example UCF file!'
   end
-rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => e
+  puts e
   exit 1
 end

data/examples/ucfinfo

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -46,12 +48,12 @@ ucffile = ARGV[0]
 
 begin
   ucf = UCF::File.open(ucffile)
-rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => e
+  puts e
   exit 1
 end
 
-puts "Archive: #{ucf.to_s}"
+puts "Archive: #{ucf}"
 puts "UCF file size: #{File.size(ucffile)} bytes, number of entries: #{ucf.size}"
 
 total_size = 0
@@ -60,11 +62,13 @@ total_comp = 0
 ucf.each do |entry|
   total_size += entry.size
   total_comp += entry.compressed_size
-  comp = entry.compression_method == 0 ? "stor" : "defN"
+  comp = entry.compression_method.zero? ? 'stor' : 'defN'
   size = entry.size.to_s.rjust(8)
   puts "#{size} #{comp} #{entry.time} #{entry.name}"
 end
 
 ratio = ((total_size - total_comp) / total_size.to_f) * 100
-puts "%d files, %d bytes uncompressed, %d bytes compressed: %.1f%%" %
-  [ucf.size, total_size, total_comp, ratio]
+puts format(
+  '%<num>d files, %<size>d bytes uncompressed, %<comp>d bytes compressed: %<ratio>.1f%%',
+  { num: ucf.size, size: total_size, comp: total_comp, ratio: ratio }
+)

data/examples/verify-ucf

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -46,7 +48,7 @@ ucffile = ARGV[0]
 
 begin
   UCF::File.verify!(ucffile)
-rescue ZipContainer::MalformedContainerError, ZipContainer::Error => err
-  puts err.to_s
+rescue ZipContainer::MalformedContainerError, ZipContainer::Error => e
+  puts e
   exit 1
 end

data/lib/ucf/dir.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2014-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,9 +32,8 @@
 #
 # 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].
@@ -41,17 +42,16 @@ module UCF
   # 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/]
+  # {ZipContainer documentation}[http://hainesr.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"
+    DEFAULT_MIMETYPE = 'application/epub+zip'
 
     def initialize(filename)
       super(filename)
@@ -72,12 +72,11 @@ module UCF
     # default, "application/epub+zip", will be used.
     #
     # Please see the
-    # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
+    # {ZipContainer documentation}[http://hainesr.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/lib/ucf/file.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,9 +32,8 @@
 #
 # Author: Robert Haines
 
-#
+##
 module UCF
-
   # This class represents a UCF document file - 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].
@@ -41,17 +42,16 @@ module UCF
   # for more details.
   #
   # This class is a specialization of ZipContainer::File so you should see the
-  # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
+  # {ZipContainer documentation}[http://hainesr.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 File < ZipContainer::File
-
     private_class_method :new
 
     # :stopdoc:
-    DEFAULT_MIMETYPE = "application/epub+zip"
+    DEFAULT_MIMETYPE = 'application/epub+zip'
 
     def initialize(filename)
       super(filename)
@@ -72,12 +72,11 @@ module UCF
     # "application/epub+zip", will be used.
     #
     # Please see the
-    # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
+    # {ZipContainer documentation}[http://hainesr.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/lib/ucf/{meta-inf.rb → meta_inf.rb}

@@ -1,4 +1,6 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -37,41 +39,41 @@ rescue LoadError
 end
 
 module UCF
-
   # This is a subclass of ManagedDirectory to represent the META-INF directory
   # in a basic UCF Document.
-  class MetaInf < ZipContainer::ManagedDirectory
-
-    SCHEMA_DIR = ::File.join(::File.dirname(__FILE__), "schema")
-    CONTAINER_SCHEMA = ::File.join(SCHEMA_DIR, "container.rng")
-    MANIFEST_SCHEMA = ::File.join(SCHEMA_DIR, "OpenDocument-manifest-schema-v1.0-os.rng")
+  class MetaInf < ZipContainer::ManagedDirectory # :nodoc:
+    SCHEMA_DIR = ::File.join(::File.dirname(__FILE__), 'schema')
+    CONTAINER_SCHEMA = ::File.join(SCHEMA_DIR, 'container.rng')
+    MANIFEST_SCHEMA = ::File.join(SCHEMA_DIR, 'OpenDocument-manifest-schema-v1.0-os.rng')
 
     # :call-seq:
     #   new -> MetaInf
     #
     # Create a standard META-INF ManagedDirectory.
     def initialize
-      super("META-INF", :required => false, :entries =>
-        [
-          File.new("container.xml", CONTAINER_SCHEMA),
-          File.new("manifest.xml", MANIFEST_SCHEMA),
-          File.new("metadata.xml"),
-          File.new("signatures.xml"),
-          File.new("encryption.xml"),
-          File.new("rights.xml")
-        ]
+      super(
+        'META-INF',
+        required: false,
+        entries:
+          [
+            File.new('container.xml', CONTAINER_SCHEMA),
+            File.new('manifest.xml', MANIFEST_SCHEMA),
+            File.new('metadata.xml'),
+            File.new('signatures.xml'),
+            File.new('encryption.xml'),
+            File.new('rights.xml')
+          ]
       )
     end
 
-    class File < ZipContainer::ManagedFile
-
+    class File < ZipContainer::ManagedFile # :nodoc:
       def initialize(name, schema = nil)
-        super(name, :required => false)
+        super(name, required: false)
 
         @schema = nil
-        if defined?(::Nokogiri)
-          @schema = schema.nil? ? nil : Nokogiri::XML::RelaxNG(::File.open(schema))
-        end
+        return unless defined?(::Nokogiri)
+
+        @schema = schema.nil? ? nil : Nokogiri::XML::RelaxNG(::File.open(schema))
       end
 
       protected
@@ -80,6 +82,5 @@ module UCF
         @schema.nil? ? true : @schema.validate(Nokogiri::XML(contents)) == []
       end
     end
-
   end
 end

data/lib/ucf/version.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2014-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,17 +32,8 @@
 #
 # Author: Robert Haines
 
-require 'yaml'
-
+##
 module UCF
-
-  # Library version information.
-  module Version
-    # Version information in a Hash
-    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..", "..",
-      "version.yml"))
-
-    # Version number as a String
-    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
-  end
+  # The current version of the UCF library.
+  VERSION = '3.0.0'
 end

data/lib/ucf.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -36,7 +38,7 @@ require 'bundler/setup'
 require 'zip-container'
 
 require 'ucf/version'
-require 'ucf/meta-inf'
+require 'ucf/meta_inf'
 require 'ucf/dir'
 require 'ucf/file'
 

data/ucf.gemspec

@@ -1,4 +1,6 @@
-# Copyright (c) 2013-2018 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,37 +32,50 @@
 #
 # Author: Robert Haines
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ucf/version"
+require_relative 'lib/ucf/version'
 
 Gem::Specification.new do |s|
-  s.name        = "ucf"
-  s.version     = UCF::Version::STRING
-  s.authors     = ["Robert Haines", "Finn Bacall"]
-  s.email       = ["support@mygrid.org.uk"]
-  s.homepage    = "http://mygrid.github.io/ruby-ucf/"
+  s.name        = 'ucf'
+  s.version     = UCF::VERSION
+  s.authors     = ['Robert Haines', 'Finn Bacall']
+  s.email       = ['robert.haines@manchester.ac.uk']
+  s.homepage    = 'https://github.com/hainesr/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) "\
-    "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)."
-  s.license          = "BSD"
-  s.require_path     = "lib"
-  s.files            = `git ls-files`.split($/)
-  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.required_ruby_version = ">= 1.9.3"
-  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", "~> 4.0.1"
+  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) ' \
+    '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).'
+
+  s.license       = 'BSD'
+  s.require_paths = ['lib']
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/hainesr/ruby-ucf/issues',
+    'changelog_uri' => "https://github.com/hainesr/ruby-ucf/blob/v#{s.version}/Changelog.md",
+    'documentation_uri' => 'https://hainesr.github.io/ruby-ucf',
+    'source_code_uri' => "https://github.com/hainesr/ruby-ucf/tree/v#{s.version}",
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.required_ruby_version = '>= 3.0'
+
+  s.add_development_dependency 'minitest', '~> 5.25'
+  s.add_development_dependency 'nokogiri', '~> 1.18.9'
+  s.add_development_dependency 'rake', '~> 13.2'
+  s.add_development_dependency 'rdoc', '~> 6.11'
+  s.add_development_dependency 'rubocop', '~> 1.50.0'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.30.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.17.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'simplecov', '0.22.0'
+  s.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+
+  s.add_runtime_dependency 'zip-container', '~> 6.0'
 end