cookstyle 7.32.8 → 8.0.0

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

@@ -1,68 +1,68 @@
-# 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
-        # PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   powershell_script 'Create Directory' do
-        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
-        #     guard_interpreter :powershell_script
-        #   end
-        #
-        #   batch 'Create Directory' do
-        #     code "mkdir C:\mydir"
-        #     guard_interpreter :powershell_script
-        #   end
-        #
-        #   ### correct
-        #   powershell_script 'Create Directory' do
-        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
-        #   end
-        #
-        #   batch 'Create Directory' do
-        #     code "mkdir C:\mydir"
-        #   end
-        #
-        class PowerShellGuardInterpreter < Base
-          include RuboCop::Chef::CookbookHelpers
-          include RangeHelp
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '13.0'
-
-          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'
-
-          def on_block(node)
-            match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
-              return unless interpreter.arguments.first.source == ':powershell_script'
-              add_offense(interpreter, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: interpreter.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
+        # PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   ### correct
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
+        #   end
+        #
+        class PowerShellGuardInterpreter < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '13.0'
+
+          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'
+
+          def on_block(node)
+            match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
+              return unless interpreter.arguments.first.source == ':powershell_script'
+              add_offense(interpreter, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: interpreter.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,53 @@
-# 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
-        # Use the powershell_package resource built into Chef Infra Client instead of the powershell_script resource to run Install-Package
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   powershell_script 'Expand website' do
-        #     code 'Install-Package -Name docker'
-        #   end
-        #
-        #  ### correct
-        #  powershell_package 'docker'
-        #
-        class PowershellInstallPackage < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '12.16'
-
-          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'
-
-          def on_block(node)
-            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              return unless property_data && property_data.match?(/^install-package\s/i)
-              add_offense(node, severity: :refactor)
-            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
+        # Use the powershell_package resource built into Chef Infra Client instead of the powershell_script resource to run Install-Package
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Expand website' do
+        #     code 'Install-Package -Name docker'
+        #   end
+        #
+        #  ### correct
+        #  powershell_package 'docker'
+        #
+        class PowershellInstallPackage < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.16'
+
+          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^install-package\s/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# 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
-        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource to run Install-WindowsFeature or Add-WindowsFeature
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   powershell_script 'Install Feature' do
-        #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
-        #   end
-        #
-        #  ### correct
-        #  windows_feature 'Net-framework-Core' do
-        #    action :install
-        #    install_method :windows_feature_powershell
-        #  end
-        #
-        class PowershellInstallWindowsFeature < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'
-
-          def on_block(node)
-            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              return unless property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
-              add_offense(node, severity: :refactor)
-            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
+        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource to run Install-WindowsFeature or Add-WindowsFeature
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Install Feature' do
+        #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
+        #   end
+        #
+        #  ### correct
+        #  windows_feature 'Net-framework-Core' do
+        #    action :install
+        #    install_method :windows_feature_powershell
+        #  end
+        #
+        class PowershellInstallWindowsFeature < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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
-        # When using properties in a custom resource you should use name_property not the legacy name_attribute from the days of attributes
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :bob, String, name_attribute: true
-        #
-        #   ### correct
-        #   property :bob, String, name_property: true
-        #
-        class PropertyWithNameAttribute < Base
-          extend AutoCorrector
-
-          MSG = 'Resource property sets name_attribute instead of name_property'
-          RESTRICT_ON_SEND = [:property].freeze
-
-          # match on a property that has any name and any type and a hash that
-          # contains name_attribute true. The hash pairs are wrapped in
-          # <> which means the order doesn't matter in the hash.
-          def_node_matcher :property_with_name_attribute?, <<-PATTERN
-            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
-          PATTERN
-
-          def on_send(node)
-            property_with_name_attribute?(node) do |name_attribute|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(name_attribute, 'name_property: true')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # When using properties in a custom resource you should use name_property not the legacy name_attribute from the days of attributes
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :bob, String, name_attribute: true
+        #
+        #   ### correct
+        #   property :bob, String, name_property: true
+        #
+        class PropertyWithNameAttribute < Base
+          extend AutoCorrector
+
+          MSG = 'Resource property sets name_attribute instead of name_property'
+          RESTRICT_ON_SEND = [:property].freeze
+
+          # match on a property that has any name and any type and a hash that
+          # contains name_attribute true. The hash pairs are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :property_with_name_attribute?, <<-PATTERN
+            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
+          PATTERN
+
+          def on_send(node)
+            property_with_name_attribute?(node) do |name_attribute|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(name_attribute, 'name_property: true')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,68 +1,68 @@
-# 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
-        # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   def initialize(*args)
-        #     super
-        #     @provides = :foo
-        #   end
-        #
-        #   ### correct
-        #   provides :foo
-        #
-        class ProvidesFromInitialize < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
-
-          def_node_matcher :provides_assignment?, <<-PATTERN
-            (ivasgn :@provides $(sym ...))
-          PATTERN
-
-          def on_ivasgn(node)
-            provides_assignment?(node) do
-              return unless initialize_method(node.parent.parent).any?
-              add_offense(node, severity: :refactor) do |corrector|
-                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
-                unless provides_method?(processed_source.ast)
-                  initialize_node = initialize_method(processed_source.ast).first
-                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
-                end
-
-                # remove the variable from the initialize method
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-
-          def_node_search :provides_method?, '(send nil? :provides ... )'
-
-          def_node_search :initialize_method, '(def :initialize ... )'
-        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
+        # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @provides = :foo
+        #   end
+        #
+        #   ### correct
+        #   provides :foo
+        #
+        class ProvidesFromInitialize < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
+
+          def_node_matcher :provides_assignment?, <<-PATTERN
+            (ivasgn :@provides $(sym ...))
+          PATTERN
+
+          def on_ivasgn(node)
+            provides_assignment?(node) do
+              return unless initialize_method(node.parent.parent).any?
+              add_offense(node, severity: :refactor) do |corrector|
+                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+                unless provides_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :provides_method?, '(send nil? :provides ... )'
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end