piggly-nsd 2.3.3

data/lib/piggly/reporter/base.rb

@@ -0,0 +1,106 @@
+module Piggly
+  module Reporter
+
+    class Base
+      include HtmlDsl
+
+      def initialize(config)
+        @config = config
+      end
+
+      # Copy each file to @config.report_root
+      def install(*files)
+        files.each do |name|
+          src = File.join(File.dirname(__FILE__), name)
+          dst = report_path(name)
+
+          File.open(dst, "w"){|io| io.write(File.read(src)) }
+        end
+      end
+
+      def report_path(file=nil, ext=nil)
+        unless file.nil?
+          # Remove the original extension from +file+ and add given extension
+          @config.mkpath(@config.report_root, ext ?
+            File.basename(file, ".*") + ext :
+            File.basename(file))
+        else
+          @config.mkpath(@config.report_root)
+        end
+      end
+
+    private
+
+      def aggregate(label, summary)
+        tag :p, label, :class => "summary"
+        tag :table, :class => "summary" do
+          tag :tr do
+            tag :th, "Blocks"
+            tag :th, "Loops"
+            tag :th, "Branches"
+            tag :th, "Block Coverage"
+            tag :th, "Loop Coverage"
+            tag :th, "Branch Coverage"
+          end
+
+          tag :tr, :class => "even" do
+            unless summary.include?(:block) or summary.include?(:loop) or summary.include?(:branch)
+              # Parser couldn't parse this file
+              tag(:td, :class => "count") { tag :span, -1 }
+              tag(:td, :class => "count") { tag :span, -1 }
+              tag(:td, :class => "count") { tag :span, -1 }
+              tag(:td, :class => "pct")   { tag :span, -1 }
+              tag(:td, :class => "pct")   { tag :span, -1 }
+              tag(:td, :class => "pct")   { tag :span, -1 }
+            else
+              tag(:td, (summary[:block][:count]  || 0), :class => "count")
+              tag(:td, (summary[:loop][:count]   || 0), :class => "count")
+              tag(:td, (summary[:branch][:count] || 0), :class => "count")
+              tag(:td, :class => "pct") { percent(summary[:block][:percent])  }
+              tag(:td, :class => "pct") { percent(summary[:loop][:percent])   }
+              tag(:td, :class => "pct") { percent(summary[:branch][:percent]) }
+            end
+          end
+        end
+      end
+
+      def percent(pct)
+        if pct
+          tag :table, :align => "center" do
+            tag :tr do
+              tag :td, "%0.2f%% " % pct, :class => "num"
+
+              style =
+                case pct.to_f
+                when 0;      "zero"
+                when 0...30; "low"
+                when 0...60; "mid"
+                when 0...99; "high"
+                else         "full"
+                end
+
+              tag :td, :class => "graph" do
+                if pct
+                  tag :table, :align => "right", :class => "graph #{style}" do
+                    tag :tr do
+                      covered_width = (pct/2.0).round
+                      tag :td, :class => "covered", :width => covered_width
+                      tag :td, :class => "uncovered", :width => (50 - covered_width)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        else
+          tag :span, -1, :style => "display:none"
+        end
+      end
+
+      def timestamp
+        tag :div, "Generated by piggly #{Piggly::VERSION} at #{Time.now.strftime("%B %d, %Y %H:%M %Z")}", :class => "timestamp"
+      end
+    end
+
+  end
+end

data/lib/piggly/reporter/html_dsl.rb

