uniword 1.2.5 → 1.3.0

data/lib/uniword/validators/table_validator.rb

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-# NOTE: element_validator is already loaded by uniword.rb
-# No need to require it here to avoid circular dependencies
-
-module Uniword
-  module Validators
-    # Validator for Table elements
-    # Responsibility: Validate table-specific constraints
-    #
-    # A valid table:
-    # - Must be a Table instance
-    # - Can have zero or more rows (empty tables are valid)
-    # - All rows must be valid TableRow instances
-    # - All rows should have consistent column counts (warning, not error)
-    # - Properties, if present, must be valid TableProperties
-    #
-    # @example Using the table validator
-    #   validator = Uniword::Validators::TableValidator.new
-    #   validator.valid?(table) # => true or false
-    #   validator.errors(table) # => ["error message", ...]
-    class TableValidator < ElementValidator
-      # Validate a table element
-      #
-      # @param element [Table] The table to validate
-      # @return [Boolean] true if valid, false otherwise
-      def valid?(element)
-        return false unless super
-        return false unless element.is_a?(Uniword::Wordprocessingml::Table)
-
-        validate_rows(element) &&
-          validate_properties(element)
-      end
-
-      # Get validation errors for a table
-      #
-      # @param element [Table] The table to validate
-      # @return [Array<String>] Array of error messages
-      def errors(element)
-        errors = []
-
-        # Check if element is nil
-        return ["Element is nil"] if element.nil?
-
-        # Check table type first (more specific than base check)
-        return ["Element must be a Table"] unless element.is_a?(Uniword::Wordprocessingml::Table)
-
-        # Validate rows - collect all specific errors
-        errors.concat(row_errors(element))
-
-        # Validate properties - collect all specific errors
-        errors.concat(property_errors(element))
-
-        errors
-      end
-
-      # Get validation warnings (non-critical issues)
-      #
-      # @param element [Table] The table to validate
-      # @return [Array<String>] Array of warning messages
-      def warnings(element)
-        warnings = []
-
-        return warnings unless element.is_a?(Uniword::Wordprocessingml::Table)
-        return warnings if element.rows.empty?
-
-        # Check for inconsistent column counts
-        column_counts = element.rows.map { |row| row.cells.count }.uniq
-        warnings << "Table has inconsistent column counts: #{column_counts.join(', ')}" if column_counts.size > 1
-
-        warnings
-      end
-
-      private
-
-      # Validate that all rows are valid TableRow instances
-      #
-      # @param table [Table] The table to validate
-      # @return [Boolean] true if all rows are valid
-      def validate_rows(table)
-        return true if table.rows.nil? || table.rows.empty?
-
-        table.rows.all?(Uniword::Wordprocessingml::TableRow)
-      end
-
-      # Get errors related to rows
-      #
-      # @param table [Table] The table to validate
-      # @return [Array<String>] Array of error messages
-      def row_errors(table)
-        errors = []
-
-        return errors if table.rows.nil? || table.rows.empty?
-
-        table.rows.each_with_index do |row, index|
-          errors << "Row at index #{index} must be a TableRow instance" unless row.is_a?(Uniword::Wordprocessingml::TableRow)
-        end
-
-        errors
-      end
-
-      # Validate properties if present
-      #
-      # @param table [Table] The table to validate
-      # @return [Boolean] true if properties are valid or nil
-      def validate_properties(table)
-        return true if table.properties.nil?
-
-        table.properties.is_a?(Uniword::Wordprocessingml::TableProperties)
-      end
-
-      # Get errors related to properties
-      #
-      # @param table [Table] The table to validate
-      # @return [Array<String>] Array of error messages
-      def property_errors(table)
-        return [] if table.properties.nil?
-
-        return ["Properties must be a TableProperties instance"] unless table.properties.is_a?(Uniword::Wordprocessingml::TableProperties)
-
-        []
-      end
-    end
-  end
-end
-
-# Register this validator when the file is loaded
-# This ensures the validator is available regardless of load order
-if defined?(Uniword::Validators::ElementValidator)
-  Uniword::Validators::ElementValidator.register(
-    Uniword::Wordprocessingml::Table,
-    Uniword::Validators::TableValidator,
-  )
-end

data/lib/uniword/validators.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Uniword
-  module Validators
-    autoload :ElementValidator, "#{__dir__}/validators/element_validator"
-    autoload :ParagraphValidator, "#{__dir__}/validators/paragraph_validator"
-    autoload :TableValidator, "#{__dir__}/validators/table_validator"
-  end
-end

