Merge pull request #233 from DigitalNZ/rm/codeclimate-diff

Add code quality score

.codeclimate.yml

@@ -0,0 +1,30 @@
+---
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-1-36-0
+  reek:
+    enabled: true
+
+exclude_patterns:
+  - config/
+  - db/
+  - dist/
+  - features/
+  - public/
+  - "**/node_modules/"
+  - script/
+  - "**/spec/"
+  - "**/test/"
+  - "**/tests/"
+  - Tests/
+  - "**/vendor/"
+  - "**/*_test.go"
+  - "**/*.d.ts"
+  - "**/*.min.js"
+  - "**/*.min.css"
+  - "**/__tests__/"
+  - "**/__mocks__/"
+  - "/.gitlab/"
+  - coverage/ . # simple cov

.codeclimate_diff.yml

@@ -0,0 +1,2 @@
+main_branch_name: main # defaults to main
+threshold_to_run_on_all_files: 8  # when you reach a certain number of files changed, it becomes faster to analyze all files rather than analyze them one by one.

.github/workflows/code_quality_score.yml

@@ -0,0 +1,9 @@
+name: Code quality score
+
+on:
+  - pull_request
+
+jobs:
+  code_quality_score:
+    name: Code quality
+    uses: DigitalNZ/code_quality_score/.github/workflows/calculate-code-quality-score.yml@main

.reek.yml

@@ -0,0 +1,46 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false
+
+  NilCheck:
+    enabled: false
+
+  ManualDispatch:
+    enabled: false
+
+  LongParameterList:
+    max_params: 4  # defaults to 3.  You want this number realistic but stretchy so we can move it down
+
+  TooManyStatements:
+    max_statements: 10  # defaults to 5.  You want this number realistic but stretchy so we can move it down
+
+  UtilityFunction:
+    public_methods_only: true
+
+  UncommunicativeVariableName:
+    accept:
+      - e
+
+directories:
+  "app/controllers":
+    IrresponsibleModule:
+      enabled: false
+    NestedIterators:
+      max_allowed_nesting: 2
+    UnusedPrivateMethod:
+      enabled: false
+    InstanceVariableAssumption:
+      enabled: false
+  "app/helpers":
+    IrresponsibleModule:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+    FeatureEnvy:
+      enabled: false
+  "app/mailers":
+    InstanceVariableAssumption:
+      enabled: false
+  "app/models":
+    InstanceVariableAssumption:
+      enabled: false

Gemfile

@@ -19,7 +19,7 @@ gem 'puma'
 gem 'puma-metrics'
 gem 'rails', '~> 7.0.4'
 gem 'responders'
-gem 'sidekiq', '~> 6.4.0'
+gem 'sidekiq', '6.5.10'
 gem 'sinatra', require: nil
 gem 'supplejack_common', github: 'DigitalNZ/supplejack_common', tag: 'v2.11.1'
 gem 'whenever', require: false
@@ -50,4 +50,5 @@ group :test, :development do
   gem 'rubocop', require: false
   gem 'rubocop-rails_config', require: false
   gem 'rubocop-rspec', require: false
+  gem 'codeclimate_diff', github: 'boost/codeclimate_diff'
 end