rubycritic 1.3.0 → 1.4.0

data/lib/rubycritic/{report_generators → generators/html}/assets/stylesheets/application.css

@@ -1,3 +1,7 @@
+* {
+  box-sizing: border-box;
+}
+
 .group:after {
   content: '';
   display: table;
@@ -6,10 +10,42 @@
 
 html {
   overflow-y: scroll;
+  font-family: "Droid Sans", Arial, "Helvetica Neue", Helvetica, sans-serif;
+  font-size: 1em;
+}
+
+html, body {
+  margin: 0;
+  padding: 0;
+}
+
+a {
+  color: #00adc4;
+  text-decoration: none;
+}
+
+a:hover {
+  border-bottom: 1px solid;
+}
+
+a:visited {
+  color: #4E6072;
+}
+
+.container {
+  width: 100%;
+  max-width: 80em;
+  margin: 0 auto;
 }
 
 .project-header {
-  padding: 20px 0 20px 60px;
+  padding: 1em 0 1em 0;
+  margin-bottom: 2em;
+  background-color: #F2F1EE;
+}
+
+.project-header .container {
+  padding: 0 2rem;
 }
 
 .logo {
@@ -17,21 +53,23 @@ html {
   margin: 0;
 }
 
-.logo-link {
+a.logo-link {
   color: black;
-  text-decoration: none;
 }
 
 .project-nav {
   float: left;
-  margin-left: 100px;
+  margin-left: 4rem;
   line-height: 2.5em;
 }
 
-.project-nav-item {
-  color: black;
-  margin-right: 40px;
-  text-decoration: none;
+a.project-nav-item {
+  color: #323333;
+  margin-right: 3rem;
+}
+
+a.project-nav-item:hover {
+  border-bottom: 1px solid;
 }
 
 .chart-container {
@@ -42,7 +80,6 @@ html {
 .index-table {
   width: 100%;
   border-collapse: collapse;
-  table-layout: fixed;
 }
 
 .index-table th {
@@ -54,6 +91,18 @@ html {
   background-color: white;
 }
 
+.floatThead-container {
+  box-shadow: 0 3px 4px -2px rgb(224, 223, 223);
+}
+
+.index-table tr:nth-child(odd) {
+  background-color: #f9f9f9;
+}
+
+.index-table tr:hover {
+  background-color: #e9fafc;
+}
+
 .index-table .circle {
   width: 28px;
   height: 28px;
@@ -64,27 +113,28 @@ html {
   line-height: 28px;
 }
 
-.sortable-table .headerSortUp,
-.sortable-table .headerSortDown {
-  border: 1px solid silver;
-  border-bottom: 0;
+.tablesorter-headerAsc .tablesorter-header-inner:after,
+.tablesorter-headerDesc .tablesorter-header-inner:after {
+  position: absolute;
 }
 
-.sortable-table th:hover {
-  background-color: #ECECEC;
-  cursor: pointer;
+.tablesorter-headerAsc .tablesorter-header-inner:after {
+  content: '\00A0\2191';
+}
+.tablesorter-headerDesc .tablesorter-header-inner:after {
+  content: '\00A0\2193';
 }
 
-.index-table td {
-  padding: 12px 10px;
+.sortable-table th:focus {
+  outline: none;
 }
 
-.index-table .first-cell {
-  padding-left: 60px;
+.sortable-table th:hover {
+  cursor: pointer;
 }
 
-.index-table .last-cell {
-  padding-right: 60px;
+.index-table td, .index-table th {
+  padding: 1rem 2rem;
 }
 
 .index-table .numeric-cell {
@@ -138,7 +188,7 @@ html {
 
 .file-header {
   position: relative;
-  padding: 0 0 10px 60px;
+  padding: 0 0 10px 2rem;
   border-bottom: 1px solid silver;
 }
 
@@ -175,7 +225,7 @@ html {
 
 .file-name {
   float: left;
-  margin: 0 0 0 20px;
+  margin: 0;
   line-height: 50px;
   font-weight: normal;
 }
@@ -189,7 +239,6 @@ html {
 
 .file-stats {
   clear: both;
-  margin-left: 68px;
   width: 300px;
 }
 
@@ -201,6 +250,18 @@ html {
   white-space: nowrap;
 }
 
+.file-header.rated .file-stats {
+  margin-left: 68px;
+}
+
+.file-header.rated .file-name {
+  margin-left: 20px;
+}
+
+.file-header.unrated .rating {
+  display: none;
+}
+
 .smells-toggle-button {
   position: absolute;
   right: 64px;
@@ -214,6 +275,7 @@ html {
 }
 
 .smells {
+  font-family: "Droid Sans", Arial, "Helvetica Neue", Helvetica, sans-serif;
   margin: 2px 0 22px 0;
   padding-left: 0;
   border: 1px solid #000;

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

@@ -0,0 +1,52 @@
+require "erb"
+require "pathname"
+require "rubycritic/generators/html/view_helpers"
+
+module Rubycritic
+  module Generator
+    module Html
+
+      class Base
+        def self.erb_template(template_path)
+          ERB.new(File.read(File.join(TEMPLATES_DIR, template_path)))
+        end
+
+        TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
+        LAYOUT_TEMPLATE = erb_template(File.join("layouts", "application.html.erb"))
+
+        include ViewHelpers
+
+        def file_href
+          "file://#{file_pathname}"
+        end
+
+        def file_pathname
+          File.join(file_directory, file_name)
+        end
+
+        def file_directory
+          @file_directory ||= root_directory
+        end
+
+        def file_name
+          raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+        end
+
+        def render
+          raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+        end
+
+        private
+
+        def root_directory
+          @root_directory ||= Pathname.new(Config.root)
+        end
+
+        def get_binding
+          binding
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require "rubycritic/generators/html/base"
+require "rubycritic/generators/html/line"
+
+module Rubycritic
+  module Generator
+    module Html
+
+      class CodeFile < Base
+        LINE_NUMBER_OFFSET = 1
+        TEMPLATE = erb_template("code_file.html.erb")
+
+        def initialize(analysed_module)
+          @analysed_module = analysed_module
+          @pathname = @analysed_module.pathname
+        end
+
+        def file_directory
+          @file_directory ||= root_directory + @pathname.dirname
+        end
+
+        def file_name
+          @pathname.basename.sub_ext(".html")
+        end
+
+        def render
+          file_code = ""
+          File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
+            location = Location.new(@pathname, line_number)
+            line_smells = @analysed_module.smells_at_location(location)
+            file_code << Line.new(file_directory, line_text, line_smells).render
+          end
+
+          file_body = TEMPLATE.result(get_binding { file_code })
+          LAYOUT_TEMPLATE.result(get_binding { file_body })
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "rubycritic/generators/html/base"
+
+module Rubycritic
+  module Generator
+    module Html
+
+      class CodeIndex < Base
+        TEMPLATE = erb_template("code_index.html.erb")
+
+        def initialize(analysed_modules)
+          @analysed_modules = analysed_modules
+        end
+
+        def file_name
+          "code_index.html"
+        end
+
+        def render
+          index_body = TEMPLATE.result(get_binding)
+          LAYOUT_TEMPLATE.result(get_binding { index_body })
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+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,27 @@
+require "rubycritic/generators/html/base"
+require "rubycritic/generators/html/turbulence"
+
+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)
+        end
+
+        def file_name
+          "overview.html"
+        end
+
+        def render
+          index_body = TEMPLATE.result(get_binding)
+          LAYOUT_TEMPLATE.result(get_binding { index_body })
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+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)
+        end
+
+        def file_name
+          "smells_index.html"
+        end
+
+        def render
+          index_body = TEMPLATE.result(get_binding)
+          LAYOUT_TEMPLATE.result(get_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/{report_generators → generators/html}/templates/code_file.html.erb

@@ -1,5 +1,7 @@
-<div class="file-header group">
-  <span class="rating-<%= @analysed_module.rating.to_s.downcase %> circled-text circle "><%= @analysed_module.rating %></span>
+<div class="file-header group <%= Config.suppress_ratings ? 'unrated' : 'rated' %>">
+  <span class="rating rating-<%= @analysed_module.rating.to_s.downcase %> circled-text circle">
+    <%= @analysed_module.rating %>
+  </span>
   <h2 class="file-name"><%= @analysed_module.name %></h2>
 
   <span class="file-committed-at">