simplecov-material 0.2.0

data/simplecov-material.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simplecov-material/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov-material"
+  spec.version       = SimpleCov::Formatter::MaterialFormatter::VERSION
+  spec.authors       = ["Christopher Pezza"]
+  spec.email         = ["chiefpansancolt@gmail.com"]
+  spec.summary       = "HTML Material Design View for Simplecov formatter"
+  spec.description   = %q(HTML Material Design View of Simplecov as a formatter
+                          that is clean, easy to read.)
+  spec.homepage      = "https://github.com/chiefpansancolt/simplecov-material"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chiefpansancolt/simplecov-material"
+  spec.metadata["changelog_uri"] = "https://github.com/chiefpansancolt/simplecov-material/blob/master/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/chiefpansancolt/simplecov-material/issues"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "bin"
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "simplecov", ">= 0.16.0"
+end

data/test/fixtures/app/controllers/sample_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Foo class
+class Foo
+  def initialize
+    @foo = "baz"
+  end
+
+  def bar
+    @foo
+  end
+end

data/test/fixtures/app/models/user.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Foo class
+class Foo
+  def initialize
+    @foo = "baz"
+  end
+
+  def bar
+    @foo
+  end
+end

data/test/fixtures/sample.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Foo class
+class Foo
+  def initialize
+    @foo = "baz"
+  end
+
+  def bar
+    @foo
+  end
+end

data/test/simplecov-material/simplecov_material_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "simplecov"
+require "simplecov-material"
+require "simplecov-material/version"
+
+class SimplecovMaterialTest < Minitest::Test
+  def test_defined
+    assert defined?(SimpleCov::Formatter::MaterialFormatter)
+    assert defined?(SimpleCov::Formatter::MaterialFormatter::VERSION)
+  end
+
+  def test_version
+    version = SimpleCov::Formatter::MaterialFormatter::VERSION
+
+    assert(!version.nil?)
+  end
+
+  def test_execution # rubocop:disable MethodLength
+    @original_result = {
+      source_fixture("sample.rb") => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil],
+      source_fixture("app/models/user.rb") => [
+        nil, 1, 1, 1, nil, nil, 1, 0, nil, nil
+      ],
+      source_fixture("app/controllers/sample_controller.rb") => [
+        nil, 1, 1, 1, nil, nil, 0, 0, nil, nil
+      ]
+    }
+
+    @result = SimpleCov::Result.new(@original_result)
+    SimpleCov::Formatter::MaterialFormatter.new.format(@result)
+
+    assert(File.exist?("/#{SimpleCov.coverage_path}/index.html"))
+  end
+
+  def source_fixture(filename)
+    File.expand_path(File.join(File.dirname(__FILE__), "fixtures", filename))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::MaterialFormatter
+]
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/ci"
+require "mocha/minitest"

data/views/dialog.erb

@@ -0,0 +1,51 @@
+<div class="mdc-dialog" role="alertdialog" aria-modal="true"
+     aria-labelledby="<%= shortened_filename(file) %>"
+     id="<%= shortened_filename(file) %>-dialog">
+  <div class="mdc-dialog__container">
+    <div class="mdc-dialog__surface">
+      <h2 class="mdc-dialog__title">
+        <%= shortened_filename file %>
+        <span class="parenthese">
+          <span class="<%= coverage_class(file.covered_percent) %>">
+              <%= file.covered_percent.round(2).to_s %>%
+          </span>
+        </span>
+      </h2>
+
+      <div class="mdc-dialog__content">
+        <pre>
+          <ol>
+            <% 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>
+
+      <footer class="mdc-dialog__actions">
+        <div class="text">
+          <b><%= file.lines_of_code %></b> Relevant Lines
+          |
+          <span class="green"><b>
+            <%= format_number(file.covered_lines.count) %>
+          </b></span> Lines Covered
+          |
+          <span class="red"><b>
+            <%= format_number(file.missed_lines.count) %>
+          </b></span> Lines Missed
+        </div>
+        <div class="buttons">
+          <button type="button" class="mdc-button mdc-button--raised mdc-dialog__button" data-mdc-dialog-action="close">
+            <span class="mdc-button__label">close</span>
+          </button>
+        </div>
+      </footer>
+    </div>
+  </div>
+  <div class="mdc-dialog__scrim"></div>
+</div>

data/views/group_page.erb

@@ -0,0 +1,110 @@
+<div class="tab-groups" name="<%= title_id %>" style="<%= hide_show(title_id) %>">
+  <div class="mdc-layout-grid">
+    <div class="mdc-layout-grid__inner">
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title">Covered</p>
+          <h4 class="card-data mdc-typography--headline4 <%= coverage_class(files.covered_percent) %>">
+              <%= files.covered_percent.round(2) %>%
+          </h4>
+        </div>
+      </div>
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title">Hits/Line</p>
+          <h4 class="card-data mdc-typography--headline4 <%= strength_class(files.covered_strength) %>">
+              <%= files.covered_strength.round(2) %>
+          </h4>
+        </div>
+      </div>
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title"># of Files</p>
+          <h4 class="card-data mdc-typography--headline4">
+            <%= format_number(files.length) %>
+          </h4>
+        </div>
+      </div>
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title">Relevent Lines</p>
+          <h4 class="card-data mdc-typography--headline4">
+            <%= format_number(files.lines_of_code) %>
+          </h4>
+        </div>
+      </div>
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title">Lines Covered</p>
+          <h4 class="card-data mdc-typography--headline4 green">
+            <%= format_number(files.covered_lines) %>
+          </h4>
+        </div>
+      </div>
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-2">
+        <div class="mdc-card card-tile">
+          <p class="card-title">Lines Missed</p>
+          <h4 class="card-data mdc-typography--headline4 red">
+            <%= format_number(files.missed_lines) %>
+          </h4>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <div class="mdc-card mdc-card--outlined">
+    <div class="mdc-text-field mdc-text-field--with-trailing-icon">
+      <i class="material-icons mdc-text-field__icon">search</i>
+      <input type="search" class="mdc-text-field__input search-box" onkeyup="searchTable(this.id)" onsearch="searchTable(this.id)" id="<%= title_id %>">
+      <div class="mdc-line-ripple"></div>
+      <label for="text-field-hero-input" class="mdc-floating-label">Search</label>
+    </div>
+    <div class="mdc-text-field-helper-text mdc-text-field-helper-text--persistent" aria-hidden="false">
+      You can search based on File column.
+    </div>
+
+    <table class="table table-hover table-condensed" id="<%= title_id %>-table">
+        <thead>
+          <tr>
+            <th class="width-50">File</th>
+            <th class="width-9 center">% Covered</th>
+            <th class="width-5 center">Lines</th>
+            <th class="width-9 center">Relevant Lines</th>
+            <th class="width-9 center">Lines Covered</th>
+            <th class="width-9 center">Lines Missed</th>
+            <th class="width-9 center">Avg Hits/Line</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% files.each do |source_file| %>
+            <tr class="clickable" name="<%= shortened_filename(source_file) %>"
+                onclick="openModal(this.attributes.name.value)">
+              <td class="width-50" title="<%= shortened_filename(source_file) %>">
+                <div class="overflow">
+                  <%= shortened_filename(source_file) %>
+                </div>
+              </td>
+              <td class="width-9 <%= coverage_class(source_file.covered_percent) %>">
+                <%= source_file.covered_percent.round(2).to_s %>%
+              </td>
+              <td class="width-5 center">
+                <%= format_number(source_file.lines.count) %>
+              </td>
+              <td class="width-9 center">
+                <%= format_number(source_file.covered_lines.count + source_file.missed_lines.count) %>
+              </td>
+              <td class="width-9 center">
+                <%= format_number(source_file.covered_lines.count) %>
+              </td>
+              <td class="width-9 center">
+                <%= format_number(source_file.missed_lines.count) %>
+              </td>
+              <td class="width-9 center">
+                <%= format_number(source_file.covered_strength) %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+    </table>
+  </div>
+</div>

data/views/main.erb

