epub_tools 0.6.0 → 0.9.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub_tools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jaime Rodas
@@ -15,42 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.2'
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
 email:
 - rodas@hey.com
 executables:
@@ -76,42 +62,35 @@ files:
 - lib/epub_tools/add_chapters.rb
 - lib/epub_tools/append_book.rb
 - lib/epub_tools/book_builder.rb
-- lib/epub_tools/chapter_marker_detector.rb
+- lib/epub_tools/chapter_order.rb
 - lib/epub_tools/chapter_validator.rb
 - lib/epub_tools/cli.rb
-- lib/epub_tools/cli/command_options_configurator.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/compile_workspace.rb
-- lib/epub_tools/epub_configuration.rb
-- lib/epub_tools/epub_file_writer.rb
 - lib/epub_tools/epub_initializer.rb
-- lib/epub_tools/epub_metadata_builder.rb
 - lib/epub_tools/loggable.rb
 - lib/epub_tools/pack_ebook.rb
+- lib/epub_tools/pdf_converter.rb
+- lib/epub_tools/pdf_layout.rb
+- lib/epub_tools/set_cover.rb
 - lib/epub_tools/split_chapters.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
-- lib/epub_tools/xhtml_generator.rb
 - style.css
 - test/add_chapters_test.rb
 - test/append_book_test.rb
 - test/chapter_validator_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/compile_workspace_test.rb
 - test/epub_initializer_test.rb
 - test/pack_ebook_test.rb
+- test/pdf_converter_test.rb
+- test/pdf_layout_test.rb
+- test/set_cover_test.rb
 - test/split_chapters_test.rb
 - test/style_finder_test.rb
 - test/test_helper.rb
@@ -132,14 +111,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Tools to extract, split, and compile EPUB books
 test_files: []

data/lib/epub_tools/chapter_marker_detector.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module EpubTools
-  # Detects chapter boundary markers in XHTML nodes.
-  # Recognizes: "Chapter N", "Chapter N (continued)", and "Prologue".
-  class ChapterMarkerDetector
-    # Tags that can contain chapter markers
-    MARKER_TAGS = %w[p span h2 h3 h4].freeze
-    # Tags that can contain prologue markers
-    PROLOGUE_TAGS = %w[h3 h4].freeze
-
-    # Detect what type of chapter marker a node represents
-    # @param node [Nokogiri::XML::Node] The XHTML node to check
-    # @return [Symbol, nil] :chapter, :continued, :prologue, or nil
-    def detect(node)
-      if continued_marker?(node)
-        :continued
-      elsif chapter_marker?(node)
-        :chapter
-      elsif prologue_marker?(node)
-        :prologue
-      end
-    end
-
-    # Extract the chapter number from a node's text
-    # @param node [Nokogiri::XML::Node] A node containing "Chapter N" text
-    # @return [Integer] The chapter number
-    def extract_chapter_number(node)
-      node.text.match(/Chapter\s+(\d+)/i)[1].to_i
-    end
-
-    private
-
-    def continued_marker?(node)
-      MARKER_TAGS.include?(node.name) && node.text.match?(/Chapter\s+\d+\s*\(continued\)/i)
-    end
-
-    def chapter_marker?(node)
-      MARKER_TAGS.include?(node.name) && node.text.match?(/Chapter\s+\d+/i) && !continued_marker?(node)
-    end
-
-    def prologue_marker?(node)
-      PROLOGUE_TAGS.include?(node.name) && node.text.strip.match?(/\APrologue\z/i)
-    end
-  end
-end

