rubycritic 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf20b3c6aba1b1063bb8485305bf26e942fbd784
-  data.tar.gz: cdb7f733d4376905de9845a930abd41367e0d561
+  metadata.gz: 0555c63872e8ba208eed9e2b2ba2e409b6bcc2af
+  data.tar.gz: 4ec5b4de84de9b3f9ab6c864d9cf1056f38c07b8
 SHA512:
-  metadata.gz: 893f288ebe082485d63eb7534e322320e139f0daa48d038acb9fe02bd48c76ce26721858e98ddccffd157e0e66babe253d0263968018392b244849ad5e1945c5
-  data.tar.gz: 05e1a071d9fdfab5b6b7eaed3d13fea7ae45b8f1a848ba005565321d37ba657c676874ff5db8fd6ccc0014345003afbedf72793adad152e5284ebda281b09e35
+  metadata.gz: 652e9d64e4ac113cb346833907e4d05b289f98f236aaa52970b40f9d472b38bf56bcb48fff30fc31d4e4774f28740dbbfafc5950a75c356d6bc3894b0dbf00bc
+  data.tar.gz: 20d381594ebb3ab984e95e0d62b00086ea379f119bbbd63698c51439f8e8b7ce83145b5d9bfba57d1d5c4e2868dee0cea239d5b3ef40d961decae640de9d240f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 3.1.1 / 2016-12-01
+
+* [FEATURE] Implement search and filter on code and smells view (rohitcy)
+* [CHANGE] Use Ruby's File instead of `wc` system command (by tejasbubane)
+* [BUGFIX] Fix code navigation links in the new UI (by rohitcy)
+* [BUGFIX] Add missing method 'head_reference' for Perforce source control (Rataah)
+
 # 3.1.0 / 2016-11-23
 
 * [FEATURE] Support for Perforce source control system (by Loic Gudet)

data/README.md

