Updating project files

Author: hlascelles

.github/dependabot.yml

@@ -3,5 +3,5 @@ updates:
 - package-ecosystem: bundler
   directory: "/"
   schedule:
-    interval: daily
+    interval: monthly
   open-pull-requests-limit: 10

.github/workflows/specs.yml

@@ -1,9 +1,11 @@
 name: Specs
+permissions:
+  contents: read
 on:
 - pull_request
 jobs:
   specs:
-    name: appraisal
+    name: specs
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -15,7 +17,5 @@ jobs:
     - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle check || bundle install
-    - run: ./bundle_install_each_appraisal.sh
-    - name: appraisal
-      run: bundle exec appraisal rspec
+    - run: ./specs.sh
+    - run: ./quality.sh

.gitignore

@@ -1,4 +1,3 @@
-.idea
 *.gem
 *.rbc
 /.config
@@ -41,6 +40,7 @@ build-iPhoneSimulator/
 
 ## Environment normalization:
 /.bundle/
+/coverage/
 /vendor/bundle
 /lib/bundler/man/
 
@@ -55,5 +55,19 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+/.idea/.gitignore
+/.idea/ferrum-har.iml
+/.idea/misc.xml
+/.idea/modules.xml
+/.idea/vcs.xml
+/target/
+.idea
+.ruby-version
 /spec/internal/log/
 /.rspec_status
+/pkg
+_site
+.sass-cache
+.jekyll-metadata
+/log
+.rspec_status

.reek.yml

@@ -1,16 +1,15 @@
 ---
 detectors:
   Attribute:
-    enabled: false
-    exclude: []
+    enabled: true
   BooleanParameter:
     enabled: false
     exclude: []
   ClassVariable:
-    enabled: false # Rubocop already handles this
+    enabled: true
     exclude: []
   ControlParameter:
-    enabled: false
+    enabled: true
     exclude: []
   DataClump:
     enabled: true
@@ -22,18 +21,17 @@ detectors:
     max_calls: 3
     allow_calls: []
     exclude:
-    - spec # Specs contain a lot of duplication (better way?)
-    - expect # Specs contain a lot of duplication (better way?)
-    - logger # Calling logger often is a good thing
+    - spec # Specs contain a lot of duplication
+    - expect # Specs contain a lot of duplication
   FeatureEnvy:
     enabled: false
   IrresponsibleModule:
-    enabled: false # We don't need Ruby comments for all modules
+    enabled: false
     exclude: []
   LongParameterList:
     enabled: true
     exclude: []
-    max_params: 4 # 4 is used across our codebase
+    max_params: 4
     overrides:
       initialize:
         max_params: 5
@@ -54,7 +52,7 @@ detectors:
     ignore_iterators:
     - tap
   NilCheck:
-    enabled: false # Didn't appear helpful
+    enabled: false
     exclude: []
   RepeatedConditional:
     enabled: true
@@ -112,35 +110,8 @@ detectors:
     enabled: true
     public_methods_only: true
     exclude:
-    - Concern # Concerns will frequently appear to have utility functions
-    - Helper # Lots of helper methods do things like hash manipulation
-    - "#change"
-    - "#up"
-    - "#down"
-    - "#run"
-    - "#work_message"
+    - job_args_from_db_row
 
-directories:
-  "**/spec/**":
-    UtilityFunction:
-      enabled: false
-    DuplicateMethodCall:
-      enabled: false
-  "**/jobs/**":
-    UtilityFunction:
-      enabled: false
-  "**/workers/**":
-    UtilityFunction:
-      enabled: false
-  "**/app/controllers/**":
-    InstanceVariableAssumption:
-      enabled: false
-  "**/app/listeners/**":
-    UtilityFunction:
-      enabled: false
-    DataClump:
-      enabled: false
-  "**/db/migrate/**":
-    # Migrations contain generated class names so this reek makes no sense there
-    UncommunicativeModuleName:
-      enabled: false
+exclude_paths:
+- vendor
+- gemfiles

.rubocop-global.yml

