class-metrix 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f907803028cff5b1f0e8fcc21bd9e9b68d4dc496ba450dda0364337f5548c06a
-  data.tar.gz: 1d02ce1725a8542e9a5e60a528c248838ff072743c4556c17878b68a7a5ae931
+  metadata.gz: 440b6eacf85b731cd683533be57ab3b2c17b25605ce70ed650bed43539f34531
+  data.tar.gz: 728575b7ddac28f55d5d192f3e1004858f19820453a9e6c3d00002df50855c92
 SHA512:
-  metadata.gz: c7d44e8e2359f858fc349179539cb5d7d7cf831abb6da76f77eaec75e882efd4f3d9cb371f6070c34ab4048d9fb319ddf7621fadafc5a0cc0d00089c8f8881f2
-  data.tar.gz: 349ccda98eec305973604160b6238c47b3c764f5f1935ca7d06bf63fcf4a8832b8d026e7810dff3504ac38eddf029f7ac45fdfe9b3fdfaa0f19bde7adbab449c
+  metadata.gz: 868af534a658dc3a083315ee1660f4ba8754919474ac3d6c5c2458f2a5af8df763bfa292d6d1c426a0df20b4ef3419cd7cc031397bd14ed3a563f0dee07b605c
+  data.tar.gz: 9bcfe4160f94b93abf072e1888c92222a790387f16e16d376ef93be48c28d4ac7ee1edd931c6b9e70236c64e3bec17d0610c2561db14ab80e60d4f0ed1a6af41

data/.editorconfig

@@ -0,0 +1,48 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Ruby files
+[*.rb]
+indent_style = space
+indent_size = 2
+max_line_length = 140
+
+# Gemfiles and other Ruby-related files
+[{Gemfile,Rakefile,*.gemspec}]
+indent_style = space
+indent_size = 2
+
+# YAML files
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# Markdown files
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+
+# JSON files
+[*.json]
+indent_style = space
+indent_size = 2
+
+# JavaScript/TypeScript files (if any)
+[*.{js,ts}]
+indent_style = space
+indent_size = 2
+
+# Shell scripts
+[*.sh]
+indent_style = space
+indent_size = 2

data/.vscode/README.md

@@ -0,0 +1,72 @@
+# VS Code Works### Ruby Support
+
+- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server with Rubocop formatting
+- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+
+### Markdown Support
+
+- **Prettier** (`esbenp.prettier-vscode`) - Primary Markdown formatter
+- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Comprehensive Markdown support
+- **markdownlint** (`davidanson.vscode-markdownlint`) - Markdown lintingnfiguration
+
+This folder contains VS Code workspace configuration files that help maintain consistent development environment across team members.
+
+## Files Overview
+
+- **settings.json**: Workspace-specific settings for Ruby and Markdown formatting
+- **extensions.json**: Recommended extensions for this project
+- **tasks.json**: Predefined tasks for common operations (Rubocop, RSpec)
+- **launch.json**: Debug configurations for Ruby files and tests
+
+## Required Extensions
+
+To get the best development experience, install these recommended extensions:
+
+### Ruby Support
+
+- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server
+- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+
+### Markdown Support
+
+- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Comprehensive Markdown support
+- **markdownlint** (`davidanson.vscode-markdownlint`) - Markdown linting
+
+### General
+
+- **EditorConfig** (`editorconfig.editorconfig`) - Consistent coding styles
+- **GitLens** (`eamodio.gitlens`) - Enhanced Git capabilities
+
+## Auto-formatting
+
+The configuration enables automatic formatting on save for:
+
+- **Ruby files**: Using Rubocop via Ruby LSP (Shopify.ruby-lsp)
+- **Markdown files**: Using Prettier formatter
+- **Format on type**: Enabled for Ruby files for real-time formatting
+
+## Available Tasks
+
+Access via `Ctrl+Shift+P` → "Tasks: Run Task":
+
+- **Rubocop: Check** - Run Rubocop linting
+- **Rubocop: Fix** - Auto-fix Rubocop violations
+- **Rubocop: Fix Current File** - Fix violations in current file only
+- **RSpec: Run All Tests** - Run complete test suite
+- **RSpec: Run Current File** - Run tests for current file
+- **Bundle Install** - Install/update gems
+
+## Debug Configurations
+
+Available debug configurations:
+
+- **Ruby: Run Current File** - Debug the currently open Ruby file
+- **RSpec: Debug Current File** - Debug tests in current file
+- **RSpec: Debug All Tests** - Debug entire test suite
+
+## Setup Instructions
+
+1. Open this project in VS Code
+2. Install recommended extensions (VS Code will prompt you)
+3. Run "Bundle Install" task to ensure gems are installed
+4. Start coding! Auto-formatting will work on save

