epub_tools 0.4.1 → 0.6.0

data/test/add_chapters_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require_relative '../lib/epub_tools/add_chapters'
 require 'nokogiri'
@@ -53,47 +55,139 @@ class AddChaptersTest < Minitest::Test
   end
 
   def test_run_moves_files_and_updates_opf_and_nav
-    # Run the add chapters task
     result = EpubTools::AddChapters.new(chapters_dir: @chapters_dir, oebps_dir: @epub_dir).run
 
-    # Check return value is an array of moved file basenames
+    verify_return_value(result)
+    verify_files_moved
+    verify_opf_structure
+    verify_nav_structure
+  end
+
+  private
+
+  def verify_return_value(result)
     assert_instance_of Array, result
     assert_equal 2, result.size
     assert_includes result, 'chapter_0.xhtml'
     assert_includes result, 'chapter_1.xhtml'
+  end
 
-    # Original chapter files should be moved
+  def verify_files_moved
     assert_empty Dir.glob(File.join(@chapters_dir, '*.xhtml'))
     assert_path_exists File.join(@epub_dir, 'chapter_0.xhtml')
     assert_path_exists File.join(@epub_dir, 'chapter_1.xhtml')
+  end
 
-    # package.opf should include manifest items and spine refs
-    doc = Nokogiri::XML(File.read(@opf_file)) { |cfg| cfg.default_xml.noblanks }
-    items   = doc.xpath('//xmlns:manifest/xmlns:item')
-    idrefs  = doc.xpath('//xmlns:spine/xmlns:itemref')
-    hrefs   = items.map { |i| i['href'] }
-    ids     = items.map { |i| i['id'] }
-    refs    = idrefs.map { |ir| ir['idref'] }
-
-    assert_includes hrefs, 'chapter_0.xhtml'
-    assert_includes hrefs, 'chapter_1.xhtml'
-    assert_includes ids,   'chap0'
-    assert_includes ids,   'chap1'
-    assert_includes refs,  'chap0'
-    assert_includes refs,  'chap1'
-
-    # nav.xhtml should have list entries for each chapter
-    nav_doc = Nokogiri::XML(File.read(@nav_file))
-    # strip namespaces for easy querying
-    nav_doc.remove_namespaces!
-    links = nav_doc.xpath('//nav/ol/li/a')
+  def verify_opf_structure
+    doc = parse_opf_document
+    opf_data = extract_opf_data(doc)
+
+    assert_includes opf_data[:hrefs], 'chapter_0.xhtml'
+    assert_includes opf_data[:hrefs], 'chapter_1.xhtml'
+    assert_includes opf_data[:ids], 'chap0'
+    assert_includes opf_data[:ids], 'chap1'
+    assert_includes opf_data[:refs], 'chap0'
+    assert_includes opf_data[:refs], 'chap1'
+  end
+
+  def verify_nav_structure
+    links = extract_nav_links
 
     assert_equal 2, links.size
-    # First is Prologue (chapter_0)
     assert_equal 'chapter_0.xhtml', links[0]['href']
     assert_equal 'Prologue', links[0].text
-    # Second is Chapter 1
     assert_equal 'chapter_1.xhtml', links[1]['href']
     assert_equal 'Chapter 1', links[1].text
   end
