cbz_tools 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96ee68c0b79bcb1256324ad692bf441f0926443ab71e87db3715c0ca5c89cac0
-  data.tar.gz: 15d6235b0d040d8836a752da8e304bb89d2fd0976f9eb371f6f514b6dd8c97c4
+  metadata.gz: 30f58af31425d78057d97105cfe21164b6ec05263f0b86d2b2a0dca150792d5d
+  data.tar.gz: edd397b9588670cd49a3bcfe517f684ae9f684f4469a9725d1ac440f00da0fbe
 SHA512:
-  metadata.gz: dfaee61a3965d6901835d58ca0206ee5bd5f4a05eb1ffb00d2248ca16755aeb1d418b54f3550fe9ef6d0d125aff393955aec459990a279259bc05d874e7d1adc
-  data.tar.gz: 7e2e12a38206a9a6ea43d49eb4474a60770d094c48d47746a3cb6f249496abf382af564caacd41e5426684077a23135018ef108795232c87e592a835740ef435
+  metadata.gz: 57e09be8a89fec63e2cb22b140c6500afa29a0363a1f0e7b1b6d5ef75b9a137e4f6da4b1012031d18b2875db856e73145ded2fabf8532a6080d9f80d9ff98894
+  data.tar.gz: 73deffc4ac234b2288b2b8c5898cd12dc005561b79a7b5941cfb052ace8766fef6227bf935b6835226381f679d0bfb5fd2f9553fc68fd8cb2bc5ce309e7bfd45

data/.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-  "cSpell.words": ["comicinfo", "gtin", "penciller"]
+  "cSpell.words": ["comicinfo", "gtin", "penciller", "unrar"]
 }

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.5.0] - 2026-08-04
+
+- `CbzTools::CbrConverter` now uses `unrar` directly — no extractor param required.
+- **Breaking**: Removed `extractor:` param, `ExtractionError`, and `extractor` attribute.
+- Runtime check raises `ArchiveError` if `unrar` is not in PATH.
+
 ## [0.4.0] - 2026-08-03
 
 - Add `CbzTools::CbrConverter` for converting CBR archives to CBZ. The gem ships the orchestration (extract → repack → error model) but no default extractor — callers pass `extractor:` (anything responding to `call(cbr_path, destination_dir)` and raising `ExtractionError` on failure).

data/README.md

@@ -38,37 +38,17 @@ end
 
 ### Converting CBR to CBZ
 
-`CbzTools::CbrConverter` orchestrates the extract → repack → CBZ step,
-but it does **not** ship an extractor. Pass anything responding to
-`call(cbr_path, destination_dir)` (and that raises `ExtractionError`
-on failure):
+`CbzTools::CbrConverter` converts CBR archives to CBZ using the `unrar`
+command-line tool (which must be installed on your system).
 
 ```ruby
-extractor = MyApp::UnrarExtractor.new
-CbzTools::CbrConverter.convert("path/to/comic.cbr",
-  to: "path/to/comic.cbz",
-  extractor: extractor)
-```
-
-Reuse one extractor across many conversions with `work_in:` to pool
-the tmpdir:
-
-```ruby
-extractor = MyApp::UnrarExtractor.new
-work_in   = Dir.mktmpdir("batch")
-converter = CbzTools::CbrConverter.new(extractor: extractor)
-
-paths.each do |cbr|
-  converter.convert(cbr, to: cbr.sub(/\.cbr\z/i, ".cbz"), work_in: work_in)
-end
+CbzTools::CbrConverter.convert("path/to/comic.cbr", to: "path/to/comic.cbz")
 ```
 
 Errors inherit from `CbzTools::Error`:
 
-- `CbzTools::CbrConverter::ExtractionError` — the extractor failed.
-- `CbzTools::CbrConverter::ArchiveError` — no extractor supplied,
-  the destination couldn't be written, or `overwrite: false` and the
-  destination already exists.
+- `CbzTools::CbrConverter::ArchiveError` — the destination couldn't be written,
+  `overwrite: false` and the destination already exists, or `unrar` is not installed.
 
 ## Development
 

data/lib/cbz_tools/cbr_converter.rb

@@ -4,45 +4,28 @@ require "tmpdir"
 require "fileutils"
 require "zip"
 require "pathname"
+require "open3"
+
+require_relative "system_dependencies"
 
 module CbzTools
   # Converts a CBR (Comic Book RAR) archive into a CBZ (Comic Book ZIP)
   # archive.
   #
-  # The CBR extraction step is delegated to an injectable +extractor+
-  # — anything that responds to +call(cbr_path, destination_dir)+ and
-  #   raises {CbzTools::CbrConverter::ExtractionError} on failure. Callers (not this gem) own the
-  # extractor; this class is deliberately agnostic about which binary,
-  # library, or pure-Ruby implementation is used to expand the source.
+  # Extraction is handled internally using the +unrar+ command-line tool,
+  # which must be installed on the system. Consumers do not need to
+  # install or configure any extraction backend.
   #
-  # @example Single-shot conversion with an explicit extractor
-  #   extractor = MyApp::UnrarExtractor.new
-  #   CbzTools::CbrConverter.convert("path/to/comic.cbr",
-  #     to: "path/to/comic.cbz",
-  #     extractor: extractor)
+  # @example Single-shot conversion
+  #   CbzTools::CbrConverter.convert("path/to/comic.cbr", to: "path/to/comic.cbz")
   #
