cookstyle 7.32.8 → 8.1.1

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

@@ -1,60 +1,60 @@
-# 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 built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Mixlib::ShellOut.new('foo').run_command
-        #
-        #   ### correct
-        #   shell_out('foo')
-        #
-        class ShellOutHelper < Base
-          extend AutoCorrector
-          extend TargetChefVersion
-
-          minimum_target_chef_version '12.11'
-
-          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
-          RESTRICT_ON_SEND = [:run_command].freeze
-
-          def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
-          (send
-            (send
-              (const
-                (const nil? :Mixlib) :ShellOut) :new
-              $(...)) :run_command)
-          PATTERN
-
-          def on_send(node)
-            mixlib_shellout_run_cmd?(node) do |cmd|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "shell_out(#{cmd.source})")
-              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
+        # Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Mixlib::ShellOut.new('foo').run_command
+        #
+        #   ### correct
+        #   shell_out('foo')
+        #
+        class ShellOutHelper < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.11'
+
+          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
+          RESTRICT_ON_SEND = [:run_command].freeze
+
+          def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
+          (send
+            (send
+              (const
+                (const nil? :Mixlib) :ShellOut) :new
+              $(...)) :run_command)
+          PATTERN
+
+          def on_send(node)
+            mixlib_shellout_run_cmd?(node) do |cmd|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "shell_out(#{cmd.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,58 +1,58 @@
-# 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 Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   execute 'install package foo' do
-        #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
-        #   end
-        #
-        #  powershell_script 'add artifactory choco source' do
-        #    code "choco source add -n=artifactory -s='https://mycorp.jfrog.io/mycorp/api/nuget/chocolatey-remote' -u foo -p bar"x
-        #    not_if 'choco source list | findstr artifactory'
-        #  end
-        #
-        class ShellOutToChocolatey < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
-
-          def on_block(node)
-            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              next unless property_data && property_data.match?(/^choco /i)
-              add_offense(node, severity: :refactor)
-            end
-
-            match_property_in_resource?(:execute, 'command', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              next unless property_data && property_data.match?(/^choco /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 Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'install package foo' do
+        #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
+        #   end
+        #
+        #  powershell_script 'add artifactory choco source' do
+        #    code "choco source add -n=artifactory -s='https://mycorp.jfrog.io/mycorp/api/nuget/chocolatey-remote' -u foo -p bar"x
+        #    not_if 'choco source list | findstr artifactory'
+        #  end
+        #
+        class ShellOutToChocolatey < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,63 +1,63 @@
-# 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
-        # The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net, which should be used to simplify the resource code in your cookbooks.
-        #
-        # @example
-        #
-        #  ### incorrect
-        #    apt_repository 'atom-ppa' do
-        #      uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
-        #      components ['main']
-        #      keyserver 'keyserver.ubuntu.com'
-        #      key 'C2518248EEA14886'
-        #    end
-        #
-        #  ### correct
-        #    apt_repository 'atom-ppa' do
-        #      uri 'ppa:webupd8team/atom'
-        #      components ['main']
-        #      keyserver 'keyserver.ubuntu.com'
-        #      key 'C2518248EEA14886'
-        #    end
-        #
-        class SimplifyAptPpaSetup < Base
-          extend AutoCorrector
-          include RangeHelp
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'
-
-          def on_block(node)
-            match_property_in_resource?(:apt_repository, 'uri', node) do |uri|
-              if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
-                add_offense(uri, severity: :refactor) do |corrector|
-                  next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
-                  corrector.replace(uri, "uri 'ppa:#{replacement_val}'")
-                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
+        # The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net, which should be used to simplify the resource code in your cookbooks.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #    apt_repository 'atom-ppa' do
+        #      uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
+        #      components ['main']
+        #      keyserver 'keyserver.ubuntu.com'
+        #      key 'C2518248EEA14886'
+        #    end
+        #
+        #  ### correct
+        #    apt_repository 'atom-ppa' do
+        #      uri 'ppa:webupd8team/atom'
+        #      components ['main']
+        #      keyserver 'keyserver.ubuntu.com'
+        #      key 'C2518248EEA14886'
+        #    end
+        #
+        class SimplifyAptPpaSetup < Base
+          extend AutoCorrector
+          include RangeHelp
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'uri', node) do |uri|
+              if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
+                add_offense(uri, severity: :refactor) do |corrector|
+                  next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
+                  corrector.replace(uri, "uri 'ppa:#{replacement_val}'")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# 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
-        # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   sysctl_param 'fs.aio-max-nr' do
-        #     value '1048576'
-        #   end
-        #
-        #   ### correct
-        #   sysctl 'fs.aio-max-nr' do
-        #     value '1048576'
-        #   end
-        #
-        class SysctlParamResource < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'
-          RESTRICT_ON_SEND = [:sysctl_param].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, node.source.gsub(/^sysctl_param/, 'sysctl'))
-            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
+        # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   sysctl_param 'fs.aio-max-nr' do
+        #     value '1048576'
+        #   end
+        #
+        #   ### correct
+        #   sysctl 'fs.aio-max-nr' do
+        #     value '1048576'
+        #   end
+        #
+        class SysctlParamResource < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:sysctl_param].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^sysctl_param/, 'sysctl'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# 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
-        # Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   require 'mixlib/shellout'
-        #
-        class UnnecessaryMixlibShelloutRequire < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
-          RESTRICT_ON_SEND = [:require].freeze
-
-          def_node_matcher :require_mixlibshellout?, <<-PATTERN
-          (send nil? :require ( str "mixlib/shellout"))
-          PATTERN
-
-          def on_send(node)
-            require_mixlibshellout?(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
+        # Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'mixlib/shellout'
+        #
+        class UnnecessaryMixlibShelloutRequire < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def_node_matcher :require_mixlibshellout?, <<-PATTERN
+          (send nil? :require ( str "mixlib/shellout"))
+          PATTERN
+
+          def on_send(node)
+            require_mixlibshellout?(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