png_conform 0.1.1 → 0.1.3

data/lib/png_conform/services/validation_service.rb

@@ -1,314 +1,120 @@
 # frozen_string_literal: true
 
-require_relative "../validators/chunk_registry"
-require_relative "../models/validation_result"
-require_relative "../models/file_analysis"
-require_relative "../models/image_info"
-require_relative "../models/compression_info"
-require_relative "../analyzers/resolution_analyzer"
-require_relative "../analyzers/optimization_analyzer"
-require_relative "../analyzers/metrics_analyzer"
+require_relative "validation_orchestrator"
 
 module PngConform
   module Services
     # Main validation orchestration service
     #
-    # This service coordinates the validation of PNG files by:
-    # 1. Reading chunks from the file
-    # 2. Creating appropriate validators for each chunk
-    # 3. Executing validation in the correct order
-    # 4. Collecting and aggregating results
-    #
-    # The service follows a pipeline architecture:
-    # File → Chunks → Validators → Results
+    # This service coordinates the validation of PNG files by delegating
+    # all operations to the ValidationOrchestrator class.
     #
     class ValidationService
-      attr_reader :reader, :context, :results, :chunks
-
       # Convenience method to validate a file by path
       #
       # @param filepath [String] Path to PNG file
-      # @return [ValidationResult] Validation results
-      def self.validate_file(filepath)
-        require_relative "../readers/full_load_reader"
-        reader = Readers::FullLoadReader.new(filepath)
-        service = new(reader, filepath)
-        service.validate
+      # @param options [Hash] Optional CLI options
+      # @return [FileAnalysis] Validation results
+      def self.validate_file(filepath, options = {})
+        ValidationOrchestrator.validate_file(filepath, options)
       end
 
+      attr_reader :reader, :context, :results, :chunks
+
       # Initialize validation service
       #
       # @param reader [Object] File reader (StreamingReader or FullLoadReader)
       # @param filepath [String, nil] Optional file path (for reporting)
-      def initialize(reader, filepath = nil)
+      # @param options [Hash] CLI options for controlling behavior
+      def initialize(reader, filepath = nil, options = {})
         @reader = reader
         @filepath = filepath
-        @context = Validators::ValidationContext.new
-        @results = []
-        @chunks = [] # Store chunks as we read them
+        @options = options
+        @orchestrator = ValidationOrchestrator.new(reader, filepath, options)
+        @context = @orchestrator.context
+        @chunks = []
       end
 
       # Validate the PNG file
       #
-      # This is the main entry point for validation. It processes all chunks
-      # in order, validates them, and collects the results.
-      #
       # @return [FileAnalysis] Complete file analysis with all data
       def validate
-        validate_signature
-        validate_chunks
-        validate_chunk_sequence
-        build_file_analysis
+        file_analysis = @orchestrator.validate
+        @chunks = @orchestrator.chunks
+        file_analysis
       end
 
       # Validate PNG signature
-      #
-      # Checks that the file starts with the PNG signature:
-      # 137 80 78 71 13 10 26 10
-      #
-      # @return [void]
-      def validate_signature
-        sig = reader.signature
-        expected = [137, 80, 78, 71, 13, 10, 26, 10].pack("C*")
-
-        return if sig == expected
-
-        add_error("Invalid PNG signature")
-      end
+      def validate_signature; end
 
       # Validate all chunks in the file
-      #
-      # Processes each chunk in order:
-      # 1. Check for validator
-      # 2. Create validator instance
-      # 3. Execute validation
-      # 4. Collect results
-      #
-      # @return [void]
-      def validate_chunks
-        reader.each_chunk do |chunk|
-          @chunks << chunk # Store chunk for later use
-          validate_chunk(chunk)
-        end
-      end
+      def validate_chunks; end
 
       # Validate a single chunk
       #
       # @param chunk [Object] Chunk to validate
-      # @return [void]
-      def validate_chunk(chunk)
-        # Get validator for this chunk type
-        validator = Validators::ChunkRegistry.create_validator(chunk, context)
-
-        if validator
-          # Validate chunk with registered validator
-          validator.validate
-          # Errors are stored in context, not validator
-        else
-          # Unknown chunk - check if it's safe to ignore
-          handle_unknown_chunk(chunk)
-        end
-
-        # Mark chunk as seen AFTER validation
-        # This allows validators to check for duplicates before marking
-        # Convert BinData::String to regular String for hash key consistency
-        context.mark_chunk_seen(chunk.chunk_type.to_s, chunk)
-      end
+      def validate_chunk(chunk); end
 
       # Handle unknown chunk types
       #
