fastruby-metric_fu 5.0.0

data/lib/metric_fu/templates/javascripts/js-class.js

@@ -0,0 +1 @@
+JS={extend:function(a,b){b=b||{};for(var c in b){if(a[c]===b[c])continue;a[c]=b[c]}return a},makeFunction:function(){return function(){return this.initialize?(this.initialize.apply(this,arguments)||this):this}},makeBridge:function(a){var b=function(){};b.prototype=a.prototype;return new b},bind:function(){var a=JS.array(arguments),b=a.shift(),c=a.shift()||null;return function(){return b.apply(c,a.concat(JS.array(arguments)))}},callsSuper:function(a){return a.SUPER===undefined?a.SUPER=/\bcallSuper\b/.test(a.toString()):a.SUPER},mask:function(a){var b=a.toString().replace(/callSuper/g,'super');a.toString=function(){return b};return a},array:function(a){if(!a)return[];if(a.toArray)return a.toArray();var b=a.length,c=[];while(b--)c[b]=a[b];return c},indexOf:function(a,b){for(var c=0,d=a.length;c<d;c++){if(a[c]===b)return c}return-1},isFn:function(a){return a instanceof Function},isType:function(a,b){if(!a||!b)return false;return(b instanceof Function&&a instanceof b)||(typeof b==='string'&&typeof a===b)||(a.isA&&a.isA(b))},ignore:function(a,b){return/^(include|extend)$/.test(a)&&typeof b==='object'}};JS.Module=JS.makeFunction();JS.extend(JS.Module.prototype,{END_WITHOUT_DOT:/([^\.])$/,initialize:function(a,b,c){this.__mod__=this;this.__inc__=[];this.__fns__={};this.__dep__=[];this.__mct__={};if(typeof a==='string'){this.__nom__=this.displayName=a}else{this.__nom__=this.displayName='';c=b;b=a}c=c||{};this.__res__=c._1||null;if(b)this.include(b,false);if(JS.Module.__chainq__)JS.Module.__chainq__.push(this)},setName:function(a){this.__nom__=this.displayName=a||'';for(var b in this.__mod__.__fns__)this.__name__(b);if(a&&this.__meta__)this.__meta__.setName(a+'.')},__name__:function(a){if(!this.__nom__)return;var b=this.__mod__.__fns__[a]||{};a=this.__nom__.replace(this.END_WITHOUT_DOT,'$1#')+a;if(JS.isFn(b.setName))return b.setName(a);if(JS.isFn(b))b.displayName=a},define:function(a,b,c,d){var f=(d||{})._0||this;this.__fns__[a]=b;this.__name__(a);if(JS.Module._0&&f&&JS.isFn(b))JS.Module._0(a,f);if(c!==false)this.resolve()},instanceMethod:function(a){var b=this.lookup(a).pop();return JS.isFn(b)?b:null},instanceMethods:function(a,b){var c=this.__mod__,b=b||[],d=c.ancestors(),f=d.length,e;for(e in c.__fns__){if(c.__fns__.hasOwnProperty(e)&&JS.isFn(c.__fns__[e])&&JS.indexOf(b,e)===-1)b.push(e)}if(a===false)return b;while(f--)d[f].instanceMethods(false,b);return b},include:function(a,b,c){b=(b!==false);if(!a)return b?this.resolve():this.uncache();c=c||{};if(a.__mod__)a=a.__mod__;var d=a.include,f=a.extend,e=c._4||this,g,h,i,j;if(a.__inc__&&a.__fns__){this.__inc__.push(a);a.__dep__.push(this);if(c._2)a.extended&&a.extended(c._2);else a.included&&a.included(e)}else{if(c._5){for(h in a){if(JS.ignore(h,a[h]))continue;this.define(h,a[h],false,{_0:e||c._2||this})}}else{if(typeof d==='object'||JS.isType(d,JS.Module)){g=[].concat(d);for(i=0,j=g.length;i<j;i++)e.include(g[i],b,c)}if(typeof f==='object'||JS.isType(f,JS.Module)){g=[].concat(f);for(i=0,j=g.length;i<j;i++)e.extend(g[i],false);e.extend()}c._5=true;return e.include(a,b,c)}}b?this.resolve():this.uncache()},includes:function(a){var b=this.__mod__,c=b.__inc__.length;if(Object===a||b===a||b.__res__===a.prototype)return true;while(c--){if(b.__inc__[c].includes(a))return true}return false},match:function(a){return a.isA&&a.isA(this)},ancestors:function(a){var b=this.__mod__,c=(a===undefined),d=(b.__res__||{}).klass,f=(d&&b.__res__===d.prototype)?d:b,e,g;if(c&&b.__anc__)return b.__anc__.slice();a=a||[];for(e=0,g=b.__inc__.length;e<g;e++)b.__inc__[e].ancestors(a);if(JS.indexOf(a,f)===-1)a.push(f);if(c)b.__anc__=a.slice();return a},lookup:function(a){var b=this.__mod__,c=b.__mct__;if(c[a])return c[a].slice();var d=b.ancestors(),f=[],e,g,h;for(e=0,g=d.length;e<g;e++){h=d[e].__mod__.__fns__[a];if(h)f.push(h)}c[a]=f.slice();return f},make:function(a,b){if(!JS.isFn(b)||!JS.callsSuper(b))return b;var c=this;return function(){return c.chain(this,a,arguments)}},chain:JS.mask(function(c,d,f){var e=this.lookup(d),g=e.length-1,h=c.callSuper,i=JS.array(f),j;c.callSuper=function(){var a=arguments.length;while(a--)i[a]=arguments[a];g-=1;var b=e[g].apply(c,i);g+=1;return b};j=e.pop().apply(c,i);h?c.callSuper=h:delete c.callSuper;return j}),resolve:function(a){var b=this.__mod__,a=a||b,c=a.__res__,d,f,e,g;if(a===b){b.uncache(false);d=b.__dep__.length;while(d--)b.__dep__[d].resolve()}if(!c)return;for(d=0,f=b.__inc__.length;d<f;d++)b.__inc__[d].resolve(a);for(e in b.__fns__){g=a.make(e,b.__fns__[e]);if(c[e]!==g)c[e]=g}},uncache:function(a){var b=this.__mod__,c=b.__dep__.length;b.__anc__=null;b.__mct__={};if(a===false)return;while(c--)b.__dep__[c].uncache()}});JS.Class=JS.makeFunction();JS.extend(JS.Class.prototype=JS.makeBridge(JS.Module),{initialize:function(a,b,c){if(typeof a==='string'){this.__nom__=this.displayName=a}else{this.__nom__=this.displayName='';c=b;b=a}var d=JS.extend(JS.makeFunction(),this);d.klass=d.constructor=this.klass;if(!JS.isFn(b)){c=b;b=Object}d.inherit(b);d.include(c,false);d.resolve();do{b.inherited&&b.inherited(d)}while(b=b.superclass);return d},inherit:function(a){this.superclass=a;if(this.__eigen__&&a.__eigen__)this.extend(a.__eigen__(),true);this.subclasses=[];(a.subclasses||[]).push(this);var b=this.prototype=JS.makeBridge(a);b.klass=b.constructor=this;this.__mod__=new JS.Module(this.__nom__,{},{_1:this.prototype});this.include(JS.Kernel,false);if(a!==Object)this.include(a.__mod__||new JS.Module(a.prototype,{_1:a.prototype}),false)},include:function(a,b,c){if(!a)return;var d=this.__mod__,c=c||{};c._4=this;return d.include(a,b,c)},define:function(a,b,c,d){var f=this.__mod__;d=d||{};d._0=this;f.define(a,b,c,d)}});JS.Module=new JS.Class('Module',JS.Module.prototype);JS.Class=new JS.Class('Class',JS.Module,JS.Class.prototype);JS.Module.klass=JS.Module.constructor=JS.Class.klass=JS.Class.constructor=JS.Class;JS.extend(JS.Module,{_3:[],__chainq__:[],methodAdded:function(a,b){this._3.push([a,b])},_0:function(a,b){var c=this._3,d=c.length;while(d--)c[d][0].call(c[d][1]||null,a,b)}});JS.Kernel=JS.extend(new JS.Module('Kernel',{__eigen__:function(){if(this.__meta__)return this.__meta__;var a=this.__nom__,b=this.klass.__nom__,c=a||(b?'#<'+b+'>':''),d=this.__meta__=new JS.Module(c?c+'.':'',{},{_1:this});d.include(this.klass.__mod__,false);return d},equals:function(a){return this===a},extend:function(a,b){return this.__eigen__().include(a,b,{_2:this})},hash:function(){return this.__hashcode__=this.__hashcode__||JS.Kernel.getHashCode()},isA:function(a){return this.__eigen__().includes(a)},method:function(a){var b=this,c=b.__mcache__=b.__mcache__||{};if((c[a]||{}).fn===b[a])return c[a].bd;return(c[a]={fn:b[a],bd:JS.bind(b[a],b)}).bd},methods:function(){return this.__eigen__().instanceMethods(true)},tap:function(a,b){a.call(b||null,this);return this}}),{__hashIndex__:0,getHashCode:function(){this.__hashIndex__+=1;return(Math.floor(new Date().getTime()/1000)+this.__hashIndex__).toString(16)}});JS.Module.include(JS.Kernel);JS.extend(JS.Module,JS.Kernel.__fns__);JS.Class.include(JS.Kernel);JS.extend(JS.Class,JS.Kernel.__fns__);JS.Interface=new JS.Class({initialize:function(d){this.test=function(a,b){var c=d.length;while(c--){if(!JS.isFn(a[d[c]]))return b?d[c]:false}return true}},extend:{ensure:function(){var a=JS.array(arguments),b=a.shift(),c,d;while(c=a.shift()){d=c.test(b,true);if(d!==true)throw new Error('object does not implement '+d+'()');}}}});JS.Singleton=new JS.Class({initialize:function(a,b,c){return new(new JS.Class(a,b,c))}});