@@ -5,7 +5,7 @@ RubyCritic
 [![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
 [![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
-<img src="http://i.imgur.com/66HACCD.png" alt="RubyCritic Icon" align="right" />
+<img src="/images/logo.png" alt="RubyCritic Icon" align="right" />
 RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [Flay][2] and [Flog][3] to provide a quality report of your Ruby code.
 
 **Table of Contents**
@@ -28,15 +28,15 @@ This gem provides features such as:
 
 1. An overview of your project:
 
-  ![RubyCritic overview screenshot](http://i.imgur.com/oiE5O3X.png)
+  ![RubyCritic overview screenshot](/images/overview.png)
 
 2. An index of the project files with their respective number of smells:
 
-  ![RubyCritic code index screenshot](http://i.imgur.com/a0GCn48.png)
+  ![RubyCritic code index screenshot](/images/code.png)
 
 3. An index of the smells detected:
 
-  ![RubyCritic smells index screenshot](http://i.imgur.com/PvkFEe3.png)
+  ![RubyCritic smells index screenshot](/images/smells.png)
 
 4. When analysing code like the following:
 
@@ -52,11 +52,11 @@ This gem provides features such as:
 
   It basically turns something like this:
 
-  ![Reek output screenshot](http://i.imgur.com/5G2zPIC.png)
+  ![Reek output screenshot](/images/reek.png)
 
   Into something like this:
 
-  ![RubyCritic file code screenshot](http://i.imgur.com/RNzXewk.png)
+  ![RubyCritic file code screenshot](/images/smell-details.png)
 
 5. It uses your source control system (only Git, Mercurial and Perforce
   are currently supported) to compare your currently uncommitted
@@ -215,7 +215,7 @@ The current core team consists of:
 
 ## Credits
 
-![Whitesmith](http://i.imgur.com/Si2l3kd.png)
+![Whitesmith](/images/whitesmith.png)
 
 RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@Whitesmithco][10].
 

data/docs/core-metrics.md

@@ -3,7 +3,7 @@
 RubyCritic wraps around static analysis gems such as [Reek][2], [Flay][3] and [Flog][4] to provide a quality report of your Ruby code.
 
 Each of these gems are internally wrapped as an **Analyser**, with a collection of **AnalysedModule**s, which give us calculations of key metrics.
-The most important ones are **churn**, **complexity**, **cost** and **rating**. 
+The most important ones are **churn**, **complexity**, **cost** and **rating**.
 
 The output of RubyCritic will give you four values to help you judge your code's _odorousness_:
 
@@ -40,7 +40,7 @@ Complexity is the output of [Flog][4]. You can [read more about how it works][7]
 
 Both **churn** and **complexity** are presented as a chart:
 
-![RubyCritic overview screenshot](http://i.imgur.com/oiE5O3X.png)
+![RubyCritic overview screenshot](/images/churn-vs-complexity.png)
 
 Each file is represented by a dot. **The closer they are to the bottom-left corner, the better.**
 But keep in mind that you cannot reduce churn (well... not unless you re-write your repo's history :neckbeard:), so try to keep the dots as close to the bottom as possible.
@@ -54,7 +54,7 @@ Generally `A`'s & `B`'s are good enough, `C`'s serve as a warning and `D`'s & `F
 
 **Rating** is simply [a conversion][5] from the calculated **cost** to a letter.
 
-![RubyCritic code index screenshot](http://i.imgur.com/a0GCn48.png)
+![RubyCritic code index screenshot](/images/rating.png)
 
 ### Cost
 

data/lib/rubycritic/core/analysed_module.rb

@@ -32,7 +32,7 @@ module RubyCritic
     end
 
     def line_count
-      `wc -l "#{path}"`.strip.split(' ')[0].to_i
+      File.read(path).each_line.count
     end
 
     def cost

data/lib/rubycritic/generators/html/assets/javascripts/application.js

@@ -168,8 +168,6 @@ function getRatingWiseCount(rating){
   return count;
 };
 
-emphasizeLineFromFragment();
-
 function emphasizeLineFromFragment() {
   emphasizeLine(window.location.hash)
 }
@@ -195,12 +193,11 @@ function emphasizeLine(lineReference) {
 }
 
 function scrollToTarget(lineReference) {
+  window.location.hash = lineReference;
   $.scrollTo(lineReference, {
     duration: 300,
     easing: "linear",
-    onAfter: function() {
-      window.location.hash = lineReference;
-    }
+    offset: {top: -87}
   });
 }
 
@@ -251,3 +248,20 @@ $(function(){
     }
   });
 });
+
+function assignIdsToCodeLines(){
+  $($('.linenums')[1]).children().each(function(index){
+    $(this).attr('id', "L" + index)
+  });
+};
+
+$(document).ready(function(){
+  assignIdsToCodeLines();
+  emphasizeLineFromFragment();
+  initTableFilters();
+});
+
+var initTableFilters = function() {
+  $("#codeTable").filterTable({ignoreColumns: [2], placeholder: 'Filter by Name'});
+  $("#js-index-table").filterTable({ignoreColumns: [2, 3, 4, 5], placeholder: 'Filter by Smell or Location', inputSelector: 'form-control'});
+}

data/lib/rubycritic/generators/html/assets/javascripts/jquery.filtertable.min.js

@@ -0,0 +1,13 @@
+/**
+ * jquery.filterTable
+ *
+ * This plugin will add a search filter to tables. When typing in the filter,
+ * any rows that do not contain the filter will be hidden.
+ *
+ * Utilizes bindWithDelay() if available. https://github.com/bgrins/bindWithDelay
+ *
+ * @version v1.5.6
+ * @author Sunny Walker, swalker@hawaii.edu
+ * @license MIT
+ */
+!function($){var e=$.fn.jquery.split("."),t=parseFloat(e[0]),n=parseFloat(e[1]);2>t&&8>n?($.expr[":"].filterTableFind=function(e,t,n){return $(e).text().toUpperCase().indexOf(n[3].toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0},$.expr[":"].filterTableFindAny=function(e,t,n){var i=n[3].split(/[\s,]/),r=[];return $.each(i,function(e,t){var n=t.replace(/^\s+|\s$/g,"");n&&r.push(n)}),r.length?function(e){var t=!1;return $.each(r,function(n,i){return $(e).text().toUpperCase().indexOf(i.toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0?(t=!0,!1):void 0}),t}:!1},$.expr[":"].filterTableFindAll=function(e,t,n){var i=n[3].split(/[\s,]/),r=[];return $.each(i,function(e,t){var n=t.replace(/^\s+|\s$/g,"");n&&r.push(n)}),r.length?function(e){var t=0;return $.each(r,function(n,i){$(e).text().toUpperCase().indexOf(i.toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0&&t++}),t===r.length}:!1}):($.expr[":"].filterTableFind=jQuery.expr.createPseudo(function(e){return function(t){return $(t).text().toUpperCase().indexOf(e.toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0}}),$.expr[":"].filterTableFindAny=jQuery.expr.createPseudo(function(e){var t=e.split(/[\s,]/),n=[];return $.each(t,function(e,t){var i=t.replace(/^\s+|\s$/g,"");i&&n.push(i)}),n.length?function(e){var t=!1;return $.each(n,function(n,i){return $(e).text().toUpperCase().indexOf(i.toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0?(t=!0,!1):void 0}),t}:!1}),$.expr[":"].filterTableFindAll=jQuery.expr.createPseudo(function(e){var t=e.split(/[\s,]/),n=[];return $.each(t,function(e,t){var i=t.replace(/^\s+|\s$/g,"");i&&n.push(i)}),n.length?function(e){var t=0;return $.each(n,function(n,i){$(e).text().toUpperCase().indexOf(i.toUpperCase().replace(/"""/g,'"').replace(/"\\"/g,"\\"))>=0&&t++}),t===n.length}:!1})),$.fn.filterTable=function(e){var t={autofocus:!1,callback:null,containerClass:"filter-table",containerTag:"p",filterExpression:"filterTableFind",hideTFootOnFilter:!1,highlightClass:"alt",ignoreClass:"",ignoreColumns:[],inputSelector:null,inputName:"",inputType:"search",label:"Filter:",minChars:1,minRows:8,placeholder:"search this table",preventReturnKey:!0,quickList:[],quickListClass:"quick",quickListGroupTag:"",quickListTag:"a",visibleClass:"visible"},n=function(e){return e.replace(/&/g,"&amp;").replace(/"/g,"&quot;").replace(/</g,"&lt;").replace(/>/g,"&gt;")},i=$.extend({},t,e),r=function(e,t){var n=e.find("tbody");if(""===t||t.length<i.minChars)n.find("tr").show().addClass(i.visibleClass),n.find("td").removeClass(i.highlightClass),i.hideTFootOnFilter&&e.find("tfoot").show();else{var r=n.find("td");if(n.find("tr").hide().removeClass(i.visibleClass),r.removeClass(i.highlightClass),i.hideTFootOnFilter&&e.find("tfoot").hide(),i.ignoreColumns.length){var a=[];i.ignoreClass&&(r=r.not("."+i.ignoreClass)),a=r.filter(":"+i.filterExpression+'("'+t+'")'),a.each(function(){var e=$(this),t=e.parent().children().index(e);-1===$.inArray(t,i.ignoreColumns)&&e.addClass(i.highlightClass).closest("tr").show().addClass(i.visibleClass)})}else i.ignoreClass&&(r=r.not("."+i.ignoreClass)),r.filter(":"+i.filterExpression+'("'+t+'")').addClass(i.highlightClass).closest("tr").show().addClass(i.visibleClass)}i.callback&&i.callback(t,e)};return this.each(function(){var e=$(this),t=e.find("tbody"),a=null,l=null,s=null,o=!0;"TABLE"===e[0].nodeName&&t.length>0&&(0===i.minRows||i.minRows>0&&t.find("tr").length>=i.minRows)&&!e.prev().hasClass(i.containerClass)&&(i.inputSelector&&1===$(i.inputSelector).length?(s=$(i.inputSelector),a=s.parent(),o=!1):(a=$("<"+i.containerTag+" />"),""!==i.containerClass&&a.addClass(i.containerClass),a.prepend(i.label+" "),s=$('<input type="'+i.inputType+'" placeholder="'+i.placeholder+'" name="'+i.inputName+'" />'),i.preventReturnKey&&s.on("keydown",function(e){return 13===(e.keyCode||e.which)?(e.preventDefault(),!1):void 0})),i.autofocus&&s.attr("autofocus",!0),$.fn.bindWithDelay?s.bindWithDelay("keyup",function(){r(e,$(this).val())},200):s.bind("keyup",function(){r(e,$(this).val())}),s.bind("click search input paste blur",function(){r(e,$(this).val())}),o&&a.append(s),i.quickList.length>0&&(l=i.quickListGroupTag?$("<"+i.quickListGroupTag+" />"):a,$.each(i.quickList,function(e,t){var r=$("<"+i.quickListTag+' class="'+i.quickListClass+'" />');r.text(n(t)),"A"===r[0].nodeName&&r.attr("href","#"),r.bind("click",function(e){e.preventDefault(),s.val(t).focus().trigger("click")}),l.append(r)}),l!==a&&a.append(l)),o&&e.before(a))})}}(jQuery);

data/lib/rubycritic/generators/html/assets/stylesheets/application.css

@@ -526,3 +526,21 @@ span.metric {
   display: inline-block;
   margin-left: 20px;
 }
+
+.filter-table {
+  text-align: right;
+}
+
+.filter-table input {
+  width: 200px;
+  display: inline;
+  height: 34px;
+  padding: 6px 12px;
+  font-size: 14px;
+  line-height: 1.42857143;
+  color: #555;
+  background-color: #fff;
+  background-image: none;
+  border: 1px solid #ccc;
+  border-radius: 4px;
+}

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

@@ -52,5 +52,6 @@
     <%= javascript_tag(:'prettify') %>
     <%= javascript_tag(:'bootstrap.min') %>
     <%= javascript_tag(:application) %>
+    <%= javascript_tag(:'jquery.filtertable.min') %>
   </body>
 </html>

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

@@ -2,20 +2,22 @@
 
 <div class="nocode errors smells">
 <% @smells.each do |smell| %>
-  <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>
+  <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 %>
-    <% end %>
-  </div>
+    </div>
+  </li>
 <% end %>
 </div>

data/lib/rubycritic/source_control_systems/perforce.rb

@@ -3,7 +3,8 @@ require 'date'
 
 module RubyCritic
   module SourceControlSystem
-    PerforceStats = Struct.new(:filename, :revision, :last_commit, :opened?)
+    PERFORCE_FSTAT_OPTS = '-F "clientFile=*.rb" -T clientFile,headRev,headTime,headChange,action'.freeze
+    PerforceStats = Struct.new(:filename, :revision, :last_commit, :opened?, :head)
 
     class Perforce < Base
       register_system
@@ -53,12 +54,16 @@ module RubyCritic
         !perforce_files.values.count(&:opened?).zero?
       end
 
+      def head_reference
+        perforce_files.values.map(&:head).max_by(&:to_i)
+      end
+
       def self.build_file_cache
         # Chun is very slow if files stats are requested one by one
         # this fill a hash with the result of all ruby file in the current directory (and sub-directories)
         {}.tap do |file_cache|
           line_aggregator = []
-          `p4 fstat -F "clientFile=*.rb" -T clientFile,headRev,headTime,action #{Dir.getwd}...`.each_line do |line|
+          `p4 fstat #{PERFORCE_FSTAT_OPTS} #{Dir.getwd}...`.each_line do |line|
             Perforce.compute_line(file_cache, line_aggregator, line)
           end
           # handle remaining lines
@@ -86,7 +91,8 @@ module RubyCritic
           Perforce.normalized_file_path(perforce_lines['clientFile']),
           perforce_lines['headRev'],
           perforce_lines['headTime'],
-          perforce_lines.key?('action')
+          perforce_lines.key?('action'),
+          perforce_lines['headChange']
         )
       end
 

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.1.1'.freeze
 end

data/rubycritic.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'flay', '~> 2.8'
   spec.add_runtime_dependency 'flog', '~> 4.4'
   spec.add_runtime_dependency 'reek', '~> 4.4'
-  spec.add_runtime_dependency 'parser', '2.3.1.4'
+  spec.add_runtime_dependency 'parser', '2.3.3.1'
   spec.add_runtime_dependency 'ruby_parser', '~> 3.8'
   spec.add_runtime_dependency 'rainbow'
   spec.add_runtime_dependency 'launchy', '2.4.3'

data/test/lib/rubycritic/source_control_systems/perforce_test.rb

@@ -110,11 +110,13 @@ Server address: the.server.address.com
 ... clientFile /path/to/client/a_ruby_file.rb
 ... headTime 1473075551
 ... headRev 16
+... headChange 2103503
 
 ... clientFile /path/to/client/second_ruby_file.rb
 ... headTime 1464601668
 ... action opened
 ... headRev 12
+... headChange 2103504
         END
       end
 
@@ -128,12 +130,14 @@ Server address: the.server.address.com
           first_file.filename.must_equal '/path/to/client/a_ruby_file.rb'
           first_file.revision.must_equal '16'
           first_file.last_commit.must_equal '1473075551'
+          first_file.head.must_equal '2103503'
           first_file.opened?.must_equal false
 
           second_file = file_cache['/path/to/client/second_ruby_file.rb']
           second_file.filename.must_equal '/path/to/client/second_ruby_file.rb'
           second_file.revision.must_equal '12'
           second_file.last_commit.must_equal '1464601668'
+          second_file.head.must_equal '2103504'
           second_file.opened?.must_equal true
         end
       end
@@ -157,6 +161,12 @@ Server address: the.server.address.com
         RubyCritic::SourceControlSystem::Perforce.stubs(:`).once.returns(p4_stats)
         @system.revision?.must_equal true
       end
+
+      it 'retrieves the head reference of the repository' do
+        Dir.stubs(:getwd).returns('/path/to/client')
+        RubyCritic::SourceControlSystem::Perforce.stubs(:`).once.returns(p4_stats)
+        @system.head_reference.must_equal '2103504'
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.4
+        version: 2.3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.4
+        version: 2.3.3.1
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +265,15 @@ files:
 - features/step_definitions/rubycritic_steps.rb
 - features/step_definitions/sample_file_steps.rb
 - features/support/env.rb
+- images/churn-vs-complexity.png
+- images/code.png
+- images/logo.png
+- images/overview.png
+- images/rating.png
+- images/reek.png
+- images/smell-details.png
+- images/smells.png
+- images/whitesmith.png
 - lib/rubycritic.rb
 - lib/rubycritic/analysers/attributes.rb
 - lib/rubycritic/analysers/churn.rb
@@ -316,6 +325,7 @@ files:
 - lib/rubycritic/generators/html/assets/javascripts/application.js
 - lib/rubycritic/generators/html/assets/javascripts/bootstrap.min.js
 - lib/rubycritic/generators/html/assets/javascripts/highcharts.src-4.0.1.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.filtertable.min.js
 - lib/rubycritic/generators/html/assets/javascripts/jquery.min.js
 - lib/rubycritic/generators/html/assets/javascripts/jquery.scrollTo.min.js
 - lib/rubycritic/generators/html/assets/javascripts/jquery.tablesorter.js