class-metrix 0.1.2 → 1.0.1

data/sig/formatters_base.rbs

@@ -0,0 +1,59 @@
+# Base formatter classes
+module ClassMetrix
+  module Formatters
+    module Base
+      class BaseFormatter
+        attr_reader data: Hash[Symbol, untyped]
+        attr_reader expand_hashes: bool
+        attr_reader options: Hash[Symbol, untyped]
+
+        def initialize: (Hash[Symbol, untyped] data, ?bool expand_hashes, ?Hash[Symbol, untyped] options) -> void
+        def format: () -> String
+
+        private
+
+        def default_options: () -> Hash[Symbol, untyped]
+        def has_type_column?: () -> bool
+        def behavior_column_index: () -> Integer
+        def value_start_index: () -> Integer
+        def class_headers: () -> Array[String]
+        def collect_all_hash_keys: (Array[Array[untyped]] rows, Array[String] _headers) -> Hash[String, Set[String]]
+        def determine_table_data: () -> Hash[Symbol, untyped]
+        def render_markdown_table: (Hash[Symbol, untyped] table_data) -> Array[String]
+        def render_csv_table: (Hash[Symbol, untyped] table_data) -> Array[String]
+        def calculate_column_widths: (Array[String] headers, Array[Array[untyped]] rows) -> Array[Integer]
+        def build_header_row: (Array[String] headers, Array[Integer] widths) -> String
+        def build_separator_row: (Array[Integer] widths) -> String
+        def build_data_rows: (Array[Array[untyped]] rows, Array[String] headers, Array[Integer] widths) -> Array[String]
+        def build_single_data_row: (Array[untyped] row, Array[String] headers, Array[Integer] widths) -> String
+        def pad_row_to_header_length: (Array[untyped] row, Integer header_length) -> Array[untyped]
+        def format_row_cells: (Array[untyped] row, Array[Integer] widths) -> Array[String]
+        def truncate_cell: (String cell, Integer max_width) -> String
+        def truncate_hash_representation: (String text, Integer max_width) -> String
+        def format_cell: (untyped cell) -> String
+        def format_csv_cell: (untyped cell) -> String
+        def process_value: (untyped value, ?Symbol format) -> String
+        def safe_hash_lookup: (Hash[untyped, untyped] hash, untyped key) -> untyped
+        def has_hash_key?: (Hash[untyped, untyped] hash, untyped key) -> bool
+      end
+
+      class BaseComponent
+        attr_reader data: Hash[Symbol, untyped]
+        attr_reader options: Hash[Symbol, untyped]
+        attr_reader value_processor: untyped
+
+        def initialize: (Hash[Symbol, untyped] data, ?Hash[Symbol, untyped] options) -> void
+        def generate: () -> Array[String]
+
+        private
+
+        def has_type_column?: () -> bool
+        def behavior_column_index: () -> Integer
+        def value_start_index: () -> Integer
+        def class_headers: () -> Array[String]
+        def extraction_types_description: () -> String
+        def format_timestamp: () -> String
+      end
+    end
+  end
+end

data/sig/formatters_components.rbs

