cookstyle 7.32.8 → 8.0.0

data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.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
-        # Use node['platform_version'] and node['kernel'] data instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Windows::VersionHelper.nt_version
-        #   Windows::VersionHelper.server_version?
-        #   Windows::VersionHelper.core_version?
-        #   Windows::VersionHelper.workstation_version?
-        #
-        #   ### correct
-        #   node['platform_version'].to_f
-        #   node['kernel']['product_type'] == 'Server'
-        #   node['kernel']['server_core']
-        #   node['kernel']['product_type'] == 'Workstation'
-        #
-        class WindowsVersionHelpers < Base
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '14.0'
-
-          MSG = "Use node['platform_version'] and node['kernel'] data introduced in Chef Infra Client 14 instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook."
-          RESTRICT_ON_SEND = [:nt_version, :server_version?, :core_version?, :workstation_version?].freeze
-
-          def_node_matcher :windows_helper?, <<-PATTERN
-            (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )
-          PATTERN
-
-          def on_send(node)
-            windows_helper?(node) do |method|
-              add_offense(node, severity: :refactor) do |corrector|
-                case method
-                when :nt_version
-                  corrector.replace(node, 'node[\'platform_version\'].to_f')
-                when :server_version?
-                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
-                when :core_version?
-                  corrector.replace(node, 'node[\'kernel\'][\'server_core\']')
-                when :workstation_version?
-                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
-                end
-              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
+        # Use node['platform_version'] and node['kernel'] data instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Windows::VersionHelper.nt_version
+        #   Windows::VersionHelper.server_version?
+        #   Windows::VersionHelper.core_version?
+        #   Windows::VersionHelper.workstation_version?
+        #
+        #   ### correct
+        #   node['platform_version'].to_f
+        #   node['kernel']['product_type'] == 'Server'
+        #   node['kernel']['server_core']
+        #   node['kernel']['product_type'] == 'Workstation'
+        #
+        class WindowsVersionHelpers < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = "Use node['platform_version'] and node['kernel'] data introduced in Chef Infra Client 14 instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook."
+          RESTRICT_ON_SEND = [:nt_version, :server_version?, :core_version?, :workstation_version?].freeze
+
+          def_node_matcher :windows_helper?, <<-PATTERN
+            (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )
+          PATTERN
+
+          def on_send(node)
+            windows_helper?(node) do |method|
+              add_offense(node, severity: :refactor) do |corrector|
+                case method
+                when :nt_version
+                  corrector.replace(node, 'node[\'platform_version\'].to_f')
+                when :server_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
+                when :core_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'server_core\']')
+                when :workstation_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# 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
-        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include_recipe 'xml::ruby'
-        #
-        class IncludingXMLRubyRecipe < Base
-          extend AutoCorrector
-
-          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
-
-          def_node_matcher :xml_ruby_recipe?, <<-PATTERN
-            (send nil? :include_recipe (str "xml::ruby"))
-          PATTERN
-
-          def on_send(node)
-            xml_ruby_recipe?(node) do
-              node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(node)
-              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
+        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'xml::ruby'
+        #
+        class IncludingXMLRubyRecipe < Base
+          extend AutoCorrector
+
+          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :xml_ruby_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str "xml::ruby"))
+          PATTERN
+
+          def on_send(node)
+            xml_ruby_recipe?(node) do
+              node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(node)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.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 Deprecations
-        # Don't include the deprecated yum DNF compatibility recipe, which is no longer necessary
-        # as Chef Infra Client includes DNF package support
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include_recipe 'yum::dnf_yum_compat'
-        #
-        class IncludingYumDNFCompatRecipe < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
-
-          def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
-            (send nil? :include_recipe (str "yum::dnf_yum_compat"))
-          PATTERN
-
-          def on_send(node)
-            yum_dnf_compat_recipe_usage?(node) do
-              node = node.parent if node.parent&.conditional? && node.parent&.single_line?
-              add_offense(node, severity: :warning) 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 Deprecations
+        # Don't include the deprecated yum DNF compatibility recipe, which is no longer necessary
+        # as Chef Infra Client includes DNF package support
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'yum::dnf_yum_compat'
+        #
+        class IncludingYumDNFCompatRecipe < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str "yum::dnf_yum_compat"))
+          PATTERN
+
+          def on_send(node)
+            yum_dnf_compat_recipe_usage?(node) do
+              node = node.parent if node.parent&.conditional? && node.parent&.single_line?
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/berksfile.rb

