rubycritic-simplecov 4.1.0

data/lib/rubycritic/generators/html/line.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'rubycritic/generators/html/base'
+
+module RubyCritic
+  module Generator
+    module Html
+      class Line < Base
+        NORMAL_TEMPLATE = erb_template('line.html.erb')
+        SMELLY_TEMPLATE = erb_template('smelly_line.html.erb')
+
+        attr_reader :file_directory
+
+        def initialize(file_directory, text, smells)
+          @file_directory = file_directory
+          @text = CGI.escapeHTML(text.chomp)
+          @smells = smells
+        end
+
+        def render
+          template.result(binding).delete("\n") + "\n"
+        end
+
+        private
+
+        def template
+          if @smells.empty?
+            NORMAL_TEMPLATE
+          else
+            SMELLY_TEMPLATE
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/html/overview.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/html/base'
+require 'rubycritic/generators/html/turbulence'
+require 'rubycritic/analysis_summary'
+
+module RubyCritic
+  module Generator
+    module Html
+      class Overview < Base
+        TEMPLATE = erb_template('overview.html.erb')
+
+        def initialize(analysed_modules)
+          @turbulence_data = Turbulence.data(analysed_modules)
+          @score = analysed_modules.score
+          @max_score = AnalysedModulesCollection::MAX_SCORE
+          @summary = analysed_modules.summary
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
+        end
+
+        def file_name
+          'overview.html'
+        end
+
+        def render
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/html/simple_cov_index.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/html/base'
+
+module RubyCritic
+  module Generator
+    module Html
+      class SimpleCovIndex < Base
+        TEMPLATE = erb_template('simple_cov_index.html.erb')
+
+        def initialize(analysed_modules)
+          @analysed_modules = sorted(filtered(analysed_modules))
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
+        end
+
+        def file_name
+          'simple_cov_index.html'
+        end
+
+        def render
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
+        end
+
+        def sorted(mods)
+          mods.sort_by(&:coverage)
+        end
+
+        def filtered(mods)
+          mods.reject do |a_module|
+            path = a_module.pathname.to_s
+            path.start_with?('spec', 'test')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/html/smells_index.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/html/base'
+
+module RubyCritic
+  module Generator
+    module Html
+      class SmellsIndex < Base
+        TEMPLATE = erb_template('smells_index.html.erb')
+
+        def initialize(analysed_modules)
+          @smells = analysed_modules.flat_map(&:smells).uniq
+          @analysed_module_names = analysed_module_names(analysed_modules)
+          @show_status = (Config.mode == :default)
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
+        end
+
+        def file_name
+          'smells_index.html'
+        end
+
+        def render
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
+        end
+
+        private
+
+        def analysed_module_names(analysed_modules)
+          names = {}
+          analysed_modules.each do |analysed_module|
+            names[analysed_module.pathname] = analysed_module.name
+          end
+          names
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/html/templates/code_file.html.erb