@@ -0,0 +1,133 @@
+# Component classes for formatters
+module ClassMetrix
+  module Formatters
+    module Components
+      class HeaderComponent < Base::BaseComponent
+        def generate: () -> Array[String]
+        def generate_title: () -> Array[String]
+
+        private
+
+        def generate_title_section: () -> Array[String]
+        def generate_classes_section: () -> Array[String]
+        def generate_extraction_info: () -> Array[String]
+      end
+
+      class TableComponent < Base::BaseComponent
+        def generate: () -> Array[String]
+
+        private
+
+        def process_table_data: () -> Hash[Symbol, untyped]
+        def build_table: (Hash[Symbol, untyped] processed_data) -> Array[String]
+
+        class TableDataExtractor
+          @headers: Array[String]
+
+          def initialize: (Array[String] headers) -> void
+          def behavior_column_index: () -> Integer
+          def value_start_index: () -> Integer
+          def class_headers: () -> Array[String]
+          def has_type_column?: () -> bool
+          def row_has_expandable_hash?: (Array[untyped] row) -> bool
+          def extract_row_data: (Array[untyped] row) -> Hash[Symbol, untyped]
+          def collect_hash_keys: (Array[untyped] values) -> Set[String]
+
+          private
+
+          def determine_hash_presence: (Array[untyped] row) -> bool
+        end
+
+        class RowProcessor
+          @data_extractor: TableDataExtractor
+          @hide_main_row: bool
+          @hide_key_rows: bool
+
+          def initialize: (TableDataExtractor data_extractor, ?Hash[Symbol, untyped] options) -> void
+          def process_simple_rows: (Array[Array[untyped]] rows) -> Array[Array[untyped]]
+          def process_expanded_rows: (Array[Array[untyped]] rows) -> Array[Array[untyped]]
+
+          private
+
+          def process_non_hash_row: (Array[untyped] row) -> Array[untyped]
+          def expand_row: (Array[untyped] row) -> Array[Array[untyped]]
+          def build_expanded_rows: (Hash[Symbol, untyped] row_data, Set[String] all_hash_keys, Array[untyped] original_row) -> Array[Array[untyped]]
+          def should_show_main_row?: () -> bool
+          def should_show_key_rows?: () -> bool
+          def build_main_expanded_row: (Hash[Symbol, untyped] row_data) -> Array[untyped]
+          def build_key_rows: (Set[String] all_hash_keys, Hash[Symbol, untyped] row_data, Array[untyped] original_row) -> Array[Array[untyped]]
+          def build_key_row: (String key, Hash[Symbol, untyped] row_data, Array[untyped] original_row) -> Array[untyped]
+          def process_key_values: (String key, Array[untyped] values, Array[untyped] original_row) -> Array[untyped]
+          def extract_hash_value: (untyped value, String key) -> untyped
+          def handle_non_hash_value: (Array[untyped] original_row, Integer index) -> untyped
+        end
+
+        class ColumnWidthCalculator
+          @table_style: Symbol
+          @min_column_width: Integer
+          @max_column_width: Integer
+
+          def initialize: (?table_style: Symbol, ?min_column_width: Integer, ?max_column_width: Integer) -> void
+          def calculate: (Integer col_count, Array[String] headers, Array[Array[untyped]] rows) -> Array[Integer]
+          def calculate_widths: (Array[String] headers, Array[Array[untyped]] rows) -> Array[Integer]
+
+          private
+
+          def initialize_column_widths: (Integer col_count, Array[String] headers) -> Array[Integer]
+          def update_widths_from_rows: (Array[Integer] widths, Array[Array[untyped]] rows, Integer col_count) -> void
+          def apply_minimum_widths: (Array[Integer] widths) -> Array[Integer]
+          def calculate_cell_width: (untyped cell) -> Integer
+        end
+
+        class TableRenderer
+          @table_style: Symbol
+          @max_column_width: Integer
+
+          def initialize: (?table_style: Symbol, ?max_column_width: Integer) -> void
+          def render: (Array[String] headers, Array[Array[untyped]] rows, Array[Integer] column_widths) -> Array[String]
+          def render_table: (Array[String] headers, Array[Array[untyped]] rows, Array[Integer] column_widths) -> Array[String]
+
+          private
+
+          def build_row: (Array[untyped] cells, Array[Integer] col_widths) -> String
+          def build_separator: (Array[Integer] col_widths) -> String
+          def format_cells: (Array[untyped] cells, Array[Integer] col_widths) -> Array[String]
+          def format_cell_content: (untyped cell) -> String
+        end
+      end
+
+      class FooterComponent < Base::BaseComponent
+        def initialize: (Hash[Symbol, untyped] options) -> void
+        def generate: () -> Array[String]
+        def generate_detailed_footer: () -> Array[String]
+        def generate_default_footer: () -> Array[String]
+
+        private
+
+        def build_footer_content: () -> Array[String]
+      end
+
+      class MissingBehaviorsComponent < Base::BaseComponent
+        @missing_behaviors: Hash[String, Hash[String, String]]
+
+        def generate: () -> Array[String]
+        def track_missing_behaviors: () -> void
+        def generate_missing_behaviors_summary: () -> Array[String]
+        def generate_grouped_summary: () -> Array[String]
+        def generate_flat_summary: () -> Array[String]
+        def generate_detailed_summary: () -> Array[String]
+
+        private
+
+        def find_missing_behaviors: () -> Hash[String, Array[String]]
+        def format_missing_behaviors: (Hash[String, Array[String]] missing) -> Array[String]
+      end
+
+      class GenericHeaderComponent < Base::BaseComponent
+        def generate: () -> Array[String]
+        def generate_markdown_header: () -> Array[String]
+        def generate_csv_header: () -> Array[String]
+      end
+    end
+  end
+end

