class-metrix 0.1.2 → 1.0.0

data/examples/basic/02_simple_methods.rb

@@ -1,99 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-puts "=== Basic Example 2: Simple Class Methods ==="
-puts
-
-# Define some simple classes with class methods
-class PaymentProcessor
-  def self.supported_currencies
-    %w[USD EUR GBP]
-  end
-
-  def self.max_amount
-    10_000
-  end
-
-  def self.requires_verification?
-    false
-  end
-
-  def self.processing_fee
-    2.5
-  end
-end
-
-class StripeProcessor
-  def self.supported_currencies
-    %w[USD EUR GBP CAD AUD]
-  end
-
-  def self.max_amount
-    50_000
-  end
-
-  def self.requires_verification?
-    true
-  end
-
-  def self.processing_fee
-    2.9
-  end
-
-  def self.supports_recurring?
-    true
-  end
-end
-
-class PayPalProcessor
-  def self.supported_currencies
-    %w[USD EUR]
-  end
-
-  def self.max_amount
-    25_000
-  end
-
-  def self.requires_verification?
-    true
-  end
-
-  def self.processing_fee
-    3.4
-  end
-
-  def self.instant_transfer?
-    false
-  end
-end
-
-puts "Classes defined: PaymentProcessor, StripeProcessor, PayPalProcessor"
-puts "Methods: supported_currencies, max_amount, requires_verification?, processing_fee, etc."
-puts
-
-# Extract all class methods
-puts "📋 All Class Methods:"
-puts ClassMetrix.extract(:class_methods)
-                .from([PaymentProcessor, StripeProcessor, PayPalProcessor])
-                .to_markdown
-puts
-
-# Extract boolean methods only
-puts "✅ Boolean Methods (ending with ?):"
-puts ClassMetrix.extract(:class_methods)
-                .from([PaymentProcessor, StripeProcessor, PayPalProcessor])
-                .filter(/\?$/)
-                .to_markdown
-puts
-
-# Extract configuration methods
-puts "⚙️ Configuration Methods (max, fee, supported):"
-puts ClassMetrix.extract(:class_methods)
-                .from([PaymentProcessor, StripeProcessor, PayPalProcessor])
-                .filter(/max|fee|supported/)
-                .to_markdown
-puts
-
-puts "✨ This example shows class method extraction with different return types!"

data/examples/basic/03_multi_type_extraction.rb

@@ -1,116 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-puts "=== Basic Example 3: Multi-Type Extraction ==="
-puts
-
-# Define classes with both constants and methods
-class EmailService
-  # Constants
-  PROVIDER_NAME = "smtp"
-  DEFAULT_PORT = 587
-  ENCRYPTION_ENABLED = true
-
-  # Class methods
-  def self.provider_name
-    "SMTP Service"
-  end
-
-  def self.default_port
-    587
-  end
-
-  def self.encryption_enabled?
-    true
-  end
-
-  def self.rate_limit
-    100
-  end
-end
-
-class SendGridService
-  # Constants
-  PROVIDER_NAME = "sendgrid"
-  DEFAULT_PORT = 443
-  ENCRYPTION_ENABLED = true
-  API_VERSION = "v3"
-
-  # Class methods
-  def self.provider_name
-    "SendGrid API"
-  end
-
-  def self.default_port
-    443
-  end
-
-  def self.encryption_enabled?
-    true
-  end
-
-  def self.rate_limit
-    1000
-  end
-
-  def self.api_version
-    "v3"
-  end
-end
-
-class MailgunService
-  # Constants
-  PROVIDER_NAME = "mailgun"
-  DEFAULT_PORT = 443
-  ENCRYPTION_ENABLED = true
-
-  # Class methods
-  def self.provider_name
-    "Mailgun API"
-  end
-
-  def self.default_port
-    443
-  end
-
-  def self.encryption_enabled?
-    true
-  end
-
-  def self.rate_limit
-    500
-  end
-end
-
-puts "Classes defined: EmailService, SendGridService, MailgunService"
-puts "Each has constants AND class methods with similar names"
-puts
-
-# Compare constants vs methods
-puts "📊 Multi-Type Extraction (Constants + Methods):"
-puts ClassMetrix.extract(:constants, :class_methods)
-                .from([EmailService, SendGridService, MailgunService])
-                .filter(/provider_name|default_port|encryption/)
-                .to_markdown
-puts
-
-# Compare specific behaviors
-puts "🎯 Rate Limiting Comparison:"
-puts ClassMetrix.extract(:constants, :class_methods)
-                .from([EmailService, SendGridService, MailgunService])
-                .filter(/rate_limit/)
-                .to_markdown
-puts
-
-# API-specific features
-puts "🔌 API Features:"
-puts ClassMetrix.extract(:constants, :class_methods)
-                .from([EmailService, SendGridService, MailgunService])
-                .filter(/API|version/)
-                .to_markdown
-puts
-
-puts "✨ This example shows how to compare both constants and methods in one table!"
-puts "Notice how the 'Type' column distinguishes between constants and methods."

