omnizip 0.3.9 → 0.3.10

data/lib/omnizip/archive_handlers/zip_handler.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Omnizip
+  module ArchiveHandlers
+    # Adapter that exposes the canonical +create+/+open+/+extract_to+
+    # /+list+ interface for the ZIP format. Wraps +Omnizip::Zip::File+.
+    class ZipHandler
+      def create(path, &block)
+        Omnizip::Zip::File.create(path, &block)
+      end
+
+      def open(path, &block)
+        Omnizip::Zip::File.open(path, &block)
+      end
+
+      def extract_to(path, output_dir, overwrite: false, **_)
+        extracted = []
+        Omnizip::Zip::File.open(path) do |zip|
+          zip.each do |entry|
+            dest_path = ::File.join(output_dir, entry.name)
+            on_exists = if overwrite
+                          proc { true }
+                        else
+                          proc { |_e, p| raise "File exists: #{p}" }
+                        end
+            zip.extract(entry, dest_path, &on_exists)
+            extracted << dest_path
+          end
+        end
+        extracted
+      end
+
+      def list(path, details: false, **_)
+        Omnizip::Zip::File.open(path) do |zip|
+          if details
+            zip.entries.map do |entry|
+              {
+                name: entry.name,
+                size: entry.size,
+                compressed_size: entry.compressed_size,
+                compression_method: entry.compression_method,
+                crc: entry.crc,
+                time: entry.time,
+                directory: entry.directory?,
+              }
+            end
+          else
+            zip.names
+          end
+        end
+      end
+
+      def read_entry(path, entry_name)
+        Omnizip::Zip::File.open(path) do |zip|
+          entry = zip.get_entry(entry_name)
+          raise Errno::ENOENT, "Entry not found: #{entry_name}" unless entry
+
+          zip.read(entry)
+        end
+      end
+
+      def add_entry(path, entry_name, source_path)
+        Omnizip::Zip::File.open(path) { |zip| zip.add(entry_name, source_path) }
+      end
+
+      def remove_entry(path, entry_name)
+        Omnizip::Zip::File.open(path) { |zip| zip.remove(entry_name) }
+      end
+    end
+  end
+end
+
+Omnizip::ArchiveHandler.register(:zip, Omnizip::ArchiveHandlers::ZipHandler.new)

data/lib/omnizip/archive_handlers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Omnizip
+  # Archive handler namespace. Each format ships a Handler class here
+  # that adapts its format-specific API to the canonical contract
+  # documented on +Omnizip::ArchiveHandler+.
+  module ArchiveHandlers
+    autoload :ZipHandler, "omnizip/archive_handlers/zip_handler"
+    autoload :TarHandler, "omnizip/archive_handlers/tar_handler"
+  end
+end

data/lib/omnizip/checksum_registry.rb

@@ -1,114 +1,41 @@
 # frozen_string_literal: true
 
-#
-# Copyright (C) 2024 Ribose Inc.
-#
-# This file is part of Omnizip.
-#
-# Omnizip is a pure Ruby port of 7-Zip compression algorithms.
-# Based on the 7-Zip LZMA SDK by Igor Pavlov.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# See the COPYING file for the complete text of the license.
-#
-
 module Omnizip
-  # Registry for managing available checksum algorithms.
-  #
-  # This class maintains a central registry of all checksum implementations
-  # available in Omnizip, providing a consistent interface for algorithm
-  # discovery and instantiation.
-  #
-  # The registry pattern ensures that checksum algorithms are defined in
-  # one place and can be easily extended with new implementations without
-  # modifying existing code.
-  #
-  # @example Register a new checksum algorithm
-  #   ChecksumRegistry.register(:crc32, Omnizip::Checksums::Crc32)
-  #
-  # @example Get a checksum class
-  #   crc_class = ChecksumRegistry.get(:crc32)
-  #   checksum = crc_class.calculate("data")
-  #
-  # @example List available checksums
-  #   ChecksumRegistry.available
-  #   # => [:crc32, :crc64]
-  class ChecksumRegistry
-    @checksums = {}
+  class ChecksumRegistry < Omnizip::Registry
+    BUILTIN_CHECKSUMS = {
+      crc32: "Omnizip::Checksums::Crc32",
+      crc64: "Omnizip::Checksums::Crc64",
+    }.freeze
 
     class << self
-      # Register a checksum algorithm.
-      #
-      # Adds a new checksum implementation to the registry, making it
-      # available for use throughout the application.
-      #
-      # @param name [Symbol] unique identifier for the checksum
-      # @param checksum_class [Class] class implementing the checksum
-      # @return [void]
-      # @raise [ArgumentError] if name is already registered
-      def register(name, checksum_class)
-        name = name.to_sym
-        if @checksums.key?(name)
-          raise ArgumentError,
-                "Checksum '#{name}' is already registered"
-        end
-
-        @checksums[name] = checksum_class
+      def not_found_error_class
+        Omnizip::UnknownChecksumError
       end
 