data/sig/formatters_main.rbs

@@ -0,0 +1,20 @@
+# Main formatter classes
+module ClassMetrix
+  class MarkdownFormatter < Formatters::Base::BaseFormatter
+    def initialize: (Hash[Symbol, untyped] data, ?bool expand_hashes, ?Hash[Symbol, untyped] options) -> void
+    def format: () -> String
+
+    private
+
+    def generate_markdown_content: () -> String
+  end
+
+  class CsvFormatter < Formatters::Base::BaseFormatter
+    def initialize: (Hash[Symbol, untyped] data, ?bool expand_hashes, ?Hash[Symbol, untyped] options) -> void
+    def format: () -> String
+
+    private
+
+    def generate_csv_content: () -> String
+  end
+end

data/sig/formatters_shared.rbs

@@ -0,0 +1,102 @@
+# Shared table builder classes and value processor
+module ClassMetrix
+  module Formatters
+    module Shared
+      class ValueProcessor
+        def self.process_for_markdown: (untyped value, ?debug_mode: bool, ?debug_level: Symbol) -> String
+        def self.process_for_csv: (untyped value, ?Hash[Symbol, untyped] options, ?debug_mode: bool, ?debug_level: Symbol) -> String
+        def self.process_csv_value_by_type: (untyped value, untyped logger, String null_value) -> String
+        def self.process_hash_for_csv: (Hash[untyped, untyped] value, untyped logger) -> String
+        def self.process_array_for_csv: (Array[untyped] value, untyped logger) -> String
+        def self.process_string_for_csv: (String value, String null_value) -> String
+        def self.process_other_for_csv: (untyped value, untyped logger) -> String
+        def self.safe_hash_lookup: (Hash[untyped, untyped] hash, untyped key, ?debug_mode: bool, ?debug_level: Symbol) -> untyped
+        def self.has_hash_key?: (Hash[untyped, untyped] hash, untyped key, ?debug_mode: bool, ?debug_level: Symbol) -> bool
+        def self.missing_constant: () -> String
+        def self.missing_method: () -> String
+        def self.handle_extraction_error: (Exception error) -> String
+        def self.missing_hash_key: () -> String
+      end
+      class TableBuilder
+        @data: Hash[Symbol, untyped]
+        @expand_hashes: bool
+        @options: Hash[Symbol, untyped]
+
+        def initialize: (Hash[Symbol, untyped] data, bool expand_hashes, Hash[Symbol, untyped] options) -> void
+        def build: () -> Array[String]
+        def build_simple_table: () -> Hash[Symbol, untyped]
+        def build_expanded_table: () -> Hash[Symbol, untyped]
+        def build_flattened_table: () -> Hash[Symbol, untyped]
+        def process_rows_for_expansion: (Array[String] headers) -> Array[Array[untyped]]
+        def row_has_expandable_hash?: (Array[untyped] row) -> bool
+        def create_flattened_rows: (Array[Array[untyped]] rows, Array[String] headers, Hash[String, Set[String]] all_hash_keys) -> Array[Array[untyped]]
+        def has_type_column?: () -> bool
+        def behavior_column_index: () -> Integer
+        def value_start_index: () -> Integer
+        def class_headers: () -> Array[String]
+        def process_row: (Array[untyped] row) -> Array[untyped]
+        def process_value: (untyped value) -> String
+        def expand_row: (Array[untyped] row, Array[String] _headers) -> Array[Array[untyped]]
+        def collect_hash_keys_from_values: (Array[untyped] values) -> Set[String]
+        def build_expanded_row_set: (Array[untyped] row, String behavior_name, Array[untyped] values, Set[String] all_hash_keys) -> Array[Array[untyped]]
+        def should_show_main_row?: () -> bool
+        def should_show_key_rows?: () -> bool
+        def build_main_row: (Array[untyped] row, String behavior_name, Array[untyped] values) -> Array[untyped]
+        def build_sub_rows: (Set[String] all_hash_keys, Array[untyped] values) -> Array[Array[untyped]]
+        def build_single_sub_row: (String key, Array[untyped] values) -> Array[untyped]
+        def extract_key_values: (Array[untyped] values, String key) -> Array[untyped]
+        def extract_single_key_value: (untyped value, String key) -> untyped
+        def extract_hash_value_for_key: (Hash[untyped, untyped] hash, String key) -> untyped
+        def collect_all_hash_keys: (Array[Array[untyped]] rows, Array[String] _headers) -> Hash[String, Set[String]]
+        def collect_hash_keys_for_row: (Array[untyped] row, Integer value_start_idx, Hash[String, Set[String]] all_keys) -> Integer
+        def create_flattened_headers: (Array[String] headers, Hash[String, Set[String]] all_hash_keys) -> Array[String]
+        def add_hash_key_headers: (Array[String] flattened, Hash[String, Set[String]] all_hash_keys, Array[String] class_hdrs) -> void
+        def add_behavior_key_headers: (Array[String] flattened, String behavior_name, Set[String] keys, Array[String] class_hdrs) -> void
+        def flatten_row: (Array[untyped] row, Array[String] _headers, Hash[String, Set[String]] all_hash_keys) -> Array[untyped]
+        def extract_hash_key_value: (Hash[untyped, untyped] hash, String key) -> untyped
+        def add_flattened_hash_values: (Array[untyped] flattened, Array[untyped] row, String behavior_name, Hash[String, Set[String]] all_hash_keys) -> void
+        def add_flattened_values_for_key: (Array[untyped] flattened, Array[untyped] values, String key) -> void
+        def extract_flattened_value: (untyped value, String key) -> untyped
+        def get_null_value: () -> String
+
+        private
+
+        def create_header_row: (Array[String] headers) -> String
+        def create_separator_row: (Array[String] headers) -> String
+        def create_data_row: (Array[untyped] row) -> String
+      end
+
+      class MarkdownTableBuilder < TableBuilder
+        def build: () -> Array[String]
+        def process_value: (untyped value) -> String
+        def get_null_value: () -> String
+        def expand_row: (Array[untyped] row, Array[String] _headers) -> Array[Array[untyped]]
+        def collect_unique_hash_keys: (Array[untyped] values) -> Set[String]
+        def build_expanded_row_structure: (Array[untyped] row, String behavior_name, Array[untyped] values, Set[String] all_hash_keys) -> Array[Array[untyped]]
+        def build_main_row: (Array[untyped] row, String behavior_name, Array[untyped] values) -> Array[untyped]
+        def build_hash_key_rows: (Array[untyped] row, String behavior_name, Array[untyped] values, Set[String] all_hash_keys) -> Array[Array[untyped]]
+        def build_single_key_row: (Array[untyped] row, String behavior_name, Array[untyped] values, String key) -> Array[untyped]
+        def extract_key_values_for_row: (Array[untyped] values, String key) -> Array[untyped]
+        def extract_single_key_value: (untyped value, String key) -> untyped
+        def extract_hash_key_value: (Hash[untyped, untyped] hash, String key) -> untyped
+
+        private
+
+        def create_header_row: (Array[String] headers) -> String
+        def create_separator_row: (Array[String] headers) -> String
+        def create_data_row: (Array[untyped] row) -> String
+      end
+
+      class CsvTableBuilder < TableBuilder
+        def build: () -> Array[String]
+        def process_value: (untyped value) -> String
+        def get_null_value: () -> String
+
+        private
+
+        def create_csv_row: (Array[untyped] row) -> String
+        def escape_csv_value: (untyped value) -> String
+      end
+    end
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,32 @@
+# manifest.yaml for RBS type definitions
+# This file defines the structure and dependencies of the RBS signatures
+
+dependencies:
+  - name: csv
+    version: "~> 3.0"
+  - name: pathname
+    version: "~> 0.2"
+  - name: json
+    version: "~> 2.0"
+  - name: fileutils
+    version: "~> 1.0"
+
+type_definitions:
+  - class_metrix.rbs         # Main module and entry point
+  - version.rbs              # Version constant
+  - extractor.rbs            # Core extractor fluent interface
+  - extractors.rbs           # Specialized extractor classes
+  - formatters_base.rbs      # Base formatter and component classes
+  - formatters_components.rbs # Component classes for formatters
+  - formatters_shared.rbs    # Shared table builder classes
+  - formatters_main.rbs      # Main formatter classes
+  - utils.rbs                # Utility classes and processors
+
+coverage_targets:
+  - lib/class_metrix.rb
+  - lib/class_metrix/version.rb
+  - lib/class_metrix/extractor.rb
+  - lib/class_metrix/extractors/
+  - lib/class_metrix/formatters/
+  - lib/class_metrix/utils/
+  - lib/class_metrix/processors/