@@ -0,0 +1,99 @@
+require:
+- rubocop-magic_numbers
+
+plugins:
+- rubocop-performance
+- rubocop-rails
+- rubocop-rake
+- rubocop-rspec
+- rubocop-thread_safety
+
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+  - 'gemfiles/**/*' # These are automatically generated by appraisal:
+  - 'vendor/**/*'
+  - 'target/**/*'
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+Layout/DotPosition:
+  EnforcedStyle: leading
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+  - '**/spec/**/*.rb'
+Metrics/BlockLength:
+  Exclude:
+  - 'Rakefile'
+  - '**/*.rake'
+  - '**/*.gemspec'
+  - '**/spec/**/*.rb'
+Layout/LineLength:
+  Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Metrics/MethodLength:
+  Max: 30
+Rails/Delegate:
+  Enabled: false # Gems aren't Rails
+Rails/Output:
+  Enabled: false # Gems aren't Rails
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 50
+RSpec/HookArgument:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Max: 5
+RSpec/NoExpectationExample:
+  Enabled: false
+RSpec/StubbedMock:
+  Enabled: false
+Style/AccessModifierDeclarations:
+  Enabled: true
+  EnforcedStyle: inline
+Style/BlockDelimiters:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/NumericLiterals:
+  Enabled: false
+Style/RedundantConstantBase:
+  Enabled: true
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

.rubocop-project.yml

@@ -0,0 +1,2 @@
+Style/RedundantConstantBase:
+  Enabled: false # We refer to ::ENV in many places to distinguish it

.rubocop.yml

@@ -1,90 +1,6 @@
-require:
-- rubocop-rspec
-- rubocop-performance
+inherit_from:
+- .rubocop-global.yml
+- .rubocop-project.yml
 
 AllCops:
   TargetRubyVersion: 3.2
-  DisplayCopNames: true
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-  - 'vendor/**/*'
-  - 'gemfiles/**/*' # These are automatically generated by appraisal
-Gemspec/RequiredRubyVersion:
-  Enabled: true
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-Layout/BlockAlignment:
-  EnforcedStyleAlignWith: start_of_block
-Layout/DotPosition:
-  EnforcedStyle: leading
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Metrics/AbcSize:
-  Max: 20
-  Exclude:
-  - '**/spec/**/*.rb'
-Metrics/BlockLength:
-  Exclude:
-  - 'Rakefile'
-  - '**/*.rake'
-  - '**/*.gemspec'
-  - '**/spec/**/*.rb'
-Layout/LineLength:
-  Max: 100
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Metrics/MethodLength:
-  Max: 30
-RSpec/AnyInstance:
-  Enabled: false
-RSpec/ExampleLength:
-  Max: 50
-RSpec/HookArgument:
-  Enabled: false
-RSpec/MessageSpies:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Max: 5
-RSpec/NoExpectationExample:
-  Enabled: false
-RSpec/StubbedMock:
-  Enabled: false
-Style/AccessModifierDeclarations:
-  Enabled: true
-  EnforcedStyle: inline
-Style/BlockDelimiters:
-  Enabled: false
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true
-Style/NumericLiterals:
-  Enabled: false
-Style/RedundantConstantBase:
-  Enabled: false # We refer to ::ENV in many places to distinguish it
-Style/TrailingCommaInArguments:
-  Enabled: false
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-

Appraisals

@@ -1,4 +1,4 @@
-if ::Gem::Version.new(RUBY_VERSION) <= ::Gem::Version.new('3.3')
+if ::Gem::Version.new(RUBY_VERSION) <= ::Gem::Version.new("3.3")
   appraise "rails-6" do
     gem "psych", "~> 4.0"
     gem "sqlite3", "~> 1.0"

Gemfile

@@ -7,3 +7,18 @@ gemspec
 gem "net-imap", require: false
 gem "net-pop", require: false
 gem "net-smtp", require: false
+
+group :development, :test do
+  gem "fasterer"
+  gem "pry-byebug"
+  gem "rake"
+  gem "reek"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-magic_numbers"
+  gem "rubocop-performance"
+  gem "rubocop-rails"
+  gem "rubocop-rake", "> 0.7.0" # as plugin
+  gem "rubocop-rspec", "> 3.5.0" # as plugin
+  gem "rubocop-thread_safety"
+end