rubycritic 0.0.16 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a43f9d486a902fa7eda73e1df3e492cdb6ab085
-  data.tar.gz: a29c16803a4e83f4b559065630b024b76b45a69c
+  metadata.gz: fceb73a4e6b94b34fcfc88f846367c0db8abf85d
+  data.tar.gz: b1b3714fe7efd0fbcc178139763c894730689b0d
 SHA512:
-  metadata.gz: d0720b07a319110c0cb31dc6c5ca1ec69fef4eb60d7759069ba1e1e869a16f537d1e7d49553aa5ca544ccc91993c481f16f6fe7da2abe8917358499f952e2436
-  data.tar.gz: 05e48772690e0230b7e8d5788751204e754ccaaf0c4e40d72a4e5520fc0bad81ddc3f87a09f141d9a494372de94ae9c1e6df5adf808d2b765de22a3ae23294d1
+  metadata.gz: a51d03f7b9c0b888496bc18b1366bd15ae43ab92abca874d57aa2625541ba2434502a284e0bb2d649e703a13cb00023079865ba408f2e3f9412fa51a54f5cbd9
+  data.tar.gz: 77ac17f55cbf455d8bf4419a09bdc75bd8a5db4f69588230979574fcd7a14a35bce36c1c49044676ed9e3c64b6bc148b7b712dc7552187749b8bc178fbbb2ed0

data/.travis.yml

@@ -3,8 +3,8 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
-  - rbx-2
+  - 2.1
   - jruby
+  - rbx-2
 
 script: "bundle exec rake"

data/CONTRIBUTING.md

@@ -1,19 +1,68 @@
 Contributing
 ============
 