+
+  def parse_opf_document
+    Nokogiri::XML(File.read(@opf_file)) { |cfg| cfg.default_xml.noblanks }
+  end
+
+  def extract_opf_data(doc)
+    items = doc.xpath('//xmlns:manifest/xmlns:item')
+    idrefs = doc.xpath('//xmlns:spine/xmlns:itemref')
+
+    {
+      hrefs: items.map { |i| i['href'] },
+      ids: items.map { |i| i['id'] },
+      refs: idrefs.map { |ir| ir['idref'] }
+    }
+  end
+
+  def extract_nav_links
+    nav_doc = Nokogiri::XML(File.read(@nav_file))
+    nav_doc.remove_namespaces!
+    nav_doc.xpath('//nav/ol/li/a')
+  end
+end
+
+class AddChaptersHalfChapterTest < Minitest::Test
+  def setup
+    @tmp = Dir.mktmpdir
+    @chapters_dir = File.join(@tmp, 'chapters')
+    @epub_dir = File.join(@tmp, 'OEBPS')
+    Dir.mkdir(@chapters_dir)
+    Dir.mkdir(@epub_dir)
+    create_chapter_files
+    create_opf_and_nav
+  end
+
+  def teardown
+    FileUtils.remove_entry(@tmp)
+  end
+
+  def test_half_chapter_sorting_and_labels
+    result = EpubTools::AddChapters.new(chapters_dir: @chapters_dir, oebps_dir: @epub_dir).run
+
+    assert_equal %w[chapter_1.xhtml chapter_1_5.xhtml chapter_2.xhtml], result
+  end
+
+  def test_half_chapter_nav_label
+    EpubTools::AddChapters.new(chapters_dir: @chapters_dir, oebps_dir: @epub_dir).run
+
+    nav_doc = Nokogiri::XML(File.read(File.join(@epub_dir, 'nav.xhtml')))
+    nav_doc.remove_namespaces!
+    links = nav_doc.xpath('//nav/ol/li/a')
+
+    assert_equal 'Chapter 1', links[0].text
+    assert_equal 'Chapter 1.5', links[1].text
+    assert_equal 'Chapter 2', links[2].text
+  end
+
+  def test_half_chapter_opf_id
+    EpubTools::AddChapters.new(chapters_dir: @chapters_dir, oebps_dir: @epub_dir).run
+
+    doc = Nokogiri::XML(File.read(File.join(@epub_dir, 'package.opf')))
+    ids = doc.xpath('//xmlns:manifest/xmlns:item').map { |i| i['id'] }
+
+    assert_includes ids, 'chap1_5'
+  end
+
+  private
+
+  def create_chapter_files
+    File.write(File.join(@chapters_dir, 'chapter_1.xhtml'), '<html><body>Ch1</body></html>')
+    File.write(File.join(@chapters_dir, 'chapter_1_5.xhtml'), '<html><body>Ch1.5</body></html>')
+    File.write(File.join(@chapters_dir, 'chapter_2.xhtml'), '<html><body>Ch2</body></html>')
+  end
+
+  def create_opf_and_nav
+    File.write(File.join(@epub_dir, 'package.opf'), <<~XML)
+      <?xml version="1.0"?>
+      <package xmlns="http://www.idpf.org/2007/opf" version="3.0" unique-identifier="pub-id" xml:lang="en">
+        <metadata xmlns:dc="http://purl.org/dc/elements/1.1/"></metadata>
+        <manifest></manifest>
+        <spine></spine>
+      </package>
+    XML
+    File.write(File.join(@epub_dir, 'nav.xhtml'), <<~XHTML)
+      <?xml version="1.0" encoding="utf-8"?>
+      <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" lang="en">
+        <body>
+          <nav epub:type="toc" id="toc"><ol></ol></nav>
+        </body>
+      </html>
+    XHTML
+  end
 end

