epub_tools 0.3.0 → 0.4.0

data/test/split_chapters_test.rb

@@ -27,26 +27,47 @@ class SplitChaptersTest < Minitest::Test
   end
 
   def test_run_generates_chapter_files
-    EpubTools::SplitChapters.new(@input, 'BookTitle', @out, 'chap').run
+    result = EpubTools::SplitChapters.new(input_file: @input, book_title: 'BookTitle', output_dir: @out,
+                                          output_prefix: 'chap').run
+
+    # Check return value is an array of chapter file paths
+    assert_instance_of Array, result
+    assert_equal 3, result.size
+
+    expected_paths = [
+      File.join(@out, 'chap_0.xhtml'),
+      File.join(@out, 'chap_1.xhtml'),
+      File.join(@out, 'chap_2.xhtml')
+    ]
+
+    expected_paths.each do |path|
+      assert_includes result, path
+      assert_path_exists path, "Expected file #{path} to exist"
+    end
+
     files = Dir.children(@out)
+
     assert_includes files, 'chap_0.xhtml'
     assert_includes files, 'chap_1.xhtml'
     assert_includes files, 'chap_2.xhtml'
 
     # Prologue
     prologue = File.read(File.join(@out, 'chap_0.xhtml'))
+
     assert_includes prologue, '<h1>Prologue</h1>'
     assert_includes prologue, 'Intro text'
     refute_includes prologue, 'Chapter 1'
 
     # Chapter 1
     ch1 = File.read(File.join(@out, 'chap_1.xhtml'))
+
     assert_includes ch1, '<h1>Chapter 1</h1>'
     assert_includes ch1, 'First paragraph'
     refute_includes ch1, 'Chapter 2'
 
     # Chapter 2
     ch2 = File.read(File.join(@out, 'chap_2.xhtml'))
+
     assert_includes ch2, '<h1>Chapter 2</h1>'
     assert_includes ch2, 'Second paragraph'
   end

data/test/{text_style_class_finder_test.rb → style_finder_test.rb}

@@ -1,8 +1,8 @@
 require 'yaml'
 require_relative 'test_helper'
-require_relative '../lib/epub_tools/text_style_class_finder'
+require_relative '../lib/epub_tools/style_finder'
 
-class TextStyleClassFinderTest < Minitest::Test
+class StyleFinder < Minitest::Test
   def setup
     @tmp = Dir.mktmpdir
     @xhtml = File.join(@tmp, 'doc.xhtml')
@@ -22,19 +22,20 @@ class TextStyleClassFinderTest < Minitest::Test
   end
 
   def test_finds_italic_and_bold_classes
-    EpubTools::TextStyleClassFinder.new(@xhtml, @yaml).call
+    EpubTools::StyleFinder.new(file_path: @xhtml, output_path: @yaml).run
     data = YAML.load_file(@yaml)
+
     assert_equal ['c1'], data['italics']
     assert_equal ['c2'], data['bolds']
   end
 
   def test_verbose_mode
     text = <<~OUTPUT
-    Classes with font-style: italic: c1
-    Classes with font-weight: 700: c2
+      Classes with font-style: italic: c1
+      Classes with font-weight: 700: c2
     OUTPUT
     assert_output(text) do
-      EpubTools::TextStyleClassFinder.new(@xhtml, @yaml, verbose: true).call
+      EpubTools::StyleFinder.new(file_path: @xhtml, output_path: @yaml, verbose: true).run
     end
   end
 end

data/test/test_helper.rb

@@ -1,9 +1,8 @@
-if ENV['COVERAGE']
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter '/test/'
-  end
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
 end
+
 require 'minitest/autorun'
 require 'tmpdir'
 require 'fileutils'

data/test/unpack_ebook_test.rb

