rubycritic 0.0.14 → 0.0.15

data/lib/rubycritic/smells_status_setter.rb

@@ -1,22 +1,16 @@
 module Rubycritic
 
-  class SmellsStatusSetter
-    def initialize(smells_before, smells_now)
-      @smells_before = smells_before || []
-      @smells_now = smells_now || []
-    end
-
-    def smells
-      old_smells = @smells_now & @smells_before
+  module SmellsStatusSetter
+    def self.set(smells_before, smells_now)
+      old_smells = smells_now & smells_before
       set_status(old_smells, :old)
-      new_smells = @smells_now - @smells_before
+      new_smells = smells_now - smells_before
       set_status(new_smells, :new)
-      @smells_now
     end
 
     private
 
-    def set_status(smells, status)
+    def self.set_status(smells, status)
       smells.each { |smell| smell.status = status }
     end
   end

data/lib/rubycritic/source_control_systems/base.rb

@@ -0,0 +1,60 @@
+require "shellwords"
+
+module Rubycritic
+  module SourceControlSystem
+
+    class Base
+      @@systems = []
+
+      def self.register_system
+        @@systems << self
+      end
+
+      def self.create
+        supported_system = systems.detect(&:supported?)
+        if supported_system
+          supported_system.new
+        else
+          puts "Rubycritic requires a #{system_names} repository."
+          Double.new
+        end
+      end
+
+      def self.systems
+        @@systems
+      end
+
+      def self.system_names
+        systems.join(", ")
+      end
+
+      def self.supported?
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def has_revision?
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def head_reference
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def travel_to_head
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def revisions_count(path)
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def date_of_last_commit(path)
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+    end
+
+  end
+end
+
+require "rubycritic/source_control_systems/double"
+require "rubycritic/source_control_systems/git"

data/lib/rubycritic/source_control_systems/double.rb

@@ -0,0 +1,19 @@
+module Rubycritic
+  module SourceControlSystem
+
+    class Double < Base
+      def has_revision?
+        false
+      end
+
+      def revisions_count(path)
+        "N/A"
+      end
+
+      def date_of_last_commit(path)
+        nil
+      end
+    end
+
+  end
+end

data/lib/rubycritic/source_control_systems/git.rb

@@ -1,57 +1,63 @@
 module Rubycritic
+  module SourceControlSystem
 
-  class Git < SourceControlSystem
-    register_system
+    class Git < Base
+      register_system
 
-    def self.supported?
-      `git branch 2>&1` && $?.success?
-    end
+      def self.supported?
+        `git branch 2>&1` && $?.success?
+      end
 
-    def self.to_s
-      "Git"
-    end
+      def self.to_s
+        "Git"
+      end
 
-    def has_revision?
-      head_reference && $?.success?
-    end
+      def has_revision?
+        head_reference && $?.success?
+      end
 
-    def head_reference
-      `git rev-parse --verify HEAD`.chomp
-    end
+      def head_reference
+        `git rev-parse --verify HEAD`.chomp!
+      end
 
-    def travel_to_head
-      stash_successful = stash_changes
-      yield
-    ensure
-      travel_to_original_state if stash_successful
-    end
+      def travel_to_head
+        stash_successful = stash_changes
+        yield
+      ensure
+        travel_to_original_state if stash_successful
+      end
 
-    def revisions_count(file)
-      `git log --follow --format=oneline #{file}`.count("\n")
-    end
+      def revisions_count(path)
+        `git log --follow --format=oneline #{path.shellescape}`.count("\n")
+      end
 
-    private
+      def date_of_last_commit(path)
+        `git log -1 --date=iso --format=%ad #{path.shellescape}`.chomp!
+      end
 
-    def stash_changes
-      return false if everything_commmited?
+      private
 
-      stashes_count_before = stashes_count
-      `git stash`
-      stashes_count_after = stashes_count
-      stashes_count_after > stashes_count_before
-    end
+      def stash_changes
+        return false if everything_commmited?
 
-    def everything_commmited?
-      `git status --porcelain`.empty?
-    end
+        stashes_count_before = stashes_count
+        `git stash`
+        stashes_count_after = stashes_count
+        stashes_count_after > stashes_count_before
+      end
 
