gitlab-styles 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6524a0d089736b32d3cade47711da247bac96961d97da814715c11ea977237b7
-  data.tar.gz: 83876a151dbd560911b4d4c8b92d9692bd3192920521f8e7c2b69f030478faaf
+  metadata.gz: a5c5dbefc4cc4e9fce7794623c0688cb4bfb145e186a0c12376e8cf973b09c1b
+  data.tar.gz: ce47876a9ac193036759b85aea6ef23d1c2caf3037e057d640849fe2cce8b197
 SHA512:
-  metadata.gz: 1c5840d3fc84a7f0979a19cc86cfac8b1408c9d27c5aed1a61f971789ac3feb8b5baeea236f7a16d69a04018d6941152b97a407516fafe1cec69058648158489
-  data.tar.gz: 93815193b0ead85db1823585a6fffe7a2db1f564fc8f1b02eaac18c286d43b87b2b42e947af4813bfec45d85d6261d973e8ae1984cf282c56388ca68ccb4a0e3
+  metadata.gz: 3f2713efa71f126be8e9bf9b44ca4caef0c09f69bdbec2f2abc143184356891341b4b423606f742ea7d517feabec0dadd259553846adcf8c068c80dcc8e588dd
+  data.tar.gz: 4c83cc34cebefb7b7d0bc53adeec8b733f9adefbe446c7e46cd81f60fa136de48445de38b71533edf76f32789c3fa4caf46b27860dd23177a3607377f81a6397

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gitlab-rubocop.gemspec
 gemspec
+
+group :test do
+  # Pin these dependencies, otherwise a new rule could break the CI pipelines
+  gem 'rubocop', '0.52.0'
+  gem 'rubocop-rspec', '1.20.1'
+end

data/lib/gitlab/styles/rubocop.rb

@@ -5,6 +5,7 @@ require 'gitlab/styles/rubocop/cop/redirect_with_status'
 require 'gitlab/styles/rubocop/cop/polymorphic_associations'
 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'
 
 module Gitlab

data/lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb

@@ -0,0 +1,102 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Ensures a line break after guard clauses.
+        #
+        # @example
+        #   # bad
+        #   return unless condition
+        #   do_stuff
+        #
+        #   # good
+        #   return unless condition
+        #
+        #   do_stuff
+        #
+        #   # bad
+        #   raise if condition
+        #   do_stuff
+        #
+        #   # good
+        #   raise if condition
+        #
+        #   do_stuff
+        #
+        #   Multiple guard clauses are allowed without
+        #   line break.
+        #
+        #   # good
+        #   return unless condition_a
+        #   return unless condition_b
+        #
+        #   do_stuff
+        #
+        #   Guard clauses in case statement are allowed without
+        #   line break.
+        #
+        #   # good
+        #   case model
+        #     when condition_a
+        #       return true unless condition_b
+        #     when
+        #       ...
+        #   end
+        #
+        #   Guard clauses before end are allowed without
+        #   line break.
+        #
+        #   # good
+        #   if condition_a
+        #     do_something
+        #   else
+        #     do_something_else
+        #     return unless condition
+        #   end
+        #
+        #   do_something_more
+        class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
+          MSG = 'Add a line break after guard clauses'.freeze
+
+          def_node_matcher :guard_clause_node?, <<-PATTERN
+            [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]
+          PATTERN
+
+          def on_if(node)
+            return unless node.single_line?
+            return unless guard_clause?(node)
+            return if next_line(node).blank? || clause_last_line?(next_line(node)) || guard_clause?(next_sibling(node))
+
+            add_offense(node, location: :expression, message: MSG)
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.insert_after(node.loc.expression, "\n")
+            end
+          end
+
+          private
+
+          def guard_clause?(node)
+            return false unless node.if_type?
+
+            guard_clause_node?(node.if_branch)
+          end
+
+          def next_sibling(node)
+            node.parent.children[node.sibling_index + 1]
+          end
+
+          def next_line(node)
+            processed_source[node.loc.line]
+          end
+
+          def clause_last_line?(line)
+            line =~ /^\s*(?:end|elsif|else|when|rescue|ensure)/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

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

data/rubocop-layout.yml

@@ -191,14 +191,20 @@ Layout/SpaceBeforeComment:
 Layout/SpaceBeforeSemicolon:
   Enabled: true
 
-# Checks for spaces inside square brackets.
-Layout/SpaceInsideBrackets:
+# Checks that brackets used for array literals have or don't have
+# surrounding space depending on configuration..
+Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: true
 
 # Use spaces inside hash literal braces - or don't.
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: true
 
+# Checks that reference brackets have or don't have
+# surrounding space depending on configuration.
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
 # No spaces inside range literals.
 Layout/SpaceInsideRangeLiteral:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -121,6 +121,7 @@ files:
 - lib/gitlab/styles/rubocop/cop/custom_error_class.rb
 - lib/gitlab/styles/rubocop/cop/gem_fetcher.rb
 - lib/gitlab/styles/rubocop/cop/in_batches.rb
+- lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb
 - 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
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.0
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: GitLab style guides and shared style configs.