analdiffist 0.3.0 → 0.4.0

data/TODO

@@ -0,0 +1,5 @@
+- if there are uncommitted changes, should they be analyzed?
+- diffing engine needs help
+- add -v and --version switches 
+- different grouping options (added/removed and by class/module/context)
+

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/anal_diffist.rb

@@ -1,6 +1,5 @@
 module AnalDiffist
   require 'analdiffist/target_finder'
-  require 'analdiffist/reek_metrics'
   require 'analdiffist/reek_parser'
   require 'analdiffist/flog_parser'
   require 'analdiffist/diff_set'
@@ -49,7 +48,7 @@ module AnalDiffist
     end
 
     def get_refs_to_diff current_branch, start_ref, end_ref
-      [ start_ref || "origin/master", end_ref || current_branch]
+      [ start_ref ||  `git merge-base HEAD origin/master`, end_ref || current_branch]
     end
 
     def analyze_ref ref_name

data/lib/analdiffist/diff_set.rb

@@ -6,25 +6,48 @@ module AnalDiffist
     end
 
     def added_problems
-      compare(@after, @before)
+      differences.select {|difference| difference.score > 0 }
     end
 
     def removed_problems
-      compare(@before, @after)
+      differences.select {|difference| difference.score < 0 }
     end
 
     private
-    def compare(a,b)
-      #TODO: move this comparison into the class?
-      a.map do |problem| 
-        matching_problem = b.detect {|problem2| [problem.type, problem.context] == [problem2.type, problem2.context] }
+    def differences
+      @differences ||= calculate_differences
+    end
+
+    def calculate_differences
+      diffs = []
+      before_by_context = @before.group_by {|b| [b.type, b.context]}
+      after_by_context = @after.group_by {|b| [b.type, b.context]}
+      all_contexts = (before_by_context.keys + after_by_context.keys).uniq
 
-          problem.diff(matching_problem)
+      all_contexts.each do |context|
 
-      end.reject {|x| x.nil?}
+        before = before_by_context[context] || []
+        after = after_by_context[context] || []
+
+        diffs.concat(calculate_diffs_for_a_context(before, after))
+      end
+      diffs.reject(&:nil?)
     end
-  end
 
-  class ScoreDiffSet
+    def calculate_diffs_for_a_context before, after
+      diffs = []
+      while before.any? || after.any? do
+        diff = get_diff(before.pop, after.pop)
+        diffs << diff unless diff.nil?
+      end
+      diffs
+    end
+
+    def get_diff before, after
+      return after.diff(before) unless after.nil?
+      diff = before.diff(after)
+      return nil if diff.nil?
+      InvertedDiff.new(diff)
+    end
   end
 end

data/lib/analdiffist/flog_parser.rb

@@ -7,7 +7,8 @@ module AnalDiffist
     end
 
     def problems
-      f = Flog.new
+      f = Flog.new :continue => true
+
       f.flog(@paths)
       problems = []
       f.each_by_score{|class_method, score, ignore_for_now| problems << FlogProblem.new(class_method, score, @flog_threshold)}
@@ -29,10 +30,12 @@ module AnalDiffist
     end
 
     def diff other
-      return nil if score < @flog_threshold
-      return FlogDiff.new(@context, 0, score) if other.nil?
-
-      return nil if other.score >= score
+      if other.nil?
+        return nil if score < @flog_threshold
+        return FlogDiff.new(@context, 0, score)
+      end
+      return nil if other.score == score
+      return nil if score < @flog_threshold && other.score < @flog_threshold
       FlogDiff.new(@context, other.score, score)
     end
 
@@ -53,9 +56,36 @@ module AnalDiffist
       (@current_score - @previous_score).round(1)
     end
 
+    def invert!
+      score = 0 - (score || 0)
+      self
+    end
+
     def description(mode = :added)
-      indicator = (mode == :added) ? "+" : "-"
+      indicator = (mode == :added) ? "+" : ""
       "Flog: #{@current_score.round(1)} (#{indicator}#{(@current_score - @previous_score).round(1)})"
     end
   end
+
+  class InvertedDiff
+    def initialize inner
+      @inner = inner
+    end
+
+    def context
+      @inner.context
+    end
+
+    def score
+      0-@inner.score
+    end
+
+    def type
+      @inner.type
+    end
+
+    def description(mode = :added)
+      @inner.description(mode)
+    end
+  end
 end

data/lib/analdiffist/reek_parser.rb

@@ -4,8 +4,17 @@ module AnalDiffist
     attr_accessor :problems
 
     def initialize(paths)
-      examiner = Reek::Examiner.new(paths)
-      @problems = examiner.smells.map {|smell| ReekProblem.new(smell)}
+      @examiner = Reek::Examiner.new(paths)
+      @problems = get_problems
+    end
+
+    def get_problems
+      unfiltered = @examiner.smells.map {|smell| ReekProblem.new(smell)}
+      filter_reek_problems(unfiltered)
+    end
+
+    def filter_reek_problems(reek_problems)
+      reek_problems
     end
 
     def diff(previous)
