cookstyle 5.6.5 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffca3b8387e0818808debc42526209312332b497559ed017b37f772187bca663
-  data.tar.gz: 769bbde3f4becf66b92311d728b7d2b5d14924d18c2ebe4a77cc31c6bc95fbf0
+  metadata.gz: e79627357ca125484e3ab900401f64dfef191b650282118279129b9fc3e1e65c
+  data.tar.gz: c6633c204e5cf76711518d7f25cbb03c49814eb4a0534bf108fba69bd58c4f61
 SHA512:
-  metadata.gz: 59ec17831658cb6712d866f71af9d1dcb59c2f81f98760f5966394cdf6e22c6e0b580a2e2cb8e069486d401dfdef7e0595769fd4c117c3d074270b72a7e2c8d5
-  data.tar.gz: 8f062dd18cdb2e65b96285d5683397229109369db6f7d562af7e0d0ac61133cdbda34205ae340e37c5bc2589c8c8de7044204ab9625c45153e8d0df25d4ebf77
+  metadata.gz: 04db3d494e31f545987ee9a5d74b5b238fb22e5a3c46904cee0956f3903c5402a0cedb1f922270a54eec3fa44691af0e79767e0fa2cf643bdd727e5d28abf30b
+  data.tar.gz: b7459b727077fc0079872053a7f7dd4c07822e254a6c9476d99390d22dcf4b7c9284ca5aa1b908ba66673fd9f2116495eacfb19706b3cf69ce6d0c57d282f12b

data/config/cookstyle.yml

@@ -412,6 +412,50 @@ ChefDeprecations/WindowsTaskChangeAction:
   Exclude:
     - '**/metadata.rb'
 
+ChefDeprecations/ResourceOverridesProvidesMethod:
+  Description: 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.
+  Enabled: true
+  VersionAdded: '5.7.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/providers/*.rb'
+    - '**/resources/*.rb'
+
+ChefDeprecations/ResourceUsesDslNameMethod:
+  Description: Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.
+  Enabled: true
+  VersionAdded: '5.7.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/providers/*.rb'
+    - '**/resources/*.rb'
+
+ChefDeprecations/ResourceUsesUpdatedMethod:
+  Description: Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later.
+  Enabled: false # has a high potential for false positives
+  VersionAdded: '5.7.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/providers/*.rb'
+    - '**/resources/*.rb'
+
+ChefDeprecations/NamePropertyWithDefaultValue:
+  Description: A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later.
+  Enabled: true
+  VersionAdded: '5.7.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/providers/*.rb'
+    - '**/resources/*.rb'
+
+ChefDeprecations/ResourceUsesProviderBaseMethod:
+  Description: 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.
+  Enabled: true
+  VersionAdded: '5.7.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.6.5".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.7.0".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.72.0'.freeze
 end

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

@@ -29,7 +29,7 @@ module RuboCop
           MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
 
           def_node_matcher :depends_partial_search?, <<-PATTERN
-            (send nil? :depends (str {"partial_search"}))
+            (send nil? :depends (str "partial_search"))
           PATTERN
 
           def on_send(node)

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

@@ -0,0 +1,67 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # A custom resource property can't be marked as a name_property and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :config_file, String, default: 'foo', name_property: true
+        #
+        #   # good
+        #   property :config_file, String, name_property: true
+        #
+        class NamePropertyWithDefaultValue < Cop
+          MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later.".freeze
+
+          def on_send(node)
+            if default_value?(node) && property_is_name_property?(node)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          private
+
+          def property_is_name_property?(node)
+            if node.method_name == :property
+              node.arguments.each do |arg|
+                if arg.type == :hash
+                  return true if arg.source.match?(/name_property:\s*true/)
+                end
+              end
+              false # no required: true found
+            end
+          end
+
+          def default_value?(node)
+            if node.method_name == :property
+              node.arguments.each do |arg|
+                if arg.type == :hash
+                  return true if arg.source.match?(/default:\s/)
+                end
+              end
+              false # no default: found
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # 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
+        #
+        #   # bad
+        #   def provides?
+        #    true
+        #   end
+        #
+        #   # good
+        #   provides :SOME_PROVIDER_NAME
+        #
+        class ResourceOverridesProvidesMethod < Cop
+          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.".freeze
+
+          def_node_search :provides, '(send nil? :provides ...)'
+
+          def on_def(node)
+            if node.method_name == :provides?
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if provides(processed_source.ast).count == 0
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # 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
+        #
+        #   # bad
+        #   my_resource = MyResource.dsl_name
+        #
+        #   # good
+        #   my_resource = MyResource.resource_name
+        #
+        class ResourceUsesDslNameMethod < Cop
+          MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'.freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :dsl_name
+          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_provider_base_method.rb

@@ -0,0 +1,38 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # 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
+        #
+        #   # bad
+        #   provider_base ::Chef::Provider::SomethingSomething
+        #
+        class ResourceUsesProviderBaseMethod < Cop
+          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.".freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provider_base
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@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 ChefDeprecations
+        # 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.html.
+        #
+        # @example
+        #
+        #   # bad
+        #   action :foo do
+        #     updated = true
+        #   end
+        #
+        #   # good
+        #   action :foo do
+        #     converge_by('resource did something) do
+        #       # code that causes the resource to converge
+        #     end
+        #
+        class ResourceUsesUpdatedMethod < Cop
+          MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later.".freeze
+
+          def on_lvasgn(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) 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

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

@@ -18,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Don't depend the zypper cookbook as the zypper_repository resource is built into
-        # Chef Infra Client 13.3
+        # Don't depend the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3
         #
         # @example
         #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.6.5
+  version: 5.7.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -109,6 +109,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb
 - lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb
 - lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
+- lib/rubocop/cop/chef/deprecation/name_property_and_default.rb
 - lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb
 - lib/rubocop/cop/chef/deprecation/node_set.rb
 - lib/rubocop/cop/chef/deprecation/node_set_unless.rb
@@ -116,6 +117,10 @@ files:
 - lib/rubocop/cop/chef/deprecation/recipe_metadata.rb
 - lib/rubocop/cop/chef/deprecation/replaces_metadata.rb
 - lib/rubocop/cop/chef/deprecation/require_recipe.rb
+- lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
+- lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb
+- lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb
+- lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb
 - lib/rubocop/cop/chef/deprecation/suggests_metadata.rb
 - lib/rubocop/cop/chef/deprecation/use_inline_resources.rb
 - lib/rubocop/cop/chef/deprecation/user_supports_property.rb