class-metrix 0.1.2 → 1.0.0

data/lib/class_metrix/utils/debug_logger.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module ClassMetrix
+  module Utils
+    # Debug logging utility for ClassMetrix
+    # Provides safe, consistent debug output across all components
+    class DebugLogger
+      # Debug levels: :basic, :detailed, :verbose
+      LEVELS = { basic: 1, detailed: 2, verbose: 3 }.freeze
+
+      def initialize(component_name, debug_mode = false, level = :basic)
+        @component_name = component_name
+        @debug_mode = debug_mode
+        @level = LEVELS[level] || LEVELS[:basic]
+      end
+
+      def log(message, level = :basic)
+        return unless @debug_mode && LEVELS[level] <= @level
+
+        puts "[DEBUG #{@component_name}] #{message}"
+      end
+
+      def log_safe_operation(operation_name, level = :detailed, &block)
+        log("Starting #{operation_name}", level)
+        result = block.call
+        log("Completed #{operation_name} successfully", level)
+        result
+      rescue StandardError => e
+        log("Error in #{operation_name}: #{e.class.name}: #{e.message}")
+        raise
+      end
+
+      # Summary logging for groups of similar operations
+      def log_summary(operation, items, &block)
+        return unless @debug_mode
+
+        if @level >= LEVELS[:detailed]
+          log("#{operation} (#{items.length} items)")
+          items.each_with_index { |item, i| block.call(item, i) } if block_given?
+        else
+          log("#{operation} (#{items.length} items)")
+        end
+      end
+
+      def log_decision(decision, reason, level = :basic)
+        log("Decision: #{decision} - #{reason}", level)
+      end
+
+      def log_anomaly(description)
+        log("⚠️ Anomaly: #{description}")
+      end
+
+      # Safe inspection methods to handle problematic objects
+      def safe_inspect(value)
+        value.inspect
+      rescue StandardError => e
+        "[inspect failed: #{e.class.name}]"
+      end
+
+      def safe_class(value)
+        value.class
+      rescue StandardError => e
+        "[class failed: #{e.class.name}]"
+      end
+
+      def safe_keys(value)
+        value.keys
+      rescue StandardError => e
+        "[keys failed: #{e.class.name}]"
+      end
+
+      def safe_length(value)
+        value.length
+      rescue StandardError
+        "[length failed]"
+      end
+
+      def safe_truncate(str, max_length)
+        return str unless str.respond_to?(:length) && str.respond_to?(:[])
+
+        str.length > max_length ? "#{str[0...max_length]}..." : str
+      rescue StandardError => e
+        "[truncate failed: #{e.class.name}]"
+      end
+
+      def safe_to_s(value)
+        value.to_s
+      rescue StandardError => e
+        begin
+          value.class.name
+        rescue StandardError => e2
+          "[to_s failed: #{e.class.name}, class failed: #{e2.class.name}]"
+        end
+      end
+
+      def log_value_details(value, index = nil, level = :verbose)
+        return unless @debug_mode && @level >= LEVELS[level]
+
+        prefix = index ? "Value #{index}" : "Value"
+        log("#{prefix}: #{safe_inspect(value)} (#{safe_class(value)})", level)
+      end
+
+      def log_hash_detection(value, index = nil, level = :detailed)
+        return unless @debug_mode && @level >= LEVELS[level]
+
+        prefix = index ? "Value #{index}" : "Value"
+        is_hash = value.is_a?(Hash)
+        is_real_hash = value.is_a?(Hash) && value.instance_of?(Hash)
+
+        return unless is_hash
+
+        log("#{prefix} hash detection:")
+        log("  is_a?(Hash): #{is_hash}, class == Hash: #{is_real_hash}")
+        log("  respond_to?(:keys): #{value.respond_to?(:keys)}")
+
+        if is_hash && is_real_hash
+          log("  keys: #{safe_keys(value)}")
+        elsif is_hash
+          log_anomaly("Hash-like object (#{safe_class(value)}) but not real Hash - will be skipped")
+        end
+      end
+
+      # Smart hash detection summary
+      def log_hash_detection_summary(values)
+        return unless @debug_mode
+
+        hash_count = 0
+        real_hash_count = 0
+        anomaly_count = 0
+
+        values.each do |value|
+          next unless value.is_a?(Hash)
+
+          hash_count += 1
+          if value.instance_of?(Hash)
+            real_hash_count += 1
+          else
+            anomaly_count += 1
+          end
+        end
+
+        return unless hash_count.positive?
+
+        log("Hash detection summary: #{real_hash_count} real hashes, #{anomaly_count} hash-like objects")
+        log_anomaly("Found #{anomaly_count} hash-like proxy objects") if anomaly_count.positive?
+      end
+
+      def enabled?
+        @debug_mode
+      end
+
+      attr_reader :level
+
+      def set_level(level)
+        @level = LEVELS[level] || LEVELS[:basic]
+      end
+    end
+  end
+end