data/test/append_book_test.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+require_relative '../lib/epub_tools/append_book'
+
+class AppendBookTest < Minitest::Test
+  def setup
+    @tmp = Dir.mktmpdir
+    @source = File.join(@tmp, 'src')
+    @target = File.join(@tmp, 'target.epub')
+    FileUtils.mkdir_p(@source)
+    FileUtils.touch(@target)
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmp)
+  end
+
+  def test_initialize_assigns_attributes
+    ab = build_append_book(verbose: true)
+
+    assert_equal @source, ab.source_dir
+    assert_equal File.expand_path(@target), ab.target_epub
+    assert_equal @tmp, ab.build_dir
+    assert ab.verbose
+  end
+
+  def test_default_build_dir
+    ab = EpubTools::AppendBook.new(source_dir: @source, target_epub: @target)
+
+    assert ab.build_dir.end_with?('.epub_tools_build')
+  end
+
+  def test_log_outputs_when_verbose
+    ab = build_append_book(verbose: true)
+
+    assert_output("hello\n") { ab.send(:log, 'hello') }
+  end
+
+  def test_log_silent_when_not_verbose
+    ab = build_append_book(verbose: false)
+
+    assert_silent { ab.send(:log, 'hello') }
+  end
+
+  def test_detect_conflicts_raises_on_overlap
+    ab = build_append_book
+    setup_conflict_dirs(ab, new_chapters: [1, 2], existing_chapters: [1])
+
+    error = assert_raises(ArgumentError) { ab.send(:detect_conflicts) }
+    assert_match(/chapters 1 already exist/, error.message)
+  end
+
+  def test_detect_conflicts_passes_with_no_overlap
+    ab = build_append_book
+    setup_conflict_dirs(ab, new_chapters: [5], existing_chapters: [1, 2])
+
+    ab.send(:detect_conflicts)
+  end
+
+  def test_detect_conflicts_with_half_chapters
+    ab = build_append_book
+    chapters_dir = File.join(@tmp, 'chapters')
+    oebps_dir = File.join(@tmp, 'epub', 'OEBPS')
+    FileUtils.mkdir_p([chapters_dir, oebps_dir])
+
+    FileUtils.touch(File.join(chapters_dir, 'chapter_3_5.xhtml'))
+    FileUtils.touch(File.join(oebps_dir, 'chapter_3_5.xhtml'))
+
+    workspace = ab.instance_variable_get(:@workspace)
+    workspace.instance_variable_set(:@chapters_dir, chapters_dir)
+    workspace.instance_variable_set(:@epub_dir, File.join(@tmp, 'epub'))
+
+    error = assert_raises(ArgumentError) { ab.send(:detect_conflicts) }
+    assert_match(/3\.5 already exist/, error.message)
+  end
+
+  def test_run_completes_workflow
+    ab = build_append_book
+
+    def ab.prepare_epub; end
+    def ab.extract_xhtmls; end
+    def ab.split_xhtmls; end
+    def ab.validate_chapters; end
+    def ab.before_add_chapters; end
+    def ab.add_chapters; end
+    def ab.pack_epub; end
+
+    result = ab.run
+
+    assert_equal File.expand_path(@target), result
+  end
+
+  def test_backup_creates_bak_file
+    File.write(@target, 'epub content')
+    ab = build_append_book
+
+    ab.send(:backup_target)
+
+    backup_path = "#{File.expand_path(@target)}.bak"
+
+    assert_path_exists backup_path
+    assert_equal 'epub content', File.read(backup_path)
+  end
+
+  private
+
+  def build_append_book(verbose: false)
+    EpubTools::AppendBook.new(
+      source_dir: @source, target_epub: @target,
+      build_dir: @tmp, verbose: verbose
+    )
+  end
+
+  def setup_conflict_dirs(append_book, new_chapters:, existing_chapters:)
+    chapters_dir = File.join(@tmp, 'chapters')
+    oebps_dir = File.join(@tmp, 'epub', 'OEBPS')
+    FileUtils.mkdir_p([chapters_dir, oebps_dir])
+
+    new_chapters.each { |n| FileUtils.touch(File.join(chapters_dir, "chapter_#{n}.xhtml")) }
+    existing_chapters.each { |n| FileUtils.touch(File.join(oebps_dir, "chapter_#{n}.xhtml")) }
+
+    workspace = append_book.instance_variable_get(:@workspace)
+    workspace.instance_variable_set(:@chapters_dir, chapters_dir)
+    workspace.instance_variable_set(:@epub_dir, File.join(@tmp, 'epub'))
+  end
+end

