cookstyle 7.32.8 → 8.1.1

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

@@ -1,48 +1,48 @@
-# 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
-        # Some providers in resources override the provides? method, used to check whether they are a valid provider on the current platform. In Chef Infra Client 13, this will cause an error. Instead use `provides :SOME_PROVIDER_NAME` to register the provider.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   def provides?
-        #    true
-        #   end
-        #
-        #   ### correct
-        #   provides :SOME_PROVIDER_NAME
-        #
-        class ResourceOverridesProvidesMethod < Base
-          MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
-
-          def_node_search :calls_provides?, '(send nil? :provides ...)'
-
-          def on_def(node)
-            return unless node.method?(:provides?)
-
-            add_offense(node, severity: :warning) unless calls_provides?(processed_source.ast)
-          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
+        # Some providers in resources override the provides? method, used to check whether they are a valid provider on the current platform. In Chef Infra Client 13, this will cause an error. Instead use `provides :SOME_PROVIDER_NAME` to register the provider.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def provides?
+        #    true
+        #   end
+        #
+        #   ### correct
+        #   provides :SOME_PROVIDER_NAME
+        #
+        class ResourceOverridesProvidesMethod < Base
+          MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
+
+          def_node_search :calls_provides?, '(send nil? :provides ...)'
+
+          def on_def(node)
+            return unless node.method?(:provides?)
+
+            add_offense(node, severity: :warning) unless calls_provides?(processed_source.ast)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,46 +1,46 @@
-# 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 use the dsl_name method in a resource to find the name of the resource. Use the resource_name method instead. dsl_name was removed in Chef Infra Client 13 and will now result in an error.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   my_resource = MyResource.dsl_name
-        #
-        #   ### correct
-        #   my_resource = MyResource.resource_name
-        #
-        class ResourceUsesDslNameMethod < Base
-          MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'
-          RESTRICT_ON_SEND = [:dsl_name].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :warning)
-          end
-
-          # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from
-          # this might not be worth it yet based on the number of these we'd run into and the false auto correct potential
-        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 use the dsl_name method in a resource to find the name of the resource. Use the resource_name method instead. dsl_name was removed in Chef Infra Client 13 and will now result in an error.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   my_resource = MyResource.dsl_name
+        #
+        #   ### correct
+        #   my_resource = MyResource.resource_name
+        #
+        class ResourceUsesDslNameMethod < Base
+          MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'
+          RESTRICT_ON_SEND = [:dsl_name].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning)
+          end
+
+          # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from
+          # this might not be worth it yet based on the number of these we'd run into and the false auto correct potential
+        end
+      end
+    end
+  end
+end

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

