rubocop-brands_insurance 1.3.0.pre.rc.2 → 1.4.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d970e26f5615762329168e39d4e03ca54f6249565919ff2922110380d3cee5
-  data.tar.gz: 6782129fbbede885e3438fa2b38d9888c0cba31dd32c0e0a82389529e862ff7c
+  metadata.gz: f71b8941f86c6189771d5c9bfcc81f4744e9fb821d45d5ba3c93c5a0fd195320
+  data.tar.gz: 8032dc595911c74d1d4296d0123918c98e60cb273fd4aa0d1654602526363936
 SHA512:
-  metadata.gz: f52e5fcd8e1ad529fb5d6f269c4404f6d063e71740a39109da17611d01722c54f47154c6253d62d378a084d88c90846e10eef835b398cb20f85d60b7d9fad29f
-  data.tar.gz: daa29de6ad55a7d75d2f2c3e2fbbf5e06ca983fbcae25ee944e54f6e0a39b72bf148527255cc70079e600f7127277f8a70f5935c44a536d868cf090de362b715
+  metadata.gz: f9a13ac68f7eead1d4186767b1fef7c6e8eaae15beb823a1344acb33bc7a969ef4bf3c8b05665e3fc3291b32f749293237539163d7f8eafc13e4a78f346faed7
+  data.tar.gz: 58be8bafe667d21c2b9be721a6102fe9fabe16ec8b03633d430385366bb37b4b1dabbb73c552d1f5197affe9f5cbc637b3aefa4a30739f27f640d7431ec898a8

data/README.adoc

@@ -35,6 +35,7 @@ BrandsInsurance/Style/DisallowedMethods:
 
 == Departments
 
+* xref:./docs/cops/layout/README.adoc[``Layout``]
 * xref:./docs/cops/style/README.adoc[``Style``]
 
 == Contributing

data/config/default.yml

@@ -1,3 +1,10 @@
+BrandsInsurance/Layout/MultilineArrayLineBreaks:
+  Description: 'Fork of base Layout/MultilineArrayLineBreaks rule'
+  Enabled: true
+  VersionAdded: '1.3.0'
+  AllowMultilineFinalElement: true
+  AllowPercentArray: true
+
 BrandsInsurance/Style/DisallowedMethods:
   Description: 'Disallows the usage of `#abort` and `#tap` methods'
   Enabled: true

data/docs/cops/layout/README.adoc

@@ -0,0 +1,7 @@
+= Layout
+
+Layout cops check for stylistic whitespace in your code
+
+== Cops
+
+* xref:./multiline_array_line_breaks/README.adoc[``Layout/MultilineArrayLineBreaks``]

data/docs/cops/layout/multiline_array_line_breaks/README.adoc

@@ -0,0 +1,44 @@
+= ``Layout/MultilineArrayLineBreaks``
+
+== Description
+
+Extends the built-in link:https://docs.rubocop.org/rubocop/1.49/cops_layout.html#layoutmultilinearraylinebreaks[``Layout/MultilineArrayLineBreaks``]
+and adds the ``AllowPercentArray`` option
+
+== Examples
+
+[source,ruby]
+----
+# bad
+%w[
+  1
+  2
+  3
+  4
+]
+
+# good
+%w[
+  1 2
+  3 4
+]
+----
+
+== Configurable Attributes
+
+|===
+|Name |Default value |Configurable values
+
+|AllowMultilineFinalElement
+|false
+|Boolean
+
+|AllowPercentArray
+|false
+|Boolean
+
+|===
+
+== References
+
+https://github.com/BrandsInsurance/expert-chainsaw/issues/1032

data/lib/rubocop/brands_insurance/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module BrandsInsurance
-    VERSION = '1.3.0-rc.2'
+    VERSION = '1.4.0-rc.1'
   end
 end

data/lib/rubocop/cop/brands_insurance/layout/multiline_array_line_breaks.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module BrandsInsurance
+      module Layout
+        class MultilineArrayLineBreaks < Base
+          include RuboCop::Cop::MultilineElementLineBreaks
+          # extend RuboCop::Cop::AutoCorrector
+
+          # `RuboCop::Cop::AutoCorrector` must be extended but it only has this method returning `true`
+          #
+          # @return [Boolean]
+          #
+          def support_autocorrect?
+            false
+          end
+
+          MESSAGE = 'Each item in a multi-line array must start on a separate line.'
+          # MSG is needed for `check_line_breaks`
+          MSG = MESSAGE
+
+          def on_array(node)
+            return if allowed_percent_array?(node)
+
+            check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
+          end
+
+          private
+
+            # Check conig option
+            #
+            # @return [Boolean]
+            #
+            def ignore_last_element?
+              cop_config.fetch('AllowMultilineFinalElement', false)
+            end
+
+            # Check conig option
+            #
+            # @return [Boolean]
+            #
+            def allowed_percent_array?(node)
+              cop_config.fetch('AllowPercentArray', false) && node.percent_literal?
+            end
+
+            # Copied from rubocop's source
+            def check_line_breaks(_node, children, ignore_last: false)
+              return if all_on_same_line?(children, ignore_last: ignore_last)
+
+              last_seen_line = -1
+              children.each do |child|
+                if last_seen_line >= child.first_line
+                  add_offense(child, message: MESSAGE)
+                else
+                  last_seen_line = child.last_line
+                end
+              end
+            end
+
+            # Copied from rubocop's source
+            def all_on_same_line?(nodes, ignore_last: false)
+              return true if nodes.empty?
+
+              return same_line?(nodes.first, nodes.last) if ignore_last
+
+              nodes.first.first_line == nodes.last.last_line
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/brands_insurance_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'brands_insurance/style/disallowed_methods'
+require_relative 'brands_insurance/layout/multiline_array_line_breaks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-brands_insurance
 version: !ruby/object:Gem::Version
-  version: 1.3.0.pre.rc.2
+  version: 1.4.0.pre.rc.1
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -35,6 +35,8 @@ files:
 - LICENSE.txt
 - README.adoc
 - config/default.yml
+- docs/cops/layout/README.adoc
+- docs/cops/layout/multiline_array_line_breaks/README.adoc
 - docs/cops/style/README.adoc
 - docs/cops/style/disallowed_methods/README.adoc
 - lib/rubocop-brands_insurance.rb
@@ -44,6 +46,7 @@ files:
 - lib/rubocop/cop/brands_insurance/generator.rb
 - lib/rubocop/cop/brands_insurance/generator/cop_readme_injector.rb
 - lib/rubocop/cop/brands_insurance/generator/dept_readme_injector.rb
+- lib/rubocop/cop/brands_insurance/layout/multiline_array_line_breaks.rb
 - lib/rubocop/cop/brands_insurance/style/disallowed_methods.rb
 - lib/rubocop/cop/brands_insurance_cops.rb
 homepage: https://github.com/BrandsInsurance/expert-chainsaw/