chefspec 9.2.0 → 9.3.2

data/lib/chefspec/coverage.rb

@@ -1,4 +1,4 @@
-require_relative 'coverage/filters'
+require_relative "coverage/filters"
 
 module ChefSpec
   class Coverage
@@ -30,14 +30,14 @@ module ChefSpec
       @filters    = {}
       @outputs    = []
       add_output do |report|
-        begin
-          erb = Erubis::Eruby.new(File.read(@template))
-          puts erb.evaluate(report)
-        rescue NameError => e
-          raise Error::ErbTemplateParseError.new(original_error: e.message)
-        end
+
+        erb = Erubis::Eruby.new(File.read(@template))
+        puts erb.evaluate(report)
+      rescue NameError => e
+        raise Error::ErbTemplateParseError.new(original_error: e.message)
+
       end
-      @template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
+      @template = ChefSpec.root.join("templates", "coverage", "human.erb")
     end
 
     #
@@ -63,17 +63,17 @@ module ChefSpec
     def add_filter(filter = nil, &block)
       id = "#{filter.inspect}/#{block.inspect}".hash
 
-      @filters[id] = if filter.kind_of?(Filter)
+      @filters[id] = if filter.is_a?(Filter)
                        filter
-                     elsif filter.kind_of?(String)
+                     elsif filter.is_a?(String)
                        StringFilter.new(filter)
-                     elsif filter.kind_of?(Regexp)
+                     elsif filter.is_a?(Regexp)
                        RegexpFilter.new(filter)
                      elsif block
                        BlockFilter.new(block)
                      else
-                       raise ArgumentError, 'Please specify either a string, ' \
-                         'filter, or block to filter source files with!'
+                       raise ArgumentError, "Please specify either a string, " \
+                         "filter, or block to filter source files with!"
                      end
 
       true
@@ -98,18 +98,14 @@ module ChefSpec
     #
     # @return [true]
     #
-    def set_template(file = 'human.erb')
-      [
-        ChefSpec.root.join('templates', 'coverage', file),
-        File.expand_path(file, Dir.pwd)
-      ].each do |temp|
-        if File.exist?(temp)
-          @template = temp
-          return
-        end
-      end
-      raise Error::TemplateNotFound.new(path: file)
+    def set_template(file = "human.erb")
+      @template = [
+        ChefSpec.root.join("templates", "coverage", file),
+        File.expand_path(file, Dir.pwd),
+      ].find { |f| File.exist?(f) }
+      raise Error::TemplateNotFound.new(path: file) unless @template
     end
+
     #
     # Add a resource to the resource collection. Only new resources are added
     # and only resources that match the given filter are covered (which is *
@@ -129,9 +125,8 @@ module ChefSpec
     # @param [Chef::Resource] resource
     #
     def cover!(resource)
-      if wrapper = find(resource)
-        wrapper.touch!
-      end
+      wrapper = find(resource)
+      wrapper.touch! if wrapper
     end
 
     #
@@ -166,7 +161,7 @@ module ChefSpec
       report = {}.tap do |h|
         h[:total]     = @collection.size
         h[:touched]   = @collection.count { |_, resource| resource.touched? }
-        h[:coverage]  = ((h[:touched]/h[:total].to_f)*100).round(2)
+        h[:coverage]  = ((h[:touched] / h[:total].to_f) * 100).round(2)
       end
 
       report[:untouched_resources] = @collection.collect do |_, resource|
@@ -175,7 +170,7 @@ module ChefSpec
       report[:all_resources] = @collection.values
 
       @outputs.each do |block|
-        self.instance_exec(report, &block)
+        instance_exec(report, &block)
       end
 
       # Ensure we exit correctly (#351)
@@ -208,24 +203,24 @@ module ChefSpec
           "source_file" => source_file,
           "source_line" => source_line,
           "touched" => touched?,
-          "resource" => to_s
+          "resource" => to_s,
         }.to_json
       end
 
       def source_file
         @source_file ||= if @resource.source_line
-          shortname(@resource.source_line.split(':').first)
-        else
-          'Unknown'
-        end
+                           shortname(@resource.source_line.split(":").first)
+                         else
+                           "Unknown"
+                         end
       end
 
       def source_line
         @source_line ||= if @resource.source_line
-          @resource.source_line.split(':', 2).last.to_i
-        else
-          'Unknown'
-        end
+                           @resource.source_line.split(":", 2).last.to_i
+                         else
+                           "Unknown"
+                         end
       end
 
       def touch!
