chefspec 9.2.1 → 9.3.0

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.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/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/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/file_cache_path_proxy.rb

@@ -1,5 +1,5 @@
-require 'fileutils' unless defined?(FileUtils)
-require 'singleton' unless defined?(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

data/lib/chefspec/matchers.rb

@@ -1,13 +1,13 @@
 module ChefSpec
   module Matchers
-    require_relative 'matchers/do_nothing_matcher'
-    require_relative 'matchers/include_any_recipe_matcher'
-    require_relative 'matchers/include_recipe_matcher'
-    require_relative 'matchers/link_to_matcher'
-    require_relative 'matchers/notifications_matcher'
-    require_relative 'matchers/render_file_matcher'
-    require_relative 'matchers/resource_matcher'
-    require_relative 'matchers/state_attrs_matcher'
-    require_relative 'matchers/subscribes_matcher'
+    require_relative "matchers/do_nothing_matcher"
+    require_relative "matchers/include_any_recipe_matcher"
+    require_relative "matchers/include_recipe_matcher"
+    require_relative "matchers/link_to_matcher"
+    require_relative "matchers/notifications_matcher"
+    require_relative "matchers/render_file_matcher"
+    require_relative "matchers/resource_matcher"
+    require_relative "matchers/state_attrs_matcher"
+    require_relative "matchers/subscribes_matcher"
   end
 end

data/lib/chefspec/matchers/do_nothing_matcher.rb

@@ -14,37 +14,37 @@ module ChefSpec::Matchers
     end
 
     def description
-      'do nothing'
+      "do nothing"
     end
 
     def failure_message
       if @resource
-        message =  %|expected #{@resource} to do nothing, but the following |
-        message << %|actions were performed:|
-        message << %|\n\n|
+        message =  %{expected #{@resource} to do nothing, but the following }
+        message << %{actions were performed:}
+        message << %{\n\n}
         @resource.performed_actions.each do |action|
-          message << %|  :#{action}|
+          message << %{  :#{action}}
         end
         message
       else
-        message =  %|expected _something_ to do nothing, but the _something_ |
-        message << %|you gave me was nil! If you are running a test like:|
-        message << %|\n\n|
-        message << %|  expect(_something_).to do_nothing|
-        message << %|\n\n|
-        message << %|make sure that `_something_` exists, because I got nil!|
+        message =  %{expected _something_ to do nothing, but the _something_ }
+        message << %{you gave me was nil! If you are running a test like:}
+        message << %{\n\n}
+        message << %{  expect(_something_).to do_nothing}
+        message << %{\n\n}
+        message << %{make sure that `_something_` exists, because I got nil!}
         message
       end
     end
 
     def failure_message_when_negated
       if @resource
-        message =  %|expected #{@resource} to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected #{@resource} to do something, but no actions }
+        message << %{were performed.}
         message
       else
-        message =  %|expected _something_ to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected _something_ to do something, but no actions }
+        message << %{were performed.}
         message
       end
     end

data/lib/chefspec/matchers/include_any_recipe_matcher.rb

@@ -6,15 +6,15 @@ module ChefSpec::Matchers
     end
 
     def description
-      'include any recipe'
+      "include any recipe"
     end
 
     def failure_message
-      'expected to include any recipe'
+      "expected to include any recipe"
     end
 
     def failure_message_when_negated
-      'expected not to include any recipes'
+      "expected not to include any recipes"
     end
 
     private
@@ -36,7 +36,7 @@ module ChefSpec::Matchers
     # @return [String]
     #
     def with_default(name)
-      name.include?('::') ? name : "#{name}::default"
+      name.include?("::") ? name : "#{name}::default"
     end
 
     #

data/lib/chefspec/matchers/include_recipe_matcher.rb

@@ -31,7 +31,7 @@ module ChefSpec::Matchers
     # @return [String]
     #
     def with_default(name)
-      name.include?('::') ? name : "#{name}::default"
+      name.include?("::") ? name : "#{name}::default"
     end
 
     #

data/lib/chefspec/matchers/link_to_matcher.rb

@@ -11,8 +11,8 @@ module ChefSpec::Matchers
         ChefSpec::Coverage.cover!(@link)
 
         @link.is_a?(Chef::Resource::Link) &&
-        @link.performed_action?(:create) &&
-        @path === @link.to
+          @link.performed_action?(:create) &&
+          @path === @link.to
       else
         false
       end

data/lib/chefspec/matchers/notifications_matcher.rb

@@ -14,8 +14,8 @@ module ChefSpec::Matchers
       if @resource
         block = Proc.new do |notified|
           resource_name(notified.resource).to_s == @expected_resource_type &&
-          (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
-          matches_action?(notified)
+            (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
+            matches_action?(notified)
         end
 
         if @immediately
@@ -115,6 +115,7 @@ module ChefSpec::Matchers
 
     def matches_action?(notification)
       return true if @action.nil?
+
       @action == notification.action.to_sym
     end
 
@@ -130,12 +131,12 @@ module ChefSpec::Matchers
         type = :delayed
       end
 
-      %Q{  "#{notifying_resource.to_s}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
+      %Q{  "#{notifying_resource}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
     end
 
     def format_notifications
       all_notifications.map do |notification|
-        '  ' + format_notification(notification)
+        "  " + format_notification(notification)
       end.join("\n")
     end
   end

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -87,8 +87,8 @@ module ChefSpec::Matchers
 
     def resource
       @resource ||= @runner.find_resource(:cookbook_file, @path) ||
-                    @runner.find_resource(:file, @path) ||
-                    @runner.find_resource(:template, @path)
+        @runner.find_resource(:file, @path) ||
+        @runner.find_resource(:template, @path)
     end
 
     #
@@ -99,7 +99,7 @@ module ChefSpec::Matchers
     # @return [true, false]
     #
     def has_create_action?
-      [:create, :create_if_missing].any? { |action| resource.performed_action?(action) }
+      %i{create create_if_missing}.any? { |action| resource.performed_action?(action) }
     end
 
     #