ezcater_rubocop 5.2.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c8d52abd3c39c8b776dbaff56aa94f2f010cf6866579b21a00084f22a42c1f
-  data.tar.gz: dc12424a0dd777560c4657ae87539264ec40f6553b3b6aa6aa963051fbc919d2
+  metadata.gz: 8e412cd3e88f3c5e18b537a9a81beec0396f8882aba05f3f09c87464510bd9a6
+  data.tar.gz: 8786ebe582591fde680b7846e9be9783d84a402f6066cd22c1f5f379dd468b80
 SHA512:
-  metadata.gz: 54bb2d3b45ff6bd48f4ab289bb885e3e1c2635cb4b4bfc44d74086d3b46a39db1bb8c1f3c83f53901931f4a9a015ebe3beb780019f078dd5713a64ba41e11aa7
-  data.tar.gz: cbeb087b43166a7f874603862ad0f909e930ee051c89a3f4862dbe18c0a62e2b6bf58d9657155d8dfd5b569bf1d56b6b83804181394fa8e88d0da19ba9d2f68b
+  metadata.gz: 3394769cce8e62507578b3fc55b943536ba79825ed30de348e538030c96129f2f923652682087467ade43c15a0847dce7faa8bcf5d7e6bd19d98d6b810b3fc3a
+  data.tar.gz: 4f79ad7d080b3c8a64e85cb9521226809c9dc1d558fa334cc0146dce879c1f836e8e10766db1aef2af922f82dafa715680f8af3d0c93537912843a9fc926ff2f

data/CHANGELOG.md

@@ -6,6 +6,9 @@ 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`.
 
+## 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 has 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).
 

data/README.md

@@ -79,20 +79,26 @@ not add cops with `enabled: false` unless you want that cop to always be disable
 
 ## Custom Cops
 
-1. [RailsConfiguration](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rails_configuration.rb) - Enforce use of `Rails.configuration` instead of `Rails.application.config`.
-1. [RequireGqlErrorHelpers](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/require_gql_error_helpers.rb) - Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.
-1. [RspecDotNotSelfDot](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb) - Enforce ".<class method>" instead of "self.<class method>" and "::<class method>" for example group description.
-1. [RspecMatchOrderedArray](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb) - Enforce use of `match_ordered_array` matcher instead of `eq` matcher. This matcher comes from the [ezcater_matchers](https://github.com/ezcater/ezcater_matchers) gem.
-1. [RspecRequireBrowserMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb) - Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.
-1. [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
-1. [RspecRequireHttpStatusMatcher](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb) - Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`
-1. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
+* [FeatureFlagActive](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/feature_flag_active.rb) - Enforce the proper arguments are given to `EzcaterFeatureFlag.active?`
+* [FeatureFlagNameValid](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/feature_flag_name_valid.rb) - Enforce correct flag name format is being used.
+* [RailsConfiguration](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rails_configuration.rb) - Enforce use of `Rails.configuration` instead of `Rails.application.config`.
+* [RequireGqlErrorHelpers](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/require_gql_error_helpers.rb) - Use the helpers provided by `GQLErrors` instead of raising `GraphQL::ExecutionError` directly.
+* [RspecDotNotSelfDot](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb) - Enforce ".<class method>" instead of "self.<class method>" and "::<class method>" for example group description.
+* [RspecMatchOrderedArray](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb) - Enforce use of `match_ordered_array` matcher instead of `eq` matcher. This matcher comes from the [ezcater_matchers](https://github.com/ezcater/ezcater_matchers) gem.
+* [RspecRequireBrowserMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb) - Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.
+* [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
+* [RspecRequireHttpStatusMatcher](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb) - Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`
+* [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing a New Version
+
+To release a new version, update the version number in `version.rb`, merge your PR to `main`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/config/default.yml

@@ -14,6 +14,10 @@ Ezcater/FeatureFlagActive:
   Description: "Enforce the proper arguments are given to EzcaterFeatureFlag.active?"
   Enabled: true
 
+Ezcater/FeatureFlagNameValid:
+  Description: "Enforce correct flag name format is being used."
+  Enabled: true
+
 Ezcater/RspecDotNotSelfDot:
   Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
   Enabled: true

data/lib/ezcater_rubocop/version.rb

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

data/lib/ezcater_rubocop.rb

@@ -18,6 +18,7 @@ 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/feature_flag_name_valid"
 require "rubocop/cop/ezcater/rails_configuration"
 require "rubocop/cop/ezcater/rails_env"
 require "rubocop/cop/ezcater/ruby_timeout"

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Match the naming validations in the feature flag service.
+      #
+      # @example
+      #
+      #   # good
+      #   EzFF.at_100?("Flag1")
+      #   EzFF.active?("Foo::Bar", tracking_id: 1234)
+      #   EzFF.at_100?("Foo::Bar::Baz")
+      #   MY_FLAG="Foo::Bar"; EzFF.at_100?(MY_FLAG)
+      #
+      #   # bad
+      #   EzFF.at_100?("Foo:Bar")
+      #   EzFF.active?("Foo:::Bar", tracking_id: 1234)
+      #   EzFF.at_100?("Foo:Bar:Baz")
+      #   EzFF.at_100?("Foo::Bar  ")
+      #   EzFF.at_100?("Foo::Bar && rm -rf * ")
+      #   EzFF.active?("foo::bar", identifiers: ["user:1"])
+      #   MY_FLAG="Foo:bar"
+      class FeatureFlagNameValid < Cop
+        WHITESPACE = /\s/.freeze
+        ISOLATED_COLON = /(?<!:):(?!:)/.freeze
+        TRIPLE_COLON = /:::/.freeze
+        INVALID_CHARACTERS = /[^a-zA-Z0-9:]/.freeze
+        TITLECASE_SEGMENT = /"^([A-Z][a-z0-9]*)+$"/.freeze
+
+        WHITESPACE_MSG = "Feature flag names must not contain whitespace."
+        DOUBLE_COLON_MSG = "Feature flag names must use double colons (::) as namespace separators."
+        INVALID_CHARACTERS_MSG = "Feature flag names must only contain alphanumeric characters and colons."
+        TITLECASE_SEGMENT_MSG = "Feature flag names must use titlecase for each segment."
+
+        def_node_matcher :feature_flag_constant_assignment, <<~PATTERN
+          (casgn nil? $_ (str $_))
+        PATTERN
+
+        def_node_matcher :feature_flag_method_call, <<~PATTERN
+          (send
+            (_ _ {:EzFF :EzcaterFeatureFlag}) {:active? | :at_100? | :random_sample_active?} (str $_ ...))
+        PATTERN
+
+        def on_casgn(node)
+          feature_flag_constant_assignment(node) do |const_name, flag_name|
+            if const_name.end_with?("_FF", "_FLAG", "_FLAG_NAME", "_FEATURE_FLAG")
+              errors = find_name_violations(flag_name)
+              add_offense(node, location: :expression, message: errors.join(", ")) if errors.any?
+            end
+          end
+        end
+
+        def on_send(node)
+          return unless feature_flag_method_call(node)
+            
+          feature_flag_method_call(node) do |flag_name|
+            errors = find_name_violations(flag_name)
+            add_offense(node, location: :expression, message: errors.join(", ")) if errors.any?
+          end
+        end
+
+        private
+
+        def find_name_violations(name)
+          errors = []
+
+          if name.match?(WHITESPACE)
+            errors << WHITESPACE_MSG
+          end
+
+          if name.match?(ISOLATED_COLON) || name.match?(TRIPLE_COLON)
+            errors << DOUBLE_COLON_MSG
+          end
+
+          if name.match?(INVALID_CHARACTERS)
+            errors << INVALID_CHARACTERS_MSG
+          end
+
+          name.split(/:+/).each do |segment|
+            unless segment.match?(TITLECASE_SEGMENT)
+              errors << TITLECASE_SEGMENT_MSG
+              break
+            end
+          end
+
+          errors
+        end
+      end
+    end
+  end 
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 6.0.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -213,6 +213,7 @@ files:
 - 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/feature_flag_name_valid.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
 - lib/rubocop/cop/ezcater/rails_env.rb
 - lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb