cookstyle 6.12.6 → 6.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2a5a64113481754a334b8f95b80e976875672ca750c506dbdb586c2ccbab598
-  data.tar.gz: 0ff373380e2f388e723a25b6ce1fae3e2447487cfe4c3692f3151e81f412a67a
+  metadata.gz: ddf96e2cc00a4c499396b6cb2b54297e64d0605edd2dba615fb28ecd0bcb91a9
+  data.tar.gz: 2ec5752d4202b2b7567f808346672b4a80c59967a8ebeed20fe354f0911236bb
 SHA512:
-  metadata.gz: e4b62f764012b0f77378a0fa3d7b97abc249ece2fcc464234ce8c0b68d3bc41692324ce0557652f084a3d923f834973f660aa060206ab9d520fb09bbe75bc3de
-  data.tar.gz: 6f3a5b63437a4dd752b211959915744fa6c6b7cce86c6da0711f950bcba8f1e3d8d40c3b661b19b4f2f5a871d3801316d12d39a29b367c097740852f704e78ee
+  metadata.gz: 4f5e75f32ca428f5b4395a3f42a50a37675e21dc79e89d4b7b1d731328c28e2cd1dfd116667c0c8c9b0887bfd1ca647901ecd6895c56e82bac5f4e9939c84e54
+  data.tar.gz: 6aa192abcf88b35034474eac2ebcfecd8c154e2f28e08f0995a53bb4e998e8a4af7f1e246a1f7fced0979bbd2bddd1bdd96bbde6c046fdc92299cede2b012742

data/config/cookstyle.yml

@@ -454,6 +454,23 @@ ChefCorrectness/InvalidPlatformInCase:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefCorrectness/InvalidDefaultAction:
+  Description: Default actions in resources should be a symbol or an array of symbols.
+  StyleGuide: '#chefcorrectnessinvaliddefaultaction'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
+ChefCorrectness/SupportsMustBeFloat:
+  Description: Versions used in metadata.rb supports calls should be floats not integers.
+  StyleGuide: '#chefcorrectnesssupportsmustbefloat'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/metadata.rb'
+
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -1581,7 +1598,7 @@ ChefModernize/ShellOutHelper:
 
 ChefModernize/ConditionalUsingTest:
   Description: Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out.
-  StyleGuide: '#conditionalusingtest'
+  StyleGuide: '#chefmodernizeconditionalusingtest'
   Enabled: true
   VersionAdded: '6.11.0'
   Exclude:
@@ -1589,6 +1606,26 @@ ChefModernize/ConditionalUsingTest:
     - '**/Berksfile'
     - '**/attributes/*.rb'
 
