Class: PulseAnalysis::Report

Inherits:
Object
  • Object
show all
Defined in:
lib/pulse-analysis/report.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(analysis) ⇒ Report

Returns a new instance of Report.

Parameters:

  • analysis (PulseAnalysis::Analysis) —

    The analysis to report on. Required that analysis has been run (see Analysis#run)



8
9
10
11
 
# File 'lib/pulse-analysis/report.rb', line 8

def initialize(analysis)
  @analysis = analysis
  populate_items
end

Instance Attribute Details

#analysis ⇒ Object (readonly)

Returns the value of attribute analysis.



5
6
7
 
# File 'lib/pulse-analysis/report.rb', line 5

def analysis
  @analysis
end

#items ⇒ Object (readonly)

Returns the value of attribute items.



5
6
7
 
# File 'lib/pulse-analysis/report.rb', line 5

def items
  @items
end

Instance Method Details

#inspect ⇒ String

Override Object#inspect to not include the large audio data

Returns:

  • (String) 


26
27
28
 
# File 'lib/pulse-analysis/report.rb', line 26

def inspect
  to_h.inspect
end

#to_h ⇒ Hash

Convert the report to a hash

Returns:

  • (Hash) 


15
16
17
18
19
20
21
22
 
# File 'lib/pulse-analysis/report.rb', line 15

def to_h
  {
    file: {
      path: @analysis.sound.audio_file.path.to_s
    },
    analysis: @items
  }
end