rails_code_health 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 806988266c00efaa8181b4379e6baa5f5ff9e5913fa4a0801fd993ededf3a580
-  data.tar.gz: 61e1909e93309e22265b961038f87da7c0367f38cf6cf9a763449e144e39c73f
+  metadata.gz: 4b357d8913c61f87fa0edb2c9f672963c90a56a1b9679e0ee41a80c17d69883f
+  data.tar.gz: 55f62937933e657fe285dfddf64238ab39ef19114118c265f849773023ee56b5
 SHA512:
-  metadata.gz: 37d498b553e834f76811b405f6be6b967fec45512170098b70b818bc952de8321cf7790dce0f7b93b1353fc373b12614ba9f7be98466e871d26f25b22ad75938
-  data.tar.gz: 1ca51781fa1cccfdabd3ef5e138d2cd2aea2e0a64432ea7e26802464c4e5c732185c09a8622ca4a558f8ccef7762653a168982dcc1db9f6fe29633ded8feb673
+  metadata.gz: 47aa3d974735472e21adc083cd66237582241d71e12e6801615915277de1bb221e3f97080e2166da32ec6a91276f0f1070e0c0f73678c866e73400de2e2fa8a7
+  data.tar.gz: e7709324ea411f35eddfeed0fa0c4070cb902a1a87761a76d27d21d0f0aa7bcb7e6f30588dc6d0d65a351990c8bbcf570965b0adfae760aa2b52d0fe7ca937ad

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.3] - 2026-05-18
+
+### Fixed
+- Removed the canned "Focus on these improvement areas" block from the recommendations report. It was a static fortune-cookie message printed on every run regardless of the actual findings, making reports look templated. The "Most Common Issues (by frequency)" section above it already provides evidence-based, data-driven recommendations derived from real per-file findings.
+- The "🎯 Priority Actions:" header is now only emitted when there are actually critical files to act on (no more orphaned header).
+
+## [0.3.2] - 2026-05-18
+
+### Added
+- `--fail-under SCORE` CLI flag: exits with code `2` when the average health score is below the given threshold. Lets teams gate CI builds on overall code health.
+- `--max-critical N` CLI flag: exits with code `2` when more than `N` files fall into the Critical category. Useful for blocking PRs that introduce severely unhealthy files.
+- GitHub Actions example in the README and landing page.
+
+### Fixed
+- Removed dead `config/tresholds.json` file (misspelled, never loaded by the gem) and the unreachable file-loading branch in `Configuration#load_default_thresholds`. The hardcoded defaults in `Configuration#default_hardcoded_thresholds` are now the single source of truth for the gem's built-in thresholds. User-supplied configs via `--config` continue to work unchanged.
+
+### Changed
+- Removed `config/**/*` from `gemspec`'s shipped files (the directory no longer exists).
+
 ## [0.3.1] - 2026-05-18
 
 ### Fixed
@@ -81,7 +100,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Reporting**: Detailed console output with health categories and JSON export
 - **CLI**: `rails-health` command with options for format, output file, and custom configuration
 
-[Unreleased]: https://github.com/gkosmo/rails_code_health/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/gkosmo/rails_code_health/compare/v0.3.3...HEAD
+[0.3.3]: https://github.com/gkosmo/rails_code_health/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/gkosmo/rails_code_health/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/gkosmo/rails_code_health/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/gkosmo/rails_code_health/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/gkosmo/rails_code_health/compare/v0.1.0...v0.2.0

data/README.md

@@ -55,6 +55,43 @@ Use custom configuration:
 rails-health --config custom_thresholds.json
 ```
 
+### Continuous Integration
+
+Use `--fail-under` and/or `--max-critical` to gate CI builds on code health:
+
+```bash
+# Fail the build if the average health score drops below 7.0
+rails-health --fail-under 7.0
+
+# Fail the build if more than 5 files are in the Critical category
+rails-health --max-critical 5
+
+# Combine both — fail if either condition is violated
+rails-health --fail-under 7.0 --max-critical 5
+```
+
+Exit codes:
+- `0` — analysis succeeded and any configured gates passed
+- `1` — analysis itself failed (e.g. not a Rails project, parse error)
+- `2` — analysis succeeded but a `--fail-under` or `--max-critical` gate failed
+
+#### GitHub Actions example
+
+```yaml
+name: Code Health
+on: [pull_request]
+jobs:
+  health:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+      - run: gem install rails_code_health
+      - run: rails-health --fail-under 7.0 --max-critical 5
+```
+
 ### Programmatic Usage
 
 ```ruby

data/lib/rails_code_health/cli.rb

@@ -13,7 +13,9 @@ module RailsCodeHealth
         format: :console,
         output: nil,
         config: nil,
-        verbose: false
+        verbose: false,
+        fail_under: nil,
+        max_critical: nil
       }
     end
 
@@ -33,13 +35,17 @@ module RailsCodeHealth
         puts "📊 Using format: #{@options[:format]}" if @options[:verbose]
 
         # Run the analysis
-        report = analyze_project
+        results = analyze_project
 
         # Output the report
-        output_report(report)
+        output_report(results)
 
         puts "\n✅ Analysis complete!" if @options[:verbose]
 
+        # Apply CI gating thresholds (after report is emitted so the user still sees output)
+        exit_code = gate_exit_code(results)
+        exit exit_code unless exit_code.zero?
+
       rescue RailsCodeHealth::Error => e
         puts "❌ Error: #{e.message}"
         exit 1
@@ -75,11 +81,21 @@ module RailsCodeHealth
           @options[:config] = file
         end
 
