rubycritic 0.0.5 → 0.0.16

data/lib/rubycritic.rb

@@ -1,27 +1,2 @@
-require "rubycritic/source_locator"
-require "rubycritic/analysers_runner"
-require "rubycritic/smells_aggregator"
-require "rubycritic/source_control_systems/source_control_system"
-require "rubycritic/revision_comparator"
-require "rubycritic/report_generators/reporter"
-
-module Rubycritic
-
-  class Rubycritic
-    def initialize
-      @source_control_system = SourceControlSystem.create
-    end
-
-    def critique(paths)
-      source = SourceLocator.new(paths)
-      if @source_control_system.has_revision?
-        smelly_pathnames = RevisionComparator.new(source.paths, @source_control_system).compare
-      else
-        smell_adapters = AnalysersRunner.new(source.paths).run
-        smelly_pathnames = SmellsAggregator.new(smell_adapters).smelly_pathnames
-      end
-      Reporter.new(source.pathnames, smelly_pathnames).generate_report
-    end
-  end
-
-end
+require "rubycritic/configuration"
+require "rubycritic/orchestrator"

data/rubycritic.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Ruby code smell detector"
   spec.homepage      = "https://github.com/whitesmith/rubycritic"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 1.9.3"
 
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -21,8 +22,10 @@ Gem::Specification.new do |spec|
   spec.require_path  = "lib"
 
   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_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

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

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

data/test/lib/rubycritic/adapters/smell/flay_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+require "rubycritic/adapters/smell/flay"
+require "rubycritic/core/analysed_file"
+require "pathname"
+
+describe Rubycritic::SmellAdapter::Flay do
+  before do
+    @analysed_file = Rubycritic::AnalysedFile.new(
+      :pathname => Pathname.new("test/samples/flay/smelly.rb"),
+      :smells => [],
+      :duplication => 0
+    )
+    analysed_files = [@analysed_file]
+    Rubycritic::SmellAdapter::Flay.new(analysed_files).smells
+  end
+
+  it "detects smells and adds them to analysed_files" do
+    @analysed_file.smells.length.must_equal 1
+  end
+
+  it "creates smells with messages" do
+    smell = @analysed_file.smells.first
+    smell.message.must_be_instance_of String
+  end
+
+  it "creates smells with scores" do
+    smell = @analysed_file.smells.first
+    smell.score.must_be_kind_of Numeric
+  end
+
+  it "calculates the mass of duplicate code and adds it to analysed_files" do
+    @analysed_file.duplication.must_be(:>, 0)
+  end
+end

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

@@ -0,0 +1,26 @@
+require "test_helper"
+require "rubycritic/adapters/smell/flog"
+
+describe Rubycritic::SmellAdapter::Flog 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
+  end
+
+  it "detects smells and adds them to analysed_files" do
+    @analysed_file.smells.length.must_equal 1
+  end
+
+  it "creates smells with messages" do
+    smell = @analysed_file.smells.first
+    smell.message.must_be_instance_of String
+  end
+
+  it "creates smells with scores" do
+    smell = @analysed_file.smells.first
+    smell.score.must_be_kind_of Numeric
+  end
+end
+
+class AnalysedFileDouble < OpenStruct; end

data/test/lib/rubycritic/adapters/smell/reek_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+require "rubycritic/adapters/smell/reek"
+
+describe Rubycritic::SmellAdapter::Reek 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
+    end
+
+    it "detects smells and adds them to analysed_files" do
+      @analysed_file.smells.length.must_equal 1
+    end
+
+    it "creates smells with messages" do
+      smell = @analysed_file.smells.first
+      smell.message.must_equal "has boolean parameter 'reek'"
+    end
+  end
+
+  context "when analysing a file with smells ignored in config.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)
+    end
+
+    it "does not detect smells and does not add them to analysed files" do
+      @analysed_file.smells.must_be_empty
+    end
+  end
+end
+
+class AnalysedFileDouble < OpenStruct; end

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

@@ -0,0 +1,38 @@
+require "test_helper"
+require "rubycritic/analysers/churn"
+require "rubycritic/source_control_systems/base"
+
+describe Rubycritic::Analyser::Churn do
+  before do
+    @analysed_files = [AnalysedFileDouble.new(:path => "path_to_some_file.rb")]
+    @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
+    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
+    end
+  end
+end
+
+class AnalysedFileDouble < OpenStruct; end
+
+class SourceControlSystemDouble < Rubycritic::SourceControlSystem::Base
+  def revisions_count(path)
+    1 # churn
+  end
+
+  def date_of_last_commit(path)
+    "2013-10-09 12:52:49 +0100"
+  end
+end

data/test/lib/rubycritic/configuration_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+require "rubycritic/configuration"
+
+describe Rubycritic::Configuration do
+  describe "#root" do
+    it "has a default" do
+      Rubycritic.configuration.root.wont_be_empty
+    end
+
+    it "can be configured" do
+      default = Rubycritic.configuration.root
+      Rubycritic.configuration.root = "foo"
+      Rubycritic.configuration.root.must_equal File.expand_path("foo")
+      Rubycritic.configuration.root = default
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+require "test_helper"
+require "rubycritic/core/analysed_file"
+require "rubycritic/core/smell"
+require "rubycritic/core/location"
+
+describe Rubycritic::AnalysedFile do
+  describe "attribute readers" do
+    before do
+      @pathname = Pathname.new("foo/bar.rb")
+      @smells = []
+      @churn = 1
+      @complexity = 2
+      @analysed_file = Rubycritic::AnalysedFile.new(
+        :pathname   => @pathname,
+        :smells     => @smells,
+        :churn      => @churn,
+        :complexity => @complexity
+      )
+    end
+
+    it "has a pathname reader" do
+      @analysed_file.pathname.must_equal @pathname
+    end
+
+    it "has a smells reader" do
+      @analysed_file.smells.must_equal @smells
+    end
+
+    it "has a churn reader" do
+      @analysed_file.churn.must_equal @churn
+    end
+
+    it "has a complexity reader" do
+      @analysed_file.complexity.must_equal @complexity
+    end
+
+    it "has a name reader" do
+      @analysed_file.name.must_equal "bar"
+    end
+
+    it "has a path reader" do
+      @analysed_file.path.must_equal @pathname.to_s
+    end
+  end
+
+  describe "#cost" do
+    it "returns the remediation cost of fixing the analysed_file" do
+      smells = [SmellDouble.new(:cost => 1), SmellDouble.new(:cost => 2)]
+      analysed_file = Rubycritic::AnalysedFile.new(:smells => smells, :complexity => 0)
+      analysed_file.cost.must_equal 3
+    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])
+      analysed_file.has_smells?.must_equal true
+    end
+  end
+
+  describe "#smells_at_location" do
+    it "returns the smells of an analysed_file at a certain location" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smells = [Rubycritic::Smell.new(:locations => [location])]
+      analysed_file = Rubycritic::AnalysedFile.new(:smells => smells)
+      analysed_file.smells_at_location(location).must_equal smells
+    end
+  end
+end
+
+class SmellDouble < OpenStruct; end

data/test/lib/rubycritic/{location_test.rb → core/location_test.rb}

@@ -1,11 +1,11 @@
 require "test_helper"
-require "rubycritic/location"
+require "rubycritic/core/location"
 
 describe Rubycritic::Location do
   describe "attribute readers" do
     before do
-      @path = "./foo"
-      @line = 42
+      @path = "./foo.rb"
+      @line = "42"
       @location = Rubycritic::Location.new(@path, @line)
     end
 
@@ -14,7 +14,11 @@ describe Rubycritic::Location do
     end
 
     it "has a line number" do
-      @location.line.must_equal @line
+      @location.line.must_equal @line.to_i
+    end
+
+    it "has a file name" do
+      @location.file_name.must_equal "foo"
     end
   end
 

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

