cookstyle 7.32.8 → 8.0.0

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

@@ -1,54 +1,54 @@
-# 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 Modernize
-        # In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   declare_action_class do
-        #     foo
-        #   end
-        #
-        #   ### correct
-        #   action_class do
-        #     foo
-        #   end
-        #
-        class DeclareActionClass < Base
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.9'
-
-          MSG = 'In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.'
-          RESTRICT_ON_SEND = [:declare_action_class].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, node.source.gsub('declare_action_class', 'action_class'))
-            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 Modernize
+        # In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   declare_action_class do
+        #     foo
+        #   end
+        #
+        #   ### correct
+        #   action_class do
+        #     foo
+        #   end
+        #
+        class DeclareActionClass < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.9'
+
+          MSG = 'In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.'
+          RESTRICT_ON_SEND = [:declare_action_class].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub('declare_action_class', 'action_class'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,74 +1,74 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019-2020, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Modernize
-        # The default actions can now be specified using the `default_action` helper instead of using the @action variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   def initialize(*args)
-        #     super
-        #     @action = :create
-        #   end
-        #
-        #   ### incorrect
-        #   def initialize(*args)
-        #     super
-        #     @default_action = :create
-        #   end
-        #
-        #  ### correct
-        #  default_action :create
-
-        class DefaultActionFromInitialize < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'
-
-          def_node_matcher :action_variable_assignment?, <<-PATTERN
-            (ivasgn {:@action :@default_action} $(...))
-          PATTERN
-
-          def_node_search :initialize_method, '(def :initialize ... )'
-
-          def_node_search :default_action_method?, '(send nil? :default_action ... )'
-
-          def on_ivasgn(node)
-            action_variable_assignment?(node) do
-              return unless initialize_method(node.parent.parent)
-              add_offense(node, severity: :refactor) do |corrector|
-                # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
-                unless default_action_method?(processed_source.ast)
-                  initialize_node = initialize_method(processed_source.ast).first
-                  corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
-                end
-
-                # remove the variable from the initialize method
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # The default actions can now be specified using the `default_action` helper instead of using the @action variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @action = :create
+        #   end
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @default_action = :create
+        #   end
+        #
+        #  ### correct
+        #  default_action :create
+
+        class DefaultActionFromInitialize < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'
+
+          def_node_matcher :action_variable_assignment?, <<-PATTERN
+            (ivasgn {:@action :@default_action} $(...))
+          PATTERN
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+
+          def_node_search :default_action_method?, '(send nil? :default_action ... )'
+
+          def on_ivasgn(node)
+            action_variable_assignment?(node) do
+              return unless initialize_method(node.parent.parent)
+              add_offense(node, severity: :refactor) do |corrector|
+                # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
+                unless default_action_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-# 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
-        # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   if defined?(ChefSpec)
-        #     def create_yum_repository(resource_name)
-        #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
-        #     end
-        #   end
-        #
-        class DefinesChefSpecMatchers < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'
-
-          def_node_matcher :chefspec_matcher?, <<-PATTERN
-            (if ( :defined? (const nil? :ChefSpec)) ... )
-          PATTERN
-
-          def on_if(node)
-            chefspec_matcher?(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
+        # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   if defined?(ChefSpec)
+        #     def create_yum_repository(resource_name)
+        #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
+        #     end
+        #   end
+        #
+        class DefinesChefSpecMatchers < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'
+
+          def_node_matcher :chefspec_matcher?, <<-PATTERN
+            (if ( :defined? (const nil? :ChefSpec)) ... )
+          PATTERN
+
+          def on_if(node)
+            chefspec_matcher?(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

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

@@ -1,36 +1,36 @@
-# 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
-        # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, common properties like not_if/only_if, and resource reporting.
-        #
-        class Definitions < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'
-
-          def on_block(node)
-            add_offense(node, severity: :refactor) if node.respond_to?(:method_name) && node.method?(:define)
-          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
+        # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, common properties like not_if/only_if, and resource reporting.
+        #
+        class Definitions < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'
+
+          def on_block(node)
+            add_offense(node, severity: :refactor) if node.respond_to?(:method_name) && node.method?(:define)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-# 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 Modernize
-        # Don't depend on the chef-vault cookbook made obsolete by Chef Infra Client 16.0. The chef-vault gem and helpers are now included in Chef Infra Client itself.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   depends 'chef-vault'
-        #
-        class DependsOnChefVaultCookbook < Base
-          extend AutoCorrector
-          extend TargetChefVersion
-          include RangeHelp
-
-          minimum_target_chef_version '16.0'
-
-          MSG = "Don't depend on the chef-vault cookbook made obsolete by Chef Infra Client 16.0. The chef-vault gem and helpers are now included in Chef Infra Client itself."
-          RESTRICT_ON_SEND = [:depends].freeze
-
-          def_node_matcher :legacy_depends?, <<-PATTERN
-            (send nil? :depends (str "chef-vault") ... )
-          PATTERN
-
-          def on_send(node)
-            legacy_depends?(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:: 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 Modernize
+        # Don't depend on the chef-vault cookbook made obsolete by Chef Infra Client 16.0. The chef-vault gem and helpers are now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'chef-vault'
+        #
+        class DependsOnChefVaultCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '16.0'
+
+          MSG = "Don't depend on the chef-vault cookbook made obsolete by Chef Infra Client 16.0. The chef-vault gem and helpers are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "chef-vault") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(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

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

@@ -1,55 +1,55 @@
-# 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 Modernize
-        # Don't depend on the chocolatey_source or chocolatey_config cookbooks made obsolete by Chef Infra Client 14.3. The chocolatey_source and chocolatey_config resources are now included in Chef Infra Client itself.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   depends 'chocolatey_source'
-        #   depends 'chocolatey_config'
-        #
-        class DependsOnChocolateyCookbooks < Base
-          extend AutoCorrector
-          extend TargetChefVersion
-          include RangeHelp
-
-          minimum_target_chef_version '14.3'
-
-          MSG = "Don't depend on the chocolatey_source or chocolatey_config cookbooks made obsolete by Chef Infra Client 14.3. The chocolatey_source and chocolatey_config resources are now included in Chef Infra Client itself."
-          RESTRICT_ON_SEND = [:depends].freeze
-
-          def_node_matcher :legacy_depends?, <<-PATTERN
-            (send nil? :depends (str {"chocolatey_source" "chocolatey_config"}) ... )
-          PATTERN
-
-          def on_send(node)
-            legacy_depends?(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:: 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 Modernize
+        # Don't depend on the chocolatey_source or chocolatey_config cookbooks made obsolete by Chef Infra Client 14.3. The chocolatey_source and chocolatey_config resources are now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'chocolatey_source'
+        #   depends 'chocolatey_config'
+        #
+        class DependsOnChocolateyCookbooks < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.3'
+
+          MSG = "Don't depend on the chocolatey_source or chocolatey_config cookbooks made obsolete by Chef Infra Client 14.3. The chocolatey_source and chocolatey_config resources are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"chocolatey_source" "chocolatey_config"}) ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(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