metric_fu 4.8.0 → 4.9.0

data/lib/metric_fu/reporting/templates/javascripts/highcharts_graph.js

@@ -0,0 +1,38 @@
+createGraphElement("div");
+
+if(document.getElementById('graph')) {
+  var chart = new Highcharts.Chart({
+    chart: {
+      animation: false,
+      renderTo: 'graph'
+    },
+    legend: {
+      align: 'center',
+      verticalAlign: 'top',
+      y: 25
+    },
+    plotOptions: {
+      line: {
+        animation: false,
+        lineWidth: 3,
+        marker: {
+          radius: 6
+        },
+        pointPlacement: 'on'
+      }
+    },
+    title: {
+      text: graph_title
+    },
+    xAxis: {
+      categories: graph_labels,
+      tickmarkPlacement: 'on'
+    },
+    yAxis: {
+      maxPadding: 0,
+      min: 0,
+      minPadding: 0
+    },
+    series: graph_series
+  });
+}

data/lib/metric_fu/reporting/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/reporting/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/css/bluff.css

@@ -1,15 +1,15 @@
 .bluff-tooltip {
-	background: #fff;
-	border: 1px solid #d1edf5;
-	padding: 8px 8px 6px;
+  background: #fff;
+  border: 1px solid #d1edf5;
+  padding: 8px 8px 6px;
 }
 .bluff-tooltip .color {
-	display: block;
-	height: 4px;
-	width: 30px;
-	margin: 0 0 4px;
-	overflow: hidden;
+  display: block;
+  height: 4px;
+  width: 30px;
+  margin: 0 0 4px;
+  overflow: hidden;
 }
 .bluff-tooltip .data {
-	font-weight: bold;
-}
+  font-weight: bold;
+}

data/lib/metric_fu/templates/css/integrity.css

@@ -312,6 +312,9 @@ a {
     display: block;
     margin-top: 1em;
     margin-left: 2em; }
+  #content div#graph {
+    width: 100%;
+    height: 600px; }
 
 a.success {
   color: #bbf8aa; }

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

@@ -1,10 +1,9 @@
 <html>
   <head>
     <style>
-    <%=  inline_css('css/syntax.css') %>
-    <%=  inline_css('css/bluff.css') if MetricFu.configuration.graph_engine == :bluff %>
-    <%=  inline_css('css/rcov.css') if @metrics.has_key?(:rcov) %>
+      <%=  inline_css('css/syntax.css') %>
     </style>
+    <title>Analyzed File Report</title>
   </head>
   <body>
     <table cellpadding='0' cellspacing='0' class='ruby'>
@@ -27,6 +26,6 @@
           </td>
          </tr>
          <% end %>
-    <table>
+    </table>
   </body>
 </html>

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = '4.8.0'
+  VERSION = '4.9.0'
 end

data/metric_fu.gemspec

@@ -64,5 +64,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency   'test_construct'
   # ensure we have a JSON parser
   s.add_development_dependency   'json'
+  s.add_development_dependency   'simplecov'
 
 end

data/spec/fixtures/coverage.rb

@@ -0,0 +1,13 @@
+class SomeClass
+  def method_1
+    1+1
+  end
+
+  def method_2 ( value )
+    value * value
+  end
+
+  def method_3
+    "über"
+  end
+end

data/spec/fixtures/exit0.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+which ruby
+exit 0

data/spec/fixtures/exit1.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+which ruby
+exit 1

data/spec/metric_fu/formatter/html_spec.rb

@@ -67,7 +67,7 @@ describe MetricFu::Formatter::HTML do
     it "copies common javascripts to the output directory" do
       expect {
       MetricFu::Formatter::HTML.new.finish
-      }.to create_file("#{directory('output_directory')}/bluff*.js")
+      }.to create_file("#{directory('output_directory')}/highcharts*.js")
     end
 
     it "creates graphs for appropriate metrics" do
@@ -118,7 +118,7 @@ describe MetricFu::Formatter::HTML do
     it "copies common javascripts to the custom output directory" do
       expect {
       MetricFu::Formatter::HTML.new(output: @output).finish
-      }.to create_file("#{directory('base_directory')}/#{@output}/bluff*.js")
+      }.to create_file("#{directory('base_directory')}/#{@output}/highcharts*.js")
     end
 
     it "creates graphs for appropriate metrics in the custom output directory " do