data/lib/class_metrix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClassMetrix
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 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.0
 platform: ruby
 authors:
 - Huy Nguyen
@@ -47,23 +47,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- ".vscode/README.md"
+- ".vscode/extensions.json"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
+- ".vscode/tasks.json"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - RELEASE_GUIDE.md
 - Rakefile
+- docs/ARCHITECTURE.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 +79,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,6 +91,7 @@ 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
 homepage: https://github.com/patrick204nqh/class-metrix

data/examples/advanced/error_handling.rb

@@ -1,199 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-puts "=== Advanced Example: Error Handling ==="
-puts
-
-# Classes that demonstrate various error scenarios
-class WorkingService
-  # Working constants
-  SERVICE_NAME = "working"
-  VERSION = "1.0.0"
-  ENABLED = true
-
-  # Working methods
-  def self.status
-    "healthy"
-  end
-
-  def self.version
-    "1.0.0"
-  end
-
-  def self.health_check
-    { status: "ok", uptime: 12_345 }
-  end
-
-  def self.enabled?
-    true
-  end
-end
-
-class PartiallyBrokenService
-  # Working constants
-  SERVICE_NAME = "partially_broken"
-  VERSION = "0.9.0"
-  # Missing ENABLED constant
-
-  # Working methods
-  def self.status
-    "degraded"
-  end
-
-  def self.version
-    "0.9.0"
-  end
-
-  # Broken method that raises an error
-  def self.health_check
-    raise StandardError, "Health check failed!"
-  end
-
-  def self.enabled?
-    false
-  end
-
-  # Method that returns nil
-  def self.uptime
-    nil
-  end
-
-  # Method with complex error
-  def self.database_connection
-    raise ActiveRecord::ConnectionNotEstablished, "Database unavailable"
-  rescue NameError
-    # If ActiveRecord is not available, raise a different error
-    raise "Connection library not available"
-  end
-end
-
-class CompletelyBrokenService
-  # Has some constants
-  SERVICE_NAME = "broken"
-  # Missing VERSION and ENABLED
-
-  # Has working method
-  def self.status
-    "down"
-  end
-
-  # Missing version method
-
-  # Broken health_check
-  def self.health_check
-    raise NoMethodError, "Health monitoring not implemented"
-  end
-
-  # Method that raises during execution
-  def self.enabled?
-    some_undefined_variable.call
-  end
-
-  # Method that returns false
-  def self.deprecated?
-    true
-  end
-end
-
-puts "=== Service Classes Defined ==="
-puts "WorkingService: All methods work"
-puts "PartiallyBrokenService: Some methods fail"
-puts "CompletelyBrokenService: Most methods fail"
-puts
-
-# 1. Extract without error handling (will raise errors)
-puts "💥 1. WITHOUT ERROR HANDLING (This will show errors)"
-puts "-" * 60
-
-begin
-  result = ClassMetrix.extract(:class_methods)
-                      .from([WorkingService, PartiallyBrokenService])
-                      .filter(/health_check/)
-                      .to_markdown
-  puts result
-rescue StandardError => e
-  puts "❌ Error occurred: #{e.class.name}: #{e.message}"
-end
-puts
-
-# 2. Extract with error handling
-puts "🛡️ 2. WITH ERROR HANDLING (Graceful failure)"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 3. Constants with missing values
-puts "📋 3. CONSTANTS WITH MISSING VALUES"
-puts "-" * 60
-result = ClassMetrix.extract(:constants)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 4. Multi-type extraction with errors
-puts "📊 4. MULTI-TYPE WITH ERROR HANDLING"
-puts "-" * 60
-result = ClassMetrix.extract(:constants, :class_methods)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .filter(/SERVICE_NAME|status|enabled/)
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 5. Focus on problematic methods
-puts "🔍 5. PROBLEMATIC METHODS ANALYSIS"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .filter(/health_check|database|uptime/)
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 6. Boolean and nil value handling
-puts "✅ 6. BOOLEAN AND NIL VALUE HANDLING"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .filter(/enabled\?|deprecated\?|uptime/)
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 7. Save comprehensive error analysis report
-puts "💾 7. SAVING COMPREHENSIVE ERROR ANALYSIS REPORT"
-puts "-" * 60
-report = ClassMetrix.extract(:constants, :class_methods)
-                    .from([WorkingService, PartiallyBrokenService, CompletelyBrokenService])
-                    .handle_errors
-                    .to_markdown("error_analysis_report.md", title: "Service Health Analysis Report")
-
-puts "✅ Comprehensive error analysis saved to: error_analysis_report.md"
-puts "📊 Report contains #{report.lines.count} lines with rich metadata"
-puts
-
-puts "🛡️ Enhanced Error Handling Features Demonstrated:"
-puts "• 🚫 Missing constants: '🚫 Not defined'"
-puts "• 🚫 Missing methods: '🚫 No method'"
-puts "• ⚠️ Runtime errors: '⚠️ Error: [descriptive message]'"
-puts "• ❌ Boolean false and nil values: '❌'"
-puts "• ✅ Boolean true values: '✅'"
-puts "• 📊 Rich markdown reports with titles and metadata"
-puts "• 📋 Missing behaviors summary per class"
-puts "• 🛡️ handle_errors flag enables graceful degradation"