@@ -0,0 +1,73 @@
+require "test_helper"
+require "rubycritic/core/smell"
+require "rubycritic/core/location"
+
+describe Rubycritic::Smell do
+  describe "attribute readers" do
+    before do
+      @locations = [Rubycritic::Location.new("./foo", "42")]
+      @context = "#bar"
+      @message = "This smells"
+      @score = 0
+      @type = :complexity
+      @smell = Rubycritic::Smell.new(
+        :locations => @locations,
+        :context   => @context,
+        :message   => @message,
+        :score     => @score,
+        :type      => @type
+      )
+    end
+
+    it "has a context reader" do
+      @smell.context.must_equal @context
+    end
+
+    it "has a locations reader" do
+      @smell.locations.must_equal @locations
+    end
+
+    it "has a message reader" do
+      @smell.message.must_equal @message
+    end
+
+    it "has a score reader" do
+      @smell.score.must_equal @score
+    end
+
+    it "has a type reader" do
+      @smell.type.must_equal @type
+    end
+  end
+
+  describe "#at_location?" do
+    it "returns true if the smell has a location that matches the location passed as argument" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smell = Rubycritic::Smell.new(:locations => [location])
+      smell.at_location?(location).must_equal true
+    end
+  end
+
+  describe "#has_multiple_locations?" do
+    it "returns true if the smell has more than one location" do
+      location1 = Rubycritic::Location.new("./foo", "42")
+      location2 = Rubycritic::Location.new("./foo", "23")
+      smell = Rubycritic::Smell.new(:locations => [location1, location2])
+      smell.has_multiple_locations?.must_equal true
+    end
+  end
+
+  describe "#==" do
+    it "returns true if two smells have the same base attributes" do
+      attributes = {
+        :context => "#bar",
+        :message => "This smells",
+        :score => 0,
+        :type => :complexity
+      }
+      smell1 = Rubycritic::Smell.new(attributes)
+      smell2 = Rubycritic::Smell.new(attributes)
+      smell1.must_equal smell2
+    end
+  end
+end

data/test/lib/rubycritic/{smells_array_test.rb → core/smells_array_test.rb}

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 describe "Array of Smells" do
   it "is sortable" do

data/test/lib/rubycritic/smells_status_setter_test.rb

@@ -1,21 +1,21 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 require "rubycritic/smells_status_setter"
 
 describe Rubycritic::SmellsStatusSetter do
-  describe "#smelly_pathnames" do
+  describe "#smells" do
     before do
       @smell = Rubycritic::Smell.new(:context => "#bar")
-      @smelly_pathnames = { "file0.rb" => [@smell] }
+      @smells = [@smell]
     end
 
     it "marks old smells" do
-      Rubycritic::SmellsStatusSetter.new(@smelly_pathnames, @smelly_pathnames).smelly_pathnames
+      Rubycritic::SmellsStatusSetter.set(@smells, @smells)
       @smell.status.must_equal :old
     end
 
     it "marks new smells" do
-      Rubycritic::SmellsStatusSetter.new({}, @smelly_pathnames).smelly_pathnames
+      Rubycritic::SmellsStatusSetter.set([], @smells)
       @smell.status.must_equal :new
     end
   end

data/test/lib/rubycritic/source_control_systems/source_control_system_test.rb

@@ -1,9 +1,9 @@
 require "test_helper"
-require "rubycritic/source_control_systems/source_control_system"
+require "rubycritic/source_control_systems/base"
 
 describe Rubycritic::SourceControlSystem do
   before do
-    Rubycritic::SourceControlSystem.systems.each do |system|
+    Rubycritic::SourceControlSystem::Base.systems.each do |system|
       system.stubs(:supported?).returns(false)
     end
   end
@@ -11,15 +11,9 @@ describe Rubycritic::SourceControlSystem do
   describe "::create" do
     describe "when a source control system is found" do
       it "creates an instance of that source control system" do
-        Rubycritic::Git.stubs(:supported?).returns(true)
-        system = Rubycritic::SourceControlSystem.create
-        system.must_be_instance_of Rubycritic::Git
-      end
-    end
-
-    describe "when no source control system is found" do
-      it "raises an error" do
-        proc { Rubycritic::SourceControlSystem.create }.must_raise RuntimeError
+        Rubycritic::SourceControlSystem::Git.stubs(:supported?).returns(true)
+        system = Rubycritic::SourceControlSystem::Base.create
+        system.must_be_instance_of Rubycritic::SourceControlSystem::Git
       end
     end
   end

data/test/lib/rubycritic/source_locator_test.rb

@@ -3,12 +3,12 @@ require "rubycritic/source_locator"
 
 describe Rubycritic::SourceLocator do
   before do
-    @original_dir = Dir.pwd
+    @original_dir = Dir.getwd
     Dir.chdir("test/samples/location")
   end
 
   describe "#paths" do
-    it "finds a single path" do
+    it "finds a single file" do
       paths = ["file0.rb"]
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
@@ -18,33 +18,42 @@ describe Rubycritic::SourceLocator do
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
 
