simplecov_html_inline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4f0ec856cffec37d6772b8f4c428c7f20f8001bcf7f064c0413f34fef887ebe
+  data.tar.gz: 88ec81a6728eb27b9985c1e6a5bbe72f6060a31ffbf0a674ddbe75927884b6a3
+SHA512:
+  metadata.gz: 6c9c628692d7b37dad9648075621fe6ac57734497e3d569ee1b35ac6bbb56b759b988b49bb1ff1d95f842fbe5ea432274187c7d863dd8be3c689f605b362c4ba
+  data.tar.gz: 46ab7630741a579b5c3c0ffaf9cf103c2cd0b7ef1c6fbb1cca7e85c1c0940aed6b54759b9068faa9c900d1da4170d2085c79bca7c2161313704d6432f5f4490d

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle
+/.byebug_history
+/Gemfile.lock
+/coverage
+/spec/tmp
+
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'byebug'
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Toby Hsieh
+
+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,16 @@
+# simplecov\_html\_inline
+
+This is a Ruby gem that contains `SimplecovHtmlInline::Formatter`, a [SimpleCov](https://github.com/simplecov-ruby/simplecov) formatter based on [simplecov-html](https://github.com/simplecov-ruby/simplecov-html) that uses inline/embedded assets (via data URIs).
+
+This is useful for cases such as using continuous integration software that publishes artifacts to a private S3 bucket and lets you view artifacts by responding with a redirect to a signed S3 URL. With simplecov-html, the index.html file won't work because it uses relative URLs for assets, which do not have S3 signatures.
+
+## Usage
+
+```ruby
+require 'simplecov'
+require 'simplecov_html_inline'
+
+SimpleCov.start do
+  formatter SimplecovHtmlInline::Formatter
+end
+```

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/simplecov_html_inline.rb

@@ -0,0 +1,2 @@
+require 'simplecov_html_inline/formatter'
+require 'simplecov_html_inline/version'

data/lib/simplecov_html_inline/formatter.rb

@@ -0,0 +1,66 @@
+require 'base64'
+
+require 'simplecov'
+require 'simplecov-html'
+
+class SimplecovHtmlInline
+  # A SimpleCov formatter based on {SimpleCov::Formatter::HTMLFormatter} that
+  # uses inline/embedded assets
+  class Formatter < SimpleCov::Formatter::HTMLFormatter
+    # Mapping from file extension to media type
+    MEDIA_TYPE_MAPPING = {
+      '.css' => 'text/css',
+      '.gif' => 'image/gif',
+      '.js' => 'text/javascript',
+      '.png' => 'image/png',
+    }.freeze
+
+    # Directory where simplecov-html assets live
+    PUBLIC_DIR = Gem.find_latest_files(
+      'simplecov-html.rb'
+    ).first.then do |simplecov_html_rb_path|
+      dir = File.join(File.dirname(simplecov_html_rb_path), '..', 'public')
+      File.absolute_path(dir).freeze
+    end
+
+    # Creates an HTML coverage report with inline assets
+    #
+    # @param result [SimpleCov::Result] the SimpleCov result to format
+    def format(result)
+      # Same as SimpleCov::Formatter::HTMLFormatter#format except we omit the
+      # copying of asset files
+      File.open(File.join(output_path, 'index.html'), 'wb') do |file|
+        file.puts template('layout').result(binding)
+      end
+      puts output_message(result)
+    end
+
+    private
+
+    # Constructs a data URI for an asset with the given name.
+    #
+    # @note
+    #   This overrides {SimpleCov::Formatter::HTMLFormatter#assets_path} (which
+    #   returns a relative URL)
+    #
+    # @param name [String]
+    #   name of file (relative to simplecov-html's public directory) to return
+    #   a data URI for
+    # @return [String]
+    #   data URI for the asset, or an empty string if an asset with the given
+    #   name does not exist
+    def assets_path(name)
+      file_path = File.join(PUBLIC_DIR, name)
+      return '' unless File.exist?(file_path)
+
+      media_type = MEDIA_TYPE_MAPPING.fetch(File.extname(name))
+      contents = IO.read(file_path)
+
+      if media_type == 'text/css'
+        contents.gsub!(/url\(['"]?(.+?)['"]?\)/) { "url(#{assets_path($1)})" }
+      end
+
+      "data:#{media_type};base64,#{Base64.strict_encode64(contents)}"
+    end
+  end
+end

data/lib/simplecov_html_inline/version.rb

@@ -0,0 +1,3 @@
+class SimplecovHtmlInline
+  VERSION = IO.read(File.join(__dir__, '..', '..', 'VERSION')).chomp
+end

data/simplecov_html_inline.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'simplecov_html_inline'
+  s.version = IO.read('VERSION').chomp
+  s.authors = ['Toby Hsieh']
+  s.homepage = 'https://github.com/tobyhs/simplecov_html_inline'
+  s.summary = 'SimpleCov HTML formatter with inline assets'
+  s.description = 'Formatter based on simplecov-html that uses inline/embedded assets'
+  s.license = 'MIT'
+
+  s.add_dependency 'simplecov', '~> 0.21'
+
+  s.add_development_dependency 'rspec', '~> 3.10'
+  s.add_development_dependency 'selenium-webdriver', '~> 3.142'
+
+  s.files = `git ls-files`.split($/)
+end

data/spec/fixtures/test1.rb

@@ -0,0 +1,5 @@
+module Test1
+  def self.testing
+    puts 'testing'
+  end
+end

data/spec/fixtures/test2.rb

@@ -0,0 +1,9 @@
+module Test2
+  def self.abs(number)
+    if number >= 0
+      number
+    else
+      -number
+    end
+  end
+end

data/spec/simplecov_html_inline/formatter_spec.rb

@@ -0,0 +1,86 @@
+require 'selenium-webdriver'
+
+require 'simplecov_html_inline/formatter'
+
+RSpec.describe SimplecovHtmlInline::Formatter do
+  let(:coverage_path) { 'spec/tmp/coverage' }
+  subject(:formatter) { described_class.new }
+
+  describe '#format' do
+    let(:original_result) do
+      {
+        'spec/fixtures/test1.rb' => { 'lines' => [1, 1, 1, nil, nil] },
+        'spec/fixtures/test2.rb' => {
+          'lines' => [1, 1, 1, 1, nil, 0, nil, nil, nil],
+        },
+      }.transform_keys(&File.method(:absolute_path))
+    end
+
+    let(:result) do
+      SimpleCov::Result.new(
+        original_result,
+        command_name: 'TestTest',
+        created_at: Time.at(1615761100)
+      )
+    end
+
+    let(:web_driver) { Selenium::WebDriver.for(:chrome) }
+
+    before do
+      FileUtils.rm_rf(coverage_path)
+      FileUtils.mkdir_p(coverage_path)
+      allow(SimpleCov).to receive(:coverage_path).and_return(coverage_path)
+      # spec_helper.rb adds a filter that only includes lib/ files, so we need
+      # to stub this here so spec/fixtures/ files are included
+      allow(SimpleCov).to receive(:filters).and_return([])
+    end
+
+    after do
+      web_driver.quit
+    end
+
+    it 'creates an HTML coverage report with inline assets' do
+      formatter.format(result)
+
+      index_path = File.join(Dir.pwd, coverage_path, 'index.html')
+      web_driver.get("file://#{index_path}")
+
+      aggregate_failures do
+        # Check that the JavaScript file is inline
+        script_element = web_driver.find_element(:tag_name, 'script')
+        expect(script_element.attribute('src')).to start_with(
+          'data:text/javascript;base64,'
+        )
+
+        # Check that the CSS file is inline
+        css_element = web_driver.find_element(css: 'link[rel="stylesheet"]')
+        css_data_uri = css_element.attribute('href')
+        expect(css_data_uri).to start_with('data:text/css;base64,')
+
+        # Check that the image URLs in the CSS file are data URIs
+        css_content = css_data_uri.split(',', 2)[1]
+        css_content = Base64.strict_decode64(css_content)
+        css_content.scan(/url\((.+?)\)/) do |match|
+          expect(match[0]).to match(%r{\Adata:image/[a-z]+;base64,})
+        end
+
+        # Check that clicking a file shows its source
+        file_name = 'spec/fixtures/test1.rb'
+        file_a_element = web_driver.find_element(css: "a[title='#{file_name}']")
+        file_a_element.click
+
+        file_id = file_a_element.attribute('href').split('#').last
+        source_table = web_driver.find_element(id: file_id)
+        expect(source_table).to be_displayed
+
+        web_driver.find_element(id: 'cboxClose').click
+        Selenium::WebDriver::Wait.new(
+          message: 'Source table for file did not close',
+          timeout: 1,
+        ).until do
+          !source_table.displayed?
+        end
+      end
+    end
+  end
+end

data/spec/simplecov_html_inline/version_spec.rb

@@ -0,0 +1,7 @@
+require 'simplecov_html_inline/version'
+
+RSpec.describe 'SimplecovHtmlInline::VERSION' do
+  it 'resembles a version string' do
+    expect(SimplecovHtmlInline::VERSION).to match(/\A\d+\.\d+\.\d+\z/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter { |src_file| !src_file.project_filename.start_with?('/lib/') }
+
+  # Using this odd technique so 'simplecov_html_inline' can be required after
+  # SimpleCov starts coverage
+  formatter_wrapper = Object.new
+  def formatter_wrapper.new
+    SimplecovHtmlInline::Formatter.new
+  end
+  formatter formatter_wrapper
+end
+
+require 'simplecov_html_inline'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_html_inline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toby Hsieh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.142'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.142'
+description: Formatter based on simplecov-html that uses inline/embedded assets
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- lib/simplecov_html_inline.rb
+- lib/simplecov_html_inline/formatter.rb
+- lib/simplecov_html_inline/version.rb
+- simplecov_html_inline.gemspec
+- spec/fixtures/test1.rb
+- spec/fixtures/test2.rb
+- spec/simplecov_html_inline/formatter_spec.rb
+- spec/simplecov_html_inline/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tobyhs/simplecov_html_inline
+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.1.4
+signing_key:
+specification_version: 4
+summary: SimpleCov HTML formatter with inline assets
+test_files: []