rubycritic 0.0.5 → 1.4.0

data/CONTRIBUTING.md

@@ -1,19 +1,71 @@
 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, please:
+
 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.
-
-[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. 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].
+
+8. Push the branch to GitHub (`git push origin my-new-feature`).
+
+9. [Create a Pull Request] and send it to be merged with the master branch.
+
+10. After your code is reviewed, [hide the sausage making]. 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].
+
+Improving the Documentation
+---------------------------
+
+You are welcome to clarify how something works or simply fix a typo. Please include `[ci skip]` on a new line in each of your commit messages. This will signal [Travis] that running the test suite is not necessary for these changes.
+
+Reporting a Bug
+---------------
+
+If you are experiencing unexpected behavior and, after having read the documentation, you are convinced this behavior is a bug, please:
+
+1. Search the [issues tracker] to see if it was already reported / fixed.
+
+2. [Create a new issue].
+
+3. 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.
+  If you have never written a bug report before, or if you want to brush up on your bug reporting skills, read Simon Tatham's essay [How to Report Bugs Effectively].
+
+[descriptive commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Create a pull request]: https://help.github.com/articles/creating-a-pull-request
+[hide the sausage making]: http://sethrobertson.github.io/GitBestPractices/#sausage
+[how to rewrite history]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
+[Travis]: https://travis-ci.org
+[issues tracker]: https://github.com/whitesmith/rubycritic/issues
+[Create a new issue]: https://github.com/whitesmith/rubycritic/issues/new
+[How to Report Bugs Effectively]: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html

data/README.md

@@ -1,33 +1,73 @@
-Ruby Critic
-===========
+RubyCritic
+==========
 
