propshaft-js-coverage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45b0cdef5510748a7220025542d359c363f5dafc42235c2243182b1aa8a0fc8a
+  data.tar.gz: 16336ae2f0629cb95dc0f024b15b96dc8ea500fa3aba8d883e73c88732b0fc6b
+SHA512:
+  metadata.gz: 120ff098be347f3910e42eed790333a6361fa8a9948d76137d76ebac6347bdc31596bb7dd402d7c7f97ecd40f89a45aab9b41c9c3d6911f9ad082cbb4cff7ce1
+  data.tar.gz: 58b8084d25f2609fc8cd356c72adca3580fae24f22f0076d4932507849578587f9abf9024ce872c05273ac5a820e7f64488ea8d360908746a18e4cfed2a0bf59

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+Unreleased
+==========
+
+**Key breaking changes:**
+
+New features:
+
+Updated features:
+
+Removed features:
+
+Internal improvements:
+
+Testing improvements:
+
+Others:
+
+v0.1.0
+======
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yoann Lecuyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'propshaft-js-coverage'
+```
+
+Add the compiler to propshaft
+
+```ruby
+# config/initializers/assets.rb
+
+if ENV["COVERAGE"]
+  Propshaft::Js::Coverage::Compiler.configure do |config|
+    config.should_process = ->(path) {
+      return false if path.match?(/vendor\/assets\//)
+      return false if path.match?(/gems\//)
+      return true
+    }
+  end
+
+  Rails.application.config.assets.compilers << [
+    "text/javascript", Propshaft::Js::Coverage::Compiler
+  ]
+end
+```
+
+Get the coverage reports after running your tests
+
+```ruby
+# test/application_system_test_case.rb
+
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+def teardown
+    __coverage__ = page.evaluate_script <<-JS
+        JSON.stringify((typeof __coverage__ !== 'undefined') ? __coverage__ : null)
+    JS
+
+    if __coverage__ != "null"
+      File.write("#{JS_COVERAGE_DIR}/#{Time.now.to_i.to_s}.json", __coverage__)
+    end
+
+    super
+  end
+end
+```
+
+Convert to lcov and generate html report
+
+```bash
+nyc report --reporter=lcov --temp-dir tmp/js-coverage --report-dir tmp/js-coverage
+genhtml -q -o ./coverage ./tmp/js-coverage/lcov.info ./coverage/lcov/simplecov.lcov
+```
+
+# How it works
+
+This gem uses istanbul instrumenter to add coverage to your javascript files. It will add a global variable `__coverage__` to your javascript files. You can then use this variable to get the coverage report.
+
+# Configuration
+
+TBD
+
+# Contributing
+
+Clone the repo and run `bundle install` to install the dependencies.
+
+Prepare the js script by running `yarn install` and `yarn run build` in the `js/instrumenter` directory.
+
+# Release
+
+Run `./scripts/release.sh` to release a new version after updating the version in `lib/propshaft/js/coverage/version.rb`.