Class: Compendium::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/compendium/query.rb

Direct Known Subclasses

Presenters::Chart

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options, proc) ⇒ Query

Returns a new instance of Query.



10
11
12
13
14
15
 
# File 'lib/compendium/query.rb', line 10

def initialize(name, options, proc)
  @name = name
  @options = options
  @proc = proc
  @metrics = ::Collection[Metric]
end

Instance Attribute Details

#metrics ⇒ Object (readonly)

Returns the value of attribute metrics.



7
8
9
 
# File 'lib/compendium/query.rb', line 7

def metrics
  @metrics
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/compendium/query.rb', line 7

def name
  @name
end

#options ⇒ Object

Returns the value of attribute options.



8
9
10
 
# File 'lib/compendium/query.rb', line 8

def options
  @options
end

#proc ⇒ Object

Returns the value of attribute proc.



8
9
10
 
# File 'lib/compendium/query.rb', line 8

def proc
  @proc
end

#report ⇒ Object

Returns the value of attribute report.



8
9
10
 
# File 'lib/compendium/query.rb', line 8

def report
  @report
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



7
8
9
 
# File 'lib/compendium/query.rb', line 7

def results
  @results
end

#through ⇒ Object

Returns the value of attribute through.



8
9
10
 
# File 'lib/compendium/query.rb', line 8

def through
  @through
end

Instance Method Details

#add_metric(name, proc, options = {}) ⇒ Object 



29
30
31
 
# File 'lib/compendium/query.rb', line 29

def add_metric(name, proc, options = {})
  Compendium::Metric.new(name, self.name, proc, options).tap { |m| @metrics << m }
end

#initialize_clone ⇒ Object 



17
18
19
20
 
# File 'lib/compendium/query.rb', line 17

def initialize_clone(*)
  super
  @metrics = @metrics.clone
end

#nil? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/compendium/query.rb', line 46

def nil?
  proc.nil?
end

#ran? ⇒ Boolean Also known as: has_run?

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/compendium/query.rb', line 41

def ran?
  !@results.nil?
end

#render_chart(template, *options, &block) ⇒ Object 



37
38
39
 
# File 'lib/compendium/query.rb', line 37

def render_chart(template, *options, &block)
  Compendium::Presenters::Chart.new(template, self, *options, &block).render
end

#render_table(template, *options, &block) ⇒ Object 



33
34
35
 
# File 'lib/compendium/query.rb', line 33

def render_table(template, *options, &block)
  Compendium::Presenters::Table.new(template, self, *options, &block).render
end

#run(params, context = self) ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/compendium/query.rb', line 22

def run(params, context = self)
  collect_results(params, context)
  collect_metrics(context)

  @results
end