-      # Retrieve a checksum class by name.
-      #
-      # Returns the checksum class registered under the given name,
-      # allowing for instantiation and use.
-      #
-      # @param name [Symbol] identifier of the checksum to retrieve
-      # @return [Class] the checksum class
-      # @raise [UnknownAlgorithmError] if checksum not found
-      def get(name)
-        name = name.to_sym
-        checksum_class = @checksums[name]
+      def label
+        "Checksum"
+      end
 
-        unless checksum_class
-          raise UnknownAlgorithmError,
-                "Unknown checksum: '#{name}'. Available: " \
-                "#{available.join(', ')}"
+      def register(name, checksum_class)
+        key = normalize_key(name)
+        existing = storage[key]
+        if existing && existing != checksum_class
+          raise ArgumentError, "Checksum '#{key}' is already registered"
         end
 
+        synchronize { storage[key] = checksum_class }
         checksum_class
       end
 
-      # List all available checksum algorithms.
-      #
-      # Returns an array of registered checksum names, useful for
-      # displaying options to users or validating input.
-      #
-      # @return [Array<Symbol>] array of registered checksum names
       def available
-        @checksums.keys.sort
-      end
-
-      # Check if a checksum is registered.
-      #
-      # @param name [Symbol] identifier of the checksum to check
-      # @return [Boolean] true if registered, false otherwise
-      def registered?(name)
-        @checksums.key?(name.to_sym)
-      end
-
-      # Clear all registered checksums.
-      #
-      # This method is primarily for testing purposes and should not
-      # be used in production code.
-      #
-      # @return [void]
-      # @api private
-      def clear
-        @checksums.clear
+        super.sort
       end
     end
   end
 end
+
+Omnizip::ChecksumRegistry::BUILTIN_CHECKSUMS.each do |name, const_path|
+  Omnizip::ChecksumRegistry.register_lazy(name) do
+    Omnizip::ChecksumRegistry.register(name, Object.const_get(const_path))
+  end
+end

data/lib/omnizip/cli/shared.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Omnizip
+  class Cli
+    # Shared helpers used by the Thor command groups defined in
+    # lib/omnizip/cli.rb (ProfileCommands, ArchiveCommands, Cli).
+    module Shared
+      # Print a formatted error message and exit nonzero.
+      #
+      # @param error [StandardError] the error to display
+      def handle_error(error)
+        warn Omnizip::CliOutputFormatter.format_error(error)
+        exit 1
+      end
+
+      # Format a byte count with a binary-unit suffix.
+      #
+      # @param bytes [Integer] the byte count
+      # @return [String] human-readable size (e.g. "1.5 MB")
+      def format_bytes(bytes)
+        return "0 B" if bytes.zero?
+
+        units = %w[B KB MB GB TB]
+        exp = (Math.log(bytes) / Math.log(1024)).to_i
+        exp = [exp, units.size - 1].min
+
+        "%.1f %s" % [bytes.to_f / (1024**exp), units[exp]]
+      end
+    end
+  end
+end

data/lib/omnizip/cli.rb

@@ -17,22 +17,12 @@
 #
 
 require "thor"
-require "omnizip/commands/compress_command"
-require "omnizip/commands/decompress_command"
-require "omnizip/commands/list_command"
-require "omnizip/commands/archive_create_command"
-require "omnizip/commands/archive_extract_command"
-require "omnizip/commands/archive_list_command"
-require "omnizip/commands/profile_list_command"
-require "omnizip/commands/profile_show_command"
-require "omnizip/commands/metadata_command"
-require "omnizip/commands/archive_verify_command"
-require "omnizip/commands/archive_repair_command"
-require "omnizip/cli/output_formatter"
 
 module Omnizip
   # Profile commands subcommand group
   class ProfileCommands < Thor
+    include Omnizip::Cli::Shared
+
     class << self
       def exit_on_failure?
         true
@@ -75,17 +65,12 @@ module Omnizip
     rescue StandardError => e
       handle_error(e)
     end
-
-    private
-
-    def handle_error(error)
-      warn Omnizip::CliOutputFormatter.format_error(error)
-      exit 1
-    end
   end
 
   # Archive commands subcommand group
   class ArchiveCommands < Thor
+    include Omnizip::Cli::Shared
+
     class << self
       def exit_on_failure?
         true
@@ -306,13 +291,6 @@ module Omnizip
     rescue StandardError => e
       handle_error(e)
     end
