cookstyle 6.10.2 → 6.15.3

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
 #
@@ -18,39 +19,58 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Check the file modes are given as strings instead of integers.
+        # Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
         #
         # @example
         #
         #   # bad
-        #   mode 644
-        #   mode 0644
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode 0600
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode 644
+        #     action :create
+        #   end
         #
         #   # good
-        #   mode '644'
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode '600'
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode '644'
+        #     action :create
+        #   end
         #
-        class FileMode < Cop
-          MSG = 'Use strings for file modes'.freeze
+        class FileMode < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Use strings to represent file modes to avoid confusion between octal and base 10 integer formats'
 
           def_node_matcher :resource_mode?, <<-PATTERN
-            (send nil? :mode $int)
+            (send nil? {:mode :files_mode} $int)
           PATTERN
 
           def on_send(node)
             resource_mode?(node) do |mode_int|
-              add_offense(mode_int, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # If it was an octal literal, make sure we write out the right number.
-              replacement_base = octal?(node) ? 8 : 10
-              replacement_mode = node.children.first.to_s(replacement_base)
+              add_offense(mode_int.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                # If it was an octal literal, make sure we write out the right number.
+                replacement_base = octal?(mode_int) ? 8 : 10
+                replacement_mode = mode_int.children.first.to_s(replacement_base)
 
-              # we build our own escaped string instead of using .inspect because that way
-              # we can use single quotes instead of the double quotes that .inspect adds
-              corrector.replace(node.loc.expression, "\'#{replacement_mode}\'")
+                # we build our own escaped string instead of using .inspect because that way
+                # we can use single quotes instead of the double quotes that .inspect adds
+                corrector.replace(mode_int.loc.expression, "\'#{replacement_mode}\'")
+              end
             end
           end
 

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"})) ... )
@@ -66,7 +67,7 @@ module RuboCop
                   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

@@ -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/{cop.rb → base.rb}

@@ -1,6 +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

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/registry_cop.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.10.2
+  version: 6.15.3
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.89.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.89.1
 description: 
 email:
 - thom@chef.io
@@ -37,6 +37,7 @@ files:
 - Gemfile
 - LICENSE
 - bin/cookstyle
+- bin/cookstyle-profile
 - config/cookstyle.yml
 - config/default.yml
 - config/disable_all.yml
@@ -55,6 +56,7 @@ files:
 - lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb
 - lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb
 - lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb
+- lib/rubocop/cop/chef/correctness/invalid_default_action.rb
 - lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb
@@ -65,6 +67,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
@@ -78,11 +81,15 @@ files:
 - lib/rubocop/cop/chef/correctness/resource_with_none_action.rb
 - lib/rubocop/cop/chef/correctness/scoped_file_exist.rb
 - lib/rubocop/cop/chef/correctness/service_resource.rb
+- 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/chef_handler_recipe.rb
 - lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
 - lib/rubocop/cop/chef/deprecation/chef_rewind.rb
 - lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb
+- lib/rubocop/cop/chef/deprecation/chefdk_generators.rb
 - lib/rubocop/cop/chef/deprecation/cheffile.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb
@@ -107,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
@@ -142,6 +150,7 @@ files:
 - lib/rubocop/cop/chef/effortless/node_roles.rb
 - lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb
 - lib/rubocop/cop/chef/effortless/search_used.rb
+- lib/rubocop/cop/chef/modernize/action_method_in_resource.rb
 - lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb
 - lib/rubocop/cop/chef/modernize/apt_default_recipe.rb
 - lib/rubocop/cop/chef/modernize/berksfile_source.rb
@@ -149,6 +158,8 @@ files:
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
 - lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
 - lib/rubocop/cop/chef/modernize/compile_time_resources.rb
+- lib/rubocop/cop/chef/modernize/conditional_using_test.rb
+- lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb
 - lib/rubocop/cop/chef/modernize/cron_manage_resource.rb
 - lib/rubocop/cop/chef/modernize/databag_helpers.rb
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
@@ -207,6 +218,7 @@ files:
 - lib/rubocop/cop/chef/redundant/attribute_metadata.rb
 - lib/rubocop/cop/chef/redundant/conflicts_metadata.rb
 - lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb
+- lib/rubocop/cop/chef/redundant/double_compile_time.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
@@ -239,6 +251,7 @@ files:
 - lib/rubocop/cop/chef/style/comments_format.rb
 - lib/rubocop/cop/chef/style/file_mode.rb
 - lib/rubocop/cop/chef/style/immediate_notification_timing.rb
+- lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb
 - lib/rubocop/cop/chef/style/negating_only_if.rb
 - lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb
 - lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb
@@ -247,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: