chefspec 8.0.1 → 9.3.0

data/lib/chefspec/api/stubs_for.rb

@@ -1,5 +1,5 @@
 require "chef/version"
-require "mixlib/shellout"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 
 module ChefSpec
   module API
@@ -35,7 +35,7 @@ module ChefSpec
       before do
         allow(StubsFor).to receive(:setup_stubs_for) do |object, type|
           type_stubs = _chefspec_stubs_for_registry[type]
-          resource_object = object.is_a?(Chef::Provider) ? object.new_resource : object
+          resource_object = object.respond_to?(:new_resource) ? object.new_resource : object
           stubs = type_stubs[nil] + type_stubs[resource_object.resource_name.to_s] + type_stubs[resource_object.to_s]
           stubs.each do |stub|
             instance_exec(object, &stub)
@@ -56,23 +56,25 @@ module ChefSpec
       #     expect(subject.some_method).to eq "asdf"
       #   end
       # @param target [String, nil] Resource name to inject, or nil for all resources.
-      # @param current_resource [Boolean] If true, also register stubs for current_resource objects on the same target.
+      # @param current_value [Boolean] If true, also register stubs for current_value objects on the same target.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_resource(target=nil, current_resource: true, &block)
+      def stubs_for_resource(target = nil, current_value: true, current_resource: true, &block)
+        current_value = false unless current_resource
         _chefspec_stubs_for_registry[:resource][target] << block
-        stubs_for_current_resource(target, &block) if current_resource
+        stubs_for_current_value(target, &block) if current_value
       end
 
-      # Register stubs for current_resource objects.
+      # Register stubs for current_value objects.
       #
       # @see #stubs_for_resource
       # @param target [String, nil] Resource name to inject, or nil for all resources.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_current_resource(target=nil, &block)
-        _chefspec_stubs_for_registry[:current_resource][target] << block
+      def stubs_for_current_value(target = nil, &block)
+        _chefspec_stubs_for_registry[:current_value][target] << block
       end
+      alias_method :stubs_for_current_resource, :stubs_for_current_value
 
       # Register stubs for provider objects.
       #
@@ -80,15 +82,15 @@ module ChefSpec
       # @param target [String, nil] Resource name to inject, or nil for all providers.
       # @param block [Proc] A block taking the resource object as a parameter.
       # @return [void]
-      def stubs_for_provider(target=nil, &block)
+      def stubs_for_provider(target = nil, &block)
         _chefspec_stubs_for_registry[:provider][target] << block
       end
 
-      def receive_shell_out(*cmd, stdout: '', stderr: '', exitstatus: 0, **opts)
+      def receive_shell_out(*cmd, stdout: "", stderr: "", exitstatus: 0, **opts)
         # Ruby does not allow constructing an actual exitstatus object from Ruby code. Really.
         fake_exitstatus = double(exitstatus: exitstatus)
         fake_cmd = Mixlib::ShellOut.new(*cmd)
-        fake_cmd.define_singleton_method(:run_command) { } # Do nothing, just in case.
+        fake_cmd.define_singleton_method(:run_command) {} # Do nothing, just in case.
         # Inject our canned data.
         fake_cmd.instance_exec do
           @stdout = stdout
@@ -97,24 +99,25 @@ module ChefSpec
         end
         # On newer Chef, we can intercept using the new, better shell_out_compact hook point.
         shell_out_method ||= if HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
-          :shell_out_compacted
-        else
-          :shell_out
-        end
+                               :shell_out_compacted
+                             else
+                               :shell_out
+                             end
         with_args = cmd + (opts.empty? ? [any_args] : [hash_including(opts)])
         receive(shell_out_method).with(*with_args).and_return(fake_cmd)
       end
 
       module ClassMethods
         # (see StubsFor#stubs_for_resource)
-        def stubs_for_resource(*args, &block)
-          before { stubs_for_resource(*args, &block) }
+        def stubs_for_resource(*args, **kwargs, &block)
+          before { stubs_for_resource(*args, **kwargs, &block) }
         end
 
