rubycritic 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1099d50ed1beb525a791af3127cfae40dc525d4e
-  data.tar.gz: 2be5a299cd4a4839ca9c096ffd613a3ae0e38647
+  metadata.gz: 256bd2cbd360e7435d0ad68b21db192854b49461
+  data.tar.gz: 6bb7d80fb6ec8cf0b7fe1e8aa460c368ce9239fd
 SHA512:
-  metadata.gz: 11c74550a23f8fdcf3d7bcb579d72ab8cf584552bf8ee412bc3c41be13f565d21a5ed73159c615dfc177724c9d73a20eaa9efd6f081da363f2ab7b33f3278ec3
-  data.tar.gz: dcfa39fc7b30b9d2ba6a2a3d02d93eacb1f1616cfb3c78dad9f790841172d8b202d93c4c312db95798090f7a733152837d38ce95222df0545cf5fbeadc970657
+  metadata.gz: cd11682da1d3f86e750fe53e60e0efbe1104e4dc1b2bf75706e1add54d493bf7dcabf3e67961b7ba89a00211f6ad773299251235395adbb821ad82a9a5f5f976
+  data.tar.gz: 11e0c3069c482a01200cf6f166b843478edca25ba366795b2ae9c7ebd1d8887760520b0892b0a2ee6e1779d31f46d8426cbfac9dab2ceb0adfc3500019708e52

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx-2
+  - jruby
+
+script: "bundle exec rake"

data/README.md

@@ -1,6 +1,10 @@
 RubyCritic
 ===========
 
+[![Gem Version](https://badge.fury.io/rb/rubycritic.svg)](http://badge.fury.io/rb/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.png)](https://codeclimate.com/github/whitesmith/rubycritic)
+
 RubyCritic is a gem that wraps around static analysis gems such as [Reek][1]
 and [Flay][2] to provide a quality report of your Ruby code.
 

data/lib/rubycritic/report_generators/base_generator.rb

@@ -4,8 +4,12 @@ require "rubycritic/report_generators/view_helpers"
 module Rubycritic
 
   class BaseGenerator
+    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.new(File.read(File.join(TEMPLATES_DIR, "layouts", "application.html.erb")))
+    LAYOUT_TEMPLATE = erb_template(File.join("layouts", "application.html.erb"))
 
     include ViewHelpers
 
@@ -32,12 +36,6 @@ module Rubycritic
     def get_binding
       binding
     end
-
-    private
-
-    def root_directory
-      ::Rubycritic.configuration.root
-    end
   end
 
 end

data/lib/rubycritic/report_generators/code_index_generator.rb

@@ -4,10 +4,11 @@ require "rubycritic/report_generators/base_generator"
 module Rubycritic
 
   class CodeIndexGenerator < BaseGenerator
-    TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "code_index.html.erb")))
+    TEMPLATE = erb_template("code_index.html.erb")
 
-    def initialize(file_generators)
-      @file_generators = file_generators.sort { |a, b| a.analysed_file_name <=> b.analysed_file_name }
+    def initialize(source_pathnames, smelly_pathnames)
+      @source_pathnames = source_pathnames.sort { |a, b| a.basename <=> b.basename }
+      @smelly_pathnames = smelly_pathnames
     end
 
     def file_name
@@ -18,6 +19,14 @@ module Rubycritic
       index_body = TEMPLATE.result(get_binding)
       LAYOUT_TEMPLATE.result(get_binding { index_body })
     end
+
+    def file_path(path)
+      File.join(root_directory, path.sub_ext(".html"))
+    end
+
+    def smells_count(pathname)
+      (@smelly_pathnames[pathname] || []).length
+    end
   end
 
 end

data/lib/rubycritic/report_generators/file_generator.rb

@@ -6,7 +6,7 @@ module Rubycritic
 
   class FileGenerator < BaseGenerator
     LINE_NUMBER_OFFSET = 1
-    TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "file.html.erb")))
+    TEMPLATE = erb_template("file.html.erb")
 
     def initialize(pathname, smells)
       @pathname = pathname
@@ -18,11 +18,7 @@ module Rubycritic
     end
 
     def file_name
-      "#{analysed_file_name}.html"
-    end
-
-    def analysed_file_name
-      @pathname.basename.sub_ext("")
+      @pathname.basename.sub_ext(".html")
     end
 
     def render

