Class: LintFu::HtmlReport

Inherits:
Report
  • Object
show all
Defined in:
lib/lint_fu/report.rb

Constant Summary collapse

STYLESHEET = 
<<-EOF
  table { border: 2px solid black }
  th    { color: white; background: black }
  td    { border-right: 1px dotted black; border-bottom: 1px dotted black }
  h1    { font-family: Arial,Helvetica,sans-serif }
  h2    { font-family: Arial,Helvetica,sans-serif; color: white; background: black }
  h3    { font-family: Arial,Helvetica,sans-serif }
  h4    { border-bottom: 1px dotted grey }
  .detail code { background: yellow }
EOF

Instance Attribute Summary

Attributes inherited from Report

#scan, #scm

Instance Method Summary collapse

Methods inherited from Report

#initialize

Constructor Details

This class inherits a constructor from LintFu::Report

Instance Method Details

#generate(output_stream) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/lint_fu/report.rb', line 29

def generate(output_stream)
  #Build map of contributors to issues they created

  @issues_by_author = Hash.new

  @issues.each do |issue|
    commit, author = scm.blame(issue.relative_file, issue.line)
    @issues_by_author[author] ||= []
    @issues_by_author[author] << issue
  end
  #Sort contributors in decreasing order of number of issues created
  @authors_by_issue_count = @issues_by_author.keys.sort { |x,y| @issues_by_author[y].size <=> @issues_by_author[x].size }

  @issues_by_class = Hash.new
  @issues.each do |issue|
    klass = issue.class
    @issues_by_class[klass] ||= []
    @issues_by_class[klass] << issue
  end

  #Build map of files to issues they contain
  @issues_by_file = Hash.new
  @issues.each do |issue|
    @issues_by_file[issue.relative_file] ||= []
    @issues_by_file[issue.relative_file] << issue
  end
  #Sort files in decreasing order of number of issues contained
  @files_by_issue_count = @issues_by_file.keys.sort { |x,y| @issues_by_file[y].size <=> @issues_by_file[x].size }
  #Sort files in increasing lexical order of path
  @files_by_name = @issues_by_file.keys.sort { |x,y| x <=> y }

  #Write the report in HTML format
  x = Builder::XmlMarkup.new(:target => output_stream, :indent => 2)
  x << %Q{<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n}
  x.html do |html|
    html.head do |head|
      head.title 'Static Analysis Results'
      include_external_javascripts(head)
      include_external_stylesheets(head)
      head.style(STYLESHEET, :type=>'text/css')
    end
    html.body do |body|
      body.h1 'Summary'
      body.p "#{@issues.size} issues found."

      body.h2 'Issues by Type'
      body.table do |table|
        table.thead do |thead|
          thead.tr do |tr|
            tr.th 'Type'
            tr.th '#'
            tr.th 'Issues'
          end

          @issues_by_class.each_pair do |klass, issues|
            table.tr do |tr|
              sample_issue = issues.first
              tr.td(sample_issue.brief)
              tr.td(issues.size.to_s)
              tr.td do |td|
                issues.each do |issue|
                  td.a(issue.issue_hash[0..4], :href=>"#issue_#{issue.issue_hash}")
                  td.text!(' ')
                end
              end
            end
          end
        end
      end

      body.h2 'Issues by Contributor'
      body.table do |table|
        table.thead do |thead|
          thead.tr do |tr|
            tr.th 'Name'
            tr.th '#'
            tr.th 'Issues'
          end
        end
        table.tbody do |tbody|
          @authors_by_issue_count.each do |author|
            table.tr do |tr|
              tr.td(author)
              tr.td(@issues_by_author[author].size.to_s)
              tr.td do |td|
                @issues_by_author[author].each do |issue|
                  td.a(issue.issue_hash[0..4], :href=>"#issue_#{issue.issue_hash}")
                  td.text!(' ')
                end
              end
            end
          end
        end
      end

      body.h2 'Issues by File'
      body.table do |table|
        table.thead do |thead|
          thead.tr do |tr|
            tr.th 'File'
            tr.th '#'
            tr.th 'Issues'
          end
        end
        table.tbody do |tbody|
          @files_by_issue_count.each do |file|
            tbody.tr do |tr|
              tr.td(file)
              tr.td(@issues_by_file[file].size.to_s)
              tr.td do |td|
                @issues_by_file[file].each do |issue|
                  td.a(issue.issue_hash[0..4], :href=>"#issue_#{issue.issue_hash}")
                  td.text!(' ')
                end
              end
            end
          end
        end
      end

      body.h1 'Detailed Results'
      @files_by_name.each do |file|
        body.h2 file

        issues = @issues_by_file[file]
        issues = issues.to_a.sort { |x,y| x.line <=> y.line }
        issues.each do |issue|
          body.div(:class=>'issue', :id=>"issue_#{issue.issue_hash}") do |div_issue|
            div_issue.h4 do |h4|
              reference_link(div_issue, issue)
              h4.text! ", #{File.basename(issue.file)}:#{issue.line}"
            end
            div_issue.div(:class=>'detail') do |div_detail|
              div_detail << RedCloth.new(issue.detail).to_html
            end

            first   = issue.line-3
            first   = 1 if first < 1
            last    = issue.line + 3
            excerpt = scm.excerpt(issue.file, (first..last), :blame=>false)
            highlighted_code_snippet(div_issue, excerpt, first, issue.line)
          end
        end
      end

      body.h1 'Reference Information'
      @issues_by_class.values.each do |array|
        sample_issue = array.first
        body.h2 sample_issue.brief
        body.div(:id=>id_for_issue_class(sample_issue.class)) do |div|
          div << RedCloth.new(sample_issue.reference_info).to_html 
        end
      end

      activate_syntax_highlighter(body)
    end
  end
end