@@ -0,0 +1,61 @@
+<div class="row">
+  <!--Page Title -->
+  <div class="Page_Title">
+    <div class="file-time">
+      <span class="committed-at">
+        <% if @analysed_module.committed_at %>
+          Updated <%= timeago_tag(@analysed_module.committed_at) %>
+        <% else %>
+          Never committed
+        <% end %>
+      </span>
+    </div>
+    <div>
+      <h3><small><%= @analysed_module.file_location %> /</small> <%= @analysed_module.file_name %></h3>
+    </div>
+  </div>
+  <!--End Page Title -->
+  <div class="Content_Wrapper">
+    <!-- code detail -->
+    <div class="code-top-detail clearfix row">
+      <div class="col-md-8">
+        <div class="row">
+          <div class="col-md-1">
+            <div class="rating <%= @analysed_module.rating.to_s.downcase %> big">
+              <%= @analysed_module.rating %>
+            </div>
+          </div>
+          <div class="code-statistics col-md-11">
+            <div class="col-md-3">
+              <div><span class="metric"><%= @analysed_module.line_count %></span><small> lines of codes</small></div>
+              <div><span class="metric"><%= @analysed_module.methods_count %></span><small> methods</small></div>
+            </div>
+            <div class="col-md-3">
+              <div><span class="metric"><%= @analysed_module.complexity_per_method %></span><small> complexity/method</small></div>
+              <div><span class="metric"><%= @analysed_module.churn %></span><small> churn</small></div>
+            </div>
+            <div class="col-md-3">
+              <div><span class="metric"><%= @analysed_module.complexity %></span><small> complexity</small></div>
+              <div><span class="metric"><%= @analysed_module.duplication %></span><small> duplications</small></div>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div class="col-md-4">
+        <div class="code-tabs">
+          <ul class="nav nav-pills right-to-left">
+            <li><a href="#" id="toggle-code" class="toggle-button button">code</a></li>
+            <li class="active">
+              <a href="#" id="toggle-smells" class="toggle-button button">
+                <%= @analysed_module.smells_count %>
+                <%= @analysed_module.smells_count <= 1 ? 'smell' : 'smells' %>
+              </a>
+            </li>
+          </ul>
+        </div>
+      </div>
+    </div>
+
+    <code class="prettyprint linenums lang-ruby file-code js-file-code"><%= yield %></code>
+  </div>
+</div>

data/lib/rubycritic/generators/html/templates/code_index.html.erb

@@ -0,0 +1,55 @@
+<div class="row">
+    <!--Page Title -->
+    <div class="Page_Title">
+      <h3>Code</h3>
+    </div>
+    <!--End Page Title -->
+    <div class="Content_Wrapper">
+      <table id="codeTable" class="table code sortable-table tablesorter">
+        <thead>
+          <tr>
+            <% unless Config.suppress_ratings %>
+              <th width="10%" class="table-header">Rating<span class="sort-type"></span></th>
+            <% end %>
+            <th width="50%" class="table-header">Name<span class="sort-type"></span></th>
+            <th width="10%" class="table-header">Churn<span class="sort-type"></span></th>
+            <th width="10%" class="table-header">Complexity<span class="sort-type"></span></th>
+            <th width="10%" class="table-header">Duplication<span class="sort-type"></span></th>
+            <th width="10%" class="table-header">Smells<span class="sort-type"></span></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @analysed_modules.each do |analysed_module| %>
+            <tr>
+              <% unless Config.suppress_ratings %>
+                <td>
+                  <% if Config.build_mode? %>
+                    <% master_analysed_module = Config.base_branch_collection.find(analysed_module.pathname) %>
+                    <% if master_analysed_module.cost > analysed_module.cost %>
+                      <span class="glyphicon glyphicon-arrow-up green-color"></span>
+                    <% elsif master_analysed_module.cost < analysed_module.cost %>
+                      <span class="glyphicon glyphicon-arrow-down red-color"></span>
+                    <% else %>
+                      <span class="empty-span glyphicon"></span>
+                    <% end %>
+                  <% end %>
+                  <div class="rating <%= analysed_module.rating.to_s.downcase %>"><%= analysed_module.rating %></div>
+                </td>
+              <% end %>
+              <td>
+                <ul class="nav nav-pills">
+                  <li role="presentation" >
+                    <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>"><%= analysed_module.name %></a>
+                  </li>
+                </ul>
+              </td>
+              <td><%= analysed_module.churn %></td>
+              <td><%= analysed_module.complexity %></td>
+              <td><%= analysed_module.duplication %></td>
+              <td><%= analysed_module.smells_count %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+  </div>
+</div>

