123456789_123456789_123456789_123456789_123456789_

Module: RSpec::Support

Relationships & Source Files
Namespace Children
Modules:
AllExceptionsExceptOnesWeMustNotRescue, FormattingSupport, FuzzyMatcher, InSubProcess, RecursiveConstMethods, ShellOut, Spec, Version, Warnings, WhitespaceChecks, WithIsolatedStdErr, WithKeywordsWhenNeeded
Classes:
BlockSignature, ComparableVersion, Differ, DirectoryMaker, EncodedString, HunkGenerator, LooseSignatureVerifier, MethodSignature, MethodSignatureExpectation, MethodSignatureVerifier, Mutex, ObjectFormatter, ReentrantMutex, Source, StdErrSplitter
Defined in: rspec-support/lib/rspec/support.rb,
rspec-support/lib/rspec/support/comparable_version.rb,
rspec-support/lib/rspec/support/differ.rb,
rspec-support/lib/rspec/support/directory_maker.rb,
rspec-support/lib/rspec/support/encoded_string.rb,
rspec-support/lib/rspec/support/fuzzy_matcher.rb,
rspec-support/lib/rspec/support/hunk_generator.rb,
rspec-support/lib/rspec/support/matcher_definition.rb,
rspec-support/lib/rspec/support/method_signature_verifier.rb,
rspec-support/lib/rspec/support/mutex.rb,
rspec-support/lib/rspec/support/object_formatter.rb,
rspec-support/lib/rspec/support/recursive_const_methods.rb,
rspec-support/lib/rspec/support/reentrant_mutex.rb,
rspec-support/lib/rspec/support/source.rb,
rspec-support/lib/rspec/support/spec.rb,
rspec-support/lib/rspec/support/version.rb,
rspec-support/lib/rspec/support/warnings.rb,
rspec-support/lib/rspec/support/with_keywords_when_needed.rb,
rspec-support/lib/rspec/support/source/location.rb,
rspec-support/lib/rspec/support/source/node.rb,
rspec-support/lib/rspec/support/source/token.rb,
rspec-support/lib/rspec/support/spec/diff_helpers.rb,
rspec-support/lib/rspec/support/spec/formatting_support.rb,
rspec-support/lib/rspec/support/spec/in_sub_process.rb,
rspec-support/lib/rspec/support/spec/library_wide_checks.rb,
rspec-support/lib/rspec/support/spec/shell_out.rb,
rspec-support/lib/rspec/support/spec/stderr_splitter.rb,
rspec-support/lib/rspec/support/spec/with_isolated_stderr.rb

Constant Summary

Class Attribute Summary

Class Method Summary

Class Attribute Details

.failure_notifier (rw)

This method is for internal use only.
[ GitHub ] 

  


# File 'rspec-support/lib/rspec/support.rb', line 113



def self.failure_notifier
  thread_local_data[:failure_notifier] || DEFAULT_FAILURE_NOTIFIER
end


  








  

    .failure_notifier=(callable)   (rw)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 105



def self.failure_notifier=(callable)
  thread_local_data[:failure_notifier] = callable
end


  








  

    .warning_notifier   (rw)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 140



def self.warning_notifier
  @warning_notifier ||= DEFAULT_WARNING_NOTIFIER
end


  








  

    .warning_notifier=(value)   (rw)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 133



attr_writer :warning_notifier


  







Class Method Details



  

    .class_of(object)  
  

  

    This method is for internal use only.
  



  

    

Used internally to get a class of a given object, even if it does not respond to #class.


  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 86



def self.class_of(object)
  object.class
rescue NoMethodError
  singleton_class = class << object; self; end
  singleton_class.ancestors.find { |ancestor| !ancestor.equal?(singleton_class) }
end


  








  

    .define_optimized_require_for_rspec(lib, &require_relative)  
  

  

    This method is for internal use only.
  



  

    

Defines a helper method that is optimized to require files from the named lib. The passed block MUST be ‘{ |f| require_relative f }` because for require_relative to work properly from within the named lib the line of code must be IN that lib.



require_relative is preferred when available because it is always O(1), regardless of the number of dirs in $LOAD_PATH. require, on the other hand, does a linear O(N) search over the dirs in the $LOAD_PATH until it can resolve the file relative to one of the dirs.


  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 16



def self.define_optimized_require_for_rspec(lib, &require_relative)
  name = "require_rspec_#{lib}"

  if RUBY_PLATFORM == 'java' && !Kernel.respond_to?(:require)
    # JRuby 9.1.17.0 has developed a regression for require
    (class << self; self; end).__send__(:define_method, name) do |f|
      Kernel.send(:require, "rspec/#{lib}/#{f}")
    end
  elsif Kernel.respond_to?(:require_relative)
    (class << self; self; end).__send__(:define_method, name) do |f|
      require_relative.call("#{lib}/#{f}")
    end
  else
    (class << self; self; end).__send__(:define_method, name) do |f|
      require "rspec/#{lib}/#{f}"
    end
  end
end


  








  

    .deregister_matcher_definition(&block)  
  

  

    This method is for internal use only.
  



  

    

Remove a previously registered matcher. Useful for cleaning up after yourself in specs.


  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support/matcher_definition.rb', line 24



def self.deregister_matcher_definition(&block)
  matcher_definitions.delete(block)
end


  








  

    .is_a_matcher?(object)  ⇒ Boolean 
  

  

    This method is for internal use only.
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support/matcher_definition.rb', line 29



def self.is_a_matcher?(object)
  matcher_definitions.any? { |md| md.call(object) }
end


  








  

    .matcher_definitions  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support/matcher_definition.rb', line 6



def self.matcher_definitions
  @matcher_definitions ||= []
end


  








  

    .method_handle_for(object, method_name)  
  



  

    

See additional method definition at line 54.


  



  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 66



def self.method_handle_for(object, method_name)
  KERNEL_METHOD_METHOD.bind(object).call(method_name)
rescue NameError => original
  begin
    handle = object.method(method_name)
    raise original unless handle.is_a? Method
    handle
  rescue Support::AllExceptionsExceptOnesWeMustNotRescue
    raise original
  end
end


  








  

    .notify_failure(failure, options = {})  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 118



def self.notify_failure(failure, options={})
  failure_notifier.call(failure, options)
end


  








  

    .register_matcher_definition(&block)  
  

  

    This method is for internal use only.
  



  

    

Used internally to break cyclic dependency between mocks, expectations, and support. We don’t currently have a consistent implementation of our matchers, though we are considering changing that: github.com/rspec/rspec-mocks/issues/513


  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support/matcher_definition.rb', line 16



def self.register_matcher_definition(&block)
  matcher_definitions << block
end


  








  

    .rspec_description_for_object(object)  
  

  

    This method is for internal use only.
  



  

    

gives a string representation of an object for use in ::RSpec descriptions


  





  


  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support/matcher_definition.rb', line 36



def self.rspec_description_for_object(object)
  if RSpec::Support.is_a_matcher?(object) && object.respond_to?(:description)
    object.description
  else
    object
  end
end


  








  

    .thread_local_data  
  



  

    

See additional method definition at line 95.


  



  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 99



def self.thread_local_data
  Thread.current.thread_variable_get(:__rspec) || Thread.current.thread_variable_set(:__rspec, {})
end


  








  

    .with_failure_notifier(callable)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-support/lib/rspec/support.rb', line 123



def self.with_failure_notifier(callable)
  orig_notifier = failure_notifier
  self.failure_notifier = callable
  yield
ensure
  self.failure_notifier = orig_notifier
end