@@ -1,84 +1,84 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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
-        # Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   mycookbook/resources/myresource.rb:
-        #   resource_name :mycookbook_myresource
-        #
-        class ResourceUsesOnlyResourceName < Base
-          include RuboCop::Chef::CookbookHelpers
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'
-          RESTRICT_ON_SEND = [:resource_name].freeze
-
-          def_node_matcher :resource_name?, '(send nil? :resource_name (sym $_ ))'
-
-          def_node_search :cb_name_match, '(send nil? :name (str $_))'
-
-          def_node_search :provides, '(send nil? :provides (sym $_) ...)'
-
-          # determine the cookbook name either by parsing metadata.rb or by parsing metadata.json
-          #
-          # @return [String] the cookbook name
-          def cookbook_name
-            cb_path = File.expand_path(File.join(processed_source.file_path, '../..'))
-
-            if File.exist?(File.join(cb_path, 'metadata.rb'))
-              cb_metadata_ast = ProcessedSource.from_file(File.join(cb_path, 'metadata.rb'), @config.target_ruby_version).ast
-              cb_name_match(cb_metadata_ast).first
-            elsif File.exist?(File.join(cb_path, 'metadata.json')) # this exists only for supermarket files that lack metadata.rb
-              JSON.parse(File.read(File.join(cb_path, 'metadata.json')))['name']
-            end
-          end
-
-          # given a resource name make sure there's a provides that matches that name
-          #
-          # @return [TrueClass, FalseClass]
-          def valid_provides?(resource_name)
-            provides_ast = provides(processed_source.ast)
-            return false unless provides_ast
-
-            provides_ast.include?(resource_name)
-          end
-
-          def on_send(node)
-            resource_name?(node) do |name|
-              return if valid_provides?(name)
-              add_offense(node, severity: :warning) do |corrector|
-                if name.to_s == "#{cookbook_name}_#{File.basename(processed_source.path, '.rb')}"
-                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-                else
-                  corrector.insert_after(node.source_range, "\n#{node.source.gsub('resource_name', 'provides')}")
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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
+        # Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   mycookbook/resources/myresource.rb:
+        #   resource_name :mycookbook_myresource
+        #
+        class ResourceUsesOnlyResourceName < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'
+          RESTRICT_ON_SEND = [:resource_name].freeze
+
+          def_node_matcher :resource_name?, '(send nil? :resource_name (sym $_ ))'
+
+          def_node_search :cb_name_match, '(send nil? :name (str $_))'
+
+          def_node_search :provides, '(send nil? :provides (sym $_) ...)'
+
+          # determine the cookbook name either by parsing metadata.rb or by parsing metadata.json
+          #
+          # @return [String] the cookbook name
+          def cookbook_name
+            cb_path = File.expand_path(File.join(processed_source.file_path, '../..'))
+
+            if File.exist?(File.join(cb_path, 'metadata.rb'))
+              cb_metadata_ast = ProcessedSource.from_file(File.join(cb_path, 'metadata.rb'), @config.target_ruby_version).ast
+              cb_name_match(cb_metadata_ast).first
+            elsif File.exist?(File.join(cb_path, 'metadata.json')) # this exists only for supermarket files that lack metadata.rb
+              JSON.parse(File.read(File.join(cb_path, 'metadata.json')))['name']
+            end
+          end
+
+          # given a resource name make sure there's a provides that matches that name
+          #
+          # @return [TrueClass, FalseClass]
+          def valid_provides?(resource_name)
+            provides_ast = provides(processed_source.ast)
+            return false unless provides_ast
+
+            provides_ast.include?(resource_name)
+          end
+
+          def on_send(node)
+            resource_name?(node) do |name|
+              return if valid_provides?(name)
+              add_offense(node, severity: :warning) do |corrector|
+                if name.to_s == "#{cookbook_name}_#{File.basename(processed_source.path, '.rb')}"
+                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+                else
+                  corrector.insert_after(node.source_range, "\n#{node.source.gsub('resource_name', 'provides')}")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,40 +1,40 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-module RuboCop
-  module Cop
-    module Chef
-      module Deprecations
-        # The Resource.provider_base allows the developer to specify within a resource a module to load the resource's provider from. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   provider_base ::Chef::Provider::SomethingSomething
-        #
-        class ResourceUsesProviderBaseMethod < Base
-          MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
-          RESTRICT_ON_SEND = [:provider_base].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :warning)
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Deprecations
+        # The Resource.provider_base allows the developer to specify within a resource a module to load the resource's provider from. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   provider_base ::Chef::Provider::SomethingSomething
+        #
+        class ResourceUsesProviderBaseMethod < Base
+          MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
+          RESTRICT_ON_SEND = [:provider_base].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,50 +1,50 @@
-# 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 call the deprecated `updated=` method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a `converge_by` block. Documentation on using the `converge_by` block can be found at https://docs.chef.io/custom_resources/.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   action :foo do
-        #     updated = true
-        #   end
-        #
-        #   ### correct
-        #   action :foo do
-        #     converge_by('resource did something') do
-        #       # code that causes the resource to converge
-        #     end
-        #
-        class ResourceUsesUpdatedMethod < Base
-          MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."
-
-          def on_lvasgn(node)
-            add_offense(node, severity: :warning) if node.node_parts.first == :updated
-          end
-
-          # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from
-          # this might not be worth it yet based on the number of these we'd run into and the false auto correct potential
-        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 call the deprecated `updated=` method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a `converge_by` block. Documentation on using the `converge_by` block can be found at https://docs.chef.io/custom_resources/.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   action :foo do
+        #     updated = true
+        #   end
+        #
+        #   ### correct
+        #   action :foo do
+        #     converge_by('resource did something') do
+        #       # code that causes the resource to converge
+        #     end
+        #
+        class ResourceUsesUpdatedMethod < Base
+          MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."
+
+          def on_lvasgn(node)
+            add_offense(node, severity: :warning) if node.node_parts.first == :updated
+          end
+
+          # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from
+          # this might not be worth it yet based on the number of these we'd run into and the false auto correct potential
+        end
+      end
+    end
+  end
+end