Class: Skunk::Generator::Html::Overview

Inherits:
RubyCritic::Generator::Html::Base
  • Object
show all
Defined in:
lib/skunk/generators/html/overview.rb

Overview

Generates an HTML overview report for the analysed modules.

Constant Summary collapse

TEMPLATES_DIR = 
File.expand_path("templates", __dir__)
TEMPLATE = 
erb_template("skunk_overview.html.erb")

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(analysed_modules) ⇒ Overview

Returns a new instance of Overview.



21
22
23
24
25
 
# File 'lib/skunk/generators/html/overview.rb', line 21

def initialize(analysed_modules)
  @analysed_modules = analysed_modules
  @generated_at = Time.now.strftime("%Y-%m-%d %H:%M:%S")
  @skunk_version = Skunk::VERSION
end

Class Method Details

.erb_template(template_path) ⇒ Object 



14
15
16
 
# File 'lib/skunk/generators/html/overview.rb', line 14

def self.erb_template(template_path)
  ERB.new(File.read(File.join(TEMPLATES_DIR, template_path)))
end

Instance Method Details

#analysed_modules_count ⇒ Object 



35
36
37
 
# File 'lib/skunk/generators/html/overview.rb', line 35

def analysed_modules_count
  @analysed_modules.analysed_modules_count
end

#file_name ⇒ Object 



27
28
29
 
# File 'lib/skunk/generators/html/overview.rb', line 27

def file_name
  "skunk_overview.html"
end

#files ⇒ Object 



47
48
49
50
51
 
# File 'lib/skunk/generators/html/overview.rb', line 47

def files
  @files ||= @analysed_modules.sorted_modules.map do |module_data|
    FileData.new(module_data)
  end
end

#render ⇒ Object 



31
32
33
 
# File 'lib/skunk/generators/html/overview.rb', line 31

def render
  TEMPLATE.result(binding)
end

#skunk_score_average ⇒ Object 



43
44
45
 
# File 'lib/skunk/generators/html/overview.rb', line 43

def skunk_score_average
  @analysed_modules.skunk_score_average
end

#skunk_score_total ⇒ Object 



39
40
41
 
# File 'lib/skunk/generators/html/overview.rb', line 39

def skunk_score_total
  @analysed_modules.skunk_score_total
end