-    def stashes_count
-      `git stash list`.count("\n")
-    end
+      def everything_commmited?
+        `git status --porcelain`.empty?
+      end
 
-    def travel_to_original_state
-      `git stash pop`
+      def stashes_count
+        `git stash list`.count("\n")
+      end
+
+      def travel_to_original_state
+        `git stash pop`
+      end
     end
-  end
 
+  end
 end

data/lib/rubycritic/turbulence.rb

@@ -2,13 +2,9 @@ require "json"
 
 module Rubycritic
 
-  class Turbulence
-    def initialize(analysed_files)
-      @analysed_files = analysed_files
-    end
-
-    def data
-      @analysed_files.map do |analysed_file|
+  module Turbulence
+    def self.data(analysed_files)
+      analysed_files.map do |analysed_file|
         {
           :name => analysed_file.pathname,
           :x => analysed_file.churn,

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/lib/rubycritic.rb

@@ -1,8 +1,2 @@
 require "rubycritic/configuration"
-require "rubycritic/source_locator"
-require "rubycritic/analysers_runner"
-require "rubycritic/source_control_systems/source_control_system"
-require "rubycritic/revision_comparator"
-require "rubycritic/analysers/churn"
-require "rubycritic/adapters/complexity/flog"
-require "rubycritic/analysed_files_builder"
+require "rubycritic/orchestrator"

data/rubycritic.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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

@@ -4,14 +4,14 @@ require "rubycritic/adapters/complexity/flog"
 
 describe Rubycritic::ComplexityAdapter::Flog do
   before do
-    sample_paths = ["test/samples/flog/smelly.rb", "test/samples/flog/smelly2.rb"]
-    @adapter = Rubycritic::ComplexityAdapter::Flog.new(sample_paths)
+    @analysed_files = [AnalysedFileDouble.new(:path => "test/samples/flog/complex.rb")]
+    Rubycritic::ComplexityAdapter::Flog.new(@analysed_files).complexity
   end
 
   describe "#complexity" do
-    it "return an array containing the complexity of each file" do
-      @adapter.complexity.each do |file_complexity|
-        file_complexity.must_be_kind_of Numeric
+    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

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

@@ -1,23 +1,34 @@
 require "test_helper"
 require "rubycritic/adapters/smell/flay"
+require "rubycritic/core/analysed_file"
+require "pathname"
 
 describe Rubycritic::SmellAdapter::Flay do
   before do
-    sample_paths = ["test/samples/flay/smelly.rb"]
-    @adapter = Rubycritic::SmellAdapter::Flay.new(sample_paths)
+    @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" do
-    @adapter.smells.wont_be_empty
+  it "detects smells and adds them to analysed_files" do
+    @analysed_file.smells.length.must_equal 1
   end
 
-  it "has smells with messages" do
-    smell = @adapter.smells.first
+  it "creates smells with messages" do
+    smell = @analysed_file.smells.first
     smell.message.must_be_instance_of String
   end
 
-  it "has smells with scores" do
-    smell = @adapter.smells.first
+  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

@@ -3,21 +3,24 @@ require "rubycritic/adapters/smell/flog"
 
 describe Rubycritic::SmellAdapter::Flog do
   before do
-    sample_paths = ["test/samples/flog/smelly.rb"]
-    @adapter = Rubycritic::SmellAdapter::Flog.new(sample_paths)
+    @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" do
-    @adapter.smells.wont_be_empty
+  it "detects smells and adds them to analysed_files" do
+    @analysed_file.smells.length.must_equal 1
   end
 
-  it "has smells with messages" do
-    smell = @adapter.smells.first
+  it "creates smells with messages" do
+    smell = @analysed_file.smells.first
     smell.message.must_be_instance_of String
   end
 
-  it "has smells with scores" do
-    smell = @adapter.smells.first
+  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

@@ -4,28 +4,32 @@ require "rubycritic/adapters/smell/reek"
 describe Rubycritic::SmellAdapter::Reek do
   context "when analysing a smelly file" do
     before do
-      sample_paths = ["test/samples/reek/smelly.rb"]
-      @adapter = Rubycritic::SmellAdapter::Reek.new(sample_paths)
+      @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" do
-      @adapter.smells.wont_be_empty
+    it "detects smells and adds them to analysed_files" do
+      @analysed_file.smells.length.must_equal 1
     end
 
-    it "has smells with messages" do
-      smell = @adapter.smells.first
+    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
-      sample_paths = ["test/samples/reek/not_smelly.rb"]
-      @adapter = Rubycritic::SmellAdapter::Reek.new(sample_paths)
+      @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" do
-      @adapter.smells.must_be_empty
+    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

@@ -1,23 +1,38 @@
 require "test_helper"
 require "rubycritic/analysers/churn"
-require "rubycritic/source_control_systems/source_control_system"
+require "rubycritic/source_control_systems/base"
 
 describe Rubycritic::Analyser::Churn do
   before do
-    sample_paths = ["path_to_some_file.rb"]
-    source_control_system = SourceControlSystemDouble.new
-    @churn = Rubycritic::Analyser::Churn.new(sample_paths, source_control_system)
+    @analysed_files = [AnalysedFileDouble.new(:path => "path_to_some_file.rb")]
+    @source_control_system = SourceControlSystemDouble.new
   end
 
   describe "#churn" do
-    it "returns an array containing the number of times each file has changed" do
-      @churn.churn.must_equal [1]
+    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 SourceControlSystemDouble < Rubycritic::SourceControlSystem
-  def revisions_count(file)
+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/core/analysed_file_test.rb

@@ -1,14 +1,16 @@
 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")
+      @pathname = Pathname.new("foo/bar.rb")
       @smells = []
       @churn = 1
       @complexity = 2
-      @smell = Rubycritic::AnalysedFile.new(
+      @analysed_file = Rubycritic::AnalysedFile.new(
         :pathname   => @pathname,
         :smells     => @smells,
         :churn      => @churn,
@@ -17,26 +19,35 @@ describe Rubycritic::AnalysedFile do
     end
 
     it "has a pathname reader" do
-      @smell.pathname.must_equal @pathname
+      @analysed_file.pathname.must_equal @pathname
     end
 
     it "has a smells reader" do
-      @smell.smells.must_equal @smells
+      @analysed_file.smells.must_equal @smells
     end
 
     it "has a churn reader" do
-      @smell.churn.must_equal @churn
+      @analysed_file.churn.must_equal @churn
     end
 
     it "has a complexity reader" do
-      @smell.complexity.must_equal @complexity
+      @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 "#name" do
-    it "returns the name of the file" do
-      analysed_file = Rubycritic::AnalysedFile.new(:pathname => Pathname.new("foo/bar.rb"))
-      analysed_file.name.must_equal "bar"
+  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
 
@@ -46,6 +57,15 @@ describe Rubycritic::AnalysedFile do
       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; end
+class SmellDouble < OpenStruct; end

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

@@ -1,5 +1,6 @@
 require "test_helper"
 require "rubycritic/core/smell"
+require "rubycritic/core/location"
 
 describe Rubycritic::Smell do
   describe "attribute readers" do
@@ -47,16 +48,6 @@ describe Rubycritic::Smell do
     end
   end
 
-  describe "#at_pathname?" do
-    it "returns true if the smell has a pathname that matches the pathname passed as argument" do
-      path = "./foo"
-      pathname = Pathname.new(path)
-      location = Rubycritic::Location.new(path, "42")
-      smell = Rubycritic::Smell.new(:locations => [location])
-      smell.at_pathname?(pathname).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")
@@ -66,15 +57,17 @@ describe Rubycritic::Smell do
     end
   end
 
-  it "is comparable" 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
+  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_status_setter_test.rb

@@ -10,12 +10,12 @@ describe Rubycritic::SmellsStatusSetter do
     end
 
     it "marks old smells" do
-      Rubycritic::SmellsStatusSetter.new(@smells, @smells).smells
+      Rubycritic::SmellsStatusSetter.set(@smells, @smells)
       @smell.status.must_equal :old
     end
 
     it "marks new smells" do
-      Rubycritic::SmellsStatusSetter.new([], @smells).smells
+      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,16 +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
-        error = proc { Rubycritic::SourceControlSystem.create }.must_raise RuntimeError
-        error.message.must_match "Rubycritic requires a Git repository."
+        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/turbulence_test.rb

@@ -1,12 +1,11 @@
 require "test_helper"
 require "rubycritic/turbulence"
-require "ostruct"
 
 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.new(files).data
+      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

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/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)