data/sig/utils.rbs

@@ -0,0 +1,57 @@
+# Utility classes
+module ClassMetrix
+  module Utils
+    class ClassResolver
+      def self.normalize_classes: (Array[Class | String] classes) -> Array[Class]
+      def self.resolve_class: (Class | String klass) -> Class
+      def self.string_to_class: (String class_name) -> Class
+    end
+
+    class DebugLogger
+      LEVELS: Hash[Symbol, Integer]
+
+      @component_name: String
+      @debug_mode: bool
+      @level: Integer
+
+      def initialize: (String component_name, bool debug_mode, Symbol debug_level) -> void
+      def log: (String message, ?Symbol level) -> void
+      def enabled?: () -> bool
+      def log_safe_operation: (String operation_name, ?Symbol level) { () -> untyped } -> untyped
+      def log_summary: (String operation, Array[untyped] items) { (untyped item, Integer index) -> void } -> void
+      def log_decision: (String decision, String reason, ?Symbol level) -> void
+      def log_anomaly: (String description) -> void
+      def safe_inspect: (untyped value) -> String
+      def safe_class: (untyped value) -> String
+      def safe_keys: (untyped value) -> String
+      def safe_length: (untyped value) -> String
+      def safe_truncate: (String str, Integer max_length) -> String
+      def safe_to_s: (untyped value) -> String
+      def log_value_details: (untyped value, ?Integer? index, ?Symbol level) -> void
+      def log_hash_detection: (untyped value, ?Integer? index, ?Symbol level) -> void
+      def log_hash_detection_summary: (Array[untyped] values) -> void
+      def set_level: (Symbol level) -> void
+
+      private
+
+      def should_log?: (Symbol level) -> bool
+      def format_message: (String message) -> String
+    end
+  end
+end
+
+# Root level classes for processors
+class ValueProcessor
+  def self.process: (untyped value, ?expand_hashes: bool) -> untyped
+  def self.format_hash: (Hash[untyped, untyped] hash) -> String
+  def self.expand_hash: (Hash[untyped, untyped] hash) -> Array[Hash[Symbol, untyped]]
+  def self.handle_extraction_error: (Exception error) -> String
+  def self.missing_constant: () -> String
+  def self.missing_method: () -> String
+end
+
+# Root level utility class references
+module ClassMetrix
+  class ClassResolver < Utils::ClassResolver
+  end
+end