-    it "finds all the paths" do
-      paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(["."]).paths.must_equal paths
+    it "finds all the files inside a given directory" do
+      initial_paths = ["dir1"]
+      final_paths = ["dir1/file1.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
-    it "finds all the files inside a given directory" do
-      paths = ["dir1/file1.rb"]
-      Rubycritic::SourceLocator.new(["dir1"]).paths.must_equal paths
+    it "finds all the files" do
+      initial_paths = ["."]
+      final_paths = ["dir1/file1.rb", "file0.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
+    end
+
+    it "cleans paths of consecutive slashes and useless dots" do
+      initial_paths = [".//file0.rb"]
+      final_paths = ["file0.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
     it "ignores paths to non-existent files" do
-      paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal []
+      initial_paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
+      final_paths = []
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
     it "ignores paths to files that do not match the Ruby extension" do
-      paths = ["file_with_no_extension", "file_with_different_extension.py"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal []
+      initial_paths = ["file_with_no_extension", "file_with_different_extension.py"]
+      final_paths = []
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
   end
 
   describe "#pathnames" do
-    it "finds a single path" do
-      path = "file0.rb"
-      paths = [path]
-      result = [Pathname.new(path)]
-      Rubycritic::SourceLocator.new(paths).pathnames.must_equal result
+    it "finds a single file" do
+      initial_paths = ["file0.rb"]
+      final_pathnames = [Pathname.new("file0.rb")]
+      Rubycritic::SourceLocator.new(initial_paths).pathnames.must_equal final_pathnames
     end
   end
 

data/test/lib/rubycritic/turbulence_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+require "rubycritic/turbulence"
+
+describe Rubycritic::Turbulence do
+  describe "#data" do
+    it "returns json data that maps pathname, churn and complexity to name, x and y" do
+      files = [AnalysedFileDouble.new(:pathname => "./foo.rb", :churn => 1, :complexity => 2)]
+      turbulence_data = Rubycritic::Turbulence.data(files)
+      instance_parsed_json = JSON.parse(turbulence_data).first
+      instance_parsed_json["name"].must_equal "./foo.rb"
+      instance_parsed_json["x"].must_equal 1
+      instance_parsed_json["y"].must_equal 2
+    end
+  end
+end
+
+class AnalysedFileDouble < OpenStruct; end

data/test/lib/rubycritic/version_test.rb

@@ -1,4 +1,5 @@
 require "test_helper"
+require "rubycritic/version"
 
 describe "Rubycritic version" do
   it "is defined" do

data/test/samples/flay/smelly.rb

@@ -0,0 +1,17 @@
+class Ramsay
+  def flay(parts)
+    parts -= 1
+    parts -= 2
+    parts -= 3
+    parts -= 4
+  end
+end
+
+class Roose
+  def flay(parts)
+    parts -= 1
+    parts -= 2
+    parts -= 3
+    parts -= 4
+  end
+end

data/test/samples/flog/complex.rb

@@ -0,0 +1,11 @@
+class AllTheMethods
+  def method_missing(method, *args, &block)
+    message = "I"
+    eval "message = ' did not'"
+    eval "message << ' exist,'"
+    eval "message << ' but now'"
+    eval "message << ' I do.'"
+    self.class.send(:define_method, method) { "I did not exist, but now I do." }
+    self.send(method)
+  end
+end

data/test/samples/flog/smelly.rb

@@ -1,6 +1,11 @@
 class AllTheMethods
   def method_missing(method, *args, &block)
-    define_method(method) { "I did not exist, but now I do." }
-    send(method)
+    message = "I"
+    eval "message = ' did not'"
+    eval "message << ' exist,'"
+    eval "message << ' but now'"
+    eval "message << ' I do.'"
+    self.class.send(:define_method, method) { "I did not exist, but now I do." }
+    self.send(method)
   end
 end

data/test/samples/reek/not_smelly.rb

@@ -1,7 +1,35 @@
-class Perfumed
-  attr_reader :perfume
+class Perfume
+  attr_reader :perfumed
 
-  def ignoresRubyStyle(oneParameter)
+  def ignoreRubyStyle(oneParameter)
     oneVariable = oneParameter
   end
+
+  def allow_nesting_iterators_two_levels_deep
+    loop do
+      loop do
+      end
+    end
+  end
+
+  def method_with_too_many_statements
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+  end
+
+  def allow_up_to_two_duplicate_method_calls
+    respond_to do |format|
+      if success
+        format.html { redirect_to some_path }
+        format.js { head :ok }
+      else
+        format.html { redirect_to :back, status: :bad_request }
+        format.js { render status: :bad_request }
+      end
+    end
+  end
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require "minitest/autorun"
 require "minitest/pride"
 require "mocha/setup"
+require "ostruct"
 
 def context(*args, &block)
   describe(*args, &block)