epub-rb 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 849b081d7cddbdb2eb58d244c3e63a592e77eb17a954260aa963afb387580869
+  data.tar.gz: cbe1f6e8f759c167b06dfe9198ed0284af344ede80f720a9b7f56a90be3f78cf
+SHA512:
+  metadata.gz: 96cb09f533b6ed5a07c309ee8c0a354d226478cd087303cbc83b912df4d70e06d96bd938f2db59d6f0894d5528af64dc06c90f18ce697f22fcaef28b65923981
+  data.tar.gz: 61f5f252c171559dd0183236c80d50064c7f03b2ab48977131f99634eb201c2735add1c22ce96ec665a4c33c2ff1c56efdeac69236f9511ef24e38ce92930924

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+---
+github: [fnando]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of epub-rb
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+---
+contact_links:
+  - name: "🤨 Q&A"
+    url: https://github.com/fnando/epub/discussions/new?category=q-a
+    about: Have a question? Ask it away here!

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,55 @@
+---
+name: ruby-tests
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+        gemfile:
+          - Gemfile
+
+    steps:
+      - uses: fnando/epubcheck-action@main
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.log
+*.lock
+/test/support/toc.html
+*.epub

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+Naming/FileName:
+  Exclude:
+    - lib/epub-rb.rb

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## Unreleased
+
+- Initial release.

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 me@fnando.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing to epub-rb
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/epub/blob/main/CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## Contributing with code
+
+Before making any radicals changes, please make sure you discuss your intention
+by [opening an issue on Github](https://github.com/fnando/epub/issues).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) epub-rb
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
+7. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `rake`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+## Setting up the environment
+
+- Use the latest ruby version (although any of the two ruby releases are
+  officially supported).
+- Make sure you have [epubchecker](https://www.w3.org/publishing/epubcheck/)
+  available on your path, as it's used to test that generated files are valid.
+- Install dependencies with `bundle install`.
+- Run tests with `bundle exec rake`.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2024 Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# epub-rb
+
+[![Tests](https://github.com/fnando/epub/workflows/ruby-tests/badge.svg)](https://github.com/fnando/epub)
+[![Gem](https://img.shields.io/gem/v/epub-rb.svg)](https://rubygems.org/gems/epub-rb)
+[![Gem](https://img.shields.io/gem/dt/epub-rb.svg)](https://rubygems.org/gems/epub-rb)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+Create epub files using Ruby.
+
+## Installation
+
+```bash
+gem install epub-rb
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "epub-rb"
+```
+
+## Usage
+
+```ruby
+require "epub"
+
+epub = Epub.new(
+  root_dir: "./book",
+  title: "Hello World",
+  subtitle: "A Complete Beginner’s Guide to Ruby Programming",
+  creators: ["John Doe"],
+  publisher: "epub-rb",
+  date: "2024-01-24",
+  id: "d05f92ea-62f7-44d6-bb48-d94c11e660db",
+  copyright: "Copyright 2024 by John Doe",
+  identifiers: ["915869090000000000DD", "urn:isbn:9780000000001"],
+  contributors: ["Jane Doe"],
+  files: [
+    "./book/book.css",
+    "./book/cover.png",
+    "./book/cover.html",
+    "./book/toc.html",
+    "./book/ch01.html",
+    "./book/ch02.html",
+    "./book/images/terminal.svg"
+  ]
+)
+
+epub.save("hello-word.epub")
+```
+
+The epub file is compliant with the EPUB 3.3 specification. You can check it by
+using [epubcheck](https://www.w3.org/publishing/epubcheck/).
+
+> [!NOTE]
+>
+> epub-rb makes a few assumptions that you need to follow.
+>
+> 1. You need to have a file name `toc.{xhtml,html}`. This file must be
+>    compliant with the EPUB 3 spec.
+> 2. You'll also need a cover image named as `cover.{png,jpg,gif}`.
+> 3. You'll also need a companion file called `cover.{xhtml,html}`.
+
+### Generating the Table of Contents (navigation file)
+
+You can use the methods `Epub::Navigation.extract(files, root_dir:)` and
+`Epub::Navigation.extract_html(files, root_dir:)` to generate the `toc.html`
+file. A simple way would be using something like this:
+
+```ruby
+navigation = Epub::Navigation.extract_html(
+  Dir["./book/**/*.html"],
+  root_dir: "./book"
+)
+
+File.open("toc.html", "w") do |file|
+  file << <<~HTML
+    <?xml version='1.0' encoding='utf-8'?>
+    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+      <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+        <title>Table of Contents</title>
+      </head>
+      <body>
+        #{navigation}
+      </body>
+    </html>
+
+  HTML
+end
+```
+
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/epub/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+https://github.com/fnando/epub/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/epub/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the epub-rb project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/epub/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "epub-rb"
+
+# 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.
+
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/epub-rb.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/epub/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "epub-rb"
+  spec.version = Epub::VERSION
+  spec.authors = ["Nando Vieira"]
+  spec.email   = ["me@fnando.com"]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  spec.summary     = "Create epub files using Ruby."
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
+
+  github_url = "https://github.com/fnando/epub"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "builder"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "thor"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+end

data/exe/epub

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/epub-rb"
+Epub::CLI.start

data/lib/epub/cli.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Epub
+  class CLI < Thor
+    check_unknown_options!
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "new PATH", "Create a new gem"
+    def new(path)
+      generator = Generator.new
+      generator.destination_root = File.expand_path(path)
+      generator.options = options
+      generator.invoke_all
+    end
+
+    no_commands do
+      # Add helper methods here
+    end
+  end
+end