class-metrix 1.0.1 → 1.1.0

data/.vscode/extensions.json

@@ -4,17 +4,13 @@
     "shopify.ruby-lsp",
 
     // RBS and Steep support (type checking)
-    "soutaro.rbs-syntax",
     "soutaro.steep-vscode",
-    "mateuszdrewniak.rbs-snippets",
 
     // Debugging support
     "koichisasada.vscode-rdbg",
 
     // Markdown support
     "esbenp.prettier-vscode",
-    "yzhang.markdown-all-in-one",
-    "davidanson.vscode-markdownlint",
 
     // General productivity
     "ms-vscode.vscode-json",
@@ -22,10 +18,6 @@
     "editorconfig.editorconfig",
 
     // Git integration
-    "eamodio.gitlens",
-
-    // Additional helpful extensions
-    "ms-vscode.test-adapter-converter",
-    "hbenl.vscode-test-explorer"
+    "eamodio.gitlens"
   ]
 }

data/.vscode/keybindings.json

@@ -1,26 +0,0 @@
-[
-  {
-    "key": "ctrl+shift+r ctrl+v",
-    "command": "workbench.action.tasks.runTask",
-    "args": "RBS: Validate",
-    "when": "editorTextFocus"
-  },
-  {
-    "key": "ctrl+shift+r ctrl+s",
-    "command": "workbench.action.tasks.runTask",
-    "args": "Steep: Type Check",
-    "when": "editorTextFocus"
-  },
-  {
-    "key": "ctrl+shift+r ctrl+w",
-    "command": "workbench.action.tasks.runTask",
-    "args": "Steep: Watch Mode",
-    "when": "editorTextFocus"
-  },
-  {
-    "key": "ctrl+shift+r ctrl+r",
-    "command": "workbench.action.tasks.runTask",
-    "args": "Rubocop: Fix",
-    "when": "editorTextFocus"
-  }
-]

data/.vscode/settings.json

@@ -1,14 +1,4 @@
 {
-  // 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,
@@ -48,6 +38,50 @@
     "editor.rulers": [120],
     "editor.trimAutoWhitespace": true
   },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.quickSuggestions": {
+      "strings": true
+    },
+    "editor.suggest.insertMode": "replace"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.quickSuggestions": {
+      "strings": true
+    },
+    "editor.suggest.insertMode": "replace"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.autoIndent": "advanced",
+    "editor.quickSuggestions": {
+      "other": true,
+      "comments": false,
+      "strings": true
+    }
+  },
+  "[yml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.autoIndent": "advanced",
+    "editor.quickSuggestions": {
+      "other": true,
+      "comments": false,
+      "strings": true
+    }
+  },
 
   // File associations
   "files.associations": {
@@ -56,7 +90,19 @@
     "Rakefile": "ruby",
     ".rubocop.yml": "yaml",
     "*.rbs": "rbs",
-    "Steepfile": "ruby"
+    "Steepfile": "ruby",
+    "*.yaml": "yaml",
+    "*.yml": "yaml",
+    ".yamllint": "yaml",
+    ".yamllint.yaml": "yaml",
+    ".yamllint.yml": "yaml",
+    "*.json": "json",
+    "*.jsonc": "jsonc",
+    ".vscode/*.json": "jsonc",
+    "tsconfig*.json": "jsonc",
+    ".eslintrc": "jsonc",
+    ".babelrc": "jsonc",
+    ".prettierrc": "jsonc"
   },
 
   // Auto-save settings

data/.vscode/tasks.json

@@ -235,6 +235,96 @@
         "panel": "shared"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Qlty: Check All",