@@ -24,6 +24,7 @@ class UnpackEbookTest < Minitest::Test
       Dir.glob(File.join(@build_dir, '**', '*'), File::FNM_DOTMATCH).sort.each do |src_path|
         rel_path = src_path.sub(%r{^#{Regexp.escape(@build_dir)}/?}, '')
         next if rel_path.empty? || rel_path == 'mimetype'
+
         if File.directory?(src_path)
           zip.mkdir(rel_path)
         else
@@ -40,19 +41,34 @@ class UnpackEbookTest < Minitest::Test
   end
 
   def test_run_extracts_all_entries
-    EpubTools::UnpackEbook.new(@epub_file, @dest_dir).run
+    result = EpubTools::UnpackEbook.new(epub_file: @epub_file, output_dir: @dest_dir).run
+
+    # Check return value is the output directory path
+    assert_equal @dest_dir, result
+
     # Check extracted files
     assert Dir.exist?(@dest_dir)
     assert_equal 'application/epub+zip', File.read(File.join(@dest_dir, 'mimetype'))
-    assert File.exist?(File.join(@dest_dir, 'META-INF', 'container.xml'))
-    assert File.exist?(File.join(@dest_dir, 'OEBPS', 'title.xhtml'))
+    assert_path_exists File.join(@dest_dir, 'META-INF', 'container.xml')
+    assert_path_exists File.join(@dest_dir, 'OEBPS', 'title.xhtml')
+  end
+
+  def test_run_with_default_output_dir
+    # Create the test with default output directory
+    result = EpubTools::UnpackEbook.new(epub_file: @epub_file).run
+
+    expected_dir = File.join(File.dirname(@epub_file), File.basename(@epub_file, '.epub'))
+
+    assert_equal expected_dir, result
+    assert Dir.exist?(expected_dir)
+    assert_path_exists File.join(expected_dir, 'mimetype')
   end
 
   def test_missing_epub_raises_error
     missing = File.join(@tmp, 'nope.epub')
     error = assert_raises(ArgumentError) do
-      EpubTools::UnpackEbook.new(missing, @dest_dir).run
+      EpubTools::UnpackEbook.new(epub_file: missing, output_dir: @dest_dir).run
     end
-    assert_includes error.message, "does not exist"
+    assert_includes error.message, 'does not exist'
   end
 end

data/test/xhtml_cleaner_test.rb

@@ -28,12 +28,18 @@ class XHTMLCleanerTest < Minitest::Test
   end
 
   def test_cleaner_removes_and_transforms_tags
-    EpubTools::XHTMLCleaner.new(@file, @config).call
-    result = File.read(@file)
-    assert_includes result, '<i>ItalicsOnly</i>'
-    assert_includes result, 'KeepThis'
-    refute_includes result, '<span'
-    refute_includes result, '<hr'
-    refute_includes result, 'RemoveMe'
+    result = EpubTools::XHTMLCleaner.new(filename: @file, class_config: @config).run
+
+    # Check return value is the filename that was cleaned
+    assert_equal @file, result
+    assert_path_exists @file
+
+    content = File.read(@file)
+
+    assert_includes content, '<i>ItalicsOnly</i>'
+    assert_includes content, 'KeepThis'
+    refute_includes content, '<span'
+    refute_includes content, '<hr'
+    refute_includes content, 'RemoveMe'
   end
 end

data/test/xhtml_extractor_test.rb

@@ -22,8 +22,24 @@ class XHTMLExtractorTest < Minitest::Test
   end
 
   def test_extracts_xhtml_excluding_nav
-    @extractor.extract_all
+    result = @extractor.run
+
+    # Check return value is an array of extracted file paths
+    assert_instance_of Array, result
+    assert_equal 2, result.size
+
+    expected_paths = [
+      File.join(@tgt, 'sample_chapter1.xhtml'),
+      File.join(@tgt, 'sample_ch2.xhtml')
+    ]
+
+    expected_paths.each do |path|
+      assert_includes result, path
+      assert_path_exists path
+    end
+
     files = Dir.children(@tgt)
+
     assert_includes files, 'sample_chapter1.xhtml'
     assert_includes files, 'sample_ch2.xhtml'
     refute_includes files, 'nav.xhtml'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub_tools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jaime Rodas
@@ -23,20 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,33 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.25'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.25'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 email:
 - rodas@hey.com
 executables:
@@ -86,37 +58,49 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".nova/Configuration.json"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/epub-tools
 - epub_tools.gemspec
 - lib/epub_tools.rb
-- lib/epub_tools/add_chapters_to_epub.rb
-- lib/epub_tools/cli_helper.rb
+- lib/epub_tools/add_chapters.rb
+- lib/epub_tools/cli.rb
+- lib/epub_tools/cli/command_registry.rb
+- lib/epub_tools/cli/option_builder.rb
+- lib/epub_tools/cli/runner.rb
 - lib/epub_tools/compile_book.rb
 - lib/epub_tools/epub_initializer.rb
+- lib/epub_tools/loggable.rb
 - lib/epub_tools/pack_ebook.rb
 - lib/epub_tools/split_chapters.rb
-- lib/epub_tools/text_style_class_finder.rb
+- lib/epub_tools/style_finder.rb
 - lib/epub_tools/unpack_ebook.rb
 - lib/epub_tools/version.rb
 - lib/epub_tools/xhtml_cleaner.rb
 - lib/epub_tools/xhtml_extractor.rb
 - style.css
-- test/add_chapters_to_epub_test.rb
+- test/add_chapters_test.rb
+- test/cli/command_registry_test.rb
+- test/cli/option_builder_test.rb
+- test/cli/runner_test.rb
+- test/cli_commands_test.rb
+- test/cli_test.rb
 - test/cli_version_test.rb
 - test/compile_book_test.rb
 - test/epub_initializer_test.rb
 - test/pack_ebook_test.rb
 - test/split_chapters_test.rb
+- test/style_finder_test.rb
 - test/test_helper.rb
-- test/text_style_class_finder_test.rb
 - test/unpack_ebook_test.rb
 - test/xhtml_cleaner_test.rb
 - test/xhtml_extractor_test.rb
@@ -126,6 +110,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/jaimerodas/epub_tools/tree/main
   homepage_uri: https://github.com/jaimerodas/epub_tools
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -133,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/epub_tools/add_chapters_to_epub.rb

@@ -1,87 +0,0 @@
-#!/usr/bin/env ruby
-require 'nokogiri'
-require 'fileutils'
-
-module EpubTools
-  class AddChaptersToEpub
-    def initialize(chapters_dir = './chapters', epub_dir = './epub/OEBPS', verbose = false)
-      @chapters_dir = chapters_dir
-      @epub_dir = epub_dir
-      @opf_file = File.join(@epub_dir, 'package.opf')
-      @nav_file = File.join(@epub_dir, 'nav.xhtml')
-      @verbose = verbose
-    end
-
-    def run
-      moved_files = move_chapters
-      update_package_opf(moved_files)
-      update_nav_xhtml(moved_files)
-      @verbose ? moved_files.each {|f| puts "Moved: #{f}"} : moved_files
-    end
-
-    private
-
-    def move_chapters
-      # Sort by chapter number (numeric)
-      chapter_files = Dir.glob(File.join(@chapters_dir, '*.xhtml')).sort_by do |path|
-        # extract first integer from filename (e.g. chapter_10.xhtml -> 10)
-        File.basename(path)[/\d+/].to_i
-      end
-      chapter_files.each do |file|
-        FileUtils.mv(file, @epub_dir)
-      end
-      chapter_files.map { |f| File.basename(f) }
-    end
-
-    def chapter_id(filename)
-      match = filename.match(/chapter_(\d+)\.xhtml/)
-      match ? "chap#{match[1]}" : File.basename(filename, '.xhtml')
-    end
-
-    def update_package_opf(filenames)
-      doc = Nokogiri::XML(File.read(@opf_file)) { |config| config.default_xml.noblanks }
-      manifest = doc.at_xpath('//xmlns:manifest')
-      spine = doc.at_xpath('//xmlns:spine')
-
-      filenames.each do |filename|
-        id = chapter_id(filename)
-        # Add <item> to the manifest if missing
-        unless doc.at_xpath("//xmlns:item[@href='#{filename}']")
-          item = Nokogiri::XML::Node.new('item', doc)
-          item['id'] = id
-          item['href'] = filename
-          item['media-type'] = 'application/xhtml+xml'
-          manifest.add_child(item)
-        end
-
-        # Add <itemref> to the spine if missing
-        unless doc.at_xpath("//xmlns:itemref[@idref='#{id}']")
-          itemref = Nokogiri::XML::Node.new('itemref', doc)
-          itemref['idref'] = id
-          spine.add_child(itemref)
-        end
-      end
-
-      File.write(@opf_file, doc.to_xml(indent: 2))
-    end
-
-    def update_nav_xhtml(filenames)
-      doc = Nokogiri::XML(File.read(@nav_file)) { |config| config.default_xml.noblanks }
-      nav = doc.at_xpath('//xmlns:nav[@epub:type="toc"]/xmlns:ol')
-
-      filenames.each do |filename|
-        # Create a new <li><a href="...">Label</a></li> element
-        label = File.basename(filename, '.xhtml').gsub('_', ' ').capitalize
-        label = "Prologue" if label == "Chapter 0"
-        li = Nokogiri::XML::Node.new('li', doc)
-        a  = Nokogiri::XML::Node.new('a', doc)
-        a['href'] = filename
-        a.content = label
-        li.add_child(a)
-        nav.add_child(li)
-      end
-
-      File.write(@nav_file, doc.to_xml(indent: 2))
-    end
-  end
-end

data/lib/epub_tools/cli_helper.rb

@@ -1,31 +0,0 @@
-require 'optparse'
-
-module EpubTools
-  # A simple helper to DRY CLI OptionParser usage across commands
-  class CLIHelper
-    # Parses ARGV into options hash, enforces required keys, and displays help/errors.
-    # options: hash of defaults; required_keys: array of symbols required
-    def self.parse(options = {}, required_keys = [], &block)
-      parser = OptionParser.new do |opts|
-        block.call(opts, options)
-        opts.on('-h', '--help', 'Prints this help') { puts opts; exit }
-      end
-      begin
-        parser.parse!
-        unless required_keys.empty?
-          missing = required_keys.select { |k| options[k].nil? }
-          unless missing.empty?
-            STDERR.puts "Missing required options: #{missing.map { |k| "--#{k.to_s.gsub('_','-')}" }.join(', ')}"
-            STDERR.puts parser
-            exit 1
-          end
-        end
-      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
-        STDERR.puts e.message
-        STDERR.puts parser
-        exit 1
-      end
-      options
-    end
-  end
-end

data/lib/epub_tools/text_style_class_finder.rb

@@ -1,47 +0,0 @@
-#!/usr/bin/env ruby
-require 'nokogiri'
-require 'yaml'
-
-module EpubTools
-  class TextStyleClassFinder
-    def initialize(file_path, output_path = 'text_style_classes.yaml', verbose: false)
-      @file_path = file_path
-      @output_path = output_path
-      @verbose = verbose
-      raise ArgumentError, "File does not exist: #{@file_path}" unless File.exist?(@file_path)
-    end
-
-    def call
-      doc = Nokogiri::HTML(File.read(@file_path))
-      style_blocks = doc.xpath('//style').map(&:text).join("\n")
-
-      italics = extract_classes(style_blocks, /font-style\s*:\s*italic/)
-      bolds   = extract_classes(style_blocks, /font-weight\s*:\s*700/)
-
-      print_summary(italics, bolds) if @verbose
-
-      data = {
-        "italics" => italics,
-        "bolds"   => bolds
-      }
-      File.write(@output_path, data.to_yaml)
-    end
-
-    private
-
-    def extract_classes(style_text, pattern)
-      regex = /\.([\w-]+)\s*{[^}]*#{pattern.source}[^}]*}/i
-      style_text.scan(regex).flatten.uniq
-    end
-
-    def print_summary(italics, bolds)
-      unless italics.empty?
-        puts "Classes with font-style: italic: #{italics.join(", ")}"
-      end
-
-      unless bolds.empty?
-        puts "Classes with font-weight: 700: #{bolds.join(", ")}"
-      end
-    end
-  end
-end