ucf 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f267e62b0019f1239fcee77be2f5ca2f5ebe49b0937faa7c2288d40dd381ab4b
-  data.tar.gz: 29f4f89813f92d56a5f73601a3c7c44156df4757c7047992380abe8769381964
+  metadata.gz: 45e68bb0b3234a7d195436ae50355f48dd1a328dddf9006abe332aae2ce9e581
+  data.tar.gz: 9dd69431276430cd0e21b6b957c5bfb74b6de73ef331e785db7aac85a7378480
 SHA512:
-  metadata.gz: 3fc0af5f72c78a58659bf93be2e73f0981ec0b332ba17015aa147ceb8c63a129b789168c071e5e3160b48301a97db1356e1e8a40ac77721805465d0ab6680b36
-  data.tar.gz: 86aa40b6a057b141f34b62cf01af8f17842488d3f8ff84d0595d0e85bd0c0993ada43c4d51f450b8e68316d10ee33691a462090f8444c58419906a6533ee83df
+  metadata.gz: 18c8ebeeb0bff5e112e202f52ee6823d0e3672549455c5113f503cbeda08568187444067a789c2b09eccadf1cbdc18a88f19404642fea173a8a47346b146d8f9
+  data.tar.gz: 9e51cacb95be6e8b871998e8cbc7fd5a588260b7a5b77d21615ba2410626fe54f2dd4b9773ddb8e697819bd81ce94a5598b8eae7ce7d49c8731bfc34bde4178e

data/.github/workflows/latest-docs.yml

@@ -0,0 +1,29 @@
+name: Latest documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout UCF code
+        uses: actions/checkout@v4
+
+      - name: Install and set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Run RDoc
+        run: bundle exec rake rdoc
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: html
+          target-folder: latest

data/.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: Linter
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout rubyzip code
+      uses: actions/checkout@v3
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+
+    - name: Rubocop
+      run: bundle exec rubocop -f github

data/.github/workflows/tests.yml

@@ -0,0 +1,89 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: ['3.1', '3.2', '3.3', '3.4', head, jruby, jruby-head, truffleruby, truffleruby-head]
+        include:
+          - os: macos
+            ruby: '3.1'
+          - os: windows
+            ruby: '3.1'
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.os == 'windows' || matrix.ruby == 'truffleruby' }}
+    steps:
+    - name: Checkout rubyzip code
+      uses: actions/checkout@v3
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run the tests
+      env:
+        RUBYOPT: -v
+        JRUBY_OPTS: --debug
+      run: bundle exec rake
+
+    - name: Coveralls
+      if: matrix.os == 'ubuntu' && !endsWith(matrix.ruby, 'head')
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        flag-name: ${{ matrix.ruby }}
+        parallel: true
+
+  test-isolated:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout rubyzip code
+      uses: actions/checkout@v3
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+
+    - name: Run isolated tests
+      run: bundle exec rake test:isolated
+
+  test-yjit:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: ['3.1', '3.2', '3.3', '3.4', head]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: true
+    steps:
+    - name: Checkout rubyzip code
+      uses: actions/checkout@v3
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run the tests
+      env:
+        RUBYOPT: --enable-yjit -v
+      run: bundle exec rake
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

data/.gitignore

@@ -7,3 +7,6 @@ coverage/
 .rvmrc
 Gemfile.lock
 example.zip
+.ruby-env
+.ruby-gemset
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,63 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+# Set our base version of ruby and enable all cops.
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+# I think 'has_key?' looks better than 'key?'.
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+
+# Allow long lines in the tests.
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'test/**/*.rb'
+
+# Force ruby19 style hash keys, but be consistent within a hash.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# Enforce %w notation in the library code, but be less strict in tests.
+Style/WordArray:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Ignore ABC failures in the tests.
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Ignore block length failures in the tests.
+Metrics/BlockLength:
+  Exclude:
+    - 'ucf.gemspec'
+    - 'test/**/*.rb'
+
+# Set a more reasonable method length and ignore failures in the tests.
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'test/**/*.rb'
+
+# Set a more reasonable class length and ignore failures in the tests.
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+    - 'test/**/*.rb'
+
+# This is still too high, but we'll get there.
+Minitest/MultipleAssertions:
+  Max: 10
+
+Style/Documentation:
+  Exclude:
+    - 'test/**/*.rb'
+    - 'examples/*'
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true

data/{test/tc_read_dir.rb → .simplecov}

@@ -1,4 +1,6 @@
-# Copyright (c) 2014, 2015 The University of Manchester, UK.
+# frozen_string_literal: true
+
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,27 +32,23 @@
 #
 # Author: Robert Haines
 
