jasmine-coverage 0.2.2 → 0.2.4

data/README.md

@@ -59,6 +59,10 @@ it generates regardless, you can specify that in an environment variable.
 
     bundle exec rake jasmine:coverage JASMINE_COVERAGE_KEEP_TEST_RIG=true
 
+You can also specify if you want missing coverage warnings
+
+    bundle exec rake jasmine:coverage JASMINE_COVERAGE_WARNINGS=true
+
 # How it works
 
 First Sprockets is interrogated to get a list of JS files concerned. This way, the right JS files

data/lib/jasmine/coverage/version.rb

@@ -1,5 +1,5 @@
 module Jasmine
   module Coverage
-    VERSION = '0.2.2'
+    VERSION = '0.2.4'
   end
 end

data/lib/tasks/base64.min.js

@@ -0,0 +1,2 @@
+// credit to https://github.com/dankogai/js-base64
+(function(global){"use strict";if(global.Base64)return;var version="2.1.1";var buffer;if(typeof module!=="undefined"&&module.exports){buffer=require("buffer").Buffer}var b64chars="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";var b64tab=function(bin){var t={};for(var i=0,l=bin.length;i<l;i++)t[bin.charAt(i)]=i;return t}(b64chars);var fromCharCode=String.fromCharCode;var cb_utob=function(c){if(c.length<2){var cc=c.charCodeAt(0);return cc<128?c:cc<2048?fromCharCode(192|cc>>>6)+fromCharCode(128|cc&63):fromCharCode(224|cc>>>12&15)+fromCharCode(128|cc>>>6&63)+fromCharCode(128|cc&63)}else{var cc=65536+(c.charCodeAt(0)-55296)*1024+(c.charCodeAt(1)-56320);return fromCharCode(240|cc>>>18&7)+fromCharCode(128|cc>>>12&63)+fromCharCode(128|cc>>>6&63)+fromCharCode(128|cc&63)}};var re_utob=/[\uD800-\uDBFF][\uDC00-\uDFFFF]|[^\x00-\x7F]/g;var utob=function(u){return u.replace(re_utob,cb_utob)};var cb_encode=function(ccc){var padlen=[0,2,1][ccc.length%3],ord=ccc.charCodeAt(0)<<16|(ccc.length>1?ccc.charCodeAt(1):0)<<8|(ccc.length>2?ccc.charCodeAt(2):0),chars=[b64chars.charAt(ord>>>18),b64chars.charAt(ord>>>12&63),padlen>=2?"=":b64chars.charAt(ord>>>6&63),padlen>=1?"=":b64chars.charAt(ord&63)];return chars.join("")};var btoa=global.btoa||function(b){return b.replace(/[\s\S]{1,3}/g,cb_encode)};var _encode=buffer?function(u){return new buffer(u).toString("base64")}:function(u){return btoa(utob(u))};var encode=function(u,urisafe){return!urisafe?_encode(u):_encode(u).replace(/[+\/]/g,function(m0){return m0=="+"?"-":"_"}).replace(/=/g,"")};var encodeURI=function(u){return encode(u,true)};var re_btou=new RegExp(["[À-ß][€-¿]","[à-ï][€-¿]{2}","[ð-÷][€-¿]{3}"].join("|"),"g");var cb_btou=function(cccc){switch(cccc.length){case 4:var cp=(7&cccc.charCodeAt(0))<<18|(63&cccc.charCodeAt(1))<<12|(63&cccc.charCodeAt(2))<<6|63&cccc.charCodeAt(3),offset=cp-65536;return fromCharCode((offset>>>10)+55296)+fromCharCode((offset&1023)+56320);case 3:return fromCharCode((15&cccc.charCodeAt(0))<<12|(63&cccc.charCodeAt(1))<<6|63&cccc.charCodeAt(2));default:return fromCharCode((31&cccc.charCodeAt(0))<<6|63&cccc.charCodeAt(1))}};var btou=function(b){return b.replace(re_btou,cb_btou)};var cb_decode=function(cccc){var len=cccc.length,padlen=len%4,n=(len>0?b64tab[cccc.charAt(0)]<<18:0)|(len>1?b64tab[cccc.charAt(1)]<<12:0)|(len>2?b64tab[cccc.charAt(2)]<<6:0)|(len>3?b64tab[cccc.charAt(3)]:0),chars=[fromCharCode(n>>>16),fromCharCode(n>>>8&255),fromCharCode(n&255)];chars.length-=[0,0,2,1][padlen];return chars.join("")};var atob=global.atob||function(a){return a.replace(/[\s\S]{1,4}/g,cb_decode)};var _decode=buffer?function(a){return new buffer(a,"base64").toString()}:function(a){return btou(atob(a))};var decode=function(a){return _decode(a.replace(/[-_]/g,function(m0){return m0=="-"?"+":"/"}).replace(/[^A-Za-z0-9\+\/]/g,""))};global.Base64={VERSION:version,atob:atob,btoa:btoa,fromBase64:decode,toBase64:encode,utob:utob,encode:encode,encodeURI:encodeURI,btou:btou,decode:decode};if(typeof Object.defineProperty==="function"){var noEnum=function(v){return{value:v,enumerable:false,writable:true,configurable:true}};global.Base64.extendString=function(){Object.defineProperty(String.prototype,"fromBase64",noEnum(function(){return decode(this)}));Object.defineProperty(String.prototype,"toBase64",noEnum(function(urisafe){return encode(this,urisafe)}));Object.defineProperty(String.prototype,"toBase64URI",noEnum(function(){return encode(this,true)}))}}})(this);

