class-metrix 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440b6eacf85b731cd683533be57ab3b2c17b25605ce70ed650bed43539f34531
-  data.tar.gz: 728575b7ddac28f55d5d192f3e1004858f19820453a9e6c3d00002df50855c92
+  metadata.gz: 0106c0c9302df96ca95140d24c7b95cd1a9b5a6381336b96b6bd639e3edd3ba7
+  data.tar.gz: e8a1c3fe4e9a1be7253514ff9851a6af39b2aa0975444e38196e252c596f0fb2
 SHA512:
-  metadata.gz: 868af534a658dc3a083315ee1660f4ba8754919474ac3d6c5c2458f2a5af8df763bfa292d6d1c426a0df20b4ef3419cd7cc031397bd14ed3a563f0dee07b605c
-  data.tar.gz: 9bcfe4160f94b93abf072e1888c92222a790387f16e16d376ef93be48c28d4ac7ee1edd931c6b9e70236c64e3bec17d0610c2561db14ab80e60d4f0ed1a6af41
+  metadata.gz: c0518a94b39fbfd118a5d3e4961602619cc91e611bbfef3a6e63b5d1c1b799f30b004710a3edc2489a31a060d8e6c8143f974b90dad1aab60971427f51c5c32f
+  data.tar.gz: e22b3a3db21c49321dcc986f79efa2eaabfe42f7b05dc75ff89e204a40f1f75e8079a11b0c1a48a3598f67082b8dd760823cd3662747ac8c2a980c5eeadb5f2a

data/.prettierrc.json

@@ -0,0 +1,41 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "avoid",
+  "printWidth": 80,
+  "endOfLine": "lf",
+  "proseWrap": "preserve",
+  "htmlWhitespaceSensitivity": "css",
+  "embeddedLanguageFormatting": "auto",
+  "overrides": [
+    {
+      "files": "*.json",
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2
+      }
+    },
+    {
+      "files": ["*.yml", "*.yaml"],
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2,
+        "singleQuote": false,
+        "bracketSpacing": true
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 80,
+        "proseWrap": "preserve",
+        "tabWidth": 2
+      }
+    }
+  ]
+}

data/.qlty/.gitignore

@@ -0,0 +1,7 @@
+*
+!configs
+!configs/**
+!hooks
+!hooks/**
+!qlty.toml
+!.gitignore

data/.qlty/configs/.yamllint.yaml

@@ -0,0 +1,8 @@
+rules:
+  document-start: disable
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ["{|}"]
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true

data/.qlty/qlty.toml

@@ -0,0 +1,108 @@
+# This file was automatically generated by `qlty init`.
+# You can modify it to suit your needs.
+# We recommend you to commit this file to your repository.
+#
+# This configuration is used by both Qlty CLI and Qlty Cloud.
+#
+#     Qlty CLI -- Code quality toolkit for developers
+#     Qlty Cloud -- Fully automated Code Health Platform
+#
+# Try Qlty Cloud: https://qlty.sh
+#
+# For a guide to configuration, visit https://qlty.sh/d/config
+# Or for a full reference, visit https://qlty.sh/d/qlty-toml
+config_version = "0"
+
+exclude_patterns = [
+  "*_min.*",
+  "*-min.*",
+  "*.min.*",
+  "**/.yarn/**",
+  "**/*.d.ts",
+  "**/assets/**",
+  "**/bower_components/**",
+  "**/build/**",
+  "**/cache/**",
+  "**/config/**",
+  "**/db/**",
+  "**/deps/**",
+  "**/dist/**",
+  "**/extern/**",
+  "**/external/**",
+  "**/generated/**",
+  "**/Godeps/**",
+  "**/gradlew/**",
+  "**/mvnw/**",
+  "**/node_modules/**",
+  "**/protos/**",
+  "**/seed/**",
+  "**/target/**",
+  "**/templates/**",
+  "**/testdata/**",
+  "**/vendor/**",
+  # Project-specific exclusions
+  "**/.github/**",           # GitHub configuration files
+  "**/examples/**",          # Example code doesn't need strict formatting
+  "**/docs/**",              # Documentation files are less strict
+  "**/.vscode/**",           # VS Code configuration files
+  "**/bin/**",               # Script files
+  # Documentation files with relaxed formatting
+  "README.md",               # Readme can have long lines
+  "CHANGELOG.md",            # Changelog can have duplicate headers
+]
+
+test_patterns = [
+  "**/test/**",
+  "**/spec/**",
+  "**/*.test.*",
+  "**/*.spec.*",
+  "**/*_test.*",
+  "**/*_spec.*",
+  "**/test_*.*",
+  "**/spec_*.*",
+]
+
+[smells]
+mode = "comment"
+
+[[source]]
+name = "default"
+default = true
+
+
+[[plugin]]
+name = "actionlint"
+
+[[plugin]]
+name = "checkov"
+
+[[plugin]]
+name = "markdownlint"
+mode = "comment"
+
+[[plugin]]
+name = "osv-scanner"
+
+[[plugin]]
+name = "prettier"
+
+[[plugin]]
+name = "ripgrep"
+mode = "comment"
+
+[[plugin]]
+name = "rubocop"
+version = "1.75.8"
+
+[[plugin]]
+name = "trivy"
+drivers = [
+  "config",
+  "fs-vuln",
+]
+
+[[plugin]]
+name = "trufflehog"
+
+[[plugin]]
+name = "yamllint"

