cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb

@@ -1,113 +1,113 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Modernize
-        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   %w(bmon htop vim curl).each do |pkg|
-        #     package pkg do
-        #       action :install
-        #     end
-        #   end
-        #
-        #   ### correct
-        #   package %w(bmon htop vim curl)
-        #
-        class UseMultipackageInstalls < Base
-          extend AutoCorrector
-
-          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
-          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
-
-          def_node_matcher :platform_or_platform_family?, <<-PATTERN
-            (send (send nil? :node) :[] (str {"platform" "platform_family"}) )
-          PATTERN
-
-          def_node_matcher :platform_helper?, <<-PATTERN
-          (if
-            (send nil? {:platform_family? :platform?} $... )
-            $(block
-              (send
-                $(array ... ) :each)
-              (args ... )
-              {(block
-                (send nil? :package
-                  (lvar ... ))
-                (args)
-                (send nil? :action
-                  (sym :install)))
-                (send nil? :package
-                    (lvar _))}) nil?)
-          PATTERN
-
-          def_node_search :package_array_install, <<-PATTERN
-          $(block
-            (send
-              $(array ... ) :each)
-            (args ... )
-            {(block
-              (send nil? :package
-                (lvar ... ))
-              (args)
-              (send nil? :action
-                (sym :install)))
-              (send nil? :package
-                  (lvar _))})
-          PATTERN
-
-          # see if all platforms in the when condition are multi-package compliant
-          def multipackage_platforms?(condition_obj)
-            condition_obj.all? do |p|
-              # make sure it's a string (not a regex) and it's in the array
-              p.str_type? && MULTIPACKAGE_PLATS.include?(p.value)
-            end
-          end
-
-          def on_when(node)
-            return unless platform_or_platform_family?(node.parent.condition) &&
-                          multipackage_platforms?(node.conditions)
-            return if node.body.nil? # don't blow up on empty whens
-
-            package_array_install(node.body) do |install_block, pkgs|
-              add_offense(install_block, severity: :refactor) do |corrector|
-                corrector.replace(install_block, "package #{pkgs.source}")
-              end
-            end
-          end
-
-          def on_if(node)
-            platform_helper?(node) do |plats, blk, _pkgs|
-              return unless multipackage_platforms?(plats)
-
-              add_offense(blk, severity: :refactor) do |corrector|
-                package_array_install(blk) do |install_block, pkgs|
-                  corrector.replace(install_block, "package #{pkgs.source}")
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   %w(bmon htop vim curl).each do |pkg|
+        #     package pkg do
+        #       action :install
+        #     end
+        #   end
+        #
+        #   ### correct
+        #   package %w(bmon htop vim curl)
+        #
+        class UseMultipackageInstalls < Base
+          extend AutoCorrector
+
+          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
+          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
+
+          def_node_matcher :platform_or_platform_family?, <<-PATTERN
+            (send (send nil? :node) :[] (str {"platform" "platform_family"}) )
+          PATTERN
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+          (if
+            (send nil? {:platform_family? :platform?} $... )
+            $(block
+              (send
+                $(array ... ) :each)
+              (args ... )
+              {(block
+                (send nil? :package
+                  (lvar ... ))
+                (args)
+                (send nil? :action
+                  (sym :install)))
+                (send nil? :package
+                    (lvar _))}) nil?)
+          PATTERN
+
+          def_node_search :package_array_install, <<-PATTERN
+          $(block
+            (send
+              $(array ... ) :each)
+            (args ... )
+            {(block
+              (send nil? :package
+                (lvar ... ))
+              (args)
+              (send nil? :action
+                (sym :install)))
+              (send nil? :package
+                  (lvar _))})
+          PATTERN
+
+          # see if all platforms in the when condition are multi-package compliant
+          def multipackage_platforms?(condition_obj)
+            condition_obj.all? do |p|
+              # make sure it's a string (not a regex) and it's in the array
+              p.str_type? && MULTIPACKAGE_PLATS.include?(p.value)
+            end
+          end
+
+          def on_when(node)
+            return unless platform_or_platform_family?(node.parent.condition) &&
+                          multipackage_platforms?(node.conditions)
+            return if node.body.nil? # don't blow up on empty whens
+
+            package_array_install(node.body) do |install_block, pkgs|
+              add_offense(install_block, severity: :refactor) do |corrector|
+                corrector.replace(install_block, "package #{pkgs.source}")
+              end
+            end
+          end
+
+          def on_if(node)
+            platform_helper?(node) do |plats, blk, _pkgs|
+              return unless multipackage_platforms?(plats)
+
+              add_offense(blk, severity: :refactor) do |corrector|
+                package_array_install(blk) do |install_block, pkgs|
+                  corrector.replace(install_block, "package #{pkgs.source}")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/use_require_relative.rb