data/sig/value_processor.rbs

@@ -0,0 +1,11 @@
+# Legacy value processor for backward compatibility
+module ClassMetrix
+  class ValueProcessor
+    def self.process: (untyped value, ?expand_hashes: bool) -> (String | Array[Hash[Symbol, untyped]])
+    def self.format_hash: (Hash[untyped, untyped] hash) -> String
+    def self.expand_hash: (Hash[untyped, untyped] hash) -> Array[Hash[Symbol, untyped]]
+    def self.handle_extraction_error: (Exception error) -> String
+    def self.missing_constant: () -> String
+    def self.missing_method: () -> String
+  end
+end

data/sig/version.rbs

@@ -0,0 +1,4 @@
+# Version information
+module ClassMetrix
+  VERSION: String
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: class-metrix
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Huy Nguyen
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2025-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: ClassMetrix allows you to easily extract and compare constants and class
   methods across multiple Ruby classes, generating clean markdown tables for analysis
   and documentation.
@@ -47,23 +75,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- ".vscode/README.md"
+- ".vscode/extensions.json"
+- ".vscode/keybindings.json"
+- ".vscode/launch.json"
+- ".vscode/rbs.code-snippets"
+- ".vscode/settings.json"
+- ".vscode/tasks.json"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - RELEASE_GUIDE.md
 - Rakefile
