simplecov-inline-html 0.0.1

data/lib/simplecov-inline-html.rb

@@ -0,0 +1,104 @@
+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
+
+module SimpleCov
+  module Formatter
+    class InlineHTMLFormatter
+      def format(result)
+        File.open(File.join(output_path, "index.html"), "wb") do |file|
+          file.puts template("layout").result(binding)
+        end
+        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 file(name)
+        File.read(File.join(File.dirname(__FILE__), name))
+      end
+
+      # Returns the an erb instance for the template of given name
+      def template(name)
+        ERB.new(file("../views/#{name}.erb"))
+      end
+
+      def output_path
+        SimpleCov.coverage_path
+      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)
+        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
+        template("file_list").result(binding)
+      end
+
+      def data_image(filename)
+        _name, type = filename.split(".")
+        "data:image/#{type};base64,#{Base64.encode64(file("../assets/#{filename}"))}"
+      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
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require "simplecov-inline-html/version"

data/lib/simplecov-inline-html/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    class InlineHTMLFormatter
+      VERSION = "0.0.1".freeze
+    end
+  end
+end

data/simplecov-inline-html.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "simplecov-inline-html/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "simplecov-inline-html"
+  gem.version     = SimpleCov::Formatter::InlineHTMLFormatter::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Jon Rowe"]
+  gem.email       = ["hello@jonrowe.co.uk"]
+  gem.homepage    = "https://github.com/JonRowe/simplecov-inline-html"
+  gem.description = %(Inline HTML formatter for SimpleCov code coverage tool.)
+  gem.summary     = gem.description
+  gem.license     = "MIT"
+
+  gem.required_ruby_version = "~> 2.4"
+  gem.add_development_dependency "bundler", "~> 1.9"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

data/views/file_list.erb

@@ -0,0 +1,45 @@
+<div class="file_list_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (<span class="covered_percent"><span class="<%= coverage_css_class(source_files.covered_percent) %>"><%= source_files.covered_percent.round(2) %>%</span></span>
+     covered at
+     <span class="covered_strength">
+       <span class="<%= strength_css_class(source_files.covered_strength) %>">
+         <%= source_files.covered_strength.round(2) %>
+       </span>
+    </span> hits/line)
+  </h2>
+  <a name="<%= title_id %>"></a>
+  <div>
+    <b><%= source_files.length %></b> files in total.
+    <b><%= source_files.lines_of_code %></b> relevant lines.
+    <span class="green"><b><%= source_files.covered_lines %></b> lines covered</span> and
+    <span class="red"><b><%= source_files.missed_lines %></b> lines missed </span>
+  </div>
+  <table class="file_list">
+    <thead>
+      <tr>
+        <th>File</th>
+        <th>% covered</th>
+        <th>Lines</th>
+        <th>Relevant Lines</th>
+        <th>Lines covered</th>
+        <th>Lines missed</th>
+        <th>Avg. Hits / Line</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% source_files.each do |source_file| %>
+      <tr>
+        <td class="strong"><%= link_to_source_file(source_file) %></td>
+        <td class="<%= coverage_css_class(source_file.covered_percent) %> strong"><%= source_file.covered_percent.round(2).to_s %> %</td>
+        <td><%= source_file.lines.count %></td>
+        <td><%= source_file.covered_lines.count + source_file.missed_lines.count %></td>
+        <td><%= source_file.covered_lines.count %></td>
+        <td><%= source_file.missed_lines.count %></td>
+        <td><%= source_file.covered_strength %></td>
+      </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/views/layout.erb

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title>Code coverage for <%= SimpleCov.project_name %></title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <link rel="shortcut icon" type="image/png" href="<%= data_image("favicon_#{coverage_css_class(result.source_files.covered_percent)}.png") %>" />
+    <style>
+      <%= file("../assets/application.css") %>
+    </style>
+    <script type="text/javascript">
+      <%= file("../assets/application.js") %>
+    </script>
+  </head>
+
+  <body>
+    <div id="loading">
+      <img src="<%= data_image('loading.gif') %>" alt="loading"/>
+    </div>
+    <div id="wrapper" style="display: none;">
+      <div class="timestamp">Generated <%= timeago(Time.now) %></div>
+      <ul class="group_tabs"></ul>
+
+      <div id="content">
+        <%= formatted_file_list("All Files", result.source_files) %>
+
+        <% result.groups.each do |name, files| %>
+          <%= formatted_file_list(name, files) %>
+        <% end %>
+      </div>
+
+      <div id="footer">
+        Generated by <a href="http://github.com/colszowka/simplecov">simplecov</a> v<%= SimpleCov::VERSION %>
+        and simplecov-inlinehtml v<%= SimpleCov::Formatter::InlineHTMLFormatter::VERSION %><br/>
+        using <%= result.command_name %>
+      </div>
+
+      <div class="source_files">
+      <% result.source_files.each do |source_file| %>
+        <%= formatted_source_file(source_file) %>
+      <% end %>
+      </div>
+    </div>
+  </body>
+</html>

data/views/source_file.erb

@@ -0,0 +1,23 @@
+<div class="source_table" id="<%= id source_file %>">
+  <div class="header">
+    <h3><%= shortened_filename source_file %></h3>
+    <h4><span class="<%= coverage_css_class(source_file.covered_percent) %>"><%= source_file.covered_percent.round(2).to_s %> %</span> covered</h4>
+    <div>
+      <b><%= source_file.lines_of_code %></b> relevant lines.
+      <span class="green"><b><%= source_file.covered_lines.count %></b> lines covered</span> and
+      <span class="red"><b><%= source_file.missed_lines.count %></b> lines missed.</span>
+    </div>
+  </div>
+
+  <pre>
+    <ol>
+      <% source_file.lines.each do |line| %>
+        <li class="<%= line.status %>" data-hits="<%= line.coverage ? line.coverage : '' %>" data-linenumber="<%= line.number %>">
+          <% if line.covered? %><span class="hits"><%= line.coverage %></span><% end %>
+          <% if line.skipped? %><span class="hits">skipped</span><% end %>
+          <code class="ruby"><%= CGI.escapeHTML(line.src.chomp) %></code>
+        </li>
+      <% end %>
+    </ol>
+  </pre>
+</div>

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-inline-html
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Inline HTML formatter for SimpleCov code coverage tool.
+email:
+- hello@jonrowe.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/application.css
+- assets/application.js
+- assets/favicon_green.png
+- assets/favicon_red.png
+- assets/favicon_yellow.png
+- assets/loading.gif
+- assets/magnify.png
+- lib/simplecov-inline-html.rb
+- lib/simplecov-inline-html/version.rb
+- simplecov-inline-html.gemspec
+- views/file_list.erb
+- views/layout.erb
+- views/source_file.erb
+homepage: https://github.com/JonRowe/simplecov-inline-html
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Inline HTML formatter for SimpleCov code coverage tool.
+test_files: []