data/lib/tasks/coverage_output_generator.js

@@ -31,8 +31,8 @@ function generateEncodedCoverage() {
     for (var file_name in window._$jscoverage) {
         var jscov = window._$jscoverage[ file_name ];
         var file_report = rv[ file_name ] = {
-            coverage:new Array(jscov.length),
-            source:new Array(jscov.length)
+            coverage: new Array(jscov.length),
+            source: new Array(jscov.length)
         };
         for (var i = 0; i < jscov.length; ++i) {
             var hit_count = jscov[ i ] !== undefined ? jscov[ i ] : null;
@@ -47,7 +47,7 @@ function generateEncodedCoverage() {
 
 function coverageForAllFiles() {
 
-    var totals = { files:0, statements:0, executed:0 };
+    var totals = { files: 0, statements: 0, executed: 0 };
 
     var output = "Coverage was:\n";
 
@@ -58,8 +58,14 @@ function coverageForAllFiles() {
         totals['files']++;
         totals['statements'] += simple_file_coverage['statements'];
         totals['executed'] += simple_file_coverage['executed'];
+        if (simple_file_coverage['missing'].length > 0 && JasmineCoverage.warnings) {
+            var i, ar = simple_file_coverage['missing'], l = ar.length;
+            for (i = 0; i < l; i++) {
+                console.log("\033[31m" + "WARNING -- File '" + file_name + "' has no coverage on line: " + ar[i] + "\033[0m");
+            }
+        }
 
-        var fraction = (simple_file_coverage['executed']+"/"+simple_file_coverage['statements']).lpad(' ', 10);
+        var fraction = (simple_file_coverage['executed'] + "/" + simple_file_coverage['statements']).lpad(' ', 10);
         output += fraction + (" = " + simple_file_coverage['percentage'] + "").lpad(' ', 3) + "% for " + file_name + "\n";
     }
 
@@ -69,10 +75,10 @@ function coverageForAllFiles() {
     }
 
     if (totals['statements'] === 0) {
-        log("No Javascript was found to test coverage for.");
+        console.log("No Javascript was found to test coverage for.");
     } else {
-        output += ( totals['executed'] +"/"+totals['statements']+ " = "+ coverage + "").lpad(' ', 15) + "% Total\n";
-        log(output);
+        output += ( totals['executed'] + "/" + totals['statements'] + " = " + coverage + "").lpad(' ', 15) + "% Total\n";
+        console.log(output);
     }
 
     return coverage;
@@ -120,8 +126,9 @@ function coverageForFile(fileCC) {
     var percentage = ( num_statements === 0 ? 0 : parseInt(100 * num_executed / num_statements) );
 
     return {
-        statements:num_statements,
-        executed:num_executed,
-        percentage:percentage
+        statements: num_statements,
+        executed: num_executed,
+        percentage: percentage,
+        missing: missing
     };
 }

data/lib/tasks/jasmine_coverage.rake

@@ -24,11 +24,11 @@ if env =~ /^(development|test)$/
       FileUtils.rm_rf output_dir
       FileUtils.mkdir_p instrumented_dir
 
-      # The reprocessing folder map
-      files_map = {
-          File.expand_path('app/assets/javascripts') => instrumented_dir+'app',
-          File.expand_path('lib/assets/javascripts') => instrumented_dir+'lib',
-          File.expand_path('public/javascripts') => instrumented_dir+'public'
+      # The reprocessing folder map. Use an environment variable if available.
+      files_map = ENV['JS_SRC_PATH'] ? {ENV['JS_SRC_PATH'] => instrumented_dir+'public'} : {
+        File.expand_path('app/assets/javascripts') => instrumented_dir+'app',
+        File.expand_path('lib/assets/javascripts') => instrumented_dir+'lib',
+        File.expand_path('public/javascripts') => instrumented_dir+'public',
       }
 
       # Instrument the source files into the instrumented folders
@@ -38,6 +38,7 @@ if env =~ /^(development|test)$/
         FileUtils.mv(Dir.glob(files_map[folder]+'/jscoverage*'), output_dir)
       end
 
+      Jasmine::Coverage.warnings = ENV['JASMINE_COVERAGE_WARNINGS'] || 'false'
       Jasmine::Coverage.resources = files_map
       Jasmine::Coverage.output_dir = output_dir
       test_rig_folder = "#{Jasmine::Coverage.output_dir}/test-rig"
@@ -46,26 +47,40 @@ if env =~ /^(development|test)$/
 
       # Run Jasmine using the original config.
       status_code = Jasmine::Headless::Runner.run(
-          # Any options from the options.rb file in jasmine-headless-webkit can be used here.
+        # Any options from the options.rb file in jasmine-headless-webkit can be used here.
 
-          :reporters => [['File', "#{output_dir}/rawreport.txt"]]
+        :reporters => [['File', "#{output_dir}/rawreport.txt"]]
       )
-      errStr = "JSCoverage exited with error code: #{status_code}.\nThis implies one of five things:\n"
-      errStr = errStr +"0) Your JS files had exactly zero instructions. Are they all blank or just comments?\n"
-      errStr = errStr +"1) A test failed (run bundle exec jasmine:headless to see a better error)\n"
-      errStr = errStr +"2) The sourcecode has a syntax error (which JSLint should find)\n"
-      errStr = errStr +"3) An error occurred in a deferred block, eg a setTimeout or underscore _.defer. This caused a window error which Jasmine will never see.\n"
-      errStr = errStr +"4) The source files are being loaded out of sequence (so global variables are not being declared in order)\n"
-      errStr = errStr +"   To check this, run bundle exec jasmine-headless-webkit -l to see the ordering\n"
-      errStr = errStr +"\nIn any case, try running the standard jasmine command to get better errors:\n\nbundle exec jasmine:headless\n"
-      errStr = errStr +"\nFinally, try opening the test-rig in firefox to see the tests run in a browser and get a stacktrace. "
-      errStr = errStr +"Chrome has strict security settings that make this difficult since it accesses the local filesystem from Javascript (but you can switch the settings off at the command line)\n\n"
-      errStr = errStr +"\n**********************************************************************************************\n"
-      errStr = errStr +"\nThe test rig file needs to load JS directly off disk, which Chrome prevents by default. Your best bet is to open the rig in Firefox.\n"
-      errStr = errStr +"\nThe file can be found here: #{test_rig_folder}/jscoverage-test-rig.html\n"
-      errStr = errStr +"\n**********************************************************************************************\n"
-      fail errStr if status_code == 1
+      errStr = <<-EOS
+JSCoverage exited with error code: #{status_code}
+
+This implies one of five things:
+0) Your JS files had exactly zero instructions. Are they all blank or just comments?
+1) A test failed (run bundle exec rake jasmine:headless to see a better error)
+2) The sourcecode has a syntax error (which JSLint should find)
+3) An error occurred in a deferred block, e.g. a setTimeout or underscore _.defer. This caused a window error which Jasmine will never see.
+4) The source files are being loaded out of sequence (so global variables are not being declared in order)
+   To check this, run bundle exec jasmine-headless-webkit -l to see the ordering
+
+In any case, try running the standard jasmine command to get better errors:
+
+bundle exec rake jasmine:headless
+
+Finally, try opening the test-rig in firefox to see the tests run in a browser and get a stacktrace. Chrome has strict security settings
+that make this difficult since it accesses the local filesystem from Javascript (but you can switch the settings off at the command line).
+
+
+**********************************************************************************************
+
+The test rig file needs to load JS directly off disk, which Chrome prevents by default. Your best bet is to open the rig in Firefox.
+
+The file can be found here: #{test_rig_folder}/jscoverage-test-rig.html
+
+**********************************************************************************************
 
+      EOS
+
+      fail errStr if status_code == 1
       # Delete the test_rig folder if not required
       if ENV['JASMINE_COVERAGE_KEEP_TEST_RIG']
         p "A copy of the page and files that were used as the jasmine test environment can be found here: #{test_rig_folder}"
@@ -77,8 +92,18 @@ if env =~ /^(development|test)$/
       contents = File.open("#{output_dir}/rawreport.txt") { |f| f.read }
       # Get our Base64.
       json_report_enc = contents.split(/ENCODED-COVERAGE-EXPORT-STARTS:/m)[1]
-      # Remove the junk at the end
-      json_report_enc_stripped = json_report_enc[0, json_report_enc.index("\"")]
+      # Provide warnings to use
+      warning_regex = /^CONSOLE\|\|.{1,6}WARNING.{4}(.*).{5}$/
+      warnings = contents.scan warning_regex
+      if (warnings.length != 0)
+        puts "Detected #{warnings.length} warnings:"
+        puts warnings
+        fail "Aborting. All lines must be covered by a test." if ENV['MUST_COVER_ALL']
+      else
+        puts "No warnings detected."
+      end if
+        # Remove the junk at the end
+        json_report_enc_stripped = json_report_enc[0, json_report_enc.index("\"")]
 
       # Unpack it from Base64
       json_report = Base64.decode64(json_report_enc_stripped)
@@ -119,6 +144,8 @@ if env =~ /^(development|test)$/
   module Jasmine
     module Coverage
       @resources
+      @output_dir
+      @warnings
 
       def self.resources= resources
         @resources = resources
@@ -128,8 +155,6 @@ if env =~ /^(development|test)$/
         @resources
       end
 
-      @output_dir
-
       def self.output_dir= output_dir
         @output_dir = output_dir
       end
@@ -137,7 +162,15 @@ if env =~ /^(development|test)$/
       def self.output_dir
         @output_dir
       end
+
+      def self.warnings= warnings
+        @warnings = warnings
+      end
+
+      def self.warnings
+        @warnings
+      end
     end
   end
 
-end
+end

data/lib/tasks/jasmine_headless_coverage_patches.rb

@@ -16,14 +16,11 @@ module Jasmine::Headless
       FileUtils.mkdir_p test_rigfolder
 
       p "Copying all view files and potential javascript fixture folders so the jasmine-coverage run has access to the html fixtures."
-      FileUtils.mkdir_p "#{test_rigfolder}/target/fixtures"
-      FileUtils.copy_entry("#{Jasmine::Coverage.output_dir}/../fixtures", "#{test_rigfolder}/target/fixtures") rescue nil
-      FileUtils.mkdir_p "#{test_rigfolder}/target/views"
-      FileUtils.copy_entry("#{Jasmine::Coverage.output_dir}/../views", "#{test_rigfolder}/target/views") rescue nil
-
-      # Here we must also copy the spec and app folders to that we have access to all the files if we need them for the test rig
-      FileUtils.copy_entry("#{Jasmine::Coverage.output_dir}/../../spec", "#{test_rigfolder}/spec")
-      FileUtils.copy_entry("#{Jasmine::Coverage.output_dir}/../../app", "#{test_rigfolder}/app")
+      copy_assets_to_test_dir(test_rigfolder, '../fixtures', 'target/fixtures')
+      copy_assets_to_test_dir(test_rigfolder, '../views', 'target/views')
+      # Here we must also copy the spec and app folders so that we have access to all the files if we need them for the test rig
+      copy_assets_to_test_dir(test_rigfolder, '../../spec', 'spec')
+      copy_assets_to_test_dir(test_rigfolder, '../../app', 'app')
 
       jss = str.scan(/<script type="text\/javascript" src="(.*)"><\/script>/)
       jss << str.scan(/<link rel="stylesheet" href="(.*)" type="text\/css" \/>/)
@@ -52,6 +49,15 @@ module Jasmine::Headless
 
       ret
     end
+
+    private
+
+    def copy_assets_to_test_dir(test_rigfolder, from_dir, to_dir)
+      if File.exists? "#{Jasmine::Coverage.output_dir}/#{from_dir}"
+        FileUtils.mkdir_p "#{test_rigfolder}/#{to_dir}"
+        FileUtils.copy_entry("#{Jasmine::Coverage.output_dir}/#{from_dir}", "#{test_rigfolder}/#{to_dir}")
+      end
+    end
   end
 end
 
@@ -63,7 +69,7 @@ module Jasmine::Headless
 
     def to_html(files)
       # Declare our test runner files
-      cov_files = ['/jscoverage.js', '/coverage_output_generator.js']
+      cov_files = ['/jscoverage.js', '/base64.min.js', '/coverage_output_generator.js']
 
       # Add the original files, remapping to instrumented where necessary
       tags = []
@@ -85,6 +91,8 @@ module Jasmine::Headless
       # Attach the "in context" test runners
       tags = tags + old_to_html(cov_files.map { |f| File.dirname(__FILE__)+f })
 
+      add_coverage_js_config(tags)
+
       tags
     end
 
@@ -97,5 +105,17 @@ module Jasmine::Headless
       @sprockets_environment.append_path(File.dirname(__FILE__))
       @sprockets_environment
     end
+
+    private
+
+    # This method injects the config we have defined in Ruby that needs to be present in the JS context
+    def add_coverage_js_config(tags)
+      cov_conf = "#{Jasmine::Coverage.output_dir}/coverage_config.js"
+      tags << "<script type=\"text/javascript\" src=\"#{cov_conf}\"></script>"
+
+      aFile = File.new(cov_conf, "w")
+      aFile.write("var JasmineCoverage = { warnings: #{Jasmine::Coverage.warnings}}")
+      aFile.close
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jasmine-coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,56 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
   name: jasmine-headless-webkit
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.0.rc.2
-    none: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.0.rc.2
-    none: false
 - !ruby/object:Gem::Dependency
   type: :runtime
   name: coffee-script-source
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
   type: :runtime
   name: headless
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: 
 email:
 - harry@harrylascelles.com
@@ -69,6 +69,7 @@ files:
 - lib/jasmine/coverage.rb
 - lib/jasmine/coverage/version.rb
 - lib/jasmine/coverage/jasmine_coverage_railtie.rb
+- lib/tasks/base64.min.js
 - lib/tasks/jasmine_headless_coverage_patches.rb
 - lib/tasks/jasmine_coverage.rake
 - lib/tasks/jscoverage.js
@@ -82,20 +83,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A blend of JS unit testing and coverage