cookstyle 7.32.2 → 7.32.8

data/lib/rubocop/cop/chefstyle/ruby/gemspec_license.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # All gemspec files should define their license.
+        #
+        # @example
+        #
+        #   # good
+        #   spec.license = "Apache-2.0"
+        #
+        class GemspecLicense < Base
+          include RangeHelp
+
+          MSG = 'All gemspec files should define their license.'
+
+          def_node_search :license, <<~PATTERN
+            (send _ {:license= :licenses=} _)
+          PATTERN
+
+          def_node_search :eval_method, <<~PATTERN
+            (send nil? {:eval :instance_eval} ... )
+          PATTERN
+
+          def on_new_investigation
+            # exit if we find a license statement or any eval since that usually happens
+            # when we have a windows platform gem that evals the main gemspec
+            return if license(processed_source.ast).first || eval_method(processed_source.ast).first
+
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, message: MSG, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chefstyle/ruby/gemspec_require_rubygems.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # Rubygems does not need to be required in a Gemspec. It's already loaded out of the box in Ruby now.
+        class GemspecRequireRubygems < Base
+          extend RuboCop::Cop::AutoCorrector
+          include RangeHelp
+
+          MSG = "Rubygems does not need to be required in a Gemspec. It's already loaded out of the box in Ruby now."
+
+          def_node_matcher :require_rubygems?, <<-PATTERN
+            (send nil? :require (str "rubygems") )
+          PATTERN
+
+          def on_send(node)
+            require_rubygems?(node) do |_r|
+              node = node.parent if node.parent && node.parent.conditional? # make sure we identify conditionals on the require
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chefstyle/ruby/legacy_powershell_out_methods.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # Use powershell_exec!/powershell_exec instead of powershell_out!/powershell_out. The new
+        # methods don't spawn 2 shells per shellout and instead use .NET bindings to call PS directly.
+        class LegacyPowershellOutMethods < Base
+          MSG = 'Use powershell_exec!/powershell_exec instead of the slower legacy powershell_out!/powershell_out methods.'
+          RESTRICT_ON_SEND = %i(powershell_out! powershell_out).freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chefstyle/ruby/require_net_https.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # net/https is deprecated and just includes net/http and openssl. We should include those directly instead.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'net/https'
+        #
+        #   # good
+        #   require 'net/http'
+        #   require 'openssl'
+        #
+        class RequireNetHttps < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'net/https is deprecated and just includes net/http and openssl. We should include those directly instead.'
+
+          def_node_matcher :require_net_https?, <<-PATTERN
+            (send nil? :require (str "net/https"))
+          PATTERN
+
+          def on_send(node)
+            require_net_https?(node) do
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, %(require "net/http"\nrequire "openssl"))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chefstyle/ruby/unless_defined_require.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # Rubygems is VERY slow to require gems even if they've already been loaded. To work around this
+        # wrap your require statement with an `if defined?()` check.
+        #
+        class UnlessDefinedRequire < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "Workaround rubygems slow requires by only running require if the class isn't already defined"
+
+          REQUIRE_TO_CLASS = {
+            'addressable/uri' => 'Addressable::URI',
+            'appscript' => 'Appscript',
+            'base64' => 'Base64',
+            'benchmark' => 'Benchmark',
+            'cgi' => 'CGI',
+            'chef-utils' => 'ChefUtils::CANARY',
+            'chef-utils/dist' => 'ChefUtils::Dist',
+            'csv' => 'CSV',
+            'digest' => 'Digest',
+            'digest/md5' => 'Digest::MD5',
+            'digest/sha1' => 'Digest::SHA1',
+            'digest/sha2' => 'Digest::SHA2',
+            'droplet_kit' => 'DropletKit',
+            'erb' => 'Erb',
+            'erubis' => 'Erubis',
+            'etc' => 'Etc',
+            'excon' => 'Excon',
+            'faraday' => 'Faraday',
+            'ffi_yajl' => 'FFI_Yajl',
+            'ffi' => 'FFI',
+            'fileutils' => 'FileUtils',
+            'find' => 'Find.find',
+            'forwardable' => 'Forwardable',
+            'ipaddr' => 'IPAddr',
+            'json' => 'JSON',
+            'mime/types' => 'MIME::Types',
+            'mixlib/archive' => 'Mixlib::Archive',
+            'mixlib/cli' => 'Mixlib::CLI',
+            'mixlib/config' => 'Mixlib::Config',
+            'mixlib/shellout' => 'Mixlib::ShellOut',
+            'multi_json' => 'MultiJson',
+            'net/http' => 'Net::HTTP',
+            'net/ssh' => 'Net::SSH',
+            'netaddr' => 'NetAddr',
+            'nokogiri' => 'Nokogiri',
+            'ohai' => 'Ohai::System',
+            'open-uri' => 'OpenURI',
+            'openssl' => 'OpenSSL',
+            'optparse' => 'OptionParser',
+            'ostruct' => 'OpenStruct',
+            'pathname' => 'Pathname',
+            'pp' => 'PP',
+            'rack' => 'Rack',
+            'rbconfig' => 'RbConfig',
+            'retryable' => 'Retryable',
+            'rexml/document' => 'REXML::Document',
+            'rubygems' => 'Gem',
+            'rubygems/package' => 'Gem::Package',
+            'securerandom' => 'SecureRandom',
+            'set' => 'Set',
+            'shellwords' => 'Shellwords',
+            'singleton' => 'Singleton',
+            'socket' => 'Socket',
+            'sslshake' => 'SSLShake',
+            'stringio' => 'StringIO',
+            'tempfile' => 'Tempfile',
+            'thor' => 'Thor',
+            'time' => 'Time.zone_offset',
+            'timeout' => 'Timeout',
+            'tmpdir' => 'Dir.mktmpdir',
+            'tomlrb' => 'Tomlrb',
+            'uri' => 'URI',
+            'webrick' => 'WEBrick',
+            'win32/registry' => 'Win32::Registry',
+            'win32ole' => 'WIN32OLE',
+            'winrm' => 'WinRM::Connection',
+            'yard' => 'YARD',
+            'zip' => 'Zip',
+            'zlib' => 'Zlib',
+            'pastel' => 'Pastel',
+          }.freeze
+
+          def_node_matcher :require?, <<-PATTERN
+            (send nil? :require (str $_) )
+          PATTERN
+
+          def on_send(node)
+            require?(node) do |r|
+              next if node.parent && node.parent.conditional? # catch both if and unless
+              next unless REQUIRE_TO_CLASS[r]
+
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "#{node.source} unless defined?(#{REQUIRE_TO_CLASS[r]})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   login_defs_umask = input('login_defs_umask', default: '077', description: 'Default umask to set in login.defs')
         #
