cookstyle 7.32.8 → 8.0.0

data/config/default.yml

@@ -1,2 +1,2 @@
-inherit_from:
-  - cookstyle.yml
+inherit_from:
+  - cookstyle.yml

data/cookstyle.gemspec

@@ -1,30 +1,34 @@
-# frozen_string_literal: true
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cookstyle/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'cookstyle'
-  spec.version       = Cookstyle::VERSION
-  spec.authors       = ['Thom May', 'Tim Smith']
-  spec.email         = ['thom@chef.io', 'tsmith84@gmail.com']
-  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.license       = 'Apache-2.0'
-  spec.homepage      = 'https://docs.chef.io/workstation/cookstyle/'
-  spec.required_ruby_version = '>= 2.7'
-
-  # the gemspec and Gemfile are necessary for appbundling of the gem
-  spec.files = %w(LICENSE cookstyle.gemspec Gemfile) + Dir.glob('{lib,bin,config}/**/*')
-  spec.executables = %w(cookstyle)
-  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/main/CHANGELOG.md',
-    'source_code_uri' => 'https://github.com/chef/cookstyle',
-    'documentation_uri' => 'https://docs.chef.io/workstation/cookstyle/',
-    'bug_tracker_uri' => 'https://github.com/chef/cookstyle/issues',
-  }
-end
+# frozen_string_literal: true
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cookstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cookstyle'
+  spec.version       = Cookstyle::VERSION
+  spec.authors       = ['Thom May', 'Tim Smith']
+  spec.email         = ['thom@chef.io', 'tsmith84@gmail.com']
+  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.license       = 'Apache-2.0'
+  spec.homepage      = 'https://docs.chef.io/workstation/cookstyle/'
+  spec.required_ruby_version = '>= 2.7'
+
+  # the gemspec and Gemfile are necessary for appbundling of the gem
+  spec.files = %w(LICENSE cookstyle.gemspec Gemfile) + Dir.glob('{lib,bin,config}/**/*')
+  spec.executables = %w(cookstyle)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('rubocop', Cookstyle::RUBOCOP_VERSION)
+
+  # remove these dependencies once we upgrade to a modern rubocop
+  spec.add_dependency('base64')
+  spec.add_dependency('ostruct')
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/chef/cookstyle',
+    'changelog_uri' => 'https://github.com/chef/cookstyle/blob/main/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/chef/cookstyle',
+    'documentation_uri' => 'https://docs.chef.io/workstation/cookstyle/',
+    'bug_tracker_uri' => 'https://github.com/chef/cookstyle/issues',
+  }
+end

data/lib/cookstyle/chefstyle.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-module Cookstyle
-  CHEFSTYLE_CONFIG = true
-end
-require_relative '../cookstyle'
+# frozen_string_literal: true
+module Cookstyle
+  CHEFSTYLE_CONFIG = true
+end
+require_relative '../cookstyle'

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-module Cookstyle
-  VERSION = "7.32.8" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.25.1'
-end
+# frozen_string_literal: true
+module Cookstyle
+  VERSION = "8.0.0" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.75.2'
+end

data/lib/cookstyle.rb

@@ -1,45 +1,48 @@
-# frozen_string_literal: true
-require_relative 'cookstyle/version'
-
-require 'pathname' unless defined?(Pathname)
-require 'yaml' unless defined?(YAML)
-
-# ensure the desired target version of RuboCop is gem activated
-gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
-require 'rubocop'
-require_relative 'rubocop/monkey_patches/directive_comment'
-
-# monkey patches needed for the TargetChefVersion config option
-require_relative 'rubocop/monkey_patches/config'
-require_relative 'rubocop/monkey_patches/base'
-require_relative 'rubocop/monkey_patches/team'
-require_relative 'rubocop/monkey_patches/registry_cop'
-
-# Cookstyle patches the RuboCop tool to set a new default configuration that
-# is vendored in the Cookstyle codebase.
-module Cookstyle
-  # @return [String] the absolute path to the main RuboCop configuration YAML file
-  def self.config
-    config_file = const_defined?('CHEFSTYLE_CONFIG') ? 'chefstyle.yml' : 'default.yml'
-    File.realpath(File.join(__dir__, '..', 'config', config_file))
-  end
-end
-
-require_relative 'rubocop/chef'
-require_relative 'rubocop/chef/autocorrect_helpers'
-require_relative 'rubocop/chef/cookbook_helpers'
-require_relative 'rubocop/chef/platform_helpers'
-require_relative 'rubocop/chef/cookbook_only'
-require_relative 'rubocop/cop/target_chef_version'
-
-# Chef Infra specific cops
-Dir.glob(__dir__ + '/rubocop/cop/**/*.rb') do |file|
-  next if File.directory?(file)
-
-  require_relative file # not actually relative but require_relative is faster
-end
-
-# stub default value of TargetChefVersion to avoid STDERR noise
-RuboCop::ConfigLoader.default_configuration['AllCops']['TargetChefVersion'] = '~'
-
-RuboCop::ConfigLoader.default_configuration = RuboCop::ConfigLoader.configuration_from_file(Cookstyle.config)
+# frozen_string_literal: true
+require_relative 'cookstyle/version'
+
+require 'pathname' unless defined?(Pathname)
+require 'yaml' unless defined?(YAML)
+
+# ensure the desired target version of RuboCop is gem activated
+gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
+require 'rubocop'
+require_relative 'rubocop/monkey_patches/directive_comment'
+
+# monkey patches needed for the TargetChefVersion config option
+require_relative 'rubocop/monkey_patches/config'
+require_relative 'rubocop/monkey_patches/base'
+require_relative 'rubocop/monkey_patches/team'
+require_relative 'rubocop/monkey_patches/registry_cop'
+
+# Cookstyle patches the RuboCop tool to set a new default configuration that
+# is vendored in the Cookstyle codebase.
+module Cookstyle
+  # @return [String] the absolute path to the main RuboCop configuration YAML file
+  def self.config
+    config_file = const_defined?(:CHEFSTYLE_CONFIG) ? 'chefstyle.yml' : 'default.yml'
+    File.realpath(File.join(__dir__, '..', 'config', config_file))
+  end
+end
+
+require_relative 'rubocop/chef'
+require_relative 'rubocop/chef/autocorrect_helpers'
+require_relative 'rubocop/chef/cookbook_helpers'
+require_relative 'rubocop/chef/platform_helpers'
+require_relative 'rubocop/chef/cookbook_only'
+require_relative 'rubocop/cop/target_chef_version'
+
+# Chef Infra specific cops
+Dir.glob(__dir__ + '/rubocop/cop/**/*.rb') do |file|
+  next if File.directory?(file)
+
+  require_relative file # not actually relative but require_relative is faster
+end
+
+# stub default value of TargetChefVersion to avoid STDERR noise when ConfigLoader.configuration_from_file runs
+RuboCop::ConfigLoader.default_configuration['AllCops']['TargetChefVersion'] ||= nil
+
+RuboCop::ConfigLoader.default_configuration = RuboCop::ConfigLoader.configuration_from_file(Cookstyle.config)
+
+# re-stub TargetChefVersion to avoid STDERR noise on *next* configuration load
+RuboCop::ConfigLoader.default_configuration['AllCops']['TargetChefVersion'] ||= nil

data/lib/rubocop/chef/autocorrect_helpers.rb