data/spec/metric_fu/metrics/rcov/simplecov_formatter_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'simplecov'
+require 'metric_fu/metrics/rcov/simplecov_formatter'
+
+describe SimpleCov::Formatter::MetricFu do
+  before do
+    @rcov_file =  subject.coverage_file_path
+    File.delete( @rcov_file ) if File.exists?( @rcov_file )
+
+    @result = SimpleCov::Result.new(
+      {
+       FIXTURE.fixtures_path.join('coverage.rb').expand_path.to_s =>
+        [1,1,1,1,nil,1,0,1,1,nil,0,1,1]
+      }
+    )
+
+    # Set to default encoding
+    Encoding.default_internal = nil if defined?(Encoding)
+  end
+
+  it "test_format" do
+    SimpleCov::Formatter::MetricFu.new.format( @result )
+
+    expect(File.exists?( @rcov_file )).to be_truthy
+  end
+
+  it "test_encoding" do
+    # This is done in many rails environments
+    Encoding.default_internal = 'UTF-8' if defined?(Encoding)
+
+    SimpleCov::Formatter::MetricFu.new.format( @result )
+  end
+
+  it "test_create_content" do
+    content = SimpleCov::Formatter::MetricFu::FormatLikeRCov.new(@result).format
+    test = "\="*80
+
+    expect(content).to match(/#{test}/)
+    expect(content).to match(/!!     value \* value/)
+  end
+end

data/spec/spec_helper.rb

@@ -1,27 +1,26 @@
-require 'rspec/autorun'
-
+# add lib to the load path just like rubygems does
+$:.unshift File.expand_path("../../lib", __FILE__)
 if ENV['COVERAGE']
   require 'simplecov'
   formatters = [SimpleCov::Formatter::HTMLFormatter]
   begin
     puts '[COVERAGE] Running with SimpleCov HTML Formatter'
-    require 'simplecov-rcov-text'
-    formatters << SimpleCov::Formatter::RcovTextFormatter
-    puts '[COVERAGE] Running with SimpleCov Rcov Formatter'
+    require 'metric_fu/metrics/rcov/simplecov_formatter'
+    formatters << SimpleCov::Formatter::MetricFu
+    puts '[COVERAGE] Running with SimpleCov MetricFu Formatter'
   rescue LoadError
-    puts '[COVERAGE] SimpleCov Rcov formatter could not be loaded'
+    puts '[COVERAGE] SimpleCov MetricFu formatter could not be loaded'
   end
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[ *formatters ]
   SimpleCov.start
 end
 
+require 'rspec/autorun'
 require 'date'
 require 'test_construct'
 require 'json'
 require 'pry-nav'
 
-# add lib to the load path just like rubygems does
-$:.unshift File.expand_path("../../lib", __FILE__)
 require 'metric_fu'
 include MetricFu
 def mf_log(msg); mf_debug(msg); end

data/spec/support/usage_test.rb

@@ -0,0 +1,134 @@
+# usage_test = UsageTest.new
+# usage_test.test_files(EXAMPLE_FILES)
+
+# puts "SUCCESS!"
+# Process.exit! 0
+require 'metric_fu/logging/mf_debugger'
+require 'open3'
+class UsageTest
+  def initialize
+    @markdown = Redcarpet::Markdown.new(HTMLRenderAndVerifyCodeBlocks, :fenced_code_blocks => true)
+  end
+
+  def test_files(paths)
+    in_test_directory do
+      Array(paths).each do |path|
+        puts "Testing #{path}"
+        @markdown.render(File.read(path))
+        puts
+      end
+    end
+    puts "SUCCESS!"
+    Process.exit! 0
+  end
+
+  private
+
+  def in_test_directory
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) {
+        `git init; touch README; git add README; git commit -m 'first'`
+        yield
+      }
+    end
+  end
+end
+SnippetRunner = Struct.new(:code, :language) do
+  include MfDebugger
+  SystemCommandError = Class.new(StandardError)
+  TestResult = Struct.new(:success, :captured_output)
+
+  def test!
+    time = Time.now
+    test_result = run_code
+    mf_debug "#{Time.now - time} seconds"
+    if test_result.success
+      print '.'
+    else
+      puts 'x'
+      puts "Red :( language: #{language}, code #{code}, #{test_result.captured_output}"
+      Process.exit! 1
+    end
+  end
+
+  def run_code(test_result = TestResult.new(:no_result,''))
+    test_result.captured_output = case language
+                                  when 'ruby' then eval_ruby
+                                  when 'sh'   then run_system_command
+                                  else mf_debug "Cannot test language: #{language.inspect}"
+                                  end
+    test_result.success = true
+    test_result
+  rescue StandardError => run_error
+    test_result.captured_output = exception_message(run_error)
+    test_result.success =  false
+    test_result
+  rescue SystemExit => system_exit
+    puts "I am a system exit"
+    test_result.captured_output = exception_message(system_exit)
+    test_result.success = system_exit.success?
+    test_result
+  end
+
+  def eval_ruby(fail_on_empty=false)
+    capture_output(fail_on_empty) do
+      instance_eval(code)
+    end
+  end
+
+  def run_system_command(fail_on_empty=true)
+    out = ''
+    err = ''
+    pid = :not_set
+    exit_status = :not_set
+    Open3.popen3(code) do |stdin, stdout, stderr, wait_thr|
+      out << stdout.read.chomp
+      err << stderr.read.chomp
+      pid = wait_thr.pid
+      exit_status = wait_thr.value
+    end
+    exit_code = exit_status.exitstatus
+    case exit_code
+    when 0  then  "Ran with exit status #{exit_code}"
+    when (1..Float::INFINITY) then fail SystemCommandError.new("Failed with exit status #{exit_code}. #{err}----#{out}")
+    else fail SystemCommandError.new("Execution failed with exit status #{exit_code}. #{err}----#{out}")
+    end
+
+  end
+
+  def exception_message(e)
+    "#{e.class}\t#{e.message}"
+  end
+
+  def capture_output(fail_on_empty)
+    exception = nil
+    stderr = :not_set
+    stdout = :not_set
+    MfDebugger::Logger.capture_output(STDOUT) do
+     stdout =
+     MfDebugger::Logger.capture_output(STDERR) do
+       begin
+         stderr = yield
+       rescue Exception => e
+         exception  = e
+       end
+     end
+    end
+    if [nil, '', :not_set].none? {|c| c == stderr }
+      mf_debug "Captured STDERR"
+      stderr
+    elsif [nil, '', :not_set].none? {|c| c == stdout }
+      mf_debug "Captured STDOUT"
+      stdout
+    elsif exception
+      mf_debug "Captured Exception"
+      raise exception
+    else
+      mf_debug "Captured Nothing"
+      if fail_on_empty
+        fail SystemCommandError.new 'No output generated or exception caught'
+      end
+    end
+  end
+
+end

