jscov 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99ef4a868465e2904e7c3630c95b7e65d279156394278ad540e7de000547f1d5
-  data.tar.gz: c2dd6c216c26c20e5061d76a68ae0c2136ff9832723185a5d089e27c0a842b60
+  metadata.gz: f82380fb241d12d3d6eebe7d3e8871b27cabb321616e512b98b5608e59bfb0cc
+  data.tar.gz: 45bee86b0495527eb965828c79142572e26c0010e2b983d870cecf6d61cc4e27
 SHA512:
-  metadata.gz: 8425216d48ef1a6f01995530d8756f49bfa55a382bbe327d2efb563cde9d3d3f202cbe4d32700bb2c4835d247de9d9628206194fdfb86c1f8d0619946be3fda4
-  data.tar.gz: '029e8f9733aab260bed599f2133accc86b00db24062fbf421cd44b35730ef0163b4f821e2032c0546d302e33422f6208591c6b0d554b3fa692a9177c218962d1'
+  metadata.gz: 22683961b04ade60df6a5a8511cfba794370e81476b55518b049b7ab75d5fba1fa530039cdb8e6aa8d7baba99d5e65ab5e4599d46d01bd3661857b5b34c8d092
+  data.tar.gz: 0436e397fc6250f3e3430b0c12a0cd4afa20db53d4596dd47896e59106615dd71b86a64a5700a1f312b5e85cdcc89e080a8813d34c9dc2dc282cf3b6116209c0

data/README.md

@@ -64,13 +64,26 @@ Configure selenium to capture the output of `console.log`:
 
 ```ruby
 RSpec.configure do |config|
-  config.before(type: :system) do |example|
-    caps = Selenium::WebDriver::Remote::Capabilities.chrome('chromeOptions' => { w3c: false }, 'goog:loggingPrefs' => { browser: 'ALL' })
+  config.before(type: :system) do
+    caps = Selenium::WebDriver::Remote::Capabilities.chrome(
+      'chromeOptions' => { w3c: false },
+      'goog:loggingPrefs' => { browser: 'ALL' }
+    )
     driven_by :selenium, using: :headless_chrome, options: { desired_capabilities: caps }
   end
 end
 ```
 
+And configure rspec to save coverage files after each examples:
+
+```ruby
+RSpec.configure do |config|
+  config.after(type: :system) do
+    Jscov.save!
+  end
+end
+```
+
 Run `NODE_ENV=test RAILS_ENV=test bin/rails assets:precompile` for generating js codes that applied `istanbul`:
 
 ```bash
@@ -84,6 +97,23 @@ The collected coverages can be output as a report using [nyc](https://github.com
 $ npx nyc report --temp-dir=tmp/jscov
 ```
 
+### Tips
+
+Selenium's `logs.get(:browser)` is a destructive method. `jscov` depends on it. If you use it out of `jscov`, it will affect to result of `jscov`, and vice versa.
+
+You can pass browser logs to `Jscov.save!` to avoid this issue:
+
+```ruby
+logs = Capybara.current_session.driver.browser.manage.logs.get(:browser)
+Jscov.save!(logs: logs)
+```
+
+If you use multiple capybara sessions, you can pass your capybara sessions to `Jscov.save!` to save coverages that collected on your sessions:
+
+```
+Jscov.save!(session: your_capybara_session)
+```
+
 ### Vue.js
 
 To collect coverage for `.vue` files, you will need to change the configurations.

data/lib/jscov.rb

@@ -1,6 +1,7 @@
 require "securerandom"
 require "jscov/configuration"
 require "jscov/rack_middleware"
+require "jscov/collector"
 
 module Jscov
   class << self
@@ -17,5 +18,10 @@ module Jscov
       FileUtils.rm_f(Dir.glob(dir_path.join("jscov_*.json")))
       FileUtils.mkdir_p(dir_path)
     end
+
+    def save!(session: nil, logs: nil)
+      collector = Collector.new(session, logs)
+      collector.coverages.each(&:save)
+    end
   end
 end

data/lib/jscov/collector.rb

@@ -0,0 +1,48 @@
+require "json"
+require "jscov/coverage"
+
+module Jscov
+  class Collector
+    def initialize(session, logs)
+      @session = session || Capybara.current_session
+      @logs = logs
+    end
+
+    def coverages
+      return [] unless selenium?
+
+      dump_coverage
+
+      browser_logs
+        .map { |log| parse(log.message) }
+        .compact
+        .map { |cov| Coverage.new(cov) }
+    end
+
+    def selenium?
+      @session.driver.browser.respond_to?(:manage)
+    end
+
+    def dump_coverage
+      code = <<~JS
+        typeof __jscov_dumpCoverage === 'function' && __jscov_dumpCoverage()
+      JS
+      @session.execute_script(code)
+    end
+
+    def browser_logs
+      logs = @session.driver.browser.manage.logs.get(:browser)
+      (@logs || []) + logs
+    end
+
+    def parse(message)
+      json_string = message[/__jscov" (.*)/, 1]
+      return if json_string.nil?
+
+      json = JSON.parse(json_string)
+      JSON.parse(json)
+    rescue JSON::ParserError
+      nil
+    end
+  end
+end

data/lib/jscov/rspec.rb

@@ -1,15 +1,8 @@
 require "capybara"
 require "jscov"
-require "jscov/test_hooks"
 
 RSpec.configure do |config|
   config.before(:suite) do
     Jscov.clean!
   end
-
-  %i[system feature].each do |type|
-    config.after(type: type) do
-      Jscov::TestHooks.new(Capybara.current_session).after_example!
-    end
-  end
 end

data/lib/jscov/version.rb

@@ -1,3 +1,3 @@
 module Jscov
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jscov
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kazuki Nishikawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -112,11 +112,11 @@ files:
 - Rakefile
 - lib/jscov.rb
 - lib/jscov/bless.rb
+- lib/jscov/collector.rb
 - lib/jscov/configuration.rb
 - lib/jscov/coverage.rb
 - lib/jscov/rack_middleware.rb
 - lib/jscov/rspec.rb
-- lib/jscov/test_hooks.rb
 - lib/jscov/version.rb
 homepage: https://github.com/kzkn/jscov
 licenses:

data/lib/jscov/test_hooks.rb

@@ -1,46 +0,0 @@
-require "json"
-
-module Jscov
-  class TestHooks
-    def initialize(session)
-      @session = session
-    end
-
-    def after_example!
-      return unless selenium?
-
-      dump_coverage
-
-      browser_logs.each do |log|
-        coverage = parse(log.message)
-        if coverage
-          Coverage.new(coverage).save
-        end
-      end
-    end
-
-    def selenium?
-      @session.driver.browser.respond_to?(:manage)
-    end
-
-    def dump_coverage
-      @session.execute_script <<~JS
-                                typeof __jscov_dumpCoverage === 'function' && __jscov_dumpCoverage()
-                              JS
-    end
-
-    def browser_logs
-      @session.driver.browser.manage.logs.get(:browser)
-    end
-
-    def parse(message)
-      json_string = message[/__jscov" (.*)/, 1]
-      return if json_string.nil?
-
-      json = JSON.parse(json_string)
-      JSON.parse(json)
-    rescue JSON::ParserError
-      nil
-    end
-  end
-end