Class: GG::Stack

Inherits:
Object show all
Includes:
Enumerable
Defined in:
lib/gg/stack.rb

Overview

stakk.rb

Instantiate a Go::CallStack object

This is the way to create a Stakk object that contains a full stack trace that is easy to get data out of.

stack = get_stakk      # stack starting from one up the caller stack             
stack = get_stakk(1)   # stack starting from one up the caller stack
stack = get_stakk(0)   # stack starting from this line

The traditional way to instantiate a Stakk

stack = Stakk.new( caller )       # look one up the caller stack
stack = Stakk.new( caller(1) )    # Same as above
stack = Stakk.new( caller(0) )    # get callstack at this line in code

Methods

Get one item in the stack

item = stack[0]
item.line              -> 5
item.value             -> "./go/util/caller/caller.test.rb:6:in `test_caller'"
item.to_s              -> same as above 
item.path              -> path to stack item
item.path( 'file.html' )  -> path to other file in same dir as stack item
item.dir               -> dir of stack item
item.join( subpath )   -> join subpath to item.dir
item.method_name       -> name of method. Didn't use #method because of conflict

Stakk methods

stack.to_a
stack.each
stack[0]
stack[0..3]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(array) ⇒ Stack

CallStack takes an array that is returned by the method Kernel#caller.



43
44
45
46
 
# File 'lib/gg/stack.rb', line 43

def initialize( array )
  @array = array
  @items = []
end

Instance Attribute Details

#array ⇒ Object (readonly)

Returns the value of attribute array.



48
49
50
 
# File 'lib/gg/stack.rb', line 48

def array
  @array
end

#items ⇒ Object (readonly)

Returns the value of attribute items.



48
49
50
 
# File 'lib/gg/stack.rb', line 48

def items
  @items
end

Instance Method Details

#[](arg) ⇒ Object

Returns the CallStack::Item at the nth position up the stack or if given a range, returns a new GoCallStack object with that portion of the array of initial caller items.



53
54
55
56
57
58
59
 
# File 'lib/gg/stack.rb', line 53

def []( arg )
  if arg.is_a?( Range )
    GG::Stack.new( array[ arg ] )
  else
    items[ arg ] ||= GG::StackLine.new( array[ arg ] )
  end
end

#each ⇒ Object

Iterates over each item in the CallStack



62
63
64
65
66
 
# File 'lib/gg/stack.rb', line 62

def each
  array.each_with_index do |item,i|
    yield self[i]
  end
end

#to_a ⇒ Object

Returns all CallStack::Item objects as an array



69
70
71
72
73
74
75
76
 
# File 'lib/gg/stack.rb', line 69

def to_a
  i = 0
  @array.map do |stack_line_value|
    item = self[i]
    i += 1
    item
  end
end