data/.vscode/extensions.json

@@ -0,0 +1,28 @@
+{  "recommendations": [
+    // Ruby language support
+    "shopify.ruby-lsp",
+    "castwide.solargraph",
+
+    // Alternative Ruby support (choose one of the above)
+    // "rebornix.ruby",
+
+    // Markdown support
+    "esbenp.prettier-vscode",
+    "yzhang.markdown-all-in-one",
+    "davidanson.vscode-markdownlint",
+
+    // General productivity
+    "ms-vscode.vscode-json",
+    "redhat.vscode-yaml",
+    "editorconfig.editorconfig",
+
+    // Git integration
+    "eamodio.gitlens",
+
+    // Additional helpful extensions
+    "ms-vscode.test-adapter-converter",
+    "hbenl.vscode-test-explorer",
+    "formulahendry.auto-rename-tag",
+    "bradlc.vscode-tailwindcss"
+  ]
+}

data/.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Ruby: Run Current File",
+      "type": "ruby_lsp",
+      "request": "launch",
+      "program": "${file}"
+    },
+    {
+      "name": "Ruby: Run with Arguments",
+      "type": "ruby_lsp",
+      "request": "launch",
+      "program": "${file}",
+      "args": []
+    },
+    {
+      "name": "RSpec: Debug Current File",
+      "type": "ruby_lsp",
+      "request": "launch",
+      "program": "bundle",
+      "args": ["exec", "rspec", "${file}"]
+    },
+    {
+      "name": "RSpec: Debug All Tests",
+      "type": "ruby_lsp",
+      "request": "launch",
+      "program": "bundle",
+      "args": ["exec", "rspec"]
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,88 @@
+{
+  // Ruby language settings
+  "ruby.format": "rubocop",
+  "ruby.lint": {
+    "rubocop": {
+      "useBundler": true
+    }
+  },
+  "ruby.useLanguageServer": true,
+  "ruby.intellisense": "rubyLsp",
+
+  // Auto-formatting settings
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "editor.formatOnType": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.rubocop": "explicit"
+  },
+
+  // Language-specific formatting
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.semanticHighlighting.enabled": true,
+    "editor.formatOnType": true,
+    "editor.rulers": [140],
+    "editor.trimAutoWhitespace": true
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.wordWrap": "on",
+    "editor.quickSuggestions": {
+      "comments": "off",
+      "strings": "off",
+      "other": "off"
+    }
+  },
+
+  // File associations
+  "files.associations": {
+    "*.gemspec": "ruby",
+    "Gemfile": "ruby",
+    "Rakefile": "ruby",
+    ".rubocop.yml": "yaml"
+  },
+
+  // Auto-save settings
+  "files.autoSave": "onFocusChange",
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+
+  // Ruby LSP specific settings
+  "rubyLsp.enabledFeatures": {
+    "codeActions": true,
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true,
+    "codeLens": true,
+    "definition": true,
+    "workspaceSymbol": true,
+    "signatureHelp": true,
+    "typeHierarchy": true
+  },
+  "rubyLsp.formatter": "rubocop",
+
+  // Rubocop specific settings
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.suppressRubocopWarnings": false,
+
+  // Additional helpful settings
+  "breadcrumbs.enabled": true,
+  "editor.minimap.enabled": true,
+  "workbench.editor.enablePreview": false
+}

data/.vscode/tasks.json

@@ -0,0 +1,99 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Rubocop: Check",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rubocop"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "rubocop",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): ([A-Z]): (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Rubocop: Fix",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rubocop", "-A"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      }
+    },
+    {
+      "label": "Rubocop: Fix Current File",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rubocop", "-A", "${file}"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "silent",
+        "focus": false,
+        "panel": "shared"
+      }
+    },
+    {
+      "label": "RSpec: Run All Tests",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rspec"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      }
+    },
+    {
+      "label": "RSpec: Run Current File",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rspec", "${file}"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      }
+    },
+    {
+      "label": "Bundle Install",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["install"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      }
+    }
+  ]
+}

data/CHANGELOG.md

@@ -5,20 +5,86 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2025-06-07
+## [Unreleased]
+
+## [1.0.0] - 2025-06-07
+
+### 🎉 Major Release - Production Ready
+
+This marks the first stable release of ClassMetrix with a comprehensive feature set and robust architecture.
 
 ### Added
+
+- **🐛 Advanced Debug System**: Comprehensive debug logging with three levels (`:basic`, `:detailed`, `:verbose`)
+  - Safe object inspection for problematic objects with broken `inspect`/`to_s` methods
+  - Smart hash detection to prevent issues with proxy objects
+  - Component-specific debug loggers for targeted troubleshooting
+  - Error-resistant operations with graceful degradation
+- **📊 Enhanced Hash Expansion**: Multiple hash expansion modes for different analysis needs
+  - `show_only_main`: Show collapsed hash representations (default)
+  - `show_only_keys`: Show only expanded key rows for detailed analysis
+  - `show_expanded_details`: Show both main and expanded rows
+  - Support for nested hash structures with proper truncation
+- **🏗️ Refactored Architecture**: Clean separation of concerns and improved maintainability
+  - Modular extractor system with dedicated extractors for each type
+  - Shared table builders for consistent formatting across output formats
+  - Centralized value processor for robust value handling
+  - Component-based formatter architecture
+- **⚙️ Enhanced Configuration**: More granular control over extraction and formatting
+  - Hash expansion display options (`hide_main_row`, `hide_key_rows`)
+  - Improved inheritance and module inclusion handling
+  - Better error handling and recovery mechanisms
+- **🔧 VS Code Integration**: Complete development environment setup
+  - Auto-formatting with Rubocop integration
+  - Task definitions for common operations
+  - Debug configurations for Ruby and RSpec
+  - Recommended extensions for optimal development experience
+
+### Enhanced
+
+- **Hash Processing**: Robust handling of complex nested structures and edge cases
+- **CSV Export**: Improved hash flattening with better column organization
+- **Error Handling**: More resilient extraction with detailed error reporting
+- **Performance**: Optimized table building and value processing
+- **Documentation**: Comprehensive examples and architecture documentation
+
+### Fixed
+
+- Parameter list optimization in `MultiTypeExtractor` (reduced from 6 to 5 parameters)
+- Method length optimization in `ValueProcessor.process_for_csv` (reduced from 28 to 25 lines)
+- Improved hash detection to prevent issues with ActiveRecord and other proxy objects
+- Better handling of objects with problematic method behaviors
+
+### Technical Improvements
+
+- **Safety-First Design**: All operations wrapped with exception handling
+- **Debug Integration**: Every component includes comprehensive debug logging
+- **Type Safety**: Strict hash detection prevents issues with duck-typed objects
+- **Modular Design**: Easy to extend with new extraction types and formatters
+- **Test Coverage**: Extensive test suite covering edge cases and error conditions
+
+### Breaking Changes
+
+- Hash expansion now defaults to `show_only_main` (was `show_expanded_details`)
+- Some internal API changes for better consistency (affects custom extensions)
+
+## [0.1.2] - 2025-06-07
+
+### Added
+
 - GitHub Actions CI/CD workflow for automated releases
 - Multi-version Ruby testing (3.1, 3.2, 3.3)
 - Automated gem publishing to RubyGems
 - Version consistency checking
 
 ### Changed
+
 - Improved CI workflow with better test coverage
 
-## [0.1.0] - 2024-01-XX
+## [0.1.0] - 2025-06-07
 
 ### Added
+
 - Initial release of ClassMetrix
 - Constants extraction from Ruby classes
 - Class methods extraction and comparison
@@ -32,10 +98,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - RuboCop integration
 
 ### Features
