deprecations_detector 0.0.1

data/lib/deprecations_detector/formatters/html/assets/stylesheets/plugins/jquery.colorbox.css

@@ -0,0 +1,52 @@
+/*
+    ColorBox Core Style:
+    The following CSS is consistent between example themes and should not be altered.
+*/
+#colorbox, #cboxOverlay, #cboxWrapper{position:absolute; top:0; left:0; z-index:9999; overflow:hidden;}
+#cboxOverlay{position:fixed; width:100%; height:100%;}
+#cboxMiddleLeft, #cboxBottomLeft{clear:left;}
+#cboxContent{position:relative;}
+#cboxLoadedContent{overflow:auto;}
+#cboxTitle{margin:0;}
+#cboxLoadingOverlay, #cboxLoadingGraphic{position:absolute; top:0; left:0; width:100%; height:100%;}
+#cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{cursor:pointer;}
+.cboxPhoto{float:left; margin:auto; border:0; display:block; max-width:none;}
+.cboxIframe{width:100%; height:100%; display:block; border:0;}
+#colorbox, #cboxContent, #cboxLoadedContent{box-sizing:content-box;}
+
+/*
+    User Style:
+    Change the following styles to modify the appearance of ColorBox.  They are
+    ordered & tabbed in a way that represents the nesting of the generated HTML.
+*/
+#cboxOverlay{background:#000;}
+#colorbox{}
+    #cboxTopLeft{width:14px; height:14px; background:url(colorbox/controls.png) no-repeat 0 0;}
+    #cboxTopCenter{height:14px; background:url(colorbox/border.png) repeat-x top left;}
+    #cboxTopRight{width:14px; height:14px; background:url(colorbox/controls.png) no-repeat -36px 0;}
+    #cboxBottomLeft{width:14px; height:43px; background:url(colorbox/controls.png) no-repeat 0 -32px;}
+    #cboxBottomCenter{height:43px; background:url(colorbox/border.png) repeat-x bottom left;}
+    #cboxBottomRight{width:14px; height:43px; background:url(colorbox/controls.png) no-repeat -36px -32px;}
+    #cboxMiddleLeft{width:14px; background:url(colorbox/controls.png) repeat-y -175px 0;}
+    #cboxMiddleRight{width:14px; background:url(colorbox/controls.png) repeat-y -211px 0;}
+    #cboxContent{background:#fff; overflow:visible;}
+        .cboxIframe{background:#fff;}
+        #cboxError{padding:50px; border:1px solid #ccc;}
+        #cboxLoadedContent{margin-bottom:5px;}
+        #cboxLoadingOverlay{background:url(colorbox/loading_background.png) no-repeat center center;}
+        #cboxLoadingGraphic{background:url(colorbox/loading.gif) no-repeat center center;}
+        #cboxTitle{position:absolute; bottom:-25px; left:0; text-align:center; width:100%; font-weight:bold; color:#7C7C7C;}
+        #cboxCurrent{position:absolute; bottom:-25px; left:58px; font-weight:bold; color:#7C7C7C;}
+
+        #cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{position:absolute; bottom:-29px; background:url(colorbox/controls.png) no-repeat 0px 0px; width:23px; height:23px; text-indent:-9999px;}
+        #cboxPrevious{left:0px; background-position: -51px -25px;}
+        #cboxPrevious:hover{background-position:-51px 0px;}
+        #cboxNext{left:27px; background-position:-75px -25px;}
+        #cboxNext:hover{background-position:-75px 0px;}
+        #cboxClose{right:0; background-position:-100px -25px;}
+        #cboxClose:hover{background-position:-100px 0px;}
+
+        .cboxSlideshow_on #cboxSlideshow{background-position:-125px 0px; right:27px;}
+        .cboxSlideshow_on #cboxSlideshow:hover{background-position:-150px 0px;}
+        .cboxSlideshow_off #cboxSlideshow{background-position:-150px -25px; right:27px;}
+        .cboxSlideshow_off #cboxSlideshow:hover{background-position:-125px 0px;}

data/lib/deprecations_detector/formatters/html/assets/stylesheets/reset.css

@@ -0,0 +1,103 @@
+/* -----------------------------------------------------------------------
+
+
+ Blueprint CSS Framework 0.9
+ http://blueprintcss.org
+
+   * Copyright (c) 2007-Present. See LICENSE for more info.
+   * See README for instructions on how to use Blueprint.
+   * For credits and origins, see AUTHORS.
+   * This is a compressed file. See the sources in the 'src' directory.
+
+----------------------------------------------------------------------- */
+
+/* reset.css */
+html, body, div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, code, del, dfn, em, img, q, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, dialog, figure, footer, header, hgroup, nav, section {margin:0;padding:0;border:0;font-weight:inherit;font-style:inherit;font-size:100%;font-family:inherit;vertical-align:baseline;}
+article, aside, dialog, figure, footer, header, hgroup, nav, section {display:block;}
+body {line-height:1.5;}
+table {border-collapse:separate;border-spacing:0;}
+caption, th, td {text-align:left;font-weight:normal;}
+table, td, th {vertical-align:middle;}
+blockquote:before, blockquote:after, q:before, q:after {content:"";}
+blockquote, q {quotes:"" "";}
+a img {border:none;}
+
+/* typography.css */
+html {font-size:100.01%;}
+body {font-size:82%;color:#222;background:#fff;font-family:"Helvetica Neue", Arial, Helvetica, sans-serif;}
+h1, h2, h3, h4, h5, h6 {font-weight:normal;color:#111;}
+h1 {font-size:3em;line-height:1;margin-bottom:0.5em;}
+h2 {font-size:2em;margin-bottom:0.75em;}
+h3 {font-size:1.5em;line-height:1;margin-bottom:1em;}
+h4 {font-size:1.2em;line-height:1.25;margin-bottom:1.25em;}
+h5 {font-size:1em;font-weight:bold;margin-bottom:1.5em;}
+h6 {font-size:1em;font-weight:bold;}
+h1 img, h2 img, h3 img, h4 img, h5 img, h6 img {margin:0;}
+p {margin:0 0 1.5em;}
+p img.left {float:left;margin:1.5em 1.5em 1.5em 0;padding:0;}
+p img.right {float:right;margin:1.5em 0 1.5em 1.5em;}
+a:focus, a:hover {color:#000;}
+a {color:#009;text-decoration:underline;}
+blockquote {margin:1.5em;color:#666;font-style:italic;}
+strong {font-weight:bold;}
+em, dfn {font-style:italic;}
+dfn {font-weight:bold;}
+sup, sub {line-height:0;}
+abbr, acronym {border-bottom:1px dotted #666;}
+address {margin:0 0 1.5em;font-style:italic;}
+del {color:#666;}
+pre {margin:1.5em 0;white-space:pre;}
+pre, code, tt {font:1em 'andale mono', 'lucida console', monospace;line-height:1.5;}
+li ul, li ol {margin:0;}
+ul, ol {margin:0 1.5em 1.5em 0;padding-left:3.333em;}
+ul {list-style-type:disc;}
+ol {list-style-type:decimal;}
+dl {margin:0 0 1.5em 0;}
+dl dt {font-weight:bold;}
+dd {margin-left:1.5em;}
+table {margin-bottom:1.4em;width:100%;}
+th {font-weight:bold;}
+thead th {background:#c3d9ff;}
+th, td, caption {padding:4px 10px 4px 5px;}
+tr.even td {background:#efefef;}
+tfoot {font-style:italic;}
+caption {background:#eee;}
+.small {font-size:.8em;margin-bottom:1.875em;line-height:1.875em;}
+.large {font-size:1.2em;line-height:2.5em;margin-bottom:1.25em;}
+.hide {display:none;}
+.quiet {color:#666;}
+.loud {color:#000;}
+.highlight {background:#ff0;}
+.added {background:#060;color:#fff;}
+.removed {background:#900;color:#fff;}
+.first {margin-left:0;padding-left:0;}
+.last {margin-right:0;padding-right:0;}
+.top {margin-top:0;padding-top:0;}
+.bottom {margin-bottom:0;padding-bottom:0;}
+
+/* forms.css */
+label {font-weight:bold;}
+fieldset {padding:1.4em;margin:0 0 1.5em 0;border:1px solid #ccc;}
+legend {font-weight:bold;font-size:1.2em;}
+input[type=text], input[type=password], input.text, input.title, textarea, select {background-color:#fff;border:1px solid #bbb;}
+input[type=text]:focus, input[type=password]:focus, input.text:focus, input.title:focus, textarea:focus, select:focus {border-color:#666;}
+input[type=text], input[type=password], input.text, input.title, textarea, select {margin:0.5em 0;}
+input.text, input.title {width:300px;padding:5px;}
+input.title {font-size:1.5em;}
+textarea {width:390px;height:250px;padding:5px;}
+input[type=checkbox], input[type=radio], input.checkbox, input.radio {position:relative;top:.25em;}
+form.inline {line-height:3;}
+form.inline p {margin-bottom:0;}
+.error, .notice, .success {padding:.8em;margin-bottom:1em;border:2px solid #ddd;}
+.error {background:#FBE3E4;color:#8a1f11;border-color:#FBC2C4;}
+.notice {background:#FFF6BF;color:#514721;border-color:#FFD324;}
+.success {background:#E6EFC2;color:#264409;border-color:#C6D880;}
+.error a {color:#8a1f11;}
+.notice a {color:#514721;}
+.success a {color:#264409;}
+.box {padding:1.5em;margin-bottom:1.5em;background:#E5ECF9;}
+hr {background:#ddd;color:#ddd;clear:both;float:none;width:100%;height:.1em;margin:0 0 1.45em;border:none;}
+hr.space {background:#fff;color:#fff;visibility:hidden;}
+.clearfix:after, .container:after {content:"\0020";display:block;height:0;clear:both;visibility:hidden;overflow:hidden;}
+.clearfix, .container {display:block;}
+.clear {clear:both;}

data/lib/deprecations_detector/formatters/html/assets/stylesheets/screen.css.sass

@@ -0,0 +1,249 @@
+#loading
+  position: fixed
+  left: 40%
+  top: 50%
+
+a
+  color: #333
+  text-decoration: none
+  &:hover
+    color: #000
+    text-decoration: underline
+
+body
+  font-family: "Lucida Grande", Helvetica, "Helvetica Neue", Arial, sans-serif
+  padding: 12px
+  background-color: #333
+
+h1, h2, h3, h4
+  color: #1C2324
+  margin: 0
+  padding: 0
+  margin-bottom: 12px
+
+table
+  width: 100%
+
+#content
+  clear: left
+  background-color: white
+  border: 2px solid #ddd
+  border-top: 8px solid #ddd
+  padding: 18px
+  -webkit-border-bottom-left-radius: 5px
+  -webkit-border-bottom-right-radius: 5px
+  -webkit-border-top-right-radius: 5px
+  -moz-border-radius-bottomleft: 5px
+  -moz-border-radius-bottomright: 5px
+  -moz-border-radius-topright: 5px
+  border-bottom-left-radius: 5px
+  border-bottom-right-radius: 5px
+  border-top-right-radius: 5px
+
+.dataTables_filter, .dataTables_info
+  padding: 2px 6px
+
+abbr.timeago
+  text-decoration: none
+  border: none
+  font-weight: bold
+
+.timestamp
+  float: right
+  color: #ddd
+
+.group_tabs
+  list-style: none
+  float: left
+  margin: 0
+  padding: 0
+  li
+    display: inline
+    float: left
+    a
+      font-family: Helvetica, Arial, sans-serif
+      display: block
+      float: left
+      text-decoration: none
+      padding: 4px 8px
+      background-color: #aaa
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(#dddddd), to(#aaaaaa))
+      background: -moz-linear-gradient(#dddddd, #aaaaaa)
+      background: linear-gradient(#dddddd, #aaaaaa)
+      text-shadow: #e5e5e5 1px 1px 0px
+      border-bottom: none
+      color: #333
+      font-weight: bold
+      margin-right: 8px
+      border-top: 1px solid #efefef
+      -webkit-border-top-left-radius: 2px
+      -webkit-border-top-right-radius: 2px
+      -moz-border-radius-topleft: 2px
+      -moz-border-radius-topright: 2px
+      border-top-left-radius: 2px
+      border-top-right-radius: 2px
+      &:hover
+        background-color: #ccc
+        background: -webkit-gradient(linear, 0 0, 0 bottom, from(#eeeeee), to(#aaaaaa))
+        background: -moz-linear-gradient(#eeeeee, #aaaaaa)
+        background: linear-gradient(#eeeeee, #aaaaaa)
+      &:active
+        padding-top: 5px
+        padding-bottom: 3px
+    &.active a
+      color: black
+      text-shadow: #fff 1px 1px 0px
+      background-color: #ddd
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(white), to(#dddddd))
+      background: -moz-linear-gradient(white, #dddddd)
+      background: linear-gradient(white, #dddddd)
+
+.file_list
+  margin-bottom: 18px
+
+a.src_link
+  background: url('./magnify.png') no-repeat left 50%
+  padding-left: 18px
+
+tr, td
+  margin: 0
+  padding: 0
+
+th
+  white-space: nowrap
+  &.ui-state-default
+    cursor: pointer
+  span.ui-icon
+    float: left
+
+td
+  padding: 4px 8px
+  &.strong
+    font-weight: bold
+
+.source_table
+  h3, h4
+    padding: 0
+    margin: 0
+    margin-bottom: 4px
+  .header
+    padding: 10px
+  pre
+    margin: 0
+    padding: 0
+    white-space: normal
+    color: #000
+    font-family: "Monaco", "Inconsolata", "Consolas", monospace
+  code
+    color: #000
+    font-family: "Monaco", "Inconsolata", "Consolas", monospace
+  pre
+    background-color: #333
+    ol
+      margin: 0px
+      padding: 0px
+      margin-left: 45px
+      font-size: 12px
+      color: white
+    li
+      margin: 0px
+      padding: 2px 6px
+      border-left: 5px solid white
+      code
+        white-space: pre
+        white-space: pre-wrap
+    .hits
+      float: right
+      margin-left: 10px
+      padding: 2px 4px
+      background-color: #444
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(#222222), to(#666666))
+      background: -moz-linear-gradient(#222222, #666666)
+      background: linear-gradient(#222222, #666666)
+      color: white
+      font-family: Helvetica, "Helvetica Neue", Arial, sans-serif
+      font-size: 10px
+      font-weight: bold
+      text-align: center
+      border-radius: 6px
+
+#footer
+  color: #ddd
+  font-size: 12px
+  font-weight: bold
+  margin-top: 12px
+  text-align: right
+  a
+    color: #eee
+    text-decoration: underline
+    &:hover
+      color: #fff
+      text-decoration: none
+
+.green
+  color: #090
+
+.red
+  color: #900
+
+.yellow
+  color: #da0
+
+.source_table
+  pre li
+    padding: 2px 0 0 0
+
+  .covered
+    border-color: #090
+  .missed
+    border-color: #900
+  .never
+    border-color: black
+  .skipped
+    border-color: #fc0
+  .covered
+    cursor: pointer
+    &:nth-child(odd)
+      background-color: #CDF2CD
+    &:nth-child(even)
+      background-color: #DBF2DB
+  .missed
+    &:nth-child(odd)
+      background-color: #F7C0C0
+    &:nth-child(even)
+      background-color: #F7CFCF
+  .never
+    &:nth-child(odd)
+      background-color: #efefef
+    &:nth-child(even)
+      background-color: #f4f4f4
+  .skipped
+    &:nth-child(odd)
+      background-color: #FBF0C0
+    &:nth-child(even)
+      background-color: #FBFfCf
+
+  .deprecations_detector
+    background: #fed
+    color: #333
+    display: none
+    padding: 2px 6px
+    >.example_data
+      &:nth-child(odd)
+        background-color: #FBF0C0
+      &:nth-child(even)
+        background-color: #FBFfCf
+      >.file_path
+        padding-left: 14px
+
+.tree-leaf .tree-child-leaves
+  border-left: 1px dashed #bbb
+  padding-left: 11px
+  margin-left: 4px
+
+.tree-expando.hidden + .tree-leaf-text
+  color: #000
+  font-weight: bold
+
+  &:before
+    content: '↳ '

data/lib/deprecations_detector/formatters/html/assets/stylesheets/treeview.css

@@ -0,0 +1,12 @@
+/* https://github.com/justinchmura/js-treeview/blob/1.1.5/src/treeview.css */
+
+.tree-leaf { position: relative; }
+.tree-leaf .tree-child-leaves { display: block; margin-left: 15px; }
+.tree-leaf .hidden { display: none; }
+.tree-leaf .tree-expando { background: #ddd; border-radius: 3px; cursor: pointer; float: left; height: 10px; line-height: 10px; position: relative; text-align: center; top: 5px; width: 10px; }
+.tree-leaf .hidden { visibility: hidden; }
+.tree-leaf .tree-expando:hover { background: #aaa; }
+.tree-leaf .tree-leaf-text { cursor: pointer; float: left; margin-left: 5px; }
+.tree-leaf .tree-leaf-text:hover { color: blue; }
+.tree-leaf .tree-leaf-content:before, .tree-leaf .tree-leaf-content:after { content: " "; display: table; }
+.tree-leaf .tree-leaf-content:after { clear: both; }

data/lib/deprecations_detector/formatters/html/formatter.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "erb"
+require "cgi"
+require "fileutils"
+require "digest/sha1"
+require "time"
+require "json"
+
+module DeprecationsDetector
+  module Formatters
+    module HTML
+      class Formatter
+        def format(result, output_path: DeprecationsDetector::Main.output_path)
+          public_r = './public/*'
+          Dir[File.join(File.dirname(__FILE__), public_r)].each do |path|
+            FileUtils.cp_r(path, asset_output_path(output_path))
+          end
+
+          File.open(File.join(output_path, "index.html"), "wb") do |file|
+            file.puts template("layout").result(binding)
+          end
+          puts output_message(result, output_path)
+        end
+
+        def output_message(result, output_path)
+          "Coverage report generated for #{result.count} files to #{output_path}."
+        end
+
+        def asset_output_path(output_path)
+          return @asset_output_path if defined?(@asset_output_path) && @asset_output_path
+
+          @asset_output_path = File.join(output_path, "assets", DeprecationsDetector::VERSION)
+          FileUtils.mkdir_p(@asset_output_path)
+          @asset_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 assets_path(name)
+          File.join("./assets", DeprecationsDetector::VERSION, name)
+        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 #{filename(source_file)}. Simplecov/ERB can't handle non ASCII characters in filenames. Error: #{e.message}."
+        end
+
+        def readfile(source_file)
+          load_source(filename(source_file))
+        end
+
+        def load_source(file_name)
+          lines = []
+          # The default encoding is UTF-8
+          File.open(file_name, "rb:UTF-8") do |file|
+            line = file.gets
+
+            # Check for shbang
+            if /\A#!/.match?(line)
+              lines << line
+              line = file.gets
+            end
+            return lines unless line
+
+            check_magic_comment(file, line)
+            lines.concat([line], file.readlines)
+          end
+
+          lines
+        end
+
+        def check_magic_comment(file, line)
+          # Check for encoding magic comment
+          # Encoding magic comment must be placed at first line except for shbang
+          if (match = /\A#\s*(?:-\*-)?\s*(?:en)?coding:\s*(\S+)\s*(?:-\*-)?\s*\z/.match(line))
+            file.set_encoding(match[1], "UTF-8")
+          end
+        end
+
+        def grouped(files)
+          groups = files.group_by do |file_name, lines|
+            lines.map do |line, examples|
+              examples.map { |example| example[:deprecation_message] }
+            end
+          end.keys.flatten.uniq
+
+          grouped = {}
+          grouped_files = []
+
+          groups.each do |deprecation_message|
+            grouped[deprecation_message] = files.select { |source_file, lines| lines.detect { |line, examples| examples.detect { |example| example[:deprecation_message] == deprecation_message } } }
+            grouped_files += grouped[deprecation_message].keys
+          end
+          if !groups.empty? && !(other_files = files.reject { |source_file| grouped_files.include?(source_file) }).empty?
+            grouped["Ungrouped"] = other_files
+          end
+
+          arr = grouped.map do |deprecation_message, objects|
+            [
+              deprecation_message,
+              -objects.to_a.sum { |file, lines| lines.sum { |line, examples| examples.count } }
+            ]
+          end.sort_by { |group| group[1] }.to_h.keys[0..6] # filter just the 6 most frequent deprecations
+
+          arr.map { |k| [k, grouped[k]] }.to_h
+        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 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
+
+        def filename(source_file)
+          source_file.first.to_s
+        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(filename(source_file))
+        end
+
+        def timeago(time)
+          "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+        end
+
+        def shortened_filename(source_file)
+          filename(source_file).sub(Dir.pwd, '.').gsub(%r{^./}, "")
+        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
+end