cookstyle 6.9.0 → 6.14.7

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The grouping 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 == :grouping

data/lib/rubocop/cop/chef/redundant/long_description_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
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The long_description 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 == :long_description

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

@@ -0,0 +1,61 @@
+# 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
+        # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
+        #
+        # @example
+        #
+        #   # bad
+        #   platform?('redhat') || platform?('ubuntu')
+        #   platform_family?('debian') || platform_family?('rhel')
+        #
+        #   # good
+        #   platform?('redhat', 'ubuntu')
+        #   platform_family?('debian', 'rhel')
+        #
+        class MultiplePlatformChecks < Cop
+          MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'
+
+          def_node_matcher :or_platform_helpers?, <<-PATTERN
+            (or (send nil? ${:platform? :platform_family?} $_ )* )
+          PATTERN
+
+          def on_or(node)
+            or_platform_helpers?(node) do |helpers, _plats|
+              # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if helpers.uniq.size == 1
+            end
+          end
+
+          def autocorrect(node)
+            or_platform_helpers?(node) do |type, plats|
+              lambda do |corrector|
+                new_string = "#{type.first}(#{plats.map(&:source).join(', ')})"
+                corrector.replace(node.loc.expression, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -59,7 +60,7 @@ module RuboCop
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Cop
-          MSG = 'Resource properties marked as name properties should not also be required properties'.freeze
+          MSG = 'Resource properties marked as name properties should not also be required properties'
 
           # 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

@@ -0,0 +1,69 @@
+# 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
+        # Many Ohai node attributes are already strings and don't need to be cast to strings again
+        #
+        # @example
+        #
+        #   # bad
+        #   node['platform'].to_s
+        #   node['platform_family'].to_s
+        #   node['platform_version'].to_s
+        #   node['fqdn'].to_s
+        #   node['hostname'].to_s
+        #   node['os'].to_s
+        #   node['name'].to_s
+        #
+        #   # good
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['fqdn']
+        #   node['hostname']
+        #   node['os']
+        #   node['name']
+        #
+        class OhaiAttributeToString < Cop
+          MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
+
+          def_node_matcher :attribute_to_s?, <<-PATTERN
+            (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
+          PATTERN
+
+          def on_send(node)
+            attribute_to_s?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            attribute_to_s?(node) do |method|
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "node['#{method.value}']")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         class PropertySplatRegex < Cop
           include RangeHelp
 
-          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'.freeze
+          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
 
           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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class PropertyWithRequiredAndDefault < Cop
           include RangeHelp
 
-          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'.freeze
+          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains default: true and required: true. These are wrapped in <> which means

data/lib/rubocop/cop/chef/redundant/provides_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 ProvidesMetadata < Cop
           include RangeHelp
 
-          MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The provides 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 == :provides

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = "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.".freeze
+          MSG = "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."
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :recipe

data/lib/rubocop/cop/chef/redundant/replaces_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 ReplacesMetadata < Cop
           include RangeHelp
 
-          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The replaces 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 == :replaces

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
         class ResourceWithNothingAction < Cop
           include RangeHelp
 
-          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'.freeze
+          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'
 
           def_node_matcher :nothing_action?, <<-PATTERN
             (block (send nil? :action (sym :nothing)) (args) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -24,7 +25,7 @@ module RuboCop
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Cop
-          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'.freeze
+          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'
 
           def_node_matcher :sensitive_property?, <<-PATTERN
             (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         class StringPropertyWithNilDefault < Cop
           include RangeHelp
 
-          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'.freeze
+          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'
 
           def_node_matcher :string_property_with_nil_default?, <<-PATTERN
             (send nil? :property (sym _)

data/lib/rubocop/cop/chef/redundant/suggests_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 SuggestsMetadata < Cop
           include RangeHelp
 
-          MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The suggests 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 == :suggests

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         class UnnecessaryDesiredState < Cop
           include RangeHelp
 
-          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'.freeze
+          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
 
           def_node_matcher :property?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) ... $(hash ...))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   attribute :name, kind_of: String, name_attribute: true
         #
         class UnnecessaryNameProperty < Cop
-          MSG = '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.'.freeze
+          MSG = '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.'
 
           def_node_matcher :name_attribute?, <<-PATTERN
           (send nil? :attribute

data/lib/rubocop/cop/chef/redundant/use_create_if_missing.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
         #
         class UseCreateIfMissing < Cop
           include RuboCop::Chef::CookbookHelpers
-          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'.freeze
+          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
 
           def_node_matcher :not_if_file_exist?, <<-PATTERN
           (block (send nil? :not_if) (args) (send (const {nil? (cbase)} :File) {:exist? :exists?} $(str ...)))

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.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
         #   maintainer_email 'bob@bobberson.com'
         #
         class DefaultMetadataMaintainer < Cop
-          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'.freeze
+          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'
 
           def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
 

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.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
         #   license 'Apache-2.0'
         #
         class EmptyMetadataField < Cop
-          MSG = 'Cookbook metadata.rb contains an field with an empty string.'.freeze
+          MSG = 'Cookbook metadata.rb contains an field with an empty string.'
 
           def_node_matcher :field?, '(send nil? _ $str ...)'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -18,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze
+          MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
           # any method named property being called with a symbol argument and anything else
           def_node_matcher :property?, '(send nil? :property (sym _) ...)'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -18,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -32,7 +33,7 @@ module RuboCop
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze
+          MSG = 'Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
           def investigate(processed_source)
             return if processed_source.blank?

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 ChefSharing
+        # Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
+        #
+        # @example
+        #
+        #   # good
+        #   examples <<~DOC
+        #     **Specify a global domain value**
+        #
+        #     ```ruby
+        #     macos_userdefaults 'full keyboard access to all controls' do
+        #       key 'AppleKeyboardUIMode'
+        #       value '2'
+        #     end
+        #     ```
+        #   DOC
+        #
+        class IncludeResourceExamples < Cop
+          include RangeHelp
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.9'
+
+          MSG = 'Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
+
+          def investigate(processed_source)
+            return if processed_source.blank?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(nil, location: range, message: MSG, severity: :refactor) unless resource_examples(processed_source.ast).any?
+          end
+
+          def_node_search :resource_examples, '(send nil? :examples dstr ...)'
+        end
+      end
+    end
+  end
+end