data/lib/uniword/warnings/warning.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-module Uniword
-  module Warnings
-    # Represents a single warning about an unsupported element or feature.
-    #
-    # Responsibility: Store information about one warning.
-    # Single Responsibility: Only represents warning data.
-    #
-    # A warning includes:
-    # - Type (unsupported_element, unsupported_attribute, etc.)
-    # - Severity (error, warning, info)
-    # - Element/attribute name
-    # - Context where it was encountered
-    # - Location in document
-    # - Suggestion for user
-    #
-    # @example Create a warning
-    #   warning = Warning.new(
-    #     type: :unsupported_element,
-    #     severity: :warning,
-    #     element: 'chart',
-    #     message: 'Unsupported element: chart',
-    #     context: 'While parsing paragraph',
-    #     suggestion: 'Chart will be preserved but not editable'
-    #   )
-    class Warning
-      # @return [Symbol] Type of warning
-      attr_reader :type
-
-      # @return [Symbol] Severity level (:error, :warning, :info)
-      attr_reader :severity
-
-      # @return [String] Element name
-      attr_reader :element
-
-      # @return [String, nil] Attribute name (for attribute warnings)
-      attr_reader :attribute
-
-      # @return [String] Warning message
-      attr_reader :message
-
-      # @return [String, nil] Context where warning occurred
-      attr_reader :context
-
-      # @return [String, nil] Location in document
-      attr_reader :location
-
-      # @return [String, nil] Suggestion for user
-      attr_reader :suggestion
-
-      # Initialize a new warning.
-      #
-      # @param attributes [Hash] Warning attributes
-      # @option attributes [Symbol] :type Warning type
-      # @option attributes [Symbol] :severity Severity level
-      # @option attributes [String] :element Element name
-      # @option attributes [String] :attribute Attribute name (optional)
-      # @option attributes [String] :message Warning message
-      # @option attributes [String] :context Context (optional)
-      # @option attributes [String] :location Location (optional)
-      # @option attributes [String] :suggestion Suggestion (optional)
-      #
-      # @example Create a warning
-      #   warning = Warning.new(
-      #     type: :unsupported_element,
-      #     severity: :error,
-      #     element: 'chart',
-      #     message: 'Unsupported element: chart'
-      #   )
-      def initialize(attributes)
-        @type = attributes[:type]
-        @severity = attributes[:severity]
-        @element = attributes[:element]
-        @attribute = attributes[:attribute]
-        @message = attributes[:message]
-        @context = attributes[:context]
-        @location = attributes[:location]
-        @suggestion = attributes[:suggestion]
-      end
-
-      # Check if this is an error-level warning.
-      #
-      # @return [Boolean] true if severity is :error
-      def error?
-        @severity == :error
-      end
-
-      # Check if this is a warning-level warning.
-      #
-      # @return [Boolean] true if severity is :warning
-      def warning?
-        @severity == :warning
-      end
-
-      # Check if this is an info-level warning.
-      #
-      # @return [Boolean] true if severity is :info
-      def info?
-        @severity == :info
-      end
-
-      # Convert to hash representation.
-      #
-      # @return [Hash] Hash representation
-      def to_h
-        {
-          type: @type,
-          severity: @severity,
-          element: @element,
-          attribute: @attribute,
-          message: @message,
-          context: @context,
-          location: @location,
-          suggestion: @suggestion,
-        }.compact
-      end
-
-      # Convert to string for display.
-      #
-      # @return [String] String representation
-      def to_s
-        severity_str = @severity.to_s.upcase
-        element_str = @attribute ? "#{@element}/@#{@attribute}" : @element
-        msg_str = @message
-        "[#{severity_str}] #{element_str}: #{msg_str}"
-      end
-    end
-  end
-end

data/lib/uniword/warnings/warning_collector.rb