@@ -29,10 +38,12 @@ module AnalDiffist
     def diff other
       self if other.nil?
     end
+
     def score
       2
     end
-    def description mode = :added
+
+    def description(mode = :added)
       "Reek: #{type}"
     end
   end

data/lib/analdiffist/standard_diffist.rb

@@ -22,7 +22,10 @@ module AnalDiffist
       diff = DiffSet.new(before.problems, after.problems)
 
       @reporter.report(diff, before.name, after.name)
+    end
 
+    def puts_problems problems
+      puts problems.map {|p| "#{p.context} - #{p.description}"}.join("\n")
     end
 
     private

data/lib/analdiffist/std_out_reporter.rb

@@ -2,13 +2,29 @@ module AnalDiffist
   class StdOutReporter
     def report diff, from_rev, to_rev
       puts "\n\nAnaldifference between revisions: \n #{from_rev}\n #{to_rev}"
-      puts "\nAdded:\n"
-      puts describe(diff.added_problems, :added).join("\n")
-      puts "\nRemoved:\n"
-      puts describe(diff.removed_problems, :removed).join("\n")
+      sum = sum_scores(diff.added_problems + diff.removed_problems)
+      direction = ["Same", "Worse", "Better"][sum<=>0]
+
+      puts "Overall: #{'+' if sum > 0}#{sum} (#{direction})"
+
+      describe_problems(diff.added_problems, 'Worse', :added)
+      describe_problems(diff.removed_problems, 'Better', :removed)
+
       puts "\n\n"
     end
 
+    def sum_scores diffs
+      sum = 0.0
+      diffs.each {|p| sum += p.score}
+      sum.round(1)
+    end
+
+    def describe_problems problems, title, mode
+      sum = sum_scores(problems)
+      puts "\n#{title} (#{problems.length} : #{sum})\n"
+      puts describe(problems, mode).join("\n")
+    end
+
     def describe(problems, mode)
       results = []
       by_type = problems.group_by do |prob|

data/spec/lib/analdiffist/diff_set_spec.rb

@@ -1,83 +1,88 @@
 require  'spec_helper'
 
+RSpec::Matchers.define :have_a_single_problem do |type, context|
+  match do |problems|
+    problems.length.should == 1
+    problems.first.type.should == type
+    problems.first.context.should == context
+  end
+end
+
 describe 'diffing two files' do
   context 'single problem added' do
-    before do
-      @diff = AnalDiffist::DiffSet.new([], [test_problem('foo', 'bar')])
-    end
-    it 'should find a new reek' do
-      added_problems = @diff.added_problems
-      added_problems.length.should == 1
-      added_problems.first.type.should == 'foo'
-      added_problems.first.context == 'bar'
-    end
-    it 'should not have any removed reeks' do
-      @diff.removed_problems.should == []
-    end
+    subject{AnalDiffist::DiffSet.new([], [test_problem('foo', 'bar')])}
+
+    its(:removed_problems) {should == []}
+    its(:added_problems) {should  have_a_single_problem 'foo', 'bar'}
   end
 
   context 'single problem removed' do
-    before do
-      @diff = AnalDiffist::DiffSet.new( [test_problem('foo', 'bar')], [])
-    end
-    it 'should find a removed reek' do
-      removed_problems = @diff.removed_problems
-      removed_problems.length.should == 1
-      removed_problems.first.type.should == 'foo'
-      removed_problems.first.context == 'bar'
-    end
-    it 'should not have any added reeks' do
-      @diff.added_problems.should == []
-    end
+    subject { AnalDiffist::DiffSet.new( [test_problem('foo', 'bar')], [])}
+
+    its(:removed_problems) {should have_a_single_problem 'foo', 'bar' }
+    its(:added_problems) {should == []}
   end
 
   context 'one removed, one added, one remains' do
-    before do
+    subject do
       before = [test_problem('foo', 'bar'), test_problem('removed', 'removed')]
       after = [test_problem('foo', 'bar'), test_problem('added', 'added')]
-      @diff = AnalDiffist::DiffSet.new(before, after)
+      AnalDiffist::DiffSet.new(before, after)
     end
 
-    it 'should find a removed reek' do
-      removed_problems = @diff.removed_problems
-      removed_problems.length.should == 1
-      removed_problems.first.type.should == 'removed'
-      removed_problems.first.context == 'removed'
+    its(:removed_problems) {should  have_a_single_problem 'removed', 'removed'}
+    its(:added_problems) {should have_a_single_problem 'added', 'added'}
+  end
+
+  context 'reeks are grouped by context and type' do
+    context 'two reeks with same context and type, then one is removed' do
+      subject do
+        before = [test_problem('same-type', 'bar'), test_problem('same-type', 'bar')]
+        after = [test_problem('same-type', 'bar')]
+        AnalDiffist::DiffSet.new(before, after)
+      end
+
+      its(:removed_problems) {should  have_a_single_problem 'same-type', 'bar'}
+      its(:added_problems) {should == []}
     end
 
