cookstyle 6.13.3 → 6.16.4

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

@@ -33,7 +33,9 @@ module RuboCop
         #     not_if { systemd }
         #   end
         #
-        class NegatingOnlyIf < Cop
+        class NegatingOnlyIf < Base
+          extend AutoCorrector
+
           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
@@ -45,7 +47,7 @@ module RuboCop
           PATTERN
 
           def on_block(node)
-            negated_only_if?(node) do |_only_if, code|
+            negated_only_if?(node) do |only_if, code|
               # skip inspec controls where we don't have not_if
               return if node.parent&.parent&.block_type? &&
                         node.parent&.parent&.method_name == :control
@@ -54,13 +56,7 @@ module RuboCop
               return if code.descendants.first.send_type? &&
                         code.descendants.first.negation_method?
 
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            negated_only_if?(node) do |only_if, code|
-              lambda do |corrector|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(code.loc.expression, code.source.gsub(/^!/, ''))
                 corrector.replace(only_if.source_range, 'not_if')
               end

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

@@ -41,7 +41,8 @@ module RuboCop
         #   depends 'apt'
         #   depends 'yum'
         #
-        class OverlyComplexSupportsDependsMetadata < Cop
+        class OverlyComplexSupportsDependsMetadata < Base
+          extend AutoCorrector
           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
@@ -54,14 +55,9 @@ module RuboCop
           PATTERN
 
           def on_block(node)
-            supports_depends_array?(node) do |array, _type|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if array.values.count < 3
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              supports_depends_array?(node) do |array, type|
+            supports_depends_array?(node) do |array, type|
+              return unless array.values.count < 3
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 corrected_value = array.values.map { |x| "#{type} '#{x.source}'" }
                 corrector.replace(node.loc.expression, corrected_value.join("\n"))
               end

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

@@ -34,7 +34,9 @@ module RuboCop
         #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
         #   if node['platform_version'].to_i == 7
         #
-        class SimplifyPlatformMajorVersionCheck < Cop
+        class SimplifyPlatformMajorVersionCheck < Base
+          extend AutoCorrector
+
           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
@@ -57,18 +59,14 @@ module RuboCop
             end
           end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "node['platform_version'].to_i")
-            end
-          end
-
           private
 
           # if the parent is .to_i then we want to alert on that
           def add_offense_to_i_if_present(node)
             node = node.parent if parent_method_equals?(node, :to_i)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
+              corrector.replace(node.loc.expression, "node['platform_version'].to_i")
+            end
           end
 
           # see if the parent is a method and if it equals the passed in name

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

@@ -29,7 +29,8 @@ module RuboCop
         #   # good
         #   property :foo, [true, false]
         #
-        class TrueClassFalseClassResourceProperties < Cop
+        class TrueClassFalseClassResourceProperties < Base
+          extend AutoCorrector
           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
@@ -37,14 +38,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            trueclass_falseclass_property?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              trueclass_falseclass_property?(node) do |types|
+            trueclass_falseclass_property?(node) do |types|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(types.loc.expression, '[true, false]')
               end
             end

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

@@ -35,7 +35,9 @@ module RuboCop
         #   platform_family?('aix')
         #   platform_family?('netbsd', 'openbsd', 'freebsd)
         #
-        class UnnecessaryOSCheck < Cop
+        class UnnecessaryOSCheck < Base
+          extend AutoCorrector
+
           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
@@ -54,23 +56,30 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            os_equals?(node) do |_operator, val|
-              if UNNECESSARY_OS_VALUES.include?(val.value)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            os_equals?(node) do |operator, val|
+              return unless UNNECESSARY_OS_VALUES.include?(val.value)
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrected_string = (operator == :!= ? '!' : '') + "platform_family?('#{sanitized_platform(val.value)}')"
+                corrector.replace(node.loc.expression, corrected_string)
               end
             end
 
             os_eql?(node) do |val|
-              if UNNECESSARY_OS_VALUES.include?(val.value)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              return unless UNNECESSARY_OS_VALUES.include?(val.value)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrected_string = "platform_family?('#{sanitized_platform(val.value)}')"
+                corrector.replace(node.loc.expression, corrected_string)
               end
             end
 
             os_include?(node) do |val|
               array_of_plats = array_from_ast(val)
               # see if all the values in the .include? usage are in our list of 1:1 platform family to os values
-              if (UNNECESSARY_OS_VALUES & array_of_plats) == array_of_plats
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              return unless (UNNECESSARY_OS_VALUES & array_of_plats) == array_of_plats
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                platforms = val.values.map { |x| x.str_type? ? "'#{sanitized_platform(x.value)}'" : x.source }
+                corrected_string = "platform_family?(#{platforms.join(', ')})"
+                corrector.replace(node.loc.expression, corrected_string)
               end
             end
           end