@@ -0,0 +1,90 @@
+<!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" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link href="<%= assets_path('application.css') %>" media="screen, projection, print" rel="stylesheet" type="text/css"/>
+  </head>
+
+  <body class="mdc-typography">
+    <aside class="mdc-drawer">
+      <div class="mdc-drawer__header">
+        <h3 class="mdc-drawer__title">Code Coverage</h3>
+        <h6 class="mdc-drawer__subtitle">
+          Generated using <%= result.command_name %>
+        </h6>
+      </div>
+      <div class="mdc-drawer__content">
+        <nav class="mdc-list">
+          <a class="mdc-list-item mdc-list-item--activated" href="#" name="AllFiles" onclick="navigate(this.name)">
+            <i class="material-icons mdc-list-item__graphic" aria-hidden="true">view_list</i>
+            <span class="mdc-list-item__text">
+              All Files
+              <span class="parenthese">
+                <span class="<%= coverage_class(result.source_files.covered_percent) %>">
+                  <%= result.source_files.covered_percent.round(2) %>%
+                </span>
+              </span>
+            </span>
+          </a>
+          <% result.groups.each do |name, files| %>
+            <a class="mdc-list-item" href="#" name="<%= remove_spaces(name) %>" onclick="navigate(this.name)">
+              <i class="material-icons mdc-list-item__graphic" aria-hidden="true">collections_bookmark</i>
+              <span class="mdc-list-item__text">
+                <%= name %>
+                <span class="parenthese">
+                  <span class="<%= coverage_class(files.covered_percent) %>">
+                    <%= files.covered_percent.round(2)%>%
+                  </span>
+                </span>
+              </span>
+            </a>
+          <% end %>
+        </nav>
+      </div>
+    </aside>
+    <div class="mdc-drawer-app-content">
+      <header class="mdc-top-app-bar mdc-top-app-bar--fixed app-bar" id="app-bar">
+        <div class="mdc-top-app-bar__row">
+          <section class="mdc-top-app-bar__section mdc-top-app-bar__section--align-start">
+            <span class="mdc-top-app-bar__title">
+              <%= SimpleCov.project_name.split('-').map(&:capitalize).join(' ') %>
+            </span>
+          </section>
+          <section class="mdc-top-app-bar__section mdc-top-app-bar__section--align-end">
+            Generated&nbsp;
+            <abbr class="timeago" datetime="<%= result.created_at %>">
+              <%= result.created_at %>
+            </abbr>
+          </section>
+        </div>
+      </header>
+      <main class="main-content" id="main-content">
+        <div class="mdc-top-app-bar--fixed-adjust"></div>
+        <%= generate_group_page("All Files", result.source_files) %>
+
+        <% result.groups.each do |name, files| %>
+            <%= generate_group_page(name, files) %>
+        <% end %>
+        <div class="bottom-spacer"></div>
+        <section class="footer">
+          <div>
+            Generated by
+            <a href="https://github.com/colszowka/simplecov" target="_blank">Simplecov</a>
+            v<%= SimpleCov::VERSION %>
+            and
+            <a href="https://github.com/chiefpansancolt/simplecov-material" target="_blank">Simplecov Material</a>
+            v<%= SimpleCov::Formatter::MaterialFormatter::VERSION %>
+            using <%= result.command_name %>
+          </div>
+        </section>
+      </main>
+    </div>
+
+    <% result.source_files.each do |source_file| %>
+        <%= generate_dialog(source_file) %>
+    <% end %>
+    <script src="<%= assets_path('application.js') %>" type="text/javascript"></script>
+  </body>
+</html>

data/webpack.config.js

@@ -0,0 +1,81 @@
+const path = require('path');
+const autoprefixer = require('autoprefixer');
+
+module.exports = {
+  mode: 'development',
+  entry: {
+    application: ['./dist/app.scss', './dist/app.js'],
+  },
+  output: {
+    filename: '[name].js',
+    path: path.resolve(__dirname, 'public'),
+    libraryTarget: 'window',
+  },
+  module: {
+    rules: [
+      {
+        test: /\.scss$/,
+        use: [
+          {
+            loader: 'file-loader',
+            options: {
+              name: 'application.css',
+            },
+          },
+          {loader: 'extract-loader'},
+          {loader: 'css-loader'},
+          {loader: 'postcss-loader',
+            options: {
+              plugins: () => [autoprefixer()],
+            },
+          },
+          {
+            loader: 'sass-loader',
+            options: {
+              includePaths: ['./node_modules'],
+            },
+          },
+        ],
+      },
+      {
+        test: /\.(png|svg|jpg|gif)$/,
+        use: [
+          {
+            loader: 'file-loader',
+            options: {
+              publicPath: 'images',
+              outputPath: 'images',
+            },
+          },
+        ],
+      },
+      {
+        test: /\.(woff|woff2|eot|ttf|otf)$/,
+        use: [
+          {
+            loader: 'file-loader',
+            options: {
+              publicPath: 'fonts',
+              outputPath: 'fonts',
+            },
+          },
+        ],
+      },
+      {
+        test: /\.m?js$/,
+        include: [
+          path.resolve(__dirname, 'dist'),
+        ],
+        exclude: [
+          path.resolve(__dirname, 'node_modules'),
+        ],
+        enforce: 'pre',
+        enforce: 'post',
+        loader: 'babel-loader',
+        options: {
+          presets: ['@babel/preset-env'],
+        },
+      },
+    ],
+  },
+};