Class: RGitHookFormatter

Inherits:
Spec::Runner::Formatter::BaseFormatter
  • Object
show all
Defined in:
lib/plugins/spec/rgithook_formatter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, where) ⇒ RGitHookFormatter

Returns a new instance of RGitHookFormatter.



5
6
7
8
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 5

def initialize(options, where)
   @options = options
   @where = where
end

Instance Attribute Details

#example_group ⇒ Object

Returns the value of attribute example_group.



4
5
6
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 4

def example_group
  @example_group
end

#options ⇒ Object

Returns the value of attribute options.



4
5
6
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 4

def options
  @options
end

#where ⇒ Object

Returns the value of attribute where.



4
5
6
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 4

def where
  @where
end

Instance Method Details

#add_example_group(example_group) ⇒ Object

This method is invoked at the beginning of the execution of each example_group. example_group is the example_group.

The next method to be invoked after this is #example_failed or #example_finished



23
24
25
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 23

def add_example_group(example_group)
   @example_group = example_group
end

#close ⇒ Object

This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.



72
73
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 72

def close
end

#dump_failure(counter, failure) ⇒ Object

Dumps detailed information about an example failure. This method is invoked for each failed example after all examples have run. counter is the sequence number of the associated example. failure is a Failure object, which contains detailed information about the failure.



60
61
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 60

def dump_failure(counter, failure)
end

#dump_pending ⇒ Object

This gets invoked after the summary if option is set to do so.



68
69
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 68

def dump_pending
end

#dump_summary(duration, example_count, failure_count, pending_count) ⇒ Object

This method is invoked after the dumping of examples and failures.



64
65
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 64

def dump_summary(duration, example_count, failure_count, pending_count)
end

#example_failed(example, counter, failure) ⇒ Object

This method is invoked when an example fails, i.e. an exception occurred inside it (such as a failed should or other exception). counter is the sequence number of the failure (starting at 1) and failure is the associated Failure object.



39
40
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 39

def example_failed(example, counter, failure)
end

#example_passed(example) ⇒ Object

This method is invoked when an example passes.



32
33
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 32

def example_passed(example)
end

#example_pending(example, message, pending_caller) ⇒ Object

This method is invoked when an example is not yet implemented (i.e. has not been provided a block), or when an ExamplePendingError is raised. message is the message from the ExamplePendingError, if it exists, or the default value of “Not Yet Implemented” pending_caller is the file and line number of the spec which has called the pending method



48
49
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 48

def example_pending(example, message, pending_caller)
end

#example_started(example) ⇒ Object

This method is invoked when an example starts.



28
29
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 28

def example_started(example)
end

#start(example_count) ⇒ Object

This method is invoked before any examples are run, right after they have all been collected. This can be useful for special formatters that need to provide progress on feedback (graphical ones)

This method will only be invoked once, and the next one to be invoked is #add_example_group



16
17
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 16

def start(example_count)
end

#start_dump ⇒ Object

This method is invoked after all of the examples have executed. The next method to be invoked after this one is #dump_failure (once for each failed example),



53
54
 
# File 'lib/plugins/spec/rgithook_formatter.rb', line 53

def start_dump
end