cucumber-blanket 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e23857ccf05090b02850a9edb41cafdd17ac781d
-  data.tar.gz: cbccd47528e369462f58c422e0b974392e9359d2
+  metadata.gz: f1ced4349e3ba6ee92c994e022909cfc77c37005
+  data.tar.gz: a450503278a67cf67af97d75c5ddd14907a59d82
 SHA512:
-  metadata.gz: b8e739b12dd7808c0a87c3629de33566df3c98ffd445b9a59ee6e70dd01b478628cc80fb2b2fab8e50d06ec23a2ae67aa2184b8f013b78f24f99f43281560d12
-  data.tar.gz: f96e501d2d292e8bc1f5fec114df1a5e0658397e61aae9421def5d883123957439d05cb0d974ba9ff9bbf0567cd1d935700e005e46b67393177797124b02887d
+  metadata.gz: 97a967c71d181734ff136f1ce12258877a6e205266f16b19b3850b5ef0ba39ceadb05219528d8878341928b1c9a795f5b0e5ebe07911aa9e361926ff450578d1
+  data.tar.gz: 76f9519cb0b95bb305dbf4c61efaa82bfb3c96a931832ca870f117cccb604a77fb4683cbf5b5ea772c58a5c647e95f60f6b5099f42a53099692adf1d8085b3b0

data/README.md

