cucumber-blanket 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1ced4349e3ba6ee92c994e022909cfc77c37005
-  data.tar.gz: a450503278a67cf67af97d75c5ddd14907a59d82
+  metadata.gz: 6c49a4739f76a49ef5c3f52c586ca8b541cfe1bb
+  data.tar.gz: f53fc13a0162903bf59b0097ee937853502d57bc
 SHA512:
-  metadata.gz: 97a967c71d181734ff136f1ce12258877a6e205266f16b19b3850b5ef0ba39ceadb05219528d8878341928b1c9a795f5b0e5ebe07911aa9e361926ff450578d1
-  data.tar.gz: 76f9519cb0b95bb305dbf4c61efaa82bfb3c96a931832ca870f117cccb604a77fb4683cbf5b5ea772c58a5c647e95f60f6b5099f42a53099692adf1d8085b3b0
+  metadata.gz: adb28a1c84ead4a01b2984fb94eccb9c8ae305945a97560c640155044bb919b35e1154987d3186587ca6094491c881b4612c5918f993068e597b441e7bb7ba59
+  data.tar.gz: 9be8b18b4cea7b819104e118b844ab6638e856268ebc5c88df18287051035913c273af620603fa430bd8e0573cf22636110e135f1c68b95dcc674c9ada8187a1

data/README.md

@@ -96,22 +96,16 @@ at_exit do
 end
 ```
 
-### Options
+### Write HTML Report
 
-You can adjust the wait times used to allow blanket.js to work, you should adjust
-this if you are getting an error like this:
+After you've captured some coverage data, you can create an HTML report
+like so:
 
+```ruby
+Cucumber::Blanket.write_html_report File.join(File.dirname(__FILE__), '../../coverage.html')
 ```
-unknown error: You must call blanket.setupCoverage() first.
-  (Session info: chrome=31.0.1650.63)
-  (Driver info: chromedriver=2.6.232908,platform=Mac OS X 10.9.1 x86_64) (Selenium::WebDriver::Error::UnknownError)
-```
-
-When you're extracting from the page, you can adjust the defaults (they are set to half-second) -- just keep in mind that if you set one you must set the other too.
 
-```
-Cucumber::Blanket.extract_from page, setup_wait:1, extract_wait:1 # increased each by a half-second
-```
+I like to put this in `after_exit` in my Cucumber `hooks.rb` file
 
 ## Dev Notes
 

data/cucumber-blanket.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "haml"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/javascript/cucumber-blanket.js

