Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'rubocop/cop/rspec/invalid_feature_category.rb')
-rw-r--r--rubocop/cop/rspec/invalid_feature_category.rb104
1 files changed, 0 insertions, 104 deletions
diff --git a/rubocop/cop/rspec/invalid_feature_category.rb b/rubocop/cop/rspec/invalid_feature_category.rb
deleted file mode 100644
index 9ef880d6aac..00000000000
--- a/rubocop/cop/rspec/invalid_feature_category.rb
+++ /dev/null
@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop/cop/rspec/base'
-require 'rubocop/cop/rspec/mixin/top_level_group'
-require 'did_you_mean'
-
-module RuboCop
- module Cop
- module RSpec
- # Ensures that feature categories in specs are valid.
- #
- # @example
- #
- # # bad
- # RSpec.describe 'foo', feature_category: :invalid do
- # end
- #
- # RSpec.describe 'foo', feature_category: :not_owned do
- # end
- #
- # # good
- #
- # RSpec.describe 'foo', feature_category: :wiki do
- # end
- #
- # RSpec.describe 'foo', feature_category: :tooling do
- # end
- #
- class InvalidFeatureCategory < RuboCop::Cop::RSpec::Base
- MSG = 'Please use a valid feature category. %{msg_suggestion}' \
- 'See https://docs.gitlab.com/ee/development/feature_categorization/#rspec-examples.'
-
- MSG_DID_YOU_MEAN = 'Did you mean `:%{suggestion}`? '
-
- MSG_SYMBOL = 'Please use a symbol as value.'
-
- FEATURE_CATEGORIES_PATH = File.expand_path('../../../config/feature_categories.yml', __dir__).freeze
-
- # List of feature categories which are not defined in config/feature_categories.yml
- CUSTOM_FEATURE_CATEGORIES = [
- # https://docs.gitlab.com/ee/development/feature_categorization/#tooling-feature-category
- :tooling,
- # https://docs.gitlab.com/ee/development/feature_categorization/#shared-feature-category
- :shared
- ].to_set.freeze
-
- # @!method feature_category?(node)
- def_node_matcher :feature_category_value, <<~PATTERN
- (block
- (send #rspec? {#ExampleGroups.all #Examples.all} ...
- (hash <(pair (sym :feature_category) $_) ...>)
- )
- ...
- )
- PATTERN
-
- def on_block(node)
- value_node = feature_category_value(node)
- return unless value_node
-
- unless value_node.sym_type?
- add_offense(value_node, message: MSG_SYMBOL)
- return
- end
-
- return if valid_feature_category?(value_node)
-
- message = format(MSG, msg_suggestion: suggestion_message(value_node))
- add_offense(value_node, message: message)
- end
-
- # Used by RuboCop to invalidate its cache if the contents of
- # config/feature_categories.yml changes.
- def external_dependency_checksum
- @external_dependency_checksum ||=
- Digest::SHA256.file(FEATURE_CATEGORIES_PATH).hexdigest
- end
-
- private
-
- def suggestion_message(value_node)
- spell = DidYouMean::SpellChecker.new(dictionary: self.class.feature_categories)
-
- suggestions = spell.correct(value_node.value)
- return if suggestions.none?
-
- format(MSG_DID_YOU_MEAN, suggestion: suggestions.first)
- end
-
- def valid_feature_category?(node)
- self.class.feature_categories.include?(node.value)
- end
-
- def self.feature_categories
- @feature_categories ||= YAML
- .load_file(FEATURE_CATEGORIES_PATH)
- .map(&:to_sym)
- .to_set
- .union(CUSTOM_FEATURE_CATEGORIES)
- end
- end
- end
- end
-end