rubycritic 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a1de618127c08ea218625eaf15fd6033ba99cfa
-  data.tar.gz: 5c7835df2a2841e3312bcf4d21b4838c7f1ef85f
+  metadata.gz: e3de50932159be5b26bc5a2cf4afe9eeec17e8dc
+  data.tar.gz: c7f9620aae8d000fe5f674844158d48296c706c3
 SHA512:
-  metadata.gz: 58f34ab665bde1c35c6ba021dd6bfcbb1ed56e644c6abd0bb4d7def02f4f571c3d58cd3e5e90b14575b815bb0552abb81cfc92d05007a3739877f3b87914ef24
-  data.tar.gz: 7678a5279a12a6d943d22340fe1d32b26e5af95351ed6f6f315390509702cadf4f737a758b5dc01896beb2bbb460eeb7fcd3132ddc1443dc60aedbefbefe7130
+  metadata.gz: 28d945ef0e7036d298e1c8ff54b909c7c4c67b777e6ccfad20c548905ccb515fe849c351866b38bbba6765dfd31af610d41ae6c6cede57e469db3b54ee4f44bb
+  data.tar.gz: 509b8ffc4b0cdcb85cccacbbe242a5a5bc5f0e06e2975d12ac3827d9f168c0426793bcde26d4c48cf953e49ff41ba0039dce216428e8a94f009ba0e964f21522

data/lib/rubycritic/location.rb

@@ -10,16 +10,8 @@ module Rubycritic
       @line = line
     end
 
-    def path
-      @pathname.to_s
-    end
-
-    def file
-      @pathname.basename.to_s
-    end
-
     def to_s
-      "#{path}:#{line}"
+      "#{pathname}:#{line}"
     end
 
     def ==(other)

data/lib/rubycritic/report_generators/assets/javascripts/application.js

@@ -1,5 +1,23 @@
 prettyPrint();
 