@@ -241,8 +236,8 @@ module ChefSpec
       def shortname(file)
         if file.include?(Dir.pwd)
           file.split(Dir.pwd, 2).last
-        elsif file.include?('cookbooks')
-          file.split('cookbooks/', 2).last
+        elsif file.include?("cookbooks")
+          file.split("cookbooks/", 2).last
         else
           file
         end

data/lib/chefspec/deprecations.rb

@@ -7,9 +7,9 @@ module Kernel
   # @param [Array<String>] messages
   def deprecated(*messages)
     messages.each do |message|
-      calling_spec = caller.find { |line| line =~ /(\/spec)|(_spec\.rb)/ }
+      calling_spec = caller.find { |line| line =~ %r{(/spec)|(_spec\.rb)} }
       if calling_spec
-        calling_spec = 'spec/' + calling_spec.split('/spec/').last
+        calling_spec = "spec/" + calling_spec.split("/spec/").last
         warn "[DEPRECATION] #{message} (called from #{calling_spec})"
       else
         warn "[DEPRECATION] #{message}"
@@ -42,5 +42,5 @@ module ChefSpec
 end
 
 module ChefSpec::Error
-  class NoConversionError < ChefSpecError;  end
+  class NoConversionError < ChefSpecError; end
 end

data/lib/chefspec/errors.rb

@@ -2,9 +2,9 @@ module ChefSpec
   module Error
     class ChefSpecError < StandardError
       def initialize(options = {})
-        class_name = self.class.to_s.split('::').last
+        class_name = self.class.to_s.split("::").last
         filename   = options.delete(:_template) || Util.underscore(class_name)
-        template   = ChefSpec.root.join('templates', 'errors', "#{filename}.erb")
+        template   = ChefSpec.root.join("templates", "errors", "#{filename}.erb")
 
         erb = Erubis::Eruby.new(File.read(template))
         super erb.evaluate(options)
@@ -13,12 +13,12 @@ module ChefSpec
 
     class NotStubbed < ChefSpecError
       def initialize(options = {})
-        name  = self.class.name.to_s.split('::').last
-        type  = Util.underscore(name).gsub('_not_stubbed', '')
-        klass = Stubs.const_get(name.gsub('NotStubbed', '') + 'Stub')
-        stub  = klass.new(*options[:args]).and_return('...').signature
+        name  = self.class.name.to_s.split("::").last
+        type  = Util.underscore(name).gsub("_not_stubbed", "")
+        klass = Stubs.const_get(name.gsub("NotStubbed", "") + "Stub")
+        stub  = klass.new(*options[:args]).and_return("...").signature
 
