cucumber-blanket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a325cf61c6c342d6e9066eecf5368b9062e1f12
-  data.tar.gz: 8405f3fc01145224245f6c2904ebeac73687d96d
+  metadata.gz: 2cc556e69fcc4d91fd37b57b8318d2ac67dbcaa9
+  data.tar.gz: 4d37ca8867d062e68b8c91181146d3acf64bd69a
 SHA512:
-  metadata.gz: 878b4d48cf083cdc5790c1cf80b9481c9a39a2c4d12e3e440ede1b05c6be27f9fc09cca286a8c6dee34275b218b93e30e0df5f0204102be552dd5b8cb29310cf
-  data.tar.gz: 496cbf56f4aa29607853dc5b9d6d79f034ad5d759c987885410f8d39130a169c79d789cb045c7eba53ec2e146415da014011053bb61a8a01e4b3be76f4f38779
+  metadata.gz: 1af5a99c05f9401982483090f4ba19b47817d6bb2534a181c92427857141c6689f4681d6f1d2777676f8e77fb9609d2c2843a110b0a84c27ad1c9398aca360df
+  data.tar.gz: f489b94aa98581a06cfddc74be41ce31ef537a0c1afa745675c2a23a7304a8e2a71da21cec3f69e155831734f40f359a7f8113f3bca9339665ae6674df89d534

data/.rspec

@@ -0,0 +1 @@
+--color

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -1,7 +1,7 @@
 # Cucumber::Blanket
 
-**WIP** -- will be done soon though, it's close, I just need to flatten
-the data as it comes in and complete the report generator
+**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.
@@ -22,6 +22,16 @@ Or install it yourself as:
 
 ## Usage
 
+You should be using Cucumber
+
+Require this gem at the top of `features/support/env.rb` or before using it.
+
+```ruby
+require 'cucumber/blanket'
+```
+
+Install blanket.js
+
 Two javascript files are bundled;
 * blanket.js -- the library itself
 * cucumber-blanket.js -- a very simple modification
@@ -45,13 +55,12 @@ end
 Of course every scenario will touch on different parts of your code, as
 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. **not done yet**
+considered covered when Cucumber has finished running.
 
 Finally, to generate a report **not done yet**, you can do:
 
 ```ruby
 after_exit do
-  $stack.stop
   puts Cucumber::Blanket.generate_report
 end
 ```

data/cucumber-blanket.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
 end

data/lib/cucumber/blanket.rb

@@ -1,9 +1,14 @@
 require "cucumber/blanket/version"
+require "cucumber/blanket/coverage_data"
 
 module Cucumber
   module Blanket
     class << self
-      @@coverage_data = []
+      @@coverage_data = CoverageData.new
+
+      def coverage_data
+        @@coverage_data
+      end
 
       # Grab code coverage from the frontend
       # Currently this adds >1 second to every scenario, but it's worth it
@@ -12,19 +17,14 @@ module Cucumber
         page.evaluate_script("blanket.onTestDone();")
         page.evaluate_script("blanket.onTestsDone();")
         sleep 0.5 # Allow time for blanketJS and the adapter to prepare the report
-        @@coverage_data << page.evaluate_script("window.COVERAGE_RESULTS")
-        flatten!
-      end
-
-      def flatten!
-        # go through every line of every file and OR it all together
-        # e.g. line 1 is 1 and 0, so it is 1
-        # @@coverage_data should never exceed length 2
+        page_data = page.evaluate_script("window.COVERAGE_RESULTS")
+        @@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.length}"
+        puts "coverage data length: #{@@coverage_data.inspect}"
       end
     end
   end

data/lib/cucumber/blanket/coverage_data.rb

@@ -0,0 +1,56 @@
+module Cucumber
+  module Blanket
+    ##
+    # Contains the blanketJS data structure
+    # primary purpose is to accumulate more of this data, flattening
+    # the structure against multiple runs of fresh data
+    class CoverageData
+      attr_reader :data
+
+      def initialize
+        @data = nil
+      end
+
+      def method_missing *args
+        @data[0].send(*args)
+      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|
+            # that exist in @data
+            if @data[0]['files'].has_key? page_data[0]['files'].first[0]
+              # 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]
+                # 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
+                  # 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
+              end
+            else # if it does not exist
+              # add it to 'files' as is
+              @data[0]['files'][filename] = linedata
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/blanket/version.rb

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

data/spec/fixtures/simple.json

@@ -0,0 +1,15 @@
+[{
+    "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]
+    },
+    "instrumentation": "blanket",
+    "stats": {
+        "end": {},
+        "failures": 0,
+        "passes": 1,
+        "pending": 0,
+        "start": {},
+        "suites": 0,
+        "tests": 1
+    }
+}]

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Cucumber::Blanket::CoverageData do
+  let(:page) { FakePage.new }
+  let(:covdata) do
+    Cucumber::Blanket.extract_from(page)
+    Cucumber::Blanket.coverage_data
+  end
+
+  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
+    end
+    it "squishes coverage datasets together" do
+      covdata["files"].first[1][0].should be_nil
+      covdata["files"].first[1][1].should eq 1
+      covdata.accrue! new_page_data
+      covdata["files"].first[1][0].should eq 3
+      covdata["files"].first[1][1].should eq 2
+    end
+  end
+end

data/spec/lib/cucumber/blanket_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Cucumber::Blanket do
+  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' }
+      it "shows lines of coverage for each javascript file" do
+        cov['files'].each do |filename,linedata|
+          filename.should match(/.js$/)
+          linedata.each_with_index do |cov_stats,line_number|
+            line_number.should be_a Integer
+            (cov_stats || 0).should be_a Integer # can be nil
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'pry'
+require 'json'
+require 'cucumber/blanket'
+
+class FakePage
+  attr_reader :coverage_data
+
+  def initialize
+    @coverage_data = parse_fixture_json
+  end
+
+  def parse_fixture_json
+    json = File.read(File.join(File.dirname(__FILE__),'fixtures','simple.json'))
+    return JSON.parse(json) # How it looks when we get it from Selenium
+  end
+
+  def evaluate_script script
+    if script == "window.COVERAGE_RESULTS"
+      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.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Keyvan Fatehi
@@ -38,6 +38,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Extract Blanket.js code coverage data from within a Ruby Cucumber environment
 email:
 - keyvanfatehi@gmail.com
@@ -46,7 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -54,7 +98,12 @@ files:
 - javascript/blanket.js
 - javascript/cucumber-blanket.js
 - lib/cucumber/blanket.rb
+- lib/cucumber/blanket/coverage_data.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
 homepage: https://github.com/keyvanfatehi/cucumber-blanket
 licenses:
 - MIT
@@ -79,4 +128,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Extract Blanket.js code coverage data from within a Ruby Cucumber environment
-test_files: []
+test_files:
+- spec/fixtures/simple.json
+- spec/lib/cucumber/blanket/coverage_data_spec.rb
+- spec/lib/cucumber/blanket_spec.rb
+- spec/spec_helper.rb