cookstyle 5.14.1 → 5.15.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fe10480691d3522f05f3d4a0db77cac9543e29cd50ed9f6764d45294973c2f
-  data.tar.gz: 7308ec701ae4d522633a62a59cf28d6eab5b1460179ef1af5be3a7926a8d688c
+  metadata.gz: 394f526dcec8c22ebd9db30e8c32686fe508cf388d3903769157428c49690c6d
+  data.tar.gz: abba87a8fea82ef987ca27c3631fa25bc925c55ac7f59b6d07735123092d279a
 SHA512:
-  metadata.gz: d3659fda58293a623b91d907a30fd5f5f1229da9dcbd7a8d5ebc83083baa101db9e274e15a1feae9f14071c274dbac4ee7a86069dc05c0b69fdf3650fd622da9
-  data.tar.gz: b08f3957087487156952dc5856bf2ece8c0f4f432e11d8551d9c4492c10ff148cce4ebad8cdef712a6e1179190106893c6490f07443c54dbef92062c1d8308a1
+  metadata.gz: '08e6f1c8d8563494ab21c7d69021c4955d4b2ed2af6cb6e59394510fc07eff5eabf23b6a1575afcb8994d1dfbe11446a26a456395a8d7ce1392cf1c10074d548'
+  data.tar.gz: '09eecb0aebc0837b48e72741f805ac13fd4bb2b64e53d0d762053dfb6d6763f3c53ef81c6fc647c2909bf76351fad15d28264484ea0c8d81494c4482a1476976'

data/config/cookstyle.yml

@@ -115,25 +115,6 @@ ChefCorrectness/TmpPath:
   Exclude:
     - '**/metadata.rb'
 
-ChefCorrectness/InsecureCookbookURL:
-  Description: Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields
-  Enabled: true
-  VersionAdded: '5.1.0'
-  Include:
-    - '**/metadata.rb'
-
-ChefCorrectness/NamePropertyIsRequired:
-  Description: Resource properties marked as name properties should not also be required properties
-  Enabled: true
-  VersionAdded: '5.1.0'
-
-ChefCorrectness/InvalidLicenseString:
-  Description: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved"
-  Enabled: true
-  VersionAdded: '5.2.0'
-  Include:
-    - '**/metadata.rb'
-
 ChefCorrectness/InvalidPlatformMetadata:
   Description: metadata.rb "supports" platform is invalid
   Enabled: true
@@ -148,29 +129,6 @@ ChefCorrectness/CookbookUsesNodeSave:
   Exclude:
     - '**/metadata.rb'
 
-ChefCorrectness/DefaultMetadataMaintainer:
-  Description: Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.
-  Enabled: true
-  VersionAdded: '5.4.0'
-  Include:
-    - '**/metadata.rb'
-
-ChefCorrectness/PropertyWithNameAttribute:
-  Description: Resource property sets name_attribute not name_property
-  Enabled: true
-  VersionAdded: '5.1.0'
-  Include:
-    - '**/resources/*.rb'
-    - '**/libraries/*.rb'
-
-ChefCorrectness/PropertyWithRequiredAndDefault:
-  Description: Resource property should not be both required and have a default value
-  Enabled: true
-  VersionAdded: '5.1.0'
-  Include:
-    - '**/resources/*.rb'
-    - '**/libraries/*.rb'
-
 ChefCorrectness/CookbooksDependsOnSelf:
   Description: A cookbook cannot depend on itself
   Enabled: true
@@ -213,28 +171,6 @@ ChefCorrectness/ResourceWithNoneAction:
   Exclude:
     - '**/metadata.rb'
 
-ChefCorrectness/IncludingOhaiDefaultRecipe:
-  Description: Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely.
-  Enabled: true
-  VersionAdded: '5.4.0'
-  Exclude:
-    - '**/metadata.rb'
-
-ChefCorrectness/UnnecessaryNameProperty:
-  Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
-  Enabled: true
-  VersionAdded: '5.8.0'
-  Include:
-    - '**/resources/*.rb'
-    - '**/libraries/*.rb'
-
-ChefCorrectness/EmptyMetadataField:
-  Description: metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
-  Enabled: true
-  VersionAdded: '5.8.0'
-  Include:
-    - '**/metadata.rb'
-
 ChefCorrectness/InvalidVersionMetadata:
   Description: Cookbook metadata.rb version field should follow X.Y.Z version format.
   Enabled: true
@@ -256,100 +192,113 @@ ChefCorrectness/IncorrectLibraryInjection:
   Include:
     - '**/libraries/*.rb'
 