data/.rubocop.yml

@@ -3,11 +3,14 @@ AllCops:
   SuggestExtensions: false
   NewCops: enable
   Exclude:
-    - 'bin/*'
-    - 'examples/**/*'
-    - 'vendor/**/*'
-    - 'node_modules/**/*'
-    - '.ruby-lsp/**/*'
+    - bin/*
+    - config/**/*
+    - examples/**/*
+    - tmp/**/*
+    - vendor/**/*
+    - node_modules/**/*
+    - .ruby-lsp/**/*
+    - Rakefile
 
 # String literal styles
 Style/StringLiterals:
@@ -18,49 +21,52 @@ Style/StringLiteralsInInterpolation:
 
 # Documentation requirements
 Style/Documentation:
-  Enabled: false  # Many classes don't need top-level 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
+  Max: 25 # Increased to accommodate current codebase
 
 Metrics/ClassLength:
-  Max: 250  # Increased to accommodate complex formatter classes
+  Max: 250 # Increased to accommodate complex formatter classes
 
 Metrics/BlockLength:
-  Max: 30  # Slightly increased from default
+  Max: 30 # Slightly increased from default
   Exclude:
-    - 'spec/**/*'  # Allow long blocks in tests
-    - 'class-metrix.gemspec'  # Allow long blocks in gemspec
+    - 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
+  Max: 35 # Increased to accommodate current codebase
 
 Metrics/CyclomaticComplexity:
-  Max: 15  # Increased to accommodate current codebase
+  Max: 15 # Increased to accommodate current codebase
 
 Metrics/PerceivedComplexity:
-  Max: 15  # Increased to accommodate current codebase
+  Max: 15 # Increased to accommodate current codebase
 
 # Line length
 Layout/LineLength:
-  Max: 140  # Increased from default 120
+  Max: 140 # Increased from default 120
 
 # Naming conventions
 Naming/AccessorMethodName:
-  Enabled: false  # Allow get_ prefixed methods
+  Enabled: false # Allow get_ prefixed methods
 
-Naming/PredicateName:
-  Enabled: false  # Allow has_ prefixed methods
+Naming/PredicatePrefix:
+  Enabled: false # Allow has_ prefixed methods
+
+Naming/PredicateMethod:
+  Enabled: false # Allow boolean methods without ? suffix in tests
 
 # Optional boolean parameters
 Style/OptionalBooleanParameter:
-  Enabled: false  # Allow boolean default parameters
+  Enabled: false # Allow boolean default parameters
 
 # Gemspec warning
 Gemspec/RequiredRubyVersion:
-  Enabled: false  # Allow different ruby versions in gemspec vs rubocop
+  Enabled: false # Allow different ruby versions in gemspec vs rubocop
 
 # Script permissions (for examples)
 Lint/ScriptPermission:
@@ -72,17 +78,17 @@ Lint/ConstantDefinitionInBlock:
 
 # String concatenation
 Style/StringConcatenation:
-  Enabled: false  # Allow string concatenation in some cases
+  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
+  Enabled: false # Allow development dependencies in gemspec
 
 Lint/DuplicateBranch:
-  Enabled: false  # Allow duplicate rescue branches for different error types
+  Enabled: false # Allow duplicate rescue branches for different error types
 
 Style/ComparableClamp:
-  Enabled: false  # Allow traditional min/max patterns for clarity
+  Enabled: false # Allow traditional min/max patterns for clarity
 
 Lint/NonAtomicFileOperation:
-  Enabled: false  # Allow traditional file existence checks in specs
+  Enabled: false # Allow traditional file existence checks in specs

data/.vscode/README.md

@@ -1,72 +1,280 @@
-# VS Code Works### Ruby Support
+# VS Code Development Environment for ClassMetrix
 
-- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server with Rubocop formatting
-- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+## 🎯 Overview
 
-### Markdown Support
+This directory contains a comprehensive VS Code development environment for the ClassMetrix Ruby gem, featuring modern Ruby development practices with full type safety through RBS and Steep integration.
 
-- **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
+## 🌟 Key Features
 
-This folder contains VS Code workspace configuration files that help maintain consistent development environment across team members.
+- **🔧 Complete Ruby LSP Integration** - Full language support with intelligent code completion
+- **🔍 Real-time Type Checking** - Steep integration with live error detection
+- **📝 RBS Type Annotations** - Full support for Ruby signature files
+- **🚀 Auto-formatting** - RuboCop integration with format-on-save
+- **⌨️ Custom Keyboard Shortcuts** - Optimized development workflow
+- **🧪 Integrated Testing** - One-click RSpec test execution
+- **🛠️ Smart Problem Matching** - VS Code integration for all tools
 
-## Files Overview
+## 📦 Extensions Configuration
 
-- **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 (Auto-installed)
 
-## Required Extensions
+Our `extensions.json` automatically recommends these essential extensions:
 
-To get the best development experience, install these recommended extensions:
+- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server
+- **Steep VS Code** (`soutaro.steep-vscode`) - Real-time type checking
+- **Ruby Debugger** (`koichisasada.vscode-rdbg`) - Advanced debugging support
 
-### Ruby Support
+### Productivity Extensions
 
-- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server
-- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+- **Prettier** (`esbenp.prettier-vscode`) - Markdown and JSON formatting
+- **GitLens** (`eamodio.gitlens`) - Enhanced Git integration
+- **YAML Support** (`redhat.vscode-yaml`) - YAML file support
+- **EditorConfig** (`editorconfig.editorconfig`) - Consistent editor settings
+
+## ⚙️ Intelligent Settings Configuration
+
+### Ruby Language Support
+
+Our settings provide optimal Ruby development experience:
+
+```json
+{
+  "ruby.format": "rubocop", // Use RuboCop for formatting
+  "ruby.useLanguageServer": true, // Enable Ruby LSP
+  "ruby.intellisense": "rubyLsp", // Intelligent code completion
+  "editor.formatOnSave": true, // Auto-format on save
+  "editor.semanticHighlighting.enabled": true // Enhanced syntax highlighting
+}
+```
+
+### File-Specific Configurations
+
+#### Ruby Files (`.rb`, `.gemspec`, `Rakefile`)
+
+- **Formatter**: Ruby LSP with RuboCop
+- **Tab Size**: 2 spaces
+- **Line Length**: 140 characters
+- **Auto-fix**: RuboCop issues on save
+
+#### RBS Files (`.rbs`)
+
+- **Formatter**: RBS syntax formatter
+- **Tab Size**: 2 spaces
+- **Line Length**: 120 characters
+- **Semantic Highlighting**: Enabled
+
+#### Markdown Files (`.md`)
+
+- **Formatter**: Prettier
+- **Word Wrap**: Enabled
+- **Tab Size**: 2 spaces
+
+### Type Checking Integration
+
+- **Steep**: Real-time type checking with diagnostics
+- **RBS Validation**: Automatic signature file validation
+- **Error Integration**: Problems panel integration
+
+## 🛠️ Available Tasks
+
+Access tasks via `Ctrl+Shift+P` → "Tasks: Run Task" or use keyboard shortcuts:
+
+### Ruby Development Tasks
+
+| Task                          | Description                               | Group |
+| ----------------------------- | ----------------------------------------- | ----- |
+| **Rubocop: Check**            | Lint all Ruby files with problem matching | Test  |
+| **Rubocop: Fix**              | Auto-fix all RuboCop issues               | Build |
+| **Rubocop: Fix Current File** | Fix only the current file                 | Build |
+| **RSpec: Run All Tests**      | Execute entire test suite                 | Test  |
+| **RSpec: Run Current File**   | Run tests for current file only           | Test  |
+| **Bundle Install**            | Install gem dependencies                  | Build |
+
+### Type Checking & RBS Tasks
+
+| Task                         | Description                              | Group |
+| ---------------------------- | ---------------------------------------- | ----- |
+| **RBS: Validate**            | Validate RBS syntax with error detection | Test  |
+| **RBS: Generate Prototypes** | Generate RBS from Ruby code              | Build |
+| **Steep: Type Check**        | Run one-time type checking               | Test  |
+| **Steep: Watch Mode**        | Continuous type checking (background)    | Build |
+| **Steep: Watch All Targets** | Watch all configured targets             | Build |
+
+### Problem Matchers
+
+All tasks include intelligent problem matchers that integrate errors directly into VS Code's Problems panel:
+
+- **RuboCop**: File/line/column error positioning
+- **RSpec**: Test failure integration
+- **Steep**: Type error reporting with severity levels
+- **RBS**: Syntax validation errors
+
+## ⌨️ Custom Keyboard Shortcuts
+
+Our workflow uses a two-key chord system starting with `Ctrl+Shift+R`:
+
+### Primary Shortcuts
+
+| Shortcut               | Task                  | Description                    |
+| ---------------------- | --------------------- | ------------------------------ |
+| `Ctrl+Shift+R, Ctrl+V` | **RBS: Validate**     | Validate type signatures       |
+| `Ctrl+Shift+R, Ctrl+S` | **Steep: Type Check** | Run type checking              |
+| `Ctrl+Shift+R, Ctrl+W` | **Steep: Watch Mode** | Start continuous type checking |
+| `Ctrl+Shift+R, Ctrl+R` | **Rubocop: Fix**      | Auto-fix code style issues     |
+
+### Usage Pattern
+
+1. **Press `Ctrl+Shift+R`** to enter "Ruby development mode"
+2. **Press the second key** for the specific action
+3. **View results** in the integrated terminal or Problems panel
+
+## 🚀 Getting Started
+
+### 1. Automatic Extension Installation
+
+When you open this workspace in VS Code, you'll be prompted to:
+
+- Install recommended extensions
+- Enable workspace settings
+- Configure the development environment
+
+### 2. Verify Your Setup
+
+#### Basic Functionality Check
+
+1. **Open any `.rb` file** → Should show Ruby LSP features (autocompletion, hover info)
+2. **Open any `.rbs` file** → Should have syntax highlighting and validation
+3. **Save a Ruby file** → Should auto-format with RuboCop
+
+#### Test Keyboard Shortcuts
+
+1. **Press `Ctrl+Shift+R, Ctrl+S`** → Should run type checking
+2. **Press `Ctrl+Shift+R, Ctrl+W`** → Should start watch mode
+3. **Press `Ctrl+Shift+R, Ctrl+V`** → Should validate RBS files
+
+### 3. Development Workflow
+
+#### For Active Development
+
+```bash
+# Start continuous type checking
+Ctrl+Shift+R, Ctrl+W
+
+# Make your changes...
+# Files auto-format on save
+# See real-time type checking feedback
+```
+
+#### For Code Review
+
+```bash
+# Check all types
+Ctrl+Shift+R, Ctrl+S
+
+# Fix all style issues
+Ctrl+Shift+R, Ctrl+R
+
+# Validate RBS signatures
+Ctrl+Shift+R, Ctrl+V
+```
+
+## 🔧 Advanced Configuration
+
+### Debug Configuration
+
+The included `launch.json` provides Ruby debugging setup:
+
+- **Ruby Debug** - Full debugging support with breakpoints
+- **RSpec Debug** - Debug individual test files
+- **Integration** with `vscode-rdbg` extension
+
+### Workspace Settings
+
+Key workspace-specific settings:
+
+```json
+{
+  "files.autoSave": "onFocusChange", // Save when switching files
+  "files.trimTrailingWhitespace": true, // Clean trailing spaces
+  "files.insertFinalNewline": true, // Ensure final newline
+  "breadcrumbs.enabled": true, // Show code breadcrumbs
+  "workbench.editor.enablePreview": false // Always open new tabs
+}
+```
+
+### File Associations
+
+Automatic recognition for Ruby ecosystem files:
+
+- `*.gemspec` → Ruby
+- `Gemfile` → Ruby
+- `Rakefile` → Ruby
+- `Steepfile` → Ruby
+- `*.rbs` → RBS
+- `.rubocop.yml` → YAML
+
+## 📊 Development Status
+
+### Type Safety Status
+
+✅ **RBS Coverage**: Complete type annotations for all public APIs
+✅ **Steep Integration**: Real-time type checking with zero errors
+✅ **Problem Matching**: All type errors appear in VS Code Problems panel
+
+### Code Quality Status
+
+✅ **RuboCop Integration**: Auto-formatting and linting on save
+✅ **Test Integration**: One-click RSpec execution with results
+✅ **Git Integration**: GitLens for enhanced version control
+
+### Workflow Optimization
+
+✅ **Keyboard Shortcuts**: Efficient two-key chord system
+✅ **Background Tasks**: Watch mode for continuous feedback
+✅ **Smart Defaults**: Optimized settings for Ruby development
+
+## 🛠️ Troubleshooting
 
