rubycritic 0.0.5 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3de50932159be5b26bc5a2cf4afe9eeec17e8dc
-  data.tar.gz: c7f9620aae8d000fe5f674844158d48296c706c3
+  metadata.gz: 5a43f9d486a902fa7eda73e1df3e492cdb6ab085
+  data.tar.gz: a29c16803a4e83f4b559065630b024b76b45a69c
 SHA512:
-  metadata.gz: 28d945ef0e7036d298e1c8ff54b909c7c4c67b777e6ccfad20c548905ccb515fe849c351866b38bbba6765dfd31af610d41ae6c6cede57e469db3b54ee4f44bb
-  data.tar.gz: 509b8ffc4b0cdcb85cccacbbe242a5a5bc5f0e06e2975d12ac3827d9f168c0426793bcde26d4c48cf953e49ff41ba0039dce216428e8a94f009ba0e964f21522
+  metadata.gz: d0720b07a319110c0cb31dc6c5ca1ec69fef4eb60d7759069ba1e1e869a16f537d1e7d49553aa5ca544ccc91993c481f16f6fe7da2abe8917358499f952e2436
+  data.tar.gz: 05e48772690e0230b7e8d5788751204e754ccaaf0c4e40d72a4e5520fc0bad81ddc3f87a09f141d9a494372de94ae9c1e6df5adf808d2b765de22a3ae23294d1

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,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](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.
+
+This gem provides features such as:
+
+1. An overview of your project:
+
+  ![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)
 
 Installation
 ------------
 
-Add this line to your application's Gemfile:
+RubyCritic can be installed with the following command:
 
-```ruby
-gem "rubycritic"
+```bash
+$ gem install rubycritic
 ```
 
-And then execute:
+If you'd rather install RubyCritic using Bundler, add this line to your
+application's Gemfile:
 
-```bash
-$ bundle
+```ruby
+gem "rubycritic", :require => false
 ```
 
-Or just install it yourself:
+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,24 @@ Alternatively you can pass `rubycritic` a list of files and directories to check
 ```bash
 $ 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:
+
+```bash
+rubycritic --path tmp/custom_dir        # outputs to tmp/custom_dir
+```
+
+Or full paths:
+
+```bash
+rubycritic --path $HOME/tmp/custom_dir  # outputs to $HOME/tmp/custom_dir
+```
+
+For a full list of the command-line options run:
+
+```bash
+$ rubycritic --help
+```
+
+[1]: https://github.com/troessner/reek
+[2]: https://github.com/seattlerb/flay

data/bin/rubycritic

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

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

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

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

@@ -0,0 +1,68 @@
+require "rubycritic/analysers/flay"
+require "rubycritic/core/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Flay
+      def initialize(analysed_files)
+        @analysed_files = paths_to_analysed_files(analysed_files)
+        @flay = Analyser::Flay.new(@analysed_files.keys)
+      end
+
+      def smells
+        @flay.hashes.each do |structural_hash, nodes|
+          smell = create_smell(structural_hash, nodes)
+          nodes.map(&:file).uniq.each do |file|
+            @analysed_files[file].smells << smell
+          end
+
+          nodes.each do |node|
+            @analysed_files[node.file].duplication += node.mass
+          end
+        end
+      end
+
+      private
+
+      def paths_to_analysed_files(analysed_files)
+        paths = {}
+        analysed_files.each do |analysed_file|
+          paths[analysed_file.path] = analysed_file
+        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/adapters/smell/flog.rb

@@ -0,0 +1,62 @@
+require "rubycritic/analysers/flog"
+require "rubycritic/core/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Flog
+      HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
+      VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
+
+      def initialize(analysed_files)
+        @flog = Analyser::Flog.new
+        @analysed_files = analysed_files
+      end
+
+      def smells
+        @analysed_files.each do |analysed_file|
+          add_smells_to(analysed_file)
+        end
+      end
+
+      private
+
+      def add_smells_to(analysed_file)
+        @flog.reset
+        @flog.flog(analysed_file.path)
+        @flog.each_by_score do |class_method, original_score|
+          score = original_score.round
+          if score >= HIGH_COMPLEXITY_SCORE_THRESHOLD
+            analysed_file.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

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

@@ -0,0 +1,44 @@
+require "rubycritic/analysers/reek"
+require "rubycritic/core/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Reek
+      def initialize(analysed_files)
+        @analysed_files = analysed_files
+      end
+
+      def smells
+        @analysed_files.each do |analysed_file|
+          add_smells_to(analysed_file)
+        end
+      end
+
+      private
+
+      def add_smells_to(analysed_file)
+        Analyser::Reek.new(analysed_file.path).smells.each do |smell|
+          analysed_file.smells << create_smell(smell)
+        end
+      end
+
+      def create_smell(smell)
+        Smell.new(
+          :locations => smell_locations(smell.source, smell.lines),
+          :context   => smell.context,
+          :message   => smell.message,
+          :type      => smell.subclass,
+          :cost      => 0
+        )
+      end
+
+      def smell_locations(file_path, file_lines)
+        file_lines.uniq.map do |file_line|
+          Location.new(file_path, file_line)
+        end.sort
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/churn.rb

@@ -0,0 +1,19 @@
+module Rubycritic
+  module Analyser
+
+    class Churn
+      def initialize(analysed_files, source_control_system)
+        @analysed_files = analysed_files
+        @source_control_system = source_control_system
+      end
+
+      def churn
+        @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)
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+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

@@ -10,9 +10,8 @@ module Rubycritic
         :methods => true
       }
 
-      def initialize(paths)
+      def initialize
         super(DEFAULT_OPTIONS)
-        flog(*paths)
       end
     end
 

data/lib/rubycritic/analysers/stats.rb

@@ -0,0 +1,31 @@
+require "code_analyzer"
+
+module Rubycritic
+  module Analyser
+
+    class Stats
+      def initialize(analysed_files)
+        @analysed_files = analysed_files
+      end
+
+      def stats
+        @analysed_files.each do |analysed_file|
+          analysed_file.methods_count = methods_count(analysed_file.path)
+        end
+      end
+
+      private
+
+      def methods_count(path)
+        content = File.read(path)
+        node = parse_content(content)
+        node.grep_nodes_count(sexp_type: [:def, :defs])
+      end
+
+      def parse_content(content)
+        Sexp.from_array(Ripper::SexpBuilder.new(content).parse)[1]
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers_runner.rb

@@ -1,26 +1,27 @@
-require "rubycritic/analysers/reek"
-require "rubycritic/smell_adapters/reek"
+require "rubycritic/adapters/smell/flay"
+require "rubycritic/adapters/smell/flog"
+require "rubycritic/adapters/smell/reek"
+require "rubycritic/adapters/complexity/flog"
+require "rubycritic/analysers/churn"
+require "rubycritic/analysers/stats"
 
 module Rubycritic
 
   class AnalysersRunner
-    ANALYSERS = ["Reek"]
+    SMELL_ANALYSERS = [SmellAdapter::Flay, SmellAdapter::Flog, SmellAdapter::Reek]
 
-    def initialize(paths)
-      @paths = paths
+    def initialize(analysed_files, source_control_system)
+      @analysed_files = analysed_files
+      @source_control_system = source_control_system
     end
 
     def run
-      smell_adapters
-    end
-
-    private
-
-    def smell_adapters
-      ANALYSERS.map do |analyser_name|
-        analyser = Object.const_get("Rubycritic::Analyser::#{analyser_name}").new(@paths)
-        Object.const_get("Rubycritic::SmellAdapter::#{analyser_name}").new(analyser)
+      SMELL_ANALYSERS.map do |analyser|
+        analyser.new(@analysed_files).smells
       end
+      ComplexityAdapter::Flog.new(@analysed_files).complexity
+      Analyser::Churn.new(@analysed_files, @source_control_system).churn
+      Analyser::Stats.new(@analysed_files).stats
     end
   end
 

data/lib/rubycritic/cli.rb

@@ -1,25 +1,46 @@
 require "optparse"
 require "rubycritic"
+require "rubycritic/reporters/main"
 
 module Rubycritic
 
-  OptionParser.new do |opts|
-    opts.banner = "Usage: rubycritic [options] [paths]"
+  class Cli
+    STATUS_SUCCESS = 0
 
-    opts.on_tail("-v", "--version", "Show this version") do
-      require "rubycritic/version"
-      puts VERSION
-      exit 0
+    def initialize(argv)
+      @argv = argv
+      @argv << "." if @argv.empty?
+      @main_command = true
     end
 
-    opts.on_tail("-h", "--help", "Show this message") do
-      puts opts
-      exit 0
-    end
-  end.parse!
+    def execute
+      OptionParser.new do |opts|
+        opts.banner = "Usage: rubycritic [options] [paths]"
+
+        opts.on("-p", "--path [PATH]", "Set path where report will be saved (tmp/rubycritic by default)") do |path|
+          ::Rubycritic.configuration.root = path
+        end
+
+        opts.on_tail("-v", "--version", "Show gem's version") do
+          require "rubycritic/version"
+          puts "RubyCritic #{VERSION}"
+          @main_command = false
+        end
 
-  ARGV << "." if ARGV.empty?
-  puts "New critique at #{Rubycritic.new.critique(ARGV)}"
-  exit 0
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          @main_command = false
+        end
+      end.parse!(@argv)
+
+      if @main_command
+        analysed_files = Orchestrator.new.critique(@argv)
+        report_location = Reporter::Main.new(analysed_files).generate_report
+        puts "New critique at #{report_location}"
+      end
+
+      STATUS_SUCCESS
+    end
+  end
 
 end

data/lib/rubycritic/configuration.rb

@@ -0,0 +1,24 @@
+require "pathname"
+
+module Rubycritic
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_reader :root
+
+    def initialize
+      self.root = "tmp/rubycritic"
+    end
+
+    def root=(path)
+      @root =
+        if Pathname(path).relative?
+          File.expand_path(path)
+        else
+          path
+        end
+    end
+  end
+end

data/lib/rubycritic/core/analysed_file.rb

@@ -0,0 +1,50 @@
+require "virtus"
+require "rubycritic/core/rating"
+
+module Rubycritic
+
+  class AnalysedFile
+    include Virtus.model
+
+    attribute :pathname
+    attribute :smells
+    attribute :churn
+    attribute :committed_at
+    attribute :complexity
+    attribute :duplication
+    attribute :methods_count
+
+    def name
+      @name ||= pathname.basename.sub_ext("").to_s
+    end
+
+    def path
+      @path ||= pathname.to_s
+    end
+
+    def cost
+      @cost ||= smells.map(&:cost).inject(0, :+) + (complexity / 25)
+    end
+
+    def rating
+      @rating ||= Rating.from_cost(cost)
+    end
+
+    def complexity_per_method
+      if methods_count == 0
+        "N/A"
+      else
+        complexity.fdiv(methods_count).round(1)
+      end
+    end
+
+    def has_smells?
+      !smells.empty?
+    end
+
+    def smells_at_location(location)
+      smells.select { |smell| smell.at_location?(location) }
+    end
+  end
+
+end

data/lib/rubycritic/{location.rb → core/location.rb}

@@ -7,7 +7,11 @@ module Rubycritic
 
     def initialize(path, line)
       @pathname = Pathname.new(path)
-      @line = line
+      @line = line.to_i
+    end
+
+    def file_name
+      @pathname.basename.sub_ext("").to_s
     end
 
     def to_s
@@ -15,7 +19,7 @@ module Rubycritic
     end
 
     def ==(other)
-      self.class == other.class && state == other.state
+      state == other.state
     end
 
     def <=>(other)

data/lib/rubycritic/core/rating.rb

@@ -0,0 +1,22 @@
+module Rubycritic
+
+  class Rating
+    def self.from_cost(cost)
+      if    cost <= 2  then new("A")
+      elsif cost <= 4  then new("B")
+      elsif cost <= 8  then new("C")
+      elsif cost <= 16 then new("D")
+      else new("F")
+      end
+    end
+
+    def initialize(letter)
+      @letter = letter
+    end
+
+    def to_s
+      @letter
+    end
+  end
+
+end