epub_tools 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327cbc5239c4f7c2ed333f6fdd558f2097232577049bc4b14f08ac94907ca4a6
-  data.tar.gz: d40cc31a904e125c757e880dd91f33e113744940b2dc89bb789811b27c75de37
+  metadata.gz: cbc80ed0690251633b8f12d80fa256922cac6092c12d3a910cd998e61ce38ea0
+  data.tar.gz: b0da7dd401516d3a1074268c7495d02d1a3532ea3e6f4bd9b49b9e62772e280c
 SHA512:
-  metadata.gz: 5aaec7cea97124b4167af08b83d8bd3e8374b3919712a85d99f72aa883b02953767177853ad397ab2fcf66476b725776b83e48e6a567512849e8fd8f6aa3ae63
-  data.tar.gz: 53164f7aaafcea2fe38863401bac0351e4ed25a339e7c05f1f713e6979ddef2dd71e286e1b67b9c3ac6a20cf54bc2d2725ba3e765a1260a82cd3f892d8777180
+  metadata.gz: 66de9b943051874b87a1a32bf7fba1391eefad09e21a20f1e5a9265cdcb77d65bc453342787dc25944a265a81cf1119ecfe37a78713221d6d869aae4896982d9
+  data.tar.gz: db68ab8011facd49ef7314d1b6e7ce0c2b645a62a3a4ae213048af2500546622b55153cc4598747d234a972c05738927ec7f9b9efb047feb0c60c3022a6f21fa

data/bin/epub-tools

@@ -2,6 +2,11 @@
 require_relative '../lib/epub_tools'
 
 prog = File.basename($PROGRAM_NAME)
+# Global version flag: print version and exit if invoked as `epub-tools -v/--version`
+if ARGV[0] == '-v' || ARGV[0] == '--version'
+  puts EpubTools::VERSION
+  exit 0
+end
 script_dir = File.expand_path(File.join(__dir__, '..'))
 commands = %w[add extract init split pack unpack compile]
 
@@ -90,7 +95,7 @@ when 'unpack'
     opts.on('-o DIR', '--output-dir DIR', 'Output directory to extract into (default: basename of epub)') { |v| o[:output_dir] = v }
     opts.on('-q', '--quiet', 'Run quietly (default: verbose)') { |v| o[:verbose] = !v }
   end
-  EpubTools::UnpackEbook.new(options[:epub_file], verbose: options[:verbose]).run
+  EpubTools::UnpackEbook.new(options[:epub_file], options[:output_dir], verbose: options[:verbose]).run
 
 when 'compile'
   options = {verbose: true}
@@ -103,5 +108,5 @@ when 'compile'
     opts.on('-c PATH', '--cover PATH', 'Cover image file path (optional)') { |v| o[:cover_image] = v }
     opts.on('-q', '--quiet', 'Run quietly (default: verbose)') { |v| o[:verbose] = !v }
   end
-  EpubTools::CompileBook.new(*options).run
+  EpubTools::CompileBook.new(**options).run
 end

data/epub_tools.gemspec

@@ -6,12 +6,16 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Tools to extract, split, and compile EPUB books'
   spec.authors       = ['Jaime Rodas']
   spec.email         = ['rodas@hey.com']
-  spec.homepage      = 'https://rubygems.org/gems/epub_tools'
+  spec.homepage      = 'https://github.com/jaimerodas/epub_tools'
   spec.license       = 'MIT'
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ['lib']
   spec.executables   = ['epub-tools']
   spec.required_ruby_version = ">= 3.0"
+  spec.metadata    = {
+    "source_code_uri" => "https://github.com/jaimerodas/epub_tools/tree/main",
+    "homepage_uri" => "https://github.com/jaimerodas/epub_tools"
+  }
 
   spec.add_dependency 'nokogiri', '~> 1.18'
   spec.add_dependency 'rubyzip', '~> 2.4'

data/lib/epub_tools/compile_book.rb

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 require 'fileutils'
-$LOAD_PATH.unshift File.expand_path('../../', __FILE__)
-require 'epub_tools'
+require_relative 'xhtml_extractor'
+require_relative 'split_chapters'
+require_relative 'epub_initializer'
+require_relative 'add_chapters_to_epub'
+require_relative 'pack_ebook'
 
 module EpubTools
   # Orchestrates extraction, splitting, validation, and packaging of book EPUBs

data/lib/epub_tools/version.rb

@@ -1,3 +1,3 @@
 module EpubTools
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/epub_tools.rb

@@ -7,6 +7,7 @@ require_relative 'epub_tools/xhtml_cleaner'
 require_relative 'epub_tools/xhtml_extractor'
 require_relative 'epub_tools/pack_ebook'
 require_relative 'epub_tools/unpack_ebook'
+require_relative 'epub_tools/compile_book'
 
 module EpubTools
 end

data/test/cli_version_test.rb

