cookstyle 6.9.0 → 6.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b65eaf5352ddaf7aa98b395f94211e6c8ff7f408d17d869a4fa4e0dd7f33931a
-  data.tar.gz: 7f09b6880e5301bc2e41c97b9d6dc4eb2d6e8cc33d6ed1621c7cd4b7c04ba530
+  metadata.gz: fe8edd0728c5a74a2496aa1fea1093bbcafbe584b37c2e3a65edc1103fa8580d
+  data.tar.gz: 11abc23f923ef8b0e50bb91223cedc33c6b230ba1d30c2f4d37feb49df1452e4
 SHA512:
-  metadata.gz: 942e6f7efeb10b18996de509b6c9af74f2e33b691e3778df3e0a8c1b6530d7b848362bfb45a0521531cb2a143e68b27f8b1d9867606e6b6132f9f0a92e286d3b
-  data.tar.gz: b6356cf4266f6bd9162f13de266e3f8390614004b4a7cb13f2a50f3c9e2be70338b7d6dc8bdeb3fb5d8605f5acbf9b87e4f42fd293c4ad280999650ad3023c0f
+  metadata.gz: 779695f4dd5a791a76ba01c59debefcc697826bbd3bbe2663369163a0d451d703dfc30f28c44017e34f9574c7c6365690ed1a4839fe116e51e1a42037bfb7144
+  data.tar.gz: 87aed3d5935014296eae0b5280ef942011e31a546e92391d604eb581fcd0ea8f0882f03b08a50633c18ed876acbe895fc8dbd653adcd3345ac70a683b30afceb

data/config/cookstyle.yml

@@ -503,6 +503,14 @@ ChefSharing/IncludeResourceDescriptions:
   Include:
     - '**/resources/*.rb'
 
+ChefSharing/IncludeResourceExamples:
+  Description: Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
+  StyleGuide: '#chefsharingincluderesourceexamples'
+  Enabled: false
+  VersionAdded: '6.10.0'
+  Include:
+    - '**/resources/*.rb'
+
 ###############################
 # ChefDeprecations: Resolving Deprecations that block upgrading Chef Infra Client
 ###############################
@@ -1727,6 +1735,24 @@ ChefRedundantCode/UseCreateIfMissing:
     - '**/attributes/*.rb'
     - '**/Berksfile'
 
+ChefRedundantCode/OhaiAttributeToString:
+  Description: Many Ohai node attributes are already strings and don't need to be cast to strings again
+  StyleGuide: '#ohaiattributetostring'
+  Enabled: true
+  VersionAdded: '6.10.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefRedundantCode/MultiplePlatformChecks:
+  Description: You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
+  StyleGuide: '#multipleplatformchecks'
+  Enabled: true
+  VersionAdded: '6.10.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefEffortless: Migrating to new patterns
 ###############################

data/lib/cookstyle.rb

@@ -12,6 +12,7 @@ require 'rubocop/monkey_patches/comment_config.rb'
 require 'rubocop/monkey_patches/config.rb'
 require 'rubocop/monkey_patches/cop.rb'
 require 'rubocop/monkey_patches/team.rb'
+require 'rubocop/monkey_patches/registry_cop.rb'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "6.9.0".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "6.10.2".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.86.0'.freeze
 end

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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.9.0
+  version: 6.10.2
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -209,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
@@ -226,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
@@ -247,6 +250,7 @@ files:
 - lib/rubocop/monkey_patches/comment_config.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: