makandra-rubocop 3.2.1 → 4.0.0

data/config/ext/rails.yml

@@ -0,0 +1,485 @@
+require:
+  - rubocop-rails
+
+AllCops:
+  Exclude:
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+    - 'bin/**/*'
+    - 'tmp/**/*'
+    - 'public/system/**/*'
+    - 'db/schema.rb'
+  # What version of Rails is the inspected code using?  If a value is specified
+  # for TargetRailsVersion then it is used.  Acceptable values are specificed
+  # as a float (i.e. 5.1); the patch version of Rails should not be included.
+  # If TargetRailsVersion is not set, RuboCop will parse the Gemfile.lock or
+  # gems.locked file to find the version of Rails that has been bound to the
+  # application.  If neither of those files exist, RuboCop will use Rails 5.0
+  # as the default.
+  TargetRailsVersion: ~
+
+Rails/ActionFilter:
+  Description: 'Enforces consistent use of action filter methods.'
+  Enabled: true
+  VersionAdded: '0.19'
+  EnforcedStyle: action
+  SupportedStyles:
+    - action
+    - filter
+  Include:
+    - app/controllers/**/*.rb
+
+Rails/ActiveRecordAliases:
+  Description: >-
+    Avoid Active Record aliases:
+    Use `update` instead of `update_attributes`.
+    Use `update!` instead of `update_attributes!`.
+  Enabled: true
+  VersionAdded: '0.53'
+  SafeAutoCorrect: false
+
+Rails/ActiveRecordOverride:
+  Description: >-
+    Check for overriding Active Record methods instead of using
+    callbacks.
+  Enabled: true
+  VersionAdded: '0.67'
+  Include:
+    - app/models/**/*.rb
+
+Rails/ActiveSupportAliases:
+  Description: >-
+    Avoid ActiveSupport aliases of standard ruby methods:
+    `String#starts_with?`, `String#ends_with?`,
+    `Array#append`, `Array#prepend`.
+  Enabled: false
+  VersionAdded: '0.48'
+
+Rails/ApplicationJob:
+  Description: 'Check that jobs subclass ApplicationJob.'
+  Enabled: true
+  VersionAdded: '0.49'
+
+Rails/ApplicationRecord:
+  Description: 'Check that models subclass ApplicationRecord.'
+  Enabled: false # Because not all models are necessarily domain models (e.g. migration models for legacy databases)
+  VersionAdded: '0.49'
+
+Rails/AssertNot:
+  Description: 'Use `assert_not` instead of `assert !`.'
+  Enabled: true
+  VersionAdded: '0.56'
+  Include:
+    - '**/test/**/*'
+
+Rails/BelongsTo:
+  Description: >-
+    Use `optional: true` instead of `required: false` for
+    `belongs_to` relations'
+  Enabled: true
+  VersionAdded: '0.62'
+
+Rails/Blank:
+  Description: 'Enforces use of `blank?`.'
+  Enabled: true
+  VersionAdded: '0.48'
+  VersionChanged: '0.67'
+  # Convert usages of `nil? || empty?` to `blank?`
+  NilOrEmpty: true
+  # Convert usages of `!present?` to `blank?`
+  NotPresent: true
+  # Convert usages of `unless present?` to `if blank?`
+  UnlessPresent: true
+
+Rails/BulkChangeTable:
+  Description: 'Check whether alter queries are combinable.'
+  Enabled: false # We'll maybe enable this later.
+  VersionAdded: '0.57'
+  Database: null
+  SupportedDatabases:
+    - mysql
+    - postgresql
+  Include:
+    - db/migrate/*.rb
+
+Rails/CreateTableWithTimestamps:
+  Description: >-
+    Checks the migration for which timestamps are not included
+    when creating a new table.
+  Enabled: true
+  VersionAdded: '0.52'
+  Include:
+    - db/migrate/*.rb
+
+Rails/Date:
+  Description: >-
+    Checks the correct usage of date aware methods,
+    such as Date.today, Date.current etc.
+  Enabled: false # It's not that simple. Really.
+  VersionAdded: '0.30'
+  VersionChanged: '0.33'
+  # The value `strict` disallows usage of `Date.today`, `Date.current`,
+  # `Date#to_time` etc.
+  # The value `flexible` allows usage of `Date.current`, `Date.yesterday`, etc
+  # (but not `Date.today`) which are overridden by ActiveSupport to handle current
+  # time zone.
+  EnforcedStyle: flexible
+  SupportedStyles:
+    - strict
+    - flexible
+
+Rails/Delegate:
+  Description: 'Prefer delegate method for delegations.'
+  Enabled: false
+  VersionAdded: '0.21'
+  VersionChanged: '0.50'
+  # When set to true, using the target object as a prefix of the
+  # method name without using the `delegate` method will be a
+  # violation. When set to false, this case is legal.
+  EnforceForPrefixed: true
+
+Rails/DelegateAllowBlank:
+  Description: 'Do not use allow_blank as an option to delegate.'
+  Enabled: true
+  VersionAdded: '0.44'
+
+Rails/DynamicFindBy:
+  Description: 'Use `find_by` instead of dynamic `find_by_*`.'
+  StyleGuide: 'https://rails.rubystyle.guide#find_by'
+  Enabled: false # We occasionally define custom find_by_* methods (e.g. `find_by_anything`) which don't work like ActiveRecord's methods.
+  VersionAdded: '0.44'
+  Whitelist:
+    - find_by_sql
+
+Rails/EnumHash:
+  Description: 'Prefer hash syntax over array syntax when defining enums.'
+  StyleGuide: 'https://rails.rubystyle.guide#enums'
+  Enabled: true
+  VersionAdded: '2.3'
+  Include:
+    - app/models/**/*.rb
+
+Rails/EnumUniqueness:
+  Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
+  Enabled: true
+  VersionAdded: '0.46'
+  Include:
+    - app/models/**/*.rb
+
+Rails/EnvironmentComparison:
+  Description: "Favor `Rails.env.production?` over `Rails.env == 'production'`"
+  Enabled: true
+  VersionAdded: '0.52'
+
+Rails/Exit:
+  Description: >-
+    Favor `fail`, `break`, `return`, etc. over `exit` in
+    application or library code outside of Rake files to avoid
+    exits during unit testing or running in production.
+  Enabled: true
+  VersionAdded: '0.41'
+  Include:
+    - app/**/*.rb
+    - config/**/*.rb
+    - lib/**/*.rb
+  Exclude:
+    - lib/**/*.rake
+
+Rails/FilePath:
+  Description: 'Use `Rails.root.join` for file path joining.'
+  Enabled: false
+  VersionAdded: '0.47'
+  VersionChanged: '0.57'
+  EnforcedStyle: arguments
+  SupportedStyles:
+    - slashes
+    - arguments
+
+Rails/FindBy:
+  Description: 'Prefer find_by over where.first.'
+  StyleGuide: 'https://rails.rubystyle.guide#find_by'
+  Enabled: false
+  VersionAdded: '0.30'
+  Include:
+    - app/models/**/*.rb
+
+Rails/FindEach:
+  Description: 'Prefer all.find_each over all.find.'
+  StyleGuide: 'https://rails.rubystyle.guide#find-each'
+  Enabled: true
+  VersionAdded: '0.30'
+  Include:
+    - app/models/**/*.rb
+
+Rails/HasAndBelongsToMany:
+  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
+  StyleGuide: 'https://rails.rubystyle.guide#has-many-through'
+  Enabled: true
+  VersionAdded: '0.12'
+  Include:
+    - app/models/**/*.rb
+
+Rails/HasManyOrHasOneDependent:
+  Description: 'Define the dependent option to the has_many and has_one associations.'
+  StyleGuide: 'https://rails.rubystyle.guide#has_many-has_one-dependent-option'
+  Enabled: true
+  VersionAdded: '0.50'
+  Include:
+    - app/models/**/*.rb
+
+Rails/HelperInstanceVariable:
+  Description: 'Do not use instance variables in helpers'
+  Enabled: true
+  VersionAdded: '2.0'
+  Include:
+    - app/helpers/**/*.rb
+
+Rails/HttpPositionalArguments:
+  Description: 'Use keyword arguments instead of positional arguments in http method calls.'
+  Enabled: true
+  VersionAdded: '0.44'
+  Include:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Rails/HttpStatus:
+  Description: 'Enforces use of symbolic or numeric value to define HTTP status.'
+  Enabled: false
+  VersionAdded: '0.54'
+  EnforcedStyle: symbolic
+  SupportedStyles:
+    - numeric
+    - symbolic
+
+Rails/IgnoredSkipActionFilterOption:
+  Description: 'Checks that `if` and `only` (or `except`) are not used together as options of `skip_*` action filter.'
+  Reference: 'https://api.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-_normalize_callback_options'
+  Enabled: true
+  VersionAdded: '0.63'
+  Include:
+    - app/controllers/**/*.rb
+
+Rails/InverseOf:
+  Description: 'Checks for associations where the inverse cannot be determined automatically.'
+  Enabled: true
+  VersionAdded: '0.52'
+  Include:
+    - app/models/**/*.rb
+
+Rails/LexicallyScopedActionFilter:
+  Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the controller."
+  StyleGuide: 'https://rails.rubystyle.guide#lexically-scoped-action-filter'
+  Enabled: true
+  Safe: false
+  VersionAdded: '0.52'
+  Include:
+    - app/controllers/**/*.rb
+
+Rails/LinkToBlank:
+  Description: 'Checks that `link_to` with a `target: "_blank"` have a `rel: "noopener"` option passed to them.'
+  Reference:
+    - https://mathiasbynens.github.io/rel-noopener/
+    - https://html.spec.whatwg.org/multipage/links.html#link-type-noopener
+    - https://html.spec.whatwg.org/multipage/links.html#link-type-noreferrer
+  Enabled: true
+  VersionAdded: '0.62'
+
+Rails/NotNullColumn:
+  Description: 'Do not add a NOT NULL column without a default value'
+  Enabled: true
+  VersionAdded: '0.43'
+  Include:
+    - db/migrate/*.rb
+
+Rails/Output:
+  Description: 'Checks for calls to puts, print, etc.'
+  Enabled: false
+  VersionAdded: '0.15'
+  VersionChanged: '0.19'
+  Include:
+    - app/**/*.rb
+    - config/**/*.rb
+    - db/**/*.rb
+    - lib/**/*.rb
+
+Rails/OutputSafety:
+  Description: 'The use of `html_safe` or `raw` may be a security risk.'
+  Enabled: true # We may need to review this. Unsure if the cop can always know which `html_safe` call is valid and which one is not.
+  VersionAdded: '0.41'
+
+Rails/PluralizationGrammar:
+  Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
+  Enabled: true
+  VersionAdded: '0.35'
+
+Rails/Presence:
+  Description: 'Checks code that can be written more easily using `Object#presence` defined by Active Support.'
+  Enabled: true
+  VersionAdded: '0.52'
+
+Rails/Present:
+  Description: 'Enforces use of `present?`.'
+  Enabled: true
+  VersionAdded: '0.48'
+  VersionChanged: '0.67'
+  # Convert usages of `!nil? && !empty?` to `present?`
+  NotNilAndNotEmpty: true
+  # Convert usages of `!blank?` to `present?`
+  NotBlank: true
+  # Convert usages of `unless blank?` to `if present?`
+  UnlessBlank: true
+
+Rails/ReadWriteAttribute:
+  Description: >-
+    Checks for read_attribute(:attr) and
+    write_attribute(:attr, val).
+  StyleGuide: 'https://rails.rubystyle.guide#read-attribute'
+  Enabled: true
+  VersionAdded: '0.20'
+  VersionChanged: '0.29'
+  Include:
+    - app/models/**/*.rb
+
+Rails/RedundantAllowNil:
+  Description: >-
+    Finds redundant use of `allow_nil` when `allow_blank` is set to
+    certain values in model validations.
+  Enabled: true
+  VersionAdded: '0.67'
+  Include:
+    - app/models/**/*.rb
+
+Rails/RedundantReceiverInWithOptions:
+  Description: 'Checks for redundant receiver in `with_options`.'
+  Enabled: true
+  VersionAdded: '0.52'
+
+Rails/ReflectionClassName:
+  Description: 'Use a string for `class_name` option value in the definition of a reflection.'
+  Enabled: true
+  VersionAdded: '0.64'
+
+Rails/RefuteMethods:
+  Description: 'Use `assert_not` methods instead of `refute` methods.'
+  Enabled: true
+  VersionAdded: '0.56'
+  Include:
+    - '**/test/**/*'
+
+Rails/RelativeDateConstant:
+  Description: 'Do not assign relative date to constants.'
+  Enabled: true
+  VersionAdded: '0.48'
+  VersionChanged: '0.59'
+  AutoCorrect: false
+
+Rails/RequestReferer:
+  Description: 'Use consistent syntax for request.referer.'
+  Enabled: true
+  VersionAdded: '0.41'
+  EnforcedStyle: referrer # A typo in a  "remote API" (HTTP RFC) should not force us using badly named methods
+  SupportedStyles:
+    - referer
+    - referrer
+
+Rails/ReversibleMigration:
+  Description: 'Checks whether the change method of the migration file is reversible.'
+  StyleGuide: 'https://rails.rubystyle.guide#reversible-migration'
+  Reference: 'https://api.rubyonrails.org/classes/ActiveRecord/Migration/CommandRecorder.html'
+  Enabled: true
+  VersionAdded: '0.47'
+  Include:
+    - db/migrate/*.rb
+
+Rails/SafeNavigation:
+  Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`"
+  Enabled: false
+  VersionAdded: '0.43'
+  # This will convert usages of `try` to use safe navigation as well as `try!`.
+  # `try` and `try!` work slightly differently. `try!` and safe navigation will
+  # both raise a `NoMethodError` if the receiver of the method call does not
+  # implement the intended method. `try` will not raise an exception for this.
+  ConvertTry: false
+
+Rails/SaveBang:
+  Description: 'Identifies possible cases where Active Record save! or related should be used.'
+  StyleGuide: 'https://rails.rubystyle.guide#save-bang'
+  Enabled: false
+  VersionAdded: '0.42'
+  VersionChanged: '0.59'
+  AllowImplicitReturn: true
+  AllowedReceivers: []
+  SafeAutoCorrect: false
+
+Rails/ScopeArgs:
+  Description: 'Checks the arguments of ActiveRecord scopes.'
+  Enabled: true
+  VersionAdded: '0.19'
+  Include:
+    - app/models/**/*.rb
+
+Rails/SkipsModelValidations:
+  Description: >-
+    Use methods that skips model validations with caution.
+    See reference for more information.
+  Reference: 'https://guides.rubyonrails.org/active_record_validations.html#skipping-validations'
+  Enabled: false
+  VersionAdded: '0.47'
+  VersionChanged: '0.60'
+  Blacklist:
+    - decrement!
+    - decrement_counter
+    - increment!
+    - increment_counter
+    - toggle!
+    - touch
+    - update_all
+    - update_attribute
+    - update_column
+    - update_columns
+    - update_counters
+  Whitelist: []
+
+Rails/TimeZone:
+  Description: 'Checks the correct usage of time zone aware methods.'
+  StyleGuide: 'https://rails.rubystyle.guide#time'
+  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.30'
+  VersionChanged: '0.68'
+  # The value `strict` means that `Time` should be used with `zone`.
+  # The value `flexible` allows usage of `in_time_zone` instead of `zone`.
+  EnforcedStyle: flexible
+  SupportedStyles:
+    - strict
+    - flexible
+
+Rails/UniqBeforePluck:
+  Description: 'Prefer the use of uniq or distinct before pluck.'
+  Enabled: true
+  VersionAdded: '0.40'
+  VersionChanged: '0.47'
+  EnforcedStyle: conservative
+  SupportedStyles:
+    - conservative
+    - aggressive
+  AutoCorrect: false
+
+Rails/UnknownEnv:
+  Description: 'Use correct environment name.'
+  Enabled: true
+  VersionAdded: '0.51'
+  Environments:
+    - development
+    - test
+    - production
+
+Rails/Validation:
+  Description: 'Use validates :attribute, hash of validations.'
+  Enabled: true
+  VersionAdded: '0.9'
+  VersionChanged: '0.41'
+  Include:
+    - app/models/**/*.rb