+highlightLineFromFragment();
+
+function highlightLineFromFragment() {
+    highlightLine(window.location.hash)
+}
+
+$(".js-file-code").on("click", ".js-smell-location", highlightSmellyLine);
+
+function highlightSmellyLine() {
+    var lineId = "#" + this.href.split("#")[1];
+    $(".js-file-code li").removeClass("highlight");
+    highlightLine(lineId);
+}
+
+function highlightLine(lineReference) {
+    $(lineReference).addClass("highlight");
+}
+
 $("#js-toggle-smells").on("click", toggleSmells);
 
 function toggleSmells() {

data/lib/rubycritic/report_generators/assets/javascripts/prettify.js

@@ -1097,11 +1097,18 @@ var prettyPrint;
     ol.className = 'linenums';
     var offset = Math.max(0, ((opt_startLineNum - 1 /* zero index */)) | 0) || 0;
     for (var i = 0, n = listItems.length; i < n; ++i) {
-      li = listItems[i];
+      var li = listItems[i];
+      var j = i + offset + 1;
       // Stick a class on the LIs so that stylesheets can
       // color odd/even rows, or any other row pattern that
       // is co-prime with 10.
       li.className = 'L' + ((i + offset) % 10);
+
+      // Stick an ID on the LIs so that stylesheets can
+      // highlight a line or set of lines
+      li.id = 'L' + j;
+      li.setAttribute('href', '#L' + j);
+
       if (!li.firstChild) {
         li.appendChild(document.createTextNode('\xA0'));
       }

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

@@ -66,3 +66,7 @@
 .prettyprint li {
     color: #999;
 }
+
+li.highlight {
+    background-color: #FFC;
+}

data/lib/rubycritic/report_generators/base_generator.rb

@@ -1,9 +1,13 @@
+require "rubycritic/report_generators/view_helpers"
+
 module Rubycritic
 
   class BaseGenerator
     REPORT_DIR = File.expand_path("tmp/rubycritic", Dir.getwd)
     TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
 
+    include ViewHelpers
+
     def file_href
       "file://#{file_pathname}"
     end
@@ -21,23 +25,17 @@ module Rubycritic
     end
 
     def render
-      raise NotImplementedError.new("You must implement the render file_name method.")
+      raise NotImplementedError.new("You must implement the render method.")
     end
 
-    def javascript_path(file)
-      File.join(REPORT_DIR, "assets/javascripts/#{file}.js")
-    end
-
-    def stylesheet_path(file)
-      File.join(REPORT_DIR, "assets/stylesheets/#{file}.css")
+    def get_binding
+      binding
     end
 
-    def index_path
-      File.join(REPORT_DIR, "index.html")
-    end
+    private
 
-    def get_binding
-      binding
+    def root_directory
+      REPORT_DIR
     end
   end
 

data/lib/rubycritic/report_generators/file_generator.rb

@@ -23,7 +23,7 @@ module Rubycritic
     end
 
     def analysed_file_name
-      @pathname.basename.sub_ext("").to_s
+      @pathname.basename.sub_ext("")
     end
 
     def render
@@ -34,8 +34,8 @@ module Rubycritic
         file_code << LineGenerator.new(line_text, line_smells).render
       end
 
-      file_body = FILE_TEMPLATE.result(self.get_binding { file_code })
-      LAYOUT_TEMPLATE.result(self.get_binding { file_body })
+      file_body = FILE_TEMPLATE.result(get_binding { file_code })
+      LAYOUT_TEMPLATE.result(get_binding { file_body })
     end
   end
 

data/lib/rubycritic/report_generators/index_generator.rb

@@ -20,8 +20,8 @@ module Rubycritic
     end
 
     def render
-      index_body = INDEX_TEMPLATE.result(self.get_binding)
-      LAYOUT_TEMPLATE.result(self.get_binding { index_body })
+      index_body = INDEX_TEMPLATE.result(get_binding)
+      LAYOUT_TEMPLATE.result(get_binding { index_body })
     end
   end
 

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

@@ -2,6 +2,14 @@
 
 <ul class="nocode smells js-smells">
 <% @smells.each do |smell| %>
-  <li class="smell <%= smell.status %>"><span class="description"><%= smell %></span></li>
+  <li class="smell <%= smell.status %>">
+    <span class="description"><%= smell %>
+      <% if smell.has_multiple_locations? %>
+        <% smell.locations.each_with_index do |location, index| %>
+          <a href="<%= smell_location_path(location) %>" class="js-smell-location"><%= index %></a>
+        <% end %>
+      <% end %>
+    </span>
+  </li>
 <% end %>
 </ul>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -0,0 +1,26 @@
+module Rubycritic
+
+  module ViewHelpers
+    def javascript_path(file)
+      asset_path(File.join("javascripts", "#{file}.js"))
+    end
+
+    def stylesheet_path(file)
+      asset_path(File.join("stylesheets", "#{file}.css"))
+    end
+
+    def asset_path(file)
+      File.join(root_directory, "assets", file)
+    end
+
+    def smell_location_path(location)
+      pathname = location.pathname
+      File.join(root_directory, File.dirname(pathname), "#{pathname.basename.sub_ext("")}.html#L#{location.line}")
+    end
+
+    def index_path
+      File.join(root_directory, "index.html")
+    end
+  end
+
+end

data/lib/rubycritic/smell.rb

@@ -21,6 +21,10 @@ module Rubycritic
       locations.any? { |location| location == other_location }
     end
 
+    def has_multiple_locations?
+      locations.length > 1
+    end
+
     def ==(other)
       self.class == other.class && state == other.state
     end

data/lib/rubycritic/smell_adapters/reek.rb

@@ -25,7 +25,7 @@ module Rubycritic
       end
 
       def smell_locations(file_path, file_lines)
-        file_lines.uniq.map do |file_line|
+        file_lines.uniq.sort.map do |file_line|
           Location.new(file_path, file_line)
         end
       end

data/lib/rubycritic/source_control_systems/git.rb

@@ -20,30 +20,34 @@ module Rubycritic
     end
 
     def travel_to_head
-      if uncommited_changes?
-        stash_successful = stash_changes
-      end
+      stash_successful = stash_changes
       yield
     ensure
-      `git stash pop` if stash_successful
+      travel_to_original_state if stash_successful
     end
 
     private
 
-    def uncommited_changes?
-      !`git status --porcelain`.empty?
-    end
-
     def stash_changes
+      return false if everything_commmited?
+
       stashes_count_before = stashes_count
       `git stash`
       stashes_count_after = stashes_count
       stashes_count_after > stashes_count_before
     end
 
+    def everything_commmited?
+      `git status --porcelain`.empty?
+    end
+
     def stashes_count
       `git stash list`.split("\n").length
     end
+
+    def travel_to_original_state
+      `git stash pop`
+    end
   end
 
 end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/lib/rubycritic/location_test.rb

@@ -9,12 +9,8 @@ describe Rubycritic::Location do
       @location = Rubycritic::Location.new(@path, @line)
     end
 
-    it "has a file path" do
-      @location.path.must_equal @path
-    end
-
-    it "has a file name" do
-      @location.file.must_equal "foo"
+    it "has a pathname" do
+      @location.pathname.must_equal Pathname.new(@path)
     end
 
     it "has a line number" do

data/test/lib/rubycritic/smell_test.rb

@@ -48,6 +48,15 @@ describe Rubycritic::Smell do
     end
   end
 
+  describe "#has_multiple_locations?" do
+    it "returns true if the smell has more than one location" do
+      location1 = Rubycritic::Location.new("./foo", "42")
+      location2 = Rubycritic::Location.new("./foo", "23")
+      smell = Rubycritic::Smell.new(:locations => [location1, location2])
+      smell.has_multiple_locations?.must_equal true
+    end
+  end
+
   it "is comparable" do
     attributes = {
       :context => "#bar",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -147,6 +147,7 @@ files:
 - lib/rubycritic/report_generators/templates/layouts/application.html.erb
 - lib/rubycritic/report_generators/templates/line.html.erb
 - lib/rubycritic/report_generators/templates/smelly_line.html.erb
+- lib/rubycritic/report_generators/view_helpers.rb
 - lib/rubycritic/revision_comparator.rb
 - lib/rubycritic/smell.rb
 - lib/rubycritic/smell_adapters/flog.rb