Class: SeeingIsBelieving::EventStream::Producer

Inherits:
Object
  • Object
show all
Defined in:
lib/seeing_is_believing/event_stream/producer.rb

Defined Under Namespace

Modules: NullQueue

Constant Summary collapse

StackErrors = 
[SystemStackError]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resultstream) ⇒ Producer

Returns a new instance of Producer.



19
20
21
22
23
24
25
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 19

def initialize(resultstream)
  self.filename          = nil
  self.max_line_captures = Float::INFINITY
  self.recorded_results  = []
  self.queue             = Queue.new
  self.producer_thread   = build_producer_thread(resultstream)
end

Instance Attribute Details

#filename ⇒ Object

Returns the value of attribute filename.



17
18
19
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 17

def filename
  @filename
end

#max_line_captures ⇒ Object

Returns the value of attribute max_line_captures.



17
18
19
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 17

def max_line_captures
  @max_line_captures
end

#version ⇒ Object (readonly) Also known as: ver

Returns the value of attribute version.



27
28
29
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 27

def version
  @version
end

Instance Method Details

#finish! ⇒ Object 



105
106
107
108
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 105

def finish!
  queue << :break # note that consumer will continue reading until stream is closed, which is not the responsibility of the producer
  producer_thread.join
end

#record_exception(line_number, exception) ⇒ Object

records the exception, returns the exitstatus for that exception



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 73

def record_exception(line_number, exception)
  return exception.status if SystemExit === exception # TODO === is not in the list
  if !line_number && filename
    begin line_number = exception.backtrace.grep(/#{filename.to_s}/).first[/:\d+/][1..-1].to_i
    rescue NoMethodError
    end
  end
  line_number ||= -1
  queue << [
    "exception",
    line_number.to_s,
    to_string_token(exception.class.name),
    to_string_token(exception.message),
    exception.backtrace.size.to_s,
    *exception.backtrace.map { |line| to_string_token line }
  ].join(" ")
  1 # exit status
end

#record_exec(args) ⇒ Object 



97
98
99
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 97

def record_exec(args)
  queue << "exec #{to_string_token args.inspect}"
end

#record_filename(filename) ⇒ Object 



92
93
94
95
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 92

def record_filename(filename)
  self.filename = filename
  queue << "filename #{to_string_token filename}"
end

#record_max_line_captures(max_line_captures) ⇒ Object 



38
39
40
41
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 38

def record_max_line_captures(max_line_captures)
  self.max_line_captures = max_line_captures
  queue << "max_line_captures #{max_line_captures}"
end

#record_num_lines(num_lines) ⇒ Object 



101
102
103
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 101

def record_num_lines(num_lines)
  queue << "num_lines #{num_lines}"
end

#record_result(type, line_number, value) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 45

def record_result(type, line_number, value)
  counts = recorded_results[line_number] ||= Hash.new(0)
  count  = counts[type]
  recorded_results[line_number][type] = count.next
  if count < max_line_captures
    begin
      if block_given?
        inspected = yield(value).to_str
      else
        inspected = value.inspect.to_str
      end
    rescue *StackErrors
      # this is necessary because SystemStackError won't show the backtrace of the method we tried to call
      # which means there won't be anything showing the user where this came from
      # so we need to re-raise the error to get a backtrace that shows where we came from
      # otherwise it looks like the bug is in SiB and not the user's program, see https://github.com/JoshCheek/seeing_is_believing/issues/37
      raise SystemStackError, "Calling inspect blew the stack (is it recursive w/o a base case?)"
    rescue Exception
      inspected = "#<no inspect available>"
    end
    queue << "result #{line_number.to_s} #{type.to_s} #{to_string_token inspected}"
  elsif count == max_line_captures
    queue << "maxed_result #{line_number.to_s} #{type.to_s}"
  end
  value
end

#record_ruby_version(ruby_version) ⇒ Object 



34
35
36
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 34

def record_ruby_version(ruby_version)
  queue << "ruby_version #{to_string_token ruby_version}"
end

#record_sib_version(sib_version) ⇒ Object 



29
30
31
32
 
# File 'lib/seeing_is_believing/event_stream/producer.rb', line 29

def record_sib_version(sib_version)
  @version = sib_version
  queue << "sib_version #{to_string_token sib_version}"
end