data/lib/epub_tools/cli/command_options_configurator.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-module EpubTools
-  module CLI
-    # Handles command-specific option configuration for CLI commands
-    class CommandOptionsConfigurator
-      # Configure command-specific options using dynamic dispatch
-      # @param cmd [String] Command name
-      # @param builder [OptionBuilder] Option builder instance
-      def configure(cmd, builder)
-        method_name = "configure_#{cmd.tr('-', '_')}_options"
-        raise ArgumentError, "Unknown command: #{cmd}" unless respond_to?(method_name, true)
-
-        send(method_name, builder)
-      end
-
-      private
-
-      # Configure options for the 'add' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_add_options(builder)
-        builder.with_custom_options do |opts, options|
-          opts.on('-c DIR', '--chapters-dir DIR', 'Chapters directory (required)') { |v| options[:chapters_dir] = v }
-          opts.on('-e DIR', '--oebps-dir DIR', 'EPUB OEBPS directory (required)') { |v| options[:oebps_dir] = v }
-        end
-      end
-
-      # Configure options for the 'extract' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_extract_options(builder)
-        builder.with_custom_options do |opts, options|
-          opts.on('-s DIR', '--source-dir DIR', 'Directory with EPUBs to extract XHTMLs from (required)') do |v|
-            options[:source_dir] = v
-          end
-          opts.on('-t DIR', '--target-dir DIR',
-                  'Directory where the XHTML files will be extracted to (required)') do |v|
-            options[:target_dir] = v
-          end
-        end.with_verbose_option
-      end
-
-      # Configure options for the 'split' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_split_options(builder)
-        builder.with_custom_options do |opts, options|
-          add_split_input_options(opts, options)
-          add_split_output_options(opts, options)
-        end.with_verbose_option
-      end
-
-      def add_split_input_options(opts, options)
-        opts.on('-i FILE', '--input FILE', 'Source XHTML file (required)') { |v| options[:input_file] = v }
-        opts.on('-t TITLE', '--title TITLE', 'Book title for HTML <title> tags (required)') do |v|
-          options[:book_title] = v
-        end
-      end
-
-      def add_split_output_options(opts, options)
-        opts.on('-o DIR', '--output-dir DIR',
-                "Output directory for chapter files (default: #{options[:output_dir]})") do |v|
-          options[:output_dir] = v
-        end
-        opts.on('-p PREFIX', '--prefix PREFIX', "Filename prefix for chapters (default: #{options[:prefix]})") do |v|
-          options[:prefix] = v
-        end
-      end
-
-      # Configure options for the 'init' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_init_options(builder)
-        builder.with_title_option
-               .with_author_option
-               .with_custom_options do |opts, options|
-                 opts.on('-o DIR', '--output-dir DIR', 'Destination EPUB directory (required)') do |v|
-                   options[:destination] = v
-                 end
-               end.with_cover_option
-      end
-
-      # Configure options for the 'pack' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_pack_options(builder)
-        builder.with_input_dir('EPUB directory to package')
-               .with_output_file('Output EPUB file path')
-               .with_verbose_option
-      end
-
-      # Configure options for the 'unpack' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_unpack_options(builder)
-        builder.with_custom_options do |opts, options|
-          opts.on('-i FILE', '--input-file FILE', 'EPUB file to unpack (required)') { |v| options[:epub_file] = v }
-          opts.on('-o DIR', '--output-dir DIR', 'Output directory to extract into (default: basename of epub)') do |v|
-            options[:output_dir] = v
-          end
-        end.with_verbose_option
-      end
-
-      # Configure options for the 'append' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_append_options(builder)
-        builder.with_custom_options do |opts, options|
-          opts.on('-s DIR', '--source-dir DIR', 'Directory with EPUBs to append (required)') do |v|
-            options[:source_dir] = v
-          end
-          opts.on('-t FILE', '--target-epub FILE', 'Existing EPUB file to append to (required)') do |v|
-            options[:target_epub] = v
-          end
-        end.with_verbose_option
-      end
-
-      # Configure options for the 'compile' command
-      # @param builder [OptionBuilder] Option builder instance
-      def configure_compile_options(builder)
-        builder.with_title_option
-               .with_author_option
-               .with_custom_options do |opts, options|
-                 opts.on('-s DIR', '--source-dir DIR', 'Directory with EPUBs to extract XHTMLs from (required)') do |v|
-                   options[:source_dir] = v
-                 end
-                 opts.on('-o FILE', '--output FILE', 'EPUB to create (default: book title in source dir)') do |v|
-                   options[:output_file] = v
-                 end
-               end.with_cover_option.with_verbose_option
-      end
-    end
-  end
-end

