cookstyle 6.19.5 → 7.0.0

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When using properties in a custom resource you shouldn't set a property to
         # be both required and a name_property. Name properties are a way to optionally
         # override the name given to the resource block in cookbook code. In your resource
@@ -61,6 +61,7 @@ module RuboCop
         #
         class NamePropertyIsRequired < Base
           MSG = 'Resource properties marked as name properties should not also be required properties'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property: true and required: true. These are wrapped in <> which means

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Many Ohai node attributes are already strings and don't need to be cast to strings again
         #
         # @example
@@ -46,6 +46,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
+          RESTRICT_ON_SEND = [:to_s].freeze
 
           def_node_matcher :attribute_to_s?, <<-PATTERN
             (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accept all values.
         #
         # @example
@@ -36,6 +36,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # When using properties in a custom resource you shouldn't set a property to
         # required and then provide a default value. If a property is required the
         # user will always pass in a value and the default will never be used. In Chef

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The provides metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # 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.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The replaces metadata.rb method is not used and is unnecessary in cookbooks. Replacements for existing cookbooks should be documented in the cookbook's README.md file instead.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Chef Infra Client provides the :nothing action by default for every resource. There is no need to define a :nothing action in your resource code.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Every Chef Infra resource already includes a sensitive property with a default value of false.
         #
         # # bad

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Properties have a nil value by default so there is no need to set the default value to nil.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # The suggests metadata.rb method is not used and is unnecessary in cookbooks.
         #
         # @example

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

@@ -18,16 +18,22 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
-        # There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.
+      module RedundantCode
+        # There is no need to set a property/attribute to desired_state: true as all properties/attributes have a desired_state of true by default.
         #
         # @example
         #
         #   # bad
         #   property :foo, String, desired_state: true
+        #   attribute :foo, String, desired_state: true
         #
-        class UnnecessaryDesiredState < Cop
+        #   # good
+        #   property :foo, String
+        #   attribute :foo, String
+        #
+        class UnnecessaryDesiredState < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
           RESTRICT_ON_SEND = [:property, :attribute].freeze
@@ -39,19 +45,14 @@ module RuboCop
           def on_send(node)
             property?(node) do |hash_vals|
               hash_vals.each_pair do |k, v|
-                if k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
-                  add_offense(v.parent, location: :expression, message: MSG, severity: :refactor)
+                next unless k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
+                add_offense(v.parent, message: MSG, severity: :refactor) do |corrector|
+                  range = range_with_surrounding_comma(range_with_surrounding_space(range: v.parent.loc.expression, side: :left), :left)
+                  corrector.remove(range)
                 end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              range = range_with_surrounding_comma(range_with_surrounding_space(range: node.loc.expression, side: :left), :left)
-              corrector.remove(range)
-            end
-          end
         end
       end
     end

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # 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.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundantCode
+      module RedundantCode
         # Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect that actual maintainer of the cookbook.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # Use secure Github and Gitlab URLs for source_url and issues_url
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefSharing
+      module Sharing
         # metadata.rb license field should include a SPDX compliant string or "all right reserved" (not case sensitive)
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Check which style of keys are used to access node attributes.
         #
         # There are two supported styles: "symbols" and "strings".
@@ -45,6 +45,7 @@ module RuboCop
           include RuboCop::Cop::ConfigurableEnforcedStyle
 
           MSG = 'Use %s to access node attributes'
+          RESTRICT_ON_SEND = [:[]].freeze
 
           def_node_matcher :node_attribute_access?, <<-PATTERN
             (send (send _ :node) :[] _)

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Checks for comments that mention "Chef" without context. Do you mean Chef Infra or Chef Software?
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Replaces double spaces between sentences with a single space.
         # Note: This is DISABLED by default.
         class CommentSentenceSpacing < Base

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Checks for incorrectly formatted copyright comments.
         #
         # @example
@@ -38,7 +38,8 @@ module RuboCop
         #   Copyright:: 2013-2019 Tim Smith
         #   Copyright:: 2019 37Signals, Inc.
         #
-        class CopyrightCommentFormat < Cop
+        class CopyrightCommentFormat < Base
+          extend AutoCorrector
           require 'date'
 
           MSG = 'Properly format copyrights header comments'
@@ -49,7 +50,7 @@ module RuboCop
             processed_source.comments.each do |comment|
               next unless comment.inline? && invalid_copyright_comment?(comment) # headers aren't in blocks
 
-              add_offense(comment, location: comment, message: MSG, severity: :refactor) do |corrector|
+              add_offense(comment, message: MSG, severity: :refactor) do |corrector|
                 correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
                 corrector.replace(comment, correct_comment)
               end

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Checks for default copyright comments from the chef generator cookbook command
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Checks for incorrectly formatted headers
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Use :immediately instead of :immediate for resource notification timing
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # There is no need to wrap the recipe in parentheses when using the include_recipe helper.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set. Setting multiple `supports` or `depends` values is simpler and easier to understand for new users.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # When checking the major version number of a platform you can take the node['platform_version'] attribute and transform it to an integer to strip it down to just the major version number. This simple way of determining the major version number of a platform should be used instead of splitting the platform into multiple fields with '.' as the delimiter.
         #
         # @example
@@ -38,6 +38,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]"
+          RESTRICT_ON_SEND = [:split].freeze
 
           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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # 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.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefStyle
+      module Style
         # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `plaform_family`.
         #
         # @example
@@ -39,6 +39,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values."
+          RESTRICT_ON_SEND = [:==, :!=, :eql?, :include?].freeze
 
           # 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