cucumber-blanket 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc556e69fcc4d91fd37b57b8318d2ac67dbcaa9
-  data.tar.gz: 4d37ca8867d062e68b8c91181146d3acf64bd69a
+  metadata.gz: b714356da5e34fa7ad85c6e4aa0e84fe02375e7c
+  data.tar.gz: f0098ff584b7ef9efed4acb1fdf45bbef8aef8e0
 SHA512:
-  metadata.gz: 1af5a99c05f9401982483090f4ba19b47817d6bb2534a181c92427857141c6689f4681d6f1d2777676f8e77fb9609d2c2843a110b0a84c27ad1c9398aca360df
-  data.tar.gz: f489b94aa98581a06cfddc74be41ce31ef537a0c1afa745675c2a23a7304a8e2a71da21cec3f69e155831734f40f359a7f8113f3bca9339665ae6674df89d534
+  metadata.gz: ff7bfbf589cf87174b1954234836b6eaaa9f29f0460cd3bc70698457dc35baae3ba75b1d89cfbe06163bb4e5f7c60df8ef92600c930dacf71114e10646b27e57
+  data.tar.gz: 28722ff3dbd10ef8ed147e2da0d7ad6a61ae1631ff6915443d47eb1833208892e2ae5ea3f0833754241b5064ed7fef1309ea0afbed04104e9c5de411e1a3d563

data/README.md

@@ -1,10 +1,8 @@
 # Cucumber::Blanket
 
-**WIP** -- will be done soon though, it's close, I just need to complete
-the report generator
-
-Works to extract [Blanket.js](https://github.com/alex-seville/blanket) coverage data 
-from the browser from Cucumber.
+Works to extract accumulated [Blanket.js](https://github.com/alex-seville/blanket) coverage data 
+from the browser from a Cucumber environment. Accumulated, in this context, means that coverage data
+is accumulated from scenario to scenario, in an additive fashion.
 
 ## Installation
 
@@ -57,15 +55,24 @@ such Cucumber::Blanket OR's the lines. In other words, if line 10 of
 File A was covered in Scenario X, but not in Scenario Y, line 10 is
 considered covered when Cucumber has finished running.
 
-Finally, to generate a report **not done yet**, you can do:
+Finally, to gain access to the accumulated coverage data, you can use the shorthand `Cucumber::Blanket.files`:
 
 ```ruby
 after_exit do
-  puts Cucumber::Blanket.generate_report
+  covdata =  # do something with it
+  File.open("tmp/coverage.json", "w") do |file|
+    file.write Cucumber::Blanket.files.to_json
+    # writes out JSON of this form of ruby hash:
+    # => {"http://127.0.0.1:32344/js/collections/assets.js"=>
+    #  [3, 3, 3, nil, 3, nil, nil, nil, 0, 0, nil, 0, nil, nil, nil, nil, 0, 0]}
+    # {filename=>[lineCov,lineCov,lineCov]}
+    # At this stage you can fetch the files and create a nice HTML report, etc
+  end
 end
 ```
 
-I have both of these in my `features/support/hooks.rb` file.
+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.
 
 ## Contributing
 

data/lib/cucumber/blanket.rb

@@ -10,6 +10,14 @@ module Cucumber
         @@coverage_data
       end
 
+      def reset!
+        @@coverage_data = CoverageData.new
+      end
+
+      def files
+        self.coverage_data.files
+      end
+
       # Grab code coverage from the frontend
       # Currently this adds >1 second to every scenario, but it's worth it
       def extract_from page
@@ -21,11 +29,6 @@ module Cucumber
         @@coverage_data.accrue! page_data
         return page_data
       end
-
-      def generate_report
-        # but for now, so you know it's there...
-        puts "coverage data length: #{@@coverage_data.inspect}"
-      end
     end
   end
 end

data/lib/cucumber/blanket/coverage_data.rb

@@ -8,45 +8,46 @@ module Cucumber
       attr_reader :data
 
       def initialize
-        @data = nil
+        @data = {'files'=>{}}
       end
 
       def method_missing *args
-        @data[0].send(*args)
+        @data.send(*args)
+      end
+
+      def files
+        self.data['files']
       end
 
       def accrue! page_data
-        # go through every line of every file and OR it all together
-        # e.g. line 1 is 1 and 0, so it is 1
-        #binding.pry
         if @data.nil?
           @data = page_data
         else
           # for files in page_data ...
-          page_data[0]['files'].each do |filename, linedata|
+          page_data['files'].each do |filename, linedata|
             # that exist in @data
-            if @data[0]['files'].has_key? page_data[0]['files'].first[0]
+            if @data['files'][filename]
               # accrue coverage data, meaning:
               # get a handle on existing linedata and iterate
-              @data[0]['files'][filename].each_with_index do |cov_stat, line_no|
-                new_cov_stat = page_data[0]['files'][filename][line_no]
+              @data['files'][filename].each_with_index do |cov_stat, line_no|
+                new_cov_stat = page_data['files'][filename][line_no]
                 # first we need to deal with nils, as we cannot add them
                 # either side can be nil -- and we want to be strictly additive
                 next if new_cov_stat.nil? # this is not additive, next line
                 # So now we know the new data is definitely not nil
                 # but the existing data could be, so we'll handle that now
                 if cov_stat.nil?
-                  @data[0]['files'][filename][line_no] = new_cov_stat
+                  @data['files'][filename][line_no] = new_cov_stat
                   # We replaced it with the new data, next line please
                   next
                 end
                 # if we ever get here, we're dealing strictly with integers
                 # as a result we just need to sum the two stats
-                @data[0]['files'][filename][line_no] = cov_stat + new_cov_stat
+                @data['files'][filename][line_no] = cov_stat + new_cov_stat
               end
             else # if it does not exist
               # add it to 'files' as is
-              @data[0]['files'][filename] = linedata
+              @data['files'][filename] = linedata
             end
           end
         end

data/lib/cucumber/blanket/version.rb

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

data/spec/fixtures/simple.json

@@ -1,4 +1,4 @@
-[{
+{
     "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]
     },
@@ -12,4 +12,4 @@
         "suites": 0,
         "tests": 1
     }
-}]
+}

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

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Cucumber::Blanket::CoverageData do
+  before(:each) { Cucumber::Blanket.reset! }
   let(:page) { FakePage.new }
   let(:covdata) do
     Cucumber::Blanket.extract_from(page)