data/lib/rubycritic/generators/html/templates/layouts/application.html.erb

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <title>Ruby Critic - Home</title>
+    <meta name="description" content="">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <!-- StyleSheets -->
+    <link href="<%= stylesheet_path(:'bootstrap.min') %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+    <link href="<%= stylesheet_path(:'font-awesome.min') %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+    <link href="<%= stylesheet_path(:'prettify.custom_theme') %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+    <link href="<%= stylesheet_path(:application) %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+  </head>
+
+  <body>
+    <header class="navbar navbar-default navbar-fixed-top">
+      <a href="#menu-toggle" class="btn btn-default hidden-lg visible-sm-* hidden-md visible-xs-* pull-left" id="menu-toggle"><i class="fa fa-bars" aria-hidden="true"></i></a>
+      <a href="<%= file_path('overview.html') %>"><img src="<%= image_path('logo.png') %>" alt="Ruby Critic Logo" title="Ruby Critic Logo" width="55"><span class="logo">RUBYCRITIC</span></a>
+      <% if Config.compare_branches_mode? %>
+        <ul class="nav navbar-nav navbar-right">
+          <a href="<%= @base_path %>"><span class="branch"><%= Config.base_branch %></span></a>
+          <a href="<%= @feature_path %>"><span class="branch"><%= Config.feature_branch %></span></a>
+          <a href="<%= @build_path %>"><span class="branch">Build</span></a>
+        </ul>
+      <% end %>
+    </header>
+    <div id="wrapper">
+      <!-- Sidebar -->
+      <aside id="sidebar-wrapper">
+        <ul class="sidebar-nav">
+          <li class="sidebar-item">
+            <a href="<%= file_path('overview.html') %>" class="project-nav-item overview-nav"><i class="fa fa-dashboard"></i>Overview</a>
+          </li>
+          <li class="sidebar-item">
+            <a href="<%= file_path('code_index.html') %>" class="project-nav-item code-index-nav"><i class="fa fa-code"></i>Code</a>
+          </li>
+          <li class="sidebar-item">
+            <a href="<%= file_path('smells_index.html') %>" class="project-nav-item smells-index-nav"><i class="fa fa-warning"></i>Smells</a>
+          </li>
+          <li class="sidebar-item">
+            <a href="<%= file_path('simple_cov_index.html') %>" class="project-nav-item coverage-index-nav"><i class="fa fa-umbrella"></i>Coverage</a>
+          </li>
+        </ul>
+      </aside>
+      <!-- /#sidebar-wrapper -->
+      <div id="page-content-wrapper">
+        <div class="container-fluid">
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+
+    <!-- JavaScripts -->
+    <%= javascript_tag(:'jquery.min') %>
+    <%= javascript_tag(:'jquery.tablesorter.min') %>
+    <%= javascript_tag(:'jquery.scrollTo.min') %>
+    <%= javascript_tag(:'jquery.timeago') %>
+    <%= javascript_tag(:'highcharts.src-4.0.1') %>
+    <%= javascript_tag(:'prettify') %>
+    <%= javascript_tag(:'bootstrap.min') %>
+    <%= javascript_tag(:application) %>
+    <%= javascript_tag(:'jquery.filtertable.min') %>
+  </body>
+</html>

data/lib/rubycritic/generators/html/templates/line.html.erb

@@ -0,0 +1 @@
+<%= @text %>

data/lib/rubycritic/generators/html/templates/overview.html.erb

@@ -0,0 +1,68 @@
+<!-- Page Content -->
+<div id="page-content-wrapper">
+  <div class="container-fluid">
+    <div class="row">
+      <!--Page Title -->
+      <div class="Page_Title">
+       <h3>Overview</h3>
+      </div>
+      <!--End Page Title -->
+      <div class="Content_Wrapper">
+        <!--Grade Wrapper-->
+        <div class="col-xs-12 col-sm-4 col-md-6 col-lg-4">
+          <div class="Graph_Cards fadeIn">
+          <div id="gpa-chart" class="chart-container"></div>
+          <div id="addText" ></div>
+          </div>
+        </div>
+        <!--End Grade Wrapper-->
+
+        <!--Churn vs Complexity graph-->
+        <div class="col-xs-7 col-sm-7 col-md-6 col-lg-8">
+          <div class="Graph_Cards fadeIn">
+            <% if Config.source_control_present? %>
+              <div id="churn-vs-complexity-graph-container" class="chart-container"></div>
+            <% else %>
+              <div id="churn-error">We can't show you Churn-vs-Complexity graph because this project does not seem to be under a source code management system like git or perforce at the moment. This doesn't mean that anything is wrong, it just means certain features like this one are not available.</div>
+            <% end %>
+
+            <script>
+             var turbulenceData = <%= @turbulence_data %>;
+             var score = <%= @score %>;
+            </script>
+          </div>
+        </div>
+        <!--End Churn vs Complexity graph-->
+
+        <!--Summary Wrapper-->
+        <div class="col-xs-12 col-sm-12 col-md-12 col-lg-12">
+          <div class="Graph_Cards Summary_Wrapper_Main fadeIn-3">
+            <h4>Summary</h4>
+            <% ratings =  { 'A' => 'Green_DR', 'B' => 'Green_Light', 'C' => 'Yellow_Color',
+                            'D' => 'Orange_Color', 'F' => 'Red_Color' } %>
+            <div class="Summary_Wrapper">
+              <% ratings.each do |rating, color| %>
+                <div class="col-xs-12 col-sm-6 col-md-6 col-lg-4">
+                  <div class="summary_wrap <%= color %>">
+                    <div class="pull-left Summary_Title col-xs-3 col-sm-3 col-md-3 col-lg-3">
+                      <h3><%= rating %></h3>
+                    </div>
+                    <div class="pull-right Summary_Content col-xs-9 col-sm-9 col-md-9 col-lg-9">
+                      <ul class="list-inline">
+                        <li><h4 id="ratingAfileCount"><%= @summary[rating][:files] %></h4><span>files</span></li>
+                        <li><h4 id="ratingAfileCount"><%= @summary[rating][:churns] %></h4><span>churns</span></li>
+                        <li><h4 id="ratingAfileCount"><%= @summary[rating][:smells] %></h4><span>smells</span></li>
+                      </ul>
+                    </div>
+                  </div>
+                </div>
+              <% end %>
+            </div>
+          </div>
+        </div>
+        <!--End Summary Wrapper-->
+      </div>
+    </div>
+  </div>
+</div>
+<!-- /#page-content-wrapper -->

data/lib/rubycritic/generators/html/templates/simple_cov_index.html.erb

@@ -0,0 +1,44 @@
+<!-- Page Content -->
+<div id="page-content-wrapper">
+  <div class="container-fluid">
+    <div class="row">
+      <!--Page Title -->
+      <div class="Page_Title">
+        <h3>Coverage</h3>
+      </div>
+      <!--End Page Title -->
+      <div class="Content_Wrapper">
+        <table id="js-index-table" class="table coverage-index-table index-table sortable-table">
+          <thead>
+            <tr>
+              <% unless Config.suppress_ratings %>
+                <th width="10%" class="table-header">Rating<span class="sort-type"></span></th>
+              <% end %>
+              <th width="80%" class="table-header">Name<span class="sort-type"></span></th>
+              <th width="10%" class="table-header">Coverage<span class="sort-type"></span></th>
+            </tr>
+          </thead>
+          <% @analysed_modules.each do |analysed_module| %>
+            <tr>
+              <tr>
+                <% unless Config.suppress_ratings %>
+                  <td>
+                    <div class="rating <%= analysed_module.rating.to_s.downcase %>"><%= analysed_module.coverage_rating %></div>
+                  </td>
+                <% end %>
+                <td>
+                  <ul class="nav nav-pills">
+                    <li role="presentation" >
+                      <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>"><%= analysed_module.name %></a>
+                    </li>
+                  </ul>
+                </td>
+                <td><%= '%g' % analysed_module.coverage %>%</td>
+            </tr>
+          <% end %>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>
+<!-- /#page-content-wrapper -->

data/lib/rubycritic/generators/html/templates/smells_index.html.erb

@@ -0,0 +1,47 @@
+<!-- Page Content -->
+<div id="page-content-wrapper">
+  <div class="container-fluid">
+    <div class="row">
+      <!--Page Title -->
+      <div class="Page_Title">
+        <h3>Smells</h3>
+      </div>
+      <!--End Page Title -->
+      <div class="Content_Wrapper">
+        <table id="js-index-table" class="table smells-index-table index-table sortable-table">
+          <thead>
+            <tr>
+              <th width="30%" class="table-header">Smell<span class="sort-type"></span></th>
+              <th width="65%" class="table-header">Locations<span class="sort-type"></span></th>
+              <th width="5%" class="table-header">Status<span class="sort-type"></span></th>
+            </tr>
+          </thead>
+          <% @smells.each do |smell| %>
+            <tr>
+              <td><%= smell.type %></td>
+              <td>
+                <ul class="nav nav-pills">
+                  <% smell.locations.each do |location| %>
+                    <li role="presentation">
+                      <a href="<%= smell_location_path(location) %>"><%= @analysed_module_names[location.pathname] %></a>
+                    </li>
+                  <% end %>
+                </ul>
+              </td>
+              <td>
+                <% if @show_status %>
+                  <ul class="nav nav-pills">
+                    <li role="presentation">
+                      <td class="centered-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
+                    </li>
+                  </ul>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>
+<!-- /#page-content-wrapper -->

data/lib/rubycritic/generators/html/templates/smelly_line.html.erb

@@ -0,0 +1,23 @@
+<%= @text %>
+
+<ol class="nocode errors smells">
+<% @smells.each do |smell| %>
+  <li>
+    <div class="description">
+      <div class="heading">
+        <span>
+          <i class="fa fa-warning" aria-hidden="true"></i>
+          <a href="<%= smell.doc_url %>" target="_blank"><b><%= smell.type %></b></a>
+        </span>
+      </div>
+      <span><%= "#{smell.context} #{smell.message}" %></span>
+      <% if smell.multiple_locations? %>
+        <span>Locations:</span>
+        <% smell.locations.each_with_index do |location, index| %>
+          <a href="<%= smell_location_path(location) %>" class="js-smell-location"><%= index %></a>
+        <% end %>
+      <% end %>
+    </div>
+  </li>
+<% end %>
+</ol>

data/lib/rubycritic/generators/html/turbulence.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'json'
+module RubyCritic
+  module Turbulence
+    def self.data(analysed_modules)
+      analysed_modules.map do |analysed_module|
+        {
+          name: analysed_module.name,
+          x: analysed_module.churn,
+          y: analysed_module.complexity,
+          rating: analysed_module.rating.to_s
+        }
+      end.to_json
+    end
+  end
+end

data/lib/rubycritic/generators/html/view_helpers.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RubyCritic
+  module ViewHelpers
+    def timeago_tag(time)
+      "<time class='js-timeago' datetime='#{time}'>#{time}</time>"
+    end
+
+    def javascript_tag(file)
+      "<script src='" + asset_path("javascripts/#{file}.js").to_s + "'></script>"
+    end
+
+    def stylesheet_path(file)
+      asset_path("stylesheets/#{file}.css")
+    end
+
+    def asset_path(file)
+      relative_path("assets/#{file}")
+    end
+
+    def image_path(file)
+      asset_path("images/#{file}")
+    end
+
+    def file_path(file)
+      relative_path(file)
+    end
+
+    def smell_location_path(location)
+      smell_location = "#{location.pathname.sub_ext('.html')}#L#{location.line}"
+      if Config.compare_branches_mode?
+        file_path("#{File.expand_path(Config.feature_root_directory)}/#{smell_location}")
+      else
+        file_path(smell_location)
+      end
+    end
+
+    def code_index_path(root_directory, file_name)
+      file_path("#{File.expand_path(root_directory)}/#{file_name}")
+    end
+
+    private
+
+    def relative_path(file)
+      (root_directory + file).relative_path_from(file_directory)
+    end
+
+    def file_directory
+      raise NotImplementedError,
+            "The #{self.class} class must implement the #{__method__} method."
+    end
+
+    def root_directory
+      raise NotImplementedError,
+            "The #{self.class} class must implement the #{__method__} method."
+    end
+  end
+end