cookstyle 7.32.8 → 8.0.0

data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb

@@ -1,71 +1,71 @@
-# 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 Deprecations
-        # The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   user "betty" do
-        #     supports({
-        #       manage_home: true,
-        #       non_unique: true
-        #     })
-        #   end
-        #
-        #   user 'betty' do
-        #     supports :manage_home => true
-        #   end
-        #
-        #   ### correct
-        #   user "betty" do
-        #     manage_home true
-        #     non_unique true
-        #   end
-        #
-        class UserDeprecatedSupportsProperty < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties."
-
-          def on_block(node)
-            match_property_in_resource?(:user, 'supports', node) do |property|
-              add_offense(property, severity: :warning) do |corrector|
-                new_text = []
-
-                property.arguments.first.each_pair do |k, v|
-                  # account for a strange edge case where the person incorrectly makes "manage_home a method
-                  # the code would be broken, but without this handling cookstyle would explode
-                  key_value = (k.send_type? && k.method?(:manage_home)) ? 'manage_home' : k.value
-
-                  new_text << "#{key_value} #{v.source}"
-                end
-
-                corrector.replace(property, new_text.join("\n  "))
-              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 Deprecations
+        # The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   user "betty" do
+        #     supports({
+        #       manage_home: true,
+        #       non_unique: true
+        #     })
+        #   end
+        #
+        #   user 'betty' do
+        #     supports :manage_home => true
+        #   end
+        #
+        #   ### correct
+        #   user "betty" do
+        #     manage_home true
+        #     non_unique true
+        #   end
+        #
+        class UserDeprecatedSupportsProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties."
+
+          def on_block(node)
+            match_property_in_resource?(:user, 'supports', node) do |property|
+              add_offense(property, severity: :warning) do |corrector|
+                new_text = []
+
+                property.arguments.first.each_pair do |k, v|
+                  # account for a strange edge case where the person incorrectly makes "manage_home a method
+                  # the code would be broken, but without this handling cookstyle would explode
+                  key_value = (k.send_type? && k.method?(:manage_home)) ? 'manage_home' : k.value
+
+                  new_text << "#{key_value} #{v.source}"
+                end
+
+                corrector.replace(property, new_text.join("\n  "))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb

@@ -1,57 +1,57 @@
-# 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 Deprecations
-        # In Chef Infra Client 13 the "file" variable for use within the verify property was replaced with the "path" variable.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   file '/etc/nginx.conf' do
-        #     verify 'nginx -t -c %{file}'
-        #   end
-        #
-        #   ### correct
-        #   file '/etc/nginx.conf' do
-        #     verify 'nginx -t -c %{path}'
-        #   end
-        #
-        class VerifyPropertyUsesFileExpansion < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.5'
-
-          MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13."
-
-          def on_block(node)
-            match_property_in_resource?(nil, 'verify', node) do |verify|
-              return unless verify.source.match?(/%{file}/)
-              add_offense(verify, severity: :warning) do |corrector|
-                corrector.replace(verify.loc.expression, verify.loc.expression.source.gsub('%{file}', '%{path}'))
-              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 Deprecations
+        # In Chef Infra Client 13 the "file" variable for use within the verify property was replaced with the "path" variable.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   file '/etc/nginx.conf' do
+        #     verify 'nginx -t -c %{file}'
+        #   end
+        #
+        #   ### correct
+        #   file '/etc/nginx.conf' do
+        #     verify 'nginx -t -c %{path}'
+        #   end
+        #
+        class VerifyPropertyUsesFileExpansion < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.5'
+
+          MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13."
+
+          def on_block(node)
+            match_property_in_resource?(nil, 'verify', node) do |verify|
+              return unless verify.source.match?(/%{file}/)
+              add_offense(verify, severity: :warning) do |corrector|
+                corrector.replace(verify.loc.expression, verify.loc.expression.source.gsub('%{file}', '%{path}'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb

@@ -1,58 +1,58 @@
-# 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 Deprecations
-        # The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   windows_feature 'DHCP' do
-        #     install_method :servermanagercmd
-        #   end
-        #
-        #   ### correct
-        #   windows_feature 'DHCP' do
-        #     install_method :windows_feature_dism
-        #   end
-        #
-        #   windows_feature 'DHCP' do
-        #     install_method :windows_feature_powershell
-        #   end
-        #
-        #   windows_feature_dism 'DHCP'
-        #
-        #   windows_feature_powershell 'DHCP'
-        #
-        class WindowsFeatureServermanagercmd < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
-
-          def on_block(node)
-            match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
-              add_offense(prop_node, severity: :warning) if prop_node.source.include?(':servermanagercmd')
-            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 Deprecations
+        # The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_feature 'DHCP' do
+        #     install_method :servermanagercmd
+        #   end
+        #
+        #   ### correct
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_dism
+        #   end
+        #
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_powershell
+        #   end
+        #
+        #   windows_feature_dism 'DHCP'
+        #
+        #   windows_feature_powershell 'DHCP'
+        #
+        class WindowsFeatureServermanagercmd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
+
+          def on_block(node)
+            match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
+              add_offense(prop_node, severity: :warning) if prop_node.source.include?(':servermanagercmd')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.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 Deprecations
-        # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   windows_package 'AppveyorDeploymentAgent' do
-        #     source 'https://www.example.com/appveyor.msi'
-        #     installer_type 'msi'
-        #     options "/quiet /qn /norestart /log install.log"
-        #   end
-        #
-        #   ### correct
-        #   windows_package 'AppveyorDeploymentAgent' do
-        #     source 'https://www.example.com/appveyor.msi'
-        #     installer_type :msi
-        #     options "/quiet /qn /norestart /log install.log"
-        #   end
-        #
-        class WindowsPackageInstallerTypeString < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
-
-          def on_block(node)
-            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
-              return unless offense.arguments.count == 1 # we can only analyze simple string args
-              return unless offense.arguments.first.str_type? # anything else is fine
-
-              add_offense(offense, severity: :warning) do |corrector|
-                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.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 Deprecations
+        # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type 'msi'
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        #   ### correct
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type :msi
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        class WindowsPackageInstallerTypeString < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
+
+          def on_block(node)
+            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # anything else is fine
+
+              add_offense(offense, severity: :warning) do |corrector|
+                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb

@@ -1,83 +1,83 @@
-# 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 Deprecations
-        # The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+
-        # The default action of :create should can now be used to create an update tasks.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   windows_task 'chef ad-join leave start time' do
-        #     task_name 'chef ad-join leave'
-        #     start_day '06/09/2016'
-        #     start_time '01:00'
-        #     action [:change, :create]
-        #   end
-        #
-        #   ### correct
-        #   windows_task 'chef ad-join leave start time' do
-        #     task_name 'chef ad-join leave'
-        #     start_day '06/09/2016'
-        #     start_time '01:00'
-        #     action :create
-        #   end
-        #
-        class WindowsTaskChangeAction < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '13.0'
-
-          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'
-
-          def on_block(node)
-            match_property_in_resource?(:windows_task, 'action', node) do |action_node|
-              action_values = action_node.arguments.first
-
-              if action_values.sym_type? # there's only a single action given
-                check_action(action_values)
-              else # it was an array of actions
-                action_values.node_parts.each { |action| check_action(action) }
-              end
-            end
-          end
-
-          private
-
-          def check_action(ast_obj)
-            if ast_obj.respond_to?(:value) && ast_obj.value == :change
-              add_offense(ast_obj, severity: :warning) do |corrector|
-                if ast_obj.parent.send_type? # :change was the only action
-                  corrector.replace(ast_obj, ':create')
-                # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
-                elsif ast_obj.parent.child_nodes.count == 2 &&
-                      ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
-                  corrector.replace(ast_obj.parent, ':create')
-                end
-              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 Deprecations
+        # The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+
+        # The default action of :create should can now be used to create an update tasks.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_task 'chef ad-join leave start time' do
+        #     task_name 'chef ad-join leave'
+        #     start_day '06/09/2016'
+        #     start_time '01:00'
+        #     action [:change, :create]
+        #   end
+        #
+        #   ### correct
+        #   windows_task 'chef ad-join leave start time' do
+        #     task_name 'chef ad-join leave'
+        #     start_day '06/09/2016'
+        #     start_time '01:00'
+        #     action :create
+        #   end
+        #
+        class WindowsTaskChangeAction < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '13.0'
+
+          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'
+
+          def on_block(node)
+            match_property_in_resource?(:windows_task, 'action', node) do |action_node|
+              action_values = action_node.arguments.first
+
+              if action_values.sym_type? # there's only a single action given
+                check_action(action_values)
+              else # it was an array of actions
+                action_values.node_parts.each { |action| check_action(action) }
+              end
+            end
+          end
+
+          private
+
+          def check_action(ast_obj)
+            if ast_obj.respond_to?(:value) && ast_obj.value == :change
+              add_offense(ast_obj, severity: :warning) do |corrector|
+                if ast_obj.parent.send_type? # :change was the only action
+                  corrector.replace(ast_obj, ':create')
+                # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
+                elsif ast_obj.parent.child_nodes.count == 2 &&
+                      ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
+                  corrector.replace(ast_obj.parent, ':create')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end