data/lib/metric_fu/templates/javascripts/standalone-framework.js

@@ -0,0 +1,17 @@
+/*
+ Highcharts JS v3.0.9 (2014-01-15)
+
+ Standalone Highcharts Framework
+
+ License: MIT License
+*/
+var HighchartsAdapter=function(){function o(c){function b(b,a,d){b.removeEventListener(a,d,!1)}function d(b,a,d){d=b.HCProxiedMethods[d.toString()];b.detachEvent("on"+a,d)}function a(a,c){var f=a.HCEvents,i,g,k,j;if(a.removeEventListener)i=b;else if(a.attachEvent)i=d;else return;c?(g={},g[c]=!0):g=f;for(j in g)if(f[j])for(k=f[j].length;k--;)i(a,j,f[j][k])}c.HCExtended||Highcharts.extend(c,{HCExtended:!0,HCEvents:{},bind:function(a,b){var d=this,c=this.HCEvents,g;if(d.addEventListener)d.addEventListener(a,
+b,!1);else if(d.attachEvent){g=function(a){b.call(d,a)};if(!d.HCProxiedMethods)d.HCProxiedMethods={};d.HCProxiedMethods[b.toString()]=g;d.attachEvent("on"+a,g)}c[a]===r&&(c[a]=[]);c[a].push(b)},unbind:function(c,h){var f,i;c?(f=this.HCEvents[c]||[],h?(i=HighchartsAdapter.inArray(h,f),i>-1&&(f.splice(i,1),this.HCEvents[c]=f),this.removeEventListener?b(this,c,h):this.attachEvent&&d(this,c,h)):(a(this,c),this.HCEvents[c]=[])):(a(this),this.HCEvents={})},trigger:function(a,b){var d=this.HCEvents[a]||
+[],c=d.length,g,k,j;k=function(){b.defaultPrevented=!0};for(g=0;g<c;g++){j=d[g];if(b.stopped)break;b.preventDefault=k;b.target=this;if(!b.type)b.type=a;j.call(this,b)===!1&&b.preventDefault()}}});return c}var r,l=document,p=[],m=[],q,n;Math.easeInOutSine=function(c,b,d,a){return-d/2*(Math.cos(Math.PI*c/a)-1)+b};return{init:function(c){if(!l.defaultView)this._getStyle=function(b,d){var a;return b.style[d]?b.style[d]:(d==="opacity"&&(d="filter"),a=b.currentStyle[d.replace(/\-(\w)/g,function(b,a){return a.toUpperCase()})],
+d==="filter"&&(a=a.replace(/alpha\(opacity=([0-9]+)\)/,function(b,a){return a/100})),a===""?1:a)},this.adapterRun=function(b,d){var a={width:"clientWidth",height:"clientHeight"}[d];if(a)return b.style.zoom=1,b[a]-2*parseInt(HighchartsAdapter._getStyle(b,"padding"),10)};if(!Array.prototype.forEach)this.each=function(b,d){for(var a=0,c=b.length;a<c;a++)if(d.call(b[a],b[a],a,b)===!1)return a};if(!Array.prototype.indexOf)this.inArray=function(b,d){var a,c=0;if(d)for(a=d.length;c<a;c++)if(d[c]===b)return c;
+return-1};if(!Array.prototype.filter)this.grep=function(b,d){for(var a=[],c=0,h=b.length;c<h;c++)d(b[c],c)&&a.push(b[c]);return a};n=function(b,c,a){this.options=c;this.elem=b;this.prop=a};n.prototype={update:function(){var b;b=this.paths;var d=this.elem,a=d.element;b&&a?d.attr("d",c.step(b[0],b[1],this.now,this.toD)):d.attr?a&&d.attr(this.prop,this.now):(b={},b[d]=this.now+this.unit,Highcharts.css(d,b));this.options.step&&this.options.step.call(this.elem,this.now,this)},custom:function(b,c,a){var e=
+this,h=function(a){return e.step(a)},f;this.startTime=+new Date;this.start=b;this.end=c;this.unit=a;this.now=this.start;this.pos=this.state=0;h.elem=this.elem;h()&&m.push(h)===1&&(q=setInterval(function(){for(f=0;f<m.length;f++)m[f]()||m.splice(f--,1);m.length||clearInterval(q)},13))},step:function(b){var c=+new Date,a;a=this.options;var e;if(this.elem.stopAnimation)a=!1;else if(b||c>=a.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();b=this.options.curAnim[this.prop]=
+!0;for(e in a.curAnim)a.curAnim[e]!==!0&&(b=!1);b&&a.complete&&a.complete.call(this.elem);a=!1}else e=c-this.startTime,this.state=e/a.duration,this.pos=a.easing(e,0,1,a.duration),this.now=this.start+(this.end-this.start)*this.pos,this.update(),a=!0;return a}};this.animate=function(b,d,a){var e,h="",f,i,g;b.stopAnimation=!1;if(typeof a!=="object"||a===null)e=arguments,a={duration:e[2],easing:e[3],complete:e[4]};if(typeof a.duration!=="number")a.duration=400;a.easing=Math[a.easing]||Math.easeInOutSine;
+a.curAnim=Highcharts.extend({},d);for(g in d)i=new n(b,a,g),f=null,g==="d"?(i.paths=c.init(b,b.d,d.d),i.toD=d.d,e=0,f=1):b.attr?e=b.attr(g):(e=parseFloat(HighchartsAdapter._getStyle(b,g))||0,g!=="opacity"&&(h="px")),f||(f=parseFloat(d[g])),i.custom(e,f,h)}},_getStyle:function(c,b){return window.getComputedStyle(c).getPropertyValue(b)},getScript:function(c,b){var d=l.getElementsByTagName("head")[0],a=l.createElement("script");a.type="text/javascript";a.src=c;a.onload=b;d.appendChild(a)},inArray:function(c,
+b){return b.indexOf?b.indexOf(c):p.indexOf.call(b,c)},adapterRun:function(c,b){return parseInt(HighchartsAdapter._getStyle(c,b),10)},grep:function(c,b){return p.filter.call(c,b)},map:function(c,b){for(var d=[],a=0,e=c.length;a<e;a++)d[a]=b.call(c[a],c[a],a,c);return d},offset:function(c){for(var b=0,d=0;c;)b+=c.offsetLeft,d+=c.offsetTop,c=c.offsetParent;return{left:b,top:d}},addEvent:function(c,b,d){o(c).bind(b,d)},removeEvent:function(c,b,d){o(c).unbind(b,d)},fireEvent:function(c,b,d,a){var e;l.createEvent&&
+(c.dispatchEvent||c.fireEvent)?(e=l.createEvent("Events"),e.initEvent(b,!0,!0),e.target=c,Highcharts.extend(e,d),c.dispatchEvent?c.dispatchEvent(e):c.fireEvent(b,e)):c.HCExtended===!0&&(d=d||{},c.trigger(b,d));d&&d.defaultPrevented&&(a=null);a&&a(d)},washMouseEvent:function(c){return c},stop:function(c){c.stopAnimation=!0},each:function(c,b){return Array.prototype.forEach.call(c,b)}}}();