data/examples/components/configurable_reports.rb

@@ -1,201 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../../lib/class_metrix"
-
-# Example classes for demonstration
-class DatabaseService
-  DEFAULT_CONFIG = { host: "localhost", port: 5432, ssl: true }.freeze
-  TIMEOUT_CONFIG = { connect: 30, read: 60, write: 30 }.freeze
-
-  def self.connection_timeout
-    30
-  end
-
-  def self.pool_size
-    10
-  end
-end
-
-class RedisService
-  DEFAULT_CONFIG = { host: "redis.local", port: 6379, ssl: false }.freeze
-  CLUSTER_CONFIG = { nodes: 3, replication: true, sharding: "consistent" }.freeze
-
-  def self.connection_timeout
-    5
-  end
-
-  def self.pool_size
-    20
-  end
-end
-
-class S3Service
-  DEFAULT_CONFIG = { region: "us-east-1", bucket: "my-bucket" }.freeze
-
-  def self.connection_timeout
-    60
-  end
-end
-
-puts "=" * 80
-puts "ClassMetrix v2.0 - Configurable Component Examples"
-puts "=" * 80
-
-# Example 1: Minimal Report (table only)
-puts "\n1. MINIMAL REPORT (table only)"
-puts "-" * 40
-
-minimal = ClassMetrix.extract(:constants)
-                     .from([DatabaseService, RedisService, S3Service])
-                     .filter(/DEFAULT_CONFIG/)
-                     .to_markdown(
-                       show_metadata: false,
-                       show_classes: false,
-                       show_extraction_info: false,
-                       show_footer: false
-                     )
-
-puts minimal
-
-# Example 2: Standard Report with Custom Title
-puts "\n2. STANDARD REPORT with custom title"
-puts "-" * 40
-
-standard = ClassMetrix.extract(:constants, :class_methods)
-                      .from([DatabaseService, RedisService, S3Service])
-                      .filter(/CONFIG|timeout/)
-                      .expand_hashes
-                      .handle_errors
-                      .to_markdown(
-                        title: "Microservices Configuration Analysis"
-                      )
-
-puts standard
-
-# Example 3: Detailed Report with All Features
-puts "\n3. DETAILED REPORT with all features"
-puts "-" * 40
-
-detailed = ClassMetrix.extract(:constants, :class_methods)
-                      .from([DatabaseService, RedisService, S3Service])
-                      .filter(/CONFIG|timeout|pool/)
-                      .expand_hashes
-                      .handle_errors
-                      .to_markdown(
-                        title: "Complete Service Analysis",
-                        show_missing_summary: true,
-                        summary_style: :detailed,
-                        footer_style: :detailed,
-                        show_timestamp: true,
-                        custom_footer: "Generated for production deployment review"
-                      )
-
-puts detailed
-
-# Example 4: Compact Table Style
-puts "\n4. COMPACT TABLE STYLE"
-puts "-" * 40
-
-compact = ClassMetrix.extract(:class_methods)
-                     .from([DatabaseService, RedisService, S3Service])
-                     .filter(/timeout|pool/)
-                     .to_markdown(
-                       title: "Service Performance Settings",
-                       table_style: :compact,
-                       max_column_width: 20,
-                       footer_style: :minimal
-                     )
-
-puts compact
-
-# Example 5: Different Summary Styles
-puts "\n5. DIFFERENT SUMMARY STYLES"
-puts "-" * 40
-
-# Flat summary style
-flat_summary = ClassMetrix.extract(:constants)
-                          .from([DatabaseService, RedisService, S3Service])
-                          .filter(/CLUSTER|TIMEOUT/)
-                          .handle_errors
-                          .to_markdown(
-                            title: "Missing Configurations (Flat Style)",
-                            show_missing_summary: true,
-                            summary_style: :flat,
-                            show_classes: false,
-                            show_extraction_info: false
-                          )
-
-puts flat_summary
-
-# Example 6: Save Different Formats to Files
-puts "\n6. SAVING REPORTS TO FILES"
-puts "-" * 40
-
-# Save minimal report
-ClassMetrix.extract(:constants)
-           .from([DatabaseService, RedisService, S3Service])
-           .filter(/DEFAULT_CONFIG/)
-           .expand_hashes
-           .to_markdown("reports/minimal_config.md",
-                        title: "Service Default Configurations",
-                        show_missing_summary: false,
-                        footer_style: :minimal)
-
-# Save detailed audit report
-ClassMetrix.extract(:constants, :class_methods)
-           .from([DatabaseService, RedisService, S3Service])
-           .filter(/CONFIG|timeout|pool/)
-           .expand_hashes
-           .handle_errors
-           .to_markdown("reports/detailed_audit.md",
-                        title: "Complete Microservices Audit",
-                        show_missing_summary: true,
-                        summary_style: :detailed,
-                        footer_style: :detailed,
-                        show_timestamp: true,
-                        custom_footer: "Audit performed for compliance review")
-
-# Save compact performance report
-ClassMetrix.extract(:class_methods)
-           .from([DatabaseService, RedisService, S3Service])
-           .filter(/timeout|pool/)
-           .to_markdown("reports/performance_settings.md",
-                        title: "Service Performance Configuration",
-                        table_style: :compact,
-                        max_column_width: 25,
-                        show_classes: true,
-                        show_extraction_info: false,
-                        footer_style: :default)
-
-puts "✅ Reports saved to:"
-puts "   - reports/minimal_config.md"
-puts "   - reports/detailed_audit.md"
-puts "   - reports/performance_settings.md"
-
-puts "\n#{"=" * 80}"
-puts "Component Configuration Summary:"
-puts "=" * 80
-puts "✨ Header Component Options:"
-puts "   - title: Custom report title"
-puts "   - show_metadata: Show/hide title section"
-puts "   - show_classes: Show/hide classes analyzed section"
-puts "   - show_extraction_info: Show/hide extraction types section"
-puts ""
-puts "📊 Table Component Options:"
-puts "   - table_style: :standard, :compact, :wide"
-puts "   - min_column_width: Minimum column width"
-puts "   - max_column_width: Maximum column width (for compact style)"
-puts ""
-puts "📋 Missing Behaviors Component Options:"
-puts "   - show_missing_summary: Show/hide missing behaviors analysis"
-puts "   - summary_style: :grouped, :flat, :detailed"
-puts ""
-puts "📄 Footer Component Options:"
-puts "   - show_footer: Show/hide footer"
-puts "   - footer_style: :default, :minimal, :detailed"
-puts "   - show_timestamp: Include generation timestamp"
-puts "   - custom_footer: Custom footer message"
-puts ""
-puts "🎯 All components are independently configurable!"
-puts "=" * 80

