cookstyle 7.15.4 → 7.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60334725cb29031e7b6ab778a3bf005fb5ccb32e18b662155a7717b7c806398c
-  data.tar.gz: ce345f091b1124d7b5e9dd2284e973eab41412e31653a988a72de61ec38ffd84
+  metadata.gz: '029dae7e633891d64673dbd8098a21e80f6d2486d887dc01c593fed5c16d9677'
+  data.tar.gz: 2eb8ce0b238dc9c1783bca17b2800f0511c9f1ce02f7ff47d7a3857e7dc2bb5f
 SHA512:
-  metadata.gz: 3c575e4f1afdb3c162cfdfedad396226b4ae43411c0ef3e75e277904ceed392e65b930076fb51f08a6cfd91de1fa9925cf8d56d804ad763973157edca5228593
-  data.tar.gz: c25278524868aadc4895d1ed7dab6fe8d59187ff5b946befcebf6e51a2366e34129f1f84ac82177adbe7b5e1251847335fdcc64d96697f45cb2a2e3009535517
+  metadata.gz: 49abaf63bbf1c6e6a11909d4fcad7385256472ea66093459b371e67c438b022fb337554b265c9f55d2ccaaa2c904b4a1d6c91a8f4e936ac74d9017d1757b8975
+  data.tar.gz: c0ff0119835855ac64d543b15b586302da74659768926517fd107b0d3b4e3fba502b97d6fd5640a31eb4cd3a3b9544d29e418e0ae25900eda958e7deade23764

data/config/cookstyle.yml

@@ -481,6 +481,14 @@ Chef/Correctness/OctalModeAsString:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+Chef/Correctness/MetadataMalformedDepends:
+  Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
+  StyleGuide: 'chef_correctness_metadatamalformeddepends'
+  Enabled: true
+  VersionAdded: '7.16'
+  Include:
+    - '**/metadata.rb'
+
 ###############################
 # Chef/Sharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -2450,6 +2458,8 @@ Lint/HandleExceptions:
   Enabled: true
 Lint/ImplicitStringConcatenation:
   Enabled: true
+  Exclude:
+    - '**/metadata.rb' # this prevents conflicts with Chef/Correctness/MetadataMalformedDepends
 Lint/IneffectiveAccessModifier:
   Enabled: true
 Lint/LiteralAsCondition:

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.15.4" # rubocop: disable Style/StringLiterals
+  VERSION = "7.16.1" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.18.4'
 end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Correctness
+        # metadata.rb cookbook dependencies and version constraints should be comma separated
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'some_awesome_cookbook' '= 4.5.5'
+        #   depends 'some_other_cool_cookbook' '< 8.0'
+        #
+        #   #### correct
+        #   depends 'some_awesome_cookbook', '= 4.5.5'
+        #   depends 'some_other_cool_cookbook', '< 8.0'
+        #
+        class MetadataMalformedDepends < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          RESTRICT_ON_SEND = [:depends].freeze
+          MSG = 'metadata.rb cookbook dependencies and version constraints should be comma separated'
+
+          def_node_matcher :depends_without_comma?, <<-PATTERN
+            (send nil? :depends
+              (dstr
+                $(str _ )
+                $(str _ )))
+          PATTERN
+
+          def on_send(node)
+            depends_without_comma?(node) do |cb, ver|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "depends '#{cb.value}', '#{ver.value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2021, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,6 +27,7 @@ module RuboCop
         #   name 'foo'
         #
         class MetadataMissingName < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
@@ -37,11 +38,10 @@ module RuboCop
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             return if cb_name?(processed_source.ast)
             range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, message: MSG, severity: :refactor) do |_corrector|
+            add_offense(range, message: MSG, severity: :refactor) do |corrector|
               path = processed_source.path
               cb_name = File.basename(File.dirname(path))
-              metadata = IO.read(path)
-              IO.write(path, "name '#{cb_name}'\n" + metadata)
+              corrector.insert_before(processed_source.ast, "name '#{cb_name}'\n")
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.15.4
+  version: 7.16.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -69,6 +69,7 @@ files:
 - lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb
 - lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb
 - lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb
+- lib/rubocop/cop/chef/correctness/metadata_malformed_version.rb
 - lib/rubocop/cop/chef/correctness/metadata_missing_name.rb
 - lib/rubocop/cop/chef/correctness/node_normal.rb
 - lib/rubocop/cop/chef/correctness/node_normal_unless.rb