data/lib/metric_fu/templates/javascripts/utils.js

@@ -0,0 +1,9 @@
+function createGraphElement(elementType) {
+  var graphContainer = document.getElementById("graph_container");
+
+  if(graphContainer) {
+    var graphElement = document.createElement(elementType);
+    graphElement.setAttribute("id", "graph");
+    graphContainer.appendChild(graphElement);
+  }
+}

data/lib/metric_fu/templates/layout.html.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
+    <meta content='en' http-equiv='Content-Language' />
+    <title>metrics</title>
+    <style>
+    <%= inline_css("css/reset.css") %>
+    <%= inline_css("css/buttons.css") %>
+    <%= inline_css("css/integrity.css") %>
+    <%= inline_css("css/default.css") %>
+    <%= inline_css("css/bluff.css") %>
+    </style>
+    <link REL="SHORTCUT ICON" HREF="/favicon.ico">
+    <script language="javascript" src="utils.js" type="text/javascript"></script>
+    <script language="javascript" src="js-class.js" type="text/javascript"></script>
+    <script language="javascript" src="bluff-min.js" type="text/javascript"></script>
+    <script language="javascript" src="excanvas.js" type="text/javascript"></script>
+    <script language="javascript" src="standalone-framework.js" type="text/javascript"></script>
+    <script language="javascript" src="highcharts.js" type="text/javascript"></script>
+  </head>
+  <body>
+    <div id='header'>
+      <h1><a href="/">metrics</a> | <a href="index.html"><%= @name %></a></h1>
+      <address class='watermark'>
+        built with
+        <a href='<%= MetricFu.metric_url %>'><%= MetricFu.metric_name %></a>
+      </address>
+    </div>
+    <div id='content'>
+      <%= @html %>
+    </div>
+
+    <% graph_engine = MetricFu.configuration.graph_engine.to_s %>
+    <script language="javascript" src="<%= graph_engine %>_graph.js" type="text/javascript"></script>
+  </body>
+</html>

