cookstyle 6.5.3 → 6.10.2

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/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.5.3
+  version: 6.10.2
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-07 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.86.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.86.0
 description: 
 email:
 - thom@chef.io
@@ -57,17 +57,21 @@ files:
 - lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb
 - lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb
+- lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb
+- lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb
+- lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb
 - lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb
 - lib/rubocop/cop/chef/correctness/metadata_missing_name.rb
 - lib/rubocop/cop/chef/correctness/node_normal.rb
 - lib/rubocop/cop/chef/correctness/node_normal_unless.rb
 - lib/rubocop/cop/chef/correctness/node_save.rb
 - lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb
+- lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb
 - lib/rubocop/cop/chef/correctness/powershell_delete_file.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
@@ -96,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
@@ -115,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
@@ -204,7 +209,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
@@ -221,6 +228,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
@@ -240,9 +248,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

data/lib/rubocop/monkey_patches/commissioner.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    class Commissioner
-      def remove_irrelevant_cops(filename)
-        @cops.reject! { |cop| cop.excluded_file?(filename) }
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_ruby_version?) &&
-            !cop.class.support_target_ruby_version?(cop.target_ruby_version)
-        end
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_rails_version?) &&
-            !cop.class.support_target_rails_version?(cop.target_rails_version)
-        end
-
-        ### START COOKSTYLE MODIFICATION
-        @cops.reject! do |cop|
-          cop.class.respond_to?(:support_target_chef_version?) &&
-            !cop.class.support_target_chef_version?(cop.target_chef_version)
-        end
-        ### END COOKSTYLE MODIFICATION
-      end
-    end
-  end
-end