data/examples/advanced/hash_expansion.rb

@@ -1,180 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-puts "=== Advanced Example: Hash Expansion ==="
-puts
-
-# Configuration classes with complex hash structures
-class DatabaseConfig
-  # Hash constants
-  DEFAULT_CONFIG = {
-    host: "localhost",
-    port: 5432,
-    ssl: true,
-    pool_size: 5
-  }.freeze
-
-  CONNECTION_POOLS = {
-    read: { size: 10, timeout: 30 },
-    write: { size: 5, timeout: 15 },
-    admin: { size: 2, timeout: 60 }
-  }.freeze
-
-  # Hash methods
-  def self.production_config
-    {
-      host: "db.production.com",
-      port: 5432,
-      database: "myapp_production",
-      ssl: true,
-      pool_size: 20,
-      timeout: 30,
-      backup_enabled: true
-    }
-  end
-
-  def self.development_config
-    {
-      host: "localhost",
-      port: 5432,
-      database: "myapp_development",
-      ssl: false,
-      pool_size: 5,
-      timeout: 10
-    }
-  end
-
-  def self.simple_value
-    "not a hash"
-  end
-end
-
-class RedisConfig
-  # Hash constants
-  DEFAULT_CONFIG = {
-    host: "localhost",
-    port: 6379,
-    ssl: false,
-    timeout: 5
-  }.freeze
-
-  CLUSTER_CONFIG = {
-    nodes: 3,
-    replication: true,
-    failover: "auto"
-  }.freeze
-
-  # Hash methods
-  def self.production_config
-    {
-      host: "redis.internal",
-      port: 6379,
-      database: 0,
-      ssl: false,
-      max_connections: 100,
-      cluster_enabled: true
-    }
-  end
-
-  def self.development_config
-    {
-      host: "localhost",
-      port: 6379,
-      database: 1,
-      ssl: false,
-      max_connections: 10
-    }
-  end
-
-  def self.simple_value
-    42
-  end
-end
-
-puts "=== Configuration Classes Defined ==="
-puts "DatabaseConfig and RedisConfig with hash constants and methods"
-puts
-
-# 1. Normal output (without expansion)
-puts "📋 1. NORMAL OUTPUT (Hashes as inspect strings)"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([DatabaseConfig, RedisConfig])
-                    .filter(/config$/)
-                    .to_markdown
-
-puts result
-puts
-
-# 2. Expanded output
-puts "🔍 2. EXPANDED OUTPUT (Hash keys as sub-rows)"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([DatabaseConfig, RedisConfig])
-                    .filter(/config$/)
-                    .expand_hashes
-                    .to_markdown
-
-puts result
-puts
-
-# 3. Constants with expansion
-puts "📊 3. CONSTANTS WITH HASH EXPANSION"
-puts "-" * 60
-result = ClassMetrix.extract(:constants)
-                    .from([DatabaseConfig, RedisConfig])
-                    .filter(/CONFIG/)
-                    .expand_hashes
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 4. Mixed data types with expansion
-puts "🔧 4. MIXED DATA TYPES WITH EXPANSION"
-puts "-" * 60
-result = ClassMetrix.extract(:class_methods)
-                    .from([DatabaseConfig, RedisConfig])
-                    .expand_hashes
-                    .to_markdown
-
-puts result
-puts
-
-# 5. Multi-type extraction with expansion
-puts "🚀 5. MULTI-TYPE WITH HASH EXPANSION"
-puts "-" * 60
-result = ClassMetrix.extract(:constants, :class_methods)
-                    .from([DatabaseConfig, RedisConfig])
-                    .filter(/DEFAULT_CONFIG|production_config/)
-                    .expand_hashes
-                    .handle_errors
-                    .to_markdown
-
-puts result
-puts
-
-# 6. Save expanded report
-puts "💾 6. SAVING EXPANDED REPORT"
-puts "-" * 60
-report = ClassMetrix.extract(:constants, :class_methods)
-                    .from([DatabaseConfig, RedisConfig])
-                    .expand_hashes
-                    .handle_errors
-                    .to_markdown("config_analysis_expanded.md")
-
-puts "✅ Expanded report saved to: config_analysis_expanded.md"
-puts "📊 Report contains #{report.lines.count} lines"
-puts
-
-puts "✨ Hash Expansion Features Demonstrated:"
-puts "• 📋 Hash indicators show number of keys"
-puts "• └─ Sub-rows show individual key-value pairs"
-puts "• ❌ Missing keys shown clearly"
-puts "• — Non-hash values shown with dash"
-puts "• Mixed data types handled properly"
-puts "• Works with both constants and methods"
-puts "• Compatible with multi-type extraction"