data/lib/metric_fu/templates/metrics_template.rb

@@ -0,0 +1,80 @@
+require "fileutils"
+MetricFu.lib_require { "templates/template" }
+MetricFu.lib_require { "templates/report" }
+
+# The MetricsTemplate class is the included template used by the HTML formatter.
+# The only requirement for a template class is that it provides a #write method
+# to actually write out the template.
+module MetricFu
+  class Templates::MetricsTemplate < MetricFu::Template
+    attr_accessor :result, :per_file_data, :formatter, :metrics, :name, :html
+
+    def write
+      self.name = MetricFu.report_name
+      self.metrics = {}
+
+      copy_javascripts
+
+      result.each_pair do |section, contents|
+        write_section(section, contents)
+      end
+
+      write_index
+      write_file_data
+    end
+
+    def html_filename(file)
+      file = Digest::SHA1.hexdigest(file)[0..29]
+      "#{file.gsub(%r{/}, '_')}.html"
+    end
+
+    private
+
+    def copy_javascripts
+      Dir[File.join(template_directory, "javascripts", "*")].each do |f|
+        FileUtils.cp(f, File.join(output_directory, File.basename(f)))
+      end
+    end
+
+    def write_section(section, contents)
+      if template_exists?(section)
+        create_instance_var(section, contents)
+        metrics[section] = contents
+        create_instance_var(:per_file_data, per_file_data)
+        mf_debug "Generating html for section #{section} with #{template(section)} for result #{result.class}"
+        self.html = erbify(section)
+        layout = erbify("layout")
+        fn = output_filename(section)
+        formatter.write_template(layout, fn)
+      else
+        mf_debug "no template for section #{section} with #{template(section)} for result #{result.class}"
+      end
+    end
+
+    def write_index
+      # Instance variables we need should already be created from above
+      if template_exists?("index")
+        self.html = erbify("index")
+        layout = erbify("layout")
+        fn = output_filename("index")
+        formatter.write_template(layout, fn)
+      else
+        mf_debug "no template for section index for result #{result.class}"
+      end
+    end
+
+    def write_file_data
+      per_file_data.each_pair do |file, lines|
+        next if file.to_s.empty?
+        next unless File.file?(file)
+        report = MetricFu::Templates::Report.new(file, lines).render
+
+        formatter.write_template(report, html_filename(file))
+      end
+    end
+
+    def template_directory
+      File.dirname(__FILE__)
+    end
+  end
+end