-        #   #### correct
+        #   ### correct
         #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
         #
         class AttributeDefault < Base

data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   login_defs_umask = attribute('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
         #
-        #   #### correct
+        #   ### correct
         #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
         #
         class AttributeHelper < Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.32.2
+  version: 7.32.8
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,12 +38,12 @@ files:
 - LICENSE
 - bin/cookstyle
 - bin/cookstyle-profile
+- config/chefstyle.yml
 - config/cookstyle.yml
 - config/default.yml
-- config/disable_all.yml
-- config/upstream.yml
 - cookstyle.gemspec
 - lib/cookstyle.rb
+- lib/cookstyle/chefstyle.rb
 - lib/cookstyle/version.rb
 - lib/rubocop/chef.rb
 - lib/rubocop/chef/autocorrect_helpers.rb
@@ -301,6 +301,11 @@ files:
 - lib/rubocop/cop/chef/style/unnecessary_os_check.rb
 - lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
+- lib/rubocop/cop/chefstyle/ruby/gemspec_license.rb
+- lib/rubocop/cop/chefstyle/ruby/gemspec_require_rubygems.rb
+- lib/rubocop/cop/chefstyle/ruby/legacy_powershell_out_methods.rb
+- lib/rubocop/cop/chefstyle/ruby/require_net_https.rb
+- lib/rubocop/cop/chefstyle/ruby/unless_defined_require.rb
 - lib/rubocop/cop/inspec/deprecation/attribute_default.rb
 - lib/rubocop/cop/inspec/deprecation/attribute_helper.rb
 - lib/rubocop/cop/target_chef_version.rb