cucumber-blanket 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b714356da5e34fa7ad85c6e4aa0e84fe02375e7c
-  data.tar.gz: f0098ff584b7ef9efed4acb1fdf45bbef8aef8e0
+  metadata.gz: e23857ccf05090b02850a9edb41cafdd17ac781d
+  data.tar.gz: cbccd47528e369462f58c422e0b974392e9359d2
 SHA512:
-  metadata.gz: ff7bfbf589cf87174b1954234836b6eaaa9f29f0460cd3bc70698457dc35baae3ba75b1d89cfbe06163bb4e5f7c60df8ef92600c930dacf71114e10646b27e57
-  data.tar.gz: 28722ff3dbd10ef8ed147e2da0d7ad6a61ae1631ff6915443d47eb1833208892e2ae5ea3f0833754241b5064ed7fef1309ea0afbed04104e9c5de411e1a3d563
+  metadata.gz: b8e739b12dd7808c0a87c3629de33566df3c98ffd445b9a59ee6e70dd01b478628cc80fb2b2fab8e50d06ec23a2ae67aa2184b8f013b78f24f99f43281560d12
+  data.tar.gz: f96e501d2d292e8bc1f5fec114df1a5e0658397e61aae9421def5d883123957439d05cb0d974ba9ff9bbf0567cd1d935700e005e46b67393177797124b02887d

data/README.md

@@ -74,6 +74,45 @@ end
 I have both of these in my `features/support/hooks.rb` file. As far as doing something useful
 with the coverage data, that's left up to the user, another gem, or maybe blanket.js itself from Node.js.
 
+## Other Features
+
+### Percent
+
+You can use `Cucumber::Blanket.percent` to get a float value of coverage of known lines of code.
+
+For example, you can do something like this to watch coverage increasing on every scenario:
+
+```ruby
+After do |scenario|
+  old_pct = Cucumber::Blanket.percent
+  Cucumber::Blanket.extract_from page
+  current_pct = Cucumber::Blanket.percent
+  pct_added = current_pct - old_pct
+  STDOUT.puts "Coverage: #{current_pct}% (+#{pct_added}%)"
+end
+
+at_exit do
+  STDOUT.puts "Final coverage: #{Cucumber::Blanket.percent}%"
+end
+```
+
+### Options
+
+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:
+
+```
+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
+```
+
 ## Contributing
 
 1. Fork it

data/lib/cucumber/blanket.rb

@@ -20,15 +20,37 @@ module Cucumber
 
       # Grab code coverage from the frontend
       # Currently this adds >1 second to every scenario, but it's worth it
-      def extract_from page
-        sleep 0.5 # Give blanketJS time to setupCoverage() before we go to stop it
+      # 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.evaluate_script("blanket.onTestsDone();")
-        sleep 0.5 # Allow time for blanketJS and the adapter to prepare the report
+        sleep opts[:extract_wait] # Allow time for blanketJS and the adapter to prepare the report
         page_data = page.evaluate_script("window.COVERAGE_RESULTS")
         @@coverage_data.accrue! page_data
         return page_data
       end
+
+      def percent
+        total_lines = 0
+        covered_lines = 0
+        self.files.each do |filename, linedata|
+          linedata.compact.each do |cov_stat|
+            if cov_stat > 0
+              covered_lines += 1
+            end
+            total_lines += 1
+          end
+        end
+        if total_lines > 0
+          return ((covered_lines.to_f / total_lines)*100).round(2)
+        else
+          return 0.0
+        end
+      end
     end
   end
 end

data/lib/cucumber/blanket/version.rb

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

data/spec/lib/cucumber/blanket_spec.rb

@@ -27,4 +27,17 @@ describe Cucumber::Blanket do
       end
     end
   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 37.5
+    end
+    context "no data harvested yet" do
+      it "returns zero" do
+        subject.percent.should eq 0.0
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-blanket
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Keyvan Fatehi