chefstyle 1.1.2 → 1.4.0

data/lib/chefstyle.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
 require_relative "chefstyle/version"
 
 # ensure the desired target version of RuboCop is gem activated
 gem "rubocop", "= #{Chefstyle::RUBOCOP_VERSION}"
 require "rubocop"
 
+# @TODO remove this monkeypatch after we upgrade from 0.91.0
+require_relative "rubocop/monkey_patches/rescue_ensure_alignment"
+
 module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(
       /^.*$/,
-      File.realpath(File.join(File.dirname(__FILE__), ".."))
+      File.realpath(File.join(__dir__, ".."))
     )
 
     DEFAULT_FILE.gsub!(
@@ -21,9 +25,17 @@ end
 # Chefstyle patches the RuboCop tool to set a new default configuration that
 # is vendored in the Chefstyle codebase.
 module Chefstyle
-  # @return [String] the absolute path to the main RuboCop configuration YAML
-  #   file
+  # @return [String] the absolute path to the main RuboCop configuration YAML file
   def self.config
     RuboCop::ConfigLoader::DEFAULT_FILE
   end
 end
+
+require_relative "rubocop/chef"
+
+# Chef custom cops
+Dir.glob(__dir__ + "/rubocop/cop/chef/**/*.rb") do |file|
+  next if File.directory?(file)
+
+  require_relative file # not actually relative but require_relative is faster
+end

data/lib/chefstyle/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Chefstyle
-  VERSION = "1.1.2".freeze
-  RUBOCOP_VERSION = "0.86.0".freeze
-end
+  VERSION = "1.4.0"
+  RUBOCOP_VERSION = "0.91.0"
+end

data/lib/rubocop/chef.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module RuboCop
+  # RuboCop Chef project namespace
+  module Chef
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "chefstyle.yml").freeze
+    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(*constants(false))
+  end
+end

data/lib/rubocop/cop/chef/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 ChefRuby
+        # 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/chef/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 ChefRuby
+        # 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, %Q{require "net/http"\nrequire "openssl"})
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/ruby/ruby_27_keyword_argument_warnings.rb

@@ -0,0 +1,57 @@
+# 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 ChefRuby
+        # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
+        #
+        # @example
+        #
+        #   # bad
+        #   shell_out!('hostnamectl status', { returns: [0, 1] })
+        #   shell_out('hostnamectl status', { returns: [0, 1] })
+        #
+        #   # good
+        #   shell_out!('hostnamectl status', returns: [0, 1])
+        #   shell_out('hostnamectl status', returns: [0, 1])
+        #
+        class Ruby27KeywordArgumentWarnings < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings."
+
+          def_node_matcher :positional_shellout?, <<-PATTERN
+            (send nil? {:shell_out :shell_out!} ... $(hash ... ))
+          PATTERN
+
+          def on_send(node)
+            positional_shellout?(node) do |h|
+              next unless h.braces?
+
+              add_offense(h.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(h.loc.expression, h.loc.expression.source[1..-2])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/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 ChefRuby
+        # 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",
+            "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",
+            "yaml" => "YAML",
+            "yard" => "YARD",
+            "zip" => "Zip",
+            "zlib" => "Zlib",
+          }.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/monkey_patches/rescue_ensure_alignment.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module RuboCop
+  module Cop
+    module Layout
+      class RescueEnsureAlignment < Base
+        # @TODO remove this monkeypatch after we upgrade from RuboCop 0.91.0
+        def begin_end_alignment_style
+          # FIXME: Workaround for pending status for `Layout/BeginEndAlignment` cop
+          #        When RuboCop 1.0 is released, please replace it with the following condition.
+          #
+          # config.for_cop('Layout/BeginEndAlignment')['Enabled'] &&
+          #   config.for_cop('Layout/BeginEndAlignment')['EnforcedStyleAlignWith']
+          if config.for_all_cops["NewCops"] == "enable" ||
+              config.for_cop("Layout/BeginEndAlignment")["Enabled"] &&
+                  config.for_cop("Layout/BeginEndAlignment")["Enabled"] != "pending"
+            config.for_cop("Layout/BeginEndAlignment")["EnforcedStyleAlignWith"]
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chefstyle
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.91.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.91.0
 description: 
 email:
 - oss@chef.io
@@ -83,6 +41,12 @@ files:
 - config/upstream.yml
 - lib/chefstyle.rb
 - lib/chefstyle/version.rb
+- lib/rubocop/chef.rb
+- lib/rubocop/cop/chef/ruby/gemspec_require_rubygems.rb
+- lib/rubocop/cop/chef/ruby/require_net_https.rb
+- lib/rubocop/cop/chef/ruby/ruby_27_keyword_argument_warnings.rb
+- lib/rubocop/cop/chef/ruby/unless_defined_require.rb
+- lib/rubocop/monkey_patches/rescue_ensure_alignment.rb
 homepage: https://github.com/chef/chefstyle
 licenses:
 - Apache-2.0