data/lib/epub_tools/cli/command_registry.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module EpubTools
-  module CLI
-    # Manages the registration and retrieval of commands
-    class CommandRegistry
-      attr_reader :commands
-
-      def initialize
-        @commands = {}
-      end
-
-      # Register a new command in the registry
-      # @param name [String] the command name
-      # @param command_class [Class] the class that implements the command
-      # @param required_keys [Array<Symbol>] keys that must be present in options
-      # @param default_options [Hash] default options for the command
-      # @return [self]
-      def register(name, command_class, required_keys = [], default_options = {})
-        @commands[name] = {
-          class: command_class,
-          required_keys: required_keys,
-          default_options: default_options
-        }
-        self
-      end
-
-      # Get a command by name
-      # @param name [String] the command name
-      # @return [Hash, nil] the command configuration or nil if not found
-      def get(name)
-        @commands[name]
-      end
-
-      # Get all available command names
-      # @return [Array<String>] list of registered command names
-      def available_commands
-        @commands.keys
-      end
-
-      # Check if a command is registered
-      # @param name [String] the command name
-      # @return [Boolean] true if command exists
-      def command_exists?(name)
-        @commands.key?(name)
-      end
-    end
-  end
-end

data/lib/epub_tools/cli/option_builder.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-
-module EpubTools
-  module CLI
-    # Builds and manages command line options
-    class OptionBuilder
-      attr_reader :options, :required_keys, :parser
-
-      # Initialize a new OptionBuilder
-      # @param default_options [Hash] Default options to start with
-      # @param required_keys [Array<Symbol>] Keys that must be present in the final options
-      def initialize(default_options = {}, required_keys = [])
-        @options = default_options.dup
-        @required_keys = required_keys
-        @parser = OptionParser.new
-      end
-
-      # Add banner to the option parser
-      # @param text [String] Banner text
-      # @return [self] for method chaining
-      def with_banner(text)
-        @parser.banner = text
-        self
-      end
-
-      # Add help option to the parser
-      # @return [self] for method chaining
-      def with_help_option
-        @parser.on('-h', '--help', 'Print this help') do
-          puts @parser
-          exit
-        end
-        self
-      end
-
-      # Add verbose option to the parser
-      # @return [self] for method chaining
-      def with_verbose_option
-        @options[:verbose] = true unless @options.key?(:verbose)
-        @parser.on('-q', '--quiet', 'Run quietly (default: verbose)') { |v| @options[:verbose] = !v }
-        self
-      end
-
-      # Add input file option to the parser
-      # @param description [String] Option description
-      # @param required [Boolean] Whether this option is required
-      # @return [self] for method chaining
-      def with_input_file(description = 'Input file', required: true)
-        desc = required ? "#{description} (required)" : description
-        @parser.on('-i FILE', '--input-file FILE', desc) { |v| @options[:input_file] = v }
-        self
-      end
-
-      # Add input directory option to the parser
-      # @param description [String] Option description
-      # @param required [Boolean] Whether this option is required
-      # @return [self] for method chaining
-      def with_input_dir(description = 'Input directory', required: true)
-        desc = required ? "#{description} (required)" : description
-        @parser.on('-i DIR', '--input-dir DIR', desc) { |v| @options[:input_dir] = v }
-        self
-      end
-
-      # Add output directory option to the parser
-      # @param description [String] Option description
-      # @param default [String, nil] Default value
-      # @return [self] for method chaining
-      def with_output_dir(description = 'Output directory', default = nil)
-        if default
-          desc = "#{description} (default: #{default})"
-          @options[:output_dir] = default unless @options.key?(:output_dir)
-        else
-          desc = "#{description} (required)"
-        end
-        @parser.on('-o DIR', '--output-dir DIR', desc) { |v| @options[:output_dir] = v }
-        self
-      end
-
-      # Add output file option to the parser
-      # @param description [String] Option description
-      # @param required [Boolean] Whether this option is required
-      # @return [self] for method chaining
-      def with_output_file(description = 'Output file', required: true)
-        desc = required ? "#{description} (required)" : description
-        @parser.on('-o FILE', '--output-file FILE', desc) { |v| @options[:output_file] = v }
-        self
-      end
-
-      # Add title option to the parser
-      # @return [self] for method chaining
-      def with_title_option
-        @parser.on('-t TITLE', '--title TITLE', 'Book title (required)') { |v| @options[:title] = v }
-        self
-      end
-
-      # Add author option to the parser
-      # @return [self] for method chaining
-      def with_author_option
-        @parser.on('-a AUTHOR', '--author AUTHOR', 'Author name (required)') { |v| @options[:author] = v }
-        self
-      end
-
-      # Add cover option to the parser
-      # @return [self] for method chaining
-      def with_cover_option
-        @parser.on('-c PATH', '--cover PATH', 'Cover image file path (optional)') { |v| @options[:cover_image] = v }
-        self
-      end
-
-      # Add a custom option to the parser
-      # @param short [String] Short option flag
-      # @param long [String] Long option flag
-      # @param description [String] Option description
-      # @param option_key [Symbol] Key in the options hash
-      # @param block [Proc] Optional block for custom processing
-      # @return [self] for method chaining
-      def with_option(short, long, description, option_key)
-        @parser.on(short, long, description) do |v|
-          @options[option_key] = block_given? ? yield(v) : v
-        end
-        self
-      end
-
-      # Add a custom block to configure options
-      # @yield [OptionParser, Hash] Yields the parser and options hash
-      # @return [self] for method chaining
-      def with_custom_options
-        yield @parser, @options if block_given?
-        self
-      end
-
-      # Parse the command line arguments
-      # @param args [Array<String>] Command line arguments
-      # @return [Hash] Parsed options
-      # @raise [SystemExit] If required options are missing
-      def parse(args = ARGV)
-        begin
-          @parser.parse!(args.dup)
-          validate_required_keys
-        rescue ArgumentError => e
-          abort "#{e.message}\n#{@parser}"
-        end
-        @options
-      end
-
-      private
-
-      # Validate that all required keys are present in the options
-      # @raise [SystemExit] If required options are missing
-      def validate_required_keys
-        return if @required_keys.empty?
-
-        missing = @required_keys.select { |k| @options[k].nil? }
-        return if missing.empty?
-
-        raise ArgumentError, "Missing required options: #{missing_keys(missing)}"
-      end
-
-      def missing_keys(keys)
-        keys.map { |k| "--#{k.to_s.tr('_', '-')}" }.join(', ')
-      end
-    end
-  end
-end