-  # @example Reusing one extractor across many conversions
-  #   extractor = MyApp::UnrarExtractor.new
-  #   converter = CbzTools::CbrConverter.new(extractor: extractor)
+  # @example Reusing one converter across many conversions
+  #   converter = CbzTools::CbrConverter.new
   #   paths.each { |p| converter.convert(p, to: p.sub(/\.cbr\z/i, ".cbz")) }
   class CbrConverter
-    # Raised when the underlying extractor fails to expand the source
-    # CBR into a directory. Propagated untouched so callers can rescue
-    # it without unwrapping.
-    class ExtractionError < Error
-    end
-
-    # Raised when the resulting CBZ cannot be written, when the
-    # destination already exists and +overwrite:+ is false, or when no
-    # +extractor:+ was supplied. Propagated untouched from the
-    # relevant step.
     class ArchiveError < Error
     end
 
-    # @return [#call, nil] the configured extractor, or +nil+ if none
-    #   was supplied. Read-only; there is no corresponding writer.
-    attr_reader :extractor
-
     # @see #convert
     #
     # @param cbr_path [String] source CBR path
@@ -53,39 +36,18 @@ module CbzTools
     #   a fresh +Dir.mktmpdir+ is created and cleaned up. When set, the
     #   converter uses that directory and leaves cleanup to the caller
     #   (useful when batching many conversions).
-    # @param extractor [#call] extractor backend; required.
     # @return [String] the destination CBZ path
-    # @raise [ArchiveError] when +extractor:+ is missing or target cannot be written
-    # @raise [ExtractionError] when the extractor fails
-    def self.convert(cbr_path, to:, overwrite: true, work_in: nil, extractor: nil)
-      new(extractor: extractor).convert(cbr_path, to: to, overwrite: overwrite, work_in: work_in)
+    # @raise [ArchiveError] when target cannot be written or unrar is unavailable
+    def self.convert(cbr_path, to:, overwrite: true, work_in: nil)
+      new.convert(cbr_path, to: to, overwrite: overwrite, work_in: work_in)
     end
 
-    # @param extractor [#call, nil] anything responding to
-    #   +call(cbr_path, destination_dir)+ that raises {ExtractionError}
-    #   on failure. Required — {#convert} raises {ArchiveError} if left
-    #   as +nil+.
-    def initialize(extractor: nil)
-      @extractor = extractor
-    end
-
-    # @see .convert
-    #
-    # @param cbr_path [String] source CBR path
-    # @param to [String] destination CBZ path
-    # @param overwrite [Boolean] when false, raise {ArchiveError} if
-    #   +to+ already exists; default true
-    # @param work_in [String, nil] see {.convert}
-    # @return [String] the destination CBZ path
-    # @raise [ArchiveError] when no extractor was configured or target cannot be written
-    # @raise [ExtractionError] when the extractor fails
     def convert(cbr_path, to:, overwrite: true, work_in: nil)
-      ensure_extractor!
       ensure_target_slot!(to, overwrite: overwrite)
       File.delete(to) if overwrite && File.exist?(to)
 
       in_workdir(work_in) do |temp_dir|
-        @extractor.call(cbr_path, temp_dir)
+        extract(cbr_path, temp_dir)
         repack(temp_dir, to)
       end
 
@@ -94,9 +56,17 @@ module CbzTools
 
     private
 
-    def ensure_extractor!
-      raise ArchiveError,
-        "No extractor configured; pass `extractor:` to CbrConverter.convert or CbrConverter.new" unless @extractor
+    def extract(cbr_path, destination)
+      unrar = SystemDependencies.unrar!
+      _, stderr, status = Open3.capture3(unrar, "x", "-o+", cbr_path, "#{destination}/")
+
+      unless status.success?
+        raise ArchiveError, "unrar failed: #{stderr}"
+      end
+    rescue SystemDependencies::MissingExecutableError => e
+      raise ArchiveError, e.message
+    rescue => e
+      raise ArchiveError, "Failed to extract CBR: #{e.message}"
     end
 
     def ensure_target_slot!(to, overwrite:)
@@ -133,4 +103,4 @@ module CbzTools
       zipfile.add(relative, file_path)
     end
   end
-end
+end

data/lib/cbz_tools/system_dependencies.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CbzTools
+  module SystemDependencies
+    class MissingExecutableError < StandardError; end
+
+    def self.find_executable(name)
+      extensions = Gem.win_platform? ? ENV.fetch("PATHEXT", "").split(";") : [""]
+
+      ENV.fetch("PATH", "").split(File::PATH_SEPARATOR).each do |directory|
+        extensions.each do |extension|
+          path = File.join(directory, "#{name}#{extension}")
+          return path if File.file?(path) && File.executable?(path)
+        end
+      end
+
+      nil
+    end
+
+    def self.unrar!
+      find_executable("unrar") ||
+        raise(
+          MissingExecutableError,
+          "`unrar` is required for CBR conversion but was not found in PATH. " \
+          "Install unrar using your system's package manager."
+        )
+    end
+  end
+end

data/lib/cbz_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CbzTools
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cbz_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Figueroa
@@ -55,6 +55,7 @@ files:
 - lib/cbz_tools/comic_info.rb
 - lib/cbz_tools/error.rb
 - lib/cbz_tools/reader.rb
+- lib/cbz_tools/system_dependencies.rb
 - lib/cbz_tools/version.rb
 - sig/cbz_tools.rbs
 homepage: https://github.com/dmfigueroa/cbz_tools
@@ -78,7 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- unrar executable available in PATH (for CBR conversion)
 rubygems_version: 4.0.17
 specification_version: 4
 summary: Read, extract, and edit metadata of CBZ comic archives, and convert CBR to