@@ -1,60 +1,60 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Modernize
-        # Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   require File.expand_path('../../libraries/helpers', __FILE__)
-        #
-        #   ### correct
-        #   require_relative '../libraries/helpers'
-        #
-        class UseRequireRelative < Base
-          extend AutoCorrector
-
-          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
-          RESTRICT_ON_SEND = [:require].freeze
-
-          def_node_matcher :require_with_expand_path?, <<-PATTERN
-            (send nil? :require
-              (send
-                (const nil? :File) :expand_path
-                $( str ... )
-                $( str ... )))
-          PATTERN
-
-          def on_send(node)
-            require_with_expand_path?(node) do |file, path|
-              return unless path.source == '__FILE__'
-              add_offense(node, severity: :refactor) do |corrector|
-                corrected_value = file.value
-                corrected_value.slice!(%r{^../}) # take the first ../ off the path
-                corrector.replace(node, "require_relative '#{corrected_value}'")
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require File.expand_path('../../libraries/helpers', __FILE__)
+        #
+        #   ### correct
+        #   require_relative '../libraries/helpers'
+        #
+        class UseRequireRelative < Base
+          extend AutoCorrector
+
+          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def_node_matcher :require_with_expand_path?, <<-PATTERN
+            (send nil? :require
+              (send
+                (const nil? :File) :expand_path
+                $( str ... )
+                $( str ... )))
+          PATTERN
+
+          def on_send(node)
+            require_with_expand_path?(node) do |file, path|
+              return unless path.source == '__FILE__'
+              add_offense(node, severity: :refactor) do |corrector|
+                corrected_value = file.value
+                corrected_value.slice!(%r{^../}) # take the first ../ off the path
+                corrector.replace(node, "require_relative '#{corrected_value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb

@@ -1,58 +1,58 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019-2020, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Modernize
-        # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   def whyrun_supported?
-        #    true
-        #   end
-        #
-        class WhyRunSupportedTrue < Base
-          extend TargetChefVersion
-          extend AutoCorrector
-          include RangeHelp
-
-          minimum_target_chef_version '13.0'
-
-          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'
-
-          # match on both whyrun_supported? and the typo form why_run_supported?
-          def_node_matcher :whyrun_true?, <<-PATTERN
-            (def {:whyrun_supported? :why_run_supported?}
-              (args)
-              (true))
-          PATTERN
-
-          def on_def(node)
-            whyrun_true?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def whyrun_supported?
+        #    true
+        #   end
+        #
+        class WhyRunSupportedTrue < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+          include RangeHelp
+
+          minimum_target_chef_version '13.0'
+
+          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'
+
+          # match on both whyrun_supported? and the typo form why_run_supported?
+          def_node_matcher :whyrun_true?, <<-PATTERN
+            (def {:whyrun_supported? :why_run_supported?}
+              (args)
+              (true))
+          PATTERN
+
+          def on_def(node)
+            whyrun_true?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Modernize
-        # Don't include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include_recipe 'windows::default'
-        #   include_recipe 'windows'
-        #
-        class IncludingWindowsDefaultRecipe < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
-
-          def_node_matcher :windows_recipe_usage?, <<-PATTERN
-            (send nil? :include_recipe (str {"windows" "windows::default"}))
-          PATTERN
-
-          def on_send(node)
-            windows_recipe_usage?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Don't include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'windows::default'
+        #   include_recipe 'windows'
+        #
+        class IncludingWindowsDefaultRecipe < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :windows_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"windows" "windows::default"}))
+          PATTERN
+
+          def on_send(node)
+            windows_recipe_usage?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end