-        signature = "#{type}(#{options[:args].map(&:inspect).join(', ')})"
+        signature = "#{type}(#{options[:args].map(&:inspect).join(", ")})"
 
         super({
           type:      type,

data/lib/chefspec/expect_exception.rb

@@ -26,6 +26,7 @@ module ChefSpec
 
     def expected?
       return false if @matcher.nil?
+
       exception_matched? && message_matched?
     end
 
@@ -33,7 +34,7 @@ module ChefSpec
 
     def exception_matched?
       @formatter_exception == @matcher.last_error_for_chefspec ||
-      @matcher.last_error_for_chefspec === @formatter_exception
+        @matcher.last_error_for_chefspec === @formatter_exception
     end
 
     def message_matched?

data/lib/chefspec/extensions/chef/client.rb

@@ -1,11 +1,11 @@
 # Force loading Chef Config to fix a bad dependency tree. See
 # https://github.com/opscode/chef/issues/2703 for more information.
-require 'chef/config'
+require "chef/config"
 
 # Providers has to be included before client... probably a weird
 # include missing in Chef-land, but we can make sure we get it right anyway.
-require 'chef/providers'
-require 'chef/client'
+require "chef/providers"
+require "chef/client"
 
 # @private
 Chef::Client.prepend(Module.new do

data/lib/chefspec/extensions/chef/conditional.rb

@@ -1,9 +1,10 @@
-require 'chef/resource/conditional'
+require "chef/resource/conditional"
 
 Chef::Resource::Conditional.prepend(Module.new do
   # @see Chef::Resource::Conditional#evaluate_command
   def evaluate_command
     return super unless $CHEFSPEC_MODE
+
     stub = ChefSpec::Stubs::CommandRegistry.stub_for(@command)
 
     if stub.nil?

data/lib/chefspec/extensions/chef/cookbook/gem_installer.rb

@@ -1,9 +1,10 @@
-require 'chef/cookbook/gem_installer'
+require "chef/cookbook/gem_installer"
 
 Chef::Cookbook::GemInstaller.prepend(Module.new do
   # Installs the gems into the omnibus gemset.
   def install
     return super unless $CHEFSPEC_MODE
+
     cookbook_gems = Hash.new { |h, k| h[k] = [] }
 
     cookbook_collection.each do |cookbook_name, cookbook_version|
@@ -20,10 +21,10 @@ Chef::Cookbook::GemInstaller.prepend(Module.new do
   private
 
   def locate_gem(gem_name, gem_requirements)
-    ::Gem::Specification::find_by_name(gem_name, gem_requirements)
+    ::Gem::Specification.find_by_name(gem_name, gem_requirements)
   rescue ::Gem::MissingSpecError
-    gem_cmd = "gem install #{gem_name} --version '#{gem_requirements.join(', ')}'"
-    gemfile_line = "gem '#{[gem_name, *gem_requirements].join('\', \'')}'"
+    gem_cmd = "gem install #{gem_name} --version '#{gem_requirements.join(", ")}'"
+    gemfile_line = "gem '#{[gem_name, *gem_requirements].join("', '")}'"
     warn "No matching version found for '#{gem_name}' in your gem environment.\n" \
          " - if you are using Chef Workstation, run the following command: \"chef #{gem_cmd}\"\n" \
          " - if you are using bundler, append \"#{gemfile_line}\" to your Gemfile and run \"bundle install\"\n" \

data/lib/chefspec/extensions/chef/cookbook_loader.rb

@@ -3,6 +3,7 @@ require "chef/cookbook_loader"
 Chef::CookbookLoader.prepend(Module.new do
   def all_directories_in_repo_paths
     return super unless $CHEFSPEC_MODE
+
     if Chef::Config[:chefspec_cookbook_root]
       # Hax.
       [Chef::Config[:chefspec_cookbook_root]]

data/lib/chefspec/extensions/chef/cookbook_uploader.rb

@@ -1,4 +1,4 @@
-require 'chef/cookbook_uploader'
+require "chef/cookbook_uploader"
 
 Chef::CookbookUploader.prepend(Module.new do |variable|
   #

data/lib/chefspec/extensions/chef/data_query.rb

@@ -1,4 +1,4 @@
-require 'chef/dsl/data_query'
+require "chef/dsl/data_query"
 
 Chef::DSL::DataQuery.prepend(Module.new do
   # @see Chef::DSL::DataQuery#search
@@ -6,7 +6,7 @@ Chef::DSL::DataQuery.prepend(Module.new do
     return super unless Chef::Config[:solo] && $CHEFSPEC_MODE
 
     type  = args[0]
-    query = args[1] || '*:*'
+    query = args[1] || "*:*"
     stub = ChefSpec::Stubs::SearchRegistry.stub_for(type, query)
 
     if stub.nil?
@@ -14,7 +14,7 @@ Chef::DSL::DataQuery.prepend(Module.new do
     end
 
     if block
-      Array(stub.result).each {|r| block.call(r) }
+      Array(stub.result).each { |r| block.call(r) }
       true
     else
       stub.result

data/lib/chefspec/extensions/chef/lwrp_base.rb

@@ -22,6 +22,7 @@ else # >= 13.0
   Chef::Provider.prepend(Module.new do
     def compile_and_converge_action(&block)
       return super unless $CHEFSPEC_MODE
+
       instance_eval(&block)
     end
   end)

data/lib/chefspec/extensions/chef/provider.rb

@@ -1,5 +1,5 @@
-require 'chef/provider'
-require_relative '../../api'
+require "chef/provider"
+require_relative "../../api"
 
 Chef::Provider.prepend(Module.new do
   def self.name
@@ -20,17 +20,20 @@ Chef::Provider.prepend(Module.new do
   if ChefSpec::API::StubsFor::HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
     def shell_out_compacted(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'provider', resource: new_resource)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "provider", resource: new_resource)
     end
 
     def shell_out_compacted!(*args)
       return super unless $CHEFSPEC_MODE
-      shell_out_compacted(*args).tap {|c| c.error! }
+
+      shell_out_compacted(*args).tap(&:error!)
     end
   else
     def shell_out(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'provider', resource: new_resource)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "provider", resource: new_resource)
     end
   end
 end)

data/lib/chefspec/extensions/chef/resource/freebsd_package.rb

@@ -1,4 +1,4 @@
-require 'chef/resource/freebsd_package'
+require "chef/resource/freebsd_package"
 
 Chef::Resource::FreebsdPackage.prepend(Module.new do
   #
@@ -11,6 +11,7 @@ Chef::Resource::FreebsdPackage.prepend(Module.new do
   #
   def supports_pkgng?
     return super unless $CHEFSPEC_MODE
+
     true
   end
 end)

data/lib/chefspec/extensions/chef/resource.rb

@@ -1,6 +1,6 @@
-require 'chef/resource'
-require 'chef/version'
-require_relative '../../api'
+require "chef/resource"
+require "chef/version"
+require_relative "../../api"
 
 #
 # Three concerns:
@@ -29,8 +29,8 @@ module ChefSpec::Extensions::Chef::Resource
 
   def dup
     return super unless $CHEFSPEC_MODE
+
     # Also here be dragons.
-    stack = caller
     super.tap do |dup_resource|
       # We're directly inside a load_current_resource, which is probably via
       # the load_current_value DSL system, so call this a current resource.
@@ -41,6 +41,7 @@ module ChefSpec::Extensions::Chef::Resource
   # mix of no-op and tracking concerns
   def run_action(action, notification_type = nil, notifying_resource = nil)
     return super unless $CHEFSPEC_MODE
+
     resolve_notification_references
     validate_action(action)
 
@@ -68,17 +69,20 @@ module ChefSpec::Extensions::Chef::Resource
   if ChefSpec::API::StubsFor::HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
     def shell_out_compacted(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'resource', resource: self)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "resource", resource: self)
     end
 
     def shell_out_compacted!(*args)
       return super unless $CHEFSPEC_MODE
-      shell_out_compacted(*args).tap {|c| c.error! }
+
+      shell_out_compacted(*args).tap(&:error!)
     end
   else
     def shell_out(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'resource', resource: self)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "resource", resource: self)
     end
   end
 
@@ -140,9 +144,9 @@ module ChefSpec::Extensions::Chef::Resource
       super
     end
 
-    def action(sym, &block)
+    def action(sym, description: nil, &block)
       inject_actions(sym)
-      super
+      super(sym, &block)
     end
 
     def allowed_actions(*actions)
@@ -168,6 +172,7 @@ module ChefSpec::Extensions::Chef::Resource
     def inject_actions(*actions)
       provides_names.each do |resource_name|
         next unless resource_name
+
         ChefSpec.define_matcher(resource_name)
         actions.each do |action|
           inject_method(:"#{action}_#{resource_name}", resource_name, action)

data/lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb

@@ -1,4 +1,4 @@
-require 'chef/run_context/cookbook_compiler'
+require "chef/run_context/cookbook_compiler"
 
 Chef::RunContext::CookbookCompiler.prepend(Module.new do
   # List of compile phases as of Chef 14:
@@ -15,36 +15,44 @@ Chef::RunContext::CookbookCompiler.prepend(Module.new do
 
   def load_libraries_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_LIBRARY_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_LIBRARY_PRELOAD[cookbook]
+
     $CHEFSPEC_LIBRARY_PRELOAD[cookbook] = true
     super
   end
 
   def load_ohai_plugins_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_OHAI_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_OHAI_PRELOAD[cookbook]
+
     $CHEFSPEC_OHAI_PRELOAD[cookbook] = true
     super
   end
 
   def load_lwrps_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_LWRP_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_LWRP_PRELOAD[cookbook]
+
     $CHEFSPEC_LWRP_PRELOAD[cookbook] = true
     super
   end
 
   def load_resource_definitions_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_DEFINITION_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_DEFINITION_PRELOAD[cookbook]
+
     $CHEFSPEC_DEFINITION_PRELOAD[cookbook] = true
     super
   end
@@ -56,18 +64,21 @@ Chef::RunContext::CookbookCompiler.prepend(Module.new do
   def compile_ohai_plugins
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 
   def compile_attributes
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 
   def compile_recipes
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 end)

data/lib/chefspec/extensions/chef/securable.rb

@@ -1,4 +1,4 @@
-require 'chef/mixin/securable'
+require "chef/mixin/securable"
 
 class Chef
   module Mixin

data/lib/chefspec/extensions/ohai/system.rb

@@ -1,4 +1,4 @@
-require 'ohai/system'
+require "ohai/system"
 
 Ohai::System.prepend(Module.new do
   # If an Ohai segment exists, don't actually pull data in for ohai.

data/lib/chefspec/extensions.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require "rspec"
 
 module ChefSpec::Extensions
   module Chef
@@ -6,16 +6,16 @@ module ChefSpec::Extensions
 end
 
 # STOP! DO NOT ALPHABETIZE!
-require_relative 'extensions/chef/data_query' # must be before Chef::Resource loads
-require_relative 'extensions/chef/resource'  # must come before client extensions or anything that winds up loading resources
-require_relative 'extensions/chef/provider'
-require_relative 'extensions/chef/securable'
-require_relative 'extensions/chef/client'
-require_relative 'extensions/chef/conditional'
-require_relative 'extensions/chef/cookbook_uploader'
-require_relative 'extensions/chef/cookbook/gem_installer'
-require_relative 'extensions/chef/lwrp_base'
-require_relative 'extensions/chef/resource/freebsd_package'
-require_relative 'extensions/chef/run_context/cookbook_compiler'
-require_relative 'extensions/chef/cookbook_loader'
-require_relative 'extensions/ohai/system'
+require_relative "extensions/chef/data_query" # must be before Chef::Resource loads
+require_relative "extensions/chef/resource"  # must come before client extensions or anything that winds up loading resources
+require_relative "extensions/chef/provider"
+require_relative "extensions/chef/securable"
+require_relative "extensions/chef/client"
+require_relative "extensions/chef/conditional"
+require_relative "extensions/chef/cookbook_uploader"
+require_relative "extensions/chef/cookbook/gem_installer"
+require_relative "extensions/chef/lwrp_base"
+require_relative "extensions/chef/resource/freebsd_package"
+require_relative "extensions/chef/run_context/cookbook_compiler"
+require_relative "extensions/chef/cookbook_loader"
+require_relative "extensions/ohai/system"

data/lib/chefspec/file_cache_path_proxy.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'singleton'
+require "fileutils" unless defined?(FileUtils)
+require "singleton" unless defined?(Singleton)
 
 module ChefSpec
   class FileCachePathProxy
@@ -8,7 +8,7 @@ module ChefSpec
     attr_reader :file_cache_path
 
     def initialize
-      @file_cache_path = Dir.mktmpdir(["chefspec", "file_cache_path"])
+      @file_cache_path = Dir.mktmpdir(%w{chefspec file_cache_path})
       at_exit { FileUtils.rm_rf(@file_cache_path) }
     end
   end

data/lib/chefspec/formatter.rb

@@ -1,5 +1,5 @@
-require 'chef/formatters/base'
-require 'chef/formatters/error_mapper'
+require "chef/formatters/base"
+require "chef/formatters/error_mapper"
 
 module ChefSpec
   class ChefFormatter < Chef::Formatters::Base
@@ -202,7 +202,7 @@ module ChefSpec
     def converge_complete; end
 
     # Called before action is executed on a resource.
-    def resource_action_start(resource, action, notification_type=nil, notifier=nil); end
+    def resource_action_start(resource, action, notification_type = nil, notifier = nil); end
 
     # Called when a resource fails, but will retry.
     def resource_failed_retriable(resource, action, retry_count, exception); end

data/lib/chefspec/librarian.rb

@@ -1,10 +1,11 @@
 begin
-  require 'librarian/chef/environment'
-  require 'librarian/action/resolve'
-  require 'librarian/action/install'
+  require "librarian/chef/environment"
+  require "librarian/action/resolve"
+  require "librarian/action/install"
 rescue LoadError
   raise ChefSpec::Error::GemLoadError.new(
-    gem: 'librarian-chef', name: 'Librarian')
+    gem: "librarian-chef", name: "Librarian"
+  )
 end
 
 module ChefSpec
@@ -25,7 +26,7 @@ module ChefSpec
     #
     def setup!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      @originalpath, env.config_db.local['path'] = env.config_db.local['path'], @tmpdir
+      @originalpath, env.config_db.local["path"] = env.config_db.local["path"], @tmpdir
       ::Librarian::Action::Resolve.new(env).run
       ::Librarian::Action::Install.new(env).run
 
@@ -37,7 +38,7 @@ module ChefSpec
     #
     def teardown!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      env.config_db.local['path'] = @originalpath
+      env.config_db.local["path"] = @originalpath
 
       FileUtils.rm_rf(@tmpdir) if File.exist?(@tmpdir)
     end