data/lib/epub_tools/cli/runner.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'command_registry'
-require_relative 'option_builder'
-require_relative 'command_options_configurator'
-
-module EpubTools
-  module CLI
-    # Main runner for the CLI application
-    class Runner
-      attr_reader :registry, :program_name
-
-      # Initialize a new CLI Runner
-      # @param program_name [String] Name of the program
-      def initialize(program_name = nil)
-        @registry = CommandRegistry.new
-        @program_name = program_name || File.basename($PROGRAM_NAME)
-        @options_configurator = CommandOptionsConfigurator.new
-      end
-
-      # Run the CLI application
-      # @param args [Array<String>] Command line arguments
-      # @return [Boolean] true if the command was run successfully
-      def run(args = ARGV)
-        handle_version_flag(args)
-        validate_command_args(args)
-
-        cmd = args.shift
-        handle_command(cmd, args)
-      end
-
-      # Handle a specific command
-      # @param cmd [String] Command name
-      # @param args [Array<String>] Command line arguments
-      # @return [Boolean] true if the command was run successfully
-      def handle_command(cmd, args = ARGV)
-        command_config = registry.get(cmd)
-        return false unless command_config
-
-        builder = build_option_parser(cmd, command_config)
-        execute_command(command_config, builder, args)
-      end
-
-      private
-
-      # Handle version flag and exit if present
-      # @param args [Array<String>] Command line arguments
-      def handle_version_flag(args)
-        return unless ['-v', '--version'].include?(args[0])
-
-        puts EpubTools::VERSION
-        exit 0
-      end
-
-      # Validate command arguments and exit if invalid
-      # @param args [Array<String>] Command line arguments
-      def validate_command_args(args)
-        commands = registry.available_commands
-        return unless args.empty? || !commands.include?(args[0])
-
-        print_usage(commands)
-        exit 1
-      end
-
-      # Build option parser for a command
-      # @param cmd [String] Command name
-      # @param command_config [Hash] Command configuration
-      # @return [OptionBuilder] Configured option builder
-      def build_option_parser(cmd, command_config)
-        options = command_config[:default_options].dup
-        required_keys = command_config[:required_keys]
-
-        builder = OptionBuilder.new(options, required_keys)
-                               .with_banner("Usage: #{program_name} #{cmd} [options]")
-                               .with_help_option
-
-        @options_configurator.configure(cmd, builder)
-        builder
-      end
-
-      # Execute a command with parsed options
-      # @param command_config [Hash] Command configuration
-      # @param builder [OptionBuilder] Option builder instance
-      # @param args [Array<String>] Command line arguments
-      # @return [Object] Command instance
-      def execute_command(command_config, builder, args)
-        options = builder.parse(args)
-        command_class = command_config[:class]
-        command_instance = command_class.new(options)
-        command_instance.run
-        command_instance
-      end
-
-      # Print usage information
-      # @param commands [Array<String>] Available commands
-      def print_usage(_commands)
-        puts "Usage: #{program_name} COMMAND [options]"
-        puts 'Commands:'
-        print_command_list
-      end
-
-      def print_command_list
-        puts '  init      Initialize a bare-bones EPUB'
-        puts '  extract   Extract XHTML files from EPUBs'
-        puts '  split     Split XHTML into separate XHTMLs per chapter'
-        puts '  add       Add chapter XHTML files into an EPUB'
-        puts '  pack      Package an EPUB directory into a .epub file'
-        puts '  unpack    Unpack an EPUB file into a directory'
-        puts '  compile   Takes EPUBs in a dir and splits, cleans, and compiles into a single EPUB.'
-        puts '  append    Extracts and splits EPUBs from a dir and appends them to an existing EPUB.'
-      end
-    end
-  end
-end

data/lib/epub_tools/compile_workspace.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-module EpubTools
-  # Manages the build workspace for book compilation
-  class CompileWorkspace
-    attr_reader :build_dir
-
-    def initialize(build_dir)
-      @build_dir = build_dir
-    end
-
-    # Cleans the build directory
-    def clean
-      FileUtils.rm_rf(@build_dir)
-    end
-
-    # Prepares all necessary directories
-    def prepare_directories
-      FileUtils.mkdir_p(xhtml_dir)
-      FileUtils.mkdir_p(chapters_dir)
-    end
-
-    # Gets the XHTML extraction directory
-    def xhtml_dir
-      @xhtml_dir ||= File.join(@build_dir, 'xhtml')
-    end
-
-    # Gets the chapters directory
-    def chapters_dir
-      @chapters_dir ||= File.join(@build_dir, 'chapters')
-    end
-
-    # Gets the EPUB build directory
-    def epub_dir
-      @epub_dir ||= File.join(@build_dir, 'epub')
-    end
-  end
-end