data/examples/basic/01_simple_constants.rb

@@ -1,56 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-puts "=== Basic Example 1: Simple Constants ==="
-puts
-
-# Define some simple classes with constants
-class User
-  ROLE_NAME = "user"
-  MAX_LOGIN_ATTEMPTS = 3
-  ACCOUNT_TYPE = "standard"
-end
-
-class Admin
-  ROLE_NAME = "admin"
-  MAX_LOGIN_ATTEMPTS = 5
-  ACCOUNT_TYPE = "premium"
-  ADMIN_LEVEL = 10
-end
-
-class Guest
-  ROLE_NAME = "guest"
-  MAX_LOGIN_ATTEMPTS = 1
-  ACCOUNT_TYPE = "basic"
-end
-
-puts "Classes defined: User, Admin, Guest"
-puts "Constants: ROLE_NAME, MAX_LOGIN_ATTEMPTS, ACCOUNT_TYPE, ADMIN_LEVEL"
-puts
-
-# Extract all constants
-puts "📋 All Constants:"
-puts ClassMetrix.extract(:constants)
-                .from([User, Admin, Guest])
-                .to_markdown
-puts
-
-# Extract filtered constants
-puts "🔍 Filtered Constants (ROLE and MAX):"
-puts ClassMetrix.extract(:constants)
-                .from([User, Admin, Guest])
-                .filter(/ROLE|MAX/)
-                .to_markdown
-puts
-
-# Extract with regex filter
-puts "🎯 Regex Filter (starting with ACCOUNT):"
-puts ClassMetrix.extract(:constants)
-                .from([User, Admin, Guest])
-                .filter(/^ACCOUNT/)
-                .to_markdown
-puts
-
-puts "✨ This example shows basic constant extraction and filtering!"