simplecov-html 0.3.2 → 0.13.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a569e518b4658566f6c74bde026cf0b489b16ff7b9f541fbeae4bf44754fa6d7
+  data.tar.gz: a67d0c6e72883aaed402a3d5a6e315b1536a7d4f6ceb968ef8d8d2378701299a
+SHA512:
+  metadata.gz: 00ffcd1b0f918e85bf88073dfe4df938e972575c8efec45195b376349b24775cad6ee0b7310fae8af910a8c9e45f9e2c55e554dbc2ff8458f6da6674f2d98637
+  data.tar.gz: bf5324db14d60e9f9a6c53569a5cd0effd8814b8e7d5ac5160416b12e1bcf05e2c839b5c51742a1c614f1370c353d7161f8ad9f286afa8028d2585302ab03981

data/CHANGELOG.md

@@ -0,0 +1,108 @@
+0.13.1 (2024-09-09)
+==================
+
+## Misc
+* Drop base64 dependency. See [#144](https://github.com/simplecov-ruby/simplecov-html/pull/144) (thanks [@Earlopain](https://github.com/Earlopain)).
+
+0.13.0 (2024-09-08)
+==================
+
+## Enhancements
+* Cache erb templates when generating report. See [#114](https://github.com/simplecov-ruby/simplecov-html/pull/114) (thanks [@fatkodima](https://github.com/fatkodima)).
+* Print branch coverage with line coverage. See [#103](https://github.com/simplecov-ruby/simplecov-html/pull/103) (thanks [@jeremyevans](https://github.com/jeremyevans)).
+* Add line number anchors. Thanks [@jantman](https://github.com/jantman) for the proposal [#49](https://github.com/simplecov-ruby/simplecov-html/issues/49) and [@nishidayuya](https://github.com/nishidayuya) for the patch [#106](https://github.com/simplecov-ruby/simplecov-html/pull/106)!
+* Add inline assets option. See [#107](https://github.com/simplecov-ruby/simplecov-html/pull/107) (thanks [@frankh](https://github.com/frankh)).
+* Make close button look better. See [#140](https://github.com/simplecov-ruby/simplecov-html/pull/140) (thanks [@anthony0030](https://github.com/anthony0030)).
+* Avoid "permission denied" errors by removing the destination before copying assets [#135](https://github.com/simplecov-ruby/simplecov-html/pull/135) (thanks [@tomeon](https://github.com/tomeon)).
+* Improve clarity of line and branch coverage format. See [#125](https://github.com/simplecov-ruby/simplecov-html/pull/125) (thanks [@joshuapinter](https://github.com/joshuapinter)).
+
+## Bugfixes
+* Avoid loading favicon.png that does not exist. See [#123](https://github.com/simplecov-ruby/simplecov-html/pull/123) (thanks [@yyamanoi1222](https://github.com/yyamanoi1222)).
+
+## Misc
+* Reduced gem size by not including development-only files.
+* Bundle jQuery 3.7.1. See [#108](https://github.com/simplecov-ruby/simplecov-html/issues/108) (thanks [@jgarland79](https://github.com/jgarland79) for reporting the issue).
+
+0.12.3 (2020-09-23)
+==================
+
+## Bugfixes
+* Relax ruby version requirement to work with Ruby 3.0 (next version, current `ruby-head`). Thanks [@byroot](https://github.com/byroot).
+
+0.12.2 (2020-02-27)
+==================
+
+## Bugfixes
+* Refreshing the page while a source file is open works again. Thanks [@HansBug](https://github.com/HansBug) for the report [#94](https://github.com/simplecov-ruby/simplecov-html/issues/94) and [@Tietew](https://github.com/Tietew) for the fix!
+
+0.12.1 (2020-02-23)
+==================
+
+Bugfix release to fix huge bugs that sadly test suit and maintainters didn't catch.
+
+## Bugfixes
+* Disable pagination and with it all files on 2nd page+ being broken/not able to open
+* Fix display of non ASCII characters, for this you have to upgrade to simplecov 0.18.3 though (it's handled in there)
+
+0.12.0 (2020-02-12)
+==================
+
+This release is basically a collection of long standing PRs finally merged.
+Yes it looks different, no it's not a redesign - just a side effect of lots of dependency updates to improve CSP compatibility.
+
+## Enhancements
+* The HTML should now be servable with CSP settings of `default-src 'none'; script-src 'self'; img-src 'self'; style-src 'self';`
+* File list is horizontally scrollable if the space doesn't suffice
+* numbers are now right aligned and displayed with the same number of decimals for easier comparison and reading.
+
+## Bugfixes
+* Make sorting icons appear again
+* close link tag which could cause problems when parsing as xhtml/xml
+* make sure encoding errors won't crash the formatter
+* When viewing a short source file while you have a big file list you will no longer be able to scroll on after the source file has ended
+
+
+
+0.11.0 (2020-01-28)
+=======
+
+This release goes together with simplecov 0.18 to bring branch coverage support to you. Please also check the notes of the beta releases.
+
+## Enhancements
+* Display total branch coverage percentage in the overview (if branch coverage enabled)
+
+0.11.0.beta2 (2020-01-19)
+=======
+
+## Enhancements
+* changed display of branch coverage to be `branch_type: hit_count` which should be more expressive and more intuitive
+* Cached lookup of whether we're doing branch coverage or not (should be faster)
+
+## Bugfixes
+* Fixed sorting of percent column (regression in previous release)
+
+0.11.0.beta1 (2020-01-05)
+========
+
+Changes ruby support to 2.4+, adds branch coverage support. Meant to be used with simplecov 0.18
+
+## Breaking Changes
+* Drops support for EOL'ed ruby versions, new support is ~> 2.4
+
+## Enhancements
+* Support/display of branch coverage from simplecov 0.18.0.beta1, little badges saying `hit_count, positive_or_negative` will appear next to lines if branch coverage is activated. `0, +` means positive branch was never hit, `2, -` means negative branch was hit twice
+* Encoding compatibility errors are now caught and printed out
+
+0.10.2 (2017-08-14)
+========
+
+## Bugfixes
+
+* Allow usage with frozen-string-literal-enabled. See [#56](https://github.com/simplecov-ruby/simplecov-html/pull/56) (thanks @pat)
+
+0.10.1 (2017-05-17)
+========
+
+## Bugfixes
+
+* circumvent a regression that happens in the new JRuby 9.1.9.0 release. See [#53](https://github.com/simplecov-ruby/simplecov-html/pull/53) thanks @koic

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Christoph Olszowka
+Copyright (c) 2010-2013 Christoph Olszowka
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,30 @@
+Default HTML formatter for SimpleCov
+====================================
+
+***Note: To learn more about SimpleCov, check out the main repo at https://github.com/simplecov-ruby/simplecov***
+
+Generates a nice HTML report of your SimpleCov ruby code coverage results on Ruby 2.4+ using client-side Javascript
+quite extensively.
+
+
+Note on Patches/Pull Requests
+-----------------------------
+
+The formatter itself has no actual tests. Instead, it is tested in the cucumber features of simplecov itself. If you
+modify the formatter, please make sure the simplecov test suites still pass by doing the following:
+
+  * Clone simplecov into the parent directory of your simplecov-html checkout
+  * `cd` there, run `bundle`
+  * You should end up with all dev dependencies installed and simplecov-html being used from your disk
+  * Run the tests (units and features)
+
+Please remember to add tests if you add functionality.
+
+**Important:** If you modify the JS/CSS assets, you'll have to precompile them using `rake assets:compile` - otherwise,
+your changes will not be included in your coverage reports.
+
+
+Copyright
+---------
+
+Copyright (c) 2010-2013 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -1,41 +1,55 @@
-require 'rubygems'
-require 'rake'
+# frozen_string_literal: true
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "simplecov-html"
-    gem.summary = %Q{HTML formatter for SimpleCov code coverage tool for ruby 1.9+}
-    gem.description = %Q{HTML formatter for SimpleCov code coverage tool for ruby 1.9+}
-    gem.email = "christoph at olszowka.de"
-    gem.homepage = "http://github.com/colszowka/simplecov-html"
-    gem.authors = ["Christoph Olszowka"]
-    gem.add_dependency "simplecov", "~> 0.3.0"
-    gem.add_development_dependency "shoulda", "= 2.10.3"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+# See https://github.com/simplecov-ruby/simplecov/issues/171
+desc "Set permissions on all files so they are compatible with both user-local and system-wide installs"
+task :fix_permissions do
+  system 'bash -c "find . -type f -exec chmod 644 {} \; && find . -type d -exec chmod 755 {} \;"'
 end
+# Enforce proper permissions on each build
+Rake::Task[:build].prerequisites.unshift :fix_permissions
 
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
   test.verbose = true
 end
 
-task :test => :check_dependencies
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    warn "Rubocop is disabled"
+  end
+end
+
+task default: [:test, :rubocop]
 
-task :default => :test
+namespace :assets do
+  desc "Compiles all assets"
+  task :compile do
+    puts "Compiling assets"
+    require "sprockets"
+    require "sprockets/sass_processor"
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    Sprockets.register_processor("text/css") do |input|
+      {data: input[:data].gsub(/(?<!-|_)url\(['"]?(.+?)['"]?\)/) { "asset-data-url(\"#{Regexp.last_match(1)}\")" }}
+    end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "simplecov-html #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+    Sprockets.register_processor "text/css", Sprockets::ScssProcessor
+
+    assets = Sprockets::Environment.new do |env|
+      env.append_path "assets/javascripts"
+      env.append_path "assets/stylesheets"
+      env.append_path "public"
+      env.js_compressor = :uglify
+      env.css_compressor = :scss
+    end
+    assets["application.js"].write_to("public/application.js")
+    assets["application.css"].write_to("public/application.css")
+  end
 end

data/lib/simplecov-html/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Formatter
+    class HTMLFormatter
+      VERSION = "0.13.1"
+    end
+  end
+end

data/lib/simplecov-html.rb

@@ -1,109 +1,166 @@
-require 'erb'
-require 'fileutils'
-require 'digest/sha1'
-require 'time'
-require 'simplecov'
-
-# Ensure we are using an compatible version of SimpleCov
-if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.3.0")
-  raise RuntimeError, "The version of SimpleCov you are using is too old. Please update with 'gem install simplecov'"
+# frozen_string_literal: true
+
+require "erb"
+require "cgi"
+require "fileutils"
+require "digest/sha1"
+require "time"
+
+# Ensure we are using a compatible version of SimpleCov
+major, minor, patch = SimpleCov::VERSION.scan(/\d+/).first(3).map(&:to_i)
+if major < 0 || minor < 9 || patch < 0
+  raise "The version of SimpleCov you are using is too old. " \
+        "Please update with `gem install simplecov` or `bundle update simplecov`"
 end
 
-class SimpleCov::Formatter::HTMLFormatter
-  VERSION = File.read(File.join(File.dirname(__FILE__), '../VERSION')).strip.chomp
-  
-  def format(result)
-    Dir[File.join(File.dirname(__FILE__), '../assets/*')].each do |path|
-      FileUtils.cp_r(path, asset_output_path)
-    end
-    
-    File.open(File.join(output_path, "index.html"), "w+") do |file|
-      file.puts template('layout').result(binding)
-    end
-    puts "Coverage report generated for #{result.command_name} to #{output_path}"
-  end
-  
-  private
-  
-  # Returns the an erb instance for the template of given name
-  def template(name)
-    ERB.new(File.read(File.join(File.dirname(__FILE__), '../views/', "#{name}.erb")))
-  end
-  
-  def output_path
-    SimpleCov.coverage_path
-  end
-  
-  def asset_output_path
-    return @asset_output_path if @asset_output_path
-    @asset_output_path = File.join(output_path, 'assets', SimpleCov::Formatter::HTMLFormatter::VERSION)
-    FileUtils.mkdir_p(@asset_output_path)
-    @asset_output_path
-  end
-  
-  def assets_path(name)
-    File.join('./assets', SimpleCov::Formatter::HTMLFormatter::VERSION, name)
-  end
-  
-  # Returns the html for the given source_file
-  def formatted_source_file(source_file)
-    template('source_file').result(binding)
-  end
-  
-  # Returns a table containing the given source files
-  def formatted_file_list(title, source_files)
-    template('file_list').result(binding)
-  end
-  
-  # Computes the coverage based upon lines covered and lines missed
-  def coverage(file_list)
-    return 100.0 if file_list.length == 0
-    lines_missed = file_list.map {|f| f.missed_lines.count }.inject(&:+)
-    
-    lines_covered(file_list) * 100 / lines_of_code(file_list).to_f
-  end
-  
-  def lines_of_code(file_list)
-    lines_missed(file_list) + lines_covered(file_list)
-  end
-  
-  def lines_covered(file_list)
-    return 0.0 if file_list.length == 0
-    file_list.map {|f| f.covered_lines.count }.inject(&:+)
-  end
-  
-  def lines_missed(file_list)
-    return 0.0 if file_list.length == 0
-    file_list.map {|f| f.missed_lines.count }.inject(&:+)
-  end
-  
-  def coverage_css_class(covered_percent)
-    if covered_percent > 90
-      'green'
-    elsif covered_percent > 80
-      'yellow'
-    else
-      'red'
+module SimpleCov
+  module Formatter
+    class HTMLFormatter
+      def initialize
+        @branchable_result = SimpleCov.branch_coverage?
+        @templates = {}
+        @inline_assets = !ENV["SIMPLECOV_INLINE_ASSETS"].nil?
+        @public_assets_dir = File.join(File.dirname(__FILE__), "../public/")
+      end
+
+      def format(result)
+        unless @inline_assets
+          Dir[File.join(@public_assets_dir, "*")].each do |path|
+            FileUtils.cp_r(path, asset_output_path, remove_destination: true)
+          end
+        end
+
+        File.open(File.join(output_path, "index.html"), "wb") do |file|
+          file.puts template("layout").result(binding)
+        end
+        puts output_message(result)
+      end
+
+    private
+
+      def branchable_result?
+        # cached in initialize because we truly look it up a whole bunch of times
+        # and it's easier to cache here then in SimpleCov because there we might
+        # still enable/disable branch coverage criterion
+        @branchable_result
+      end
+
+      def line_status?(source_file, line)
+        if branchable_result? && source_file.line_with_missed_branch?(line.number)
+          "missed-branch"
+        else
+          line.status
+        end
+      end
+
+      def output_message(result)
+        output = "Coverage report generated for #{result.command_name} to #{output_path}."
+        output += "\nLine Coverage: #{result.covered_percent.round(2)}% (#{result.covered_lines} / #{result.total_lines})"
+        output += "\nBranch Coverage: #{result.coverage_statistics[:branch].percent.round(2)}% (#{result.covered_branches} / #{result.total_branches})" if branchable_result?
+        output
+      end
+
+      # Returns the an erb instance for the template of given name
+      def template(name)
+        @templates[name] ||= ERB.new(File.read(File.join(File.dirname(__FILE__), "../views/", "#{name}.erb")))
+      end
+
+      def output_path
+        SimpleCov.coverage_path
+      end
+
+      def asset_output_path
+        return @asset_output_path if defined?(@asset_output_path) && @asset_output_path
+
+        @asset_output_path = File.join(output_path, "assets", SimpleCov::Formatter::HTMLFormatter::VERSION)
+        FileUtils.mkdir_p(@asset_output_path)
+        @asset_output_path
+      end
+
+      def assets_path(name)
+        return asset_inline(name) if @inline_assets
+
+        File.join("./assets", SimpleCov::Formatter::HTMLFormatter::VERSION, name)
+      end
+
+      # Only have a few content types, just hardcode them
+      CONTENT_TYPES = {
+        ".js" => "text/javascript",
+        ".png" => "image/png",
+        ".gif" => "image/gif",
+        ".css" => "text/css",
+      }.freeze
+
+      def asset_inline(name)
+        path = File.join(@public_assets_dir, name)
+        # Equivalent to `Base64.strict_encode64(File.read(path))` but without depending on Base64
+        base64_content = [File.read(path)].pack("m0")
+
+        content_type = CONTENT_TYPES[File.extname(name)]
+
+        "data:#{content_type};base64,#{base64_content}"
+      end
+
+      # Returns the html for the given source_file
+      def formatted_source_file(source_file)
+        template("source_file").result(binding)
+      rescue Encoding::CompatibilityError => e
+        puts "Encoding problems with file #{source_file.filename}. Simplecov/ERB can't handle non ASCII characters in filenames. Error: #{e.message}."
+      end
+
+      # Returns a table containing the given source files
+      def formatted_file_list(title, source_files)
+        title_id = title.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-_]/, "")
+        # Silence a warning by using the following variable to assign to itself:
+        # "warning: possibly useless use of a variable in void context"
+        # The variable is used by ERB via binding.
+        title_id = title_id # rubocop:disable Lint/SelfAssignment
+        template("file_list").result(binding)
+      end
+
+      def covered_percent(percent)
+        template("covered_percent").result(binding)
+      end
+
+      def coverage_css_class(covered_percent)
+        if covered_percent > 90
+          "green"
+        elsif covered_percent > 80
+          "yellow"
+        else
+          "red"
+        end
+      end
+
+      def strength_css_class(covered_strength)
+        if covered_strength > 1
+          "green"
+        elsif covered_strength == 1
+          "yellow"
+        else
+          "red"
+        end
+      end
+
+      # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
+      def id(source_file)
+        Digest::SHA1.hexdigest(source_file.filename)
+      end
+
+      def timeago(time)
+        "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+      end
+
+      def shortened_filename(source_file)
+        source_file.filename.sub(SimpleCov.root, ".").gsub(/^\.\//, "")
+      end
+
+      def link_to_source_file(source_file)
+        %(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>)
+      end
     end
   end
-  
-  # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
-  def id(source_file)
-    Digest::SHA1.hexdigest(source_file.filename)
-  end
-  
-  def timeago(time)
-    "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
-  end
-  
-  def shortened_filename(source_file)
-    source_file.filename.gsub(SimpleCov.root, '.')
-  end
-  
-  def link_to_source_file(source_file)
-    %Q(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>)
-  end
 end
 
-# Set up the html formatter
-SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require "simplecov-html/version"