-
-    private
-
-    def handle_error(error)
-      warn Omnizip::CliOutputFormatter.format_error(error)
-      exit 1
-    end
   end
 
   # Command-line interface for Omnizip.
@@ -320,6 +298,8 @@ module Omnizip
   # Provides Thor-based CLI commands for compressing and decompressing
   # files using various compression algorithms.
   class Cli < Thor
+    include Omnizip::Cli::Shared
+
     class << self
       def exit_on_failure?
         true
@@ -472,8 +452,6 @@ module Omnizip
                      aliases: "-v",
                      desc: "Enable verbose output"
     def convert(source, target)
-      require "omnizip/converter"
-
       puts "Converting #{source} to #{target}..." if options[:verbose]
 
       result = Omnizip::Converter.convert(
@@ -553,20 +531,5 @@ module Omnizip
     ensure
       input_io.close if input_io && input != "-"
     end
-
-    def handle_error(error)
-      warn CliOutputFormatter.format_error(error)
-      exit 1
-    end
-
-    def format_bytes(bytes)
-      return "0 B" if bytes.zero?
-
-      units = %w[B KB MB GB TB]
-      exp = (Math.log(bytes) / Math.log(1024)).to_i
-      exp = [exp, units.size - 1].min
-
-      "%.1f %s" % [bytes.to_f / (1024**exp), units[exp]]
-    end
   end
 end

data/lib/omnizip/commands/archive_create_command.rb

@@ -16,9 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-require "omnizip/formats/seven_zip/writer"
-
 module Omnizip
   module Commands
     # Command to create .7z archives from files and directories.
@@ -123,8 +120,6 @@ module Omnizip
 
         start_time = Time.now
 
-        require "omnizip/formats/rar"
-
         writer_opts = {
           version: version,
           compression: compression,
@@ -388,7 +383,6 @@ module Omnizip
       def parse_volume_size(size_str)
         return nil if size_str.nil? || size_str.empty?
 
-        require "omnizip/models/split_options"
         Omnizip::Models::SplitOptions.parse_volume_size(size_str)
       end
 

data/lib/omnizip/commands/archive_extract_command.rb

@@ -16,10 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-require "omnizip/formats/seven_zip/reader"
-require "omnizip/extraction"
-
 module Omnizip
   module Commands
     # Command to extract .7z archives to a directory.

data/lib/omnizip/commands/archive_list_command.rb

@@ -16,10 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-require "omnizip/formats/seven_zip/reader"
-require "omnizip/extraction"
-
 module Omnizip
   module Commands
     # Command to list contents of .7z archives.

data/lib/omnizip/commands/archive_repair_command.rb

@@ -18,8 +18,6 @@ module Omnizip
       # @param input_path [String] Path to corrupted archive
       # @param output_path [String] Path for repaired archive
       def run(input_path, output_path)
-        require "omnizip/formats/rar"
-
         raise "Archive not found: #{input_path}" unless File.exist?(input_path)
 
         # Detect format

data/lib/omnizip/commands/archive_verify_command.rb

@@ -17,8 +17,6 @@ module Omnizip
       #
       # @param archive_path [String] Path to archive
       def run(archive_path)
-        require "omnizip/formats/rar"
-
         unless File.exist?(archive_path)
           raise "Archive not found: #{archive_path}"
         end

data/lib/omnizip/commands/compress_command.rb

@@ -16,8 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Command to compress files using specified algorithm.

data/lib/omnizip/commands/decompress_command.rb

@@ -16,8 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Command to decompress files using specified algorithm.

data/lib/omnizip/commands/list_command.rb

@@ -16,8 +16,6 @@
 # See the COPYING file for the complete text of the license.
 #
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Command to list available compression algorithms.

data/lib/omnizip/commands/metadata_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Metadata command implementation
@@ -16,9 +14,6 @@ module Omnizip
       # @param archive_path [String] Path to archive
       # @param pattern [String, nil] Optional pattern to match entries
       def run(archive_path, pattern = nil)
-        require "omnizip/zip/file"
-        require "omnizip/metadata"
-
         unless File.exist?(archive_path)
           raise Errno::ENOENT, "Archive not found: #{archive_path}"
         end

data/lib/omnizip/commands/parity_create_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/parity"
-
 module Omnizip
   module Commands
     # Command to create PAR2 parity files

data/lib/omnizip/commands/parity_repair_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/parity"
-
 module Omnizip
   module Commands
     # Command to repair files using PAR2

data/lib/omnizip/commands/parity_verify_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/parity"
-
 module Omnizip
   module Commands
     # Command to verify files using PAR2

data/lib/omnizip/commands/profile_list_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Command to list available compression profiles

data/lib/omnizip/commands/profile_show_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "omnizip/cli/output_formatter"
-
 module Omnizip
   module Commands
     # Command to show details of a specific compression profile