+RubyCritic is open source and contributions from the community are encouraged! No contribution is too small. Please consider:
+
+* [Writing some Code](#writing-some-code)
+* [Improving the Documentation](#improving-the-documentation)
+* [Reporting a Bug](#reporting-a-bug)
+
+Writing some Code
+-----------------
+
+If you want to squash a bug or add a new feature, follow these guidelines:
+
 1. Fork the project.
-2. Create your feature branch (`git checkout -b my-new-feature`).
-3. Stage partial-file changesets (`git -p`).
-4. Commit your changes (`git commit`).
-   Make exactly as many commits as you need.
-   Too many is confusing. Too few will result in epic diffs. Strive for just the right number.
-   Each commit should do one thing and one thing only.
-   Follow [these guidelines][1] when writing your commit messages.
-5. [Hide the sausage making][2]. Squash, split and reorder commits if necessary (`git rebase -i`).
-   For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history][3].
-6. Push to the branch (`git push origin my-new-feature`).
-7. Create new Pull Request.
+
+2. Create a feature branch (`git checkout -b my-new-feature`).
+
+3. Make your changes. Include tests for your changes, otherwise I may accidentally break them in the future.
+
+4. Run the tests with the `rake` command. Make sure that they are still passing.
+
+5. Stage partial-file changesets (`git -p`).
+
+6. Commit your changes (`git commit`).
+Make exactly as many commits as you need.
+Each commit should do one thing and one thing only. For example, all whitespace fixes should be relegated to a single commit.
+
+7. Write descriptive commit messages, in accordance with [these guidelines][1].
+
+8. [Hide the sausage making][3]. Squash, split and reorder commits if necessary (`git rebase -i`).
+For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history][4].
+
+9. Push to the branch to GitHub (`git push origin my-new-feature`).
+
+10. Create a new [Pull Request][5] and send it to be merged with the master branch.
+
+Improving the Documentation
+---------------------------
+
+You are encouraged to clarify how something works or to simply fix a typo. Please include `[ci skip]` on a new line in your commit message. This will signal [Travis][2] that running the test suite is not necessary for these changes.
+
+Reporting a Bug
+---------------
+
+If you are experiencing unexpected behavior and, after having read Rubycritic's documentation, are convinced this behavior is a bug, please:
+
+1. Search the [issues tracker][6] to see if it was already reported / fixed.
+
+2. Include the Ruby and RubyCritic versions in your report. Here's a little table to help you out:
+
+  ```
+  |            | Version |
+  |------------|---------|
+  | Ruby       | 2.1.2   |
+  | RubyCritic | 1.0.0   |
+  ```
+
+  The more information you provide, the easier it will be to track down the issue and fix it.
+
+3. Create a new issue.
 
 [1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-[2]: http://sethrobertson.github.io/GitBestPractices/#sausage
-[3]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
+[2]: https://travis-ci.org
+[3]: http://sethrobertson.github.io/GitBestPractices/#sausage
+[4]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
+[5]: https://help.github.com/articles/creating-a-pull-request
+[6]: https://github.com/whitesmith/rubycritic/issues

data/README.md

@@ -1,12 +1,12 @@
 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](http://img.shields.io/codeclimate/github/whitesmith/rubycritic.svg)](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.
+<img src="http://i.imgur.com/66HACCD.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.
 
 This gem provides features such as:
 
@@ -42,8 +42,8 @@ This gem provides features such as:
 
   ![RubyCritic file code screenshot](http://i.imgur.com/KLVrhMm.png)
 
-Installation
-------------
+Getting Started
+---------------
 
 RubyCritic can be installed with the following command:
 
@@ -80,23 +80,39 @@ Alternatively you can pass `rubycritic` a list of files and directories to check
 $ rubycritic app lib/foo.rb
 ```
 
-By default, RubyCritic generates its report in `tmp/rubycritic`. You can customize the output directory using the `path` option. You can use relative paths:
+For a full list of the command-line options run:
 
 ```bash
-rubycritic --path tmp/custom_dir        # outputs to tmp/custom_dir
+$ rubycritic --help
 ```
 
-Or full paths:
+| Command flag             | Description                             |
+|--------------------------|-----------------------------------------|
+| `-v/--version`           | Displays the current version and exits. |
+| `-p/--path`              | Customizes the output directory.        |
 
-```bash
-rubycritic --path $HOME/tmp/custom_dir  # outputs to $HOME/tmp/custom_dir
-```
+Alternative Usage Methods
+-------------------------
 
-For a full list of the command-line options run:
+If you're fond of Guard you might like [guard-rubycritic][4]. It automatically analyses your Ruby files as they are modified.
 
-```bash
-$ rubycritic --help
-```
+For continuous integration, you can give [Jenkins CI][5] a spin. With it, you can easily build your own (poor-man's) Code Climate!
+
+Improving RubyCritic
+--------------------
+
+RubyCritic doesn't have to remain a second choice to other code quality analysis services. Together, we can improve it and continue to build on the great code metric tools that are available in the Ruby ecosystem.
+
+Arguably, the [better_errors gem][6] only got popular after receiving a [(pretty awesome) Pull Request][7] that changed its page design.
+
+Similarly, Pull Requests that improve the look and feel of the gem, that tweak the calculation of ratings or that fix existing issues will be most welcome. This is my first gem, so just commenting on an issue and giving some insight into how something should work will be appreciated. No contribution is too small.
+
+See RubyCritic's [contribution guidelines](CONTRIBUTING.md) about how to proceed.
 
 [1]: https://github.com/troessner/reek
 [2]: https://github.com/seattlerb/flay
+[3]: https://github.com/seattlerb/flog
+[4]: https://github.com/whitesmith/guard-rubycritic
+[5]: http://jenkins-ci.org/
+[6]: https://github.com/charliesome/better_errors
+[7]: https://github.com/charliesome/better_errors/pull/22

data/lib/rubycritic/analysers/adapters/ast_node.rb

@@ -0,0 +1,35 @@
+module Parser
+  module AST
+
+    class Node
+      def count_nodes_of_type(*types)
+        count = 0
+        recursive_children do |child|
+          count += 1 if types.include?(child.type)
+        end
+        count
+      end
+
+      def recursive_children
+        children.each do |child|
+          next unless child.is_a?(Parser::AST::Node)
+          yield child
+          child.recursive_children { |grand_child| yield grand_child }
+        end
+      end
+    end
+
+  end
+end
+
+module Rubycritic
+  module AST
+
+    class EmptyNode
+      def count_nodes_of_type(*types)
+        0
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/adapters/flay.rb

@@ -0,0 +1,13 @@
+require "flay"
+
+module Rubycritic
+
+  class Flay < ::Flay
+    def initialize(paths)
+      super()
+      process(*paths)
+      analyze
+    end
+  end
+
+end

data/lib/rubycritic/analysers/adapters/flog.rb

@@ -0,0 +1,17 @@
+require "flog"
+
+module Rubycritic
+
+  class Flog < ::Flog
+    DEFAULT_OPTIONS = {
+      :all => true,
+      :continue => true,
+      :methods => true
+    }
+
+    def initialize
+      super(DEFAULT_OPTIONS)
+    end
+  end
+
+end

data/lib/rubycritic/analysers/adapters/reek.rb

@@ -0,0 +1,13 @@
+require "reek"
+
+module Rubycritic
+
+  class Reek < ::Reek::Examiner
+    DEFAULT_CONFIG_FILES = [File.expand_path("../config.reek", __FILE__)]
+
+    def initialize(paths)
+      super(Array(paths), DEFAULT_CONFIG_FILES)
+    end
+  end
+
+end

data/lib/rubycritic/analysers/churn.rb

@@ -7,7 +7,7 @@ module Rubycritic
         @source_control_system = source_control_system
       end
 
-      def churn
+      def run
         @analysed_files.each do |analysed_file|
           analysed_file.churn = @source_control_system.revisions_count(analysed_file.path)
           analysed_file.committed_at = @source_control_system.date_of_last_commit(analysed_file.path)

data/lib/rubycritic/{adapters/complexity/flog.rb → analysers/complexity.rb}

@@ -1,15 +1,15 @@
-require "rubycritic/analysers/flog"
+require "rubycritic/analysers/adapters/flog"
 
 module Rubycritic
-  module ComplexityAdapter
+  module Analyser
 
-    class Flog
+    class Complexity
       def initialize(analysed_files)
-        @flog = Analyser::Flog.new
+        @flog = Flog.new
         @analysed_files = analysed_files
       end
 
-      def complexity
+      def run
         @analysed_files.each do |analysed_file|
           @flog.reset
           @flog.flog(analysed_file.path)

data/lib/rubycritic/{adapters/smell → analysers/smells}/flay.rb

@@ -1,16 +1,16 @@
-require "rubycritic/analysers/flay"
+require "rubycritic/analysers/adapters/flay"
 require "rubycritic/core/smell"
 
 module Rubycritic
-  module SmellAdapter
+  module Analyser
 
-    class Flay
+    class FlaySmells
       def initialize(analysed_files)
         @analysed_files = paths_to_analysed_files(analysed_files)
-        @flay = Analyser::Flay.new(@analysed_files.keys)
+        @flay = Flay.new(@analysed_files.keys)
       end
 
-      def smells
+      def run
         @flay.hashes.each do |structural_hash, nodes|
           smell = create_smell(structural_hash, nodes)
           nodes.map(&:file).uniq.each do |file|

data/lib/rubycritic/{adapters/smell → analysers/smells}/flog.rb

@@ -1,19 +1,19 @@
-require "rubycritic/analysers/flog"
+require "rubycritic/analysers/adapters/flog"
 require "rubycritic/core/smell"
 
 module Rubycritic
-  module SmellAdapter
+  module Analyser
 
-    class Flog
+    class FlogSmells
       HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
       VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
 
       def initialize(analysed_files)
-        @flog = Analyser::Flog.new
+        @flog = Flog.new
         @analysed_files = analysed_files
       end
 
-      def smells
+      def run
         @analysed_files.each do |analysed_file|
           add_smells_to(analysed_file)
         end

data/lib/rubycritic/{adapters/smell → analysers/smells}/reek.rb

@@ -1,15 +1,15 @@
-require "rubycritic/analysers/reek"
+require "rubycritic/analysers/adapters/reek"
 require "rubycritic/core/smell"
 
 module Rubycritic
-  module SmellAdapter
+  module Analyser
 
-    class Reek
+    class ReekSmells
       def initialize(analysed_files)
         @analysed_files = analysed_files
       end
 
-      def smells
+      def run
         @analysed_files.each do |analysed_file|
           add_smells_to(analysed_file)
         end
@@ -18,7 +18,7 @@ module Rubycritic
       private
 
       def add_smells_to(analysed_file)
-        Analyser::Reek.new(analysed_file.path).smells.each do |smell|
+        Reek.new(analysed_file.path).smells.each do |smell|
           analysed_file.smells << create_smell(smell)
         end
       end

data/lib/rubycritic/analysers/stats.rb

@@ -1,4 +1,5 @@
-require "code_analyzer"
+require "parser/current"
+require "rubycritic/analysers/adapters/ast_node"
 
 module Rubycritic
   module Analyser
@@ -8,7 +9,7 @@ module Rubycritic
         @analysed_files = analysed_files
       end
 
-      def stats
+      def run
         @analysed_files.each do |analysed_file|
           analysed_file.methods_count = methods_count(analysed_file.path)
         end
@@ -19,11 +20,11 @@ module Rubycritic
       def methods_count(path)
         content = File.read(path)
         node = parse_content(content)
-        node.grep_nodes_count(sexp_type: [:def, :defs])
+        node.count_nodes_of_type(:def, :defs)
       end
 
       def parse_content(content)
-        Sexp.from_array(Ripper::SexpBuilder.new(content).parse)[1]
+        Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
       end
     end
 

data/lib/rubycritic/analysers_runner.rb

@@ -1,14 +1,20 @@
-require "rubycritic/adapters/smell/flay"
-require "rubycritic/adapters/smell/flog"
-require "rubycritic/adapters/smell/reek"
-require "rubycritic/adapters/complexity/flog"
+require "rubycritic/analysers/smells/flay"
+require "rubycritic/analysers/smells/flog"
+require "rubycritic/analysers/smells/reek"
+require "rubycritic/analysers/complexity"
 require "rubycritic/analysers/churn"
 require "rubycritic/analysers/stats"
 
 module Rubycritic
 
   class AnalysersRunner
-    SMELL_ANALYSERS = [SmellAdapter::Flay, SmellAdapter::Flog, SmellAdapter::Reek]
+    ANALYSERS = [
+      Analyser::FlaySmells,
+      Analyser::FlogSmells,
+      Analyser::ReekSmells,
+      Analyser::Complexity,
+      Analyser::Stats
+    ]
 
     def initialize(analysed_files, source_control_system)
       @analysed_files = analysed_files
@@ -16,12 +22,10 @@ module Rubycritic
     end
 
     def run
-      SMELL_ANALYSERS.map do |analyser|
-        analyser.new(@analysed_files).smells
+      ANALYSERS.map do |analyser|
+        analyser.new(@analysed_files).run
       end
-      ComplexityAdapter::Flog.new(@analysed_files).complexity
-      Analyser::Churn.new(@analysed_files, @source_control_system).churn
-      Analyser::Stats.new(@analysed_files).stats
+      Analyser::Churn.new(@analysed_files, @source_control_system).run
     end
   end
 

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

@@ -59,7 +59,7 @@ html {
   height: 28px;
 }
 
-.index-table .circled-rating {
+.index-table .circled-text {
   display: inline-block;
   line-height: 28px;
 }
@@ -112,7 +112,7 @@ html {
   border-radius: 50%;
 }
 
-.circled-rating {
+.circled-text {
   text-align: center;
   color: white;
   font-family: Arial, "Helvetica Neue", Helvetica, sans-serif;
@@ -124,6 +124,18 @@ html {
   cursor: default;
 }
 
+.smells-index-table .circled-text {
+  font-size: 10px;
+}
+
+.status-old {
+  background-color: #FFDC00;
+}
+
+.status-new {
+  background-color: #FF4136;
+}
+
 .file-header {
   position: relative;
   padding: 0 0 10px 60px;
@@ -135,7 +147,7 @@ html {
   height: 50px;
 }
 
-.file-header .circled-rating {
+.file-header .circled-text {
   float: left;
   line-height: 50px;
   font-size: 32px;

data/lib/rubycritic/report_generators/base.rb

@@ -1,4 +1,5 @@
 require "erb"
+require "pathname"
 require "rubycritic/report_generators/view_helpers"
 
 module Rubycritic

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

@@ -1,13 +1,13 @@
 <div class="file-header group">
-  <span class="rating-<%= @analysed_file.rating.to_s.downcase %> circled-rating circle "><%= @analysed_file.rating %></span>
+  <span class="rating-<%= @analysed_file.rating.to_s.downcase %> circled-text 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 %>
+    <% if @analysed_file.committed_at %>
+      Updated <%= timeago_tag(@analysed_file.committed_at) %>
+    <% else %>
+      Never committed
+    <% end %>
   </span>
 
   <div class="file-stats group">

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

@@ -19,7 +19,7 @@
       <td class="numeric-cell"><%= analysed_file.complexity %></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>
+      <td class="centered-cell last-cell"><span class="rating-<%= analysed_file.rating.to_s.downcase %> circled-text circle"><%= analysed_file.rating %></span></td>
     </tr>
   <% end %>
 </tbody>

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

@@ -1,19 +1,21 @@
-<table id="js-index-table" class="index-table sortable-table">
+<table id="js-index-table" class="smells-index-table index-table sortable-table">
 <thead>
   <tr>
     <th class="first-cell">Smell</th>
-    <th class="last-cell">Locations</th>
+    <th>Locations</th>
+    <th class="centered-cell last-cell" title="Code smells introduced recently are marked as new. There's still time before they are committed!">Status</th>
   </tr>
 </thead>
 <tbody>
   <% @smells.each do |smell| %>
     <tr>
       <td class="first-cell"><%= smell.type %></td>
-      <td class="last-cell">
+      <td>
         <% smell.locations.each do |location| %>
           <a href="<%= smell_location_path(location) %>"><%= location.file_name %></a>
         <% end %>
       </td>
+      <td class="centered-cell last-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
     </tr>
   <% end %>
 </tbody>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -1,5 +1,3 @@
-require "pathname"
-
 module Rubycritic
 
   module ViewHelpers
@@ -24,7 +22,7 @@ module Rubycritic
     end
 
     def smell_location_path(location)
-      relative_path(root_directory + "#{location.pathname.sub_ext('.html')}#L#{location.line}")
+      file_path("#{location.pathname.sub_ext('.html')}#L#{location.line}")
     end
 
     private

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.16"
+  VERSION = "1.0.0"
 end

data/rubycritic.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "virtus", "~> 1.0"
   spec.add_runtime_dependency "flay", "2.4.0"
-  spec.add_runtime_dependency "flog", "4.2.0"
-  spec.add_runtime_dependency "reek", "1.3.6"
-  spec.add_runtime_dependency "code_analyzer", "0.4.5"
+  spec.add_runtime_dependency "flog", "4.2.1"
+  spec.add_runtime_dependency "reek", "1.3.8"
+  spec.add_runtime_dependency "parser", "~> 2.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/analysers_test_helper.rb

@@ -0,0 +1,3 @@
+require "test_helper"
+
+class AnalysedFileDouble < OpenStruct; end

data/test/lib/rubycritic/analysers/churn_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require "analysers_test_helper"
 require "rubycritic/analysers/churn"
 require "rubycritic/source_control_systems/base"
 
@@ -8,25 +8,21 @@ describe Rubycritic::Analyser::Churn do
     @source_control_system = SourceControlSystemDouble.new
   end
 
-  describe "#churn" do
-    it "calculates the churn of each file and adds it to analysed_files" do
-      Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).churn
-      @analysed_files.each do |analysed_file|
-        analysed_file.churn.must_equal 1
-      end
+  it "calculates the churn of each file and adds it to analysed_files" do
+    Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).run
+    @analysed_files.each do |analysed_file|
+      analysed_file.churn.must_equal 1
     end
+  end
 
-    it "calculates the date of the last commit of each file and adds it to analysed_files" do
-      Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).churn
-      @analysed_files.each do |analysed_file|
-        analysed_file.committed_at.must_equal "2013-10-09 12:52:49 +0100"
-      end
+  it "calculates the date of the last commit of each file and adds it to analysed_files" do
+    Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).run
+    @analysed_files.each do |analysed_file|
+      analysed_file.committed_at.must_equal "2013-10-09 12:52:49 +0100"
     end
   end
 end
 
-class AnalysedFileDouble < OpenStruct; end
-
 class SourceControlSystemDouble < Rubycritic::SourceControlSystem::Base
   def revisions_count(path)
     1 # churn

data/test/lib/rubycritic/analysers/complexity_test.rb

@@ -0,0 +1,12 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/complexity"
+
+describe Rubycritic::Analyser::Complexity do
+  it "calculates the complexity of each file and adds it to analysed_files" do
+    analysed_files = [AnalysedFileDouble.new(:path => "test/samples/flog/complex.rb")]
+    Rubycritic::Analyser::Complexity.new(analysed_files).run
+    analysed_files.each do |analysed_file|
+      analysed_file.complexity.must_be_kind_of Numeric
+    end
+  end
+end

data/test/lib/rubycritic/{adapters/smell → analysers/smells}/flay_test.rb

@@ -1,9 +1,9 @@
 require "test_helper"
-require "rubycritic/adapters/smell/flay"
+require "rubycritic/analysers/smells/flay"
 require "rubycritic/core/analysed_file"
 require "pathname"
 
-describe Rubycritic::SmellAdapter::Flay do
+describe Rubycritic::Analyser::FlaySmells do
   before do
     @analysed_file = Rubycritic::AnalysedFile.new(
       :pathname => Pathname.new("test/samples/flay/smelly.rb"),
@@ -11,7 +11,7 @@ describe Rubycritic::SmellAdapter::Flay do
       :duplication => 0
     )
     analysed_files = [@analysed_file]
-    Rubycritic::SmellAdapter::Flay.new(analysed_files).smells
+    Rubycritic::Analyser::FlaySmells.new(analysed_files).run
   end
 
   it "detects smells and adds them to analysed_files" do

data/test/lib/rubycritic/{adapters/smell → analysers/smells}/flog_test.rb

@@ -1,11 +1,11 @@
-require "test_helper"
-require "rubycritic/adapters/smell/flog"
+require "analysers_test_helper"
+require "rubycritic/analysers/smells/flog"
 
-describe Rubycritic::SmellAdapter::Flog do
+describe Rubycritic::Analyser::FlogSmells do
   before do
     @analysed_file = AnalysedFileDouble.new(:path => "test/samples/flog/smelly.rb", :smells => [])
     analysed_files = [@analysed_file]
-    Rubycritic::SmellAdapter::Flog.new(analysed_files).smells
+    Rubycritic::Analyser::FlogSmells.new(analysed_files).run
   end
 
   it "detects smells and adds them to analysed_files" do
@@ -22,5 +22,3 @@ describe Rubycritic::SmellAdapter::Flog do
     smell.score.must_be_kind_of Numeric
   end
 end
-
-class AnalysedFileDouble < OpenStruct; end

data/test/lib/rubycritic/{adapters/smell → analysers/smells}/reek_test.rb

@@ -1,12 +1,12 @@
-require "test_helper"
-require "rubycritic/adapters/smell/reek"
+require "analysers_test_helper"
+require "rubycritic/analysers/smells/reek"
 
-describe Rubycritic::SmellAdapter::Reek do
+describe Rubycritic::Analyser::ReekSmells do
   context "when analysing a smelly file" do
     before do
       @analysed_file = AnalysedFileDouble.new(:path => "test/samples/reek/smelly.rb", :smells => [])
       analysed_files = [@analysed_file]
-      Rubycritic::SmellAdapter::Reek.new(analysed_files).smells
+      Rubycritic::Analyser::ReekSmells.new(analysed_files).run
     end
 
     it "detects smells and adds them to analysed_files" do
@@ -23,7 +23,7 @@ describe Rubycritic::SmellAdapter::Reek do
     before do
       @analysed_file = AnalysedFileDouble.new(:path => "test/samples/reek/not_smelly.rb", :smells => [])
       analysed_files = [@analysed_file]
-      Rubycritic::SmellAdapter::Reek.new(analysed_files)
+      Rubycritic::Analyser::ReekSmells.new(analysed_files).run
     end
 
     it "does not detect smells and does not add them to analysed files" do
@@ -31,5 +31,3 @@ describe Rubycritic::SmellAdapter::Reek do
     end
   end
 end
-
-class AnalysedFileDouble < OpenStruct; end

data/test/lib/rubycritic/analysers/stats_test.rb

@@ -0,0 +1,20 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/stats"
+
+describe Rubycritic::Analyser::Stats do
+  context "when a file contains Ruby code" do
+    it "calculates the number of methods of each file and adds it to analysed_files" do
+      analysed_file = AnalysedFileDouble.new(:path => "test/samples/stats/example.rb")
+      Rubycritic::Analyser::Stats.new([analysed_file]).run
+      analysed_file.methods_count.must_equal 2
+    end
+  end
+
+  context "when a file is empty" do
+    it "calculates the number of methods as 0, adding it to analysed_files" do
+      analysed_file = AnalysedFileDouble.new(:path => "test/samples/stats/empty_example.rb")
+      Rubycritic::Analyser::Stats.new([analysed_file]).run
+      analysed_file.methods_count.must_equal 0
+    end
+  end
+end

data/test/lib/rubycritic/configuration_test.rb

@@ -3,15 +3,26 @@ require "rubycritic/configuration"
 
 describe Rubycritic::Configuration do
   describe "#root" do
+    before do
+      @default = Rubycritic.configuration.root
+    end
+
     it "has a default" do
       Rubycritic.configuration.root.wont_be_empty
     end
 
-    it "can be configured" do
-      default = Rubycritic.configuration.root
+    it "can be set to a relative path" do
       Rubycritic.configuration.root = "foo"
       Rubycritic.configuration.root.must_equal File.expand_path("foo")
-      Rubycritic.configuration.root = default
+    end
+
+    it "can be set to an absolute path" do
+      Rubycritic.configuration.root = "/foo"
+      Rubycritic.configuration.root.must_equal "/foo"
+    end
+
+    after do
+      Rubycritic.configuration.root = @default
     end
   end
 end

data/test/lib/rubycritic/core/analysed_file_test.rb

@@ -1,7 +1,6 @@
 require "test_helper"
 require "rubycritic/core/analysed_file"
 require "rubycritic/core/smell"
-require "rubycritic/core/location"
 
 describe Rubycritic::AnalysedFile do
   describe "attribute readers" do
@@ -51,6 +50,22 @@ describe Rubycritic::AnalysedFile do
     end
   end
 
+  describe "#complexity_per_method" do
+    context "when the file has no methods" do
+      it "returns a placeholder" do
+        analysed_file = Rubycritic::AnalysedFile.new(:complexity => 0, :methods_count => 0)
+        analysed_file.complexity_per_method.must_equal "N/A"
+      end
+    end
+
+    context "when the file has at least one method" do
+      it "returns the average complexity per method" do
+        analysed_file = Rubycritic::AnalysedFile.new(:complexity => 10, :methods_count => 2)
+        analysed_file.complexity_per_method.must_equal 5
+      end
+    end
+  end
+
   describe "#has_smells?" do
     it "returns true if the analysed_file has at least one smell" do
       analysed_file = Rubycritic::AnalysedFile.new(:smells => [SmellDouble.new])

data/test/lib/rubycritic/core/smell_test.rb

@@ -1,6 +1,5 @@
 require "test_helper"
 require "rubycritic/core/smell"
-require "rubycritic/core/location"
 
 describe Rubycritic::Smell do
   describe "attribute readers" do

data/test/lib/rubycritic/report_generators/view_helpers_test.rb

@@ -0,0 +1,96 @@
+require "test_helper"
+require "rubycritic/report_generators/view_helpers"
+require "pathname"
+
+describe Rubycritic::ViewHelpers do
+  context "when the file is in the root directory" do
+    let(:generator) { GeneratorDouble.new("foo.html") }
+
+    describe "#file_path" do
+      context "when the other file is in the same directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("bar.html").to_s.must_equal "bar.html"
+        end
+      end
+
+      context "when the other file is in a subdirectory" do
+        it "creates a relative path to a file" do
+          generator.file_path("subdirectory/bar.html").to_s.must_equal "subdirectory/bar.html"
+        end
+      end
+    end
+
+    describe "#asset_path" do
+      it "creates a relative path to an asset" do
+        generator.asset_path("stylesheets", "application.css").to_s
+          .must_equal "assets/stylesheets/application.css"
+      end
+    end
+  end
+
+  context "when the file is in a subdirectory" do
+    let(:generator) { GeneratorDouble.new("subdirectory/foo.html") }
+
+    describe "#file_path" do
+      context "when the other file is in the same directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("subdirectory/bar.html").to_s.must_equal "bar.html"
+        end
+      end
+
+      context "when the other file is in the root directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("bar.html").to_s.must_equal "../bar.html"
+        end
+      end
+    end
+
+    describe "#asset_path" do
+      it "creates a relative path to an asset" do
+        generator.asset_path("stylesheets", "application.css").to_s
+          .must_equal "../assets/stylesheets/application.css"
+      end
+    end
+  end
+
+  context "when the file is n directories deep" do
+    let(:generator) { GeneratorDouble.new("lets/go/crazy/foo.html") }
+
+    describe "#file_path" do
+      context "when the other file is in the same directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("lets/go/crazy/bar.html").to_s.must_equal "bar.html"
+        end
+      end
+
+      context "when the other file is in the root directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("bar.html").to_s.must_equal "../../../bar.html"
+        end
+      end
+    end
+
+    describe "#asset_path" do
+      it "creates a relative path to an asset" do
+        generator.asset_path("stylesheets", "application.css").to_s
+          .must_equal "../../../assets/stylesheets/application.css"
+      end
+    end
+  end
+end
+
+class GeneratorDouble
+  include Rubycritic::ViewHelpers
+
+  def initialize(file)
+    @file = Pathname.new(file)
+  end
+
+  def file_directory
+    root_directory + @file.dirname
+  end
+
+  def root_directory
+    Pathname.new("root_directory")
+  end
+end

data/test/samples/stats/example.rb

@@ -0,0 +1,7 @@
+class Example
+  def self.one_class_method
+  end
+
+  def one_instance_method
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 1.0.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
-  name: code_analyzer
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -154,15 +154,16 @@ files:
 - Rakefile
 - bin/rubycritic
 - lib/rubycritic.rb
-- lib/rubycritic/adapters/complexity/flog.rb
-- lib/rubycritic/adapters/smell/flay.rb
-- lib/rubycritic/adapters/smell/flog.rb
-- lib/rubycritic/adapters/smell/reek.rb
+- lib/rubycritic/analysers/adapters/ast_node.rb
+- lib/rubycritic/analysers/adapters/config.reek
+- lib/rubycritic/analysers/adapters/flay.rb
+- lib/rubycritic/analysers/adapters/flog.rb
+- lib/rubycritic/analysers/adapters/reek.rb
 - lib/rubycritic/analysers/churn.rb
-- lib/rubycritic/analysers/config.reek
-- lib/rubycritic/analysers/flay.rb
-- lib/rubycritic/analysers/flog.rb
-- lib/rubycritic/analysers/reek.rb
+- lib/rubycritic/analysers/complexity.rb
+- lib/rubycritic/analysers/smells/flay.rb
+- lib/rubycritic/analysers/smells/flog.rb
+- lib/rubycritic/analysers/smells/reek.rb
 - lib/rubycritic/analysers/stats.rb
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
@@ -211,16 +212,19 @@ files:
 - lib/rubycritic/turbulence.rb
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
-- test/lib/rubycritic/adapters/complexity/flog_test.rb
-- test/lib/rubycritic/adapters/smell/flay_test.rb
-- test/lib/rubycritic/adapters/smell/flog_test.rb
-- test/lib/rubycritic/adapters/smell/reek_test.rb
+- test/analysers_test_helper.rb
 - test/lib/rubycritic/analysers/churn_test.rb
+- test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/smells/flay_test.rb
+- test/lib/rubycritic/analysers/smells/flog_test.rb
+- test/lib/rubycritic/analysers/smells/reek_test.rb
+- test/lib/rubycritic/analysers/stats_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_file_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb
+- test/lib/rubycritic/report_generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
@@ -235,6 +239,8 @@ files:
 - test/samples/location/file_with_no_extension
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
+- test/samples/stats/empty_example.rb
+- test/samples/stats/example.rb
 - test/test_helper.rb
 homepage: https://github.com/whitesmith/rubycritic
 licenses:
@@ -261,16 +267,19 @@ signing_key:
 specification_version: 4
 summary: Ruby code smell detector
 test_files:
-- test/lib/rubycritic/adapters/complexity/flog_test.rb
-- test/lib/rubycritic/adapters/smell/flay_test.rb
-- test/lib/rubycritic/adapters/smell/flog_test.rb
-- test/lib/rubycritic/adapters/smell/reek_test.rb
+- test/analysers_test_helper.rb
 - test/lib/rubycritic/analysers/churn_test.rb
+- test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/smells/flay_test.rb
+- test/lib/rubycritic/analysers/smells/flog_test.rb
+- test/lib/rubycritic/analysers/smells/reek_test.rb
+- test/lib/rubycritic/analysers/stats_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_file_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb
+- test/lib/rubycritic/report_generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
@@ -285,4 +294,6 @@ test_files:
 - test/samples/location/file_with_no_extension
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
+- test/samples/stats/empty_example.rb
+- test/samples/stats/example.rb
 - test/test_helper.rb

data/lib/rubycritic/analysers/flay.rb

@@ -1,15 +0,0 @@
-require "flay"
-
-module Rubycritic
-  module Analyser
-
-    class Flay < ::Flay
-      def initialize(paths)
-        super()
-        process(*paths)
-        analyze
-      end
-    end
-
-  end
-end

data/lib/rubycritic/analysers/flog.rb

@@ -1,19 +0,0 @@
-require "flog"
-
-module Rubycritic
-  module Analyser
-
-    class Flog < ::Flog
-      DEFAULT_OPTIONS = {
-        :all => true,
-        :continue => true,
-        :methods => true
-      }
-
-      def initialize
-        super(DEFAULT_OPTIONS)
-      end
-    end
-
-  end
-end

data/lib/rubycritic/analysers/reek.rb

@@ -1,15 +0,0 @@
-require "reek"
-
-module Rubycritic
-  module Analyser
-
-    class Reek < ::Reek::Examiner
-      DEFAULT_CONFIG_FILES = [File.expand_path("../config.reek", __FILE__)]
-
-      def initialize(paths)
-        super(Array(paths), DEFAULT_CONFIG_FILES)
-      end
-    end
-
-  end
-end

data/test/lib/rubycritic/adapters/complexity/flog_test.rb

@@ -1,18 +0,0 @@
-require "test_helper"
-require "rubycritic/analysers/flog"
-require "rubycritic/adapters/complexity/flog"
-
-describe Rubycritic::ComplexityAdapter::Flog do
-  before do
-    @analysed_files = [AnalysedFileDouble.new(:path => "test/samples/flog/complex.rb")]
-    Rubycritic::ComplexityAdapter::Flog.new(@analysed_files).complexity
-  end
-
-  describe "#complexity" do
-    it "calculates the complexity of each file and adds it to analysed_files" do
-      @analysed_files.each do |analysed_file|
-        analysed_file.complexity.must_be_kind_of Numeric
-      end
-    end
-  end
-end