Initial commit

This commit is contained in:
Zhongwei Li
2025-11-30 08:30:07 +08:00
commit d6f6fcbaad
33 changed files with 4697 additions and 0 deletions

View File

@@ -0,0 +1,169 @@
# Pattern Detector / RuboCop Scripts
Executable shell scripts for code style checking and analysis.
## Scripts
### run_rubocop.sh
Run RuboCop with helpful options.
```bash
# Check all files
./run_rubocop.sh check
# Auto-fix safe violations
./run_rubocop.sh fix
# Auto-fix all violations (including unsafe)
./run_rubocop.sh fix-all
# Check only changed files
./run_rubocop.sh changed
# Check only staged files (for pre-commit)
./run_rubocop.sh staged
# Check specific file
./run_rubocop.sh lib/user.rb
```
**Modes:**
- `check` - Check code style (no changes)
- `fix` - Auto-fix safe violations (-a flag)
- `fix-all` - Auto-fix all violations (-A flag, use with caution)
- `changed` - Only check git-modified files
- `staged` - Only check git-staged files
- `<file_path>` - Check specific file
**Features:**
- Auto-detects RuboCop availability
- Smart git integration
- Helpful error messages
- Shows which mode is running
### rubocop_summary.sh
Generate comprehensive RuboCop summary.
```bash
./rubocop_summary.sh
```
**Output:**
```
📊 Generating RuboCop summary...
Summary:
Files inspected: 45
Total offenses: 127
Top offenses by cop:
42 Style/StringLiterals
23 Layout/LineLength
15 Style/Documentation
12 Metrics/MethodLength
...
Offense severity breakdown:
85 convention
32 warning
10 error
To fix auto-correctable offenses:
bundle exec rubocop -a
```
**Features:**
- Runs RuboCop with JSON output
- Parses and summarizes results
- Shows top offense types
- Severity breakdown
- Actionable next steps
**Requires:**
- jq (JSON processor)
- RuboCop gem
## Usage Examples
### Pre-Commit Workflow
```bash
# Check staged files before commit
./run_rubocop.sh staged
# Auto-fix if possible
./run_rubocop.sh fix
# Stage fixes
git add .
# Check again
./run_rubocop.sh staged
```
### Code Review Workflow
```bash
# Check changed files
./run_rubocop.sh changed
# Get detailed summary
./rubocop_summary.sh
# Fix safe violations
./run_rubocop.sh fix
# Review remaining issues manually
```
### Clean-up Workflow
```bash
# Get overview
./rubocop_summary.sh
# Fix safe violations
./run_rubocop.sh fix
# Review unsafe fixes
./run_rubocop.sh check
# Manually fix or disable cops
```
## RuboCop Configuration
Create `.rubocop.yml` for project-specific rules:
```yaml
AllCops:
NewCops: enable
TargetRubyVersion: 3.2
Exclude:
- 'db/schema.rb'
- 'vendor/**/*'
- 'node_modules/**/*'
Metrics/MethodLength:
Max: 10 # Sandi Metz's rule
Metrics/ClassLength:
Max: 100 # Sandi Metz's rule
Style/Documentation:
Enabled: false # Adjust as needed
```
## Integration with Git Hooks
Use `staged` mode in pre-commit hook:
```bash
#!/bin/bash
# .git/hooks/pre-commit
/path/to/run_rubocop.sh staged
```
## Requirements
- RuboCop gem
- jq (for rubocop_summary.sh)
- git (for changed/staged modes)

View File

@@ -0,0 +1,43 @@
#!/usr/bin/env bash
# Generate RuboCop summary report
set -e
echo "📊 Generating RuboCop summary..."
# Run RuboCop with JSON output
bundle exec rubocop --format json --out tmp/rubocop_results.json --format progress || true
if [ ! -f "tmp/rubocop_results.json" ]; then
echo "No RuboCop results found"
exit 1
fi
# Parse results
TOTAL_FILES=$(jq '.files | length' tmp/rubocop_results.json)
OFFENSE_COUNT=$(jq '.summary.offense_count' tmp/rubocop_results.json)
INSPECTED=$(jq '.summary.inspected_file_count' tmp/rubocop_results.json)
echo ""
echo "Summary:"
echo " Files inspected: $INSPECTED"
echo " Total offenses: $OFFENSE_COUNT"
echo ""
if [ "$OFFENSE_COUNT" -eq 0 ]; then
echo "✅ No offenses found!"
exit 0
fi
echo "Top offenses by cop:"
jq -r '.files[].offenses[] | .cop_name' tmp/rubocop_results.json | \
sort | uniq -c | sort -rn | head -10
echo ""
echo "Offense severity breakdown:"
jq -r '.files[].offenses[] | .severity' tmp/rubocop_results.json | \
sort | uniq -c | sort -rn
echo ""
echo "To fix auto-correctable offenses:"
echo " bundle exec rubocop -a"

View File

@@ -0,0 +1,62 @@
#!/usr/bin/env bash
# Run RuboCop with helpful options
set -e
MODE=${1:-check}
echo "🔍 Running RuboCop (mode: $MODE)..."
# Check if RuboCop is available
if ! bundle exec rubocop --version &> /dev/null; then
echo "❌ RuboCop not found. Add to Gemfile:"
echo " gem 'rubocop', require: false"
exit 1
fi
case "$MODE" in
check)
echo "Checking code style..."
bundle exec rubocop
;;
fix)
echo "Auto-fixing safe violations..."
bundle exec rubocop -a
;;
fix-all)
echo "⚠️ Auto-fixing all violations (including unsafe)..."
bundle exec rubocop -A
;;
changed)
echo "Checking only changed files..."
CHANGED_FILES=$(git diff --name-only --diff-filter=AM | grep '\.rb$' || true)
if [ -z "$CHANGED_FILES" ]; then
echo "No changed Ruby files found"
exit 0
fi
bundle exec rubocop $CHANGED_FILES
;;
staged)
echo "Checking only staged files..."
STAGED_FILES=$(git diff --cached --name-only --diff-filter=AM | grep '\.rb$' || true)
if [ -z "$STAGED_FILES" ]; then
echo "No staged Ruby files found"
exit 0
fi
bundle exec rubocop $STAGED_FILES
;;
*)
# Treat as file path
if [ -f "$MODE" ]; then
echo "Checking file: $MODE"
bundle exec rubocop "$MODE"
else
echo "Unknown mode: $MODE"
echo "Available modes: check, fix, fix-all, changed, staged, <file_path>"
exit 1
fi
;;
esac
echo ""
echo "✅ RuboCop check complete"