Class: Mechanize::History

Inherits:
Array
  • Object
show all
Defined in:
lib/mechanize/history.rb

Overview

This class manages history for your mechanize object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_size = nil) ⇒ History

Returns a new instance of History.



7
8
9
10
 
# File 'lib/mechanize/history.rb', line 7

def initialize(max_size = nil)
  @max_size       = max_size
  @history_index  = {}
end

Instance Attribute Details

#max_size ⇒ Object

Returns the value of attribute max_size.



5
6
7
 
# File 'lib/mechanize/history.rb', line 5

def max_size
  @max_size
end

Instance Method Details

#clear ⇒ Object 



37
38
39
40
 
# File 'lib/mechanize/history.rb', line 37

def clear
  @history_index.clear
  super
end

#initialize_copy(orig) ⇒ Object 



12
13
14
15
 
# File 'lib/mechanize/history.rb', line 12

def initialize_copy(orig)
  super
  @history_index = orig.instance_variable_get(:@history_index).dup
end

#pop ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/mechanize/history.rb', line 51

def pop
  return nil if length == 0
  page = super
  remove_from_index(page)
  page
end

#push(page, uri = nil) ⇒ Object Also known as: << 



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/mechanize/history.rb', line 17

def push(page, uri = nil)
  super(page)
  @history_index[(uri ? uri : page.uri).to_s] = page
  if @max_size && self.length > @max_size
    while self.length > @max_size
      self.shift
    end
  end
  self
end

#shift ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/mechanize/history.rb', line 42

def shift
  return nil if length == 0
  page    = self[0]
  self[0] = nil
  super
  remove_from_index(page)
  page
end

#visited?(url) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/mechanize/history.rb', line 29

def visited?(url)
  ! visited_page(url).nil?
end

#visited_page(url) ⇒ Object 



33
34
35
 
# File 'lib/mechanize/history.rb', line 33

def visited_page(url)
  @history_index[(url.respond_to?(:uri) ? url.uri : url).to_s]
end