+
 - 🔍 Multi-Type Extraction: Constants, class methods, and more
-- 📊 Hash Expansion: Expand hash values into readable sub-rows  
+- 📊 Hash Expansion: Expand hash values into readable sub-rows
 - 🛡️ Error Handling: Graceful handling of missing methods and constants
 - 📝 Rich Markdown Reports: Professional reports with configurable components
 - 📄 CSV Export: Data analysis-friendly CSV output with hash flattening
 - ⚙️ Highly Configurable: Customize every aspect of the output
-- 🚀 Simple API: Chainable, intuitive interface 
+- 🚀 Simple API: Chainable, intuitive interface

data/README.md

@@ -10,6 +10,7 @@
 - **🔍 Multi-Type Extraction**: Constants, class methods, and more
 - **📊 Hash Expansion**: Expand hash values into readable sub-rows  
 - **🛡️ Error Handling**: Graceful handling of missing methods and constants
+- **🐛 Debug Mode**: Detailed logging for troubleshooting and analysis
 - **📝 Rich Markdown Reports**: Professional reports with configurable components
 - **📄 CSV Export**: Data analysis-friendly CSV output with hash flattening
 - **⚙️ Highly Configurable**: Customize every aspect of the output
@@ -157,6 +158,43 @@ ClassMetrix.extract(:class_methods)
   .to_markdown
 ```
 
+#### Debug Mode
+```ruby
+# Enable detailed logging for troubleshooting
+ClassMetrix.extract(:constants, :class_methods)
+  .from([ServiceA, ServiceB])
+  .expand_hashes
+  .debug  # Enable debug mode (basic level)
+  .to_markdown("debug_report.md")
+
+# Different debug levels for different needs
+ClassMetrix.extract(:constants)
+  .from([ServiceA, ServiceB])
+  .debug(:basic)    # Key decisions and summaries only
+  .to_markdown
+
+ClassMetrix.extract(:constants)
+  .from([ServiceA, ServiceB])
+  .debug(:detailed) # More context and intermediate steps
+  .to_markdown
+
+ClassMetrix.extract(:constants)
+  .from([ServiceA, ServiceB])
+  .debug(:verbose)  # Full details including individual value processing
+  .to_markdown
+```
+
+**Debug Levels:**
+- **`:basic`** (default) - Key decisions and summaries only
+- **`:detailed`** - More context and intermediate steps  
+- **`:verbose`** - Full details including individual value processing
+
+**Debug Features:**
+- **Safe Object Inspection**: Handles objects with problematic `inspect`/`to_s` methods
+- **Hash Detection Analysis**: Shows why objects are/aren't treated as expandable hashes
+- **Smart Logging**: Reduces spam by grouping related operations and focusing on key decisions
+- **Error Diagnostics**: Detailed error context for troubleshooting
+
 #### CSV Output
 ```ruby
 # Basic CSV output
@@ -264,7 +302,7 @@ ClassMetrix.extract(:constants)
 ---
 ## Report Information
 
-- **Generated by**: [ClassMetrix gem](https://github.com/your-username/class-metrix)
+- **Generated by**: [ClassMetrix gem](https://github.com/patrick204nqh/class-metrix)
 - **Generated at**: 2024-01-15 14:30:25 UTC
 - **Ruby version**: 3.2.0
 ```
@@ -374,7 +412,7 @@ Each component is independently configurable and can be customized for specific
 
 ```bash
 # Clone the repository
-git clone https://github.com/your-username/class-metrix.git
+git clone https://github.com/patrick204nqh/class-metrix.git
 cd class-metrix
 
 # Install dependencies
@@ -407,11 +445,7 @@ This gem is available as open source under the terms of the [MIT License](LICENS
 
 ## 🔗 Links
 
-- [Documentation](https://github.com/your-username/class-metrix/wiki)
+- [Documentation](https://github.com/patrick204nqh/class-metrix/wiki)
 - [Examples](examples/)
 - [Build Guide](BUILD_GUIDE.md)
 - [Changelog](CHANGELOG.md)
-
----
-
-**Built with ❤️ for Ruby developers who love clean, maintainable code.**