cookstyle 5.2.17 → 5.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b693c3f963fdd6689770744a4ba49fc1461c9312976cfcef2947ff938b04bc9
-  data.tar.gz: 629951dbaa3f1c0e3e116b42f0848415b524886351f67eda55c1f7208715de6f
+  metadata.gz: e6af19177bab0492d840cc42ab0b2afffaaf31c1a16492a6235811d362390f2f
+  data.tar.gz: '01748b9bfbfcc03c1d99d4e09c24db484b76fa1c12010c48d6cb37c5ed3416bc'
 SHA512:
-  metadata.gz: 92a8fca655802ef1627025fca46a23531290aba1bd7240805ba74d648b775d876bf72a5ae955b35c47852110ca05492882afb6334124b79eda310165e8930645
-  data.tar.gz: da43f5422b02cb8d57d15b13b2390f7d9064a80c4ec0b58fce0371b81eb1ab3a0ba68928475316466b52ae9f05eb7af74fa33a33be2fddd64a60da4134995ca8
+  metadata.gz: 6c84f45e06ffb944c0990ebed2d03b6a19d99c78b09c5e01fd8e16d27719c82d074364805b9e936ff793f4da805edcd706d1da7f0a16507526478603d409767c
+  data.tar.gz: 9a78e7d098beb29896f63861867766b7744bb4e5262a2aec903caed0399c9659c0c25d249a232e57795707200c0eba0bb2b5b9a7ec8b0d90fca1c66ee87f2606

data/config/cookstyle.yml

@@ -293,6 +293,41 @@ Chef/CustomResourceWithAllowedActions:
   Include:
     - '**/resources/*.rb'
 
+Chef/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
+  VersionAdded: '5.3.0'
+  Exclude:
+    - '**/metadata.rb'
+
+Chef/IncludingWindowsDefaultRecipe:
+  Description: Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client
+  Enabled: true
+  VersionAdded: '5.3.0'
+  Exclude:
+    - '**/metadata.rb'
+
+Chef/IncludingYumDNFCompatRecipe:
+  Description: Do not include the yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF.
+  Enabled: true
+  VersionAdded: '5.3.0'
+  Exclude:
+    - '**/metadata.rb'
+
+Chef/DefinesChefSpecMatchers:
+  Description: ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook
+  Enabled: true
+  VersionAdded: '5.3.0'
+  Include:
+    - '**/libraries/*.rb'
+
+Chef/ExecuteAptUpdate:
+  Description: Use the apt_update resource instead of the execute resource to run an apt-get update package cache update
+  Enabled: true
+  VersionAdded: '5.3.0'
+  Exclude:
+    - '**/metadata.rb'
+
 ###############################
 # Detecting code that breaks Chef
 ###############################

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.2.17".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.3.6".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.72.0'.freeze
 end

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

