rubycritic 0.0.5 → 0.0.16

data/lib/rubycritic/report_generators/assets/javascripts/jquery.timeago-v1.4.1.js

@@ -0,0 +1,214 @@
+/**
+ * Timeago is a jQuery plugin that makes it easy to support automatically
+ * updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago").
+ *
+ * @name timeago
+ * @version 1.4.1
+ * @requires jQuery v1.2.3+
+ * @author Ryan McGeary
+ * @license MIT License - http://www.opensource.org/licenses/mit-license.php
+ *
+ * For usage and examples, visit:
+ * http://timeago.yarp.com/
+ *
+ * Copyright (c) 2008-2013, Ryan McGeary (ryan -[at]- mcgeary [*dot*] org)
+ */
+
+(function (factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['jquery'], factory);
+  } else {
+    // Browser globals
+    factory(jQuery);
+  }
+}(function ($) {
+  $.timeago = function(timestamp) {
+    if (timestamp instanceof Date) {
+      return inWords(timestamp);
+    } else if (typeof timestamp === "string") {
+      return inWords($.timeago.parse(timestamp));
+    } else if (typeof timestamp === "number") {
+      return inWords(new Date(timestamp));
+    } else {
+      return inWords($.timeago.datetime(timestamp));
+    }
+  };
+  var $t = $.timeago;
+
+  $.extend($.timeago, {
+    settings: {
+      refreshMillis: 60000,
+      allowPast: true,
+      allowFuture: false,
+      localeTitle: false,
+      cutoff: 0,
+      strings: {
+        prefixAgo: null,
+        prefixFromNow: null,
+        suffixAgo: "ago",
+        suffixFromNow: "from now",
+        inPast: 'any moment now',
+        seconds: "less than a minute",
+        minute: "about a minute",
+        minutes: "%d minutes",
+        hour: "about an hour",
+        hours: "about %d hours",
+        day: "a day",
+        days: "%d days",
+        month: "about a month",
+        months: "%d months",
+        year: "about a year",
+        years: "%d years",
+        wordSeparator: " ",
+        numbers: []
+      }
+    },
+
+    inWords: function(distanceMillis) {
+      if(!this.settings.allowPast && ! this.settings.allowFuture) {
+          throw 'timeago allowPast and allowFuture settings can not both be set to false.';
+      }
+
+      var $l = this.settings.strings;
+      var prefix = $l.prefixAgo;
+      var suffix = $l.suffixAgo;
+      if (this.settings.allowFuture) {
+        if (distanceMillis < 0) {
+          prefix = $l.prefixFromNow;
+          suffix = $l.suffixFromNow;
+        }
+      }
+
+      if(!this.settings.allowPast && distanceMillis >= 0) {
+        return this.settings.strings.inPast;
+      }
+
+      var seconds = Math.abs(distanceMillis) / 1000;
+      var minutes = seconds / 60;
+      var hours = minutes / 60;
+      var days = hours / 24;
+      var years = days / 365;
+
+      function substitute(stringOrFunction, number) {
+        var string = $.isFunction(stringOrFunction) ? stringOrFunction(number, distanceMillis) : stringOrFunction;
+        var value = ($l.numbers && $l.numbers[number]) || number;
+        return string.replace(/%d/i, value);
+      }
+
+      var words = seconds < 45 && substitute($l.seconds, Math.round(seconds)) ||
+        seconds < 90 && substitute($l.minute, 1) ||
+        minutes < 45 && substitute($l.minutes, Math.round(minutes)) ||
+        minutes < 90 && substitute($l.hour, 1) ||
+        hours < 24 && substitute($l.hours, Math.round(hours)) ||
+        hours < 42 && substitute($l.day, 1) ||
+        days < 30 && substitute($l.days, Math.round(days)) ||
+        days < 45 && substitute($l.month, 1) ||
+        days < 365 && substitute($l.months, Math.round(days / 30)) ||
+        years < 1.5 && substitute($l.year, 1) ||
+        substitute($l.years, Math.round(years));
+
+      var separator = $l.wordSeparator || "";
+      if ($l.wordSeparator === undefined) { separator = " "; }
+      return $.trim([prefix, words, suffix].join(separator));
+    },
+
+    parse: function(iso8601) {
+      var s = $.trim(iso8601);
+      s = s.replace(/\.\d+/,""); // remove milliseconds
+      s = s.replace(/-/,"/").replace(/-/,"/");
+      s = s.replace(/T/," ").replace(/Z/," UTC");
+      s = s.replace(/([\+\-]\d\d)\:?(\d\d)/," $1$2"); // -04:00 -> -0400
+      s = s.replace(/([\+\-]\d\d)$/," $100"); // +09 -> +0900
+      return new Date(s);
+    },
+    datetime: function(elem) {
+      var iso8601 = $t.isTime(elem) ? $(elem).attr("datetime") : $(elem).attr("title");
+      return $t.parse(iso8601);
+    },
+    isTime: function(elem) {
+      // jQuery's `is()` doesn't play well with HTML5 in IE
+      return $(elem).get(0).tagName.toLowerCase() === "time"; // $(elem).is("time");
+    }
+  });
+
+  // functions that can be called via $(el).timeago('action')
+  // init is default when no action is given
+  // functions are called with context of a single element
+  var functions = {
+    init: function(){
+      var refresh_el = $.proxy(refresh, this);
+      refresh_el();
+      var $s = $t.settings;
+      if ($s.refreshMillis > 0) {
+        this._timeagoInterval = setInterval(refresh_el, $s.refreshMillis);
+      }
+    },
+    update: function(time){
+      var parsedTime = $t.parse(time);
+      $(this).data('timeago', { datetime: parsedTime });
+      if($t.settings.localeTitle) $(this).attr("title", parsedTime.toLocaleString());
+      refresh.apply(this);
+    },
+    updateFromDOM: function(){
+      $(this).data('timeago', { datetime: $t.parse( $t.isTime(this) ? $(this).attr("datetime") : $(this).attr("title") ) });
+      refresh.apply(this);
+    },
+    dispose: function () {
+      if (this._timeagoInterval) {
+        window.clearInterval(this._timeagoInterval);
+        this._timeagoInterval = null;
+      }
+    }
+  };
+
+  $.fn.timeago = function(action, options) {
+    var fn = action ? functions[action] : functions.init;
+    if(!fn){
+      throw new Error("Unknown function name '"+ action +"' for timeago");
+    }
+    // each over objects here and call the requested function
+    this.each(function(){
+      fn.call(this, options);
+    });
+    return this;
+  };
+
+  function refresh() {
+    var data = prepareData(this);
+    var $s = $t.settings;
+
+    if (!isNaN(data.datetime)) {
+      if ( $s.cutoff == 0 || Math.abs(distance(data.datetime)) < $s.cutoff) {
+        $(this).text(inWords(data.datetime));
+      }
+    }
+    return this;
+  }
+
+  function prepareData(element) {
+    element = $(element);
+    if (!element.data("timeago")) {
+      element.data("timeago", { datetime: $t.datetime(element) });
+      var text = $.trim(element.text());
+      if ($t.settings.localeTitle) {
+        element.attr("title", element.data('timeago').datetime.toLocaleString());
+      } else if (text.length > 0 && !($t.isTime(element) && element.attr("title"))) {
+        element.attr("title", text);
+      }
+    }
+    return element.data("timeago");
+  }
+
+  function inWords(date) {
+    return $t.inWords(distance(date));
+  }
+
+  function distance(date) {
+    return (new Date().getTime() - date.getTime());
+  }
+
+  // fix for IE6 suckage
+  document.createElement("abbr");
+  document.createElement("time");
+}));

data/lib/rubycritic/report_generators/assets/stylesheets/application.css

@@ -1,8 +1,211 @@
+.group:after {
+  content: '';
+  display: table;
+  clear: both;
+}
+
+html {
+  overflow-y: scroll;
+}
+
+.project-header {
+  padding: 20px 0 20px 60px;
+}
+
+.logo {
+  float: left;
+  margin: 0;
+}
+
+.logo-link {
+  color: black;
+  text-decoration: none;
+}
+
+.project-nav {
+  float: left;
+  margin-left: 100px;
+  line-height: 2.5em;
+}
+
+.project-nav-item {
+  color: black;
+  margin-right: 40px;
+  text-decoration: none;
+}
+
+.chart-container {
+  max-width: 1000px;
+  margin: 0 auto;
+}
+
+.index-table {
+  width: 100%;
+  border-collapse: collapse;
+  table-layout: fixed;
+}
+
+.index-table th {
+  text-align: left;
+  padding: 8px 10px;
+  border-bottom: 1px solid silver;
+  font-size: 1.55em;
+  font-weight: normal;
+  background-color: white;
+}
+
+.index-table .circle {
+  width: 28px;
+  height: 28px;
+}
+
+.index-table .circled-rating {
+  display: inline-block;
+  line-height: 28px;
+}
+
+.sortable-table .headerSortUp,
+.sortable-table .headerSortDown {
+  border: 1px solid silver;
+  border-bottom: 0;
+}
+
+.sortable-table th:hover {
+  background-color: #ECECEC;
+  cursor: pointer;
+}
+
+.index-table td {
+  padding: 12px 10px;
+}
+
+.index-table .first-cell {
+  padding-left: 60px;
+}
+
+.index-table .last-cell {
+  padding-right: 60px;
+}
+
+.index-table .numeric-cell {
+  text-align: right;
+}
+
+.index-table .centered-cell {
+  text-align: center;
+}
+
+.button {
+  margin: 0;
+  padding: 0.5em 1em;
+  border: 1px solid black;
+  font-size: 0.9em;
+  border-radius: 0.2em;
+  cursor: pointer;
+  transition-property: background-color;
+  -webkit-transition-duration: 0.5s;
+  transition-duration: 0.5s;
+}
+
+.circle {
+  display: block;
+  border-radius: 50%;
+}
+
+.circled-rating {
+  text-align: center;
+  color: white;
+  font-family: Arial, "Helvetica Neue", Helvetica, sans-serif;
+  font-weight: bold;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+  cursor: default;
+}
+
+.file-header {
+  position: relative;
+  padding: 0 0 10px 60px;
+  border-bottom: 1px solid silver;
+}
+
+.file-header .circle {
+  width: 50px;
+  height: 50px;
+}
+
+.file-header .circled-rating {
+  float: left;
+  line-height: 50px;
+  font-size: 32px;
+}
+
+.rating-a {
+  background-color: #2ECC40;
+}
+
+.rating-b {
+  background-color: #2ECC40;
+}
+
+.rating-c {
+  background-color: #FFDC00;
+}
+
+.rating-d {
+  background-color: #FF851B;
+}
+
+.rating-f {
+  background-color: #FF4136;
+}
+
+.file-name {
+  float: left;
+  margin: 0 0 0 20px;
+  line-height: 50px;
+  font-weight: normal;
+}
+
+.file-committed-at {
+  float: left;
+  margin: 20px 0 0 28px;
+  font-size: 13px;
+  color: #666666;
+}
+
+.file-stats {
+  clear: both;
+  margin-left: 68px;
+  width: 300px;
+}
+
+.file-stat {
+  float: left;
+  margin: 3px;
+  width: 130px;
+  font-size: 12px;
+  white-space: nowrap;
+}
+
+.smells-toggle-button {
+  position: absolute;
+  right: 64px;
+  bottom: -17px;
+  border-color: silver;
+  background-color: #EEEBE9;
+}
+
+.smells-toggle-button:hover {
+  background-color: #D1CFCD;
+}
+
 .smells {
   margin: 2px 0 22px 0;
   padding-left: 0;
   border: 1px solid #000;
-  background-color: #DDD;
+  background-color: #EEEBE9;
   white-space: normal;
   list-style-type: disc;
 }

data/lib/rubycritic/report_generators/assets/stylesheets/prettify.custom_theme.css

@@ -57,10 +57,7 @@
 
 /* Specify class=linenums on a pre to get line numbering */
 .prettyprint ol.linenums {
-    margin-top: 0;
-    margin-bottom: 0;
-    background-color: #EEEBE9;
-    padding-left: 66px;
+    padding-left: 60px;
 }
 
 .prettyprint li {

data/lib/rubycritic/report_generators/base.rb

@@ -0,0 +1,49 @@
+require "erb"
+require "rubycritic/report_generators/view_helpers"
+
+module Rubycritic
+  module Generator
+
+    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(::Rubycritic.configuration.root)
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/code_file.rb

@@ -0,0 +1,38 @@
+require "rubycritic/report_generators/base"
+require "rubycritic/report_generators/line"
+
+module Rubycritic
+  module Generator
+
+    class CodeFile < Base
+      LINE_NUMBER_OFFSET = 1
+      TEMPLATE = erb_template("code_file.html.erb")
+
+      def initialize(analysed_file)
+        @analysed_file = analysed_file
+        @pathname = @analysed_file.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_file.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

data/lib/rubycritic/report_generators/code_index.rb

@@ -0,0 +1,24 @@
+require "rubycritic/report_generators/base"
+
+module Rubycritic
+  module Generator
+
+    class CodeIndex < Base
+      TEMPLATE = erb_template("code_index.html.erb")
+
+      def initialize(analysed_files)
+        @analysed_files = analysed_files
+      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

data/lib/rubycritic/report_generators/current_code_file.rb

@@ -0,0 +1,17 @@
+require "rubycritic/report_generators/code_file"
+
+module Rubycritic
+  module Generator
+
+    class CurrentCodeFile < CodeFile
+      def file_directory
+        @file_directory ||= root_directory
+      end
+
+      def file_name
+        "current_file.html"
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/line.rb

@@ -0,0 +1,31 @@
+require "rubycritic/report_generators/base"
+require "cgi"
+
+module Rubycritic
+  module Generator
+
+    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
+        @template =
+          if @smells.empty?
+            NORMAL_TEMPLATE
+          else
+            SMELLY_TEMPLATE
+          end
+      end
+
+      def render
+        @template.result(binding).delete("\n") + "\n"
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/overview.rb

@@ -0,0 +1,25 @@
+require "rubycritic/report_generators/base"
+require "rubycritic/turbulence"
+
+module Rubycritic
+  module Generator
+
+    class Overview < Base
+      TEMPLATE = erb_template("overview.html.erb")
+
+      def initialize(analysed_files)
+        @turbulence_data = Turbulence.data(analysed_files)
+      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

data/lib/rubycritic/report_generators/smells_index.rb

@@ -0,0 +1,24 @@
+require "rubycritic/report_generators/base"
+
+module Rubycritic
+  module Generator
+
+    class SmellsIndex < Base
+      TEMPLATE = erb_template("smells_index.html.erb")
+
+      def initialize(smells)
+        @smells = smells
+      end
+
+      def file_name
+        "smells_index.html"
+      end
+
+      def render
+        index_body = TEMPLATE.result(get_binding)
+        LAYOUT_TEMPLATE.result(get_binding { index_body })
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,36 @@
+<div class="file-header group">
+  <span class="rating-<%= @analysed_file.rating.to_s.downcase %> circled-rating circle "><%= @analysed_file.rating %></span>
+  <h2 class="file-name"><%= @analysed_file.name %></h2>
+
+  <span class="file-committed-at">
+  <% if @analysed_file.committed_at %>
+    Updated <%= timeago_tag(@analysed_file.committed_at) %></span>
+  <% else %>
+    Never committed
+  <% end %>
+  </span>
+
+  <div class="file-stats group">
+    <div class="file-stat">
+      <%= @analysed_file.complexity %> complexity
+    </div>
+    <div class="file-stat">
+      <%= @analysed_file.complexity_per_method %> complexity per method
+    </div>
+    <div class="file-stat">
+      <%= @analysed_file.churn %> churn
+    </div>
+    <div class="file-stat">
+      <%= @analysed_file.methods_count %> methods
+    </div>
+    <div class="file-stat">
+      <%= @analysed_file.duplication %> duplication
+    </div>
+  </div>
+
+  <% if @analysed_file.has_smells? %>
+    <button id="js-toggle-smells" class="smells-toggle-button button">Toggle Smells</button>
+  <% end %>
+</div>
+
+<code class="prettyprint linenums lang-ruby file-code js-file-code"><%= yield %></code>