class Churn::SourceControl

Base class for analyzing various SCM systems like git, HG, and SVN

Public Class Methods

new(start_date=nil) click to toggle source
# File lib/churn/scm/source_control.rb, line 21
def initialize(start_date=nil)
  @start_date = start_date
end
set_source_control(start_date) click to toggle source
# File lib/churn/scm/source_control.rb, line 6
def self.set_source_control(start_date)
  analyzers = [GitAnalyzer, HgAnalyzer, BzrAnalyzer, SvnAnalyzer]
  analyzer = analyzers.detect(&:supported?)
  if analyzer
    analyzer.new(start_date)
  else
    raise "Churn requires a bazaar, git, mercurial, or subversion source control"
  end
end
supported?() click to toggle source

@api public

# File lib/churn/scm/source_control.rb, line 17
def self.supported?
  raise NotImplementedError, "child class must implement"
end

Public Instance Methods

generate_history(starting_point) click to toggle source
# File lib/churn/scm/source_control.rb, line 33
def generate_history(starting_point)
  raise NotImplementedError, "child class must implement"
end
get_logs() click to toggle source
# File lib/churn/scm/source_control.rb, line 25
def get_logs
  raise NotImplementedError, "child class must implement"
end
get_revisions() click to toggle source
# File lib/churn/scm/source_control.rb, line 29
def get_revisions
  raise NotImplementedError, "child class must implement"
end
get_updated_files_change_info(revision, revisions) click to toggle source
# File lib/churn/scm/source_control.rb, line 37
def get_updated_files_change_info(revision, revisions)
  updated     = {}
  logs        = get_updated_files_from_log(revision, revisions)
  recent_file = nil
  logs.each do |line|
    if /^---|^\+\+\+/ =~ line
      # Remove the --- a/ and +++ b/ if present
      recent_file = get_recent_file(line)
      updated[recent_file] = [] unless updated.include?(recent_file)
    elsif /^@@/ =~ line
      # Now add the added/removed ranges for the line
      removed_range = get_changed_range(line, '-')
      added_range   = get_changed_range(line, '\+')
      updated[recent_file] << removed_range
      updated[recent_file] << added_range
    else
      raise "diff lines that don't match the two patterns aren't expected: '#{line}'"
    end
  end
  updated
end
get_updated_files_from_log(revision, revisions) click to toggle source
# File lib/churn/scm/source_control.rb, line 59
def get_updated_files_from_log(revision, revisions)
  current_index = revisions.index(revision)
  previous_index = current_index+1
  previous_revision = revisions[previous_index] unless revisions.length < previous_index
  if revision && previous_revision
    get_diff(revision, previous_revision)
  else
    []
  end
end

Private Instance Methods

get_changed_range(line, matcher) click to toggle source
# File lib/churn/scm/source_control.rb, line 72
def get_changed_range(line, matcher)
  change_start = line.match(/#{matcher}[0-9]+/)
  change_end   = line.match(/#{matcher}[0-9]+,[0-9]+/)
  change_start = change_start.to_s.gsub(/#{matcher}/,'')
  change_end   = change_end.to_s.gsub(/.*,/,'')

  change_start_num = change_start.to_i
  range  = if change_end && change_end!=''
             (change_start_num..(change_start_num+change_end.to_i))
           else
             (change_start_num..change_start_num)
           end
  range
end
get_recent_file(line) click to toggle source
# File lib/churn/scm/source_control.rb, line 87
def get_recent_file(line)
  line.gsub(/^--- /,'').gsub(/^\+\+\+ /,'').gsub(/^a\//,'').gsub(/^b\//,'')
end