@@ -113,6 +113,18 @@ When you're extracting from the page, you can adjust the defaults (they are set
 Cucumber::Blanket.extract_from page, setup_wait:1, extract_wait:1 # increased each by a half-second
 ```
 
+## Dev Notes
+
+To create the `spec/fixtures/simple.json` with new real data, add this line
+to Cucumber::Blanket#extract_from once you have a handle to page_data:
+
+```ruby
+File.open("tmp/out.json", 'w'){|f| f.write page_data.to_json}
+```
+
+Run it through jsbeautifier and add it
+
+
 ## Contributing
 
 1. Fork it

data/javascript/cucumber-blanket.js

@@ -7,7 +7,7 @@
    * Required blanket commands:
    * blanket.setupCoverage(); // Do it ASAP
    * blanket.onTestStart(); // Do it ASAP
-   * blanket.onTestDone(); // After Scenario Hook
+   * blanket.onTestDone(); // After Scenario Hook (Not necessary)
    * blanket.onTestsDone(); // After Scenario Hook
    */
 
@@ -15,6 +15,12 @@
     callback: function() {
       blanket.setupCoverage();
       blanket.onTestStart();
+      window.CUCUMBER_BLANKET = {
+        files: {},
+        sources: {},
+        done: false,
+        is_setup: true
+      };
     }
   });
 
@@ -25,6 +31,16 @@
    * that doesn't actually work so we'll override defaultReporter
    */
   blanket.defaultReporter = function(coverage_results){
-    window.COVERAGE_RESULTS = coverage_results; // We'll grab this on selenium side
+    window.CUCUMBER_BLANKET.files = coverage_results.files;
+    // Strangely enough it looks like we need to iterate in order to grab the `source`
+    // data which is necessary to know which lines of code are being reported on.
+    var files = Object.keys(coverage_results.files);
+    for (var i = 0, l = files.length; i < l; i ++) {
+      var file = files[i];
+      window.CUCUMBER_BLANKET.sources[file] = window.CUCUMBER_BLANKET.files[file].source;
+    }
+    window.CUCUMBER_BLANKET.done = true;
+    // Now we can grab all this on the selenium side through window.CUCUMBER_BLANKET
   };
 })();
+

data/lib/cucumber/blanket/coverage_data.rb

@@ -8,7 +8,7 @@ module Cucumber
       attr_reader :data
 
       def initialize
-        @data = {'files'=>{}}
+        @data = {'files'=>{}, 'sources'=>{}}
       end
 
       def method_missing *args
@@ -19,6 +19,10 @@ module Cucumber
         self.data['files']
       end
 
+      def sources
+        self.data['sources']
+      end
+
       def accrue! page_data
         if @data.nil?
           @data = page_data
@@ -50,6 +54,11 @@ module Cucumber
               @data['files'][filename] = linedata
             end
           end
+
+          # As far as sources are concerned, we just add it if an entry doesn't exist
+          page_data['sources'].each do |filename, lines|
+            @data['sources'][filename] ||= lines
+          end
         end
       end
     end

data/lib/cucumber/blanket/version.rb

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

data/lib/cucumber/blanket.rb

@@ -14,26 +14,34 @@ module Cucumber
         @@coverage_data = CoverageData.new
       end
 
-      def files
-        self.coverage_data.files
+      def method_missing *args
+        self.coverage_data.send(*args)
       end
 
       # Grab code coverage from the frontend
-      # Currently this adds >1 second to every scenario, but it's worth it
+      # Currently this adds something like a few second or more to every scenario
       # The waits are lame but here's what it's trying to avoid
       #    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}
-        sleep opts[:setup_wait] # Give blanketJS time to setupCoverage() before we go to stop it
-        page.evaluate_script("blanket.onTestDone();")
+        @page = page
+        sleep(opts[:setup_wait]) until coverage_is_setup?
         page.evaluate_script("blanket.onTestsDone();")
-        sleep opts[:extract_wait] # Allow time for blanketJS and the adapter to prepare the report
-        page_data = page.evaluate_script("window.COVERAGE_RESULTS")
+        sleep(opts[:extract_wait]) 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")
+      end
+
+      def data_ready?
+        @page.evaluate_script("window.CUCUMBER_BLANKET.done")
+      end
+
       def percent
         total_lines = 0
         covered_lines = 0

data/spec/fixtures/simple.json

@@ -1,15 +1,12 @@
 {
+    "done": true,
     "files": {
-        "http://127.0.0.1:32344/js/collections/assets.js": [null, 1, 1, null, 1, null, null, null, 0, 0, null, 0, null, null, null, null, 0, 0]
+        "http://127.0.0.1:32344/js/collections/comments.js": [null, 1, 1, null, 1],
+        "http://127.0.0.1:32344/js/views/plans.js": [null, 1, 1, null, 1, null, null, null, null, null, null, 0, 0]
     },
-    "instrumentation": "blanket",
-    "stats": {
-        "end": {},
-        "failures": 0,
-        "passes": 1,
-        "pending": 0,
-        "start": {},
-        "suites": 0,
-        "tests": 1
+    "is_setup": true,
+    "sources": {
+        "http://127.0.0.1:32344/js/collections/comments.js": ["(function () {", "  'use strict';", "", "  App.Collections.Comments = Backbone.Collection.extend({", "", "    model: App.Models.Comment", "", "  });", "}());", "", ""],
+        "http://127.0.0.1:32344/js/views/plans.js": ["(function(){", "  \"use strict\";", "", "  App.Views.Plans = Backbone.View.extend({", "    events: {", "    },", "", "    template: App.Templates.plans,", "", "    render: function() {", "      this.$el.html(this.template);", "      return this;", "    }", "  });", "}());", ""]
     }
 }

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

@@ -47,4 +47,14 @@ describe Cucumber::Blanket::CoverageData do
       Cucumber::Blanket.files.should eq covdata.files
     end
   end
+
+  describe "#sources" do
+    it "shorthand for accessing the sources hash" do
+      covdata.sources.should eq covdata.data['sources']
+      covdata.sources.should be_a Hash
+    end
+    it "has a shortcut that produces the same data" do
+      Cucumber::Blanket.sources.should eq covdata.sources
+    end
+  end
 end

data/spec/lib/cucumber/blanket_spec.rb

@@ -8,6 +8,12 @@ describe Cucumber::Blanket do
     end
   end
 
+  describe "#sources" do
+    it "is a shortcut for coverage_data#sources" do
+      subject.sources.should eq subject.coverage_data.sources
+    end
+  end
+
   describe "#extract_from" do
     let(:page) { FakePage.new }
     context "Selenium-returned blanket.js coverage data structure characteristics" do
@@ -32,7 +38,7 @@ describe Cucumber::Blanket 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 37.5
+      subject.percent.should eq 75.0
     end
     context "no data harvested yet" do
       it "returns zero" do

data/spec/spec_helper.rb

@@ -15,8 +15,12 @@ class FakePage
   end
 
   def evaluate_script script
-    if script == "window.COVERAGE_RESULTS"
+    if script == "window.CUCUMBER_BLANKET"
       self.coverage_data
+    elsif script == "window.CUCUMBER_BLANKET.done"
+      true
+    elsif script == "window.CUCUMBER_BLANKET.is_setup"
+      true
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-blanket
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Keyvan Fatehi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler