class-metrix 0.1.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f907803028cff5b1f0e8fcc21bd9e9b68d4dc496ba450dda0364337f5548c06a
-  data.tar.gz: 1d02ce1725a8542e9a5e60a528c248838ff072743c4556c17878b68a7a5ae931
+  metadata.gz: 9b893eab40ee30c91bfb72059fcaffc282efca2088e4e150d2cf89c7fb0ff835
+  data.tar.gz: 553832b76ef1c44f6ace2cb7b37808dc2e18ef3c2f16882cc2aa951d1d9b82b3
 SHA512:
-  metadata.gz: c7d44e8e2359f858fc349179539cb5d7d7cf831abb6da76f77eaec75e882efd4f3d9cb371f6070c34ab4048d9fb319ddf7621fadafc5a0cc0d00089c8f8881f2
-  data.tar.gz: 349ccda98eec305973604160b6238c47b3c764f5f1935ca7d06bf63fcf4a8832b8d026e7810dff3504ac38eddf029f7ac45fdfe9b3fdfaa0f19bde7adbab449c
+  metadata.gz: 98297596048b427aa614a18ab3bb01cde37382b95df9b10dd2d9e2856db0afccdc420245e6b5f84ac676fa35bd7b6b68e8d945bf58f987526c39fde840d05a8f
+  data.tar.gz: dc3729ab21692725a5660b781c51c81282640640a3fae6d11328fb0485f30f4af4e30e71c74e987a3ad5709726878fb04713e349098bd4df0538468416b0099f

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,128 @@
+# VS Code Configuration for ClassMetrix
+
+## 🎯 Overview
+
+This directory contains comprehensive VS Code configuration for the ClassMetrix Ruby gem development with full RBS (Ruby Signature) and Steep type checking integration.
+
+## 📦 Extensions
+
+### Required Extensions
+
+- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language support
+- **RBS Syntax** (`soutaro.rbs-syntax`) - RBS file syntax highlighting
+- **Steep VS Code** (`soutaro.steep-vscode`) - Type checking integration
+- **RBS Snippets** (`mateuszdrewniak.rbs-snippets`) - Code snippets for RBS
+
+### Optional Extensions
+
+- **Ruby Debugger** (`koichisasada.vscode-rdbg`) - Debugging support
+- **GitLens** (`eamodio.gitlens`) - Enhanced Git integration
+- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Documentation support
+
+## ⚙️ Settings Configuration
+
+### Ruby Language Support
+
+- **Format on Save**: Enabled with RuboCop
+- **Ruby LSP**: Full feature set enabled
+- **Semantic Highlighting**: Enabled for both Ruby and RBS files
+
+### RBS Type Checking
+
+- **Steep Integration**: Real-time type checking
+- **Diagnostics**: Enabled for immediate feedback
+- **File Associations**: `.rbs` files properly recognized
+
+### Code Quality
+
+- **RuboCop**: Integrated for code formatting and linting
+- **Auto-fix on Save**: Automatic code corrections
+
+## 🛠️ Available Tasks
+
+### Ruby Development Tasks
+
+- **`Ctrl+Shift+P` → "Tasks: Run Task"**
+
+| Task                        | Description                 | Shortcut               |
+| --------------------------- | --------------------------- | ---------------------- |
+| `Rubocop: Check`            | Lint all Ruby files         | -                      |
+| `Rubocop: Fix`              | Auto-fix all RuboCop issues | `Ctrl+Shift+R, Ctrl+R` |
+| `Rubocop: Fix Current File` | Fix current file only       | -                      |
+| `RSpec: Run All Tests`      | Run entire test suite       | -                      |
+| `RSpec: Run Current File`   | Run tests for current file  | -                      |
+
+### Type Checking Tasks
+
+| Task                       | Description                 | Shortcut               |
+| -------------------------- | --------------------------- | ---------------------- |
+| `RBS: Validate`            | Validate RBS syntax         | `Ctrl+Shift+R, Ctrl+V` |
+| `RBS: Generate Prototypes` | Generate RBS from Ruby code | -                      |
+| `Steep: Type Check`        | Run type checking           | `Ctrl+Shift+R, Ctrl+S` |
+| `Steep: Watch Mode`        | Continuous type checking    | `Ctrl+Shift+R, Ctrl+W` |
+
+### Build Tasks
+
+| Task             | Description              |
+| ---------------- | ------------------------ |
+| `Bundle Install` | Install gem dependencies |
+
+## ⌨️ Keyboard Shortcuts
+
+### Custom Shortcuts
+
+- **`Ctrl+Shift+R, Ctrl+V`**: RBS Validate
+- **`Ctrl+Shift+R, Ctrl+S`**: Steep Type Check
+- **`Ctrl+Shift+R, Ctrl+W`**: Steep Watch Mode
+- **`Ctrl+Shift+R, Ctrl+R`**: RuboCop Fix
+
+### Usage Pattern
+
+1. Press `Ctrl+Shift+R` to enter "Ruby mode"
+2. Press the second key for the specific action
+
+## 📝 Code Snippets
+
+### RBS Snippets
+
+- **`rbsclass`**: Complete RBS class template
+- **`rbsmodule`**: RBS module template
+- **`rbsmethod`**: Method signature
+- **`rbsattr_reader`**: Attribute reader
+- **`rbsattr_writer`**: Attribute writer
+- **`rbsattr_accessor`**: Attribute accessor
+
+### Usage
+
+1. Type snippet prefix in `.rbs` file
+2. Press `Tab` to expand
+3. Use `Tab` to navigate through placeholders
+
+## 🚀 Getting Started
+
+### 1. Install Extensions
+
+VS Code will prompt to install recommended extensions when you open the workspace.
+
+### 2. Verify Setup
+
+1. Open any `.rb` file - should have Ruby LSP support
+2. Open any `.rbs` file - should have syntax highlighting
+3. Run `Ctrl+Shift+R, Ctrl+S` - should type check without errors
+
+### 3. Start Development
+
+1. Use `Ctrl+Shift+R, Ctrl+W` to start watch mode
+2. Edit Ruby files - see real-time type checking
+3. Use code snippets for rapid RBS development
+
+## 📊 Current Status
+
+✅ **Type Safety**: 100% (0 Steep errors)
+✅ **RBS Coverage**: Complete for all extractors
+✅ **VS Code Integration**: Fully configured
+✅ **Development Workflow**: Optimized
+
+---
+
+This VS Code setup provides a complete Ruby development environment with modern type checking capabilities.

