Class: Mocha::Configuration

### Home Classes Methods

### In Files

- lib/mocha/configuration.rb

### Parent

Object

### Methods

- ::allow
- ::allow?
- ::prevent
- ::prevent?
- ::reset_configuration
- ::warn_when
- ::warn_when?

### Class/Module Index

Quicksearch

- Mocha
- Mocha::API
- Mocha::AnyInstanceMethod
- Mocha::AnyInstanceReceiver
- Mocha::ArgumentIterator
- Mocha::ArrayMethods
- Mocha::BacktraceFilter
- Mocha::Cardinality
- Mocha::Central
- Mocha::ChangeStateSideEffect
- Mocha::ClassMethod
- Mocha::ClassMethods
- Mocha::ClassMethods::AnyInstance
- Mocha::Configuration
- Mocha::DateMethods
- Mocha::Debug
- Mocha::DefaultName
- Mocha::DefaultReceiver
- Mocha::Deprecation
- Mocha::Detection
- Mocha::Detection::MiniTest
- Mocha::Detection::TestUnit
- Mocha::ExceptionRaiser
- Mocha::Expectation
- Mocha::ExpectationError
- Mocha::ExpectationErrorFactory
- Mocha::ExpectationList
- Mocha::HashMethods
- Mocha::Hooks
- Mocha::ImpersonatingAnyInstanceName
- Mocha::ImpersonatingName
- Mocha::InStateOrderingConstraint
- Mocha::InstanceMethod
- Mocha::Integration
- Mocha::Integration::AssertionCounter
- Mocha::Integration::MiniTest
- Mocha::Integration::MiniTest::Adapter
- Mocha::Integration::MiniTest::Nothing
- Mocha::Integration::MiniTest::Version13
- Mocha::Integration::MiniTest::Version13::RunMethodPatch
- Mocha::Integration::MiniTest::Version140
- Mocha::Integration::MiniTest::Version140::RunMethodPatch
- Mocha::Integration::MiniTest::Version141
- Mocha::Integration::MiniTest::Version141::RunMethodPatch
- Mocha::Integration::MiniTest::Version142To172
- Mocha::Integration::MiniTest::Version142To172::RunMethodPatch
- Mocha::Integration::MiniTest::Version200
- Mocha::Integration::MiniTest::Version200::RunMethodPatch
- Mocha::Integration::MiniTest::Version201To222
- Mocha::Integration::MiniTest::Version201To222::RunMethodPatch
- Mocha::Integration::MiniTest::Version2110To2111
- Mocha::Integration::MiniTest::Version2110To2111::RunMethodPatch
- Mocha::Integration::MiniTest::Version2112To320
- Mocha::Integration::MiniTest::Version2112To320::RunMethodPatch
- Mocha::Integration::MiniTest::Version230To2101
- Mocha::Integration::MiniTest::Version230To2101::RunMethodPatch
- Mocha::Integration::MonkeyPatcher
- Mocha::Integration::TestUnit
- Mocha::Integration::TestUnit::Adapter
- Mocha::Integration::TestUnit::GemVersion200
- Mocha::Integration::TestUnit::GemVersion200::RunMethodPatch
- Mocha::Integration::TestUnit::GemVersion201To202
- Mocha::Integration::TestUnit::GemVersion201To202::RunMethodPatch
- Mocha::Integration::TestUnit::GemVersion203To220
- Mocha::Integration::TestUnit::GemVersion203To220::RunMethodPatch
- Mocha::Integration::TestUnit::GemVersion230To250
- Mocha::Integration::TestUnit::GemVersion230To250::RunMethodPatch
- Mocha::Integration::TestUnit::Nothing
- Mocha::Integration::TestUnit::RubyVersion185AndBelow
- Mocha::Integration::TestUnit::RubyVersion185AndBelow::RunMethodPatch
- Mocha::Integration::TestUnit::RubyVersion186AndAbove
- Mocha::Integration::TestUnit::RubyVersion186AndAbove::RunMethodPatch
- Mocha::Logger
- Mocha::MethodMatcher
- Mocha::Mock
- Mocha::Mockery
- Mocha::ModuleMethod
- Mocha::ModuleMethods
- Mocha::MultipleYields
- Mocha::Name
- Mocha::NoYields
- Mocha::ObjectMethods
- Mocha::ObjectReceiver
- Mocha::ParameterMatchers
- Mocha::ParameterMatchers::AllOf
- Mocha::ParameterMatchers::AnyOf
- Mocha::ParameterMatchers::AnyParameters
- Mocha::ParameterMatchers::Anything
- Mocha::ParameterMatchers::Base
- Mocha::ParameterMatchers::Equals
- Mocha::ParameterMatchers::HasEntries
- Mocha::ParameterMatchers::HasEntry
- Mocha::ParameterMatchers::HasKey
- Mocha::ParameterMatchers::HasValue
- Mocha::ParameterMatchers::Includes
- Mocha::ParameterMatchers::InstanceOf
- Mocha::ParameterMatchers::IsA
- Mocha::ParameterMatchers::KindOf
- Mocha::ParameterMatchers::Not
- Mocha::ParameterMatchers::Optionally
- Mocha::ParameterMatchers::QueryStringMatches
- Mocha::ParameterMatchers::RegexpMatches
- Mocha::ParameterMatchers::RespondsWith
- Mocha::ParameterMatchers::YamlEquivalent
- Mocha::ParametersMatcher
- Mocha::PrettyParameters
- Mocha::ReturnValues
- Mocha::Sequence
- Mocha::Sequence::InSequenceOrderingConstraint
- Mocha::SingleReturnValue
- Mocha::SingleYield
- Mocha::StateMachine
- Mocha::StateMachine::State
- Mocha::StateMachine::StatePredicate
- Mocha::StringMethods
- Mocha::StubbingError
- Mocha::Thrower
- Mocha::TimeMethods
- Mocha::UnexpectedInvocation
- Mocha::YieldParameters
- Array
- Date
- Hash
- Object
- String
- Time