data/test/chapter_validator_test.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+require_relative '../lib/epub_tools/chapter_validator'
+
+class ChapterValidatorTest < Minitest::Test
+  def setup
+    @tmp = Dir.mktmpdir
+    @validator = EpubTools::ChapterValidator.new(chapters_dir: @tmp)
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmp)
+  end
+
+  def test_validates_complete_sequence
+    create_chapter_files([1, 2, 3, 4, 5])
+
+    assert_silent { @validator.validate }
+  end
+
+  def test_raises_on_missing_chapters
+    create_chapter_files([1, 2, 4, 5]) # Missing 3
+
+    error = assert_raises(RuntimeError) { @validator.validate }
+    assert_match(/Missing chapter numbers: 3/, error.message)
+  end
+
+  def test_raises_on_no_chapters
+    error = assert_raises(RuntimeError) { @validator.validate }
+    assert_match(/No chapter files found/, error.message)
+  end
+
+  def test_handles_non_sequential_start
+    create_chapter_files([5, 6, 7, 8])
+
+    assert_silent { @validator.validate }
+  end
+
+  def test_validates_sequence_with_half_chapters
+    create_chapter_files([1, 2, 3])
+    create_half_chapter_files([2])
+
+    assert_silent { @validator.validate }
+  end
+
+  def test_validates_sequence_without_half_chapters_present
+    create_chapter_files([1, 2, 3])
+
+    assert_silent { @validator.validate }
+  end
+
+  def test_raises_on_missing_integer_despite_half_chapter
+    create_chapter_files([1, 3]) # Missing 2
+    create_half_chapter_files([1])
+
+    error = assert_raises(RuntimeError) { @validator.validate }
+    assert_match(/Missing chapter numbers: 2/, error.message)
+  end
+
+  private
+
+  def create_chapter_files(numbers)
+    numbers.each do |num|
+      File.write(File.join(@tmp, "chapter_#{num}.xhtml"), '<html></html>')
+    end
+  end
+
+  def create_half_chapter_files(numbers)
+    numbers.each do |num|
+      File.write(File.join(@tmp, "chapter_#{num}_5.xhtml"), '<html></html>')
+    end
+  end
+end

data/test/cli/command_registry_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require_relative '../../lib/epub_tools'
 

data/test/cli/option_builder_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require_relative '../../lib/epub_tools'
 require 'stringio'
@@ -41,17 +43,13 @@ class OptionBuilderTest < Minitest::Test
   def test_with_input_file
     @builder.with_input_file('Test input')
 
-    assert_includes @builder.parser.to_s, '-i, --input-file FILE'
-    assert_includes @builder.parser.to_s, 'Test input (required)'
+    verify_parser_option_format('-i, --input-file FILE', 'Test input (required)')
 
-    # Test with required=false
     builder2 = EpubTools::CLI::OptionBuilder.new
-    builder2.with_input_file('Test input', false)
+    builder2.with_input_file('Test input', required: false)
 
-    assert_includes builder2.parser.to_s, 'Test input'
-    refute_includes builder2.parser.to_s, 'Test input (required)'
+    verify_optional_parser_format(builder2, 'Test input')
 
-    # Test with actual parsing
     @builder.parse(['-i', 'file.txt'])
 
     assert_equal 'file.txt', @builder.options[:input_file]
@@ -69,20 +67,16 @@ class OptionBuilderTest < Minitest::Test
   end
 
   def test_with_output_dir
-    # Test with default value
     @builder.with_output_dir('Test output dir', 'default/path')
 
-    assert_includes @builder.parser.to_s, '-o, --output-dir DIR'
-    assert_includes @builder.parser.to_s, 'Test output dir (default: default/path)'
+    verify_parser_option_format('-o, --output-dir DIR', 'Test output dir (default: default/path)')
+
     assert_equal 'default/path', @builder.options[:output_dir]
 
-    # Test without default
     builder2 = EpubTools::CLI::OptionBuilder.new
     builder2.with_output_dir('Test output dir')
