.rubocop.yml

# List of cops can be found here:
# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
# https://github.com/bbatsov/rubocop/blob/master/config/disabled.yml
# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml

require:
  - rubocop-minitest
  - rubocop-performance
  - rubocop-rails

inherit_from:
  - https://raw.githubusercontent.com/ualbertalib/library_applications_development_inclusive_language/main/inclusive_language_rubocop.yml

AllCops:
  DisplayCopNames: true
  DisplayStyleGuide: true
  Exclude:
    - "db/**/*"
    - "tmp/**/*"
    - "vendor/**/*"
    - "Dangerfile"
    - "node_modules/**/*"
  ExtraDetails: true
  NewCops: enable
  TargetRubyVersion: 3.1

# readability is Actually Good
Layout/EmptyLinesAroundClassBody:
  EnforcedStyle: empty_lines_except_namespace

Layout/IndentationConsistency:
  Enabled: true
  EnforcedStyle: normal

Layout/LineLength:
  Enabled: true
  Max: 120 # default is 80
  AllowedPatterns: ['\A\s*#'] # tweak to ignore long comments, which often are examples or URLs that are not easily broken up

# readability is Actually Good
Layout/RescueEnsureAlignment:
  Enabled: false

Layout/BeginEndAlignment:
  Enabled: false

# A calculated magnitude based on number of assignments,
# branches, and conditions.
Metrics/AbcSize:
  Enabled: false

Metrics/ClassLength:
  Max: 1000 # default 100

# A complexity metric that is strongly correlated to the number
# of test cases needed to validate a method.
Metrics/CyclomaticComplexity:
  Enabled: false

# Avoid methods longer than 10 lines of code.
Metrics/MethodLength:
  Enabled: false

Metrics/BlockLength:
  Enabled: false

Metrics/ModuleLength:
  Max: 500 # default 100

# A complexity metric geared towards measuring complexity for a human reader.
Metrics/PerceivedComplexity:
  Enabled: false

Metrics/ParameterLists:
  Exclude:
    - app/models/jupiter_core/search.rb
    - app/models/jupiter_core/solr_services/deferred_faceted_solr_query.rb

Minitest/MultipleAssertions:
  Enabled: false

Naming/FileName:
  Exclude:
    - Dangerfile
    - Rakefile
    - Gemfile

Naming/MemoizedInstanceVariableName:
  Exclude:
    - app/models/jupiter_core//solr_services/deferred_faceted_solr_query.rb

Naming/MethodParameterName:
  Exclude:
    - app/models/jupiter_core//solr_services/deferred_faceted_solr_query.rb
    - app/models/jupiter_core/search.rb

Rails:
  Enabled: true

Rails/SkipsModelValidations:
  Exclude:
    - app/controllers/aip/v1/collections_controller.rb
    - app/controllers/aip/v1/communities_controller.rb
    - app/controllers/aip/v1/entities_controller.rb
    - app/services/rdf_graph_creation_service.rb

# There comes a point where I question Rubocop's maintainer's sanity
Rails/UnknownEnv:
  Enabled: false

Style/ArrayCoercion:
  Enabled: false

Style/BarePercentLiterals:
  Enabled: false

# indentation is an endangered resource
Style/ClassAndModuleChildren:
  EnforcedStyle: compact
  Exclude:
    - config/application.rb

Style/ClassVars:
  Exclude:
    - !ruby/regexp /_test\.rb$/

Style/Documentation:
  Enabled: false

Style/FormatStringToken:
  Enabled: false

# Checks if there is a magic comment to enforce string literals
Style/FrozenStringLiteralComment:
  Enabled: false

Style/NumericPredicate:
  EnforcedStyle: comparison

Style/MixinUsage:
  Exclude:
    - bin/setup
    - bin/update

# Perfer to use // but %r can be better in certain scenarios
Style/RegexpLiteral:
  Enabled: false

Style/SingleLineMethods:
  Enabled: false

Style/SymbolArray:
  Enabled: true
  EnforcedStyle: brackets

Style/TrailingUnderscoreVariable:
  Enabled: false

# Use %w or %W for arrays of words.
Style/WordArray:
  Enabled: false

Performance/TimesMap:
  Enabled: false

Style/ClassEqualityComparison:
  Enabled: true

Style/RedundantBegin:
  Enabled: true
  Exclude:
    - bin/yarn

Naming/VariableNumber:
  Enabled: false

Style/OpenStructUse:
  Exclude:
    - config/initializers/controlled_vocabularies.rb

# Migrations are YYYYMMDDHHMMSS rather than a numeric
Style/NumericLiterals:
  Exclude:
    - config/initializers/strong_migrations.rb