-### Markdown Support
+### Common Issues
 
-- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Comprehensive Markdown support
-- **markdownlint** (`davidanson.vscode-markdownlint`) - Markdown linting
+#### Extensions Not Loading
 
-### General
+- Ensure you've accepted the workspace extension recommendations
+- Restart VS Code after installing extensions
+- Check VS Code version compatibility
 
-- **EditorConfig** (`editorconfig.editorconfig`) - Consistent coding styles
-- **GitLens** (`eamodio.gitlens`) - Enhanced Git capabilities
+#### Type Checking Not Working
 
-## Auto-formatting
+- Verify Steep is in your Gemfile: `gem 'steep', '~> 1.0'`
+- Run `bundle install` to ensure dependencies
+- Check that `Steepfile` exists in project root
 
-The configuration enables automatic formatting on save for:
+#### RuboCop Not Formatting
 
-- **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
+- Ensure `.rubocop.yml` configuration exists
+- Install RuboCop: `gem install rubocop`
+- Check Ruby LSP is using RuboCop formatter
 
-## Available Tasks
+### Debug Commands
 
-Access via `Ctrl+Shift+P` → "Tasks: Run Task":
+```bash
+# Check Ruby LSP status
+Ruby LSP: Show Output Channel
 
-- **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
+# Verify Steep configuration
+bundle exec steep check --debug
 
-## Debug Configurations
+# Test RuboCop configuration
+bundle exec rubocop --version
+```
 
-Available debug configurations:
+## 📚 Additional Resources
 
-- **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
+- **[Ruby LSP Documentation](https://shopify.github.io/ruby-lsp/)**
+- **[Steep Type Checker](https://github.com/soutaro/steep)**
+- **[RBS Documentation](https://github.com/ruby/rbs)**
+- **[RuboCop Configuration](https://docs.rubocop.org/)**
 
-## 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
+This VS Code setup provides a modern, type-safe Ruby development environment optimized for the ClassMetrix gem development workflow.

data/.vscode/extensions.json

@@ -1,15 +1,16 @@
-{  "recommendations": [
+{
+  "recommendations": [
     // Ruby language support
     "shopify.ruby-lsp",
-    "castwide.solargraph",
 
-    // Alternative Ruby support (choose one of the above)
-    // "rebornix.ruby",
+    // RBS and Steep support (type checking)
+    "soutaro.steep-vscode",
+
+    // Debugging support
+    "koichisasada.vscode-rdbg",
 
     // Markdown support
     "esbenp.prettier-vscode",
-    "yzhang.markdown-all-in-one",
-    "davidanson.vscode-markdownlint",
 
     // General productivity
     "ms-vscode.vscode-json",
@@ -17,12 +18,6 @@
     "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"
+    "eamodio.gitlens"
   ]
 }