simplecov-html 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 521389c06ee24e47f7547ed6711ed500672dde0c9489802d77f0a626536bc7a3
-  data.tar.gz: 209a5a8e7dad6f2840efb3d7c3c05ce13ef9a64ff05550016b22157f56aeade2
+  metadata.gz: 39f6a1e464a4a4dc7f8909490225ad044486055ae1cefe8978738c95651c9ad8
+  data.tar.gz: b406a23cdb0e57671df0e919073aabb7147b0166521c630ac39ab3c0bf659af4
 SHA512:
-  metadata.gz: 7f9f0eb594a25f55bb3a5f16ecc9e46392a71c959754e36b976403943b81090f6e68bc125f4447ebc5ff9b253c52865e9e63678b03528f286ad48327b18429c3
-  data.tar.gz: 962890a18f9615e03c8a4b3e06392a315a8c7194cad69b7a0a3a32a0a9760f7ebc640a418a8f12d76207883e480c8c22e748a96d44348a9484dd7bb1d04cda39
+  metadata.gz: 9cecd560f071e8b9f37b7fa70354c49748704f69d318a35e844cfe03848fba01b01bdb4d4e973c5219d0aeda318e5f4abc143e78d4beaeca13b27e1ae94594b5
+  data.tar.gz: 51b3f7d1541d4a9bddb1e05a20a0c03dc6cde3885c366b914dfd4bdb4dbdea2283a26bfd648b631e1deda38acd4cd6d91d131c3271b6fafe95e4d82272328d6f

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.5
+ruby 2.7.1

data/CHANGELOG.md

@@ -1,8 +1,33 @@
+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/colszowka/simplecov-html/issues/94) and [@Tietew](https://github.com/Tietew) for the fix!
+* 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)
 ==================
@@ -30,6 +55,8 @@ Yes it looks different, no it's not a redesign - just a side effect of lots of d
 * 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)
 =======
 
@@ -65,11 +92,11 @@ Changes ruby support to 2.4+, adds branch coverage support. Meant to be used wit
 
 ## Bugfixes
 
-* Allow usage with frozen-string-literal-enabled. See [#56](https://github.com/colszowka/simplecov-html/pull/56) (thanks @pat)
+* 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/colszowka/simplecov-html/pull/53) thanks @koic
+* 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/README.md

@@ -1,7 +1,7 @@
 Default HTML formatter for SimpleCov
 ====================================
 
-***Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/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.

data/Rakefile

@@ -3,7 +3,7 @@
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-# See https://github.com/colszowka/simplecov/issues/171
+# 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 {} \;"'
@@ -27,18 +27,27 @@ rescue LoadError
   end
 end
 
-task :default => [:test, :rubocop]
+task default: [:test, :rubocop]
 
 namespace :assets do
   desc "Compiles all assets"
   task :compile do
     puts "Compiling assets"
     require "sprockets"
+    require "sprockets/sass_processor"
+
+    Sprockets.register_processor("text/css") do |input|
+      {data: input[:data].gsub(/(?<!-|_)url\(['"]?(.+?)['"]?\)/) { "asset-data-url(\"#{Regexp.last_match(1)}\")" }}
+    end
+
+    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 = :yui
+      env.css_compressor = :scss
     end
     assets["application.js"].write_to("public/application.js")
     assets["application.css"].write_to("public/application.css")

data/lib/simplecov-html/version.rb

@@ -3,7 +3,7 @@
 module SimpleCov
   module Formatter
     class HTMLFormatter
-      VERSION = "0.12.2"
+      VERSION = "0.13.0"
     end
   end
 end

data/lib/simplecov-html.rb

@@ -5,12 +5,13 @@ require "cgi"
 require "fileutils"
 require "digest/sha1"
 require "time"
+require "base64"
 
 # 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`"
+  raise "The version of SimpleCov you are using is too old. " \
+        "Please update with `gem install simplecov` or `bundle update simplecov`"
 end
 
 module SimpleCov
@@ -18,11 +19,16 @@ module SimpleCov
     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)
-        Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path|
-          FileUtils.cp_r(path, asset_output_path)
+        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|
@@ -31,9 +37,7 @@ module SimpleCov
         puts output_message(result)
       end
 
-      def output_message(result)
-        "Coverage report generated for #{result.command_name} to #{output_path}. #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
-      end
+    private
 
       def branchable_result?
         # cached in initialize because we truly look it up a whole bunch of times
@@ -50,11 +54,16 @@ module SimpleCov
         end
       end
 
-    private
+      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)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), "../views/", "#{name}.erb")))
+        @templates[name] ||= ERB.new(File.read(File.join(File.dirname(__FILE__), "../views/", "#{name}.erb")))
       end
 
       def output_path
@@ -70,9 +79,28 @@ module SimpleCov
       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)
+        base64_content = Base64.strict_encode64 File.read(path)
+
+        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)
@@ -82,11 +110,11 @@ module SimpleCov
 
       # 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\-\_]/, "")
+        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
+        title_id = title_id # rubocop:disable Lint/SelfAssignment
         template("file_list").result(binding)
       end