-require 'test/unit'
-require 'ucf'
-
-class TestReadDir < Test::Unit::TestCase
-
-  # Check that the empty directory does not verify.
-  def test_verify_empty_directory
-    assert_raise(ZipContainer::MalformedContainerError) do
-      UCF::Dir.verify!($dir_null)
-    end
+require 'simplecov-lcov'
 
-    refute(UCF::Dir.verify?($dir_null))
-  end
-
-  # Check that the empty container directory does verify.
-  def test_verify_empty_container
-    assert_nothing_raised(ZipContainer::MalformedContainerError) do
-      UCF::Dir.verify!($dir_empty)
-    end
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.output_directory = 'coverage'
+  c.lcov_file_name = 'lcov.info'
+  c.report_with_single_file = true
+  c.single_report_path = 'coverage/lcov.info'
+end
 
-    assert(UCF::Dir.verify?($dir_empty))
-  end
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter
+  ]
+)
 
+SimpleCov.start do
+  enable_coverage :branch
+  add_filter '/test/'
 end

data/{Changes.rdoc → CHANGES.md}

@@ -1,17 +1,42 @@
-= Changes log for the UCF Ruby Gem
-
-== Version 2.0.1
+# Changes log for the UCF Ruby Gem
+
+## Version 3.0.0
+
+* Update minimum ruby version required to 3.0.
+* Add a code of conduct.
+* Add contributing guidelines.
+* Update to use zip-container v6.
+* Fix various links in the documentation.
+
+### Internal/tooling:
+
+* Ensure CI tests are run with Ruby >=3.1 due to Nokogiri requirements.
+* Update rdoc and convert some rdoc files to md.
+* Update and add metadata in the gemspec.
+* Just use a constant for the gem version string.
+* Add a setup script.
+* Add a script to start IRB with UCF loaded.
+* Switch from Coveralls to Simplecov.
+* Switch to use minitest for unit tests.
+* Switch from Travis CI to GitHub Actions.
+* Add Rubocop.
+* Add a linting GitHub Action.
+* Set Rubocop output to use GitHub format.
+* Add an Action to build the latest documentation.
+* Add a test to ensure our version numbers are sane.
+
+## Version 2.0.1
 
 * Update zip-container dependency to fix rubyzip security vulnerability.
 
-== Version 2.0.0
+## 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
+## Version 1.1.0
 
 * Tidy up gemspec and update dependency versions.
 * Add test-unit to the deps so we can test in ruby 2.2.
@@ -21,13 +46,13 @@
 * Update zip-container dependency to 2.2.
 * Add the UCF::Dir class to create exploded containers.
 
-== Version 1.0.0
+## Version 1.0.0
 
 * Rename UCF::Container to UCF::File.
 * Use released zip-container 2.0 gem.
 * Remove UCF::Container compatibility.
 
-== Version 0.7.0
+## Version 0.7.0
 
 * Update to be able to use the newer zip-container gem.
 * Add ability to use a custom mimetype.
@@ -35,12 +60,12 @@
 * Verify META-INF/manifest.xml against its schema.
 * Add META-INF content to the example ucf file.
 
-== Version 0.6.0
+## Version 0.6.0
 
 * Move to use version 0.9.0 of the zip-container library.
 * Update and polish the example scripts.
 
-== Version 0.5.0
+## Version 0.5.0
 
 * Add support for managed entries in the container.
 * Verify and "optional" functionality for ManagedEntry.
