Module: RSpec::DocumentRequests::DSL

Defined in:
lib/rspec/document_requests/dsl.rb

Class Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.currently_documented_example ⇒ Object

Returns the value of attribute currently_documented_example.



5
6
7
 
# File 'lib/rspec/document_requests/dsl.rb', line 5

def currently_documented_example
  @currently_documented_example
end

.documented_requests ⇒ Object

Returns the value of attribute documented_requests.



5
6
7
 
# File 'lib/rspec/document_requests/dsl.rb', line 5

def documented_requests
  @documented_requests
end

Instance Method Details

#document_request_explanation ⇒ Object 



37
38
39
 
# File 'lib/rspec/document_requests/dsl.rb', line 37

def document_request_explanation
  @document_request_explanation ||= Explanation.new
end

#explain(message = nil, &block) ⇒ Object 



32
33
34
35
 
# File 'lib/rspec/document_requests/dsl.rb', line 32

def explain(message = nil, &block)
  document_request_explanation.message = message
  document_request_explanation.instance_eval(&block) if block_given?
end

#nodoc ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/rspec/document_requests/dsl.rb', line 41

def nodoc
  @document_request_prevented = true
  begin
    yield
  ensure
    @document_request_prevented = false
  end
end