-Ruby Critic is a tool that detects and reports smells in Ruby code.
+[![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/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
-Installation
-------------
+<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.
 
-Add this line to your application's Gemfile:
+This gem provides features such as:
 
-```ruby
-gem "rubycritic"
-```
+1. An overview of your project:
 
-And then execute:
+  ![RubyCritic overview screenshot](http://i.imgur.com/OrOflfj.png)
+
+2. An index of the project files with their respective number of smells:
+
+  ![RubyCritic code index screenshot](http://i.imgur.com/0ETNrX7.png)
+
+3. An index of the smells detected:
+
+  ![RubyCritic smells index screenshot](http://i.imgur.com/5CpPt9v.png)
+
+4. Finally, when analysing code like the following:
+
+  ```ruby
+  class Dirty
+    def awful(x, y)
+      if y
+        @screen = widgets.map {|w| w.each {|key| key += 3}}
+      end
+    end
+  end
+  ```
+
+  It basically turns something like this:
+
+  ![Reek output screenshot](http://i.imgur.com/tCgZX9I.png)
+
+  Into something like this:
+
+  ![RubyCritic file code screenshot](http://i.imgur.com/KLVrhMm.png)
+
+Getting Started
+---------------
+
+RubyCritic can be installed with the following command:
 
 ```bash
-$ bundle
+$ gem install rubycritic
 ```
 
-Or just install it yourself:
+If you'd rather install RubyCritic using Bundler, add this line to your
+application's Gemfile:
+
+```ruby
+gem "rubycritic", :require => false
+```
+
+And then execute:
 
 ```bash
-$ gem install rubycritic
+$ bundle
 ```
 
 Usage
 -----
 
-Running `rubycritic` with no arguments will check all Ruby source files in the
+Running `rubycritic` with no arguments will analyse all the Ruby files in the
 current directory:
 
 ```bash
@@ -39,3 +79,54 @@ Alternatively you can pass `rubycritic` a list of files and directories to check
 ```bash
 $ rubycritic app lib/foo.rb
 ```
+
+For a full list of the command-line options run:
+
+```bash
+$ rubycritic --help
+```
+
+| Command flag             | Description                                           |
+|--------------------------|-------------------------------------------------------|
+| `-v/--version`           | Displays the current version and exits                |
+| `-p/--path`              | Sets the output directory (tmp/rubycritic by default) |
+| `-m/--mode-ci`           | Uses CI mode (faster, but only analyses last commit)  |
+| `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
+| `--suppress-ratings`     | Suppress letter ratings                               |
+
+Alternative Usage Methods
+-------------------------
+
+If you're fond of Guard you might like [guard-rubycritic][4]. It automatically analyses your Ruby files as they are modified.
+
+For continuous integration, you can give [Jenkins CI][5] a spin. With it, you can [easily build your own (poor-man's) Code Climate][6]!
+
+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][7] only got popular after receiving a [(pretty awesome) Pull Request][8] 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 [contributing guidelines](CONTRIBUTING.md) about how to proceed.
+
+Credits
+-------
+
+![Whitesmith](http://i.imgur.com/Si2l3kd.png)
+
+RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@glitchdout][10] or [@Whitesmithco][11].
+
+[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/whitesmith/rubycritic/wiki/Building-your-own-Code-Climate
+[7]: https://github.com/charliesome/better_errors
+[8]: https://github.com/charliesome/better_errors/pull/22
+[9]: http://www.whitesmith.co/
+[10]: https://twitter.com/glitchdout
+[11]: https://twitter.com/Whitesmithco

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
-task :default => :test
-
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
-  t.pattern = "test/**/*_test.rb"
+Rake::TestTask.new do |task|
+  task.libs.push "lib"
+  task.libs.push "test"
+  task.pattern = "test/**/*_test.rb"
 end
+
+RuboCop::RakeTask.new
+
+task :default => [:test, :rubocop]

data/bin/rubycritic

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
 
-require "rubycritic/cli"
+require "rubycritic/cli/application"
+
+exit Rubycritic::Cli::Application.new(ARGV).execute

data/lib/rubycritic/analysers/attributes.rb

@@ -0,0 +1,21 @@
+require "rubycritic/analysers/helpers/methods_counter"
+require "rubycritic/analysers/helpers/modules_locator"
+
+module Rubycritic
+  module Analyser
+
+    class Attributes
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def run
+        @analysed_modules.each do |analysed_module|
+          analysed_module.methods_count = MethodsCounter.new(analysed_module).count
+          analysed_module.name = ModulesLocator.new(analysed_module).first_name
+        end
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/churn.rb

@@ -0,0 +1,21 @@
+module Rubycritic
+  module Analyser
+
+    class Churn
+      attr_writer :source_control_system
+
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+        @source_control_system = Config.source_control_system
+      end
+
+      def run
+        @analysed_modules.each do |analysed_module|
+          analysed_module.churn = @source_control_system.revisions_count(analysed_module.path)
+          analysed_module.committed_at = @source_control_system.date_of_last_commit(analysed_module.path)
+        end
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/complexity.rb

@@ -0,0 +1,22 @@
+require "rubycritic/analysers/helpers/flog"
+
+module Rubycritic
+  module Analyser
+
+    class Complexity
+      def initialize(analysed_modules)
+        @flog = Flog.new
+        @analysed_modules = analysed_modules
+      end
+
+      def run
+        @analysed_modules.each do |analysed_module|
+          @flog.reset
+          @flog.flog(analysed_module.path)
+          analysed_module.complexity = @flog.total_score.round
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,69 @@
+module Parser
+  module AST
+
+    class Node
+      MODULE_TYPES = [:module, :class]
+
+      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
+
+      def get_module_names
+        children_modules = children
+          .select { |child| child.is_a?(Parser::AST::Node) }
+          .flat_map(&:get_module_names)
+
+        if MODULE_TYPES.include?(type)
+          if children_modules.empty?
+            [module_name]
+          else
+            children_modules.map do |children_module|
+              "#{module_name}::#{children_module}"
+            end
+          end
+        else
+          children_modules
+        end
+      end
+
+      private
+
+      def module_name
+        name_segments = []
+        current_node = children[0]
+        while current_node
+          name_segments.unshift(current_node.children[1])
+          current_node = current_node.children[0]
+        end
+        name_segments.join("::")
+      end
+    end
+  end
+end
+
+module Rubycritic
+  module AST
+    class EmptyNode
+      def count_nodes_of_type(*)
+        0
+      end
+
+      def get_module_names
+        []
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/{config.reek → helpers/config.reek}

@@ -1,8 +1,14 @@
 ---
 Attribute:
   enabled: false
+DuplicateMethodCall:
+  max_calls: 2
 IrresponsibleModule:
   enabled: false
+NestedIterators:
+  max_allowed_nesting: 2
+TooManyStatements:
+  enabled: false
 UncommunicativeMethodName:
   reject:
   - !ruby/regexp /^[a-z]$/
@@ -16,3 +22,5 @@ UncommunicativeVariableName:
   reject:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
+UtilityFunction:
+  enabled: false

data/lib/rubycritic/analysers/helpers/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/helpers/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/helpers/methods_counter.rb

@@ -0,0 +1,25 @@
+require "rubycritic/analysers/helpers/parser"
+
+module Rubycritic
+
+  class MethodsCounter
+    def initialize(analysed_module)
+      @analysed_module = analysed_module
+    end
+
+    def count
+      node.count_nodes_of_type(:def, :defs)
+    end
+
+    private
+
+    def node
+      Parser.parse(content)
+    end
+
+    def content
+      File.read(@analysed_module.path)
+    end
+  end
+
+end

data/lib/rubycritic/analysers/helpers/modules_locator.rb

@@ -0,0 +1,43 @@
+require "rubycritic/analysers/helpers/parser"
+
+module Rubycritic
+
+  class ModulesLocator
+    def initialize(analysed_module)
+      @analysed_module = analysed_module
+    end
+
+    def first_name
+      names.first
+    end
+
+    def names
+      return name_from_path if @analysed_module.methods_count == 0
+      names = node.get_module_names
+      if names.empty?
+        name_from_path
+      else
+        names
+      end
+    end
+
+    private
+
+    def node
+      Parser.parse(content)
+    end
+
+    def content
+      File.read(@analysed_module.path)
+    end
+
+    def name_from_path
+      [file_name.split("_").map(&:capitalize).join]
+    end
+
+    def file_name
+      @analysed_module.pathname.basename.sub_ext("").to_s
+    end
+  end
+
+end

data/lib/rubycritic/analysers/helpers/parser.rb

@@ -0,0 +1,12 @@
+require "parser/current"
+require "rubycritic/analysers/helpers/ast_node"
+
+module Rubycritic
+  module Parser
+    def self.parse(content)
+      ::Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
+    rescue ::Parser::SyntaxError
+      AST::EmptyNode.new
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require "reek"
+require "reek/configuration/app_configuration"
+require "ostruct"
+
+module Rubycritic
+
+  class Reek < ::Reek::Examiner
+    DEFAULT_CONFIG_FILE = File.expand_path("../config.reek", __FILE__)
+
+    def initialize(paths)
+      config = OpenStruct.new(:options => OpenStruct.new(:config_file => DEFAULT_CONFIG_FILE))
+      ::Reek::Configuration::AppConfiguration.initialize_with(config)
+      super(Array(paths))
+    end
+  end
+
+end

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

@@ -0,0 +1,68 @@
+require "rubycritic/analysers/helpers/flay"
+require "rubycritic/core/smell"
+
+module Rubycritic
+  module Analyser
+
+    class FlaySmells
+      def initialize(analysed_modules)
+        @analysed_modules = paths_to_analysed_modules(analysed_modules)
+        @flay = Flay.new(@analysed_modules.keys)
+      end
+
+      def run
+        @flay.hashes.each do |structural_hash, nodes|
+          smell = create_smell(structural_hash, nodes)
+          nodes.map(&:file).uniq.each do |file|
+            @analysed_modules[file].smells << smell
+          end
+
+          nodes.each do |node|
+            @analysed_modules[node.file].duplication += node.mass
+          end
+        end
+      end
+
+      private
+
+      def paths_to_analysed_modules(analysed_modules)
+        paths = {}
+        analysed_modules.each do |analysed_module|
+          paths[analysed_module.path] = analysed_module
+        end
+        paths
+      end
+
+      def create_smell(structural_hash, nodes)
+        mass = @flay.masses[structural_hash]
+        Smell.new(
+          :locations => smell_locations(nodes),
+          :context   => similarity(structural_hash),
+          :message   => "found in #{nodes.size} nodes",
+          :score     => mass,
+          :type      => "DuplicateCode",
+          :cost      => cost(mass)
+        )
+      end
+
+      def smell_locations(nodes)
+        nodes.map do |node|
+          Location.new(node.file, node.line)
+        end.sort
+      end
+
+      def similarity(structural_hash)
+        if @flay.identical[structural_hash]
+          "Identical code"
+        else
+          "Similar code"
+        end
+      end
+
+      def cost(mass)
+        mass / 25
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,62 @@
+require "rubycritic/analysers/helpers/flog"
+require "rubycritic/core/smell"
+
+module Rubycritic
+  module Analyser
+
+    class FlogSmells
+      HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
+      VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
+
+      def initialize(analysed_modules)
+        @flog = Flog.new
+        @analysed_modules = analysed_modules
+      end
+
+      def run
+        @analysed_modules.each do |analysed_module|
+          add_smells_to(analysed_module)
+        end
+      end
+
+      private
+
+      def add_smells_to(analysed_module)
+        @flog.reset
+        @flog.flog(analysed_module.path)
+        @flog.each_by_score do |class_method, original_score|
+          score = original_score.round
+          if score >= HIGH_COMPLEXITY_SCORE_THRESHOLD
+            analysed_module.smells << create_smell(class_method, score)
+          end
+        end
+      end
+
+      def create_smell(context, score)
+        Smell.new(
+          :locations => smell_locations(context),
+          :context   => context,
+          :message   => "has a flog score of #{score}",
+          :score     => score,
+          :type      => type(score),
+          :cost      => 0
+        )
+      end
+
+      def smell_locations(context)
+        line = @flog.method_locations[context]
+        file_path, file_line = line.split(":")
+        [Location.new(file_path, file_line)]
+      end
+
+      def type(score)
+        if score >= VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD
+          "VeryHighComplexity"
+        else
+          "HighComplexity"
+        end
+      end
+    end
+
+  end
+end