cookstyle 6.10.2 → 6.15.3

data/lib/rubocop/cop/chef/modernize/resource_name_initializer.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
         class ResourceNameFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'.freeze
+          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
 
           def on_def(node)
             return unless node.method_name == :initialize
@@ -47,12 +48,12 @@ module RuboCop
             end
           end
 
-          def_node_search :intialize_method, '(def :initialize ... )'
+          def_node_search :initialize_method, '(def :initialize ... )'
 
           def autocorrect(node)
             lambda do |corrector|
               # insert the new resource_name call above the initialize method
-              initialize_node = intialize_method(processed_source.ast).first
+              initialize_node = initialize_method(processed_source.ast).first
               corrector.insert_before(initialize_node.source_range, "resource_name #{node.descendants.first.source}\n\n")
 
               # remove the variable from the initialize method

data/lib/rubocop/cop/chef/modernize/resource_set_or_return.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
         #   property :severity, String
         #
         class SetOrReturnInResources < Cop
-          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'.freeze
+          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'
 
           def on_send(node)
             if node.method_name == :set_or_return

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,7 +41,7 @@ module RuboCop
         #   end
         #
         class CustomResourceWithAttributes < Cop
-          MSG = 'Custom Resources should contain properties not attributes'.freeze
+          MSG = 'Custom Resources should contain properties not attributes'
 
           def_node_matcher :attribute?, <<-PATTERN
             (send nil? $:attribute ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -47,7 +48,7 @@ module RuboCop
 
           minimum_target_chef_version '12.1'
 
-          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'.freeze
+          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'
 
           def_node_matcher :compile_time_method_defined?, <<-PATTERN
           (if

data/lib/rubocop/cop/chef/modernize/respond_to_metadata.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
 
           minimum_target_chef_version '12.15'
 
-          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
+          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'
 
           def on_if(node)
             if_respond_to?(node) do

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'.freeze
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'
 
           def on_if(node)
             if_respond_to_provides?(node) do

data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.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
         #   resource_name :foo
         #
         class RespondToResourceName < Cop
-          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'.freeze
+          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
 
           def on_if(node)
             if_respond_to_resource_name?(node) do

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'.freeze
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sc_windows

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :seven_zip_archive

data/lib/rubocop/cop/chef/modernize/shell_out_helper.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
 
           minimum_target_chef_version '12.11'
 
-          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.".freeze
+          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
 
           def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
           (send

data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.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
         class ShellOutToChocolatey < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'.freeze
+          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'.freeze
+          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'uri', node) do |uri|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'.freeze
+          MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sysctl_param

data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.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
         class UnnecessaryMixlibShelloutRequire < Cop
           include RangeHelp
 
-          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'.freeze
+          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
 
           def_node_matcher :require_mixlibshellout?, <<-PATTERN
           (send nil? :require ( str "mixlib/shellout"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -18,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.
+        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
         #
         # @example
         #
@@ -33,7 +34,7 @@ module RuboCop
         #   package %w(bmon htop vim curl)
         #
         class UseMultipackageInstalls < Cop
-          MSG = 'Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.'.freeze
+          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
           MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
 
           def_node_matcher :platform_or_platform_family?, <<-PATTERN
@@ -72,7 +73,7 @@ module RuboCop
                   (lvar _))})
           PATTERN
 
-          # see if all platforms in the when condition are multipackage compliant
+          # see if all platforms in the when condition are multi-package compliant
           def multipackage_platforms?(condition_obj)
             condition_obj.all? do |p|
               MULTIPACKAGE_PLATS.include?(p.value)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   require_relative '../libraries/helpers'
         #
         class UseRequireRelative < Cop
-          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'.freeze
+          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
 
           def_node_matcher :require_with_expand_path?, <<-PATTERN
             (send nil? :require

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
+          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'
 
           # match on both whyrun_supported? and the typo form why_run_supported?
           def_node_matcher :whyrun_true?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/windows_default_recipe.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
         class IncludingWindowsDefaultRecipe < Cop
           include RangeHelp
 
-          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'.freeze
+          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
 
           def_node_matcher :windows_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"windows" "windows::default"}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,7 +43,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'.freeze
+          MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'
 
           # non block execute resources
           def on_send(node)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile

data/lib/rubocop/cop/chef/modernize/zipfile_resource.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
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'
 
           def_node_matcher :depends_zipfile?, <<-PATTERN
             (send nil? :depends (str "zipfile"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
 
           minimum_target_chef_version '13.3'
 
-          MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'.freeze
+          MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :zypper_repo

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -39,7 +40,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
 
-          MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.".freeze
+          MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource."
 
           def_node_matcher :default_dist?, <<-PATTERN
             (send nil? :distribution (send (send (send nil? :node) :[] ({sym str} {:lsb "lsb"})) :[] ({sym str} {:codename "codename"})))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -39,7 +40,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
 
-          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'.freeze
+          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.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
         class ConflictsMetadata < Cop
           include RangeHelp
 
-          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         class CustomResourceWithAllowedActions < Cop
           include RangeHelp
 
-          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'.freeze
+          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'
 
           def_node_matcher :allowed_actions?, <<-PATTERN
             (send nil? {:allowed_actions :actions} ... )

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