gitlab-styles 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c5dbefc4cc4e9fce7794623c0688cb4bfb145e186a0c12376e8cf973b09c1b
-  data.tar.gz: ce47876a9ac193036759b85aea6ef23d1c2caf3037e057d640849fe2cce8b197
+  metadata.gz: 7c8bcbe5bc056a0c4862e87c4fb7936bd6cb257477b61bcdd2bd446e7cd2dc11
+  data.tar.gz: 01e72c7ddc449062470f216f166cc37e02d794c64f69758bb56d4ab2485560b1
 SHA512:
-  metadata.gz: 3f2713efa71f126be8e9bf9b44ca4caef0c09f69bdbec2f2abc143184356891341b4b423606f742ea7d517feabec0dadd259553846adcf8c068c80dcc8e588dd
-  data.tar.gz: 4c83cc34cebefb7b7d0bc53adeec8b733f9adefbe446c7e46cd81f60fa136de48445de38b71533edf76f32789c3fa4caf46b27860dd23177a3607377f81a6397
+  metadata.gz: 9a3214afbb65c6c79246a72fb4b1ac38715032e3635ed2b4c0a72bddb7a6512bc6122d432c86ddac89a3e405ce41522e0c7af8bf9015fe513b3804ed12f43c69
+  data.tar.gz: 70a068513cfb5a4937e59cc26a24728fcc1222a6960d3f89f59711b46281e7c3ad6adff5423ec3c334c377aed43530c242408befd2ada70ee256eed90166b46c

data/lib/gitlab/styles/rubocop.rb

@@ -7,6 +7,7 @@ require 'gitlab/styles/rubocop/cop/active_record_dependent'
 require 'gitlab/styles/rubocop/cop/in_batches'
 require 'gitlab/styles/rubocop/cop/line_break_after_guard_clauses'
 require 'gitlab/styles/rubocop/cop/rspec/single_line_hook'
+require 'gitlab/styles/rubocop/cop/rspec/verbose_include_metadata'
 
 module Gitlab
   module Styles

data/lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb

@@ -0,0 +1,76 @@
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks for verbose include metadata used in the specs.
+          #
+          # @example
+          #   # bad
+          #   describe MyClass, js: true do
+          #   end
+          #
+          #   # good
+          #   describe MyClass, :js do
+          #   end
+          class VerboseIncludeMetadata < RuboCop::Cop::Cop
+            MSG = 'Use `%s` instead of `%s`.'.freeze
+
+            SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
+
+            def_node_matcher :include_metadata, <<-PATTERN
+              (send {(const nil? :RSpec) nil?} {#{SELECTORS.map(&:inspect).join(' ')}}
+                !const
+                ...
+                (hash $...))
+            PATTERN
+
+            def_node_matcher :invalid_metadata?, <<-PATTERN
+              (pair
+                (sym $...)
+                (true))
+            PATTERN
+
+            def on_send(node)
+              invalid_metadata_matches(node) do |match|
+                add_offense(node, location: :expression, message: format(MSG, good(match), bad(match)))
+              end
+            end
+
+            def autocorrect(node)
+              lambda do |corrector|
+                invalid_metadata_matches(node) do |match|
+                  corrector.replace(match.loc.expression, good(match))
+                end
+              end
+            end
+
+            private
+
+            def invalid_metadata_matches(node)
+              include_metadata(node) do |matches|
+                matches.select(&method(:invalid_metadata?)).each do |match|
+                  yield match
+                end
+              end
+            end
+
+            def bad(match)
+              "#{metadata_key(match)}: true"
+            end
+
+            def good(match)
+              ":#{metadata_key(match)}"
+            end
+
+            def metadata_key(match)
+              match.children[0].source
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Styles
-    VERSION = '2.2.0'.freeze
+    VERSION = '2.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -125,6 +125,7 @@ files:
 - lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
 - lib/gitlab/styles/rubocop/cop/redirect_with_status.rb
 - lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb
+- lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb
 - lib/gitlab/styles/version.rb