cookstyle 6.8.0 → 6.13.3

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         class PropertySplatRegex < Cop
           include RangeHelp
 
-          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'.freeze
+          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
 
           def_node_matcher :property_with_regex_splat?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :regex) (regexp (str ".*") (regopt))) ...>))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class PropertyWithRequiredAndDefault < Cop
           include RangeHelp
 
-          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'.freeze
+          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains default: true and required: true. These are wrapped in <> which means

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         class ProvidesMetadata < Cop
           include RangeHelp
 
-          MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provides

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead.".freeze
+          MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead."
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :recipe

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         class ReplacesMetadata < Cop
           include RangeHelp
 
-          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         class ResourceWithNothingAction < Cop
           include RangeHelp
 
-          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'.freeze
+          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'
 
           def_node_matcher :nothing_action?, <<-PATTERN
             (block (send nil? :action (sym :nothing)) (args) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -24,7 +25,7 @@ module RuboCop
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Cop
-          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'.freeze
+          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'
 
           def_node_matcher :sensitive_property?, <<-PATTERN
             (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         class StringPropertyWithNilDefault < Cop
           include RangeHelp
 
-          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'.freeze
+          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'
 
           def_node_matcher :string_property_with_nil_default?, <<-PATTERN
             (send nil? :property (sym _)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         class SuggestsMetadata < Cop
           include RangeHelp
 
-          MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :suggests

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         class UnnecessaryDesiredState < Cop
           include RangeHelp
 
-          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'.freeze
+          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
 
           def_node_matcher :property?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) ... $(hash ...))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   attribute :name, kind_of: String, name_attribute: true
         #
         class UnnecessaryNameProperty < Cop
-          MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'.freeze
+          MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'
 
           def_node_matcher :name_attribute?, <<-PATTERN
           (send nil? :attribute

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,7 +43,7 @@ module RuboCop
         #
         class UseCreateIfMissing < Cop
           include RuboCop::Chef::CookbookHelpers
-          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'.freeze
+          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
 
           def_node_matcher :not_if_file_exist?, <<-PATTERN
           (block (send nil? :not_if) (args) (send (const {nil? (cbase)} :File) {:exist? :exists?} $(str ...)))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         #   maintainer_email 'bob@bobberson.com'
         #
         class DefaultMetadataMaintainer < Cop
-          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'.freeze
+          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'
 
           def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         #   license 'Apache-2.0'
         #
         class EmptyMetadataField < Cop
-          MSG = 'Cookbook metadata.rb contains an field with an empty string.'.freeze
+          MSG = 'Cookbook metadata.rb contains an field with an empty string.'
 
           def_node_matcher :field?, '(send nil? _ $str ...)'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze
+          MSG = 'Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'
 
           # any method named property being called with a symbol argument and anything else
           def_node_matcher :property?, '(send nil? :property (sym _) ...)'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze
+          MSG = 'Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'
 
           def investigate(processed_source)
             return if processed_source.blank?

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# 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.'
+
+          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/insecure_cookbook_url.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         #   source_url 'http://gitlab.com/something/something'
         #
         class InsecureCookbookURL < Cop
-          MSG = 'Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields'.freeze
+          MSG = 'Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields'
 
           def_node_matcher :insecure_cb_url?, <<-PATTERN
             (send nil? {:source_url :issues_url} (str #insecure_url?))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -454,7 +455,7 @@ module RuboCop
             'UNLICENSED': 'all rights reserved',
           }.freeze
 
-          MSG = 'Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers.'.freeze
+          MSG = 'Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers.'
 
           def_node_matcher :license?, '(send nil? :license $str ...)'
 
@@ -483,7 +484,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/attribute_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016, Noah Kantrowitz
 #
@@ -43,7 +44,7 @@ module RuboCop
         class AttributeKeys < Cop
           include RuboCop::Cop::ConfigurableEnforcedStyle
 
-          MSG = 'Use %s to access node attributes'.freeze
+          MSG = 'Use %s to access node attributes'
 
           def_node_matcher :node_attribute_access?, <<-PATTERN
             (send (send _ :node) :[] _)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         #   Chef Infra configures your systems
         #
         class ChefWhaaat < Cop
-          MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'.freeze
+          MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'
 
           def investigate(processed_source)
             return unless processed_source.ast

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016-2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -22,7 +23,7 @@ module RuboCop
         # Replaces double spaces between sentences with a single space.
         # Note: This is DISABLED by default.
         class CommentSentenceSpacing < Cop
-          MSG = 'Use a single space after sentences in comments'.freeze
+          MSG = 'Use a single space after sentences in comments'
 
           def investigate(processed_source)
             return unless processed_source.ast

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016-2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,7 +41,7 @@ module RuboCop
         class CopyrightCommentFormat < Cop
           require 'date'
 
-          MSG = 'Properly format copyrights header comments'.freeze
+          MSG = 'Properly format copyrights header comments'
 
           def investigate(processed_source)
             return unless processed_source.ast

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016-2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         #   Copyright:: 2019 Chef Software, Inc.
         #
         class DefaultCopyrightComments < Cop
-          MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'.freeze
+          MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'
 
           def investigate(processed_source)
             return unless processed_source.ast

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016-2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,7 +41,7 @@ module RuboCop
         #   Cookbook:: Tomcat
         #
         class CommentFormat < Cop
-          MSG = 'Properly format header comments'.freeze
+          MSG = 'Properly format header comments'
 
           def investigate(processed_source)
             return unless processed_source.ast

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016, Noah Kantrowitz
 #
@@ -30,7 +31,7 @@ module RuboCop
         #   mode '644'
         #
         class FileMode < Cop
-          MSG = 'Use strings for file modes'.freeze
+          MSG = 'Use strings for file modes'
 
           def_node_matcher :resource_mode?, <<-PATTERN
             (send nil? :mode $int)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -35,7 +36,7 @@ module RuboCop
         #   end
         #
         class ImmediateNotificationTiming < Cop
-          MSG = 'Use :immediately instead of :immediate for resource notification timing'.freeze
+          MSG = 'Use :immediately instead of :immediate for resource notification timing'
 
           def_node_matcher :immediate_notify?, <<-PATTERN
             (send nil? :notifies (sym _) (...) $(sym :immediate))

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+#
+# 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'
+
+          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