deep-cover 0.1.16 → 0.2.0

data/lib/deep_cover/reporter/html/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module Reporter::HTML::Base
+    include Tools::ContentTag
+    def setup
+      DeepCover::Config::DEFAULTS.keys.map do |setting|
+        value = options[setting]
+        value = value.join(', ') if value.respond_to? :join
+        content_tag :span, value, class: setting
+      end.join
+    end
+  end
+end

data/lib/deep_cover/reporter/html/index.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module Reporter
+    require_relative 'tree'
+    require_relative 'base'
+
+    class HTML::Index < Struct.new(:analysis, :options)
+      def initialize(analysis, **options)
+        raise ArgumentError unless analysis.is_a? Coverage::Analysis
+        super
+      end
+
+      include HTML::Tree
+      include HTML::Base
+
+      def stats_to_data
+        @map = Tools.transform_keys(analysis.stat_map, &:name)
+        tree = paths_to_tree(@map.keys)
+        transform_data(populate(tree))
+      end
+
+      def columns
+        _covered_code, analyser_map = analysis.analyser_map.first
+        columns = analyser_map.flat_map do |type, analyser|
+          [{
+             value: type,
+             header: analyser.class.human_name,
+           }, {
+                value: :"#{type}_percent",
+                header: '%',
+              },
+          ]
+        end
+        columns.unshift(width: 400, header: 'Path')
+        columns
+      end
+
+      private
+
+      # {a: {}}    => [{text: a, data: stat_map[a]}]
+      # {b: {...}} => [{text: b, data: sum(stats), children: [...]}]
+      def populate(tree, dir = '')
+        tree.map do |path, children_hash|
+          full_path = [dir, path].join
+          if children_hash.empty?
+            {
+              text: %{<a href="#{full_path}.html">#{path}</a>},
+              data: @map[full_path],
+            }
+          else
+            children = populate(children_hash, "#{full_path}/")
+            data = Tools.merge(*children.map { |c| c[:data] }, :+)
+            {
+              text: path,
+              data: data,
+              children: children,
+              state: {opened: true},
+            }
+          end
+        end
+      end
+
+      # Modifies in place the tree:
+      # {per_char: Stat, ...} => {per_char: {ignored: ...}, per_char_percent: 55.55, ...}
+      def transform_data(tree)
+        return unless tree
+        tree.each do |node|
+          node[:data] = Tools.merge(
+              node[:data].transform_values(&:to_h),
+              *node[:data].map { |type, stat| {:"#{type}_percent" => stat.percent_covered} }
+          )
+          transform_data(node[:children])
+        end
+      end
+    end
+  end
+end

data/lib/deep_cover/reporter/html/site.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module DeepCover
+  require_relative 'index'
+  require_relative 'source'
+
+  module Reporter::HTML
+    class Site < Struct.new(:covered_codes, :options)
+      def initialize(covered_codes, **options)
+        raise ArgumentError unless covered_codes.all? { |c| c.is_a? CoveredCode }
+        super
+      end
+
+      include Memoize
+      memoize :analysis
+
+      def analysis
+        Coverage::Analysis.new(covered_codes, **options)
+      end
+
+      def path
+        Pathname(options[:output])
+      end
+
+      def save
+        clear
+        save_assets
+        save_index
+        save_pages
+      end
+
+      def clear
+        path.mkpath
+        path.rmtree
+        path.mkpath
+      end
+
+      def compile_stylesheet(source, dest)
+        Bundler.with_clean_env do
+          `sass #{source} #{dest}`
+        end
+      end
+
+      def render_index
+        Tools.render_template(:index, Index.new(analysis, **options))
+      end
+
+      def save_index
+        path.join('index.html').write(render_index)
+      end
+
+      def save_assets
+        require 'fileutils'
+        src = "#{__dir__}/template/assets"
+        dest = path.join('assets')
+        FileUtils.cp_r(src, dest)
+        compile_stylesheet "#{src}/deep_cover.css.sass", dest.join('deep_cover.css')
+        dest.join('deep_cover.css.sass').delete
+      end
+
+      def render_source(covered_code)
+        Tools.render_template(:source, Source.new(analysis.analyser_map.fetch(covered_code)))
+      end
+
+      def save_pages
+        covered_codes.each do |covered_code|
+          dest = path.join("#{covered_code.name}.html")
+          dest.dirname.mkpath
+          dest.write(render_source(covered_code))
+        end
+      end
+
+      def self.save(covered_codes, output: raise, **options)
+        Site.new(covered_codes, output: output, **options).save
+      end
+    end
+  end
+end

data/lib/deep_cover/reporter/html/source.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module Reporter
+    require_relative 'base'
+
+    class HTML::Source < Struct.new(:analyser_map)
+      include Tools::Covered
+
+      def initialize(analyser_map)
+        raise ArgumentError unless analyser_map.values.all? { |a| a.is_a?(Analyser) }
+        super
+      end
+
+      include HTML::Base
+
+      def format_source
+        lines = convert_source.split("\n")
+        lines.map { |line| content_tag(:td, line) }
+        rows = lines.map.with_index do |line, i|
+          nb = content_tag(:td, i + 1, id: "L#{i + 1}", class: :nb)
+          content_tag(:tr, nb + content_tag(:td, line))
+        end
+        content_tag(:table, rows.join, class: :source)
+      end
+
+      def convert_source
+        @rewriter = ::Parser::Source::TreeRewriter.new(covered_code.buffer)
+        insert_node_tags
+        insert_branch_tags
+        html_escape
+        @rewriter.process
+      end
+
+      def root_path
+        Pathname('.').relative_path_from(Pathname(covered_code.name).dirname)
+      end
+
+      def stats
+        cells = analyser_map.map do |type, analyser|
+          data = analyser.stats
+          f = ->(kind) { content_tag(:span, data.public_send(kind), class: kind, title: kind) }
+          [content_tag(:th, analyser.class.human_name, class: type),
+           content_tag(:td, "#{f[:executed]} #{f[:ignored] if data.ignored > 0} / #{f[:potentially_executable]}", class: type),
+          ]
+        end
+        rows = cells.transpose.map { |line| content_tag(:tr, line.join) }
+        content_tag(:table, rows.join)
+      end
+
+      def analyser
+        analyser_map[:per_char]
+      end
+
+      def covered_code
+        analyser.covered_code
+      end
+
+      private
+
+      RUNS_CLASS = Hash.new('run').merge!(0 => 'not-run', nil => 'ignored')
+      RUNS_TITLE = Hash.new { |k, runs| "#{runs}x" }.merge!(0 => 'never run', nil => 'ignored')
+
+      def node_span(node, kind)
+        runs = analyser.node_runs(node)
+        %{<span class="node-#{node.type} kind-#{kind} #{RUNS_CLASS[runs]}" title="#{RUNS_TITLE[runs]}">}
+      end
+
+      def insert_node_tags
+        analyser.each_node do |node|
+          h = node.executed_loc_hash
+          h.each do |kind, range|
+            wrap(range, node_span(node, kind), '</span>')
+          end
+          exp = node.expression
+          if (exp.nil? || exp.empty?) && !analyser.node_covered?(node) && !node.parent.is_a?(Node::Branch) # Not executed empty bodies must show!
+            replace(exp, icon(:empty, 'empty node never run'))
+            wrap(exp, node_span(node, :empty))
+          end
+        end
+      end
+
+      ICONS = {
+                fork: 'code-fork',
+                empty: 'code',
+              }.freeze
+      def icon(type, title)
+        %{<i class="#{type}-icon fa fa-#{ICONS[type]}" aria-hidden="true" title="#{title}"></i>}
+      end
+
+      def fork_span(node, kind, id, title: nil, klass: nil)
+        runs = analyser_map[:branch].node_runs(node)
+        title ||= RUNS_TITLE[runs]
+        %{<span class="fork fork-#{kind} fork-#{RUNS_CLASS[runs]} #{klass}" data-fork-id="#{id}">#{icon(:fork, title)}}
+      end
+
+      def insert_branch_tags
+        analyser_map[:branch].each_node.with_index do |node, id|
+          node.branches.each do |branch|
+            exp = branch.expression
+            wrap(exp, fork_span(branch, :branch, id), '</span>') if exp
+          end
+          runs = analyser_map[:branch].node_runs(node)
+          if !covered?(runs) && analyser.node_covered?(node)
+            jumps_missing = node.branches.reject { |jump| analyser.node_covered?(jump) }
+            title = "#{node.branches_summary(jumps_missing)} not covered"
+            klass = 'fork-with-uncovered-branches'
+          end
+          wrap(node.expression, fork_span(node, :whole, id, title: title, klass: klass))
+        end
+      end
+
+      def replace(range, with)
+        @rewriter.replace(range, with) rescue binding.pry
+      end
+
+      def wrap(range, before, after = '</span>')
+        line = @rewriter.source_buffer.line_range(range.first_line)
+        pinned = range.with(end_pos: [range, line].map(&:end_pos).min)
+        @rewriter.wrap(pinned, before, after) rescue binding.pry
+      end
+
+      def html_escape
+        buffer = analyser.covered_code.buffer
+        source = buffer.source
+        {'<' => '&lt;', '>' => '&gt;', '&' => '&amp;'}.each do |char, escaped|
+          source.scan(char) do
+            m = Regexp.last_match
+            range = ::Parser::Source::Range.new(buffer, m.begin(0), m.end(0))
+            @rewriter.replace(range, escaped)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deep_cover/reporter/html/template/assets/deep_cover.css.sass

@@ -0,0 +1,338 @@
+// Adapted from GitHub's scheme https://raw.githubusercontent.com/primer/github-syntax-light/master/lib/github-light.css
+$pl-c: #6a737d /* comment punctuation.definition.comment string.comment */
+
+/* constant entity.name.constant variable.other.constant variable.language support meta.property-name support.constant support.variable meta.module-reference markup.raw meta.diff.header meta.output */
+$pl-c1: #005cc5 /* string variable */
+
+$pl-en: #6f42c1 /* entity.name */
+
+/* variable.parameter.function storage.modifier.package storage.modifier.import storage.type.java variable.other */
+$pl-s1: #24292e /* string source */
+
+
+$pl-ent: #22863a /* entity.name.tag markup.quote */
+
+
+$pl-k: #d73a49 /* keyword storage storage.type */
+$pl-k: #a419ea /* override */
+
+/* string */
+/* punctuation.definition.string source.regexp string.regexp.character-class */
+/* string punctuation.section.embedded source */
+/* string.regexp */
+/* string.regexp constant.character.escape */
+/* string.regexp source.ruby.embedded */
+$pl-s: #032f62 /* string.regexp string.regexp.arbitrary-repitition */
+
+/* variable */
+$pl-v: #e36209 /* sublimelinter.mark.warning */
+
+$pl-bu: #b31d28 /* invalid.broken invalid.deprecated invalid.unimplemented message.error brackethighlighter.unmatched sublimelinter.mark.error */
+
+$pl-ii: #fafbfc /* invalid.illegal */
+$pl-ii-background: #b31d28
+
+$pl-sr: #22863a /* string.regexp constant.character.escape */
+
+$pl-ml: #735c0f /* markup.list */
+
+/* markup.heading */
+/* markup.heading entity.name */
+$pl-mh: #005cc5 /* meta.separator */
+
+$pl-mi2: #f6f8fa /* markup.ignored markup.untracked */
+$pl-mi2-background: #005cc5
+
+
+// http://meyerweb.com/eric/tools/css/reset/
+// v2.0 | 20110126
+// License: none (public domain)
+
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video
+  margin: 0
+  padding: 0
+  border: 0
+  font-size: 100%
+  // font: inherit
+  vertical-align: baseline
+
+// HTML5 display-role reset for older browsers
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section
+  display: block
+
+body
+  line-height: 1
+
+ol, ul
+  list-style: none
+
+blockquote, q
+  quotes: none
+
+blockquote:before, blockquote:after,
+q:before, q:after
+  content: ''
+  content: none
+
+table
+  border-collapse: collapse
+  border-spacing: 0
+
+
+// Global settings
+*
+  box-sizing: border-box
+  border-collapse: collapse
+  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif
+
+// *** DeepCover Source ***
+
+$dark-green: #25712b
+$light-green: #74b770
+$light-gray: #e1e4e8
+
+%light-border
+  border: 1px solid $light-gray
+
+.fork-branch > .fork-icon
+  display: none
+%show-fork-icon
+  .fork-branch > .fork-icon
+    display: inherit
+%center
+  width: 980px
+  margin: 0 auto 0 auto
+
+$toggled: $light-green
+$not-run: hsl(hue(#f00), 100%, 85%)
+$ignored: hsl(0, 0, 85%)
+
+// *** Common template ***
+main
+  @extend %center
+  padding-top: 10px
+.overlay
+  width: 100%
+  position: fixed
+  top: 0
+  z-index: 9999
+  .center
+    position: relative
+    @extend %center
+
+header
+  width: 100%
+  position: relative
+  top: 0
+  background: #24292e
+  color: rgba(255,255,255,0.75)
+  padding-bottom: 4px
+
+  .content
+    position: relative
+    @extend %center
+
+    .info
+      padding: 4px 0 4px 0
+      color: #88d483
+      .deep-cover
+        transition: opacity 0.4s
+        opacity: 0.3
+        font-size: 24px
+        font-weight: 900
+        .deep
+          color: #74b770
+      .version
+        transition: opacity 0.4s
+        opacity: 0.1
+        font-size: 12px
+        font-weight: lighter
+      &:hover
+        .deep-cover
+          opacity: 0.8
+        .version
+          opacity: 0.6
+
+    // *** DeepCover Source ***
+    body.source &
+      .nav
+        a
+          color: white
+body.source
+  .stats
+    th, td
+      padding: 6px
+      border-right: 1px solid $light-gray
+    td
+      padding-top: 0
+    table
+      @extend %light-border
+    position: absolute
+    background: white
+    right: 20px
+    top: 15px
+    color: $pl-s
+    .ignored
+      opacity: 0.7
+      &::before
+        content: "[+"
+      &::after
+        content: "]"
+
+  main
+    white-space: pre
+    font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace
+    font-size: 12px
+    line-height: 20px
+
+    table.source
+      @extend %light-border
+      width: 100%
+
+      td
+        vertical-align: top
+
+      .nb
+        color: rgba(27,31,35,0.3)
+        text-align: right
+        width: 50px
+        padding-right: 10px
+        padding-left: 10px
+      // * Color scheme *
+
+      // Default color, for unexecutable code
+      color: $pl-c
+
+      // Executed code
+      .run
+        color: $pl-s
+
+      .not-run
+        background-color: $not-run
+        padding: 2px 0
+
+      .ignored
+        background-color: $ignored
+        padding: 2px 0
+
+      .kind-keyword, .kind-else
+        color: $pl-k
+
+      .node-def.kind-name
+        color: #3e920c
+
+      // Literals:
+      .kind-expression, .node-const
+        color: $pl-c1
+
+      .node-send
+        color: $dark-green
+
+      .node-str
+        color: $pl-s
+
+      // Icons
+      .icon-not-run
+        background-color: $not-run
+        border-color: red
+      .icon-ignored
+        background-color: $ignored
+        border-color: darken($ignored, 20%)
+      .icon
+        position: absolute
+        left: -2.2ex
+        width: 2ex
+        height: 1.5em
+        line-height: 1.5em
+        text-align: center
+        background-color: white
+        padding: 0
+        @extend %light-border
+
+      .kind-empty
+        position: relative
+        & > .empty-icon
+          @extend .icon
+          left: -2.5ex
+          width: 2.3ex
+        &.not-run > .empty-icon
+          @extend .icon-not-run
+
+      // Branches
+      .fork
+        position: relative
+      .fork-icon
+        @extend .icon
+      .fork-whole
+        & > .fork-icon
+          z-index: 1
+        &:hover
+          @extend %show-fork-icon
+          background: $light-gray
+          padding: 2px 0
+
+      .fork-with-uncovered-branches
+        &.fork-not-run > .fork-icon
+          @extend .icon-not-run
+        &.fork-ignored > .fork-icon
+          @extend .icon-ignored
+
+  &.show-forks
+    @extend %show-fork-icon
+    .fork-whole
+      background: $light-gray
+    .stats .branch
+      background: $toggled
+
+// *** Index ***
+
+.tree
+  // Overrides
+  .jstree-table-cell
+    padding-left: 0
+    span
+      padding-right: 4px
+  .jstree-table-header-cell
+    // Leave space for sort arrows:
+    padding-right: 17px
+    font-style: italic
+  .jstree-table-sort-icon
+    right: 4px
+    top: 8px
+    left: inherit
+  .jstree-table-separator
+    border: none
+
+  .jstree-table-column
+    text-align: right
+    border: gray 1px #ddd
+  .jstree-table-column-0
+    text-align: left
+
+  .percent-100
+    color: green
+  .percent-90
+    color: blue
+  .percent-80
+    color: brown
+  .percent-60, .percent-70
+    color: orange
+  .percent-00, .percent-10, .percent-20, .percent-30, .percent-40, .percent-50
+    color: red
+
+footer
+  display: none