-ChefCorrectness/ResourceWithNothingAction:
-  Description: 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.
+ChefCorrectness/InvalidPlatformHelper:
+  Description: Pass valid platforms to the platform? helper.
   Enabled: true
-  VersionAdded: '5.12.0'
-  Include:
-    - '**/libraries/*.rb'
-    - '**/resources/*.rb'
-    - '**/providers/*.rb'
-
-###############################
-# ChefDeprecations: Resolving Deprecations that block upgrading Chef Infra Client
-###############################
+  VersionAdded: '5.15.0'
+  Exclude:
+    - '**/metadata.rb'
 
-ChefDeprecations/NodeDeepFetch:
-  Description: Do not use the deprecated chef-sugar node.deep_fetch methods
+ChefCorrectness/InvalidPlatformFamilyHelper:
+  Description: Pass valid platform families to the platform_family? helper.
   Enabled: true
-  VersionAdded: '5.12.0'
+  VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/NodeSet:
-  Description: Do not use the deprecated node.set method
+ChefCorrectness/ScopedFileExist:
+  Description: Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
   Enabled: true
-  VersionAdded: '5.0.0'
+  VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/NodeSetUnless:
-  Description: Do not use the deprecated node.set_unless method
+ChefCorrectness/InvalidPlatformValueForPlatformFamilyHelper:
+  Description: Pass valid platforms families to the value_for_platform_family helper.
   Enabled: true
-  VersionAdded: '5.1.0'
+  VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/EpicFail:
-  Description: Use ignore_failure method instead of the deprecated epic_fail method
+ChefCorrectness/InvalidPlatformValueForPlatformHelper:
+  Description: Pass valid platforms to the value_for_platform helper.
   Enabled: true
-  VersionAdded: '5.1.0'
+  VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/CookbookDependsOnPoise:
-  Description: Cookbooks should not depend on the deprecated Poise framework
+###############################
+# ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
+###############################
+
+ChefSharing/InsecureCookbookURL:
+  Description: Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields
   Enabled: true
   VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
   Include:
     - '**/metadata.rb'
 
-ChefDeprecations/ConflictsMetadata:
-  Description: Don't use the deprecated 'conflicts' metadata value
+ChefSharing/InvalidLicenseString:
+  Description: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved"
   Enabled: true
-  VersionAdded: '5.1.0'
+  VersionAdded: '5.2.0'
+  VersionChanged: '5.15.0'
   Include:
     - '**/metadata.rb'
 
-ChefDeprecations/SuggestsMetadata:
-  Description: Don't use the deprecated 'suggests' metadata value
+ChefSharing/DefaultMetadataMaintainer:
+  Description: Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.
   Enabled: true
-  VersionAdded: '5.1.0'
+  VersionAdded: '5.4.0'
+  VersionChanged: '5.15.0'
   Include:
     - '**/metadata.rb'
 
-ChefDeprecations/ProvidesMetadata:
-  Description: Don't use the deprecated 'provides' metadata value
+ChefSharing/EmptyMetadataField:
+  Description: metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
   Enabled: true
-  VersionAdded: '5.1.0'
+  VersionAdded: '5.8.0'
+  VersionChanged: '5.15.0'
   Include:
     - '**/metadata.rb'
 
-ChefDeprecations/ReplacesMetadata:
-  Description: Don't use the deprecated 'replaces' metadata value
+###############################
+# ChefDeprecations: Resolving Deprecations that block upgrading Chef Infra Client
+###############################
+
+ChefDeprecations/NodeDeepFetch:
+  Description: Do not use the deprecated chef-sugar node.deep_fetch methods
   Enabled: true
-  VersionAdded: '5.1.0'
-  Include:
+  VersionAdded: '5.12.0'
+  Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/AttributeMetadata:
-  Description: Don't use the deprecated 'attribute' metadata value
+ChefDeprecations/NodeSet:
+  Description: Do not use the deprecated node.set method
+  Enabled: true
+  VersionAdded: '5.0.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefDeprecations/NodeSetUnless:
+  Description: Do not use the deprecated node.set_unless method
   Enabled: true
   VersionAdded: '5.1.0'
-  Include:
+  Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/LongDescriptionMetadata:
-  Description: The long_description metadata.rb method is not used and is unnecessary in cookbooks
+ChefDeprecations/EpicFail:
+  Description: Use ignore_failure method instead of the deprecated epic_fail method
   Enabled: true
-  VersionAdded: '5.2.0'
-  Include:
+  VersionAdded: '5.1.0'
+  Exclude:
     - '**/metadata.rb'
 