+      "type": "shell",
+      "command": "./bin/qlty",
+      "args": ["check"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Qlty: Check Critical",
+      "type": "shell",
+      "command": "./bin/qlty",
+      "args": ["check-critical"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Qlty: Summary",
+      "type": "shell",
+      "command": "./bin/qlty",
+      "args": ["summary"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Qlty: Fix",
+      "type": "shell",
+      "command": "./bin/qlty",
+      "args": ["fix"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Format: All JSON Files",
+      "type": "shell",
+      "command": "npx",
+      "args": ["prettier", "--write", "**/*.json", "**/*.jsonc"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "silent",
+        "focus": false,
+        "panel": "shared"
+      },
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Format: All YAML Files",
+      "type": "shell",
+      "command": "npx",
+      "args": ["prettier", "--write", "**/*.yaml", "**/*.yml"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "silent",
+        "focus": false,
+        "panel": "shared"
+      },
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }

data/CHANGELOG.md

@@ -7,13 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2025-06-08
+
+### Added
+
+- Enhance changelog generation and update release guide for automated workflows
+- Update CI and release workflows with Slack notifications and refine branch handling
+- [EXPERIMENT] feat: Enhance release workflow with version validation and dry run support
+- Add skip CI job for draft PRs and dependency updates in workflow
+- Enhance CI workflow with Brakeman security scans and coverage reporting
+- Enable test coverage reporting in CI workflow
+- Integrate Qlty for code quality checks, add Brakeman for security scanning, and enhance coverage reporting
+- Add Qlty integration and various formatting tasks to VS Code
+
+### Changed
+
+- Deps-dev(deps-dev): update brakeman requirement from ~> 6.0 to ~> 7.0
+- Bump the production-dependencies group with 2 updates
+
+### Fixed
+
+- Exclude Rakefile from RuboCop checks
+- Correct conditional syntax for Qlty coverage upload and update RuboCop exclusions
+- Correct syntax for accessing QLTY coverage token in CI workflow
+- Update dependabot assignee to dependabot[bot] and adjust RuboCop naming configurations
+- Adjust coverage thresholds for improved test accuracy
+
+### Maintenance
+
+- Bump version to 1.0.2 in Gemfile.lock and version.rb
+
 ## [1.0.1] - 2025-06-08
 
 ## [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.
+This marks the first stable release of `ClassMetrix` with a comprehensive feature set and robust architecture.
 
 ### Added
 

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![Maintainability](https://qlty.sh/badges/df5bf564-68c2-4484-84bd-70f705e58f1b/maintainability.svg)](https://qlty.sh/gh/patrick204nqh/projects/class-metrix)
 
 **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.
 
@@ -17,6 +18,7 @@
 - **📄 CSV Export**: Data analysis-friendly CSV output with hash flattening
 - **⚙️ Highly Configurable**: Customize every aspect of the output
 - **🚀 Simple API**: Chainable, intuitive interface
+- **🔒 Type Safe**: Full RBS type annotations with Steep type checking
 
 ## 🚀 Quick Start
 
@@ -430,16 +432,37 @@ 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
+├── 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.
+### Key Design Principles
+
+- **Type Safety**: All components have complete RBS type annotations
+- **Modularity**: Each component is independently configurable
+- **Extensibility**: Easy to add new extractors and formatters
+- **Error Resilience**: Graceful handling of edge cases and errors
+- **Performance**: Optimized for processing large class hierarchies
+
+### Type System
+
+The entire codebase is fully typed using RBS (Ruby Signature) format:
+
+- **Public APIs**: Complete type contracts for all user-facing methods
+- **Internal Components**: Type safety for all internal class interactions
+- **Error Handling**: Typed exception handling with specific error types
+- **Configuration**: Strongly typed configuration objects
+
+This ensures reliability and provides excellent IDE support with autocompletion and type checking.
 
 ## 🧪 Development
 
+ClassMetrix uses modern Ruby development practices with comprehensive type checking and VS Code integration.
+
+### Quick Setup
+
 ```bash
 # Clone the repository
 git clone https://github.com/patrick204nqh/class-metrix.git
@@ -451,15 +474,47 @@ bundle install
 # Run tests
 bundle exec rspec
 
+# Run type checking
+bundle exec steep check
+
+# Run linting
+bundle exec rubocop
+
 # Run examples
 ruby examples/basic/01_simple_constants.rb
 ruby examples/advanced/hash_expansion.rb
 ```
 
+### Type Safety
+
+ClassMetrix maintains **100% type coverage** using:
+
+- **RBS Type Annotations**: Complete type signatures for all public APIs
+- **Steep Type Checking**: Static analysis for type correctness
+- **Comprehensive Type Tests**: Ensuring type safety across all components
+
+```bash
+# Check type coverage
+bundle exec steep stats
+
+# Watch mode for development
+bundle exec steep watch
+
+# Validate RBS files
+bundle exec rbs validate
+```
+
+### Code Quality
+
+- **RuboCop**: Enforced code style and best practices
+- **RSpec**: Comprehensive test suite with >95% coverage
+- **CI/CD**: Automated testing across Ruby 3.2+ versions
+
 ## 📋 Requirements
 
-- Ruby 2.7+
-- No runtime dependencies (pure Ruby implementation)
+- **Ruby 3.1+** (Required for full RBS and Steep support)
+- **No runtime dependencies** (Pure Ruby implementation)
+- **Development dependencies**: RBS (~> 3.0), Steep (~> 1.0), RuboCop (~> 1.0)
 
 ## 🤝 Contributing
 
@@ -476,6 +531,5 @@ This gem is available as open source under the terms of the [MIT License](LICENS
 ## 🔗 Links
 
 - [Documentation](https://github.com/patrick204nqh/class-metrix/wiki)
-- [Examples](examples/)
-- [Build Guide](BUILD_GUIDE.md)
 - [Changelog](CHANGELOG.md)
+- [Examples](examples/)

data/Rakefile

@@ -9,4 +9,67 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+# Add Brakeman security scanner
+begin
+  require "brakeman"
+
+  desc "Run Brakeman security scanner"
+  task :brakeman do
+    puts "🔍 Running Brakeman security scan..."
+    # Ensure tmp directory exists
+    Dir.mkdir("tmp") unless Dir.exist?("tmp")
+
+    # Run with non-zero exit to avoid breaking CI but still capture issues
+    result = system("brakeman --force --format json --output tmp/brakeman.json --no-exit-on-warn")
+    unless result
+      puts "⚠️ Brakeman found potential security issues - check tmp/brakeman.json"
+    end
+
+    # Also create human-readable output
+    system("brakeman --force --format text --output tmp/brakeman.txt --no-exit-on-warn")
+
+    puts "✅ Brakeman security scan completed"
+    puts "📄 Reports saved to: tmp/brakeman.json and tmp/brakeman.txt"
+  end
+
+  desc "Run Brakeman security scanner with HTML output"
+  task :brakeman_html do
+    puts "🔍 Running Brakeman security scan (HTML output)..."
+    Dir.mkdir("tmp") unless Dir.exist?("tmp")
+
+    system("brakeman --force --format html --output tmp/brakeman.html --no-exit-on-warn")
+    puts "✅ Brakeman HTML report generated: tmp/brakeman.html"
+  end
+
+  desc "Run comprehensive security check"
+  task :security => [:brakeman] do
+    puts "🔒 Security check completed"
+  end
+
+rescue LoadError
+  desc "Brakeman not available"
+  task :brakeman do
+    puts "⚠️ Brakeman not available - install with: gem install brakeman"
+  end
+
+  task :security => [] do
+    puts "⚠️ Security tools not available"
+  end
+end
+
+# Coverage task for local development
+desc "Run tests with coverage report"
+task :coverage do
+  ENV["COVERAGE"] = "true"
+  Rake::Task[:spec].invoke
+  puts "📊 Coverage report generated in coverage/"
+end
+
+# Quality check task combining multiple checks
+desc "Run all quality checks"
+task :quality => [:rubocop, :security] do
+  puts "✅ All quality checks completed"
+end
+
+# Add security to default tasks for better security
+task default: %i[spec rubocop security]

data/config/brakeman.yml

@@ -0,0 +1,37 @@
+# Brakeman configuration for ClassMetrix (Ruby Gem)
+# https://brakemanscanner.org/docs/options/
+
+# Application settings
+app_path: "."
+rails: false
+
+# Files to scan (gem-specific)
+only_files:
+  - "lib/**/*.rb"
+
+# Skip certain files
+skip_files:
+  - "spec/**/*.rb"
+  - "test/**/*.rb"
+  - "examples/**/*.rb"
+  - "bin/**/*"
+  - "vendor/**/*"
+  - "tmp/**/*"
+  - "coverage/**/*"
+
+# Security check configuration
+min_confidence: 2
+exit_on_warn: false
+exit_on_error: false
+
+# Output configuration
+format: text
+output_file: "tmp/brakeman-report.txt"
+ignore_file: ".brakeman.ignore"
+
+# Display options
+quiet: false
+summary: true
+
+# Force scan even for non-Rails apps
+force: true