ezcater_rubocop 2.0.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1436184ef303d8ee4af5050b33caa9872e1b233e1c7ce4411f7ceeb9355600ad
-  data.tar.gz: 21f8449c813f89d22e94e108dd4d0376ade3aaca8aab49bac4a2f22c2dfba853
+  metadata.gz: 2096c91ae045203c587668c5973b89b1b873645d0f0d1d95641eb556dd536dff
+  data.tar.gz: a989856aa682768b8a3e9c47270dc441cd6743420cf8884451b53579a61c6c1f
 SHA512:
-  metadata.gz: 4303c34cab47b80bc2982b134b41664af92c8e28a00aec643072791533db3d15727edbb72bea60c2fc1336d9aca8a87b272bf920b9f3b3fac386da9210f32fb4
-  data.tar.gz: bc3c02d74a88f087605de81e130cbb74672c6884a36d49601104f3b1297d8caa42469d7d3a54c75b51bd87d3479611951fe666fad5ff3d1595e0cfe4a3005ba6
+  metadata.gz: 772cc5d23fa87784f870effdc91bccf4bdb12665c017b7f3a845f38c572c46a3232ad2acddd89e48be6f6566144e63b6693c4a78638e18e1231eb0086c8bfea9
+  data.tar.gz: 7396c095538e84ca0984ecec837d18164a0bc3fdd3b2a11b5dcf8ae586f926100518ab78bb757a10f998c0b3c819d0e62a59025561653877e6f8829aa4a013ce

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @agrobbin @aprescott @tjwp
+* @ezcater/ruby-style-group

data/CHANGELOG.md

@@ -6,6 +6,21 @@ This gem is moving onto its own [Semantic Versioning](https://semver.org/) schem
 
 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`.
 
+## 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

data/conf/rubocop_gem.yml

@@ -2,6 +2,7 @@ inherit_from:
   - ../conf/rubocop.yml
 
 AllCops:
+  TargetRubyVersion: 2.6
   Exclude:
     - 'vendor/bundle/**/*'
     - 'gemfiles/vendor/**/*' 

data/conf/rubocop_rails.yml

@@ -47,6 +47,11 @@ Rails/UnknownEnv:
     - staging
     - production
 
+Rails/SaveBang:
+  Enabled: true
+  AllowImplicitReturn: false
+  AutoCorrect: False
+
 Ezcater/RailsTopLevelSqlExecute:
   Description: 'Use `execute` instead of `ActiveRecord::Base.connection.execute` in migrations.'
   Enabled: true

data/config/default.yml

@@ -19,6 +19,10 @@ Ezcater/DirectEnvCheck:
   Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `ENV`.'
   Enabled: false
 
+Ezcater/FeatureFlagActive:
+  Description: 'Enforce the proper arguments are given to EzcaterFeatureFlag.active?'
+  Enabled: true
+
 Ezcater/RspecDotNotSelfDot:
   Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
   Enabled: true

data/ezcater_rubocop.gemspec

@@ -42,6 +42,8 @@ Gem::Specification.new do |spec|
   spec.executables << "circle_rubocop.rb"
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 12.3"

data/lib/ezcater_rubocop.rb

@@ -16,6 +16,7 @@ config = RuboCop::ConfigLoader.merge_with_default(config, path)
 RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
 require "rubocop/cop/ezcater/direct_env_check"
+require "rubocop/cop/ezcater/feature_flag_active"
 require "rubocop/cop/ezcater/graphql_fields_naming"
 require "rubocop/cop/ezcater/rails_configuration"
 require "rubocop/cop/ezcater/rails_env"

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "2.0.0"
+  VERSION = "2.4.0"
 end

data/lib/rubocop/cop/ezcater/feature_flag_active.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use `EzcaterFeatureFlag.active?` with a tracking_id or array of identifiers
+      #
+      # @example
+      #
+      #   # good
+      #   EzFF.active?("FlagName", tracking_id: "user:12345")
+      #   EzFF.active?("FlagName", identifiers: ["user:12345", "user:23456"])
+      #   EzFF.active?(defined_flag_name_var, tracking_id: "brand:12345")
+      #   EzFF.active?(@flag_name_ivar, tracking_id: "brand:12345")
+      #
+      #   # bad
+      #   EzFF.active?("FlagName")
+      #   EzFF.active?(defined_flag_name_var)
+      #   EzFF.active?(@flag_name_ivar)
+
+      class FeatureFlagActive < Cop
+        MSG = "`EzFF.active?` must be called with at least one of `tracking_id` or `identifiers`"
+        FIRST_PARAM_MSG = "The first argument to `EzFF.active?` must be a string or predefined variable"
+
+        def_node_matcher :ezff_active_one_arg, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active? ${str lvar ivar})
+        PATTERN
+
+        def_node_matcher :args_matcher, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active?
+              ${str lvar ivar}
+              (_
+                (pair
+                  (sym {:tracking_id :identifiers})
+                  _)
+                ...))
+        PATTERN
+
+        def_node_matcher :first_param_good, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active? ${str lvar ivar} ...)
+        PATTERN
+
+        def_node_matcher :method_call_matcher, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active? ...)
+        PATTERN
+
+        def on_send(node)
+          return unless method_call_matcher(node)
+
+          if !first_param_good(node)
+            add_offense(node, location: :expression, message: FIRST_PARAM_MSG)
+          end
+
+          if ezff_active_one_arg(node) || !args_matcher(node)
+            add_offense(node, location: :expression, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,7 @@ files:
 - lib/ezcater_rubocop.rb
 - lib/ezcater_rubocop/version.rb
 - lib/rubocop/cop/ezcater/direct_env_check.rb
+- lib/rubocop/cop/ezcater/feature_flag_active.rb
 - lib/rubocop/cop/ezcater/graphql_fields_naming.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
 - lib/rubocop/cop/ezcater/rails_env.rb
@@ -199,14 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ezCater custom cops and shared configuration