data/.vscode/extensions.json

@@ -0,0 +1,31 @@
+{
+  "recommendations": [
+    // Ruby language support
+    "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",
+    "redhat.vscode-yaml",
+    "editorconfig.editorconfig",
+
+    // Git integration
+    "eamodio.gitlens",
+
+    // Additional helpful extensions
+    "ms-vscode.test-adapter-converter",
+    "hbenl.vscode-test-explorer"
+  ]
+}

data/.vscode/keybindings.json

@@ -0,0 +1,26 @@
+[
+  {
+    "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/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/rbs.code-snippets

@@ -0,0 +1,61 @@
+{
+  "RBS Class Definition": {
+    "prefix": "rbsclass",
+    "body": [
+      "class ${1:ClassName}",
+      "  ${2:# Instance variables}",
+      "  ${3:@var}: ${4:Type}",
+      "",
+      "  ${5:# Methods}",
+      "  def initialize: (${6:params}) -> void",
+      "  def ${7:method_name}: (${8:params}) -> ${9:ReturnType}",
+      "",
+      "  private",
+      "",
+      "  def ${10:private_method}: () -> ${11:ReturnType}",
+      "end"
+    ],
+    "description": "RBS class definition template"
+  },
+  "RBS Module Definition": {
+    "prefix": "rbsmodule",
+    "body": [
+      "module ${1:ModuleName}",
+      "  ${2:# Module methods}",
+      "  def self.${3:method_name}: (${4:params}) -> ${5:ReturnType}",
+      "",
+      "  ${6:# Instance methods}",
+      "  def ${7:method_name}: (${8:params}) -> ${9:ReturnType}",
+      "end"
+    ],
+    "description": "RBS module definition template"
+  },
+  "RBS Method Definition": {
+    "prefix": "rbsmethod",
+    "body": [
+      "def ${1:method_name}: (${2:params}) -> ${3:ReturnType}"
+    ],
+    "description": "RBS method definition"
+  },
+  "RBS Attribute Reader": {
+    "prefix": "rbsattr_reader",
+    "body": [
+      "attr_reader ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute reader"
+  },
+  "RBS Attribute Writer": {
+    "prefix": "rbsattr_writer",
+    "body": [
+      "attr_writer ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute writer"
+  },
+  "RBS Attribute Accessor": {
+    "prefix": "rbsattr_accessor",
+    "body": [
+      "attr_accessor ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute accessor"
+  }
+}

data/.vscode/settings.json

@@ -0,0 +1,112 @@
+{
+  // 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"
+    }
+  },
+  "[rbs]": {
+    "editor.defaultFormatter": "soutaro.rbs-syntax",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.semanticHighlighting.enabled": true,
+    "editor.rulers": [120],
+    "editor.trimAutoWhitespace": true
+  },
+
+  // File associations
+  "files.associations": {
+    "*.gemspec": "ruby",
+    "Gemfile": "ruby",
+    "Rakefile": "ruby",
+    ".rubocop.yml": "yaml",
+    "*.rbs": "rbs",
+    "Steepfile": "ruby"
+  },
+
+  // 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,
+
+  // Steep type checker settings
+  "steep.enabled": true,
+  "steep.checkOnSave": true,
+  "steep.diagnosticsEnabled": true,
+  "steep.signatureHelp": true,
+  "steep.hover": true,
+
+  // RBS validation settings
+  "ruby.rbs": {
+    "enabled": true,
+    "diagnostics": true
+  },
+
+  // Additional helpful settings
+  "breadcrumbs.enabled": true,
+  "editor.minimap.enabled": true,
+  "workbench.editor.enablePreview": false
+}

data/.vscode/tasks.json

@@ -0,0 +1,240 @@
+{
+  "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"
+      }
+    },
+    {
+      "label": "RBS: Validate",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rbs", "validate"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "rbs",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "message": 4
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Steep: Type Check",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "check"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Steep: Watch Mode",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "watch", "lib"],
+      "group": "build",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ],
+          "background": {
+            "activeOnStart": true,
+            "beginsPattern": "^# Type checking files:",
+            "endsPattern": "^(No type error detected|Detected \\d+ problems)"
+          }
+        }
+      ]
+    },
+    {
+      "label": "Steep: Watch All Targets",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "watch", "--target", "lib"],
+      "group": "build",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ],
+          "background": {
+            "activeOnStart": true,
+            "beginsPattern": "^# Type checking files:",
+            "endsPattern": "^(No type error detected|Detected \\d+ problems)"
+          }
+        }
+      ]
+    },
+    {
+      "label": "RBS: Generate Prototypes",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rbs", "prototype", "rb", "lib"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
+    }
+  ]
+}