@@ -1,33 +1,33 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2020, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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
-    # Helpers for use in autocorrection
-    module AutocorrectHelpers
-      # if the node has a heredoc as an argument you'll only get the start of the heredoc and removing
-      # the node will result in broken ruby. This way we match the node and the entire heredoc for removal
-      def expression_including_heredocs(node)
-        if node.arguments.last.respond_to?(:heredoc?) && node.arguments.last.heredoc?
-          node.loc.expression.join(node.arguments.last.loc.heredoc_end)
-        else
-          node.loc.expression
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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
+    # Helpers for use in autocorrection
+    module AutocorrectHelpers
+      # if the node has a heredoc as an argument you'll only get the start of the heredoc and removing
+      # the node will result in broken ruby. This way we match the node and the entire heredoc for removal
+      def expression_including_heredocs(node)
+        if node.arguments.last.respond_to?(:heredoc?) && node.arguments.last.heredoc?
+          node.loc.expression.join(node.arguments.last.loc.heredoc_end)
+        else
+          node.loc.expression
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -1,127 +1,127 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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
-    module CookbookHelpers
-      def resource_block_name_if_string(node)
-        if looks_like_resource?(node) && node.children.first.arguments.first.respond_to?(:value)
-          node.children.first.arguments.first.value
-        end
-      end
-
-      # Match a particular resource
-      #
-      # @param [String] resource_name The name of the resource to match
-      # @param [RuboCop::AST::Node] node The rubocop ast node to search
-      #
-      # @yield
-      #
-      def match_resource_type?(resource_name, node)
-        return unless looks_like_resource?(node)
-        # bail out if we're not in the resource we care about or nil was passed (all resources)
-        yield(node) if node.children.first.method?(resource_name.to_sym)
-      end
-
-      # Match particular properties within a resource
-      #
-      # @param [Symbol, Array<Symbol>] resource_names The name of the resources to match
-      # @param [String] property_names The name of the property to match (or action)
-      # @param [RuboCop::AST::Node] node The rubocop ast node to search
-      #
-      # @yield
-      #
-      def match_property_in_resource?(resource_names, property_names, node)
-        return unless looks_like_resource?(node)
-        # bail out if we're not in the resource we care about or nil was passed (all resources)
-        return unless resource_names.nil? || Array(resource_names).include?(node.children.first.method_name) # see if we're in the right resource
-
-        resource_block = node.children[2] # the 3rd child is the actual block in the resource
-        return unless resource_block # nil would be an empty block
-
-        if resource_block.begin_type? # if begin_type we need to iterate over the children
-          resource_block.children.each do |resource_blk_child|
-            extract_send_types(resource_blk_child) do |p|
-              yield(p) if symbolized_property_types(property_names).include?(p.method_name)
-            end
-          end
-        else # there's only a single property to check
-          extract_send_types(resource_block) do |p|
-            yield(p) if symbolized_property_types(property_names).include?(p.method_name)
-          end
-        end
-      end
-
-      def method_arg_ast_to_string(ast)
-        # a property without a value. This is totally bogus, but they exist
-        return if ast.children[2].nil?
-        # https://rubular.com/r/6uzOMd6WCHewOu
-        m = ast.children[2].source.match(/^("|')(.*)("|')$/)
-        return m[2] unless m.nil?
-      end
-
-      private
-
-      # @param [String, Array] property
-      #
-      # @return [Array]
-      def symbolized_property_types(property)
-        Array(property).map(&:to_sym)
-      end
-
-      #
-      # given a node object does it look like a chef resource or not?
-      # warning: currently this requires a resource with properties since we key off blocks and property-less resources look like methods
-      #
-      # @param [RuboCop::AST::Node] node AST object to test
-      #
-      # @return [boolean]
-      #
-      def looks_like_resource?(node)
-        return false unless node.block_type? # resources are blocks if they have properties
-        return false unless node.children.first.receiver.nil? # resource blocks don't have a receiver
-        return false if node.send_node.arguments.first.is_a?(RuboCop::AST::SymbolNode) # resources have a string name. resource actions have symbols
-
-        # bail if the block doesn't have a name a resource *generally* has a name.
-        # This isn't 100% true with things like apt_update and build_essential, but we'll live
-        # with that for now to avoid the false positives of getting stuck in generic blocks in resources
-        return false if node.children.first.arguments.empty?
-
-        # if we made it this far we're probably in a resource
-        true
-      end
-
-      def extract_send_types(node)
-        return if node.nil? # there are cases we can be passed an empty node
-        case node.type
-        when :send
-          yield(node) if node.receiver.nil? # if it's not nil then we're not in a property foo we're in bar.foo
-        when :block # ie: not_if { ruby_foo }
-          yield(node)
-        when :while
-          extract_send_types(node.body) { |t| yield(t) }
-        when :if
-          node.branches.each { |n| extract_send_types(n) { |t| yield(t) } }
-        when :case
-          node.when_branches.each { |n| extract_send_types(n.body) { |t| yield(t) } } # unless node.when_branches.nil?
-          extract_send_types(node.else_branch) { |t| yield(t) } if node.else_branch
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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
+    module CookbookHelpers
+      def resource_block_name_if_string(node)
+        if looks_like_resource?(node) && node.children.first.arguments.first.respond_to?(:value)
+          node.children.first.arguments.first.value
+        end
+      end
+
+      # Match a particular resource
+      #
+      # @param [String] resource_name The name of the resource to match
+      # @param [RuboCop::AST::Node] node The rubocop ast node to search
+      #
+      # @yield
+      #
+      def match_resource_type?(resource_name, node)
+        return unless looks_like_resource?(node)
+        # bail out if we're not in the resource we care about or nil was passed (all resources)
+        yield(node) if node.children.first.method?(resource_name.to_sym)
+      end
+
+      # Match particular properties within a resource
+      #
+      # @param [Symbol, Array<Symbol>] resource_names The name of the resources to match
+      # @param [String] property_names The name of the property to match (or action)
+      # @param [RuboCop::AST::Node] node The rubocop ast node to search
+      #
+      # @yield
+      #
+      def match_property_in_resource?(resource_names, property_names, node)
+        return unless looks_like_resource?(node)
+        # bail out if we're not in the resource we care about or nil was passed (all resources)
+        return unless resource_names.nil? || Array(resource_names).include?(node.children.first.method_name) # see if we're in the right resource
+
+        resource_block = node.children[2] # the 3rd child is the actual block in the resource
+        return unless resource_block # nil would be an empty block
+
+        if resource_block.begin_type? # if begin_type we need to iterate over the children
+          resource_block.children.each do |resource_blk_child|
+            extract_send_types(resource_blk_child) do |p|
+              yield(p) if symbolized_property_types(property_names).include?(p.method_name)
+            end
+          end
+        else # there's only a single property to check
+          extract_send_types(resource_block) do |p|
+            yield(p) if symbolized_property_types(property_names).include?(p.method_name)
+          end
+        end
+      end
+
+      def method_arg_ast_to_string(ast)
+        # a property without a value. This is totally bogus, but they exist
+        return if ast.children[2].nil?
+        # https://rubular.com/r/6uzOMd6WCHewOu
+        m = ast.children[2].source.match(/^("|')(.*)("|')$/)
+        m[2] unless m.nil?
+      end
+
+      private
+
+      # @param [String, Array] property
+      #
+      # @return [Array]
+      def symbolized_property_types(property)
+        Array(property).map(&:to_sym)
+      end
+
+      #
+      # given a node object does it look like a chef resource or not?
+      # warning: currently this requires a resource with properties since we key off blocks and property-less resources look like methods
+      #
+      # @param [RuboCop::AST::Node] node AST object to test
+      #
+      # @return [boolean]
+      #
+      def looks_like_resource?(node)
+        return false unless node.block_type? # resources are blocks if they have properties
+        return false unless node.children.first.receiver.nil? # resource blocks don't have a receiver
+        return false if node.send_node.arguments.first.is_a?(RuboCop::AST::SymbolNode) # resources have a string name. resource actions have symbols
+
+        # bail if the block doesn't have a name a resource *generally* has a name.
+        # This isn't 100% true with things like apt_update and build_essential, but we'll live
+        # with that for now to avoid the false positives of getting stuck in generic blocks in resources
+        return false if node.children.first.arguments.empty?
+
+        # if we made it this far we're probably in a resource
+        true
+      end
+
+      def extract_send_types(node)
+        return if node.nil? # there are cases we can be passed an empty node
+        case node.type
+        when :send
+          yield(node) if node.receiver.nil? # if it's not nil then we're not in a property foo we're in bar.foo
+        when :block # ie: not_if { ruby_foo }
+          yield(node)
+        when :while
+          extract_send_types(node.body) { |t| yield(t) }
+        when :if
+          node.branches.each { |n| extract_send_types(n) { |t| yield(t) } }
+        when :case
+          node.when_branches.each { |n| extract_send_types(n.body) { |t| yield(t) } } # unless node.when_branches.nil?
+          extract_send_types(node.else_branch) { |t| yield(t) } if node.else_branch
+        end
+      end
+    end
+  end
+end