-        # (see StubsFor#stubs_for_current_resource)
-        def stubs_for_current_resource(*args, &block)
-          before { stubs_for_current_resource(*args, &block) }
+        # (see StubsFor#stubs_for_current_value)
+        def stubs_for_current_value(*args, &block)
+          before { stubs_for_current_value(*args, &block) }
         end
+        alias_method :stubs_for_current_resource, :stubs_for_current_value
 
         # (see StubsFor#stubs_for_provider)
         def stubs_for_provider(*args, &block)

data/lib/chefspec/berkshelf.rb

@@ -1,7 +1,7 @@
 begin
-  require 'berkshelf'
+  require "berkshelf"
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'berkshelf', name: 'Berkshelf')
+  raise ChefSpec::Error::GemLoadError.new(gem: "berkshelf", name: "Berkshelf")
 end
 
 module ChefSpec
@@ -23,14 +23,14 @@ module ChefSpec
     def setup!
       # Get the list of Berkshelf options
       opts = RSpec.configuration.berkshelf_options
-      if !opts.is_a?(Hash)
+      unless opts.is_a?(Hash)
         raise InvalidBerkshelfOptions(value: opts.inspect)
       end
 
       berksfile = ::Berkshelf::Berksfile.from_options(opts)
 
       # Grab a handle to tmpdir, since Berkshelf 2 modifies it a bit
-      tmpdir = File.join(@tmpdir, 'cookbooks')
+      tmpdir = File.join(@tmpdir, "cookbooks")
 
       ::Berkshelf.ui.mute do
         if ::Berkshelf::Berksfile.method_defined?(:vendor)

data/lib/chefspec/cacher.rb

@@ -42,8 +42,8 @@ module ChefSpec
       location ||= ancestors.first.metadata[:parent_example_group][:location]
 
       define_method(name) do
-        key = [location, name.to_s].join('.')
-        unless @@cache.has_key?(Thread.current.object_id)
+        key = [location, name.to_s].join(".")
+        unless @@cache.key?(Thread.current.object_id)
           ObjectSpace.define_finalizer(Thread.current, FINALIZER)
         end
         @@cache[Thread.current.object_id] ||= {}

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/coverage/filters.rb

@@ -6,7 +6,7 @@ module ChefSpec
       end
 
       def matches?
-        raise RuntimeError, "Must override Filter#matches?"
+        raise "Must override Filter#matches?"
       end
     end
 
@@ -17,6 +17,7 @@ module ChefSpec
     class RegexpFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter =~ resource.source_line
       end
     end
@@ -41,6 +42,7 @@ module ChefSpec
     class BlockFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter.call(resource)
       end
     end
@@ -54,25 +56,26 @@ module ChefSpec
         @berksfile = berksfile
 
         @metadatas = if berksfile.respond_to?(:dependencies)
-          berksfile.dependencies
-            .select(&:metadata?)
-            .map(&:name)
-        else
-          berksfile.sources.collect do |source|
-            location = source.location
-            if location.respond_to?(:metadata?) && location.metadata?
-              source
-            else
-              nil
-            end
-          end.compact.map(&:name)
-        end
+                       berksfile.dependencies
+                         .select(&:metadata?)
+                         .map(&:name)
+                     else
+                       berksfile.sources.collect do |source|
+                         location = source.location
+                         if location.respond_to?(:metadata?) && location.metadata?
+                           source
+                         else
+                           nil
+                         end
+                       end.compact.map(&:name)
+                     end
       end
 
       def matches?(resource)
         return true if resource.source_line.nil?
+
         normalized_source_line = resource.source_line.gsub("\\", "/")
-        normalized_source_line=~ /cookbooks\/(?!#{@metadatas.join('|')})/
+        normalized_source_line =~ %r{cookbooks/(?!#{@metadatas.join('|')})}
       end
     end
   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.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require "rspec"
 
 module ChefSpec::Extensions
   module Chef
@@ -6,15 +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/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"