@@ -0,0 +1,63 @@
+module Piggly
+  module Reporter
+
+    #
+    # Markup DSL
+    #
+    module HtmlDsl
+      unless defined? HTML_REPLACE
+        HTML_REPLACE = { "&" => "&amp;", '"' => "&quot;", ">" => "&gt;", "<" => "&lt;" }
+        HTML_PATTERN = /[&"<>]/
+      end
+
+      def html(output = "")
+        begin
+          @htmltag_output, htmltag_output = output, @htmltag_output
+          # @todo: doctype
+          yield
+        ensure
+          # restore
+          @htmltag_output = htmltag_output
+        end
+      end
+
+      def tag(name, content = nil, attributes = {})
+        if content.is_a?(Hash) and attributes.empty?
+          content, attributes = nil, content
+        end
+
+        attributes = attributes.inject("") do |string, pair|
+          k, v = pair
+          string << %[ #{k}="#{v}"]
+        end
+
+        if content.nil?
+          if block_given?
+            @htmltag_output << "<#{name}#{attributes}>"
+            yield
+            @htmltag_output << "</#{name}>"
+          else
+            @htmltag_output << "<#{name}#{attributes}/>"
+          end
+        else
+          @htmltag_output << "<#{name}#{attributes}>#{content.to_s}</#{name}>"
+        end
+      end
+
+      if "".respond_to?(:fast_xs)
+        def e(string)
+          string.fast_xs
+        end
+      elsif "".respond_to?(:to_xs)
+        def e(string)
+          string.to_xs
+        end
+      else
+        def e(string)
+          string.gsub(HTML_PATTERN) {|c| HTML_REPLACE[c] }
+        end
+      end
+    end
+
+  end
+end

data/lib/piggly/reporter/index.rb

@@ -0,0 +1,114 @@
+module Piggly
+  module Reporter
+
+    class Index < Base
+
+      def initialize(config, profile)
+        @config, @profile = config, profile
+      end
+
+      def report(procedures, index)
+        io = File.open("#{report_path}/index.html", "w")
+
+        html(io) do
+          tag :html do
+            tag :head do
+              tag :title, "Piggly PL/pgSQL Code Coverage"
+              tag :meta, :charset => "utf-8"
+              tag :link, :rel => "stylesheet", :type => "text/css", :href => "piggly.css"
+              tag :script, "<!-- -->", :type => "text/javascript", :src => "sortable.js"
+            end
+
+            tag :body do
+              aggregate("PL/pgSQL Coverage Summary", @profile.summary)
+              table(procedures.sort_by{|p| index.label(p) }, index)
+              timestamp
+            end
+          end
+        end
+      ensure
+        io.close
+      end
+
+    private
+
+      def table(procedures, index)
+        tag :div, :class => "table-wrapper" do
+          tag :table, :class => "summary sortable" do
+            tag :tr do
+              tag :th, "Procedure"
+              tag :th, "Blocks"
+              tag :th, "Loops"
+              tag :th, "Branches"
+              tag :th, "Block Coverage"
+              tag :th, "Loop Coverage"
+              tag :th, "Branch Coverage"
+            end
+
+            procedures.each_with_index do |procedure, k|
+              summary = @profile.summary(procedure)
+              row     = k.modulo(2) == 0 ? "even" : "odd"
+              label   = index.label(procedure)
+
+              tag :tr, :class => row do
+                unless summary.include?(:block) or summary.include?(:loop) or summary.include?(:branch)
+                  # Parser couldn't parse this file
+                  tag :td, label, :class => "file fail"
+                  tag(:td, :class => "count") { tag :span, -1 }
+                  tag(:td, :class => "count") { tag :span, -1 }
+                  tag(:td, :class => "count") { tag :span, -1 }
+                  tag(:td, :class => "pct") { tag :span, -1 }
+                  tag(:td, :class => "pct") { tag :span, -1 }
+                  tag(:td, :class => "pct") { tag :span, -1 }
+                else
+                  tag(:td, :class => "file") { tag :a, label, :href => procedure.identifier + ".html" }
+                  tag :td, (summary[:block][:count]  || 0), :class => "count"
+                  tag :td, (summary[:loop][:count]   || 0), :class => "count"
+                  tag :td, (summary[:branch][:count] || 0), :class => "count"
+                  tag(:td, :class => "pct") { percent(summary[:block][:percent])  }
+                  tag(:td, :class => "pct") { percent(summary[:loop][:percent])   }
+                  tag(:td, :class => "pct") { percent(summary[:branch][:percent]) }
+                end
+              end
+
+            end
+          end
+        end
+      end
+
+      def percent(pct)
+        if pct
+          tag :table, :align => "center" do
+            tag :tr do
+              tag :td, "%0.2f%%&nbsp;" % pct, :class => "num"
+
+              style =
+                case pct.to_f
+                when 0;      "zero"
+                when 0...30; "low"
+                when 0...60; "mid"
+                when 0...99; "high"
+                else         "full"
+                end
+
+              tag :td, :class => "graph" do
+                if pct
+                  tag :table, :align => "right", :class => "graph #{style}" do
+                    tag :tr do
+                      covered_width = (pct/2.0).round
+                      tag :td, :class => "covered", :width => covered_width
+                      tag :td, :class => "uncovered", :width => (50 - covered_width)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        else
+          tag :span, -1, :style => "display:none"
+        end
+      end
+    end
+
+  end
+end

data/lib/piggly/reporter/procedure.rb

@@ -0,0 +1,129 @@
+module Piggly
+  module Reporter
+
+    class Procedure < Base
+
+      def initialize(config, profile)
+        @config, @profile = config, profile
+      end
+
+      def report(procedure)
+        io = File.open(report_path(procedure.source_path(@config), ".html"), "w")
+
+        begin
+          compiler = Compiler::CoverageReport.new(@config)
+          data     = compiler.compile(procedure, @profile)
+
+          html(io) do
+            tag :html, :xmlns => "http://www.w3.org/1999/xhtml" do
+              tag :head do
+                tag :title, "Code Coverage: #{procedure.name}"
+                tag :meta, :charset => "utf-8"
+                tag :link, :rel => "stylesheet", :type => "text/css", :href => "piggly.css"
+                tag :script, "<!-- -->", :type => "text/javascript", :src => "highlight.js"
+              end
+
+              tag :body do
+                tag :div, :class => "header" do
+                  aggregate(procedure.name, @profile.summary(procedure))
+                end
+
+                tag :div, :class => "container" do
+                  tag :div, :class => "listing" do
+                    tag :table do
+                      tag :tr do
+                        tag :td, "&nbsp;", :class => "signature"
+                        tag :td, signature(procedure), :class => "signature"
+                      end
+
+                      tag :tr do
+                        tag :td, data[:lines].to_a.map{|n| %[<a href="#L#{n}" id="L#{n}">#{n}</a>] }.join("\n"), :class => "lines"
+                        tag :td, data[:html], :class => "code"
+                      end
+                    end
+                  end
+
+                  toc(@profile[procedure])
+                end
+
+                tag :a, "Return to index", :href => "index.html", :class => "return"
+
+                timestamp
+
+              end
+            end
+          end
+        ensure
+          io.close
+        end
+      end
+
+    private
+
+      def signature(procedure)
+        keyword = procedure.prokind == "p" ? "procedure" : "function"
+        string = "<span class='tK'>create function</span> <b><span class='tI'>#{procedure.name}</span></b>"
+
+        if procedure.arg_names.size <= 1
+          string   << " ( "
+          separator = ", "
+          spacer    = " "
+        else
+          string   << "\n\t( "
+          separator = ",\n\t  "
+          spacer    = "\t"
+        end
+
+        arguments = procedure.arg_types.zip(procedure.arg_modes, procedure.arg_names).map do |atype, amode, aname|
+          amode &&= "<span class='tK'>#{amode.downcase}</span>#{spacer}"
+          aname &&= "<span class='tI'>#{aname}</span>#{spacer}"
+          "#{amode}#{aname}<span class='tD'>#{atype}</span>"
+        end.join(separator)
+
+        string << arguments << " )"
+
+        if procedure.prokind != "p"
+          string << "\n<span class='tK'>returns#{procedure.setof ? ' setof' : ''}</span>"
+
+          if procedure.type.table?
+            fields = procedure.type.types.zip(procedure.type.names).map do |rtype, rname|
+              rname = "<span class='tI'>#{rname}</span>\t"
+              rtype = "<span class='tD'>#{rtype}</span>"
+              "#{rname}#{rtype}"
+            end.join(",\n\t")
+
+            string << " <span class='tK'>table</span> (\n\t" << fields << " )"
+          else
+            string << " <span class='tD'>#{procedure.type.shorten}</span>"
+          end
+        end
+
+        string << "\n  <span class='tK'>language #{procedure.language}</span>"
+        string << "\n  <span class='tK'>security definer</span>" if procedure.secdef
+        string << "\n  <span class='tK'>strict</span>" if procedure.strict
+        string << "\n  <span class='tK'>#{procedure.volatility.downcase}</span>" if procedure.prokind != "p"
+
+        string
+      end
+
+      def toc(tags)
+        todo = tags.reject{|t| t.complete? }
+
+        tag :div, :class => 'toc' do
+          tag :strong, 'Notes'
+
+          tag :ol do
+            todo.each do |t|
+              tag(:li, :class => t.type) do
+                tag :a, t.description, :href => "#T#{t.id}",
+                  :onMouseOver => "highlight('T#{t.id}')"
+              end
+            end
+          end unless todo.empty?
+        end
+      end
+
+    end
+
+  end
+end

data/lib/piggly/reporter/resources/highlight.js

@@ -0,0 +1,38 @@
+
+var lastId = null;
+var lastBg = null;
+
+function highlight(id) {
+  var el = document.getElementById(id);
+  if (el) {
+    if (lastId)
+      unhighlight(lastId, lastBg);
+
+    lastId = id;
+    lastBg = el.style.backgroundColor;
+
+    el.style.backgroundColor = 'yellow';
+  }
+}
+
+function unhighlight(id, bg) {
+  var el = document.getElementById(id);
+  if (el) { el.style.backgroundColor = bg; }
+}
+
+document.addEventListener('DOMContentLoaded', function() {
+  var toc = document.getElementsByClassName('toc');
+  var lis = document.getElementsByClassName('listing');
+  if (toc.length != 1 || lis.length != 1)
+    return;
+
+  window.onscroll = function() {
+    if (lis[0].getBoundingClientRect().y <= 0) {
+      toc[0].classList.add('toc-fixed');
+      lis[0].classList.add('listing-fixed');
+    } else {
+      toc[0].classList.remove('toc-fixed');
+      lis[0].classList.remove('listing-fixed');
+    }
+  }
+});