No matching classes.

# Mocha::Configuration

Configuration settings.

### Constants

DEFAULTS

### Public Class Methods

allow(action, &block) click to toggle source

Allow the specified `action`.

@param [Symbol] action one of `:stubbing_method_unnecessarily`, `:stubbing_method_on_non_mock_object`, `:stubbing_non_existent_method`, `:stubbing_non_public_method`, `:stubbing_method_on_nil`. @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.

    # File lib/mocha/configuration.rb, line 20
    def allow(action, &block)
      change_config action, :allow, &block
    end

allow?(action) click to toggle source

@private

    # File lib/mocha/configuration.rb, line 25
    def allow?(action)
      configuration[action] == :allow
    end

prevent(action, &block) click to toggle source

Raise a {StubbingError} if if the specified `action` is attempted.

@param [Symbol] action one of `:stubbing_method_unnecessarily`, `:stubbing_method_on_non_mock_object`, `:stubbing_non_existent_method`, `:stubbing_non_public_method`, `:stubbing_method_on_nil`. @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.

    # File lib/mocha/configuration.rb, line 46
    def prevent(action, &block)
      change_config action, :prevent, &block
    end

prevent?(action) click to toggle source

@private

    # File lib/mocha/configuration.rb, line 51
    def prevent?(action)
      configuration[action] == :prevent
    end

reset_configuration() click to toggle source

@private

    # File lib/mocha/configuration.rb, line 56
    def reset_configuration
      @configuration = nil
    end

warn_when(action, &block) click to toggle source

Warn if the specified `action` is attempted.

@param [Symbol] action one of `:stubbing_method_unnecessarily`, `:stubbing_method_on_non_mock_object`, `:stubbing_non_existent_method`, `:stubbing_non_public_method`, `:stubbing_method_on_nil`. @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.

    # File lib/mocha/configuration.rb, line 33
    def warn_when(action, &block)
      change_config action, :warn, &block
    end

warn_when?(action) click to toggle source

@private

    # File lib/mocha/configuration.rb, line 38
    def warn_when?(action)
      configuration[action] == :warn
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.