@@ -1,39 +1,39 @@
-# 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 Effortless
-        # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
-        #
-        class Berksfile < Base
-          include RangeHelp
-
-          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'
-
-          def on_new_investigation
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            range = source_range(processed_source.buffer, 1, 0)
-
-            add_offense(range, severity: :refactor)
-          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 Effortless
+        # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
+        #
+        class Berksfile < Base
+          include RangeHelp
+
+          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'
+
+          def on_new_investigation
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb

@@ -1,87 +1,87 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, Chef Software Inc.
-# Author:: Scott Vidmar (<svidmar@chef.io>)
-#
-# 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 Effortless
-        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   require 'chef-vault'
-        #
-        #   ### incorrect
-        #   ChefVault::Item
-        #
-        #   ### incorrect
-        #   include_recipe 'chef-vault'
-        #
-        #   ### incorrect
-        #   chef_gem 'chef-vault'
-        #
-        #   ### incorrect
-        #   chef_vault_item_for_environment(arg, arg1)
-        #
-        #   ### incorrect
-        #   chef_vault_item(arg, arg1)
-        #
-        class ChefVaultUsed < Base
-          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
-          RESTRICT_ON_SEND = [:chef_vault_item,
-                              :chef_vault_item_for_environment,
-                              :include_recipe,
-                              :require,
-                              :chef_gem].freeze
-
-          def_node_matcher :require?, <<-PATTERN
-            (send nil? { :require :include_recipe :chef_gem }
-              (str "chef-vault"))
-          PATTERN
-
-          def_node_matcher :vault_const?, <<-PATTERN
-            (const
-              (const nil? :ChefVault)
-              :Item)
-          PATTERN
-
-          def_node_matcher :chef_vault_item_for_environment?, <<-PATTERN
-            (send nil? :chef_vault_item_for_environment _ _)
-          PATTERN
-
-          def_node_matcher :chef_vault_item?, <<-PATTERN
-            (send nil? :chef_vault_item _ _)
-          PATTERN
-
-          def on_send(node)
-            return unless require?(node) ||
-                          chef_vault_item_for_environment?(node) ||
-                          chef_vault_item?(node)
-            add_offense(node.loc.expression, severity: :refactor)
-          end
-
-          def on_const(node)
-            vault_const?(node) do
-              add_offense(node.loc.expression, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@chef.io>)
+#
+# 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 Effortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chef-vault'
+        #
+        #   ### incorrect
+        #   ChefVault::Item
+        #
+        #   ### incorrect
+        #   include_recipe 'chef-vault'
+        #
+        #   ### incorrect
+        #   chef_gem 'chef-vault'
+        #
+        #   ### incorrect
+        #   chef_vault_item_for_environment(arg, arg1)
+        #
+        #   ### incorrect
+        #   chef_vault_item(arg, arg1)
+        #
+        class ChefVaultUsed < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:chef_vault_item,
+                              :chef_vault_item_for_environment,
+                              :include_recipe,
+                              :require,
+                              :chef_gem].freeze
+
+          def_node_matcher :require?, <<-PATTERN
+            (send nil? { :require :include_recipe :chef_gem }
+              (str "chef-vault"))
+          PATTERN
+
+          def_node_matcher :vault_const?, <<-PATTERN
+            (const
+              (const nil? :ChefVault)
+              :Item)
+          PATTERN
+
+          def_node_matcher :chef_vault_item_for_environment?, <<-PATTERN
+            (send nil? :chef_vault_item_for_environment _ _)
+          PATTERN
+
+          def_node_matcher :chef_vault_item?, <<-PATTERN
+            (send nil? :chef_vault_item _ _)
+          PATTERN
+
+          def on_send(node)
+            return unless require?(node) ||
+                          chef_vault_item_for_environment?(node) ||
+                          chef_vault_item?(node)
+            add_offense(node.loc.expression, severity: :refactor)
+          end
+
+          def on_const(node)
+            vault_const?(node) do
+              add_offense(node.loc.expression, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end