data/examples/csv_output_demo.rb

@@ -1,237 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../lib/class_metrix"
-
-# Example classes for demonstration
-class DatabaseConfig
-  DEFAULT_CONFIG = {
-    host: "localhost",
-    port: 5432,
-    ssl: true,
-    timeout: 30
-  }.freeze
-
-  CLUSTER_CONFIG = {
-    nodes: 3,
-    replication: true
-  }.freeze
-
-  def self.connection_timeout
-    30
-  end
-
-  def self.max_connections
-    100
-  end
-end
-
-class RedisConfig
-  DEFAULT_CONFIG = {
-    host: "redis.local",
-    port: 6379,
-    ssl: false,
-    timeout: 5
-  }.freeze
-
-  CACHE_CONFIG = {
-    ttl: 3600,
-    max_memory: "1GB"
-  }.freeze
-
-  def self.connection_timeout
-    5
-  end
-
-  def self.max_connections
-    50
-  end
-end
-
-class S3Config
-  DEFAULT_CONFIG = {
-    region: "us-east-1",
-    ssl: true,
-    timeout: 60
-  }.freeze
-
-  BUCKET_CONFIG = {
-    versioning: true,
-    encryption: "AES256"
-  }.freeze
-
-  def self.connection_timeout
-    60
-  end
-
-  def self.max_connections
-    25
-  end
-end
-
-puts "=" * 80
-puts "ClassMetrix CSV Output Examples"
-puts "=" * 80
-
-# Example 1: Simple CSV output
-puts "\n1. Simple CSV Output (Constants)"
-puts "-" * 40
-
-result = ClassMetrix.extract(:constants)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/DEFAULT_CONFIG/)
-                    .to_csv(show_metadata: false)
-
-puts result
-
-# Example 2: CSV with metadata
-puts "\n\n2. CSV with Metadata and Title"
-puts "-" * 40
-
-result = ClassMetrix.extract(:constants)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/DEFAULT_CONFIG/)
-                    .to_csv(title: "Service Configuration Comparison")
-
-puts result
-
-# Example 3: Multi-type extraction with hash flattening
-puts "\n\n3. Multi-Type with Hash Flattening"
-puts "-" * 40
-
-result = ClassMetrix.extract(:constants, :class_methods)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/CONFIG|timeout|connections/)
-                    .expand_hashes
-                    .handle_errors
-                    .to_csv(
-                      title: "Complete Service Analysis",
-                      flatten_hashes: true,
-                      show_metadata: true
-                    )
-
-puts result
-
-# Example 4: Hash expansion with sub-rows (non-flattened)
-puts "\n\n4. Hash Expansion with Sub-Rows"
-puts "-" * 40
-
-result = ClassMetrix.extract(:constants)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/DEFAULT_CONFIG/)
-                    .expand_hashes
-                    .to_csv(
-                      title: "Configuration Details",
-                      flatten_hashes: false,
-                      show_metadata: false
-                    )
-
-puts result
-
-# Example 5: Different CSV separators
-puts "\n\n5. Semicolon-Separated Values"
-puts "-" * 40
-
-result = ClassMetrix.extract(:class_methods)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/timeout|connections/)
-                    .to_csv(
-                      separator: ";",
-                      show_metadata: false
-                    )
-
-puts result
-
-# Example 6: Tab-separated values
-puts "\n\n6. Tab-Separated Values"
-puts "-" * 40
-
-result = ClassMetrix.extract(:class_methods)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/timeout/)
-                    .to_csv(
-                      separator: "\t",
-                      show_metadata: false
-                    )
-
-puts result
-
-# Example 7: Custom null values
-puts "\n\n7. Custom Null Values"
-puts "-" * 40
-
-result = ClassMetrix.extract(:constants)
-                    .from([DatabaseConfig, RedisConfig, S3Config])
-                    .filter(/CLUSTER_CONFIG|CACHE_CONFIG|BUCKET_CONFIG/)
-                    .handle_errors
-                    .to_csv(
-                      null_value: "N/A",
-                      show_metadata: false
-                    )
-
-puts result
-
-# Example 8: Save to file
-puts "\n\n8. Saving to File"
-puts "-" * 40
-
-filename = "service_analysis.csv"
-ClassMetrix.extract(:constants, :class_methods)
-           .from([DatabaseConfig, RedisConfig, S3Config])
-           .filter(/CONFIG|timeout/)
-           .expand_hashes
-           .handle_errors
-           .to_csv(
-             filename,
-             title: "Service Configuration Analysis",
-             flatten_hashes: true
-           )
-
-puts "CSV report saved to: #{filename}"
-puts "File size: #{File.size(filename)} bytes"
-puts "\nFirst few lines of the file:"
-puts File.readlines(filename)[0..5].join
-
-# Example 9: Error handling demonstration
-puts "\n\n9. Error Handling in CSV"
-puts "-" * 40
-
-class BrokenConfig
-  VALID_CONFIG = { host: "localhost" }.freeze
-
-  def self.working_method
-    "success"
-  end
-
-  def self.broken_method
-    raise StandardError, "Something went wrong"
-  end
-end
-
-result = ClassMetrix.extract(:constants, :class_methods)
-                    .from([DatabaseConfig, BrokenConfig])
-                    .filter(/CONFIG|method/)
-                    .handle_errors
-                    .to_csv(show_metadata: false)
-
-puts result
-
-puts "\n#{"=" * 80}"
-puts "CSV Output Features Summary:"
-puts "=" * 80
-puts "✓ Simple CSV tables with comma separation"
-puts "✓ Custom separators (semicolon, tab, etc.)"
-puts "✓ Metadata headers with comments"
-puts "✓ Hash flattening into separate columns"
-puts "✓ Hash expansion into sub-rows"
-puts "✓ Multi-type extraction support"
-puts "✓ Error handling with clean output"
-puts "✓ Custom null value representation"
-puts "✓ File output capability"
-puts "✓ Emoji cleaning for CSV compatibility"
-puts "✓ Boolean value conversion (TRUE/FALSE)"
-puts "✓ Array value joining with semicolons"
-puts "=" * 80
-
-# Clean up
-File.delete(filename) if File.exist?(filename)