-    it 'should find an added problem' do
-      added_problems = @diff.added_problems
-      added_problems.length.should == 1
-      added_problems.first.type.should == 'added'
-      added_problems.first.context == 'added'
+    context 'two reeks with same context and different type, then one is removed' do
+      subject do
+        before = [test_problem('other-type', 'bar')]
+        after = [test_problem('same-type', 'bar')]
+        AnalDiffist::DiffSet.new(before, after)
+      end
+
+      its(:removed_problems) {should  have_a_single_problem 'other-type', 'bar'}
+      its(:added_problems) {should  have_a_single_problem 'same-type', 'bar'}
     end
   end
 
   context 'when scores change' do
-    before do
+    subject do
       before = [AnalDiffist::FlogProblem.new('bar', 17.1)]
       after = [AnalDiffist::FlogProblem.new('bar', 18.5)]
-      @diff = AnalDiffist::DiffSet.new(before, after)
+      AnalDiffist::DiffSet.new(before, after).added_problems
     end
+    specify {subject.should have(1).item}
+    specify {subject.first.score.should == 1.4 }
+  end
 
-    it 'should identify as added' do
-      added_problems = @diff.added_problems
-      added_problems.length.should == 1
-      added_problems.first.score.round(1).should == 1.4
+  context 'removing a flog' do
+    subject do
+      before = [AnalDiffist::FlogProblem.new('bar', 18.1)]
+      after = [AnalDiffist::FlogProblem.new('bar', 8.5)]
+      AnalDiffist::DiffSet.new(before, after)
     end
+    specify {subject.added_problems.should have(0).problems}
+    specify {subject.removed_problems.should have(1).item}
+    specify {subject.removed_problems.first.score.should == -9.6 }
   end
 
   def test_problem type, context, score = 1
     smell = double("fake problem")
     smell.stub(:subclass) {type}
-    smell.stub(:location) {context}
+    smell.stub(:location) { {"context" => context} }
     return AnalDiffist::ReekProblem.new(smell)
-
-    double('fake problem').tap do |p|
-      p.stub(:type) {type}
-      p.stub(:context) {context}
-      p.stub(:score) {score}
-      p.stub(:diff) {p}
-    end
   end
 end

data/spec/spec_helper.rb

@@ -7,5 +7,4 @@ require 'anal_diffist'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
 end

data/todo

@@ -0,0 +1,5 @@
+- if there are uncommitted changes, should they be analyzed?
+- diffing engine needs help
+- add -v and --version switches 
+- different grouping options (added/removed and by class/module/context)
+

metadata

@@ -2,7 +2,7 @@
 name: analdiffist
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Adam Pearson
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -07:00
+date: 2011-07-06 00:00:00 -07:00
 default_executable: analdiffist
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE.txt
 - README.md
+- TODO
 files: 
 - .document
 - .rspec
@@ -103,7 +104,6 @@ files:
 - lib/anal_diffist.rb
 - lib/analdiffist/diff_set.rb
 - lib/analdiffist/flog_parser.rb
-- lib/analdiffist/reek_metrics.rb
 - lib/analdiffist/reek_parser.rb
 - lib/analdiffist/standard_diffist.rb
 - lib/analdiffist/std_out_reporter.rb
@@ -113,12 +113,13 @@ files:
 - spec/fixtures/smelly_file.rb
 - spec/lib/analdiffist/diff_set_spec.rb
 - spec/lib/analdiffist/flog_parser_spec.rb
-- spec/lib/analdiffist/reek_metrics_spec.rb
 - spec/lib/analdiffist/reek_parser_spec.rb
 - spec/lib/analdiffist/standard_diffist_spec.rb
 - spec/lib/analdiffist/std_out_reporter_spec.rb
 - spec/lib/analdiffist/target_finder_spec.rb
 - spec/spec_helper.rb
+- todo
+- TODO
 has_rdoc: true
 homepage: http://github.com/radamant/analdiffist
 licenses: 
@@ -133,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1146240536421962276
+      hash: -915699214738148394
       segments: 
       - 0
       version: "0"
@@ -155,7 +156,6 @@ test_files:
 - spec/fixtures/smelly_file.rb
 - spec/lib/analdiffist/diff_set_spec.rb
 - spec/lib/analdiffist/flog_parser_spec.rb
-- spec/lib/analdiffist/reek_metrics_spec.rb
 - spec/lib/analdiffist/reek_parser_spec.rb
 - spec/lib/analdiffist/standard_diffist_spec.rb
 - spec/lib/analdiffist/std_out_reporter_spec.rb

data/lib/analdiffist/reek_metrics.rb

@@ -1,4 +0,0 @@
-module AnalDiffist
-  class ReekMetrics
-  end
-end

data/spec/lib/analdiffist/reek_metrics_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-
-describe AnalDiffist::ReekMetrics do
-end