@@ -1,234 +0,0 @@
-# frozen_string_literal: true
-
-module Uniword
-  module Warnings
-    # Collects warnings during document processing.
-    #
-    # Responsibility: Track unsupported elements and features.
-    # Single Responsibility: Only collects warnings.
-    #
-    # This class is used during deserialization to track all unsupported
-    # elements and attributes encountered, allowing users to understand
-    # what features may be lost in round-trip operations.
-    #
-    # External configuration: config/warning_rules.yml
-    #
-    # @example Use during deserialization
-    #   collector = WarningCollector.new
-    #   collector.record_unsupported('chart', context: 'In paragraph 5')
-    #   report = collector.report
-    #   puts report.summary
-    class WarningCollector
-      # @return [Array<Warning>] Collected warnings
-      attr_reader :warnings
-
-      # @return [Hash<String, Integer>] Element occurrence counts
-      attr_reader :element_counts
-
-      # Initialize a new warning collector.
-      #
-      # @param config_file [String] Path to configuration file
-      #
-      # @example Create with default config
-      #   collector = WarningCollector.new
-      #
-      # @example Create with custom config
-      #   collector = WarningCollector.new(
-      #     config_file: 'custom_warnings.yml'
-      #   )
-      def initialize(config_file: nil)
-        @config = load_config(config_file)
-        @warnings = []
-        @element_counts = Hash.new(0)
-      end
-
-      # Record an unsupported element.
-      #
-      # @param element_tag [String] Element tag name
-      # @param context [String] Context where element was found
-      # @param location [String] Location in document (optional)
-      # @return [void]
-      #
-      # @example Record unsupported element
-      #   collector.record_unsupported(
-      #     'chart',
-      #     context: 'While parsing paragraph',
-      #     location: '/document/body/p[5]'
-      #   )
-      def record_unsupported(element_tag, context:, location: nil)
-        return unless enabled?
-        return if max_warnings_reached?
-
-        @element_counts[element_tag] += 1
-
-        warning = Warning.new(
-          type: :unsupported_element,
-          severity: determine_severity(element_tag),
-          element: element_tag,
-          message: "Unsupported element: #{element_tag}",
-          context: context,
-          location: location,
-          suggestion: get_suggestion(element_tag),
-        )
-
-        @warnings << warning
-        log_warning(warning) if should_log?
-      end
-
-      # Record an unsupported attribute.
-      #
-      # @param element_tag [String] Element tag name
-      # @param attribute_name [String] Attribute name
-      # @param context [String] Context where attribute was found
-      # @return [void]
-      #
-      # @example Record unsupported attribute
-      #   collector.record_unsupported_attribute(
-      #     'w:p',
-      #     'customAttr',
-      #     context: 'In paragraph properties'
-      #   )
-      def record_unsupported_attribute(element_tag, attribute_name, context:)
-        return unless enabled?
-        return if max_warnings_reached?
-
-        warning = Warning.new(
-          type: :unsupported_attribute,
-          severity: :info,
-          element: element_tag,
-          attribute: attribute_name,
-          message: "Unsupported attribute: #{element_tag}/@#{attribute_name}",
-          context: context,
-        )
-
-        @warnings << warning
-        log_warning(warning) if should_log?
-      end
-
-      # Generate warning report.
-      #
-      # @return [WarningReport] Aggregated warning report
-      #
-      # @example Get report
-      #   report = collector.report
-      #   puts "Total warnings: #{report.total_count}"
-      def report
-        WarningReport.new(
-          warnings: @warnings,
-          element_counts: @element_counts,
-          config: @config,
-        )
-      end
-
-      # Check if warnings were collected.
-      #
-      # @return [Boolean] true if warnings exist
-      def any?
-        @warnings.any?
-      end
-
-      # Clear all collected warnings.
-      #
-      # @return [void]
-      def clear
-        @warnings.clear
-        @element_counts.clear
-      end
-
-      private
-
-      def load_config(config_file)
-        if config_file
-          Configuration::ConfigurationLoader.load_file(config_file)
-        else
-          # Try to load default config
-          default_path = File.join(
-            Configuration::ConfigurationLoader::CONFIG_DIR,
-            "warning_rules.yml",
-          )
-
-          if File.exist?(default_path)
-            Configuration::ConfigurationLoader.load("warning_rules")
-          else
-            # Use empty config with defaults
-            default_config
-          end
-        end
-      rescue Configuration::ConfigurationError
-        # If config fails to load, use defaults
-        default_config
-      end
-
-      def default_config
-        {
-          warning_system: {
-            enabled: true,
-            log_warnings: false,
-            log_level: :warn,
-            critical_elements: [],
-            warning_elements: [],
-            element_suggestions: {},
-            reporting: {
-              max_warnings: 100,
-            },
-          },
-        }
-      end
-
-      def warning_config
-        @config[:warning_system] || {}
-      end
-
-      def enabled?
-        warning_config[:enabled] != false
-      end
-
-      def should_log?
-        warning_config[:log_warnings] == true
-      end
-
-      def max_warnings_reached?
-        max = warning_config.dig(:reporting, :max_warnings) || 100
-        @warnings.count >= max
-      end
-
-      def determine_severity(element_tag)
-        critical = warning_config[:critical_elements] || []
-        warning_els = warning_config[:warning_elements] || []
-
-        if critical.include?(element_tag)
-          :error
-        elsif warning_els.include?(element_tag)
-          :warning
-        else
-          :info
-        end
-      end
-
-      def get_suggestion(element_tag)
-        suggestions = warning_config[:element_suggestions] || {}
-        suggestions[element_tag] ||
-          suggestions[element_tag.to_sym] ||
-          "This element is not yet supported. Data may be lost in round-trip."
-      end
-
-      def log_warning(warning)
-        level = warning_config[:log_level] || :warn
-        message = "[WARNING] #{warning}"
-
-        # Use Uniword logger if available
-        if defined?(Uniword::Logger)
-          case level
-          when :debug then Uniword::Logger.debug(message)
-          when :info  then Uniword::Logger.info(message)
-          when :warn  then Uniword::Logger.warn(message)
-          when :error then Uniword::Logger.error(message)
-          end
-        elsif %i[warn error].include?(level)
-          # Fall back to standard output
-          puts message
-        end
-      end
-    end
-  end
-end

data/lib/uniword/warnings/warning_report.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Uniword
-  module Warnings
-    # Aggregated warning report.
-    #
-    # Responsibility: Aggregate and report warnings.
-    # Single Responsibility: Only manages warning reporting.
-    #
-    # A warning report includes:
-    # - Collection of all warnings
-    # - Element occurrence counts
-    # - Grouping by severity
-    # - Summary statistics
-    #
-    # @example Create a report
-    #   report = WarningReport.new(
-    #     warnings: warnings,
-    #     element_counts: { 'chart' => 5, 'smartArt' => 2 }
-    #   )
-    #   puts report.summary
-    class WarningReport
-      # @return [Array<Warning>] All warnings
-      attr_reader :warnings
-
-      # @return [Hash<String, Integer>] Element occurrence counts
-      attr_reader :element_counts
-
-      # Initialize a new warning report.
-      #
-      # @param warnings [Array<Warning>] Warnings to include
-      # @param element_counts [Hash<String, Integer>] Element counts
-      # @param config [Hash] Configuration
-      #
-      # @example Create a report
-      #   report = WarningReport.new(
-      #     warnings: [warning1, warning2],
-      #     element_counts: { 'chart' => 3 }
-      #   )
-      def initialize(warnings:, element_counts:, config: {})
-        @warnings = warnings
-        @element_counts = element_counts
-        @config = config
-      end
-
-      # Check if report has any warnings.
-      #
-      # @return [Boolean] true if warnings exist
-      def any?
-        @warnings.any?
-      end
-
-      # Get error-level warnings.
-      #
-      # @return [Array<Warning>] Error warnings
-      def errors
-        @warnings.select(&:error?)
-      end
-
-      # Get warning-level warnings.
-      #
-      # @return [Array<Warning>] Warning-level warnings
-      def warnings_only
-        @warnings.select(&:warning?)
-      end
-
-      # Get info-level warnings.
-      #
-      # @return [Array<Warning>] Info warnings
-      def infos
-        @warnings.select(&:info?)
-      end
-
-      # Get count of error warnings.
-      #
-      # @return [Integer] Error count
-      def error_count
-        errors.count
-      end
-
-      # Get count of warning-level warnings.
-      #
-      # @return [Integer] Warning count
-      def warning_count
-        warnings_only.count
-      end
-
-      # Get count of info warnings.
-      #
-      # @return [Integer] Info count
-      def info_count
-        infos.count
-      end
-
-      # Get total warning count.
-      #
-      # @return [Integer] Total count
-      def total_count
-        @warnings.count
-      end
-
-      # Generate summary text.
-      #
-      # @return [String] Summary text
-      def summary
-        return "No warnings" unless any?
-
-        lines = []
-        lines << "Found #{total_count} warning(s):"
-        lines << "  Errors: #{error_count}"
-        lines << "  Warnings: #{warning_count}"
-        lines << "  Info: #{info_count}"
-
-        if @element_counts.any?
-          lines << ""
-          lines << "Unsupported elements encountered:"
-
-          @element_counts.sort_by { |_, count| -count }.each do |element, count|
-            lines << "  #{element}: #{count} occurrence(s)"
-          end
-        end
-
-        lines.join("\n")
-      end
-
-      # Export to JSON string.
-      #
-      # @return [String] JSON representation
-      def to_json(*_args)
-        JSON.pretty_generate(to_h)
-      end
-
-      # Convert to hash representation.
-      #
-      # @return [Hash] Hash representation
-      def to_h
-        {
-          total: total_count,
-          by_severity: {
-            errors: error_count,
-            warnings: warning_count,
-            infos: info_count,
-          },
-          element_counts: @element_counts,
-          warnings: @warnings.map(&:to_h),
-        }
-      end
-
-      # Convert to string for display.
-      #
-      # @return [String] String representation
-      def to_s
-        summary
-      end
-    end
-  end
-end

data/lib/uniword/warnings.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Uniword
-  module Warnings
-    autoload :Warning, "#{__dir__}/warnings/warning"
-    autoload :WarningCollector, "#{__dir__}/warnings/warning_collector"
-    autoload :WarningReport, "#{__dir__}/warnings/warning_report"
-  end
-end