data/lib/metric_fu/templates/report.html.erb

@@ -0,0 +1,31 @@
+<html>
+  <head>
+    <style>
+      <%=  inline_css('css/syntax.css') %>
+    </style>
+    <title>Analyzed File Report</title>
+  </head>
+  <body>
+    <table cellpadding='0' cellspacing='0' class='ruby'>
+      <% @data.each_with_index do |line, idx| %>
+        <% line_number = (idx + 1).to_s %>
+        <tr>
+          <td valign='top'>
+           <% if @lines.has_key?(line_number) %>
+             <ul>
+               <% @lines[line_number].each do |problem| %>
+                 <li><%= "#{problem[:description]} &raquo; #{problem[:type]}" %></li>
+               <% end %>
+            </ul>
+          <% else %>
+              &nbsp;
+          <% end %>
+          </td>
+          <td valign='top'>
+            <%= line_for_display(line, line_number) %>
+          </td>
+         </tr>
+         <% end %>
+    </table>
+  </body>
+</html>

data/lib/metric_fu/templates/report.rb

@@ -0,0 +1,41 @@
+MetricFu.lib_require { "formatter/syntax" }
+MetricFu.lib_require { "templates/template" }
+
+# Creates an HTML document for a given analyzed file,
+# with scored metrics annotating the relevant line.
+module MetricFu
+  module Templates
+    class Report < MetricFu::Template
+      # @param file [String] the analyzed file to annotate
+      # @param lines [Hash] of line number [String] keyed to an list [[Array] of metrics for that line. Each metric in the list is a hash containing the keys :type => metric_name, :descrption => metric_score
+      # @example file and lines
+      #   file: "lib/metric_fu/gem_version.rb
+      #   lines: {"30"=>[{:type=>:flog, :description=>"Score of 22.43"}], "42"=>[{:type=>:flog, :description=>"Score of 8.64"}]}
+      def initialize(file, lines)
+        @file = file
+        @lines = lines
+        @data = File.open(file, "rb") { |f| f.readlines }
+      end
+
+      def render
+        erbify("report")
+      end
+
+      def convert_ruby_to_html(ruby_text, line_number)
+        MetricFu::Formatter::Syntax.new.highlight(ruby_text, line_number)
+      end
+
+      def line_for_display(line, line_number)
+        if MetricFu::Formatter::Templates.option("syntax_highlighting")
+          line_for_display = convert_ruby_to_html(line, line_number)
+        else
+          "<a name='n#{line_number}' href='n#{line_number}'>#{line_number}</a>#{line}"
+       end
+      end
+
+      def template_directory
+        File.dirname(__FILE__)
+      end
+    end
+  end
+end

