cookstyle 7.32.8 → 8.1.1

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

@@ -1,64 +1,64 @@
-# 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 large number of `shell_out` helper methods in Chef Infra Client has been reduced to just `shell_out` and `shell_out!` methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   shell_out_compact('foo')
-        #   shell_out_compact!('foo')
-        #   shell_out_with_timeout('foo')
-        #   shell_out_with_timeout!('foo')
-        #   shell_out_with_systems_locale('foo')
-        #   shell_out_with_systems_locale!('foo')
-        #   shell_out_compact_timeout('foo')
-        #   shell_out_compact_timeout!('foo')
-        #
-        #   ### correct
-        #   shell_out('foo')
-        #   shell_out!('foo')
-        #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
-        #
-        class DeprecatedShelloutMethods < Base
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.3'
-
-          MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
-          RESTRICT_ON_SEND = %i( shell_out_compact
-          shell_out_compact!
-          shell_out_compact_timeout
-          shell_out_compact_timeout!
-          shell_out_with_timeout
-          shell_out_with_timeout!
-          shell_out_with_systems_locale
-          shell_out_with_systems_locale!
-        ).freeze
-
-          def on_send(node)
-            add_offense(node, severity: :warning)
-          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 large number of `shell_out` helper methods in Chef Infra Client has been reduced to just `shell_out` and `shell_out!` methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   shell_out_compact('foo')
+        #   shell_out_compact!('foo')
+        #   shell_out_with_timeout('foo')
+        #   shell_out_with_timeout!('foo')
+        #   shell_out_with_systems_locale('foo')
+        #   shell_out_with_systems_locale!('foo')
+        #   shell_out_compact_timeout('foo')
+        #   shell_out_compact_timeout!('foo')
+        #
+        #   ### correct
+        #   shell_out('foo')
+        #   shell_out!('foo')
+        #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
+        #
+        class DeprecatedShelloutMethods < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.3'
+
+          MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
+          RESTRICT_ON_SEND = %i( shell_out_compact
+                                 shell_out_compact!
+                                 shell_out_compact_timeout
+                                 shell_out_compact_timeout!
+                                 shell_out_with_timeout
+                                 shell_out_with_timeout!
+                                 shell_out_with_systems_locale
+                                 shell_out_with_systems_locale!
+        ).freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,65 +1,65 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2021, 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 `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   sudo 'admins' do
-        #     users 'bob'
-        #     groups 'sysadmins, superusers'
-        #     action :remove
-        #   end
-        #
-        #   ### correct
-        #   sudo 'admins' do
-        #     users 'bob'
-        #     groups 'sysadmins, superusers'
-        #     action :delete
-        #   end
-        #
-        class DeprecatedSudoActions < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.'
-
-          def on_block(node)
-            match_property_in_resource?(:sudo, 'action', node) do |prop_node|
-              next unless prop_node.arguments.first.sym_type?
-              next unless [s(:sym, :install), s(:sym, :remove)].include?(prop_node.arguments.first)
-
-              add_offense(prop_node, severity: :warning) do |corrector|
-                corrector.replace(prop_node, prop_node.source
-                  .gsub('install', 'create')
-                  .gsub('remove', 'delete'))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   sudo 'admins' do
+        #     users 'bob'
+        #     groups 'sysadmins, superusers'
+        #     action :remove
+        #   end
+        #
+        #   ### correct
+        #   sudo 'admins' do
+        #     users 'bob'
+        #     groups 'sysadmins, superusers'
+        #     action :delete
+        #   end
+        #
+        class DeprecatedSudoActions < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The `sudo` resource in the sudo cookbook 5.0 (2018) or Chef Infra Client 14 and later have replaced the existing `:install` and `:remove` actions with `:create` and `:delete` actions to better match other resources in Chef Infra.'
+
+          def on_block(node)
+            match_property_in_resource?(:sudo, 'action', node) do |prop_node|
+              next unless prop_node.arguments.first.sym_type?
+              next unless [s(:sym, :install), s(:sym, :remove)].include?(prop_node.arguments.first)
+
+              add_offense(prop_node, severity: :warning) do |corrector|
+                corrector.replace(prop_node, prop_node.source
+                  .gsub('install', 'create')
+                  .gsub('remove', 'delete'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,42 +1,42 @@
-# 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
-        # Don't use the deprecated `older_than_win_2012_or_8?` helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   if older_than_win_2012_or_8?
-        #     # do some legacy things
-        #   end
-        #
-        class DeprecatedWindowsVersionCheck < Base
-          MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
-          RESTRICT_ON_SEND = [:older_than_win_2012_or_8?].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :warning)
-          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
+        # Don't use the deprecated `older_than_win_2012_or_8?` helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   if older_than_win_2012_or_8?
+        #     # do some legacy things
+        #   end
+        #
+        class DeprecatedWindowsVersionCheck < Base
+          MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
+          RESTRICT_ON_SEND = [:older_than_win_2012_or_8?].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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
-        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   yum_repository 'OurCo' do
-        #     description 'OurCo yum repository'
-        #     baseurl 'http://artifacts.ourco.org/foo/bar'
-        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
-        #     action :add
-        #   end
-        #
-        #   ### correct
-        #   yum_repository 'OurCo' do
-        #     description 'OurCo yum repository'
-        #     baseurl 'http://artifacts.ourco.org/foo/bar'
-        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
-        #     action :create
-        #   end
-        #
-        class DeprecatedYumRepositoryActions < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.14'
-
-          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.'
-
-          def on_block(node)
-            match_property_in_resource?(:yum_repository, 'action', node) do |prop_node|
-              next unless prop_node.arguments.first.sym_type?
-              next unless [s(:sym, :add), s(:sym, :delete)].include?(prop_node.arguments.first)
-
-              add_offense(prop_node, severity: :warning) do |corrector|
-                corrector.replace(prop_node, prop_node.source
-                  .gsub('add', 'create')
-                  .gsub('delete', 'remove'))
-              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
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     baseurl 'http://artifacts.ourco.org/foo/bar'
+        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     action :add
+        #   end
+        #
+        #   ### correct
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     baseurl 'http://artifacts.ourco.org/foo/bar'
+        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     action :create
+        #   end
+        #
+        class DeprecatedYumRepositoryActions < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.14'
+
+          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.'
+
+          def on_block(node)
+            match_property_in_resource?(:yum_repository, 'action', node) do |prop_node|
+              next unless prop_node.arguments.first.sym_type?
+              next unless [s(:sym, :add), s(:sym, :delete)].include?(prop_node.arguments.first)
+
+              add_offense(prop_node, severity: :warning) do |corrector|
+                corrector.replace(prop_node, prop_node.source
+                  .gsub('add', 'create')
+                  .gsub('delete', 'remove'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,69 +1,69 @@
-# 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
-        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the `yum_repository` resource were renamed. `url` -> `baseurl`, `keyurl` -> `gpgkey`, and `mirrorexpire` -> `mirror_expire`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   yum_repository 'OurCo' do
-        #     description 'OurCo yum repository'
-        #     url 'http://artifacts.ourco.org/foo/bar'
-        #     keyurl 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
-        #     mirrorexpire 1440
-        #     action :create
-        #   end
-        #
-        #   ### correct
-        #   yum_repository 'OurCo' do
-        #     description 'OurCo yum repository'
-        #     baseurl 'http://artifacts.ourco.org/foo/bar'
-        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
-        #     mirror_expire 1440
-        #     action :create
-        #   end
-        #
-        class DeprecatedYumRepositoryProperties < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.14'
-
-          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.'
-
-          def on_block(node)
-            %w(url keyurl mirrorexpire).each do |prop|
-              match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
-                add_offense(prop_node, severity: :warning) do |corrector|
-                  corrector.replace(prop_node, prop_node.source
-                    .gsub(/^url/, 'baseurl')
-                    .gsub(/^keyurl/, 'gpgkey')
-                    .gsub(/^mirrorexpire/, 'mirror_expire'))
-                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
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the `yum_repository` resource were renamed. `url` -> `baseurl`, `keyurl` -> `gpgkey`, and `mirrorexpire` -> `mirror_expire`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     url 'http://artifacts.ourco.org/foo/bar'
+        #     keyurl 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     mirrorexpire 1440
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   yum_repository 'OurCo' do
+        #     description 'OurCo yum repository'
+        #     baseurl 'http://artifacts.ourco.org/foo/bar'
+        #     gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6'
+        #     mirror_expire 1440
+        #     action :create
+        #   end
+        #
+        class DeprecatedYumRepositoryProperties < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.14'
+
+          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.'
+
+          def on_block(node)
+            %w(url keyurl mirrorexpire).each do |prop|
+              match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
+                add_offense(prop_node, severity: :warning) do |corrector|
+                  corrector.replace(prop_node, prop_node.source
+                    .gsub(/^url/, 'baseurl')
+                    .gsub(/^keyurl/, 'gpgkey')
+                    .gsub(/^mirrorexpire/, 'mirror_expire'))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end