RubyGems - jscov - Versions diffs - 0.1.0 - Mend

jscov 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +97 -0
data/Rakefile +10 -0
data/app/controllers/jscov/application_controller.rb +5 -0
data/app/controllers/jscov/coverages_controller.rb +14 -0
data/config/routes.rb +3 -0
data/lib/jscov.rb +28 -0
data/lib/jscov/configuration.rb +16 -0
data/lib/jscov/coverage.rb +13 -0
data/lib/jscov/engine.rb +5 -0
data/lib/jscov/helper.rb +26 -0
data/lib/jscov/railtie.rb +11 -0
data/lib/jscov/rspec.rb +7 -0
data/lib/jscov/version.rb +3 -0
data/lib/tasks/jscov_tasks.rake +4 -0
metadata +100 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f29b1e1e112c912b6a7213210d3f156c9ca57e2ec7e01a2c5c9c1770051d7156
+  data.tar.gz: 5db3557ea568399e5de364d93fa6f7ba6beaad43f91b5e3dc2bf10d7beba48ef
+SHA512:
+  metadata.gz: ca06dc98ada7976f0edaab3935cb89c1ea8808f0f40b16ba444350f7f97c6ddad2a5a2804d0c359924f00c411a46403bbf0a80ccf91608f2dacfde4a5d959f45
+  data.tar.gz: 413eb1782c2cc65351c3b28fadb030d5fc79d4a3747dce8cb31596acc3f66ae68791a398d2774eaf0b099f02b2865ec8a0701bf14a6963eb78064ae31d67e8d6

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2020 Kazuki Nishikawa
+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 ADDED