+    verify_required_parser_format(builder2, 'Test output dir (required)')
 
-    assert_includes builder2.parser.to_s, 'Test output dir (required)'
-
-    # Test actual parsing
     @builder.parse(['-o', 'new/path'])
 
     assert_equal 'new/path', @builder.options[:output_dir]
@@ -170,4 +164,20 @@ class OptionBuilderTest < Minitest::Test
 
     assert_equal @builder, result
   end
+
+  private
+
+  def verify_parser_option_format(option_format, description)
+    assert_includes @builder.parser.to_s, option_format
+    assert_includes @builder.parser.to_s, description
+  end
+
+  def verify_optional_parser_format(builder, description)
+    assert_includes builder.parser.to_s, description
+    refute_includes builder.parser.to_s, "#{description} (required)"
+  end
+
+  def verify_required_parser_format(builder, description)
+    assert_includes builder.parser.to_s, description
+  end
 end

data/test/cli/runner_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require_relative '../../lib/epub_tools'
 require 'stringio'
@@ -33,15 +35,18 @@ class RunnerTest < Minitest::Test
   end
 
   def test_handle_command
-    assert_output(/Usage: test-program test-cmd/) do
-      assert_raises(SystemExit) { @runner.handle_command('test-cmd', ['-h']) }
+    @runner.registry.register('add', TestCommand)
+
+    assert_output(/Usage: test-program add/) do
+      assert_raises(SystemExit) { @runner.handle_command('add', ['-h']) }
     end
   end
 
   def test_handle_command_with_required_args
     runner = EpubTools::CLI::Runner.new('test-program')
-    runner.registry.register('test-cmd', TestCommand)
-    assert_output("Called!\n") { assert runner.handle_command('test-cmd') }
+    runner.registry.register('add', TestCommand)
+
+    assert_output("Called!\n") { assert runner.handle_command('add') }
   end
 
   def test_handle_nonexistent_command
@@ -69,18 +74,13 @@ class RunnerTest < Minitest::Test
   end
 
   def test_configure_command_options
-    # This is testing a private method, which is generally not recommended,
-    # but it's useful to ensure all command configurations work
+    # Test command configuration through public interface
+    @runner.registry.register('add', TestCommand)
 
-    # Use send to access private method
-    builder = EpubTools::CLI::OptionBuilder.new
-
-    # Test each command configuration - we'll just check one example
-    @runner.send(:configure_command_options, 'add', builder)
-
-    # Check add command options were added
-    assert_includes builder.parser.to_s, '--chapters-dir DIR'
-    assert_includes builder.parser.to_s, '--oebps-dir DIR'
+    # Should show help without errors
+    assert_output(/Usage: test-program add/) do
+      assert_raises(SystemExit) { @runner.handle_command('add', ['-h']) }
+    end
   end
 
   def test_run_with_unknown_command

data/test/cli_commands_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'fileutils'
 require 'tempfile'
@@ -20,6 +22,7 @@ class CLICommandsTest < Minitest::Test
     assert_includes output, 'pack'
     assert_includes output, 'unpack'
     assert_includes output, 'compile'
+    assert_includes output, 'append'
   end
 
   def test_show_version
@@ -90,6 +93,14 @@ class CLICommandsTest < Minitest::Test
     assert_includes output, '--output-file FILE'
   end
 
+  def test_append_command
+    output = `#{@bin_path} append --help`
+
+    assert_match(/Usage: epub-tools append \[options\]/, output)
+    assert_includes output, '--source-dir DIR'
+    assert_includes output, '--target-epub FILE'
+  end
+
   def test_unpack_command
     output = `#{@bin_path} unpack --help`
 

data/test/cli_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require_relative 'cli/command_registry_test'
 require_relative 'cli/option_builder_test'

data/test/cli_version_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require_relative '../lib/epub_tools/version'
 require 'open3'