cookstyle 5.0.4 → 5.1.19

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

@@ -0,0 +1,59 @@
+#
+# 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
+      # Over the course of years there have been many different valid community site / Supermarket
+      # URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects,
+      # but should be updated to point to the latest Supermarket URL.
+      #
+      # @example
+      #
+      #   # bad
+      #   source 'http://community.opscode.com/api/v3'
+      #   source 'https://supermarket.getchef.com'
+      #   source 'https://api.berkshelf.com'
+      #
+      #   # good
+      #   source 'https://supermarket.chef.io'
+      #
+      class LegacyBerksfileSource < Cop
+        MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'.freeze
+
+        def_node_matcher :berksfile_source?, <<-PATTERN
+          (send nil? :source (str #old_berkshelf_url?))
+        PATTERN
+
+        def old_berkshelf_url?(url)
+          %w(http://community.opscode.com/api/v3 https://supermarket.getchef.com https://api.berkshelf.com).include?(url)
+        end
+
+        def on_send(node)
+          berksfile_source?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/build_essential.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
+      # Use secure Github and Gitlab URLs for source_url and issues_url
+      #
+      # @example
+      #
+      #   # bad
+      #   depends 'build-essential'
+      #   include_recipe 'build-essential::default'
+      #   include_recipe 'build-essential'
+      #
+      #   # good
+      #   build_essential 'install compilation tools'
+      class UseBuildEssentialResource < Cop
+        MSG = 'Use the build_essential resource built into Chef 14+ instead of the legacy build-essential recipe'.freeze
+
+        def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
+          (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
+        PATTERN
+
+        def on_send(node)
+          build_essential_recipe_usage?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+#
+# 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 depend on cookbooks made obsolete by Chef 14
+      #
+      # @example
+      #
+      #   # bad
+      #   depends 'build-essential'
+      #   depends 'chef_handler'
+      #   depends 'chef_hostname'
+      #   depends 'dmg'
+      #   depends 'mac_os_x'
+      #   depends 'swap'
+      #   depends 'sysctl'
+      #
+      class UnnecessaryDependsChef14 < Cop
+        MSG = "Don't depend on cookbooks made obsolete by Chef 14".freeze
+
+        def_node_matcher :legacy_depends?, <<-PATTERN
+          (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}))
+        PATTERN
+
+        def on_send(node)
+          legacy_depends?(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/why_run_supported_true.rb

@@ -0,0 +1,46 @@
+#
+# 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
+      # why_run_supported? no longer needs to be set to true as that is the default in Chef 13+
+      #
+      # @example
+      #
+      #   # bad
+      #   def why_run_supported?
+      #    true
+      #   end
+      #
+      class WhyRunSupportedTrue < Cop
+        MSG = 'why_run_supported? no longer needs to be set to true as it is the default in Chef 13+'.freeze
+
+        def on_def(node)
+          if node.method_name == :why_run_supported? && node.body == s(:true) # rubocop: disable Lint/BooleanSymbol
+            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/{attribute_keys.rb → style/attribute_keys.rb}

@@ -68,10 +68,10 @@ module RuboCop
         def on_node_attribute_access(node)
           if node.type == :str
             style_detected(:strings)
-            add_offense(node, location: :expression, message: MSG % style, severity: :warning) if style == :symbols
+            add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :symbols
           elsif node.type == :sym
             style_detected(:symbols)
-            add_offense(node, location: :expression, message: MSG % style, severity: :warning) if style == :strings
+            add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :strings
           end
         end
 

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

@@ -0,0 +1,42 @@
+#
+# Copyright:: 2016-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
+      # Replaces double spaces between sentences with a single space.
+      # Note: This is DISABLED by default.
+      class CommentSentenceSpacing < Cop
+        MSG = 'Use a single space after sentences in comments'.freeze
+
+        def investigate(processed_source)
+          return unless processed_source.ast
+
+          processed_source.comments.each do |comment|
+            if comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+
+        def autocorrect(comment)
+          ->(corrector) { corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? ')) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/{comments_copyright_format.rb → style/comments_copyright_format.rb}

@@ -1,5 +1,6 @@
 #
-# Copyright:: 2016, Tim Smith
+# Copyright:: 2016-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.
@@ -42,11 +43,12 @@ module RuboCop
 
         def investigate(processed_source)
           return unless processed_source.ast
+
           processed_source.comments.each do |comment|
             next unless comment.inline? # headers aren't in blocks
 
             if invalid_copyright_comment?(comment)
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :warning)
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
             end
           end
         end
@@ -63,6 +65,7 @@ module RuboCop
 
           # no copyright year present so return this year
           return Time.new.year if dates.empty?
+
           oldest_date = dates.min[0].to_i
 
           # Avoid returning THIS_YEAR - THIS_YEAR

data/lib/rubocop/cop/chef/{comments_format.rb → style/comments_format.rb}

@@ -1,5 +1,5 @@
 #
-# Copyright 2016, Tim Smith
+# Copyright:: 2016, Tim Smith
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -42,11 +42,13 @@ module RuboCop
 
         def investigate(processed_source)
           return unless processed_source.ast
+
           processed_source.comments.each do |comment|
+            next if comment.loc.first_line > 10 # avoid false positives when we were checking further down the file
             next unless comment.inline? # headers aren't in blocks
 
             if invalid_comment?(comment)
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :warning)
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/{file_mode.rb → style/file_mode.rb}

@@ -37,9 +37,7 @@ module RuboCop
 
         def on_send(node)
           resource_mode?(node) do |mode_int|
-            # for post April 2020
-            # add_offense(mode_int, location: :expression, message: MSG, severity: octal?(mode_int) ? :warning : :error)
-            add_offense(mode_int, location: :expression, message: MSG, severity: :warning)
+            add_offense(mode_int, location: :expression, message: MSG, severity: :refactor)
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.1.19
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,13 +74,38 @@ files:
 - lib/cookstyle/version.rb
 - lib/rubocop/chef.rb
 - lib/rubocop/chef/cookbook_only.rb
-- lib/rubocop/cop/chef/attribute_keys.rb
-- lib/rubocop/cop/chef/comments_copyright_format.rb
-- lib/rubocop/cop/chef/comments_format.rb
-- lib/rubocop/cop/chef/file_mode.rb
-- lib/rubocop/cop/chef/node_set.rb
-- lib/rubocop/cop/chef/service_resource.rb
-- lib/rubocop/cop/chef/tmp_path.rb
+- lib/rubocop/cop/chef/correctness/insecure_cookbook_url.rb
+- lib/rubocop/cop/chef/correctness/name_property_and_required.rb
+- lib/rubocop/cop/chef/correctness/node_normal.rb
+- lib/rubocop/cop/chef/correctness/node_normal_unless.rb
+- lib/rubocop/cop/chef/correctness/property_with_default_and_required.rb
+- lib/rubocop/cop/chef/correctness/property_with_name_attribute.rb
+- lib/rubocop/cop/chef/correctness/service_resource.rb
+- lib/rubocop/cop/chef/correctness/tmp_path.rb
+- lib/rubocop/cop/chef/deprecation/attribute_metadata.rb
+- lib/rubocop/cop/chef/deprecation/conflicts_metadata.rb
+- lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb
+- lib/rubocop/cop/chef/deprecation/depends_partial_search.rb
+- lib/rubocop/cop/chef/deprecation/depends_poise.rb
+- lib/rubocop/cop/chef/deprecation/easy_install.rb
+- lib/rubocop/cop/chef/deprecation/epic_fail.rb
+- lib/rubocop/cop/chef/deprecation/erl_call.rb
+- lib/rubocop/cop/chef/deprecation/node_set.rb
+- lib/rubocop/cop/chef/deprecation/node_set_unless.rb
+- lib/rubocop/cop/chef/deprecation/provides_metadata.rb
+- lib/rubocop/cop/chef/deprecation/replaces_metadata.rb
+- 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/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/why_run_supported_true.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
+- lib/rubocop/cop/chef/style/comments_format.rb
+- lib/rubocop/cop/chef/style/file_mode.rb
 homepage: https://github.com/chef/cookstyle
 licenses:
 - Apache-2.0