rferraz-churn 0.0.16

data/lib/churn/churn_calculator.rb

@@ -0,0 +1,252 @@
+require 'chronic'
+require 'sexp_processor'
+require 'ruby_parser'
+require 'json'
+require 'hirb'
+require 'fileutils'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'source_control'
+require 'git_analyzer'
+require 'svn_analyzer'
+require 'hg_analyzer'
+require 'bzr_analyzer'
+require 'location_mapping'
+require 'churn_history'
+
+module Churn
+
+  # The work horse of the the churn library. This class takes user input, determins the SCM the user is using. It then determines changes
+  # made during this revision. Finally it reads all the changes from previous revisions and displays human readable output to the command
+  # line. It can also ouput a yaml format readable by other tools such as metric_fu and Caliper.
+  class ChurnCalculator
+
+    # intialized the churn calculator object
+    def initialize(options={})
+      start_date = options.fetch(:start_date) { '3 months ago' }
+      @minimum_churn_count = options.fetch(:minimum_churn_count) { 5 }
+      @source_control = set_source_control(start_date)
+      @changes          = {}
+      @revision_changes = {}
+      @class_changes    = {}
+      @method_changes   = {}
+    end
+
+    # prepares the data for the given project to be reported.
+    # reads git/svn logs analyzes the output, generates a report and either formats as a nice string or returns hash.
+    # @param [Bolean] format to return the data, true for string or false for hash
+    # @return [Object] returns either a pretty string or a hash representing the chrun of the project
+    def report(print = true)
+      self.emit 
+      self.analyze
+      print ? self.to_s : self.to_h
+    end
+    
+    # Emits various data from source control to be analyses later... Currently this is broken up like this as a throwback to metric_fu
+    def emit
+      @changes   = parse_log_for_changes.reject {|file, change_count| change_count < @minimum_churn_count}
+      @revisions = parse_log_for_revision_changes  
+    end 
+
+    # Analyze the source control data, filter, sort, and find more information on the editted files
+    def analyze
+      @changes = sort_changes(@changes)
+      @changes = @changes.map {|file_path, times_changed| {:file_path => file_path, :times_changed => times_changed }}
+
+      calculate_revision_changes
+
+      @method_changes = sort_changes(@method_changes)
+      @method_changes = @method_changes.map {|method, times_changed| {'method' => method, 'times_changed' => times_changed }}
+      @class_changes  = sort_changes(@class_changes)
+      @class_changes  = @class_changes.map {|klass, times_changed| {'klass' => klass, 'times_changed' => times_changed }}
+    end
+
+    # collect all the data into a single hash data structure.
+    def to_h
+      hash                        = {:churn => {:changes => @changes}}
+      hash[:churn][:class_churn]  = @class_changes
+      hash[:churn][:method_churn] = @method_changes
+      #detail the most recent changes made this revision
+      first_revision         = @revisions.first
+      first_revision_changes = @revision_changes[first_revision]
+      if first_revision_changes
+        changes = first_revision_changes
+        hash[:churn][:changed_files]   = changes[:files]
+        hash[:churn][:changed_classes] = changes[:classes]
+        hash[:churn][:changed_methods] = changes[:methods]
+      end
+      #TODO crappy place to do this but save hash to revision file but while entirely under metric_fu only choice
+      ChurnHistory.store_revision_history(first_revision, hash)
+      hash
+    end
+
+    # Pretty print the data as a string for the user
+    def to_s
+      hash   = to_h[:churn]
+      result = seperator 
+      result +="* Revision Changes \n"
+      result += seperator
+      result += "Files: \n"
+      result += display_array(hash[:changed_files], :fields=>[:to_str], :headers=>{:to_str=>'file'})
+      result += "\nClasses: \n"
+      result += display_array(hash[:changed_classes])
+      result += "\nMethods: \n"
+      result += display_array(hash[:changed_methods]) + "\n"
+      result += seperator 
+      result +="* Project Churn \n"
+      result += seperator
+      result += "Files: \n"
+      result += display_array(hash[:changes])
+      result += "\nClasses: \n"
+      class_churn = collect_items(hash[:class_churn], 'klass')
+      result += display_array(class_churn)
+      result += "\nMethods: \n"
+      method_churn = collect_items(hash[:method_churn], 'method')
+      result += display_array(method_churn)
+    end
+
+    private
+    
+    def collect_items(collection, match)
+      collection.map {|item| (item.delete(match) || {}).merge(item) }
+    end
+
+    def sort_changes(changes)
+      changes.to_a.sort! {|first,second| second[1] <=> first[1]}
+    end
+
+    def filters
+      /.*\.rb/
+    end
+
+    def display_array(array, options={})
+      array ? Hirb::Helpers::AutoTable.render(array, options.merge(:description=>false)) + "\n" : ''
+    end
+
+    def seperator
+      "*"*70+"\n"
+    end
+
+    def self.git?
+      system("git branch")
+    end
+
+    def self.hg?
+      system("hg branch")
+    end
+
+    def self.bzr?
+        system("bzr nick")
+    end
+
+    def set_source_control(start_date)
+      if self.class.git?
+        GitAnalyzer.new(start_date)
+      elsif self.class.hg?
+        HgAnalyzer.new(start_date)
+      elsif self.class.bzr?
+        BzrAnalyzer.new(start_date)
+      elsif File.exist?(".svn")
+        SvnAnalyzer.new(start_date)
+      else
+        raise "Churning requires a bazaar, git, mercurial, or subversion repo"
+      end
+    end
+
+    def calculate_revision_changes
+      @revisions.each do |revision|
+        if revision == @revisions.first
+          #can't iterate through all the changes and tally them up
+          #it only has the current files not the files at the time of the revision
+          #parsing requires the files
+          changed_files, changed_classes, changed_methods = calculate_revision_data(revision)
+        else
+          changed_files, changed_classes, changed_methods = ChurnHistory.load_revision_data(revision)
+        end
+        calculate_changes!(changed_methods, @method_changes) if changed_methods
+        calculate_changes!(changed_classes, @class_changes) if changed_classes
+        
+        @revision_changes[revision] = { :files => changed_files, :classes => changed_classes, :methods => changed_methods }
+      end
+    end
+
+    def calculate_revision_data(revision)
+      changed_files   = parse_logs_for_updated_files(revision, @revisions)
+      
+      changed_classes = []
+      changed_methods = []
+      changed_files.each do |file_changes|
+        if file_changes.first.match(filters)
+          classes, methods = get_changes(file_changes)
+          changed_classes += classes
+          changed_methods += methods
+        end
+      end
+      changed_files   = changed_files.map { |file, lines| file }
+      [changed_files, changed_classes, changed_methods]
+    end
+
+    def calculate_changes!(changed_objs, total_changes)
+      if changed_objs
+        changed_objs.each do |change|
+          total_changes.include?(change) ? total_changes[change] = total_changes[change]+1 : total_changes[change] = 1
+        end
+      end
+      total_changes
+    end
+
+    def get_changes(change)
+      file = change.first
+      breakdown = LocationMapping.new
+      breakdown.get_info(file)
+      changes = change.last
+      classes = changes_for_type(changes, breakdown.klasses_collection)
+      methods = changes_for_type(changes, breakdown.methods_collection)
+      classes = classes.map{ |klass| {'file' => file, 'klass' => klass} }
+      methods = methods.map{ |method| {'file' => file, 'klass' => get_klass_for(method), 'method' => method} }
+      [classes, methods]
+    rescue => error
+      [[],[]]
+    end
+
+    def get_klass_for(method)
+      method.gsub(/(#|\.).*/,'')
+    end
+
+    def changes_for_type(changes, item_collection)
+      changed_items  = []
+      item_collection.each_pair do |item, item_lines|
+        item_lines = item_lines[0].to_a
+        changes.each do |change_range|
+          item_lines.each do |line|
+            changed_items << item if change_range.include?(line) && !changed_items.include?(item)
+          end
+        end
+      end
+      changed_items
+    end
+    
+    def parse_log_for_changes
+      changes = {}
+      
+      logs = @source_control.get_logs
+      logs.each do |line|
+        changes[line] ? changes[line] += 1 : changes[line] = 1
+      end
+      changes
+    end
+
+    def parse_log_for_revision_changes
+      return [] unless @source_control.respond_to?(:get_revisions)
+      @source_control.get_revisions
+    end
+    
+    def parse_logs_for_updated_files(revision, revisions)
+      #TODO SVN doesn't support this
+      return {} unless @source_control.respond_to?(:get_updated_files_change_info)
+      @source_control.get_updated_files_change_info(revision, revisions)
+    end
+
+  end
+
+end

data/lib/churn/churn_history.rb

@@ -0,0 +1,33 @@
+module Churn
+
+  # responcible for storing the churn history to json,
+  # and for loading old churn history data from json.
+  class ChurnHistory
+    
+    #takes current revision and it's hash_data and stores it
+    def self.store_revision_history(revision, hash_data)
+      FileUtils.mkdir 'tmp' unless File.directory?('tmp')
+      File.open("tmp/#{revision}.json", 'w') {|file| file.write(hash_data.to_json) }
+    end
+
+    #given a previous project revision find and load the churn data from a json file
+    def self.load_revision_data(revision)
+      #load revision data from scratch folder if it exists
+      filename = "tmp/#{revision}.json"
+      if File.exists?(filename)
+        begin
+          json_data = File.read(filename)
+          data      = JSON.parse(json_data)
+          changed_files   = data['churn']['changed_files']
+          changed_classes = data['churn']['changed_classes']
+          changed_methods = data['churn']['changed_methods']
+        rescue JSON::ParserError
+          #leave all of the objects nil
+        end
+      end
+      [changed_files, changed_classes, changed_methods]
+    end
+
+  end
+
+end

data/lib/churn/git_analyzer.rb

@@ -0,0 +1,27 @@
+module Churn
+
+  #analizes git SCM to find recently changed files, and what lines have been altered
+  class GitAnalyzer < SourceControl
+    def get_logs
+      `git log #{date_range} --name-only --pretty=format:`.split(/\n/).reject{|line| line == ""}
+    end
+    
+    def get_revisions
+      `git log #{date_range} --pretty=format:"%H"`.split(/\n/).reject{|line| line == ""}
+    end
+    
+    private
+
+    def get_diff(revision, previous_revision)
+      `git diff #{revision} #{previous_revision} --unified=0`.split(/\n/).select{|line| line.match(/^@@/) || line.match(/^---/) || line.match(/^\+\+\+/) }
+    end
+
+    def date_range
+      if @start_date
+        date = Chronic.parse(@start_date)
+        "--after=#{date.strftime('%Y-%m-%d')}"
+      end
+    end
+    
+  end
+end

data/lib/churn/hg_analyzer.rb

@@ -0,0 +1,31 @@
+module Churn
+
+  #analizes Hg / Mercurial SCM to find recently changed files, and what lines have been altered
+  class HgAnalyzer < SourceControl
+    def get_logs
+      `hg log -v#{date_range}`.split("\n").reject{|line| line !~ /^files:/}.map{|line| line.split(" ")[1..-1]}.flatten
+    end
+
+    def get_revisions
+      `hg log#{date_range}`.split("\n").reject{|line| line !~ /^changeset:/}.map{|line| line[/:(\S+)$/, 1] }
+    end
+
+    private
+
+    def get_diff(revision, previous_revision)
+      `hg diff -r #{revision}:#{previous_revision} -U 0`.split(/\n/).select{|line| line.match(/^@@/) || line.match(/^---/) || line.match(/^\+\+\+/) }
+    end
+
+    def date_range
+      if @start_date
+        date = Chronic.parse(@start_date)
+        " -d \"> #{date.strftime('%Y-%m-%d')}\""
+      end
+    end
+
+    def get_recent_file(line)
+      super(line).split("\t")[0]
+    end
+
+  end
+end

data/lib/churn/location_mapping.rb

@@ -0,0 +1,52 @@
+module Churn
+  
+  # Given a ruby file, map the klass and methods to a range of line numbers
+  # The klass and method to line numbers mappings, are stored in
+  # @klasses_collection and @methods_collection
+  class LocationMapping < SexpProcessor
+    
+    attr_reader :klasses_collection, :methods_collection
+    
+    def initialize()
+      super
+      @klasses_collection  = {}
+      @methods_collection  = {}
+      @parser              = RubyParser.new
+      self.auto_shift_type = true
+    end
+    
+    def get_info(file)
+      ast = @parser.process(File.read(file), file)
+      process ast
+    end
+    
+    def process_class(exp)
+      name           = exp.shift
+      start_line     = exp.line
+      last_line      = exp.last.line
+      name           = name if name.is_a?(Symbol)
+      name           = name.values.value if name.is_a?(Sexp) #deals with cases like class Test::Unit::TestCase
+      @current_class = name
+      @klasses_collection[name.to_s] = [] unless @klasses_collection.include?(name)
+      @klasses_collection[name.to_s] << (start_line..last_line)
+      analyze_list exp
+      s()
+    end
+    
+    def analyze_list exp
+      process exp.shift until exp.empty?
+    end
+    
+    def process_defn(exp)
+      name        = exp.shift
+      start_line  = exp.line
+      last_line   = exp.last.line
+      full_name   = "#{@current_class}##{name}"
+      @methods_collection[full_name] = [] unless @methods_collection.include?(full_name)
+      @methods_collection[full_name] << (start_line..last_line)
+      return s(:defn, name, process(exp.shift), process(exp.shift))
+    end
+
+  end
+
+end

data/lib/churn/source_control.rb

@@ -0,0 +1,66 @@
+module Churn
+
+  # Base clase for analyzing various SCM systems like git, HG, and SVN
+  class SourceControl
+    def initialize(start_date=nil)
+      @start_date = start_date
+    end
+
+    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.match(/^---/) || line.match(/^\+\+\+/)
+          # Remove the --- a/ and +++ b/ if present
+          recent_file = get_recent_file(line)
+          updated[recent_file] = [] unless updated.include?(recent_file)
+        elsif line.match(/^@@/)
+          # 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
+          puts line.match(/^---/)
+          raise "diff lines that don't match the two patterns aren't expected: '#{line}'"
+        end
+      end
+      updated
+    end
+
+    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
+
+    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
+
+    def get_recent_file(line)
+      line = line.gsub(/^--- /,'').gsub(/^\+\+\+ /,'').gsub(/^a\//,'').gsub(/^b\//,'')
+    end
+
+  end
+
+end

data/lib/churn/svn_analyzer.rb

@@ -0,0 +1,23 @@
+module Churn
+
+  #analizes SVN SCM to find recently changed files, and what lines have been altered
+  class SvnAnalyzer < SourceControl
+    def get_logs
+      `svn log #{date_range} --verbose`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
+    end
+
+    private
+    def date_range
+      if @start_date
+        date = Chronic.parse(@start_date)
+        "--revision {#{date.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
+      end
+    end
+
+    def clean_up_svn_line(line)
+      match = line.match(/\W*[A,M]\W+(\/.*)\b/)
+      match ? match[1] : nil
+    end
+  end
+
+end

data/lib/churn.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'tasks', 'churn_tasks')

data/lib/tasks/churn_tasks.rb

@@ -0,0 +1,11 @@
+def report_churn()
+  require File.join(File.dirname(__FILE__), '..', 'churn', 'churn_calculator')
+  Churn::ChurnCalculator.new({:minimum_churn_count => 3}).report
+end
+
+desc "Report the current churn for the project"
+task :churn do
+  report = report_churn()
+  puts report
+end
+

data/man/churn.1

@@ -0,0 +1,150 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "README" "" "January 2010" "" ""
+= churn
+.
+.P
+A Project to give the churn file, class, and method for a project for a given checkin
+Over time the tool adds up the history of chruns to give the number of times a file, class, or method is changing during the life of a project.
+Churn for files is immediate, but classes and methods requires buildings up a history using churn between revisions. The history is stored in ./tmp
+.
+.P
+Currently has Full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SVN support (supports only file level churn currnetly)
+.
+.P
+Authors:
+* danmayer
+* ajwalters
+* cldwalker
+* absurdhero
+.
+.P
+== Example Output
+.
+.IP "\(bu" 4
+Revision Changes
+.
+.IP "" 0
+.
+.P
+  Files:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file                          |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | Rakefile                      |
+  | lib/churn/churn_calculator.rb |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.P
+  Classes:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file                          | klass           |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | lib/churn/churn_calculator.rb | ChurnCalculator |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.P
+  Methods:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file                          | klass           | method                        |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#filters       |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#display_array |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s          |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.IP "\(bu" 4
+Project Churn
+.
+.IP "" 0
+.
+.P
+  Files:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file_path                          | times_changed |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | lib/churn/churn_calculator.rb      | 14            |
+  | README.rdoc                        | 7             |
+  | lib/tasks/churn_tasks.rb           | 6             |
+  | Rakefile                           | 6             |
+  | lib/churn/git_analyzer.rb          | 4             |
+  | VERSION                            | 4             |
+  | test/test_helper.rb                | 4             |
+  | test/unit/churn_calculator_test.rb | 3             |
+  | test/churn_test.rb                 | 3             |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.P
+  Classes:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file                          | klass           | times_changed |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.P
+  Methods:
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | file                          | klass           | method                                  | times_changed |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s                    | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#display_array           | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#calculate_revision_data | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#filters                 | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#initialize              | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#filters                 | 1             |
+  | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s                    | 1             |
+  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+.
+.P
+TODO:
+* SVN only supports file, add full SVN support
+* support bazaar, cvs, and darcs
+* make storage directory configurable instead of using tmp
+* allow passing in directories to churn, directories to ignore
+* add a filter that allows for other files besides. *.rb
+* ignore files pattern, so you can ignore things like vendor/, lib/, or docs/
+* finish adding better documenation using YARD
+.
+.P
+Executable Usage:
+* 'gem install churn'
+* go to project root run 'churn'
+.
+.P
+Rake Usage:
+* 'gem install churn'
+* on any project you want to use churn, add "require 'churn'" to your rake file
+* run 'rake churn' to view the current output, file churn history is immediate, class and method churn builds up a history as it is run on each revision
+* temporary files with class / method churn history are stored in /tmp, to clear churn history delete them
+.
+.P
+== Note on Patches/Pull Requests
+.
+.IP "\(bu" 4
+Fork the project.
+.
+.IP "\(bu" 4
+Make your feature addition or bug fix.
+.
+.IP "\(bu" 4
+Add tests for it. This is important so I don't break it in a
+future version unintentionally.
+.
+.IP "\(bu" 4
+Commit, do not mess with rakefile, version, or history.
+(if you want to have your own version, that is fine but
+ bump version in a commit by itself I can ignore when I pull)
+.
+.IP "\(bu" 4
+Send me a pull request. Bonus points for topic branches.
+.
+.IP "" 0
+.
+.P
+== Copyright
+.
+.P
+Copyright (c) 2010 Dan Mayer. See LICENSE for details.