@@ -0,0 +1,97 @@
+# Jscov
+Collect JavaScript code coverages. It works with [istanbul](https://istanbul.js.org/).
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'jscov'
+```
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install jscov
+```
+## Usage
+Install [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul).
+```bash
+$ yarn add -D babel-plugin-istanbul
+```
+And setup it. In babel.config.js:
+```js
+module.exports = function (api) {
+  // ....
+  return {
+    plugins: [
+      // ...
+      isTestEnv && 'babel-plugin-istanbul' // Add this
+    ].filter(Boolean)
+  }
+}
+```
+Mount `Jscov::Engine`. In route.rb:
+```ruby
+if Jscov.enabled?
+  mount Jscov::Engine => "/jscov"
+end
+```
+Insert `jscov_script_tag` in your layout file:
+```html
+<html>
+  <head>
+    <%= jscov_script_tag %>
+  </head>
+  ...
+</html>
+```
+Load rspec helper. In spec/rails_helper.rb:
+```ruby
+require 'jscov/rspec'
+```
+Run `NODE_ENV=test RAILS_ENV=test bin/rails assets:precompile` for generating js codes that applied `istanbul`:
+```bash
+NODE_ENV=test RAILS_ENV=test bin/rails assets:precompile
+```
+OK, run rspec! It will dump collected coverage files in `tmp/jscov`.
+The collected coverages can be output as a report using [nyc](https://github.com/istanbuljs/nyc).
+```bash
+$ npx nyc report --temp-dir=tmp/jscov
+```
+## Configuration
+In `config/initializers/jscov.rb`, you can configure the following values.
+```ruby
+Jscov.configure do |config|
+  # config.enabled = Rails.env.test?
+  # config.coverage_report_dir_path = Rails.root.join("tmp/jscov")
+end
+```
+## Contributing
+Contribution directions go here.
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+task default: :test

data/app/controllers/jscov/application_controller.rb ADDED

@@ -0,0 +1,5 @@
+module Jscov
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/jscov/coverages_controller.rb ADDED

@@ -0,0 +1,14 @@
+require "jscov/coverage"
+module Jscov
+  class CoveragesController < ApplicationController
+    skip_before_action :verify_authenticity_token
+    def create
+      raw_data = JSON.parse(params[:coverage])
+      coverage = Jscov::Coverage.new(raw_data)
+      coverage.save
+      head :no_content
+    end
+  end
+end

data/config/routes.rb ADDED

@@ -0,0 +1,3 @@
+Jscov::Engine.routes.draw do
+  resources :coverages, only: %i[create]
+end

data/lib/jscov.rb ADDED

@@ -0,0 +1,28 @@
+require "securerandom"
+require "jscov/engine"
+require "jscov/railtie"
+require "jscov/configuration"
+module Jscov
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    def configure
+      yield configuration
+    end
+    delegate :enabled?, to: :configuration
+    def new_coverage_file_path
+      configuration.coverage_report_dir_path.join("jscov_#{Time.current.to_i}_#{SecureRandom.uuid}.json")
+    end
+    def clean!
+      dir_path = configuration.coverage_report_dir_path
+      FileUtils.rm_f(Dir.glob(dir_path.join("jscov_*.json")))
+      FileUtils.mkdir_p(dir_path)
+    end
+  end
+end

data/lib/jscov/configuration.rb ADDED

@@ -0,0 +1,16 @@
+module Jscov
+  class Configuration
+    attr_accessor :enabled, :coverage_report_dir_path
+    def initialize
+      reset!
+    end
+    alias enabled? enabled
+    def reset!
+      self.enabled = Rails.env.test?
+      self.coverage_report_dir_path = Rails.root.join("tmp/jscov")
+    end
+  end
+end

data/lib/jscov/coverage.rb ADDED

@@ -0,0 +1,13 @@
+module Jscov
+  class Coverage
+    def initialize(raw_data)
+      @raw_data = raw_data
+    end
+    def save
+      File.open(Jscov.new_coverage_file_path, "w") do |f|
+        f.puts @raw_data.to_json
+      end
+    end
+  end
+end

data/lib/jscov/engine.rb ADDED

@@ -0,0 +1,5 @@
+module Jscov
+  class Engine < ::Rails::Engine
+    isolate_namespace Jscov
+  end
+end

data/lib/jscov/helper.rb ADDED

@@ -0,0 +1,26 @@
+module Jscov
+  module Helper
+    def jscov_script_tag
+      return unless Jscov.enabled?
+      javascript_tag jscov_javascript_code
+    end
+    def jscov_javascript_code
+      <<~JS
+        (function () {
+          window.addEventListener('unload', uploadCoverage)
+          function uploadCoverage () {
+            const cov = window.__coverage__
+            if (!cov) { return }
+            const data = new FormData()
+            data.append('coverage', JSON.stringify(cov))
+            navigator.sendBeacon('#{jscov.coverages_path}', data)
+          }
+        })()
+      JS
+    end
+  end
+end

data/lib/jscov/railtie.rb ADDED

@@ -0,0 +1,11 @@
+require "jscov/helper"
+module Jscov
+  class Railtie < ::Rails::Railtie
+    initializer "jscov" do
+      ActiveSupport.on_load(:action_view) do
+        include Helper
+      end
+    end
+  end
+end

data/lib/jscov/rspec.rb ADDED

@@ -0,0 +1,7 @@
+require "jscov"
+RSpec.configure do |config|
+  config.before(:suite) do
+    Jscov.clean!
+  end
+end

data/lib/jscov/version.rb ADDED

@@ -0,0 +1,3 @@
+module Jscov
+  VERSION = '0.1.0'
+end

data/lib/tasks/jscov_tasks.rake ADDED

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jscov do
+#   # Task goes here
+# end

metadata ADDED

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jscov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuki Nishikawa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Jscov is a Rails Engine for collecting JavaScript code coverages.
+email:
+- kzkn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/jscov/application_controller.rb
+- app/controllers/jscov/coverages_controller.rb
+- config/routes.rb
+- lib/jscov.rb
+- lib/jscov/configuration.rb
+- lib/jscov/coverage.rb
+- lib/jscov/engine.rb
+- lib/jscov/helper.rb
+- lib/jscov/railtie.rb
+- lib/jscov/rspec.rb
+- lib/jscov/version.rb
+- lib/tasks/jscov_tasks.rake
+homepage: https://github.com/kzkn/jscov
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Collect JavaScript code coverages.
+test_files: []