Class: HammerBuilder::Pool

Inherits:
Object
  • Object
show all
Defined in:
lib/hammer_builder/pool.rb

Overview

Creating builder instances is expensive, therefore you can use Pool to go around that

Examples:

pool = Pool.new Formatted
pool.get.go_in do
  # some rendering
end.to_xhtml! # => output and releases the builder to pool

Direct Known Subclasses

SynchronizedPool

Defined Under Namespace

Modules: Helper

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass) ⇒ Pool

Returns a new instance of Pool.



26
27
28
29
30
 
# File 'lib/hammer_builder/pool.rb', line 26

def initialize(klass)
  @klass = klass
  @pool  = []
  klass.send :include, Helper
end

Instance Attribute Details

#klass ⇒ Object (readonly)

Returns the value of attribute klass.



24
25
26
 
# File 'lib/hammer_builder/pool.rb', line 24

def klass
  @klass
end

Instance Method Details

#get ⇒ Abstract

This the preferred way of getting new Builder. If you forget to release it, it does not matter - builder gets GCed after you lose reference

Returns:



35
36
37
38
39
40
41
 
# File 'lib/hammer_builder/pool.rb', line 35

def get
  if @pool.empty?
    @klass.new.instance_exec(self) { |origin| @_origin = origin; self }
  else
    @pool.pop
  end
end

#release(builder) ⇒ Object

returns builder back into pool DONT forget to lose the reference to the builder

Parameters:

Raises:

  • (TypeError) 


45
46
47
48
49
50
 
# File 'lib/hammer_builder/pool.rb', line 45

def release(builder)
  raise TypeError unless builder.is_a? @klass
  builder.reset
  @pool.push builder
  nil
end

#size ⇒ Object 



52
53
54
 
# File 'lib/hammer_builder/pool.rb', line 52

def size
  @pool.size
end