ci(workflow): 添加 RuboCop 检查并优化 CI 流程

添加 RuboCop 及相关 gem 用于代码风格检查
在测试流程前添加 lint 步骤
优化测试步骤的分组和日志输出
添加 CI 健康检查任务

Author: Wpc-121

.github/workflows/ruby.yml

@@ -2,46 +2,82 @@ name: Ruby
 on: [push, pull_request]
 permissions:
   contents: read
+
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Run RuboCop
+        run: |
+          echo "::group::RuboCop"
+          bundle exec rubocop --format progress --format clang
+          echo "::endgroup::"
+
   test:
     runs-on: ubuntu-latest
+    needs: lint
     steps:
-    - uses: actions/checkout@v4.1.0
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.4
-        bundler-cache: true
-    - name: Install dependencies
-      run: |
-        gem install rails
-        bundle install
-    - name: Check Ruby Syntax in .rb files
-      run: find ./app/ | grep ".*\.rb$" | xargs -L 1 ruby -c
-    - name: Setup database
-      run: rails db:migrate RAILS_ENV=test
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v4.1.0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Database migrations
+        run: |
+          echo "::group::Database Migrations"
+          bundle exec rails db:migrate RAILS_ENV=test
+          echo "::endgroup::"
+
+      - name: CI health check
+        run: |
+          echo "::group::CI Health Check"
+          bundle exec rails ci:health RAILS_ENV=test
+          echo "::endgroup::"
+
+      - name: Run tests
+        run: |
+          echo "::group::Running Tests"
+          bundle exec rails test RAILS_ENV=test --verbose
+          echo "::endgroup::"
 
   smoke-test:
     runs-on: ubuntu-latest
     needs: test
     steps:
-    - uses: actions/checkout@v4.1.0
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.4
-        bundler-cache: true
-    - name: Install dependencies
-      run: |
-        gem install rails
-        bundle install
-    - name: Make scripts executable
-      run: |
-        chmod +x start-app.sh
-        chmod +x stop-app.sh
-        chmod +x status.sh
-        chmod +x smoke-ci.sh
-    - name: Run smoke CI test
-      run: ./smoke-ci.sh
+      - uses: actions/checkout@v4.1.0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Database migrations
+        run: |
+          echo "::group::Database Migrations"
+          bundle exec rails db:migrate RAILS_ENV=test
+          echo "::endgroup::"
+
+      - name: Make scripts executable
+        run: |
+          chmod +x start-app.sh
+          chmod +x stop-app.sh
+          chmod +x status.sh
+          chmod +x smoke-ci.sh
+
+      - name: Run smoke CI test
+        run: |
+          echo "::group::Smoke Test"
+          ./smoke-ci.sh
+          echo "::endgroup::"

.rubocop.yml

@@ -0,0 +1,121 @@
+require:
+  - rubocop-rails
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'db/schema.rb'
+    - 'db/migrate/*.rb'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'log/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Rails:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: true
+
+Rails/InverseOf:
+  Enabled: true
+
+Rails/UnknownEnv:
+  Enabled: true
+
+Rails/RedundantReceiverInWithOptions:
+  Enabled: false
+
+Performance:
+  Enabled: true
+
+Performance/Casecmp:
+  Enabled: true
+
+Performance/RedundantMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Naming/PredicateName:
+  Enabled: true
+  ForbiddenPrefixes:
+    - is_
+    - are_
+  AllowedMethods:
+    - is_a?
+    - kind_of?
+    - instance_of?
+
+Naming/FileName:
+  Exclude:
+    - 'config/initializers/*'
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/SwapValue:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/NumberConversion:
+  Enabled: true

Gemfile

@@ -36,8 +36,10 @@ gem 'rack-cors'
 gem 'lockbox', '=1.3.3'
 
 group :development, :test do
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug'
+  gem 'rubocop', require: false
+  gem 'rubocop-rails', require: false
+  gem 'rubocop-performance', require: false
 end
 
 group :development do

lib/tasks/ci.rake

@@ -0,0 +1,84 @@
+namespace :ci do
+  desc 'CI health check - verify application loads correctly'
+  task health: :environment do
+    puts '=' * 60
+    puts 'CI Health Check'
+    puts '=' * 60
+    puts
+
+    checks = []
+
+    checks << {
+      name: 'Database Connection',
+      check: -> {
+        ActiveRecord::Base.connection.execute('SELECT 1')
+        true
+      }
+    }
+
+    checks << {
+      name: 'User Model',
+      check: -> {
+        User.column_names.include?('email') && User.column_names.include?('name')
+      }
+    }
+
+    checks << {
+      name: 'Document Model',
+      check: -> {
+        Document.column_names.include?('title') && Document.column_names.include?('user_id')
+      }
+    }
+
+    checks << {
+      name: 'Routes Loaded',
+      check: -> {
+        Rails.application.routes.routes.any?
+      }
+    }
+
+    checks << {
+      name: 'JsonWebToken Available',
+      check: -> {
+        defined?(JsonWebToken) && JsonWebToken.respond_to?(:encode)
+      }
+    }
+
+    checks << {
+      name: 'Lockbox Available',
+      check: -> {
+        defined?(Lockbox)
+      }
+    }
+
+    all_passed = true
+
+    checks.each do |check|
+      begin
+        passed = check[:check].call
+        if passed
+          puts "  ✓ #{check[:name]}"
+        else
+          puts "  ✗ #{check[:name]} - FAILED"
+          all_passed = false
+        end
+      rescue => e
+        puts "  ✗ #{check[:name]} - ERROR: #{e.message}"
+        all_passed = false
+      end
+    end
+
+    puts
+    puts '=' * 60
+
+    if all_passed
+      puts 'Health Check: PASSED ✓'
+      puts '=' * 60
+      exit 0
+    else
+      puts 'Health Check: FAILED ✗'
+      puts '=' * 60
+      exit 1
+    end
+  end
+end

test/test_helper.rb

@@ -3,8 +3,7 @@
 require 'rails/test_help'
 
 class ActiveSupport::TestCase
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
   fixtures :all
 
-  # Add more helper methods to be used by all tests here...
+  parallelize(workers: :number_of_processors)
 end