-      # Unknown chunks are checked for safety:
-      # - If ancillary (bit 5 of first byte = 1), it's safe to ignore
-      # - If critical (bit 5 = 0), it's an error
-      #
       # @param chunk [Object] Unknown chunk
-      # @return [void]
-      def handle_unknown_chunk(chunk)
-        # Convert BinData::String to regular String
-        chunk_type = chunk.chunk_type.to_s
-        first_byte = chunk_type.bytes[0]
-
-        # Bit 5 (0x20) of first byte indicates ancillary vs critical
-        if (first_byte & 0x20).zero?
-          # Critical chunk - must be recognized
-          add_error("Unknown critical chunk type: #{chunk_type}")
-        else
-          # Ancillary chunk - safe to ignore
-          add_info("Unknown ancillary chunk type: #{chunk_type} (ignored)")
-        end
-      end
+      def handle_unknown_chunk(chunk); end
 
       # Validate chunk sequence requirements
-      #
-      # Checks high-level sequencing rules:
-      # - IHDR must be first chunk
-      # - IEND must be last chunk
-      # - At least one IDAT chunk required
-      #
-      # @return [void]
-      def validate_chunk_sequence
-        validate_ihdr_first
-        validate_iend_last
-        validate_idat_present
-      end
+      def validate_chunk_sequence; end
 
       # Check that IHDR is the first chunk
-      #
-      # @return [void]
-      def validate_ihdr_first
-        return if context.seen?("IHDR")
-
-        add_error("Missing IHDR chunk (must be first)")
-      end
+      def validate_ihdr_first; end
 
       # Check that IEND is the last chunk
-      #
-      # @return [void]
-      def validate_iend_last
-        return if context.seen?("IEND")
-
-        add_error("Missing IEND chunk (must be last)")
-      end
+      def validate_iend_last; end
 
       # Check that at least one IDAT chunk exists
-      #
-      # @return [void]
-      def validate_idat_present
-        return if context.seen?("IDAT")
-
-        add_error("Missing IDAT chunk (at least one required)")
-      end
+      def validate_idat_present; end
 
       # Build complete FileAnalysis with validation results and analyzer data
       #
-      # Proper Model → Formatter pattern
-      # - Builds ValidationResult (legacy)
-      # - Extracts ImageInfo and CompressionInfo
-      # - Runs all analyzers HERE (not in reporters)
-      # - Returns complete FileAnalysis model
-      #
       # @return [FileAnalysis] Complete analysis model
       def build_file_analysis
-        # First build the ValidationResult (legacy structure)
-        validation_result = build_validation_result
-
-        # Extract image info from IHDR
-        image_info = extract_image_info(validation_result)
-
-        # Build complete FileAnalysis
-        Models::FileAnalysis.new.tap do |analysis|
-          analysis.file_path = @filepath || "unknown"
-          analysis.file_size = validation_result.file_size
-          analysis.file_type = validation_result.file_type
-          analysis.validation_result = validation_result
-          # chunks delegated to validation_result (no need to set)
-          analysis.image_info = image_info
-          analysis.compression_info = extract_compression_info(validation_result)
-
-          # Run analyzers HERE (proper Model → Formatter pattern)
-          analysis.resolution_analysis = run_resolution_analysis(validation_result)
-          analysis.optimization_analysis = run_optimization_analysis(validation_result)
-          analysis.metrics = run_metrics_analysis(validation_result)
-        end
+        @orchestrator.validate
       end
 
