cookstyle 6.6.9 → 6.11.4

data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb

@@ -0,0 +1,60 @@
+#
+# Copyright:: 2020, 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 ChefRedundantCode
+        # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
+        #
+        # @example
+        #
+        #   # bad
+        #   platform?('redhat') || platform?('ubuntu')
+        #   platform_family?('debian') || platform_family?('rhel')
+        #
+        #   # good
+        #   platform?('redhat', 'ubuntu')
+        #   platform_family?('debian', 'rhel')
+        #
+        class MultiplePlatformChecks < Cop
+          MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'.freeze
+
+          def_node_matcher :or_platform_helpers?, <<-PATTERN
+            (or (send nil? ${:platform? :platform_family?} $_ )* )
+          PATTERN
+
+          def on_or(node)
+            or_platform_helpers?(node) do |helpers, _plats|
+              # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if helpers.uniq.size == 1
+            end
+          end
+
+          def autocorrect(node)
+            or_platform_helpers?(node) do |type, plats|
+              lambda do |corrector|
+                new_string = "#{type.first}(#{plats.map(&:source).join(', ')})"
+                corrector.replace(node.loc.expression, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb

@@ -0,0 +1,68 @@
+#
+# Copyright:: 2020, 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 ChefRedundantCode
+        # Many Ohai node attributes are already strings and don't need to be cast to strings again
+        #
+        # @example
+        #
+        #   # bad
+        #   node['platform'].to_s
+        #   node['platform_family'].to_s
+        #   node['platform_version'].to_s
+        #   node['fqdn'].to_s
+        #   node['hostname'].to_s
+        #   node['os'].to_s
+        #   node['name'].to_s
+        #
+        #   # good
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['fqdn']
+        #   node['hostname']
+        #   node['os']
+        #   node['name']
+        #
+        class OhaiAttributeToString < Cop
+          MSG = "This Ohai node attribute is already a string and doesn't need to be converted".freeze
+
+          def_node_matcher :platform_to_s?, <<-PATTERN
+            (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
+          PATTERN
+
+          def on_send(node)
+            platform_to_s?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            platform_to_s?(node) do |method|
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "node['#{method.value}']")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb

@@ -0,0 +1,59 @@
+#
+# Copyright:: Copyright 2020, 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 ChefSharing
+        # Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        #
+        # @example
+        #
+        #   # good
+        #   examples <<~DOC
+        #     **Specify a global domain value**
+        #
+        #     ```ruby
+        #     macos_userdefaults 'full keyboard access to all controls' do
+        #       key 'AppleKeyboardUIMode'
+        #       value '2'
+        #     end
+        #     ```
+        #   DOC
+        #
+        class IncludeResourceExamples < Cop
+          include RangeHelp
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.9'
+
+          MSG = 'Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze
+
+          def investigate(processed_source)
+            return if processed_source.blank?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(nil, location: range, message: MSG, severity: :refactor) unless resource_examples(processed_source.ast).any?
+          end
+
+          def_node_search :resource_examples, '(send nil? :examples dstr ...)'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb

@@ -483,7 +483,7 @@ module RuboCop
 
           def valid_license?(license)
             VALID_LICENSE_STRING.include?(license) ||
-              license.downcase == 'all rights reserved'
+              license.casecmp('all rights reserved') == 0
           end
         end
       end

data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb

@@ -0,0 +1,57 @@
+#
+# Copyright:: 2020, 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 ChefStyle
+        # There is no need to wrap the recipe in parentheses when using the include_recipe helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe('foo::bar')
+        #
+        #   # good
+        #   include_recipe 'foo::bar'
+        #
+        class IncludeRecipeWithParentheses < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'There is no need to wrap the recipe in parentheses when using the include_recipe helper'.freeze
+
+          def_node_matcher :include_recipe?, <<-PATTERN
+            (send nil? :include_recipe $(str _))
+          PATTERN
+
+          def on_send(node)
+            include_recipe?(node) do |recipe|
+              return unless node.parenthesized?
+
+              # avoid chefspec: expect(chef_run).to include_recipe('foo')
+              return if node.parent&.send_type?
+
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "include_recipe #{recipe.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/monkey_patches/registry_cop.rb

@@ -0,0 +1,14 @@
+module RuboCop
+  module Cop
+    class Registry
+      # we monkeypatch this warning to replace rubocop with cookstyle
+      def print_warning(name, path)
+        message = "#{path}: Warning: no department given for #{name}."
+        if path.end_with?('.rb')
+          message += ' Run `cookstyle -a --only Migration/DepartmentName` to fix.'
+        end
+        warn message
+      end
+    end
+  end
+end

data/lib/rubocop/monkey_patches/team.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    class Team
+      def support_target_chef_version?(cop)
+        return true unless cop.class.respond_to?(:support_target_chef_version?)
+
+        cop.class.support_target_chef_version?(cop.target_chef_version)
+      end
+
+      ### START COOKSTYLE MODIFICATION
+      def roundup_relevant_cops(filename)
+        cops.reject do |cop|
+          cop.excluded_file?(filename) ||
+            !support_target_ruby_version?(cop) ||
+            !support_target_chef_version?(cop) ||
+            !support_target_rails_version?(cop)
+        end
+      end
+      ### END COOKSTYLE MODIFICATION
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.6.9
+  version: 6.11.4
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.87.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.87.1
 description: 
 email:
 - thom@chef.io
@@ -100,6 +100,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb
 - lib/rubocop/cop/chef/deprecation/epic_fail.rb
 - lib/rubocop/cop/chef/deprecation/erl_call.rb
+- lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb
 - lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb
 - lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb
 - lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb
@@ -119,9 +120,9 @@ files:
 - 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_only_resource_name.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/resource_without_name_or_provides.rb
 - lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb
 - lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
 - lib/rubocop/cop/chef/deprecation/run_command_helper.rb
@@ -148,6 +149,7 @@ files:
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
 - lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
 - lib/rubocop/cop/chef/modernize/compile_time_resources.rb
+- lib/rubocop/cop/chef/modernize/conditional_using_test.rb
 - lib/rubocop/cop/chef/modernize/cron_manage_resource.rb
 - lib/rubocop/cop/chef/modernize/databag_helpers.rb
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
@@ -208,7 +210,9 @@ files:
 - lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb
 - lib/rubocop/cop/chef/redundant/grouping_metadata.rb
 - lib/rubocop/cop/chef/redundant/long_description_metadata.rb
+- lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb
 - lib/rubocop/cop/chef/redundant/name_property_and_required.rb
+- lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb
 - lib/rubocop/cop/chef/redundant/property_splat_regex.rb
 - lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb
 - lib/rubocop/cop/chef/redundant/provides_metadata.rb
@@ -225,6 +229,7 @@ files:
 - lib/rubocop/cop/chef/sharing/empty_metadata_field.rb
 - lib/rubocop/cop/chef/sharing/include_property_descriptions.rb
 - lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb
+- lib/rubocop/cop/chef/sharing/include_resource_examples.rb
 - lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb
 - lib/rubocop/cop/chef/sharing/invalid_license_string.rb
 - lib/rubocop/cop/chef/style/attribute_keys.rb
@@ -235,6 +240,7 @@ files:
 - lib/rubocop/cop/chef/style/comments_format.rb
 - lib/rubocop/cop/chef/style/file_mode.rb
 - lib/rubocop/cop/chef/style/immediate_notification_timing.rb
+- lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb
 - lib/rubocop/cop/chef/style/negating_only_if.rb
 - lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb
 - lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb
@@ -244,9 +250,10 @@ files:
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
 - lib/rubocop/cop/target_chef_version.rb
 - lib/rubocop/monkey_patches/comment_config.rb
-- lib/rubocop/monkey_patches/commissioner.rb
 - lib/rubocop/monkey_patches/config.rb
 - lib/rubocop/monkey_patches/cop.rb
+- lib/rubocop/monkey_patches/registry_cop.rb
+- lib/rubocop/monkey_patches/team.rb
 homepage: 
 licenses:
 - Apache-2.0

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

@@ -1,81 +0,0 @@
-#
-# Copyright:: 2020, 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
-        # In Chef Infra Client 16 and later a legacy HWRP resource must use either `resource_name` or `provides` to define the resource name.
-        #
-        # @example
-        #
-        #   # bad
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #  # good
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         resource_name :ulimit_rule
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #  # better
-        #  Convert your legacy HWRPs to custom resources
-        #
-        class ResourceWithoutNameOrProvides < Cop
-          MSG = 'In Chef Infra Client 16 and later legacy HWRP resources must use either `resource_name` or `provides` to define the resource name.'.freeze
-
-          def_node_matcher :HWRP?, <<-PATTERN
-          (class
-            (const nil? :Chef) nil?
-            (class
-              (const nil? :Resource) nil?
-              $(class
-                (const nil? ... )
-                (const
-                  (const nil? :Chef) :Resource)
-                  (begin ... ))))
-          PATTERN
-
-          def_node_search :provides_or_resource_name?, '(send nil? {:provides :resource_name} ...)'
-
-          def on_class(node)
-            HWRP?(node) do |inherit|
-              add_offense(inherit, location: :expression, message: MSG, severity: :warning) if provides_or_resource_name?(processed_source.ast).nil?
-            end
-          end
-        end
-      end
-    end
-  end
-end