@@ -86,26 +95,6 @@ module RuboCop
             ast.each_child_node { |x| vals << x.value }
             vals.sort
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              os_equals?(node) do |operator, plat|
-                corrected_string = (operator == :!= ? '!' : '') + "platform_family?('#{sanitized_platform(plat.value)}')"
-                corrector.replace(node.loc.expression, corrected_string)
-              end
-
-              os_include?(node) do |plats|
-                platforms = plats.values.map { |x| x.str_type? ? "'#{sanitized_platform(x.value)}'" : x.source }
-                corrected_string = "platform_family?(#{platforms.join(', ')})"
-                corrector.replace(node.loc.expression, corrected_string)
-              end
-
-              os_eql?(node) do |plat|
-                corrected_string = "platform_family?('#{sanitized_platform(plat.value)}')"
-                corrector.replace(node.loc.expression, corrected_string)
-              end
-            end
-          end
         end
       end
     end

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

@@ -43,7 +43,8 @@ module RuboCop
         #
         #   include_recipe 'yum' if platform_family?('rhel')
         #
-        class UnnecessaryPlatformCaseStatement < Cop
+        class UnnecessaryPlatformCaseStatement < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.'
@@ -53,21 +54,16 @@ module RuboCop
           PATTERN
 
           def on_case(node)
-            platform_case?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if node&.when_branches&.count == 1
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              platform_case?(node) do |node_, type|
+            platform_case?(node) do |node_, type|
+              return unless node&.when_branches&.count == 1
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 # we have at least one supermarket cookbook with an entirely empty platform case statement
                 # we can't actually fix that so let's do nothing here.
                 unless empty_case_statement?(node)
                   condition_string = node.when_branches.first.conditions.map(&:source).join(', ')
 
                   # single line bodies without an else statement should be transformed into `X if platform?('ubuntu')` style statements
-                  # while multiline statements should just have the case and when bits replace with `if platform?('ubuntu')`
+                  # while multi-line statements should just have the case and when bits replace with `if platform?('ubuntu')`
                   if !node.else? && !node.when_branches.first.body.multiline?
                     new_source = "#{node.when_branches.first.body.source} if #{type.value}?(#{condition_string})"
                     corrector.replace(node.loc.expression, new_source)

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

@@ -38,7 +38,9 @@ module RuboCop
         #   !platform_family?('debian')
         #   platform_family?('rhel', 'suse')
         #
-        class UsePlatformHelpers < Cop
+        class UsePlatformHelpers < Base
+          extend AutoCorrector
+
           MSG = "Use platform? and platform_family? helpers to check a node's platform"
 
           def_node_matcher :platform_equals?, <<-PATTERN
@@ -54,33 +56,23 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            platform_equals?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-
-            platform_include?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-
-            platform_eql?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              platform_equals?(node) do |type, operator, plat|
+            platform_equals?(node) do |type, operator, plat|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = (operator == :!= ? '!' : '') + "#{type.value}?('#{plat.value}')"
                 corrector.replace(node.loc.expression, corrected_string)
               end
+            end
 
-              platform_include?(node) do |plats, type|
+            platform_include?(node) do |plats, type|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 platforms = plats.values.map { |x| x.str_type? ? "'#{x.value}'" : x.source }
                 corrected_string = "#{type.value}?(#{platforms.join(', ')})"
                 corrector.replace(node.loc.expression, corrected_string)
               end
+            end
 
-              platform_eql?(node) do |type, plat|
+            platform_eql?(node) do |type, plat|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = "#{type.value}?('#{plat.value}')"
                 corrector.replace(node.loc.expression, corrected_string)
               end

data/lib/rubocop/monkey_patches/{cop.rb → base.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module RuboCop
   module Cop
-    class Cop
+    class Base
       # This is a copy of the #target_rails_version method from rubocop-rails
       def target_chef_version
         @config.target_chef_version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.13.3
+  version: 6.16.4
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.90.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.90.0
 description: 
 email:
 - thom@chef.io
@@ -51,7 +51,6 @@ files:
 - lib/rubocop/chef/cookbook_only.rb
 - lib/rubocop/chef/platform_helpers.rb
 - lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb
-- lib/rubocop/cop/chef/correctness/cb_depends_on_self.rb
 - lib/rubocop/cop/chef/correctness/chef_application_fatal.rb
 - lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb
 - lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb
@@ -67,6 +66,7 @@ files:
 - 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/macos_userdefaults_invalid_type.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
@@ -83,6 +83,7 @@ files:
 - lib/rubocop/cop/chef/correctness/supports_must_be_float.rb
 - lib/rubocop/cop/chef/correctness/tmp_path.rb
 - lib/rubocop/cop/chef/deprecation/ use_automatic_resource_name.rb
+- lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb
 - lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb
 - lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
@@ -113,6 +114,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb
 - lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb
 - lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb
+- lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb
 - lib/rubocop/cop/chef/deprecation/name_property_and_default.rb
 - lib/rubocop/cop/chef/deprecation/node_deep_fetch.rb
 - lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb
@@ -258,12 +260,12 @@ files:
 - lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
 - lib/rubocop/cop/target_chef_version.rb
+- lib/rubocop/monkey_patches/base.rb
 - 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: 
+homepage: https://docs.chef.io/workstation/cookstyle/
 licenses:
 - Apache-2.0
 metadata: