cookstyle 6.7.3 → 6.12.6

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         #   end
         #
         class NegatingOnlyIf < Cop
-          MSG = 'Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read'.freeze
+          MSG = 'Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read'
 
           def_node_matcher :negated_only_if?, <<-PATTERN
             (block

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -41,7 +42,7 @@ module RuboCop
         #   depends 'yum'
         #
         class OverlyComplexSupportsDependsMetadata < Cop
-          MSG = "Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set.".freeze
+          MSG = "Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set."
 
           def_node_matcher :supports_depends_array?, <<-PATTERN
             (block

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         #   if node['platform_version'].to_i == 7
         #
         class SimplifyPlatformMajorVersionCheck < Cop
-          MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]".freeze
+          MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]"
 
           def_node_matcher :platform_version_check?, <<-PATTERN
             (send (send (send nil? :node) :[] (str "platform_version") ) :split (str ".") )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   property :foo, [true, false]
         #
         class TrueClassFalseClassResourceProperties < Cop
-          MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.".freeze
+          MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass."
 
           def_node_matcher :trueclass_falseclass_property?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) $(array (const nil? :TrueClass) (const nil? :FalseClass)) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -35,7 +36,7 @@ module RuboCop
         #   platform_family?('netbsd', 'openbsd', 'freebsd)
         #
         class UnnecessaryOSCheck < Cop
-          MSG = "Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values.".freeze
+          MSG = "Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values."
 
           # sorted list of all the os values that match 1:1 with a platform_family
           UNNECESSARY_OS_VALUES = %w(aix darwin dragonflybsd freebsd netbsd openbsd solaris2 windows).freeze
@@ -89,8 +90,7 @@ module RuboCop
           def autocorrect(node)
             lambda do |corrector|
               os_equals?(node) do |operator, plat|
-                corrected_string = operator == :!= ? '!' : ''
-                corrected_string << "platform_family?('#{sanitized_platform(plat.value)}')"
+                corrected_string = (operator == :!= ? '!' : '') + "platform_family?('#{sanitized_platform(plat.value)}')"
                 corrector.replace(node.loc.expression, corrected_string)
               end
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -45,7 +46,7 @@ module RuboCop
         class UnnecessaryPlatformCaseStatement < Cop
           include RangeHelp
 
-          MSG = 'Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.'.freeze
+          MSG = 'Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.'
 
           def_node_matcher :platform_case?, <<-PATTERN
           ( case $( send (send nil? :node) :[] $(str {"platform" "platform_family"})) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
         #   platform_family?('rhel', 'suse')
         #
         class UsePlatformHelpers < Cop
-          MSG = "Use platform? and platform_family? helpers to check a node's platform".freeze
+          MSG = "Use platform? and platform_family? helpers to check a node's platform"
 
           def_node_matcher :platform_equals?, <<-PATTERN
             (send (send (send nil? :node) :[] $(str {"platform" "platform_family"}) ) ${:== :!=} $str )
@@ -69,8 +70,7 @@ module RuboCop
           def autocorrect(node)
             lambda do |corrector|
               platform_equals?(node) do |type, operator, plat|
-                corrected_string = operator == :!= ? '!' : ''
-                corrected_string << "#{type.value}?('#{plat.value}')"
+                corrected_string = (operator == :!= ? '!' : '') + "#{type.value}?('#{plat.value}')"
                 corrector.replace(node.loc.expression, corrected_string)
               end
 

data/lib/rubocop/monkey_patches/comment_config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RuboCop
   # we're monkey patching the config regex to allow for # cookstyle: disable whatever
   # in addition to the # rubocop: disable whatever that comes with RuboCop

data/lib/rubocop/monkey_patches/cop.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RuboCop
   module Cop
     class Cop