-      # Build ValidationResult (original method renamed)
-      def build_validation_result
-        Models::ValidationResult.new.tap do |result|
-          # Set file metadata
-          result.filename = @filepath || "unknown"
-
-          result.file_type = determine_file_type
-
-          # Calculate file size from chunks if reader doesn't provide it
-          result.file_size = if reader.respond_to?(:file_size)
-                               reader.file_size
-                             else
-                               # 8 bytes signature + sum of chunk sizes (8 byte header + data + 4 byte CRC per chunk)
-                               8 + @chunks.sum { |c| 12 + c.length }
-                             end
-
-          # Add all chunks with CRC validation
-          crc_error_count = 0
-          @chunks.each do |bindata_chunk|
-            chunk = Models::Chunk.from_bindata(bindata_chunk,
-                                               bindata_chunk.abs_offset)
-
-            # Validate CRC
-            expected_crc = bindata_chunk.crc
-            actual_crc = calculate_crc(bindata_chunk)
-            chunk.crc_expected = format_hex(expected_crc)
-            chunk.crc_actual = format_hex(actual_crc)
-            chunk.valid_crc = (expected_crc == actual_crc)
-
-            crc_error_count += 1 unless chunk.valid_crc
-
-            result.add_chunk(chunk)
-          end
-
-          result.crc_errors_count = crc_error_count
-
-          # Calculate compression ratio for PNG files
-          if result.file_type == "PNG"
-            result.compression_ratio = calculate_compression_ratio(result.chunks)
-          end
-
-          # Add errors from service (@results)
-          @results.select { |r| r[:type] == :error }.each do |r|
-            result.error(r[:message])
-          end
-
-          # Add errors from validators (context)
-          context.all_errors.each do |e|
-            result.error(e[:message])
-          end
-
-          # Add warnings from service (@results)
-          @results.select { |r| r[:type] == :warning }.each do |r|
-            result.warning(r[:message])
-          end
-
-          # Add warnings from validators (context)
-          context.all_warnings.each do |w|
-            result.warning(w[:message])
-          end
-
-          # Add info from service (@results)
-          @results.select { |r| r[:type] == :info }.each do |r|
-            result.info(r[:message])
-          end
-
-          # Add info from validators (context)
-          context.all_info.each do |i|
-            result.info(i[:message])
-          end
-        end
-      end
+      # Build ValidationResult
+      def build_validation_result; end
 
       private
 
       # Add an error to results
       #
       # @param message [String] Error message
-      # @return [void]
       def add_error(message)
-        @results << { type: :error, message: message }
+        @context.add_error(
+          chunk_type: nil,
+          message: message,
+          severity: :error,
+        )
       end
 
       # Add a warning to results
       #
       # @param message [String] Warning message
-      # @return [void]
       def add_warning(message)
-        @results << { type: :warning, message: message }
+        @context.add_error(
+          chunk_type: nil,
+          message: message,
+          severity: :warning,
+        )
       end
 
       # Add info to results
       #
       # @param message [String] Info message
-      # @return [void]
       def add_info(message)
-        @results << { type: :info, message: message }
+        @context.add_error(
+          chunk_type: nil,
+          message: message,
+          severity: :info,
+        )
       end
 
       # Merge results from a validator
@@ -316,7 +122,6 @@ module PngConform
       # @param errors [Array<String>] Error messages
       # @param warnings [Array<String>] Warning messages
       # @param info [Array<String>] Info messages
-      # @return [void]
       def merge_results(errors, warnings, info)
         errors.each { |msg| add_error(msg) }
         warnings.each { |msg| add_warning(msg) }
@@ -326,13 +131,7 @@ module PngConform
       # Determine file type based on chunks
       #
       # @return [String] File type (PNG, MNG, JNG, or UNKNOWN)
-      def determine_file_type
-        return Models::ValidationResult::FILE_TYPE_MNG if context.seen?("MHDR")
-        return Models::ValidationResult::FILE_TYPE_JNG if context.seen?("JHDR")
-        return Models::ValidationResult::FILE_TYPE_PNG if context.seen?("IHDR")
-
-        Models::ValidationResult::FILE_TYPE_UNKNOWN
-      end
+      def determine_file_type; end
 
       # Calculate CRC32 for a chunk
       #
@@ -340,7 +139,6 @@ module PngConform
       # @return [Integer] CRC32 value
       def calculate_crc(chunk)
         require "zlib"
-        # CRC is calculated over chunk type + chunk data
         Zlib.crc32(chunk.chunk_type.to_s + chunk.data.to_s)
       end
 
@@ -356,92 +154,27 @@ module PngConform
       #
       # @param chunks [Array<Chunk>] All chunks
       # @return [Float] Compression ratio as percentage, 0.0 if cannot calculate
-      def calculate_compression_ratio(chunks)
-        idat_chunks = chunks.select { |c| c.type == "IDAT" }
-        return 0.0 if idat_chunks.empty?
-
-        compressed_size = idat_chunks.sum(&:length)
-        return 0.0 if compressed_size.zero?
-
-        # Try to decompress to get original size
-        # Need to get actual binary data from BinData chunks, not Model chunks
-        begin
-          require "zlib"
-
-          # Get IDAT chunks from the original BinData chunks
-          idat_bindata = @chunks.select { |c| c.chunk_type.to_s == "IDAT" }
-          compressed_data = idat_bindata.map { |c| c.data.to_s }.join
-
-          decompressed = Zlib::Inflate.inflate(compressed_data)
-          original_size = decompressed.bytesize
-
-          return 0.0 if original_size.zero?
-
-          # Calculate percentage: (compressed/original - 1) * 100
-          # Negative means compression, positive means expansion
-          ((compressed_size.to_f / original_size - 1) * 100).round(1)
-        rescue StandardError
-          # If decompression fails, we can't calculate ratio
-          # Return 0.0 instead of nil so it appears in YAML/JSON
-          0.0
-        end
-      end
+      def calculate_compression_ratio(chunks); end
 
       # Extract ImageInfo from IHDR chunk
-      def extract_image_info(result)
-        ihdr = result.ihdr_chunk
-        return nil unless ihdr&.data && ihdr.data.bytesize >= 13
-
-        width = ihdr.data.bytes[0..3].pack("C*").unpack1("N")
-        height = ihdr.data.bytes[4..7].pack("C*").unpack1("N")
-        bit_depth = ihdr.data.bytes[8]
-        color_type = ihdr.data.bytes[9]
-        interlace = ihdr.data.bytes[12]
-
-        Models::ImageInfo.new.tap do |info|
-          info.width = width
-          info.height = height
-          info.bit_depth = bit_depth
-          info.color_type = color_type_name(color_type)
-          info.interlaced = interlace == 1
-          info.animated = false # Could check for APNG chunks
-        end
-      end
+      def extract_image_info(result); end
 
       # Extract CompressionInfo
-      def extract_compression_info(result)
-        return nil unless result.compression_ratio
-
-        Models::CompressionInfo.new.tap do |info|
-          info.compression_ratio = result.compression_ratio
-          info.compressed_size = result.chunks.select do |c|
-            c.type == "IDAT"
-          end.sum(&:length)
-        end
-      end
+      def extract_compression_info(result); end
 
       # Run resolution analyzer
-      def run_resolution_analysis(result)
-        Analyzers::ResolutionAnalyzer.new(result).analyze
-      rescue StandardError => e
-        { error: "Resolution analysis failed: #{e.message}" }
-      end
+      def run_resolution_analysis(result); end
 
       # Run optimization analyzer
-      def run_optimization_analysis(result)
-        Analyzers::OptimizationAnalyzer.new(result).analyze
-      rescue StandardError => e
-        { error: "Optimization analysis failed: #{e.message}" }
-      end
+      def run_optimization_analysis(result); end
 
       # Run metrics analyzer
-      def run_metrics_analysis(result)
-        Analyzers::MetricsAnalyzer.new(result).analyze
-      rescue StandardError => e
-        { error: "Metrics analysis failed: #{e.message}" }
-      end
+      def run_metrics_analysis(result); end
 
       # Helper to convert color type code to name
+      #
+      # @param code [Integer] Color type code
+      # @return [String] Color type name
       def color_type_name(code)
         case code
         when 0 then "grayscale"
@@ -452,6 +185,34 @@ module PngConform
         else "unknown"
         end
       end
+
+      # Check if resolution analysis is needed
+      def need_resolution_analysis?
+        return true unless @options[:quiet]
+
+        @options[:resolution] || @options[:mobile_ready]
+      end
+
+      # Check if optimization analysis is needed
+      def need_optimization_analysis?
+        return true unless @options[:quiet]
+
+        @options[:optimize]
+      end
+
+      # Check if metrics analysis is needed
+      def need_metrics_analysis?
+        return true if ["yaml", "json"].include?(@options[:format])
+
+        @options[:metrics]
+      end
+
+      # Check if compression ratio calculation is needed
+      def need_compression_ratio?
+        return true if ["yaml", "json"].include?(@options[:format])
+
+        !@options[:quiet]
+      end
     end
   end
 end

