rubycritic 0.0.3 → 0.0.4

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

@@ -1,12 +1,26 @@
-.smelly {
-  display: inline;
-  background-color: #FFE7C8;
+.smells {
+  margin: 2px 0 22px 0;
+  padding-left: 0;
+  border: 1px solid #000;
+  background-color: #DDD;
+  white-space: normal;
+  list-style-type: disc;
 }
 
 .smell {
-  background-color: #FFC8C8;
+  margin: 5px 5px 5px 30px;
+  font-size: 24px;
+}
+
+.smell.new {
+  color: #F00;
 }
 
 .smell.old {
-  background-color: #DFDFDF;
+  color: #FA0;
+}
+
+.smell .description {
+  color: #000;
+  font-size: initial;
 }

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

@@ -0,0 +1,68 @@
+/* Pretty printing styles. Used with prettify.js. */
+
+/* SPAN elements with the classes below are added by prettyprint. */
+.pln { /* plain text */
+    color: #000;
+}
+
+.str { /* string content */
+    color: #690;
+}
+
+.kwd { /* a keyword */
+    color: #07a;
+}
+
+.com { /* a comment */
+    color: #800;
+}
+
+.typ { /* a type name */
+    color: #905;
+}
+
+.lit { /* a literal value */
+    color: #a67f59;
+}
+
+.pun, .opn, .clo { /* punctuation, lisp open bracket, lisp close bracket */
+    color: #660;
+}
+
+.tag { /* a markup tag name */
+    color: #008;
+}
+
+.atn { /* a markup attribute name */
+    color: #606;
+}
+
+.atv { /* a markup attribute value */
+    color: #080;
+}
+
+.dec, .var { /* a declaration; a variable name */
+    color: #a67f59;
+}
+
+.fun { /* a function name */
+    color: red;
+}
+
+/* Put a border around prettyprinted code snippets. */
+.prettyprint {
+    font-family: Consolas, Monaco, 'Andale Mono', monospace;
+    white-space: pre-wrap;
+}
+
+/* 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;
+}
+
+.prettyprint li {
+    color: #999;
+}

data/lib/rubycritic/report_generators/base_generator.rb

@@ -24,8 +24,12 @@ module Rubycritic
       raise NotImplementedError.new("You must implement the render file_name method.")
     end
 
-    def stylesheet_path
-      File.join(REPORT_DIR, "assets/stylesheets/application.css")
+    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")
     end
 
     def index_path

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("").to_s
     end
 
     def render
@@ -31,7 +31,7 @@ module Rubycritic
       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.located_in?(location) }
-        file_code << LineGenerator.new(line_text, line_number, line_smells).render
+        file_code << LineGenerator.new(line_text, line_smells).render
       end
 
       file_body = FILE_TEMPLATE.result(self.get_binding { file_code })

data/lib/rubycritic/report_generators/line_generator.rb

@@ -5,13 +5,11 @@ require "cgi"
 module Rubycritic
 
   class LineGenerator < BaseGenerator
-    LINE_NUMBER_PADDING = 3
     NORMAL_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "line.html.erb")))
     SMELLY_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "smelly_line.html.erb")))
 
-    def initialize(text, number, smells)
+    def initialize(text, smells)
       @text = CGI::escapeHTML(text.chomp)
-      @number = number.to_s.rjust(LINE_NUMBER_PADDING)
       @smells = smells
       @template =
         if @smells.empty?

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

@@ -1 +1,3 @@
-<pre><code><%= yield %></code></pre>
+<button id="js-toggle-smells">Toggle Smells</button>
+
+<code class="prettyprint linenums lang-ruby file-code js-file-code"><%= yield %></code>

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

@@ -4,13 +4,16 @@
         <meta charset="utf-8">
         <meta http-equiv="X-UA-Compatible" content="IE=edge">
         <title>RubyCritic</title>
-        <link href="<%= stylesheet_path %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+        <link href="<%= stylesheet_path(:application) %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+        <link href="<%= stylesheet_path(:'prettify.custom_theme') %>" media="screen, projection, print" rel="stylesheet" type="text/css">
         <meta name="description" content="">
         <meta name="viewport" content="width=device-width, initial-scale=1">
     </head>
     <body>
         <h1><a href="<%= index_path %>">RubyCritic</a></h1>
-
         <%= yield %>
+        <script src="<%= javascript_path(:'jquery-2.1.0') %>"></script>
+        <script src="<%= javascript_path(:prettify) %>"></script>
+        <script src="<%= javascript_path(:application) %>"></script>
     </body>
 </html>

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

@@ -1 +1 @@
-<%= @number %>. <%= @text %>
+<%= @text %>

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

@@ -1 +1,7 @@
-<div class='smelly'><%= @number %>. <%= @text %><% @smells.each { |smell| %><span class="smell <%= smell.status %>"> # <%= smell %><span><% } %></div>
+<%= @text %>
+
+<ul class="nocode smells js-smells">
+<% @smells.each do |smell| %>
+  <li class="smell <%= smell.status %>"><span class="description"><%= smell %></span></li>
+<% end %>
+</ul>

data/lib/rubycritic/smell_adapters/flog.rb

@@ -32,7 +32,7 @@ module Rubycritic
 
       def method_location(context)
         line = @flog.method_locations[context]
-        file_path, file_line = line.split(':')
+        file_path, file_line = line.split(":")
         Location.new(file_path, file_line)
       end
     end

data/lib/rubycritic/source_control_systems/git.rb

@@ -15,17 +15,17 @@ module Rubycritic
       head_reference && $?.success?
     end
 
+    def head_reference
+      `git rev-parse --verify HEAD`.chomp
+    end
+
     def travel_to_head
       if uncommited_changes?
-        stashed_changes = `git stash` && $?.success?
+        stash_successful = stash_changes
       end
       yield
     ensure
-      `git stash pop` if stashed_changes
-    end
-
-    def head_reference
-      `git rev-parse --verify HEAD`.chomp
+      `git stash pop` if stash_successful
     end
 
     private
@@ -33,6 +33,17 @@ module Rubycritic
     def uncommited_changes?
       !`git status --porcelain`.empty?
     end
+
+    def stash_changes
+      stashes_count_before = stashes_count
+      `git stash`
+      stashes_count_after = stashes_count
+      stashes_count_after > stashes_count_before
+    end
+
+    def stashes_count
+      `git stash list`.split("\n").length
+    end
   end
 
 end

data/lib/rubycritic/source_control_systems/source_control_system.rb

@@ -28,13 +28,13 @@ module Rubycritic
       raise NotImplementedError.new("You must implement the has_revision? method.")
     end
 
-    def travel_to_head
-      raise NotImplementedError.new("You must implement the travel_to_head method.")
-    end
-
     def head_reference
       raise NotImplementedError.new("You must implement the head_reference method.")
     end
+
+    def travel_to_head
+      raise NotImplementedError.new("You must implement the travel_to_head method.")
+    end
   end
 
 end

data/lib/rubycritic/source_locator.rb

@@ -1,11 +1,13 @@
+require "pathname"
+
 module Rubycritic
 
   class SourceLocator
     RUBY_EXTENSION = ".rb"
     RUBY_FILES = File.join("**", "*#{RUBY_EXTENSION}")
 
-    def initialize(dirs)
-      @dirs = dirs
+    def initialize(paths)
+      @user_paths = paths
     end
 
     def pathnames
@@ -19,14 +21,18 @@ module Rubycritic
     private
 
     def expand_paths
-      @dirs.map do |path|
+      @user_paths.map do |path|
         if File.directory?(path)
-          Pathname.glob(RUBY_FILES)
+          Pathname.glob(files_contained_in(path))
         elsif File.exists?(path) && File.extname(path) == RUBY_EXTENSION
           Pathname.new(path)
         end
       end.flatten.compact.sort
     end
+
+    def files_contained_in(path)
+      (path == ".") ? RUBY_FILES : File.join(path, RUBY_FILES)
+    end
   end
 
 end

data/lib/rubycritic/version.rb

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

data/lib/rubycritic.rb

@@ -12,8 +12,8 @@ module Rubycritic
       @source_control_system = SourceControlSystem.create
     end
 
-    def critique(dirs)
-      source = SourceLocator.new(dirs)
+    def critique(paths)
+      source = SourceLocator.new(paths)
       if @source_control_system.has_revision?
         smelly_pathnames = RevisionComparator.new(source.paths, @source_control_system).compare
       else

data/rubycritic.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
     Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
   EOF
   spec.summary       = "Ruby code smell detector"
-  spec.homepage      = "https://github.com/GuilhermeSimoes/rubycritic"
+  spec.homepage      = "https://github.com/whitesmith/rubycritic"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split("\n")

data/test/lib/rubycritic/source_locator_test.rb

@@ -1,6 +1,5 @@
 require "test_helper"
 require "rubycritic/source_locator"
-require "pathname"
 
 describe Rubycritic::SourceLocator do
   before do
@@ -14,7 +13,7 @@ describe Rubycritic::SourceLocator do
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
 
-    it "finds multiple paths" do
+    it "finds files through multiple paths" do
       paths = ["dir1/file1.rb", "file0.rb"]
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
@@ -24,12 +23,17 @@ describe Rubycritic::SourceLocator do
       Rubycritic::SourceLocator.new(["."]).paths.must_equal paths
     end
 
-    it "ignores non-existent paths" do
+    it "finds all the files inside a given directory" do
+      paths = ["dir1/file1.rb"]
+      Rubycritic::SourceLocator.new(["dir1"]).paths.must_equal paths
+    end
+
+    it "ignores paths to non-existent files" do
       paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
       Rubycritic::SourceLocator.new(paths).paths.must_equal []
     end
 
-    it "ignores existent paths that do not match the Ruby extension" do
+    it "ignores paths to files that do not match the Ruby extension" do
       paths = ["file_with_no_extension", "file_with_different_extension.py"]
       Rubycritic::SourceLocator.new(paths).paths.must_equal []
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -132,7 +132,11 @@ files:
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
 - lib/rubycritic/location.rb
+- lib/rubycritic/report_generators/assets/javascripts/application.js
+- lib/rubycritic/report_generators/assets/javascripts/jquery-2.1.0.js
+- lib/rubycritic/report_generators/assets/javascripts/prettify.js
 - lib/rubycritic/report_generators/assets/stylesheets/application.css
+- lib/rubycritic/report_generators/assets/stylesheets/prettify.custom_theme.css
 - lib/rubycritic/report_generators/base_generator.rb
 - lib/rubycritic/report_generators/file_generator.rb
 - lib/rubycritic/report_generators/index_generator.rb
@@ -173,7 +177,7 @@ files:
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
 - test/test_helper.rb
-homepage: https://github.com/GuilhermeSimoes/rubycritic
+homepage: https://github.com/whitesmith/rubycritic
 licenses:
 - MIT
 metadata: {}