-ChefDeprecations/RecipeMetadata:
-  Description: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the README.md file instead.
+ChefDeprecations/CookbookDependsOnPoise:
+  Description: Cookbooks should not depend on the deprecated Poise framework
   Enabled: true
-  VersionAdded: '5.6.0'
+  VersionAdded: '5.1.0'
   Include:
     - '**/metadata.rb'
 
@@ -698,14 +647,6 @@ ChefModernize/CustomResourceWithAttributes:
   Include:
     - '**/resources/*.rb'
 
-ChefModernize/CustomResourceWithAllowedActions:
-  Description: Resources no longer need to define the allowed actions using the allowed_actions / actions helper methods or within an initialize method.
-  Enabled: true
-  VersionAdded: '5.2.0'
-  Include:
-    - '**/resources/*.rb'
-    - '**/libraries/*.rb'
-
 ChefModernize/IncludingAptDefaultRecipe:
   Description: Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.
   Enabled: true
@@ -944,6 +885,136 @@ ChefModernize/ChefGemNokogiri:
     - '**/metadata.rb'
     - '**/attributes/*.rb'
 
+ChefModernize/PropertyWithNameAttribute:
+  Description: Resource property sets name_attribute not name_property
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefModernize/IncludingOhaiDefaultRecipe:
+  Description: Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely.
+  Enabled: true
+  VersionAdded: '5.4.0'
+  VersionChanged: '5.15.0'
+  Exclude:
+    - '**/metadata.rb'
+
+ChefModernize/AllowedActionsFromInitialize:
+  Description: The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.
+  Enabled: true
+  VersionAdded: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+###############################
+# ChefRedundantCode: Cleanup unncessary code in your cookbooks regardless of chef-client release
+###############################
+
+ChefRedundantCode/ConflictsMetadata:
+  Description: Don't use the deprecated 'conflicts' metadata value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/SuggestsMetadata:
+  Description: Don't use the deprecated 'suggests' metadata value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/ProvidesMetadata:
+  Description: Don't use the deprecated 'provides' metadata value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/ReplacesMetadata:
+  Description: Don't use the deprecated 'replaces' metadata value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/AttributeMetadata:
+  Description: Don't use the deprecated 'attribute' metadata value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/LongDescriptionMetadata:
+  Description: The long_description metadata.rb method is not used and is unnecessary in cookbooks
+  Enabled: true
+  VersionAdded: '5.2.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/RecipeMetadata:
+  Description: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the README.md file instead.
+  Enabled: true
+  VersionAdded: '5.6.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/metadata.rb'
+
+ChefRedundantCode/ResourceWithNothingAction:
+  Description: 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.
+  Enabled: true
+  VersionAdded: '5.12.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
+ChefRedundantCode/UnnecessaryNameProperty:
+  Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
+  Enabled: true
+  VersionAdded: '5.8.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefRedundantCode/PropertyWithRequiredAndDefault:
+  Description: Resource property should not be both required and have a default value
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefRedundantCode/NamePropertyIsRequired:
+  Description: Resource properties marked as name properties should not also be required properties
+  Enabled: true
+  VersionAdded: '5.1.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefRedundant/CustomResourceWithAllowedActions:
+  Description: 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.
+  Enabled: true
+  VersionAdded: '5.2.0'
+  VersionChanged: '5.15.0'
+  Include:
+    - '**/resources/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################

data/cookstyle.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Thom May', 'Tim Smith']
   spec.email         = ['thom@chef.io', 'tsmith@chef.io']
   spec.summary       = 'Cookstyle is a code linting tool that helps you to write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.'
-  spec.homepage      = 'https://github.com/chef/cookstyle'
   spec.license       = 'Apache-2.0'
   spec.required_ruby_version = '>= 2.4'
 
@@ -19,4 +18,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency('rubocop', Cookstyle::RUBOCOP_VERSION)
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/chef/cookstyle',
+    'changelog_uri' => 'https://github.com/chef/cookstyle/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/chef/cookstyle',
+    'documentation_uri' => 'https://docs.chef.io/cookstyle.html',
+    'bug_tracker_uri' => 'https://github.com/chef/cookstyle/issues',
+  }
 end

data/lib/cookstyle.rb

@@ -34,6 +34,7 @@ end
 
 require 'rubocop/chef'
 require 'rubocop/chef/cookbook_helpers'
+require 'rubocop/chef/platform_helpers'
 require 'rubocop/chef/cookbook_only'
 
 # Chef specific cops

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.14.1".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.15.7".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.75.1'.freeze
 end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -1,3 +1,19 @@
+#
+# Copyright:: Copyright 2019, 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 Chef
     # Common node helpers used for matching against Chef Infra Cookbooks