rubycritic 0.0.14 → 0.0.15

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

@@ -54,6 +54,16 @@ html {
   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;
@@ -81,6 +91,10 @@ html {
   text-align: right;
 }
 
+.index-table .centered-cell {
+  text-align: center;
+}
+
 .button {
   margin: 0;
   padding: 0.5em 1em;
@@ -93,21 +107,92 @@ html {
   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 {
-  margin: 0;
+  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;
-  top: 22px;
+  bottom: -17px;
   border-color: silver;
   background-color: #EEEBE9;
 }

data/lib/rubycritic/report_generators/code_file.rb

@@ -1,4 +1,3 @@
-require "erb"
 require "rubycritic/report_generators/base"
 require "rubycritic/report_generators/line"
 
@@ -12,7 +11,6 @@ module Rubycritic
       def initialize(analysed_file)
         @analysed_file = analysed_file
         @pathname = @analysed_file.pathname
-        @smells = @analysed_file.smells
       end
 
       def file_directory
@@ -27,7 +25,7 @@ module Rubycritic
         file_code = ""
         File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
           location = Location.new(@pathname, line_number)
-          line_smells = @smells.select { |smell| smell.at_location?(location) }
+          line_smells = @analysed_file.smells_at_location(location)
           file_code << Line.new(line_text, line_smells).render
         end
 

data/lib/rubycritic/report_generators/code_index.rb

@@ -1,4 +1,3 @@
-require "erb"
 require "rubycritic/report_generators/base"
 
 module Rubycritic

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
+        root_directory
+      end
+
+      def file_name
+        "current_file.html"
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/line.rb

@@ -1,4 +1,3 @@
-require "erb"
 require "rubycritic/report_generators/base"
 require "cgi"
 

data/lib/rubycritic/report_generators/overview.rb

@@ -1,4 +1,3 @@
-require "erb"
 require "rubycritic/report_generators/base"
 require "rubycritic/turbulence"
 
@@ -9,7 +8,7 @@ module Rubycritic
       TEMPLATE = erb_template("overview.html.erb")
 
       def initialize(analysed_files)
-        @turbulence_data = Turbulence.new(analysed_files).data
+        @turbulence_data = Turbulence.data(analysed_files)
       end
 
       def file_name

data/lib/rubycritic/report_generators/smells_index.rb

@@ -1,4 +1,3 @@
-require "erb"
 require "rubycritic/report_generators/base"
 
 module Rubycritic

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

@@ -1,6 +1,33 @@
-<div class="file-header">
+<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 %>

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

@@ -4,7 +4,9 @@
     <th class="first-cell">Name</th>
     <th class="numeric-cell" title="Number of times a file has changed">Churn</th>
     <th class="numeric-cell" title="Overall amount of code in a file">Complexity</th>
-    <th class="numeric-cell last-cell">Smells</th>
+    <th class="numeric-cell" title="Amount of code that is similar to other code">Duplication</th>
+    <th class="numeric-cell">Smells</th>
+    <th class="centered-cell last-cell">Rating</th>
   </tr>
 </thead>
 <tbody>
@@ -15,7 +17,9 @@
       </td>
       <td class="numeric-cell"><%= analysed_file.churn %></td>
       <td class="numeric-cell"><%= analysed_file.complexity %></td>
-      <td class="numeric-cell last-cell"><%= analysed_file.smells.length %></td>
+      <td class="numeric-cell"><%= analysed_file.duplication %></td>
+      <td class="numeric-cell"><%= analysed_file.smells.length %></td>
+      <td class="centered-cell last-cell"><span class="rating-<%= analysed_file.rating.to_s.downcase %> circled-rating circle"><%= analysed_file.rating %></td>
     </tr>
   <% end %>
 </tbody>

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

@@ -18,12 +18,13 @@
       </nav>
     </header>
     <%= yield %>
-    <script src="<%= javascript_path(:'jquery-2.1.0') %>"></script>
-    <script src="<%= javascript_path(:'jquery.tablesorter-2.0') %>"></script>
-    <script src="<%= javascript_path(:'jquery.floatThead-v1.2.7') %>"></script>
-    <script src="<%= javascript_path(:'highcharts.src-4.0.1') %>"></script>
-    <script src="<%= javascript_path(:'jquery.scrollTo-1.4.11') %>"></script>
-    <script src="<%= javascript_path(:'prettify-4-Mar-2013') %>"></script>
-    <script src="<%= javascript_path(:application) %>"></script>
+    <%= javascript_tag(:'jquery-2.1.0') %>
+    <%= javascript_tag(:'jquery.tablesorter-2.0') %>
+    <%= javascript_tag(:'jquery.floatThead-v1.2.7') %>
+    <%= javascript_tag(:'jquery.timeago-v1.4.1') %>
+    <%= javascript_tag(:'highcharts.src-4.0.1') %>
+    <%= javascript_tag(:'jquery.scrollTo-1.4.11') %>
+    <%= javascript_tag(:'prettify-4-Mar-2013') %>
+    <%= javascript_tag(:application) %>
   </body>
 </html>

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

@@ -1,5 +1,5 @@
 <div id="js-chart-container" class="chart-container"></div>
 
 <script type="text/javascript">
-  var turbulence_data = <%= @turbulence_data %>;
+  var turbulenceData = <%= @turbulence_data %>;
 </script>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -3,8 +3,12 @@ require "pathname"
 module Rubycritic
 
   module ViewHelpers
-    def javascript_path(file)
-      asset_path(File.join("javascripts", "#{file}.js"))
+    def timeago_tag(time)
+      "<time class='js-timeago' datetime='#{time}'>#{time}</time>"
+    end
+
+    def javascript_tag(file)
+      "<script src='" + asset_path(File.join("javascripts", "#{file}.js")) + "'></script>"
     end
 
     def stylesheet_path(file)

data/lib/rubycritic/reporters/main.rb

@@ -8,15 +8,15 @@ module Rubycritic
   module Reporter
 
     class Main < Base
-      def initialize(analysed_files, smells)
+      def initialize(analysed_files)
         @analysed_files = analysed_files
-        @smells = smells
+        @smells = analysed_files.flat_map(&:smells).uniq
       end
 
       def generate_report
         create_directories_and_files(generators)
         copy_assets_to_report_directory
-        overview_generator.file_href
+        report_location
       end
 
       private
@@ -42,6 +42,10 @@ module Rubycritic
           Generator::CodeFile.new(analysed_file)
         end
       end
+
+      def report_location
+        overview_generator.file_href
+      end
     end
 
   end

data/lib/rubycritic/reporters/mini.rb

@@ -1,18 +1,27 @@
 require "rubycritic/reporters/base"
-require "rubycritic/report_generators/code_file"
+require "rubycritic/report_generators/current_code_file"
 
 module Rubycritic
   module Reporter
 
     class Mini < Base
-      def initialize(analysed_file)
-        @analysed_file = analysed_file
+      def initialize(analysed_files)
+        @analysed_file = analysed_files.first
       end
 
       def generate_report
-        file_generator = Generator::CodeFile.new(@analysed_file)
         create_directories_and_files(file_generator)
         copy_assets_to_report_directory
+        report_location
+      end
+
+      private
+
+      def file_generator
+        @file_generator ||= Generator::CurrentCodeFile.new(@analysed_file)
+      end
+
+      def report_location
         file_generator.file_href
       end
     end

data/lib/rubycritic/revision_comparator.rb

@@ -1,5 +1,5 @@
-require "rubycritic/smells_serializer"
-require "rubycritic/source_locator"
+require "rubycritic/serializer"
+require "rubycritic/files_initializer"
 require "rubycritic/analysers_runner"
 require "rubycritic/smells_status_setter"
 
@@ -8,28 +8,31 @@ module Rubycritic
   class RevisionComparator
     SNAPSHOTS_DIR_NAME = "snapshots"
 
-    def initialize(smells, source_control_system)
-      @smells_now = smells
+    def initialize(analysed_files, source_control_system)
+      @analysed_files_now = analysed_files
       @source_control_system = source_control_system
     end
 
-    def smells
-      SmellsStatusSetter.new(smells_before, @smells_now).smells
+    def set_statuses
+      SmellsStatusSetter.set(
+        analysed_files_before.flat_map(&:smells),
+        @analysed_files_now.flat_map(&:smells)
+      )
     end
 
     private
 
-    def smells_before
-      serializer = SmellsSerializer.new(revision_file)
+    def analysed_files_before
+      serializer = Serializer.new(revision_file)
       if File.file?(revision_file)
         serializer.load
       else
-        smells = nil
+        analysed_files = FilesInitializer.init(["."])
         @source_control_system.travel_to_head do
-          smells = AnalysersRunner.new(paths_of_tracked_files).smells
+          AnalysersRunner.new(analysed_files, @source_control_system).run
         end
-        serializer.dump(smells)
-        smells
+        serializer.dump(analysed_files)
+        analysed_files
       end
     end
 
@@ -40,10 +43,6 @@ module Rubycritic
         @source_control_system.head_reference
       )
     end
-
-    def paths_of_tracked_files
-      SourceLocator.new(["."]).paths
-    end
   end
 
 end

data/lib/rubycritic/serializer.rb

@@ -0,0 +1,32 @@
+require "fileutils"
+
+module Rubycritic
+
+  class Serializer
+    def initialize(file)
+      @file = file
+    end
+
+    def load
+      Marshal.load(File.binread(@file))
+    end
+
+    def dump(content)
+      create_file_directory
+      File.open(@file, "w+") do |file|
+        Marshal.dump(content, file)
+      end
+    end
+
+    private
+
+    def create_file_directory
+      FileUtils.mkdir_p(file_directory)
+    end
+
+    def file_directory
+      File.dirname(@file)
+    end
+  end
+
+end