+ChefModernize/CronDFileOrTemplate:
+  Description: Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources
+  StyleGuide: '#chefmodernizecrondfileortemplate'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+    - '**/attributes/*.rb'
+
+ChefModernize/ActionMethodInResource:
+  Description: Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
+  StyleGuide: '#chefmodernizeactionmethodinresource'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/libraries/*.rb'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################
@@ -1785,7 +1822,7 @@ ChefRedundantCode/UseCreateIfMissing:
 
 ChefRedundantCode/OhaiAttributeToString:
   Description: Many Ohai node attributes are already strings and don't need to be cast to strings again
-  StyleGuide: '#ohaiattributetostring'
+  StyleGuide: '#chefredundantcodeohaiattributetostring'
   Enabled: true
   VersionAdded: '6.10.0'
   Exclude:
@@ -1794,13 +1831,23 @@ ChefRedundantCode/OhaiAttributeToString:
 
 ChefRedundantCode/MultiplePlatformChecks:
   Description: You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
-  StyleGuide: '#multipleplatformchecks'
+  StyleGuide: '#chefredundantcodemultipleplatformchecks'
   Enabled: true
   VersionAdded: '6.10.0'
   Exclude:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefRedundantCode/DoubleCompileTime:
+  Description: If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
+  StyleGuide: '#chefredundantcodedoublecompiletime'
+  Enabled: true
+  VersionAdded: '6.13.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefEffortless: Migrating to new patterns
 ###############################

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.12.6" # rubocop: disable Style/StringLiterals
+  VERSION = "6.13.3" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.88.0'
 end

data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb

@@ -0,0 +1,48 @@
+# 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
+      # Default actions in resources should be symbols or an array of symbols.
+      #
+      # @example
+      #
+      #   # bad
+      #   default_action 'create'
+      #
+      #   # good
+      #   default_action :create
+      #
+      module ChefCorrectness
+        class InvalidDefaultAction < Cop
+          MSG = 'Default actions in resources should be symbols or an array of symbols.'
+
+          def_node_matcher :default_action?, '(send nil? :default_action $_)'
+
+          def on_send(node)
+            default_action?(node) do |match|
+              return if %i(send sym array).include?(match.type)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -0,0 +1,52 @@
+# 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 ChefCorrectness
+        # Versions used in metadata.rb supports calls should be floats not integers.
+        #
+        # @example
+        #
+        #   # bad
+        #   supports 'redhat', '> 8'
+        #
+        #   # good
+        #   supports 'redhat', '> 8.0'
+        #
+        class SupportsMustBeFloat < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Versions used in metadata.rb supports calls should be floats not integers.'
+
+          def_node_matcher :supports_with_constraint?, '(send nil? :supports str $str)'
+
+          def on_send(node)
+            supports_with_constraint?(node) do |ver|
+              return if ver.source.include?('.')
+              add_offense(ver.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(ver.loc.expression, ver.source.gsub(ver.value, (ver.value + '.0')))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb

@@ -49,7 +49,7 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              # @todo when we drop ruby 2.4 support we can convert to to just delete_prefix delete_suffix
+              # @todo when we drop ruby 2.4 support we can convert this to just delete_prefix delete_suffix
               corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^{/, '').gsub(/}$/, ''))
             end
           end

data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb

@@ -0,0 +1,57 @@
+# 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 ChefModernize
+        # Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
+        #
+        # @example
+        #
+        #   # bad
+        #   def action_create
+        #    # :create action code here
+        #   end
+        #
+        #   # good
+        #   action :create do
+        #    # :create action code here
+        #   end
+        #
+        class ActionMethodInResource < Base
+          extend AutoCorrector
+
+          MSG = "Use the custom resource language's `action :my_action` blocks instead of creating actions with methods."
+
+          def_node_search :includes_poise?, '(send nil? :include (const nil? :Poise))'
+
+          def on_def(node)
+            return unless node.method_name.to_s.start_with?('action_') # when we stop support for Ruby < 2.7 the .to_s can go away here
+            return if node.arguments? # if they passed in arguments they may actually need this
+            return if node.parent && includes_poise?(node.parent)
+
+            add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              # @todo when we drop ruby 2.4 support we can convert this to use delete_suffix
+              corrector.replace(node.loc.expression, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb

@@ -0,0 +1,88 @@
+# 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 ChefModernize
+        # Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/cron.d/backup' do
+        #     source 'cron_backup_job.erb'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   cookbook_file '/etc/cron.d/backup' do
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   file '/etc/cron.d/backup' do
+        #     content '*/30 * * * * backup /usr/local/bin/backup_script.sh'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   file '/etc/cron.d/blogs' do
+        #     action :delete
+        #   end
+        #
+        #   # good
+        #   cron_d 'backup' do
+        #     minute '1'
+        #     hour '1'
+        #     mailto 'sysadmins@example.com'
+        #     command '/usr/local/bin/backup_script.sh'
+        #   end
+        #
+        #   cron_d 'blogs' do
+        #     action :delete
+        #   end
+        #
+        class CronDFileOrTemplate < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.4'
+
+          MSG = 'Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources'
+
+          def_node_matcher :file_or_template?, <<-PATTERN
+            (block
+              (send nil? {:template :file :cookbook_file}
+                (str $_))
+              ...
+            )
+          PATTERN
+
+          def on_block(node)
+            file_or_template?(node) do |file_name|
+              return unless file_name.start_with?('/etc/cron.d/')
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 ChefRedundantCode
+        # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
+        #
+        #   # bad
+        #   chef_gem 'deep_merge' do
+        #     action :nothing
+        #     compile_time true
+        #   end.run_action(:install)
+        #
+        #   # good
+        #   chef_gem 'deep_merge' do
+        #     action :install
+        #     compile_time true
+        #   end
+        #
+        class DoubleCompileTime < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
+
+          def_node_matcher :compile_time_and_run_action?, <<-PATTERN
+          (send
+            $(block
+              (send nil? ... )
+              (args)
+              (begin <
+                (send nil? :action (sym $_) )
+                (send nil? :compile_time (true) )
+                ...
+              >)
+            ) :run_action (sym $_) )
+          PATTERN
+
+          def on_send(node)
+            compile_time_and_run_action?(node) do |resource, action, run_action|
+              add_offense(node.loc.selector, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, resource.source.gsub(action.to_s, run_action.to_s))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.12.6
+  version: 6.13.3
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -56,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
@@ -79,6 +80,7 @@ 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
@@ -146,6 +148,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
@@ -154,6 +157,7 @@ files:
 - 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
@@ -212,6 +216,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