data/lib/metric_fu/templates/template.rb

@@ -0,0 +1,244 @@
+require "erb"
+module MetricFu
+  class Template
+    attr_accessor :output_directory
+
+    def output_directory
+      @output_directory || MetricFu::Io::FileSystem.directory("output_directory")
+    end
+
+    # Renders a partial and add optional instance variables to the template
+    # @param name <String> name of partial, omitting leading underscore (_)
+    # @param instance_variables <Hash> of instance variable
+    # names and values to set
+    def render_partial(name, instance_variables = {})
+      create_instance_vars(instance_variables)
+      erbify("_#{name}")
+    end
+
+    private
+
+    # Creates a new erb evaluated result from the passed in section.
+    #
+    # @param section String
+    #   The section name of
+    #
+    # @return String
+    #   The erb evaluated string
+    def erbify(section)
+      template_file = template(section)
+      erb           = erb_template_source(template_file)
+      erb.result(binding)
+    rescue => e
+      message = "Error: #{e.class}; message #{e.message}. "
+      message << "Failed evaluating erb template "
+      message << "for section #{section} and template #{template_file}."
+      raise message
+    end
+
+    def erb_template_source(template_file)
+      erb_doc       = File.read(template_file)
+      erb           = ERB.new(erb_doc)
+      erb.filename  = template_file
+      erb
+    end
+
+    # Copies an instance variable mimicing the name of the section
+    # we are trying to render, with a value equal to the passed in
+    # constant.  Allows the concrete template classes to refer to
+    # that instance variable from their ERB rendering
+    #
+    # @param section String
+    #  The name of the instance variable to create
+    #
+    # @param contents Object
+    #   The value to set as the value of the created instance
+    #   variable
+    def create_instance_var(section, contents)
+      instance_variable_set("@#{section}", contents)
+    end
+
+    def create_instance_vars(variables)
+      variables.each { |variable| create_instance_var(*variable) }
+    end
+
+    # Generates the filename of the template file to load and
+    # evaluate.  In this case, the path to the template directory +
+    # the section name + .html.erb
+    #
+    # @param section String
+    #   A section of the template to render
+    #
+    # @return String
+    #   A file path
+    def template(section)
+      # TODO: each MetricFu::Metric should know about its templates
+      #  This class knows too much about the filesystem structure
+      if MetricFu::Metric.enabled_metrics.map(&:name).include?(section) # expects a symbol
+        metric_template_path(section.to_s)
+      else
+        File.join(template_directory,  section.to_s + ".html.erb")
+      end
+    end
+
+    def metric_template_path(metric)
+      File.join(MetricFu.metrics_dir, metric, "report.html.erb")
+    end
+
+    # Determines whether a template file exists for a given section
+    # of the full template.
+    #
+    # @param section String
+    #   The section of the template to check against
+    #
+    # @return Boolean
+    #   Does a template file exist for this section or not?
+    def template_exists?(section)
+      File.exist?(template(section))
+    end
+
+    # Returns the filename that the template will render into for
+    # a given section.  In this case, the section name + '.html'
+    #
+    # @param section String
+    #   A section of the template to render
+    #
+    # @return String
+    #   The output filename
+    def output_filename(section)
+      section.to_s + ".html"
+    end
+
+    # Returns the contents of a given css file in order to
+    # render it inline into a template.
+    #
+    # @param css String
+    #   The name of a css file to open
+    #
+    # @return String
+    #   The contents of the css file
+    def inline_css(css)
+      css_file = File.join(MetricFu.lib_dir, "templates", css)
+      MetricFu::Utility.binread(css_file)
+    end
+
+    # Provides a link to open a file through the textmate protocol
+    # on Darwin, or otherwise, a simple file link.
+    #
+    # @param name String
+    #
+    # @param line Integer
+    #   The line number to link to, if textmate is available.  Defaults
+    #   to nil
+    #
+    # @return String
+    #   An anchor link to a textmate reference or a file reference
+    def link_to_filename(name, line = nil, link_content = nil)
+      href = file_url(name, line)
+      link_text = link_content(name, line, link_content)
+      "<a href='#{href}'>#{link_text}</a>"
+    end
+
+    def round_to_tenths(decimal)
+      decimal = 0.0 if decimal.to_s.eql?("NaN")
+      (decimal * 10).round / 10.0
+    end
+
+    def link_content(name, line = nil, link_content = nil) # :nodoc:
+      if link_content
+        link_content
+      elsif line
+        "#{name}:#{line}"
+      else
+        name
+      end
+    end
+
+    def display_location(location)
+      class_name, method_name = location.fetch("class_name"), location.fetch("method_name")
+      str = ""
+      str += link_to_filename(location.fetch("file_name"), location.fetch("line_number"))
+      str += " : " if method_name || class_name
+      if method_name
+        str += "#{method_name}"
+      else
+        # TODO HOTSPOTS BUG ONLY exists on move over to metric_fu
+        if class_name.is_a?(String)
+          str += "#{class_name}"
+        end
+      end
+      str
+    end
+
+    def file_url(name, line) # :nodoc:
+      return "" unless name
+      filename = complete_file_path(name)
+
+      if render_as_txmt_protocol?
+        "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
+      else
+        link_prefix = MetricFu.configuration.templates_option("link_prefix")
+        if link_prefix == MetricFu::Templates::Configuration::FILE_PREFIX
+          path = filename
+        else
+          path = name.gsub(/:.*$/, "")
+        end
+        "#{link_prefix}/#{path}"
+      end
+    end
+
+    def complete_file_path(filename)
+      File.expand_path(filename)
+    end
+
+    def render_as_txmt_protocol? # :nodoc:
+      if MetricFu.configuration.osx?
+        !MetricFu.configuration.templates_option("darwin_txmt_protocol_no_thanks")
+      else
+        false
+      end
+    end
+
+    # Provides a brain dead way to cycle between two values during
+    # an iteration of some sort.  Pass in the first_value, the second_value,
+    # and the cardinality of the iteration.
+    #
+    # @param first_value Object
+    #
+    # @param second_value Object
+    #
+    # @param iteration Integer
+    #   The number of times through the iteration.
+    #
+    # @return Object
+    #   The first_value if iteration is even.  The second_value if
+    #   iteration is odd.
+    def cycle(first_value, second_value, iteration)
+      return first_value if iteration % 2 == 0
+      second_value
+    end
+
+    # available in the erb template
+    # as it's processed in the context of
+    # the binding of this class
+    def metric_links
+      @metrics.keys.map { |metric| metric_link(metric.to_s) }
+    end
+
+    def metric_link(metric)
+      <<-LINK
+      <a href="#{metric}.html">
+        #{snake_case_to_title_case(metric)}
+      </a>
+      LINK
+    end
+
+    def snake_case_to_title_case(string)
+      string.split("_").collect { |word| word[0] = word[0..0].upcase; word }.join(" ")
+    end
+
+    def template_directory
+      fail "subclasses must specify template_directory. Usually File.dirname(__FILE__)"
+    end
+  end
+end