data/lib/png_conform/services/validator_pool.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module PngConform
+  module Services
+    # Validator pool for reusing validator instances
+    #
+    # Reduces object allocation overhead by pooling validator instances
+    # across chunk validations. Validators are reset between uses to ensure
+    # clean state for each validation.
+    #
+    # This pool is scoped to a single validation session and should be
+    # discarded after validation completes.
+    #
+    class ValidatorPool
+      # Initialize validator pool
+      #
+      # @param options [Hash] Pool options
+      # @option options [Integer] :max_per_type Maximum validators to cache per type
+      def initialize(options = {})
+        @max_per_type = options.fetch(:max_per_type, 5)
+        @pools = {} # chunk_type => [validator instances]
+        @stats = {
+          created: 0,
+          reused: 0,
+          resets: 0,
+        }
+      end
+
+      # Acquire a validator for the given chunk type
+      #
+      # Returns a validator from the pool if available, or creates a new one.
+      # The validator is reset before being returned.
+      #
+      # @param chunk_type [String] Chunk type code
+      # @param validator_class [Class] Validator class to instantiate
+      # @param chunk [Object] Chunk object
+      # @param context [ValidationContext] Validation context
+      # @return [Object] Validator instance
+      def acquire(chunk_type, validator_class, chunk, context)
+        pool = pool_for(chunk_type)
+
+        # Try to get a validator from the pool
+        validator = pool.pop
+
+        if validator
+          @stats[:reused] += 1
+          reset_validator(validator, chunk, context)
+        else
+          @stats[:created] += 1
+          validator = validator_class.new(chunk, context)
+        end
+
+        validator
+      end
+
+      # Return a validator to the pool
+      #
+      # @param chunk_type [String] Chunk type code
+      # @param validator [Object] Validator instance to return
+      # @return [void]
+      def release(chunk_type, validator)
+        pool = pool_for(chunk_type)
+
+        # Only pool if under limit
+        if pool.size < @max_per_type
+          # Clear validator state before returning to pool
+          clear_validator(validator)
+          pool << validator
+        end
+        # If pool is full, just let validator be garbage collected
+      end
+
+      # Clear all pools
+      #
+      # @return [void]
+      def clear
+        @pools.clear
+        reset_stats
+      end
+
+      # Get pool statistics
+      #
+      # @return [Hash] Statistics about pool usage
+      def stats
+        pool_sizes = @pools.transform_values(&:size)
+        @stats.merge(pool_sizes: pool_sizes,
+                     total_pooled: pool_sizes.values.sum)
+      end
+
+      # Reset statistics
+      #
+      # @return [void]
+      def reset_stats
+        @stats = {
+          created: 0,
+          reused: 0,
+          resets: 0,
+        }
+      end
+
+      private
+
+      # Get or create pool for a chunk type
+      #
+      # @param chunk_type [String] Chunk type code
+      # @return [Array] Pool array for this chunk type
+      def pool_for(chunk_type)
+        @pools[chunk_type] ||= []
+      end
+
+      # Reset validator for reuse with new chunk and context
+      #
+      # @param validator [Object] Validator instance
+      # @param chunk [Object] New chunk object
+      # @param context [ValidationContext] New validation context
+      # @return [void]
+      def reset_validator(validator, chunk, context)
+        @stats[:resets] += 1
+
+        # Reset the validator's chunk and context
+        validator.instance_variable_set(:@chunk, chunk)
+        validator.instance_variable_set(:@context, context)
+
+        # Clear any cached results/errors
+        clear_validator(validator)
+      end
+
+      # Clear validator state
+      #
+      # @param validator [Object] Validator instance
+      # @return [void]
+      def clear_validator(validator)
+        # Clear common instance variables that validators might cache
+        validator.remove_instance_variable(:@errors) if validator.instance_variable_defined?(:@errors)
+        validator.remove_instance_variable(:@warnings) if validator.instance_variable_defined?(:@warnings)
+        validator.remove_instance_variable(:@info) if validator.instance_variable_defined?(:@info)
+      rescue NameError
+        # Variable doesn't exist, that's fine
+      end
+    end
+  end
+end