Module: CommandUnit

Defined in:
lib/command-unit.rb,
lib/command-unit/test.rb,
lib/command-unit/hooks.rb,
lib/command-unit/scenario.rb,
lib/command-unit/totaliser.rb,
lib/command-unit/expectation.rb,
lib/command-unit/expectation_result.rb

Defined Under Namespace

Classes: Expectation, ExpectationResult, Hooks, Scenario, Test, Totaliser

Constant Summary collapse

@@scenario_count = 
0
@@scenarios = 
[]
@@current_scenario = 
nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#current_scenario ⇒ Object (readonly)

Returns the value of attribute current_scenario.



14
15
16
 
# File 'lib/command-unit.rb', line 14

def current_scenario
  @current_scenario
end

Instance Method Details

#ensure_inside_scenario ⇒ Object 



70
71
72
 
# File 'lib/command-unit.rb', line 70

def ensure_inside_scenario
  raise "#{caller[0]} must be called from inside a scenario block" if @@current_scenario == nil
end

#fail(desc = '') ⇒ Object 



108
109
110
 
# File 'lib/command-unit.rb', line 108

def fail(desc = '')
  ExpectationResult.new(desc, false)
end

#i_expect(desc, &i_expect_block) ⇒ Object 



99
100
101
102
 
# File 'lib/command-unit.rb', line 99

def i_expect(desc, &i_expect_block)
  ensure_inside_scenario
  @@current_scenario.current_test.add_expectation Expectation.new(desc, &i_expect_block)
end

#pass(desc = '') ⇒ Object 



104
105
106
 
# File 'lib/command-unit.rb', line 104

def pass(desc = '')
  ExpectationResult.new(desc, true)
end

#run(namespace_or_scenario_or_nowt = nil, out_stream = STDOUT) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/command-unit.rb', line 39

def run(namespace_or_scenario_or_nowt=nil, out_stream=STDOUT)
  hooks = Hooks.new
  if namespace_or_scenario_or_nowt.nil?
    # Run the lot...
    out_stream.puts "\nRunning #{@@scenarios.count} scenarios..."
    @@scenarios.each do |scenario|
      scenario.run(hooks, out_stream)
    end
  else
    if namespace_or_scenario_or_nowt.is_a? Symbol
      namespace = namespace_or_scenario_or_nowt
      scenarios_in_namespace = @@scenarios.select { |s| s.namespace == namespace }
      out_stream.puts "\nRunning #{scenarios_in_namespace.length} scenarios in namespace '#{namespace}'..."
      scenarios_in_namespace.each do |scenario|
        scenario.run(hooks, out_stream)
      end
    elsif namespace_or_scenario.is_a? Scenario
      scenario = namespace_or_scenario
      out_stream.puts "\nRunning single scenario..."
      scenario.run(hooks, out_stream)
    else
      raise "You must pass either a Scenario, a Symbol (namespace), or nil into run. You passed a #{namespace_or_scenario_or_nowt.class}"
    end
  end

  t = hooks.totaliser
  message = "\nRan #{t.scenarios_run} scenarios, #{t.scenarios_passed} passed, #{t.scenarios_failed} failed (tests passed: #{t.tests_passed}, failed: #{t.tests_failed}) (expectations passed: #{t.expectations_passed}, failed: #{t.expectations_failed})\n"

  out_stream.puts message
end

#run_silent(namespace_or_nil = nil) ⇒ Object 



33
34
35
36
37
 
# File 'lib/command-unit.rb', line 33

def run_silent(namespace_or_nil=nil)
  output = StringIO.new
  run(namespace_or_nil, output)
  return output.string
end

#scenario(namespace_or_description, description_or_nil = nil, &block) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/command-unit.rb', line 16

def scenario(namespace_or_description, description_or_nil=nil, &block)
  raise "You must provide a description (String) for each scenario." if namespace_or_description.nil? or description_or_nil.is_a? Symbol
  raise "namespace must be a symbol, if you meant it as a description, use a string instead." if description_or_nil.is_a? String and not namespace_or_description.is_a? Symbol

  if description_or_nil.nil?
    description = namespace_or_description
    namespace = nil
  else
    description = description_or_nil
    namespace = namespace_or_description
  end

  @@scenarios.push Scenario.new(namespace, description, STDOUT, &block)

  return @@scenarios.last
end

#scenario_set_up(&scenario_set_up_block) ⇒ Object 



74
75
76
77
 
# File 'lib/command-unit.rb', line 74

def scenario_set_up(&scenario_set_up_block)
  ensure_inside_scenario
  @@current_scenario.scenario_set_up_block = scenario_set_up_block
end

#scenario_tear_down(&scenario_tear_down_block) ⇒ Object 



79
80
81
82
 
# File 'lib/command-unit.rb', line 79

def scenario_tear_down(&scenario_tear_down_block)
  ensure_inside_scenario
  @@current_scenario.scenario_tear_down_block = scenario_tear_down_block
end

#set_up(&set_up_block) ⇒ Object 



89
90
91
92
 
# File 'lib/command-unit.rb', line 89

def set_up(&set_up_block)
  ensure_inside_scenario
  @@current_scenario.set_up_block = set_up_block
end

#tear_down(&tear_down_block) ⇒ Object 



84
85
86
87
 
# File 'lib/command-unit.rb', line 84

def tear_down(&tear_down_block)
  ensure_inside_scenario
  @@current_scenario.tear_down_block = tear_down_block
end

#when_i(desc, &when_i_block) ⇒ Object 



94
95
96
97
 
# File 'lib/command-unit.rb', line 94

def when_i(desc, &when_i_block)
  ensure_inside_scenario
  @@current_scenario.add_test Test.new(desc, &when_i_block)
end