@@ -10,7 +11,7 @@ describe Cucumber::Blanket::CoverageData do
   describe "#accrue!" do
     let(:new_page_data) do
       page_data = Marshal.load(Marshal.dump(covdata.data))
-      page_data[0]['files'].first[1][0] = 3 # add coverage on that line
+      page_data['files'].first[1][0] = 3 # add coverage on that line
       page_data
     end
     it "squishes coverage datasets together" do
@@ -20,5 +21,30 @@ describe Cucumber::Blanket::CoverageData do
       covdata["files"].first[1][0].should eq 3
       covdata["files"].first[1][1].should eq 2
     end
+
+    context "filename exists but is not iterable" do
+      let(:new_page_data) do
+        Marshal.load(Marshal.dump(covdata.data))
+      end
+      before do
+        @data_copy = new_page_data
+        @filename = covdata['files'].first[0]
+        covdata['files'][@filename] = nil
+      end
+      it "will not try to iterate over nil" do
+        expect {covdata.accrue! @data_copy}.not_to raise_error
+      end
+    end
+  end
+
+
+  describe "#files" do
+    it "shorthand for accessing the files hash" do
+      covdata.files.should eq covdata.data['files']
+      covdata.files.should be_a Hash
+    end
+    it "has a shortcut that produces the same data" do
+      Cucumber::Blanket.files.should eq covdata.files
+    end
   end
 end

data/spec/lib/cucumber/blanket_spec.rb

@@ -1,6 +1,13 @@
 require 'spec_helper'
 
 describe Cucumber::Blanket do
+
+  describe "#files" do
+    it "is a shortcut for coverage_data#files" do
+      subject.files.should eq subject.coverage_data.files
+    end
+  end
+
   describe "#extract_from" do
     let(:page) { FakePage.new }
     context "Selenium-returned blanket.js coverage data structure characteristics" do

data/spec/spec_helper.rb

@@ -19,12 +19,5 @@ class FakePage
       self.coverage_data
     end
   end
-
-  ##
-  # Helper to change the lines of coverage for testing flattening
-  # of two sets of coverage data
-  def cov_lines
-    
-  end
 end
 

metadata

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