+- Steepfile
+- docs/ARCHITECTURE.md
+- docs/CHANGELOG_EVOLUTION_EXAMPLE.md
 - examples/README.md
-- examples/advanced/error_handling.rb
-- examples/advanced/hash_expansion.rb
-- examples/basic/01_simple_constants.rb
-- examples/basic/02_simple_methods.rb
-- examples/basic/03_multi_type_extraction.rb
-- examples/components/configurable_reports.rb
-- examples/csv_output_demo.rb
-- examples/real_world/microservices_audit.rb
+- examples/basic_usage.rb
+- examples/debug_levels_demo.rb
+- examples/debug_mode_demo.rb
+- examples/inheritance_and_modules.rb
 - lib/class_metrix.rb
 - lib/class_metrix/extractor.rb
 - lib/class_metrix/extractors/constants_extractor.rb
@@ -76,6 +111,10 @@ files:
 - lib/class_metrix/formatters/components/header_component.rb
 - lib/class_metrix/formatters/components/missing_behaviors_component.rb
 - lib/class_metrix/formatters/components/table_component.rb
+- lib/class_metrix/formatters/components/table_component/column_width_calculator.rb
+- lib/class_metrix/formatters/components/table_component/row_processor.rb
+- lib/class_metrix/formatters/components/table_component/table_data_extractor.rb
+- lib/class_metrix/formatters/components/table_component/table_renderer.rb
 - lib/class_metrix/formatters/csv_formatter.rb
 - lib/class_metrix/formatters/markdown_formatter.rb
 - lib/class_metrix/formatters/shared/csv_table_builder.rb
@@ -84,8 +123,19 @@ files:
 - lib/class_metrix/formatters/shared/value_processor.rb
 - lib/class_metrix/processors/value_processor.rb
 - lib/class_metrix/utils/class_resolver.rb
+- lib/class_metrix/utils/debug_logger.rb
 - lib/class_metrix/version.rb
-- sig/class/metrix.rbs
+- sig/class_metrix.rbs
+- sig/extractor.rbs
+- sig/extractors.rbs
+- sig/formatters_base.rbs
+- sig/formatters_components.rbs
+- sig/formatters_main.rbs
+- sig/formatters_shared.rbs
+- sig/manifest.yaml
+- sig/utils.rbs
+- sig/value_processor.rbs
+- sig/version.rbs
 homepage: https://github.com/patrick204nqh/class-metrix
 licenses:
 - MIT