@@ -1,4 +1,10 @@
 (function (){
+  window.CUCUMBER_BLANKET = {
+    files: {},
+    sources: {},
+    done: false,
+    is_setup: false
+  };
   /* ADAPTER
    *
    * This blanket.js adapter is designed to autostart coverage
@@ -15,12 +21,7 @@
     callback: function() {
       blanket.setupCoverage();
       blanket.onTestStart();
-      window.CUCUMBER_BLANKET = {
-        files: {},
-        sources: {},
-        done: false,
-        is_setup: true
-      };
+      window.CUCUMBER_BLANKET.is_setup = true;
     }
   });
 

data/lib/cucumber/blanket.rb

@@ -1,5 +1,6 @@
 require "cucumber/blanket/version"
 require "cucumber/blanket/coverage_data"
+require "cucumber/blanket/report_generator"
 
 module Cucumber
   module Blanket
@@ -24,22 +25,22 @@ module Cucumber
       #    unknown error: You must call blanket.setupCoverage() first.
       #       (Session info: chrome=31.0.1650.63)
       #       (Driver info: chromedriver=2.6.232908,platform=Mac OS X 10.9.1 x86_64) (Selenium::WebDriver::Error::UnknownError)
-      def extract_from page, opts={setup_wait: 0.5, extract_wait: 0.5}
+      def extract_from page
         @page = page
-        sleep(opts[:setup_wait]) until coverage_is_setup?
+        sleep(0.2) until coverage_is_setup?
         page.evaluate_script("blanket.onTestsDone();")
-        sleep(opts[:extract_wait]) until data_ready?
+        sleep(0.2) until data_ready?
         page_data = page.evaluate_script("window.CUCUMBER_BLANKET")
         @@coverage_data.accrue! page_data
         return page_data
       end
 
       def coverage_is_setup?
-        @page.evaluate_script("window.CUCUMBER_BLANKET.is_setup")
+        @page.evaluate_script("window.CUCUMBER_BLANKET.is_setup") rescue false
       end
 
       def data_ready?
-        @page.evaluate_script("window.CUCUMBER_BLANKET.done")
+        @page.evaluate_script("window.CUCUMBER_BLANKET.done") rescue false
       end
 
       def percent
@@ -59,6 +60,13 @@ module Cucumber
           return 0.0
         end
       end
+
+      def write_html_report path
+        generator = ReportGenerator.new(:html, self)
+        File.open(path, 'w') do |file|
+          file.write(generator.render)
+        end
+      end
     end
   end
 end

data/lib/cucumber/blanket/coverage_data.rb

@@ -23,6 +23,22 @@ module Cucumber
         self.data['sources']
       end
 
+      def percent_covered script_url
+        total_lines = 0
+        covered_lines = 0
+        self.files[script_url].compact.each do |cov_stat|
+          if cov_stat > 0
+            covered_lines += 1
+          end
+          total_lines += 1
+        end
+        if total_lines > 0
+          return ((covered_lines.to_f / total_lines)*100).round(2)
+        else
+          return 0.0
+        end
+      end
+
       def accrue! page_data
         if @data.nil?
           @data = page_data

data/lib/cucumber/blanket/report_generator.rb

@@ -0,0 +1,23 @@
+require 'haml'
+module Cucumber
+  module Blanket
+    class ReportGenerator
+      TEMPLATE_DIR = File.join(File.dirname(__FILE__), '../../../templates')
+      
+      def initialize(mode, coverage_data)
+        case mode
+        when :html
+          template = File.join(TEMPLATE_DIR, 'html_report.html.haml')
+          @engine = Haml::Engine.new(File.read(template))
+        else
+          raise "Unsupported report #{mode}"
+        end
+        @data = coverage_data
+      end
+
+      def render
+        @engine.render(self)
+      end
+    end
+  end
+end

data/lib/cucumber/blanket/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module Blanket
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/lib/cucumber/blanket/coverage_data_spec.rb

@@ -57,4 +57,11 @@ describe Cucumber::Blanket::CoverageData do
       Cucumber::Blanket.sources.should eq covdata.sources
     end
   end
+
+  describe "#percent_covered" do
+    it "returns the percent covered for a given script" do
+      res = covdata.percent_covered covdata.files.keys[1]
+      res.should eq 60.0
+    end
+  end
 end

data/spec/lib/cucumber/blanket_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 describe Cucumber::Blanket do
 
+  let(:page) { FakePage.new }
+  before(:each) do
+    subject.reset!
+    subject.extract_from(page)
+  end
+
   describe "#files" do
     it "is a shortcut for coverage_data#files" do
       subject.files.should eq subject.coverage_data.files
@@ -15,10 +21,8 @@ describe Cucumber::Blanket do
   end
 
   describe "#extract_from" do
-    let(:page) { FakePage.new }
     context "Selenium-returned blanket.js coverage data structure characteristics" do
       let(:cov) do
-        subject.extract_from(page)
         subject.coverage_data
       end
       specify { cov.should have_key 'files' }
@@ -35,15 +39,25 @@ describe Cucumber::Blanket do
   end
 
   describe "#percent" do
-    before(:each) { subject.reset! }
     it "returns total percent coverage of known lines of code as float" do
-      subject.extract_from(FakePage.new)
       subject.percent.should eq 75.0
     end
     context "no data harvested yet" do
       it "returns zero" do
+        subject.reset!
         subject.percent.should eq 0.0
       end
     end
   end
+
+  describe "#write_html_report" do
+    let(:path) { '/tmp/cucumber-blanket-report.html' }
+    before { FileUtils.rm(path) if File.exists?(path) }
+
+    it "generates an HTML file at the desired location" do
+      subject.write_html_report path
+      File.exists?(path).should be_true
+      system("open #{path}") if ENV['showreport']
+    end
+  end
 end

data/templates/html_report.html.haml

@@ -0,0 +1,57 @@
+!!!
+%html
+  %head
+    %title cucumber-blanket coverage report
+    :css
+      pre {
+        margin:0;
+      }
+      .ignored {
+      }
+      .missed {
+        background-color: #f74552;
+      }
+      .covered {
+        background-color: #72f779;
+      }
+
+    :javascript
+      function toggleScriptContentDisplay(a) {
+        var contents = a.parentElement.childNodes[3];
+        if (contents.style.display === "none") {
+          contents.style.display = "block";
+        } else {
+          contents.style.display = "none";
+        }
+      }
+
+      document.addEventListener('DOMContentLoaded', function () {
+        scripts = document.querySelectorAll('a.script_url');
+        for (var i = 0, l = scripts.length; i < l; i ++) {
+          var script = scripts[i];
+          script.onclick = function() {
+            toggleScriptContentDisplay(this);
+            return false;
+          };
+        }
+      });
+
+
+  %body
+    %table.ui.table.segment
+      %thead
+        %tr
+          %th Script
+          %th Coverage #{@data.percent}%
+      %tbody
+        - @data.files.each do |script_url, covdata|
+          - lines = @data.sources[script_url]
+          %tr
+            %td
+              %a.script_url{:href=>"#"}= script_url
+              .contents{style:"display:none"}
+                - lines.each_with_index do |line, line_no|
+                  - cov = covdata[line_no]
+                  %pre{:class=>(cov.nil? ? "ignored" : (cov == 0 ? 'missed' : 'covered'))}
+                    = line.gsub(' ', '&nbsp;')
+            %td #{@data.percent_covered(script_url)} %

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-blanket
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keyvan Fatehi
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,11 +113,13 @@ files:
 - javascript/cucumber-blanket.js
 - lib/cucumber/blanket.rb
 - lib/cucumber/blanket/coverage_data.rb
+- lib/cucumber/blanket/report_generator.rb
 - lib/cucumber/blanket/version.rb
 - spec/fixtures/simple.json
 - spec/lib/cucumber/blanket/coverage_data_spec.rb
 - spec/lib/cucumber/blanket_spec.rb
 - spec/spec_helper.rb
+- templates/html_report.html.haml
 homepage: https://github.com/keyvanfatehi/cucumber-blanket
 licenses:
 - MIT
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Extract Blanket.js code coverage data from within a Ruby Cucumber environment