# ezcater_rubocop

# Versioning

This gem is moving onto its own [Semantic Versioning](https://semver.org/) scheme starting with v1.0.0. All version bumps moving forward should increment using `MAJOR.MINOR.PATCH` based on changes.

Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the ezcater_rubocop gem was `v0.49.0`.

## 6.0.2
- Upgrade rubocop-rspec to v2.22.0 to use the new FactoryBot namespaces.
- Fix the following wrong namespaces related to `FactoryBot`: `RSpec/FactoryBot/AttributeDefinedStatically`, `RSpec/FactoryBot/CreateList` and `RSpec/FactoryBot/FactoryClassName`.

## 6.0.1
- Fix a bug in the `FeatureFlagNameValid` cop where the titlecase regex matcher was incorrectly finding offenses.

## 6.0.0
- Add `FeatureFlagNameValid` cop to validate correct feature flag name format, [adopted from the cop](https://github.com/ezcater/ez-rails/blob/2d9272eb3d2c71dc5ebc2aa01a849cf9cfae3df2/cops/rubocop/cops/feature_flags_flag_name.rb_) in `ez-rails`.

## 5.2.1
- Fix the wrong namespace for `RSpec/Capybara/CurrentPathExpectation` and `RSpec/Capybara/VisibilityMatcher` cops, since [they've been extracted](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md#2180-2023-01-16) into a separate repo [rubocop-capybara](https://github.com/rubocop/rubocop-capybara).

## 5.2.0

- Add an explicit rule for `Style/HashSyntax`, setting `EnforcedShorthandSyntax: either`.

Ruby 3.1 introduces syntax where named arguments can be passed

```ruby
name = "Michael"
method_with_named_args(name:)
```

rather than

```ruby
name = "Michael"
method_with_named_args(name: name)
```

when the variable's name matches the named argument key.

For now, we have decided to allow either syntax while we upgrade our applications to Ruby 3.1. This is auto-correctable if and when we decide to enforce the new syntax.

## 5.1.0
- Change paths to exclude for various cops to be agnostic of directory structure prior to the matching string. This is to allow apps to have greater flexibility in where files live, but still have them excluded from certain cops. The need for this arose when implementing Stimpack, which moves specs and other files under app/packs/[pack_name].

## 5.0.0
- Enable all added cops since 0.8. There are a lot of new cops now, be sure to use `--regenerate-todo` if you're on a large project that can't be updated easily.

## 4.0.0

- Add the [rubcop-graphql](https://github.com/DmitryTsepelev/rubocop-graphql) helpers and enable
    them by default
- Remove `Ezcater/GraphqlFieldsNaming` cop. The same rule exists in `rubocop-graphql`.

## v3.0.2

- Loosen restrictions to allow for Ruby 3.1 and latest dependency gems

## v3.0.1

- Fix the RspecDotNotSelfDot cop to work with rubocop-rspec
- Exclude appraisal generated gemfiles for possible embedded gems in rails apps

## v3.0.0

- Upgrade rubocop: 1.16.0
- Upgrade rubocop-rails: 2.10.1
- Upgrade rubocop-rspec: 2.3.0
- This is a major upgrade because a large number of cops have been introduced, tweaked, or renamed. Here is an aggregate of the breaking changes introduced
  - RuboCop assumes that Cop classes do not define new `on_<type>` methods at runtime (e.g. via `extend` in `initialize`).
  - Enable all pending cops for RuboCop 1.0.
  - Change logic for cop department name computation. Cops inside deep namespaces (5 or more levels deep) now belong to departments with names that are calculated by joining module names starting from the third one with slashes as separators. For example, cop `Rubocop::Cop::Foo::Bar::Baz` now belongs to `Foo/Bar` department (previously it was `Bar`).
  - `RegexpNode#parsed_tree` now processes regexps including interpolation (by blanking the interpolation before parsing, rather than skipping).
  - Cop `Metrics/AbcSize` now counts ||=, &&=, multiple assignments, for, yield, iterating blocks. `&.` now count as conditions too (unless repeated on the same variable). Default bumped from 15 to 17. Consider using `rubocop -a --disable-uncorrectable` to ease transition.
  - Cop `Metrics/PerceivedComplexity` now counts `else` in `case` statements, `&.`, `||=`, `&&=` and blocks known to iterate. Default bumped from 7 to 8. Consider using `rubocop -a --disable-uncorrectable` to ease transition.
  - Extensive refactoring of internal classes `Team`, `Commissioner`, `Corrector`. `Cop::Cop#corrections` not completely compatible. See Upgrade Notes.
  - `rubocop -a / --autocorrect` no longer run unsafe corrections; `rubocop -A / --autocorrect-all` run both safe and unsafe corrections. Options `--safe-autocorrect` is deprecated.
  - Order for gems names now disregards underscores and dashes unless `ConsiderPunctuation` setting is set to `true`.
  - Cop `Metrics/CyclomaticComplexity` now counts `&.`, `||=`, `&&=` and blocks known to iterate. Default bumped from 6 to 7. Consider using `rubocop -a --disable-uncorrectable` to ease transition.
  - Remove support for unindent/active_support/powerpack from `Layout/HeredocIndentation`, so it only recommends using squiggy heredoc.
  - Change the max line length of `Layout/LineLength` to 120 by default.
  - Inspect all files given on command line unless `--only-recognized-file-types` is given.
  - Enabling a cop overrides disabling its department.
  - Renamed `Layout/Tab` cop to `Layout/IndentationStyle`.
  - Drop support for Ruby 2.3.
  - Drop support for ruby 2.4.
  - Retire `RSpec/InvalidPredicateMatcher` cop.
  - Enabled pending cop (`RSpec/StubbedMock`).

## v2.4.0

- Fix `FeatureFlagActive` cop so that it allows feature flag names to be variables in addition to strings.
- Add check to `FeatureFlagActive` that the first parameter is a string or a variable, and use the appropriate messaging.

## v2.3.0

- Add `FeatureFlagActive` cop. This provides confidence that upgrading to `ezcater_feature_flag-client` v2.0.0, which
  contains breaking API changes, can be done safely.

## v2.2.0

- Require Ruby 2.6 or later.
- Set `TargetRubyVersion` to 2.6 in `rubocop_gem` configuration.

## v2.1.0

- Enable `Rails/SaveBang` with `AllowImplicitReturn: false`, and with autocorrection disabled.

## v2.0.0

- Update to `rubocop` v0.81.0, `rubocop-rspec` v1.38.1 and `rubocop-rails` v2.5.2.
- This is being released as a major update because cops have been renamed so this is unlikely to be
  a drop-in replacement.
- This is the first release to support Ruby 2.7.

## v1.4.1

- Correct a matching syntax issue with `Ezcater/RubyTimeout` so that it applies in the expected cases.

## v1.4.0

- Add `Ezcater/RubyTimeout` cop.

## v1.3.0

- Add `Ezcater/GraphqlFieldsNaming` cop.

## v1.2.0

- Add `Ezcater/RailsTopLevelSqlExecute` to replace `ActiveRecord::Base.connection.execute` with `execute` in `db/migrate/`.

## v1.1.1

- Exclude `lib/tasks/` for `Ezcater/RailsEnv` and `Ezcater/DirectEnvCheck`.

## v1.1.0

- Add `Ezcater/RailsEnv` cop.
- Add `Ezcater/DirectEnvCheck` cop.

## v1.0.2

- Exclude bootsnap cache directory (`tmp/cache`).

## v1.0.1

- Disable `Rails/HasAndBelongsToMany` cop.
- Disable `Style/DoubleNegation` cop.

## v1.0.0

- Begin using Semantic Versioning
- Delete `Ezcater/PrivateAttr`

## v0.61.1

- `Layout/IndentHash` enforces consistent style
- `Layout/IndentArray` enforces consistent style

## v0.61.0

- Update to `rubocop` v0.61.1.
- Update to `rubocop-rspec` v1.30.1

## v0.59.0

- Disable `Style/NegatedIf`.

## v0.58.4

- Update `Metrics/BlockLength` to exclude `app/graphql/**/*.rb`
- Move `Metrics/BlockLength` exclusions for `lib/tasks/**/*.rake` and
  `config/environments/*.rb` into rubocop_rails.yml

## v0.58.3

- Updated `Layout/MultilineMethodCallIndentation` to `indented`.

## v0.58.2

- Updated `Ezcater/RspecDotNotSelfDot` to flag offenses for `::class_method`.

## v0.58.1

- Update to `rubocop-rspec` v1.28.0.
- Remove configuration for removed `FactoryBot/DynamicAttributeDefinedStatically` cop.

## v0.58.0

- Update to rubocop v0.58.1.
- Enable `Naming/MemoizedInstanceVariableName` with required leading
  underscore.

## v0.57.4

- Configure `Rspec/MessageExpectation` with the `allow` style.

## v0.57.3

- Do not use broken parser v2.5.1.1.

## v0.57.2

- Fix `Ezcater/RspecRequireHttpStatusMatcher` cop.

## v0.57.1

- Add `Ezcater/RspecRequireHttpStatusMatcher` cop.
- Enable `Rails/HttpStatus` cop and enforce symbols.

## v0.57.0

- Update to rubocop v0.57.2 and rubocop-rspec v1.27.0.
- Disable new cop `Naming/MemoizedInstanceVariableName` until configuration
  options are available.
- Disable `FactoryBot/DynamicAttributeDefinedStatically` due to
  https://github.com/rubocop-hq/rubocop-rspec/issues/655.
- Configure `Naming/UncommunicativeMethodParamName` to allow `e, ex, id`
  param names.
- Exclude appraisal generated gemfiles for gems.

## v0.52.8

- Add new configuration `rubocop_gem` for use with gems.

## v0.52.7

- Enable `Style/FrozenStringLiteralComment` with the `when_needed` style.

## v0.52.6

- Configure `Style/TrailingCommaInLiteral` with `consistent_comma` style.

## v0.52.5

- Add `Ezcater/RspecMatchOrderedArray` cop.
- Fix array equality matcher violations in specs.

## v0.52.4

- Configure `Style/RegexpLiteral` cop with the `AllowInnerSlashes: true` option.

## v0.52.3

- Disable `Style/GuardClause` cop.
- Exclude `spec/integrations` for `RSpec/DescribeClass`.

## v0.52.2

- Disable `Style/IfUnlessModifier` cop.

## v0.52.1

- Allow staging as a rails environment for the Rails/UnknownEnv cop.

## v0.52.0

- Update to rubocop v0.52.1 and rubocop-rspec v1.22.2.

## v0.51.8

- Disable `RSpec/LetSetup` cop.

## v0.51.7

- Rename `Ezcater/RspecRequireGqlErrorHelpers` cop to `Ezcater/RequireGqlErrorHelpers`.

## v0.51.6

- Add `Ezcater/RailsConfiguration` cop.
- Exclude `config/environments/*.rb` for the `Metrics/BlockLength` cop.

## v0.51.5

- Add `Ezcater/RspecRequireGqlErrorHelpers` cop.

## v0.51.4

- Exclude `Gemfile` for the `Metrics/LineLength` cop.
- Add `system` to the excluded spec directories for `RSpec/DescribeClass`.

## v0.51.3

- Configure `RSpec/DescribeClass` to exclude the spec directories which
  are excluded by explicit metadata.
- Exclude `lib/tasks` for the `Metrics/BlockLength` cop.

## v0.51.2

- Configure `Style/RaiseArgs` to use the `compact` style.

## v0.51.1

- Disable `Rails/FilePath` cop.
- Disable `Style/EmptyLiteral` cop.

## v0.51.0

- Update to rubocop v0.51.0 and rubocop-rspec v1.20.0.
- Disable new cop `RSpec/ContextWording`.
- Disable `Style/StderrPuts` for `bin/yarn`.

## v0.50.5

- Configure `RSpec/NestedGroups` with a `Max` value of 5.

## v0.50.4

- Configure `Style/PercentLiteralDelimiters` to prefer parentheses.

## v0.50.3

- Configure `RSpec/MultipleExpectations` with a `Max` value of 5.

## v0.50.2

- Add `Ezcater/PrivateAttr` custom cop.
- Configure `RSpec/ExampleLength` with a `Max` value of 25.
- Add `circle_rubocop.rb` script.

## v0.50.1

- Add shared configuration.
- Do not apply `Ezcater/StyleDig` to access using a range.

## v0.50.0

- Update to rubocop v0.50.0 and rubocop-rspec v1.18.0.
- Do not apply `Ezcater/StyleDig` to assignments with nested access.

# v0.49.3

- Do not apply `Ezcater/StyleDig` to access using a range.

# v0.49.2

- Do not apply `Ezcater/StyleDig` to assignments to with nested access.

## v0.49.1

- Add `Ezcater/RspecRequireBrowserMock` cop.

## v0.49.0

- Initial release.
- Add `Ezcater/RspecRequireFeatureFlagMock` cop.
- Add `Ezcater/RspecDotNotSelfDot` cop.
- Add `Ezcater/StyleDig` cop.