rubycritic 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74b9972ae846d78f2a449e831f4f56d5475349d8
-  data.tar.gz: 737c696e6b0b42393c3b6ddb2a8f6d09f446fed2
+  metadata.gz: 68c58782f25f2ad071d05ae5060034e4f2b77832
+  data.tar.gz: 61ae75fea93cde03f7e9ab378e363f345eb8f184
 SHA512:
-  metadata.gz: b5490faab830e968d3cdef7cdb0f04c1158197c8b738b30f383f9227fbbc102ba17d0276a248007ce7a668d53640cc54410d09c136f3e4ce24d59c1a9c26653e
-  data.tar.gz: d51c2940dc3a15ec3b6551d35c0ee24f6f7e8ed510e3dc74865301ef59e41cf361511e17a6db14e098e45fbdb188cf9524629ad72a35670c1f98d8f1eae05c4b
+  metadata.gz: 15a35a6440ba6536d6989451ec60d0d8037303e93c47049aaa73c05846ea65f22bad0517084510811ed9cfa794acf86f0f5dc512cee37320841cff402fb381ba
+  data.tar.gz: 493ebc3d9f648e39ca5869d397dfcd4af1bc5facb5c1a669eda9a358bce67f85c21b93c7781ae8dbce3a9c4a34bdf98b8df788c08964e5214affb957a081edd6

data/README.md

@@ -3,7 +3,7 @@ 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)
+[![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.
@@ -16,11 +16,11 @@ This gem provides features such as:
 
 2. An index of the project files with their respective number of smells:
 
-  ![RubyCritic code index screenshot](http://i.imgur.com/Hx2y2cG.png)
+  ![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/ogXYIwR.png)
+  ![RubyCritic smells index screenshot](http://i.imgur.com/5CpPt9v.png)
 
 4. Finally, when analysing code like the following:
 
@@ -40,7 +40,7 @@ This gem provides features such as:
 
   Into something like this:
 
-  ![RubyCritic file code screenshot](http://i.imgur.com/88ApcGd.png)
+  ![RubyCritic file code screenshot](http://i.imgur.com/KLVrhMm.png)
 
 Installation
 ------------
@@ -80,6 +80,18 @@ 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:
+
+```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

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

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

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

@@ -5,25 +5,43 @@ module Rubycritic
   module SmellAdapter
 
     class Flay
-      def initialize(paths)
-        @flay = ::Rubycritic::Analyser::Flay.new(paths)
+      def initialize(analysed_files)
+        @analysed_files = paths_to_analysed_files(analysed_files)
+        @flay = Analyser::Flay.new(@analysed_files.keys)
       end
 
       def smells
-        @flay.hashes.map do |structural_hash, nodes|
-          create_smell(structural_hash, nodes)
+        @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)} code",
+          :context   => similarity(structural_hash),
           :message   => "found in #{nodes.size} nodes",
-          :score     => @flay.masses[structural_hash],
-          :type      => "DuplicateCode"
+          :score     => mass,
+          :type      => "DuplicateCode",
+          :cost      => cost(mass)
         )
       end
 
@@ -35,11 +53,15 @@ module Rubycritic
 
       def similarity(structural_hash)
         if @flay.identical[structural_hash]
-          "Identical"
+          "Identical code"
         else
-          "Similar"
+          "Similar code"
         end
       end
+
+      def cost(mass)
+        mass / 25
+      end
     end
 
   end

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

@@ -8,29 +8,38 @@ module Rubycritic
       HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
       VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
 
-      def initialize(paths)
-        @flog = ::Rubycritic::Analyser::Flog.new
-        @flog.flog(*paths)
+      def initialize(analysed_files)
+        @flog = Analyser::Flog.new
+        @analysed_files = analysed_files
       end
 
       def smells
-        smells = []
-        @flog.each_by_score do |class_method, original_score|
-          score = original_score.round
-          smells << create_smell(class_method, score) if score >= HIGH_COMPLEXITY_SCORE_THRESHOLD
+        @analysed_files.each do |analysed_file|
+          add_smells_to(analysed_file)
         end
-        smells
       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)
+          :type      => type(score),
+          :cost      => 0
         )
       end
 

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

@@ -5,24 +5,31 @@ module Rubycritic
   module SmellAdapter
 
     class Reek
-      def initialize(paths)
-        @reek = ::Rubycritic::Analyser::Reek.new(paths)
+      def initialize(analysed_files)
+        @analysed_files = analysed_files
       end
 
       def smells
-        @reek.smells.map do |smell|
-          create_smell(smell)
+        @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
+          :type      => smell.subclass,
+          :cost      => 0
         )
       end
 

data/lib/rubycritic/analysers/churn.rb

@@ -2,13 +2,16 @@ module Rubycritic
   module Analyser
 
     class Churn
-      def initialize(paths, source_control_system)
-        @paths = paths
+      def initialize(analysed_files, source_control_system)
+        @analysed_files = analysed_files
         @source_control_system = source_control_system
       end
 
       def churn
-        @paths.map { |path| @source_control_system.revisions_count(path) }
+        @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
 

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,33 +1,27 @@
-require "rubycritic/active_support/methods"
 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
-    include ActiveSupport
+    SMELL_ANALYSERS = [SmellAdapter::Flay, SmellAdapter::Flog, SmellAdapter::Reek]
 
-    ANALYSERS = ["Flay", "Flog", "Reek"]
-
-    def initialize(paths)
-      @paths = paths
-    end
-
-    def smells
-      aggregate_smells(smell_adapters)
+    def initialize(analysed_files, source_control_system)
+      @analysed_files = analysed_files
+      @source_control_system = source_control_system
     end
 
-    private
-
-    def smell_adapters
-      ANALYSERS.map do |analyser_name|
-        constantize("Rubycritic::SmellAdapter::#{analyser_name}").new(@paths)
+    def run
+      SMELL_ANALYSERS.map do |analyser|
+        analyser.new(@analysed_files).smells
       end
-    end
-
-    def aggregate_smells(smell_adapters)
-      smell_adapters.flat_map(&:smells)
+      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,30 +1,46 @@
 require "optparse"
 require "rubycritic"
-require "rubycritic/orchestrators/main"
+require "rubycritic/reporters/main"
 
 module Rubycritic
 
-  OptionParser.new do |opts|
-    opts.banner = "Usage: rubycritic [options] [paths]"
+  class Cli
+    STATUS_SUCCESS = 0
 
-    opts.on("-p", "--path [PATH]", "Set path where report will be saved (tmp/rubycritic by default)") do |path|
-      configuration.root = path
+    def initialize(argv)
+      @argv = argv
+      @argv << "." if @argv.empty?
+      @main_command = true
     end
 
-    opts.on_tail("-v", "--version", "Show gem's version") do
-      require "rubycritic/version"
-      puts VERSION
-      exit 0
-    end
+    def execute
+      OptionParser.new do |opts|
+        opts.banner = "Usage: rubycritic [options] [paths]"
 
-    opts.on_tail("-h", "--help", "Show this message") do
-      puts opts
-      exit 0
-    end
-  end.parse!
+        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 #{Orchestrator::Main.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

@@ -1,3 +1,5 @@
+require "pathname"
+
 module Rubycritic
   def self.configuration
     @configuration ||= Configuration.new
@@ -11,7 +13,11 @@ module Rubycritic
     end
 
     def root=(path)
-      @root = File.expand_path(path)
+      @root = if Pathname(path).relative?
+                File.expand_path(path)
+              else
+                path
+              end
     end
   end
 end

data/lib/rubycritic/core/analysed_file.rb

@@ -1,4 +1,5 @@
 require "virtus"
+require "rubycritic/core/rating"
 
 module Rubycritic
 
@@ -8,15 +9,40 @@ module Rubycritic
     attribute :pathname
     attribute :smells
     attribute :churn
+    attribute :committed_at
     attribute :complexity
+    attribute :duplication
+    attribute :methods_count
 
     def name
-      pathname.basename.sub_ext("").to_s
+      @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
+      complexity.fdiv(methods_count).round(1)
+    rescue ZeroDivisionError
+      "N/A"
     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/core/location.rb

@@ -19,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

data/lib/rubycritic/core/smell.rb

@@ -7,15 +7,12 @@ module Rubycritic
     include Virtus.model
 
     attribute :context
+    attribute :cost
     attribute :locations
     attribute :message
     attribute :score
-    attribute :type
     attribute :status
-
-    def at_pathname?(other_pathname)
-      pathnames.any? { |pathname| pathname == other_pathname }
-    end
+    attribute :type
 
     def at_location?(other_location)
       locations.any? { |location| location == other_location }
@@ -26,7 +23,7 @@ module Rubycritic
     end
 
     def ==(other)
-      self.class == other.class && state == other.state
+      state == other.state
     end
     alias_method :eql?, :==
 
@@ -43,12 +40,6 @@ module Rubycritic
     def state
       [@context, @message, @score, @type]
     end
-
-    private
-
-    def pathnames
-      @pathnames ||= locations.map(&:pathname).uniq
-    end
   end
 
 end

data/lib/rubycritic/files_initializer.rb

@@ -0,0 +1,15 @@
+require "rubycritic/source_locator"
+require "rubycritic/core/analysed_file"
+
+module Rubycritic
+
+  module FilesInitializer
+    def self.init(paths)
+      source = SourceLocator.new(paths)
+      source.pathnames.map do |pathname|
+        AnalysedFile.new(:pathname => pathname, :smells => [], :duplication => 0)
+      end
+    end
+  end
+
+end

data/lib/rubycritic/orchestrator.rb

@@ -0,0 +1,23 @@
+require "rubycritic/source_control_systems/base"
+require "rubycritic/files_initializer"
+require "rubycritic/analysers_runner"
+require "rubycritic/revision_comparator"
+
+module Rubycritic
+
+  class Orchestrator
+    def initialize
+      @source_control_system = SourceControlSystem::Base.create
+    end
+
+    def critique(paths)
+      analysed_files = FilesInitializer.init(paths)
+      AnalysersRunner.new(analysed_files, @source_control_system).run
+      if @source_control_system.has_revision?
+        RevisionComparator.new(analysed_files, @source_control_system).set_statuses
+      end
+      analysed_files
+    end
+  end
+
+end

data/lib/rubycritic/report_generators/assets/javascripts/application.js

@@ -8,8 +8,8 @@ function emphasizeLineFromFragment() {
 
 $(".js-file-code").on("click", ".js-smell-location", emphasizeLineFromHref);
 
-function emphasizeLineFromHref() {
-    if (hrefTargetIsOnCurrentPage(this)) {
+function emphasizeLineFromHref(event) {
+    if (hrefTargetIsOnCurrentPage(this) && !event.ctrlKey) {
         $(".js-file-code li").removeClass("highlight");
         var lineId = "#" + this.href.split("#")[1];
         emphasizeLine(lineId);
@@ -52,6 +52,8 @@ $("#js-index-table")
     })
     .floatThead();          // Make table headers stick to the top when scrolling
 
+$(".js-timeago").timeago();
+
 $("#js-chart-container").highcharts({
     chart: {
         type: "scatter",
@@ -97,6 +99,6 @@ $("#js-chart-container").highcharts({
     series: [{
         showInLegend: false,
         color: "steelblue",
-        data: turbulence_data
+        data: turbulenceData
     }]
 });