data/lib/rubycritic/report_generators/line_generator.rb

@@ -5,8 +5,8 @@ require "cgi"
 module Rubycritic
 
   class LineGenerator < BaseGenerator
-    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")))
+    NORMAL_TEMPLATE = erb_template("line.html.erb")
+    SMELLY_TEMPLATE = erb_template("smelly_line.html.erb")
 
     def initialize(text, smells)
       @text = CGI::escapeHTML(text.chomp)

data/lib/rubycritic/report_generators/reporter.rb

@@ -33,7 +33,7 @@ module Rubycritic
     end
 
     def code_index_generator
-      @code_index_generator ||= CodeIndexGenerator.new(file_generators)
+      @code_index_generator ||= CodeIndexGenerator.new(@source_pathnames, @smelly_pathnames)
     end
 
     def smells_index_generator

data/lib/rubycritic/report_generators/smells_index_generator.rb

@@ -4,7 +4,7 @@ require "rubycritic/report_generators/base_generator"
 module Rubycritic
 
   class SmellsIndexGenerator < BaseGenerator
-    TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "smells_index.html.erb")))
+    TEMPLATE = erb_template("smells_index.html.erb")
 
     def initialize(smells)
       @smells = smells.sort { |a, b| a.type <=> b.type }

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

@@ -2,12 +2,14 @@
 <thead>
   <tr>
     <th>Name</th>
+    <th>Smells</th>
   </tr>
 </thead>
 <tbody>
-  <% @file_generators.each do |file_generator| %>
+  <% @source_pathnames.each do |pathname| %>
     <tr>
-      <td><a href="<%= file_generator.file_pathname %>"><%= file_generator.analysed_file_name %></a></td>
+      <td><a href="<%= file_path(pathname) %>"><%= analysed_file_name(pathname) %></a></td>
+      <td><%= smells_count(pathname) %></td>
     </tr>
   <% end %>
 </tbody>

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

@@ -1,5 +1,5 @@
 <div class="file-header">
-  <h2 class="file-name"><%= analysed_file_name %></h2>
+  <h2 class="file-name"><%= analysed_file_name(@pathname) %></h2>
 
   <% if file_has_smells? %>
     <button id="js-toggle-smells" class="smells-toggle-button button">Toggle Smells</button>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -26,9 +26,12 @@ module Rubycritic
       File.join(root_directory, "smells_index.html")
     end
 
-    # Includers must override
     def root_directory
-      raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      ::Rubycritic.configuration.root
+    end
+
+    def analysed_file_name(pathname)
+      pathname.basename.sub_ext("")
     end
   end
 

data/lib/rubycritic/smell_adapters/flay.rb

@@ -17,20 +17,12 @@ module Rubycritic
       private
 
       def create_smell(structural_hash, nodes)
-        is_identical = @flay.identical[structural_hash]
-        similarity   = is_identical ? "Identical" : "Similar"
-
-        locations = smell_locations(nodes)
-        context   = "#{similarity} code"
-        message   = "found in #{nodes.size} nodes"
-        score     = @flay.masses[structural_hash]
-
         Smell.new(
-          :locations => locations,
-          :context => context,
-          :message => message,
-          :score => score,
-          :type => "DuplicateCode"
+          :locations => smell_locations(nodes),
+          :context   => "#{similarity(structural_hash)} code",
+          :message   => "found in #{nodes.size} nodes",
+          :score     => @flay.masses[structural_hash],
+          :type      => "DuplicateCode"
         )
       end
 
@@ -39,6 +31,14 @@ module Rubycritic
           Location.new(node.file, node.line)
         end.sort
       end
+
+      def similarity(structural_hash)
+        if @flay.identical[structural_hash]
+          "Identical"
+        else
+          "Similar"
+        end
+      end
     end
 
   end

data/lib/rubycritic/smell_adapters/flog.rb

@@ -23,28 +23,27 @@ module Rubycritic
       private
 
       def create_smell(context, score)
-        location = smell_location(context)
-        message  = "has a flog score of #{score}"
-        type     =
-          if score >= VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD
-            "VeryHighComplexity"
-          else
-            "HighComplexity"
-          end
-
         Smell.new(
-          :locations => [location],
-          :context => context,
-          :message => message,
-          :score => score,
-          :type => type
+          :locations => smell_locations(context),
+          :context   => context,
+          :message   => "has a flog score of #{score}",
+          :score     => score,
+          :type      => type(score)
         )
       end
 
-      def smell_location(context)
+      def smell_locations(context)
         line = @flog.method_locations[context]
         file_path, file_line = line.split(":")
-        Location.new(file_path, file_line)
+        [Location.new(file_path, file_line)]
+      end
+
+      def type(score)
+        if score >= VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD
+          "VeryHighComplexity"
+        else
+          "HighComplexity"
+        end
       end
     end
 

data/lib/rubycritic/smell_adapters/reek.rb

@@ -17,12 +17,12 @@ module Rubycritic
       private
 
       def create_smell(smell)
-        locations = smell_locations(smell.source, smell.lines)
-        context   = smell.context
-        message   = smell.message
-        type      = smell.subclass
-
-        Smell.new(:locations => locations, :context => context, :message => message, :type => type)
+        Smell.new(
+          :locations => smell_locations(smell.source, smell.lines),
+          :context   => smell.context,
+          :message   => smell.message,
+          :type      => smell.subclass
+        )
       end
 
       def smell_locations(file_path, file_lines)

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/rubycritic.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Ruby code smell detector"
   spec.homepage      = "https://github.com/whitesmith/rubycritic"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 1.9.3"
 
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/test/lib/rubycritic/analysers_runner_test.rb

@@ -4,7 +4,7 @@ require "rubycritic/analysers_runner"
 describe Rubycritic::AnalysersRunner do
   describe "#run" do
     it "returns an array containing smell adapters" do
-      smell_adapters = Rubycritic::AnalysersRunner.new("test/samples/location/file0.rb").run
+      smell_adapters = Rubycritic::AnalysersRunner.new("test/samples/analysers_runner/empty.rb").run
       smell_adapters.each { |adapter| adapter.must_respond_to(:smells) }
     end
   end

data/test/lib/rubycritic/source_locator_test.rb

@@ -51,10 +51,9 @@ describe Rubycritic::SourceLocator do
 
   describe "#pathnames" do
     it "finds a single file" do
-      path = "file0.rb"
-      paths = [path]
-      result = [Pathname.new(path)]
-      Rubycritic::SourceLocator.new(paths).pathnames.must_equal result
+      initial_paths = ["file0.rb"]
+      final_pathnames = [Pathname.new("file0.rb")]
+      Rubycritic::SourceLocator.new(initial_paths).pathnames.must_equal final_pathnames
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-04 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -132,12 +132,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- SPEC.md
 - bin/rubycritic
 - lib/rubycritic.rb
 - lib/rubycritic/active_support/methods.rb
@@ -193,6 +193,7 @@ files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/analysers_runner/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
@@ -214,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -240,6 +241,7 @@ test_files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/analysers_runner/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb

data/SPEC.md

@@ -1,58 +0,0 @@
-Ruby Critic
-===========
-
-Ruby Critic is a tool that detects and reports smells in Ruby code.
-
-Inspired by [RuboCop][1], [Rails Best Practices][2] and [Code Climate][3], Ruby Critic aims to better help you refactor your code. By making use of Ruby's rich ecosystem of code metrics tools, Ruby Critic generates high-quality visualizations and insightful code quality reports.
-
-[1]: https://github.com/bbatsov/rubocop/
-[2]: https://github.com/railsbp/rails_best_practices
-[3]: https://codeclimate.com/
-
-Installation
-------------
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "rubycritic"
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or just install it yourself:
-
-```bash
-$ gem install rubycritic
-```
-
-Usage
------
-
-Running `rubycritic` with no arguments will check all Ruby source files in the
-current directory:
-
-```bash
-$ rubycritic
-```
-
-Alternatively you can pass `rubycritic` a list of files and directories to check:
-
-```bash
-$ rubycritic app lib/foo.rb
-```
-
-Options
--------
-
-To specify an output file for the results:
-
-```bash
-$ rubycritic -o output_file
-```
-
-The output format is determined by the file extension or by using the `-f` option. Current options are: `text`, `html`, `yaml` and `json`.