Class: Dossier::Segment

Inherits:
Object
  • Object
show all
Includes:
Dossier::Segmenter::Summable
Defined in:
lib/dossier/segment.rb,
lib/dossier/segment/rows.rb,
lib/dossier/segment/chain.rb,
lib/dossier/segment/summary.rb,
lib/dossier/segment/definition.rb

Defined Under Namespace

Classes: Chain, Definition, Rows, Summary

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Dossier::Segmenter::Summable

#summarize, #summary

Constructor Details

#initialize(segmenter, definition, options = {}) ⇒ Segment

Returns a new instance of Segment.



7
8
9
10
11
12
13
 
# File 'lib/dossier/segment.rb', line 7

def initialize(segmenter, definition, options = {})
  self.segmenter  = segmenter
  self.report     = segmenter.report
  self.definition = definition
  self.options    = options.symbolize_keys
  extend(definition.chain_module)
end

Instance Attribute Details

#definition ⇒ Object

Returns the value of attribute definition.



5
6
7
 
# File 'lib/dossier/segment.rb', line 5

def definition
  @definition
end

#options ⇒ Object

Returns the value of attribute options.



5
6
7
 
# File 'lib/dossier/segment.rb', line 5

def options
  @options
end

#parent ⇒ Object

Returns the value of attribute parent.



5
6
7
 
# File 'lib/dossier/segment.rb', line 5

def parent
  @parent
end

#report ⇒ Object

Returns the value of attribute report.



5
6
7
 
# File 'lib/dossier/segment.rb', line 5

def report
  @report
end

#segmenter ⇒ Object

Returns the value of attribute segmenter.



5
6
7
 
# File 'lib/dossier/segment.rb', line 5

def segmenter
  @segmenter
end

Instance Method Details

#chain ⇒ Object 



27
28
29
 
# File 'lib/dossier/segment.rb', line 27

def chain
  @chain ||= [].tap { |collector| parent_chain(self, collector) }
end

#display_name ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/dossier/segment.rb', line 15

def display_name
  if definition.display_name.respond_to?(:call)
    definition.display_name.call(options)
  else
    options.fetch(definition.display_name)
  end
end

#group_by ⇒ Object 



23
24
25
 
# File 'lib/dossier/segment.rb', line 23

def group_by
  options.fetch(definition.group_by)
end

#inspect ⇒ Object 



35
36
37
 
# File 'lib/dossier/segment.rb', line 35

def inspect
  "#<#{self.class.name}:#{key_path}>"
end

#key_path ⇒ Object 



31
32
33
 
# File 'lib/dossier/segment.rb', line 31

def key_path
  chain.map(&:group_by).reverse.join('.')
end