@@ -0,0 +1,20 @@
+require_relative 'test_helper'
+require_relative '../lib/epub_tools/version'
+require 'open3'
+
+class CLIVersionTest < Minitest::Test
+  def test_version_flag
+    # Path to the CLI executable under the project root
+    project_root = File.expand_path('..', __dir__)
+    cli = File.join(project_root, 'bin', 'epub-tools')
+    # Run with --version
+    out, status = Open3.capture2(cli, '--version')
+    assert_equal "#{EpubTools::VERSION}\n", out
+    assert status.success?, "Expected exit status 0, got #{status.exitstatus}"
+
+    # Run with -v
+    out2, status2 = Open3.capture2(cli, '-v')
+    assert_equal "#{EpubTools::VERSION}\n", out2
+    assert status2.success?, "Expected exit status 0, got #{status2.exitstatus}"
+  end
+end

data/test/epub_initializer_test.rb

@@ -52,4 +52,68 @@ class EpubInitializerTest < Minitest::Test
     assert_includes opf, '<item id="cover-page"'
     assert_includes opf, '<itemref idref="cover-page"'
   end
+
+  def test_run_with_cover_jpg
+    cover = File.join(@tmp, 'cover.jpg')
+    File.write(cover, 'JPGDATA')
+    EpubTools::EpubInitializer.new(@title, @author, @dest, cover).run
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.jpg'))
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    assert_includes opf, "<item id=\"cover-image\" href=\"cover.jpg\" media-type=\"image/jpeg\""
+    assert_includes opf, '<item id="cover-page"'
+    assert_includes opf, '<itemref idref="cover-page"'
+    cover_xhtml = File.read(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    assert_includes cover_xhtml, 'src="cover.jpg"'
+  end
+
+  def test_run_with_cover_jpeg
+    cover = File.join(@tmp, 'cover.jpeg')
+    File.write(cover, 'JPEGDATA')
+    EpubTools::EpubInitializer.new(@title, @author, @dest, cover).run
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.jpeg'))
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    assert_includes opf, "<item id=\"cover-image\" href=\"cover.jpeg\" media-type=\"image/jpeg\""
+    cover_xhtml = File.read(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    assert_includes cover_xhtml, 'src="cover.jpeg"'
+  end
+
+  def test_run_with_cover_gif
+    cover = File.join(@tmp, 'cover.gif')
+    File.write(cover, 'GIFDATA')
+    EpubTools::EpubInitializer.new(@title, @author, @dest, cover).run
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.gif'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    assert_includes opf, "<item id=\"cover-image\" href=\"cover.gif\" media-type=\"image/gif\""
+  end
+
+  def test_run_with_cover_svg
+    cover = File.join(@tmp, 'cover.svg')
+    File.write(cover, '<svg/>')
+    EpubTools::EpubInitializer.new(@title, @author, @dest, cover).run
+    assert File.exist?(File.join(@dest, 'OEBPS', 'cover.svg'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    assert_includes opf, "<item id=\"cover-image\" href=\"cover.svg\" media-type=\"image/svg+xml\""
+  end
+
+  def test_run_with_unsupported_cover_image
+    cover = File.join(@tmp, 'cover.bmp')
+    File.write(cover, 'BMPDATA')
+    ei = EpubTools::EpubInitializer.new(@title, @author, @dest, cover)
+    assert_output("", /unsupported cover image type/) { ei.run }
+    refute File.exist?(File.join(@dest, 'OEBPS', 'cover.bmp'))
+    refute File.exist?(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    refute_includes opf, 'cover-image'
+  end
+
+  def test_run_without_cover_but_declaring_cover
+    cover = File.join(@tmp, 'cover.bmp')
+    ei = EpubTools::EpubInitializer.new(@title, @author, @dest, cover)
+    assert_output("", /not found/) { ei.run }
+    refute File.exist?(File.join(@dest, 'OEBPS', 'cover.xhtml'))
+    opf = File.read(File.join(@dest, 'OEBPS', 'package.opf'))
+    refute_includes opf, 'cover-image'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jaime Rodas
@@ -110,6 +110,7 @@ files:
 - lib/epub_tools/xhtml_extractor.rb
 - style.css
 - test/add_chapters_to_epub_test.rb
+- test/cli_version_test.rb
 - test/compile_book_test.rb
 - test/epub_initializer_test.rb
 - test/pack_ebook_test.rb
@@ -119,10 +120,12 @@ files:
 - test/unpack_ebook_test.rb
 - test/xhtml_cleaner_test.rb
 - test/xhtml_extractor_test.rb
-homepage: https://rubygems.org/gems/epub_tools
+homepage: https://github.com/jaimerodas/epub_tools
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/jaimerodas/epub_tools/tree/main
+  homepage_uri: https://github.com/jaimerodas/epub_tools
 rdoc_options: []
 require_paths:
 - lib