ezcater_rubocop 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be105a0d50d96f787a2dcface6a8850d0754c975a224489755a78107bd387a01
-  data.tar.gz: 263a7bde454086d6171fefede0684aa035b2564fe5ab7e56dd901cbc7379e925
+  metadata.gz: 7bac13ea668d2b0aece9d826156baceaf021911bad36ad355086e7f6a53efe6b
+  data.tar.gz: 71339942639c5d6e12282656e7e8e4bc8469eda4b8fd081f2bd38ac5e169fc4f
 SHA512:
-  metadata.gz: ae30e082ef82f070eeb11994a10f852e846590799ade95b3e85d87668386c41fe107dd81aa2bb688453dc8369b72ce044be59c231667ce8cf1a6bfe83fd4df27
-  data.tar.gz: 58fa9015aecefd84a3986203a98ff9c10edb1ec72658c2392ac88ba5a771997a4aa08477eb56a062063c24afddfd826285914e104b03bdda7455e9c55621004b
+  metadata.gz: 297e28c0e816b378fcd08ad2ee9e44286d25a00230cf81022ba06e67597472c5b6392ac3b77a16d647808402827c7cd3288080ed5d790868b2eaa268aa911ed7
+  data.tar.gz: c4f7a84f1699a263ac4d1bf51b7bbe520a5e83a0db43db12d1d79cb7079b743cf6cb3f245b309782f385bb7eddb67938f5913f372a5ceae4cd5be6e570190b8f

data/.github/CODEOWNERS

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

data/CHANGELOG.md

@@ -6,6 +6,10 @@ 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.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.

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/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.2.0"
+  VERSION = "2.3.0"
 end

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

@@ -0,0 +1,51 @@
+# 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"])
+      #
+      #   # bad
+      #   EzFF.active?("FlagName")
+
+      class FeatureFlagActive < Cop
+        MSG = "`EzFF.active?` must be called with at least one of `tracking_id` or `identifiers`"
+
+        def_node_matcher :ezff_active_one_arg, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active? (str _))
+        PATTERN
+
+        def_node_matcher :args_matcher, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active?
+              (str _)
+              (_
+                (pair
+                  (sym {:tracking_id :identifiers})
+                  _)
+                ...))
+        PATTERN
+
+        def_node_matcher :method_call_matcher, <<-PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) :active? ...)
+        PATTERN
+
+        def on_send(node)
+          return unless method_call_matcher(node)
+
+          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.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-05-24 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
@@ -191,7 +192,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: ezCater custom cops and shared configuration
 test_files: []