data/spec/usage_test_spec.rb

@@ -0,0 +1,69 @@
+describe 'usage test' do
+  ROOT_PATH    = File.expand_path("..", File.dirname(__FILE__))
+  require File.join(ROOT_PATH, 'spec/support/usage_test')
+
+  context 'evaluating ruby code' do
+    specify 'succeeds when the code runs without errors' do
+      code = "1 + 1"
+      test_result = SnippetRunner.new(code, 'ruby').run_code
+      expect(test_result.captured_output).to eq(2)
+      expect(test_result.success).to eq(true)
+    end
+    specify 'fails when the code raises a standard error' do
+      code = "fail NameError.new('no name')"
+      test_result = SnippetRunner.new(code, 'ruby').run_code
+      expect(test_result.captured_output).to match('NameError')
+      expect(test_result.captured_output).to match('no name')
+      expect(test_result.success).to eq(false)
+    end
+    specify 'succeeds when the code exits with a zero exit status' do
+      code = "puts 1 + 1; exit 0"
+      test_result = SnippetRunner.new(code, 'ruby').run_code
+      expect(test_result.captured_output).to match('SystemExit')
+      expect(test_result.success).to eq(true)
+    end
+    specify 'fails when the code exits with a non-zero exit status' do
+      code = "puts 1 + 1; exit 1"
+      test_result = SnippetRunner.new(code, 'ruby').run_code
+      expect(test_result.captured_output).to match('SystemExit')
+      expect(test_result.success).to eq(false)
+    end
+
+  end
+  context 'evaluating shell commands' do
+    specify 'succeeds when the command runs without errors' do
+      code = "which ruby"
+      test_result = SnippetRunner.new(code, 'sh').run_code
+      expect(test_result.captured_output).to match("exit status 0")
+      expect(test_result.success).to eq(true)
+    end
+    specify 'fails when the command runs with an error' do
+      code = "sandwhich_fu ruby"
+      test_result = SnippetRunner.new(code, 'sh').run_code
+      expect(test_result.captured_output).to match(failed_command_error)
+      expect(test_result.success).to eq(false)
+    end
+    specify 'succeeds when the code exits with a zero exit status' do
+      code = "sh #{fixtures_path.join('exit0.sh').to_path}"
+      test_result = SnippetRunner.new(code, 'sh').run_code
+      expect(test_result.captured_output).to match("exit status 0")
+      expect(test_result.success).to eq(true)
+    end
+    specify 'fails when the code exits with a non-zero exit status' do
+      code = "sh #{fixtures_path.join('exit1.sh').to_path}"
+      test_result = SnippetRunner.new(code, 'sh').run_code
+      expect(test_result.captured_output).to match("exit status 1")
+      expect(test_result.success).to eq(false)
+    end
+
+  end
+
+  def failed_command_error
+    defined?(JRUBY_VERSION) ? 'IOError' : 'Errno::ENOENT'
+  end
+
+  def fixtures_path
+    fixtures_dir = File.join(File.expand_path('..', File.dirname(__FILE__)), 'spec', 'fixtures')
+    Pathname(fixtures_dir)
+  end
+end