class-metrix 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f907803028cff5b1f0e8fcc21bd9e9b68d4dc496ba450dda0364337f5548c06a
+  data.tar.gz: 1d02ce1725a8542e9a5e60a528c248838ff072743c4556c17878b68a7a5ae931
+SHA512:
+  metadata.gz: c7d44e8e2359f858fc349179539cb5d7d7cf831abb6da76f77eaec75e882efd4f3d9cb371f6070c34ab4048d9fb319ddf7621fadafc5a0cc0d00089c8f8881f2
+  data.tar.gz: 349ccda98eec305973604160b6238c47b3c764f5f1935ca7d06bf63fcf4a8832b8d026e7810dff3504ac38eddf029f7ac45fdfe9b3fdfaa0f19bde7adbab449c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'bin/*'
+    - 'examples/**/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - '.ruby-lsp/**/*'
+
+# String literal styles
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Documentation requirements
+Style/Documentation:
+  Enabled: false  # Many classes don't need top-level documentation
+
+# Method and class length limits
+Metrics/MethodLength:
+  Max: 25  # Increased to accommodate current codebase
+
+Metrics/ClassLength:
+  Max: 250  # Increased to accommodate complex formatter classes
+
+Metrics/BlockLength:
+  Max: 30  # Slightly increased from default
+  Exclude:
+    - 'spec/**/*'  # Allow long blocks in tests
+    - 'class-metrix.gemspec'  # Allow long blocks in gemspec
+
+# Complexity limits
+Metrics/AbcSize:
+  Max: 35  # Increased to accommodate current codebase
+
+Metrics/CyclomaticComplexity:
+  Max: 15  # Increased to accommodate current codebase
+
+Metrics/PerceivedComplexity:
+  Max: 15  # Increased to accommodate current codebase
+
+# Line length
+Layout/LineLength:
+  Max: 140  # Increased from default 120
+
+# Naming conventions
+Naming/AccessorMethodName:
+  Enabled: false  # Allow get_ prefixed methods
+
+Naming/PredicateName:
+  Enabled: false  # Allow has_ prefixed methods
+
+# Optional boolean parameters
+Style/OptionalBooleanParameter:
+  Enabled: false  # Allow boolean default parameters
+
+# Gemspec warning
+Gemspec/RequiredRubyVersion:
+  Enabled: false  # Allow different ruby versions in gemspec vs rubocop
+
+# Script permissions (for examples)
+Lint/ScriptPermission:
+  Enabled: false
+
+# Allow constants in blocks (common in specs)
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+# String concatenation
+Style/StringConcatenation:
+  Enabled: false  # Allow string concatenation in some cases
+
+# Additional cops to disable based on project needs
+Gemspec/DevelopmentDependencies:
+  Enabled: false  # Allow development dependencies in gemspec
+
+Lint/DuplicateBranch:
+  Enabled: false  # Allow duplicate rescue branches for different error types
+
+Style/ComparableClamp:
+  Enabled: false  # Allow traditional min/max patterns for clarity
+
+Lint/NonAtomicFileOperation:
+  Enabled: false  # Allow traditional file existence checks in specs

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.7

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+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
+
+### 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
+
+### Added
+- Initial release of ClassMetrix
+- Constants extraction from Ruby classes
+- Class methods extraction and comparison
+- Multi-type extraction support
+- Hash expansion functionality
+- Error handling for missing methods/constants
+- Markdown report generation
+- CSV export with hash flattening
+- Filtering capabilities
+- Comprehensive test suite
+- RuboCop integration
+
+### Features
+- 🔍 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
+- 📝 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 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Huy Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,417 @@
+# ClassMetrix
+
+[![Gem Version](https://badge.fury.io/rb/class-metrix.svg)](https://badge.fury.io/rb/class-metrix)
+[![CI](https://github.com/patrick204nqh/class-metrix/actions/workflows/main.yml/badge.svg)](https://github.com/patrick204nqh/class-metrix/actions/workflows/main.yml)
+
+**ClassMetrix** is a Ruby gem that extracts and compares class behaviors (constants, class methods, and more) across multiple classes, generating clean markdown reports for analysis, documentation, and compliance auditing.
+
+## ✨ Features
+
+- **🔍 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
+- **📝 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
+
+## 🚀 Quick Start
+
+```ruby
+# Basic usage
+ClassMetrix.extract(:constants)
+  .from([User, Admin, Guest])
+  .to_markdown
+
+# Advanced usage with configuration
+ClassMetrix.extract(:constants, :class_methods)
+  .from([DatabaseConfig, RedisConfig, S3Config])
+  .filter(/config$/)
+  .expand_hashes
+  .handle_errors
+  .to_markdown("audit_report.md", 
+    title: "Service Configuration Audit",
+    footer_style: :detailed,
+    show_missing_summary: true
+  )
+
+# CSV output with hash flattening
+ClassMetrix.extract(:constants)
+  .from([DatabaseConfig, RedisConfig])
+  .expand_hashes
+  .to_csv("config_analysis.csv", 
+    title: "Configuration Analysis",
+    flatten_hashes: true
+  )
+```
+
+## 📦 Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'class-metrix'
+```
+
+Or install directly:
+
+```bash
+gem install class-metrix
+```
+
+## 📖 Usage Guide
+
+### Basic Extraction
+
+#### Constants
+```ruby
+# Extract constants from multiple classes
+ClassMetrix.extract(:constants)
+  .from([User, Admin, Guest])
+  .to_markdown
+
+# Output:
+# | Constant   | User     | Admin    | Guest    |
+# |------------|----------|----------|----------|
+# | ROLE_NAME  | 'user'   | 'admin'  | 'guest'  |
+# | PERMISSION | 'read'   | 'write'  | 'read'   |
+```
+
+#### Class Methods
+```ruby
+# Extract class method results
+ClassMetrix.extract(:class_methods)
+  .from([DatabaseConfig, RedisConfig])
+  .filter(/config$/)
+  .to_markdown
+
+# Output:
+# | Method        | DatabaseConfig           | RedisConfig              |
+# |---------------|--------------------------|--------------------------|
+# | db_config     | {:host=>"localhost"}     | 🚫 Not defined           |
+# | cache_config  | 🚫 Not defined           | {:host=>"redis.local"}   |
+```
+
+#### Multi-Type Extraction
+```ruby
+# Combine multiple extraction types in one table
+ClassMetrix.extract(:constants, :class_methods)
+  .from([User, Admin])
+  .to_markdown
+
+# Output:
+# | Type         | Behavior    | User     | Admin    |
+# |--------------|-------------|----------|----------|
+# | Constant     | ROLE_NAME   | 'user'   | 'admin'  |
+# | Class Method | permissions | ['read'] | ['read', 'write'] |
+```
+
+### Advanced Features
+
+#### Hash Expansion
+```ruby
+# Expand hash values into readable sub-rows
+ClassMetrix.extract(:constants)
+  .from([DatabaseConfig, RedisConfig])
+  .expand_hashes
+  .to_markdown
+
+# Output:
+# | Constant    | DatabaseConfig           | RedisConfig              |
+# |-------------|--------------------------|--------------------------|
+# | DB_CONFIG   | {:host=>"localhost"}     | {:host=>"redis.local"}   |
+# | .host       | localhost                | redis.local              |
+# | .port       | 5432                     | — (missing key)          |
+# | .timeout    | — (missing key)          | 30                       |
+```
+
+#### Error Handling
+```ruby
+# Handle missing methods and constants gracefully
+ClassMetrix.extract(:class_methods)
+  .from([ServiceA, ServiceB])
+  .handle_errors
+  .to_markdown
+
+# Error indicators:
+# 🚫 Not defined  - Constant/method doesn't exist
+# 🚫 No method    - Method doesn't exist
+# ⚠️ Error: msg   - Runtime error with context
+# ❌              - nil or false values
+# ✅              - true values
+# —               - Missing hash key
+```
+
+#### Filtering
+```ruby
+# Filter behaviors by pattern
+ClassMetrix.extract(:constants)
+  .from([User, Admin, Guest])
+  .filter(/^ROLE_/, /^PERMISSION_/)
+  .to_markdown
+
+# Multiple filters (OR logic)
+ClassMetrix.extract(:class_methods)
+  .from([ConfigA, ConfigB])
+  .filter(/config$/, /setup$/)
+  .to_markdown
+```
+
+#### CSV Output
+```ruby
+# Basic CSV output
+ClassMetrix.extract(:constants)
+  .from([DatabaseConfig, RedisConfig])
+  .to_csv("config.csv")
+
+# CSV with hash flattening (separate columns for each hash key)
+ClassMetrix.extract(:constants)
+  .from([DatabaseConfig, RedisConfig])
+  .expand_hashes
+  .to_csv("config_flat.csv", flatten_hashes: true)
+
+# CSV with hash expansion (sub-rows for hash keys)
+ClassMetrix.extract(:constants)
+  .from([DatabaseConfig, RedisConfig])
+  .expand_hashes
+  .to_csv("config_expanded.csv", flatten_hashes: false)
+
+# Custom CSV options
+ClassMetrix.extract(:class_methods)
+  .from([ServiceA, ServiceB])
+  .to_csv(
+    separator: ";",           # Use semicolon separator
+    null_value: "N/A",       # Custom null value
+    show_metadata: false     # No comment headers
+  )
+```
+
+## ⚙️ Configuration Options
+
+ClassMetrix offers extensive configuration options for customizing report generation:
+
+### Markdown Report Options
+```ruby
+ClassMetrix.extract(:constants)
+  .from([User, Admin])
+  .to_markdown(
+    # File and title
+    "report.md",
+    title: "Custom Report Title",
+    
+    # Content sections
+    show_metadata: true,          # Show title and report info
+    show_classes: true,           # Show "Classes Analyzed" section
+    show_extraction_info: true,   # Show "Extraction Types" section
+    show_missing_summary: false,  # Show missing behaviors summary
+    
+    # Footer configuration
+    show_footer: true,            # Show footer
+    footer_style: :detailed,      # :default, :minimal, :detailed
+    show_timestamp: true,         # Include generation timestamp
+    custom_footer: "Custom note", # Custom footer message
+    
+    # Table formatting
+    table_style: :standard,       # :standard, :compact, :wide
+    min_column_width: 3,          # Minimum column width
+    max_column_width: 50,         # Maximum column width (for :compact style)
+    
+    # Missing behaviors analysis
+    summary_style: :grouped       # :grouped, :flat, :detailed
+  )
+```
+
+### CSV Output Options
+```ruby
+ClassMetrix.extract(:constants)
+  .from([User, Admin])
+  .to_csv(
+    # File and title
+    "report.csv",
+    title: "Custom CSV Report",
+    
+    # Content options
+    show_metadata: true,          # Show comment headers
+    comment_char: "#",            # Comment character for metadata
+    
+    # CSV formatting
+    separator: ",",               # Column separator (comma, semicolon, tab)
+    quote_char: '"',              # Quote character
+    null_value: "",               # Value for nil/missing data
+    
+    # Hash handling
+    flatten_hashes: true,         # Flatten hashes into separate columns
+                                  # false = expand into sub-rows
+  )
+```
+
+### Footer Styles
+
+#### Default Footer
+```markdown
+---
+*Report generated by ClassMetrix gem*
+```
+
+#### Minimal Footer
+```markdown
+---
+*Generated by ClassMetrix*
+```
+
+#### Detailed Footer
+```markdown
+---
+## Report Information
+
+- **Generated by**: [ClassMetrix gem](https://github.com/your-username/class-metrix)
+- **Generated at**: 2024-01-15 14:30:25 UTC
+- **Ruby version**: 3.2.0
+```
+
+### Missing Behaviors Styles
+
+#### Grouped (Default)
+```markdown
+## Missing Behaviors Summary
+
+### DatabaseConfig
+- `redis_config` - 🚫 Not defined
+- `cache_timeout` - 🚫 No method
+
+### RedisConfig  
+- `db_config` - 🚫 Not defined
+```
+
+#### Flat
+```markdown
+## Missing Behaviors
+
+- **DatabaseConfig**: `redis_config` - 🚫 Not defined
+- **DatabaseConfig**: `cache_timeout` - 🚫 No method
+- **RedisConfig**: `db_config` - 🚫 Not defined
+```
+
+#### Detailed
+```markdown
+## Missing Behaviors Analysis
+
+**Summary**: 3 missing behaviors across 2 classes
+
+### 🚫 Not (2 items)
+- **DatabaseConfig**: `redis_config` - 🚫 Not defined
+- **RedisConfig**: `db_config` - 🚫 Not defined
+
+### 🚫 No (1 items)
+- **DatabaseConfig**: `cache_timeout` - 🚫 No method
+```
+
+## 🎯 Real-World Examples
+
+### Microservices Configuration Audit
+```ruby
+# Audit configuration consistency across services
+services = [DatabaseService, RedisService, S3Service, AuthService]
+
+ClassMetrix.extract(:constants, :class_methods)
+  .from(services)
+  .filter(/CONFIG/, /timeout/, /pool/)
+  .expand_hashes
+  .handle_errors
+  .to_markdown("microservices_audit.md",
+    title: "Microservices Configuration Audit",
+    show_missing_summary: true,
+    summary_style: :detailed,
+    footer_style: :detailed
+  )
+```
+
+### Policy Classes Comparison
+```ruby
+# Compare authorization policies
+policies = [UserPolicy, AdminPolicy, ModeratorPolicy]
+
+ClassMetrix.extract(:constants)
+  .from(policies)
+  .filter(/^PERMISSION_/, /^ROLE_/)
+  .to_markdown("policy_comparison.md",
+    title: "Authorization Policy Analysis",
+    show_timestamp: true
+  )
+```
+
+### API Version Compatibility
+```ruby
+# Check API compatibility across versions
+apis = [V1::UsersAPI, V2::UsersAPI, V3::UsersAPI]
+
+ClassMetrix.extract(:class_methods)
+  .from(apis)
+  .filter(/^endpoint_/, /^validate_/)
+  .handle_errors
+  .to_markdown("api_compatibility.md",
+    title: "API Version Compatibility Report",
+    show_missing_summary: true,
+    summary_style: :flat
+  )
+```
+
+## 🏗️ Architecture
+
+ClassMetrix uses a modular component architecture for maximum flexibility:
+
+```
+MarkdownFormatter
+├── HeaderComponent      # Title, classes, extraction info
+├── TableComponent       # Table formatting and hash expansion  
+├── MissingBehaviorsComponent  # Missing behavior analysis
+└── FooterComponent      # Footer with various styles
+```
+
+Each component is independently configurable and can be customized for specific needs.
+
+## 🧪 Development
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/class-metrix.git
+cd class-metrix
+
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run examples
+ruby examples/basic/01_simple_constants.rb
+ruby examples/advanced/hash_expansion.rb
+```
+
+## 📋 Requirements
+
+- Ruby 2.7+ 
+- No runtime dependencies (pure Ruby implementation)
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -am 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## 🔗 Links
+
+- [Documentation](https://github.com/your-username/class-metrix/wiki)
+- [Examples](examples/)
+- [Build Guide](BUILD_GUIDE.md)
+- [Changelog](CHANGELOG.md)
+
+---
+
+**Built with ❤️ for Ruby developers who love clean, maintainable code.**