@@ -51,7 +76,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.
@@ -70,7 +95,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.
@@ -80,15 +105,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 UCF Library
+## Introduction
+
+**Thank you** for considering a contribution to the **Ruby UCF 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 UCF, or tweet about it
+* Write blog posts, tutorials, etc. about Ruby UCF
+* Improve wording in any prose output
+* Improve automated tests, continuous integration, documentation, etc.
+
+## Ground Rules
+
+Your contribution to Ruby UCF is valued, and it should be an enjoyable experience. To ensure this there is the Ruby UCF
+[Code of Conduct](https://github.com/hainesr/ruby-ucf/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-ucf/issues). This may mean [creating a new issue](https://github.com/hainesr/ruby-ucf/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 UCF, is in scope, and aligns with the roadmap for the Ruby UCF and the Citation File Format.
+
+## Your First Contribution
+
+If you are unsure where to begin with your contribution to Ruby UCF, have a look at the [open issues in this repository](https://github.com/hainesr/ruby-ucf/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-ucf/blob/main/CODE_OF_CONDUCT.md)
+1. [Create a new issue](https://github.com/hainesr/ruby-ucf/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 UCF, which also contains a collection of test UCF files - both valid and invalid. Please add tests (and new test UCF 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-ucf/issues/new), asking for clarification of and/or an addition to the guidelines.

data/Gemfile

@@ -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,6 +32,6 @@
 #
 # Author: Robert Haines
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/{Licence.rdoc → LICENCE}

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

data/README.md

@@ -0,0 +1,57 @@
+# Universal Container Format (UCF) Ruby Library
+## Robert Haines
+
+A Ruby library for creating, editing and validating UCF files.
+
+[![Gem Version](https://badge.fury.io/rb/ucf.svg)](https://badge.fury.io/rb/ucf)
+[![Tests](https://github.com/hainesr/ruby-ucf/actions/workflows/tests.yml/badge.svg)](https://github.com/hainesr/ruby-ucf/actions/workflows/tests.yml)
+[![Linter](https://github.com/hainesr/ruby-ucf/actions/workflows/lint.yml/badge.svg)](https://github.com/hainesr/ruby-ucf/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/feb6586086c0151adadd/maintainability)](https://codeclimate.com/github/hainesr/ruby-ucf/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/hainesr/ruby-ucf/badge.svg)](https://coveralls.io/github/hainesr/ruby-ucf)
+
+### 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://hainesr.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.
+
+### Usage
+
+This library has two entry points.
+
+The main `UCF::File` class is a specialization of [ZipContainer::File](https://hainesr.github.io/ruby-zip-container/latest/ZipContainer/File.html) which largely mimics the rubyzip [Zip::File](https://www.rubydoc.info/gems/rubyzip/3.0.1/Zip/File) and [Zip::FileSystem](http://www.rubydoc.info/gems/rubyzip/3.0.1/Zip/FileSystem) APIs.
+
+The `UCF::Dir` class is a based upon the [ZipContainer::Dir](https://hainesr.github.io/ruby-zip-container/latest/ZipContainer/Dir.html) class which mimics, where possible, the core ruby [Dir API](https://rubyapi.org/3.0/o/dir).
+
+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.
+
+### 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 `container.xml` and `manifest.xml` 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.
+
+#### Ruby version requirements and nokogiri
+
+When used on its own the UCF library requires Ruby version >=3.0, however, if you are using nokogiri for schema validation then you need to use Ruby version >=3.1 to satisfy its version constraints.
+
+### 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.
+
+* Validation of all file contents in the META-INF directory. The `container.xml` and `manifest.xml` 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).
+
+### Library versions
+
+From version 1.0.0 onwards, the principles of [semantic versioning](https://semver.org/) are applied when numbering releases with new features or breaking changes.
+
+### Developing Ruby UCF
+
+Please see our [Code of Conduct](https://github.com/hainesr/ruby-ucf/blob/main/CODE_OF_CONDUCT.md) and our [contributor guidelines](https://github.com/hainesr/ruby-ucf/blob/main/CONTRIBUTING.md).
+
+### Licence
+
+BSD (See LICENCE file or http://www.opensource.org/licenses/bsd-license.php).

data/Rakefile

@@ -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.
 #
@@ -30,26 +32,27 @@
 #
 # Author: Robert Haines
 
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rdoc/task"
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 
-task :default => [:test]
+task default: :test
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/ts_ucf.rb']
-  t.verbose = true
+Minitest::TestTask.create do |test|
+  test.framework = 'require "simplecov"'
+  test.test_globs = 'test/**/*_test.rb'
 end
 
 RDoc::Task.new do |r|
-  r.main = "ReadMe.rdoc"
-  lib = Dir.glob("lib/**/*.rb").delete_if do |item|
-    item.include?("meta-inf.rb")
-  end
-  r.rdoc_files.include("ReadMe.rdoc", "Licence.rdoc", "Changes.rdoc", lib)
-  r.options << "-t Universal Container Format Ruby Library version " +
-    "#{UCF::Version::STRING}"
-  r.options << "-N"
-  r.options << "--tab-width=2"
+  r.main = 'README.md'
+  r.rdoc_files.include(
+    'README.md', 'LICENCE', 'CODE_OF_CONDUCT.md',
+    'CONTRIBUTING.md', 'CHANGES.md', 'lib/**/*.rb'
+  )
+  r.options << "-t Universal Container Format Ruby Library version #{UCF::VERSION}"
+  r.options << '--markup=markdown'
+  r.options << '--tab-width=2'
 end
+
+RuboCop::RakeTask.new