@@ -440,6 +440,7 @@ module RuboCop
         COMMON_TYPOS = {
           "all_rights": 'all rights reserved',
           "apache 2.0": 'Apache-2.0',
+          "apache v2.0": 'Apache-2.0',
           "apache license version 2.0": 'Apache-2.0',
           "apache2": 'Apache-2.0',
           "mit": 'MIT',

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

@@ -29,8 +29,14 @@ module RuboCop
       class LongDescriptionMetadata < Cop
         MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks'.freeze
 
+        def_node_matcher :long_description?, <<-PATTERN
+          (send nil? :long_description ... )
+        PATTERN
+
         def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
+          long_description?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
+          end
         end
 
         def autocorrect(node)

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

@@ -0,0 +1,47 @@
+#
+# 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 Cop
+    module Chef
+      # Don't include the apt default recipe to update apt's package cache when you can
+      # use the apt_update resource built into Chef Infra Client 12.7 and later.
+      #
+      # @example
+      #
+      #   # bad
+      #   include_recipe 'apt::default'
+      #   include_recipe 'apt'
+      #
+      #   # good
+      #   apt_update
+      #
+      class IncludingAptDefaultRecipe < Cop
+        MSG = '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.'.freeze
+
+        def_node_matcher :apt_recipe_usage?, <<-PATTERN
+          (send nil? :include_recipe (str {"apt" "apt::default"}))
+        PATTERN
+
+        def on_send(node)
+          apt_recipe_usage?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+#
+# 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 Cop
+    module Chef
+      # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
+      #
+      # @example
+      #
+      #   # bad
+      #   if defined?(ChefSpec)
+      #     def create_yum_repository(resource_name)
+      #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
+      #     end
+      #   end
+      #
+      class DefinesChefSpecMatchers < Cop
+        MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'.freeze
+
+        def_node_matcher :chefspec_matcher?, <<-PATTERN
+          (if ( :defined? (const nil? :ChefSpec)) ... )
+        PATTERN
+
+        def on_if(node)
+          chefspec_matcher?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+#
+# 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 Cop
+    module Chef
+      # Instead of using the execute resource to to run the `apt-get update` use Chef Infra Client's built-n
+      # apt_update resource which is available in Chef Infra Client 12.7 and later.
+      #
+      #   # bad
+      #   execute 'apt-get update'
+      #
+      #   # good
+      #   apt_update
+      #
+      class ExecuteAptUpdate < Cop
+        MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'.freeze
+
+        def_node_matcher :execute_apt_update?, <<-PATTERN
+          (send nil? :execute (str "apt-get update"))
+        PATTERN
+
+        def on_send(node)
+          execute_apt_update?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+#
+# 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 Cop
+    module Chef
+      # Don't include the windows default recipe that is either full of gem install that are part
+      # of the Chef Infra Client, or empty (depends on version).
+      #
+      # @example
+      #
+      #   # bad
+      #   include_recipe 'windows::default'
+      #   include_recipe 'windows'
+      #
+      class IncludingWindowsDefaultRecipe < Cop
+        MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'.freeze
+
+        def_node_matcher :windows_recipe_usage?, <<-PATTERN
+          (send nil? :include_recipe (str {"windows" "windows::default"}))
+        PATTERN
+
+        def on_send(node)
+          windows_recipe_usage?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+#
+# 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 Cop
+    module Chef
+      # Don't include the yum DNF compatibility recipe, which is no longer necessary
+      # as Chef Infra Client includes DNF package support
+      #
+      # @example
+      #
+      #   # bad
+      #   include_recipe 'yum::dnf_yum_compat'
+      #
+      class IncludingYumDNFCompatRecipe < Cop
+        MSG = 'Do not include the yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'.freeze
+
+        def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
+          (send nil? :include_recipe (str "yum::dnf_yum_compat"))
+        PATTERN
+
+        def on_send(node)
+          yum_dnf_compat_recipe_usage?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/comments_format.rb

@@ -56,7 +56,8 @@ module RuboCop
         def autocorrect(comment)
           # Extract the type and the actual value. Strip out "Name" or "File"
           # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
-          match = /^# ?([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
+          # https://rubular.com/r/Do9fpLWXlCmvdJ
+          match = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
           comment_type, value = match.captures
           correct_comment = "# #{comment_type}:: #{value}"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.2.17
+  version: 5.3.6
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,15 +105,20 @@ files:
 - lib/rubocop/cop/chef/deprecation/suggests_metadata.rb
 - lib/rubocop/cop/chef/effortless/data_bags.rb
 - lib/rubocop/cop/chef/effortless/search_used.rb
+- lib/rubocop/cop/chef/modernize/apt_default_recipe.rb
 - lib/rubocop/cop/chef/modernize/berksfile_source.rb
 - lib/rubocop/cop/chef/modernize/build_essential.rb
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
+- lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
+- lib/rubocop/cop/chef/modernize/execute_apt_update.rb
 - lib/rubocop/cop/chef/modernize/resource_set_or_return.rb
 - lib/rubocop/cop/chef/modernize/resource_with_allowed_action.rb
 - lib/rubocop/cop/chef/modernize/resource_with_attributes.rb
 - lib/rubocop/cop/chef/modernize/respond_to_provides.rb
 - lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb
 - lib/rubocop/cop/chef/modernize/why_run_supported_true.rb
+- lib/rubocop/cop/chef/modernize/windows_default_recipe.rb
+- lib/rubocop/cop/chef/modernize/yum_dnf_compat_recipe.rb
 - lib/rubocop/cop/chef/style/attribute_keys.rb
 - lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
 - lib/rubocop/cop/chef/style/comments_copyright_format.rb