-        opts.on("-v", "--verbose", 
+        opts.on("-v", "--verbose",
                 "Verbose output") do
           @options[:verbose] = true
         end
 
+        opts.on("--fail-under SCORE", Float,
+                "Exit non-zero if average health score is below SCORE (e.g. 7.0)") do |score|
+          @options[:fail_under] = score
+        end
+
+        opts.on("--max-critical N", Integer,
+                "Exit non-zero if more than N files fall into the Critical category") do |n|
+          @options[:max_critical] = n
+        end
+
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           exit
@@ -149,6 +165,34 @@ module RailsCodeHealth
       end
     end
 
+    def gate_exit_code(results)
+      return 0 if results.nil? || results.empty?
+      return 0 if @options[:fail_under].nil? && @options[:max_critical].nil?
+
+      failures = []
+
+      if (threshold = @options[:fail_under])
+        average = results.sum { |r| r[:health_score] || 0 } / results.size.to_f
+        if average < threshold
+          failures << "average health score #{average.round(2)} is below --fail-under #{threshold}"
+        end
+      end
+
+      if (max = @options[:max_critical])
+        critical_count = results.count { |r| r[:health_category] == :critical }
+        if critical_count > max
+          failures << "#{critical_count} critical file(s) exceeds --max-critical #{max}"
+        end
+      end
+
+      return 0 if failures.empty?
+
+      warn ""
+      warn "❌ Health gate failed:"
+      failures.each { |msg| warn "   - #{msg}" }
+      2
+    end
+
     def capture_console_output(report_generator)
       original_stdout = $stdout
       $stdout = StringIO.new

data/lib/rails_code_health/configuration.rb

@@ -23,13 +23,7 @@ module RailsCodeHealth
     private
 
     def load_default_thresholds
-      config_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'thresholds.json')
-      if File.exist?(config_file)
-        JSON.parse(File.read(config_file))
-      else
-        # Fallback to hardcoded defaults if config file is missing
-        default_hardcoded_thresholds
-      end
+      default_hardcoded_thresholds
     end
 
     def default_excluded_paths

data/lib/rails_code_health/report_generator.rb

@@ -226,14 +226,13 @@ module RailsCodeHealth
         recommendations << "#{index + 1}. #{rec} (#{count} occurrence#{'s' if count > 1})"
       end
       
-      recommendations << ""
-      recommendations << "🎯 Priority Actions:"
-      recommendations << ""
-      
       # Find files with lowest scores and their recommendations
       critical_files = @results.select { |r| r[:health_score] && r[:health_score] < 4.0 }
       if critical_files.any?
-        recommendations << "1. 🚨 Address critical files immediately:"
+        recommendations << ""
+        recommendations << "🎯 Priority Actions:"
+        recommendations << ""
+        recommendations << "🚨 Address critical files immediately:"
         critical_files.first(3).each do |file|
           recommendations << "   - #{file[:relative_path]} (score: #{file[:health_score]})"
           if file[:recommendations] && file[:recommendations].any?
@@ -242,15 +241,8 @@ module RailsCodeHealth
             end
           end
         end
-        recommendations << ""
       end
-      
-      recommendations << "2. 🔧 Focus on these improvement areas:"
-      recommendations << "   - Reduce method and class lengths"
-      recommendations << "   - Lower cyclomatic complexity"
-      recommendations << "   - Follow Rails conventions"
-      recommendations << "   - Extract business logic from controllers and views"
-      
+
       recommendations.join("\n")
     end
 

data/lib/rails_code_health/version.rb

@@ -1,3 +1,3 @@
 module RailsCodeHealth
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_code_health
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - George Kosmopoulos
@@ -148,7 +148,6 @@ files:
 - LICENSE.txt
 - README.md
 - bin/rails-health
-- config/tresholds.json
 - lib/rails_code_health.rb
 - lib/rails_code_health/ast_helpers.rb
 - lib/rails_code_health/cli.rb

data/config/tresholds.json

@@ -1,80 +0,0 @@
-{
-  "ruby_thresholds": {
-    "method_length": {
-      "green": 15,
-      "yellow": 25,
-      "red": 40
-    },
-    "class_length": {
-      "green": 100,
-      "yellow": 200,
-      "red": 400
-    },
-    "cyclomatic_complexity": {
-      "green": 6,
-      "yellow": 10,
-      "red": 15
-    },
-    "abc_complexity": {
-      "green": 15,
-      "yellow": 25,
-      "red": 40
-    },
-    "nesting_depth": {
-      "green": 3,
-      "yellow": 5,
-      "red": 8
-    },
-    "parameter_count": {
-      "green": 3,
-      "yellow": 5,
-      "red": 8
-    }
-  },
-  "rails_specific": {
-    "controller_actions": {
-      "green": 5,
-      "yellow": 10,
-      "red": 20
-    },
-    "controller_length": {
-      "green": 50,
-      "yellow": 100,
-      "red": 200
-    },
-    "model_public_methods": {
-      "green": 7,
-      "yellow": 12,
-      "red": 20
-    },
-    "view_length": {
-      "green": 30,
-      "yellow": 50,
-      "red": 100
-    },
-    "migration_complexity": {
-      "green": 10,
-      "yellow": 20,
-      "red": 40
-    }
-  },
-  "file_type_multipliers": {
-    "controllers": 1.2,
-    "models": 1.0,
-    "views": 0.8,
-    "helpers": 0.9,
-    "lib": 1.1,
-    "specs": 0.7,
-    "migrations": 0.6
-  },
-  "scoring_weights": {
-    "method_length": 0.15,
-    "class_length": 0.12,
-    "cyclomatic_complexity": 0.20,
-    "nesting_depth": 0.18,
-    "parameter_count": 0.10,
-    "duplication": 0.25,
-    "rails_conventions": 0.15,
-    "code_smells": 0.25
-  }
-}