churn 0.0.12 → 0.0.13

data/README.rdoc

@@ -87,6 +87,8 @@ TODO:
 * 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
+* better man page formatting from README (switch to markdown?)
+* rake task for building manpage (currently manually run  ronn -b1 README.rdoc)
 
 Executable Usage:
 * 'gem install churn'

data/Rakefile

@@ -11,12 +11,12 @@ begin
     gem.email = "dan@devver.net"
     gem.homepage = "http://github.com/danmayer/churn"
     gem.authors = ["Dan Mayer"]
-    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "shoulda"
     gem.add_development_dependency "test-construct"
     gem.add_development_dependency "mocha", '~> 0.9.5'
     gem.add_dependency "main"
     gem.add_dependency "json_pure"
-    gem.add_dependency "chronic", '~> 0.2.3'
+    gem.add_dependency "chronic", '>= 0.2.3'
     gem.add_dependency "sexp_processor", '~> 3.0.3'
     gem.add_dependency "ruby_parser", '~> 2.0.4'
     gem.add_dependency 'hirb'
@@ -27,6 +27,38 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
+begin
+  #for additional metrics, mostly Rcov which caliper doesn't do
+  require 'metric_fu'
+  
+  MetricFu::Configuration.run do |config|
+    config.metrics  = [:churn, :saikuro, :roodi, :flog, :flay, :reek, :roodi, :rcov, :hotspots]
+    config.graphs   = [:roodi, :flog, :flay, :reek, :roodi, :rcov]
+    
+    config.flay     = { :dirs_to_flay => ['lib']  } 
+    config.flog     = { :dirs_to_flog => ['lib']  }
+    config.reek     = { :dirs_to_reek => ['lib']  }
+    config.roodi    = { :dirs_to_roodi => ['lib'] }
+    config.saikuro  = { :output_directory => 'tmp/tmp_saikuro', 
+      :input_directory => ['lib'],
+      :cyclo => "",
+      :filter_cyclo => "0",
+      :warn_cyclo => "5",
+      :error_cyclo => "7",
+      :formater => "text"} #this needs to be set to "text"
+    config.churn    = { :start_date => "3 months ago", :minimum_churn_count => 10}
+    config.rcov     = { :test_files => ['test/unit/**/*_test.rb'],
+      :rcov_opts => ["--sort coverage", 
+                     "--no-html", 
+                     "--text-coverage",
+                     "--no-color",
+                     "--profile",
+                     "--exclude /gems/,spec"]}
+  end
+rescue Exception
+  puts "metric_fu not working install it"
+end
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/lib/churn/churn_calculator.rb

@@ -15,6 +15,9 @@ 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
@@ -63,46 +66,52 @@ module Churn
       hash[:churn][:class_churn]  = @class_changes
       hash[:churn][:method_churn] = @method_changes
       #detail the most recent changes made this revision
-      if @revision_changes[@revisions.first]
-        changes = @revision_changes[@revisions.first]
+      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(@revisions.first, hash)
+      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
+      hash   = to_h[:churn]
       result = seperator 
       result +="* Revision Changes \n"
       result += seperator
       result += "Files: \n"
-      result += display_array(hash[:churn][:changed_files], :fields=>[:to_str], :headers=>{:to_str=>'file'})
+      result += display_array(hash[:changed_files], :fields=>[:to_str], :headers=>{:to_str=>'file'})
       result += "\nClasses: \n"
-      result += display_array(hash[:churn][:changed_classes])
+      result += display_array(hash[:changed_classes])
       result += "\nMethods: \n"
-      result += display_array(hash[:churn][:changed_methods]) + "\n"
+      result += display_array(hash[:changed_methods]) + "\n"
       result += seperator 
       result +="* Project Churn \n"
       result += seperator
       result += "Files: \n"
-      result += display_array(hash[:churn][:changes])
+      result += display_array(hash[:changes])
       result += "\nClasses: \n"
-      class_churn = hash[:churn][:class_churn].map {|e| (e.delete('klass') || {}).merge(e) }
+      class_churn = collect_items(hash[:class_churn], 'klass')
       result += display_array(class_churn)
       result += "\nMethods: \n"
-      method_churn = hash[:churn][:method_churn].map {|e| (e.delete('method') || {}).merge(e) }
+      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! {|x,y| y[1] <=> x[1]}
+      changes.to_a.sort! {|first,second| second[1] <=> first[1]}
     end
 
     def filters
@@ -226,7 +235,7 @@ module Churn
     end
     
     def parse_logs_for_updated_files(revision, revisions)
-      #SVN doesn't support this
+      #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

data/lib/churn/churn_history.rb

@@ -1,12 +1,16 @@
 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') {|f| f.write(hash_data.to_json) }
+      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"

data/lib/churn/git_analyzer.rb

@@ -1,5 +1,6 @@
 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 == ""}
@@ -9,56 +10,10 @@ module Churn
       `git log #{date_range} --pretty=format:"%H"`.split(/\n/).reject{|line| line == ""}
     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
-        `git diff #{revision} #{previous_revision} --unified=0`.split(/\n/).select{|line| line.match(/^@@/) || line.match(/^---/) || line.match(/^\+\+\+/) }
-      else
-        []
-      end
-    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(/^\+\+\+/)
-          recent_file = get_recent_file(line)
-          updated[recent_file] = [] unless updated.include?(recent_file)
-        elsif line.match(/^@@/)
-          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 "git diff lines that don't match the two patterns aren't expected: '#{line}'"
-        end
-      end
-      updated
-    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(/.*,/,'')
-
-      range  = if change_end && change_end!=''
-                 (change_start.to_i..(change_start.to_i+change_end.to_i))
-               else
-                 (change_start.to_i..change_start.to_i)
-               end
-      range
-    end
-
-    def get_recent_file(line)
-      line = line.gsub(/^--- /,'').gsub(/^\+\+\+ /,'').gsub(/^a\//,'').gsub(/^b\//,'')
+    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
@@ -69,5 +24,4 @@ module Churn
     end
     
   end
-
 end

data/lib/churn/hg_analyzer.rb

@@ -1,48 +1,21 @@
 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{|l| l.split(" ")[1..-1]}.flatten
+      `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{|l| l[/:(\S+)$/, 1] }
+      `hg log#{date_range}`.split("\n").reject{|line| line !~ /^changeset:/}.map{|line| line[/:(\S+)$/, 1] }
     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
-        `hg diff -r #{revision}:#{previous_revision} -U 0`.split(/\n/).select{|line| line.match(/^@@/) || line.match(/^---/) || line.match(/^\+\+\+/) }
-      else
-        []
-      end
-    end
+    private
 
-    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 "hg diff lines that don't match the two patterns aren't expected: '#{line}'"
-        end
-      end
-      updated
+    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
 
-  private
     def date_range
       if @start_date
         date = Chronic.parse(@start_date)
@@ -51,21 +24,8 @@ module Churn
     end
 
     def get_recent_file(line)
-      line = line.gsub(/^--- /,'').gsub(/^\+\+\+ /,'').gsub(/^a\//,'').gsub(/^b\//,'').split("\t")[0]
+      super(line).split("\t")[0]
     end
 
-    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(/.*,/,'')
-
-      range  = if change_end && change_end!=''
-                 (change_start.to_i..(change_start.to_i+change_end.to_i))
-               else
-                 (change_start.to_i..change_start.to_i)
-               end
-      range
-    end
   end
 end

data/lib/churn/location_mapping.rb

@@ -1,5 +1,8 @@
 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

data/lib/churn/source_control.rb

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

@@ -1,5 +1,6 @@
 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
@@ -14,8 +15,8 @@ module Churn
     end
 
     def clean_up_svn_line(line)
-      m = line.match(/\W*[A,M]\W+(\/.*)\b/)
-      m ? m[1] : nil
+      match = line.match(/\W*[A,M]\W+(\/.*)\b/)
+      match ? match[1] : nil
     end
   end
 

data/man/churn.1

@@ -0,0 +1,149 @@
+.\" 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 and Mercurial (hg) support, and partial SVN support (supports only file level churn currnetly)
+.
+.P
+Authors:
+* danmayer
+* ajwalters
+* cldwalker
+.
+.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.

data/man/churn.html

@@ -0,0 +1,541 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.4.4" />
+<title>churn</title>
+<style type="text/css">
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+  border: 1px solid red;
+*/
+}
+
+body {
+  margin: 1em 5% 1em 5%;
+}
+
+a {
+  color: blue;
+  text-decoration: underline;
+}
+a:visited {
+  color: fuchsia;
+}
+
+em {
+  font-style: italic;
+  color: navy;
+}
+
+strong {
+  font-weight: bold;
+  color: #083194;
+}
+
+tt {
+  color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  color: #527bbd;
+  font-family: sans-serif;
+  margin-top: 1.2em;
+  margin-bottom: 0.5em;
+  line-height: 1.3;
+}
+
+h1, h2, h3 {
+  border-bottom: 2px solid silver;
+}
+h2 {
+  padding-top: 0.5em;
+}
+h3 {
+  float: left;
+}
+h3 + * {
+  clear: left;
+}
+
+div.sectionbody {
+  font-family: serif;
+  margin-left: 0;
+}
+
+hr {
+  border: 1px solid silver;
+}
+
+p {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+  margin-top: 0;
+}
+
+pre {
+  padding: 0;
+  margin: 0;
+}
+
+span#author {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  font-size: 1.1em;
+}
+span#email {
+}
+span#revision {
+  font-family: sans-serif;
+}
+
+div#footer {
+  font-family: sans-serif;
+  font-size: small;
+  border-top: 2px solid silver;
+  padding-top: 0.5em;
+  margin-top: 4.0em;
+}
+div#footer-text {
+  float: left;
+  padding-bottom: 0.5em;
+}
+div#footer-badges {
+  float: right;
+  padding-bottom: 0.5em;
+}
+
+div#preamble {
+  margin-top: 1.5em;
+  margin-bottom: 1.5em;
+}
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+  margin-top: 1.5em;
+  margin-bottom: 1.5em;
+}
+div.admonitionblock {
+  margin-top: 2.5em;
+  margin-bottom: 2.5em;
+}
+
+div.content { /* Block element content. */
+  padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  text-align: left;
+  margin-top: 1.0em;
+  margin-bottom: 0.5em;
+}
+div.title + * {
+  margin-top: 0;
+}
+
+td div.title:first-child {
+  margin-top: 0.0em;
+}
+div.content div.title:first-child {
+  margin-top: 0.0em;
+}
+div.content + div.title {
+  margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+  background: #ffffee;
+  border: 1px solid silver;
+  padding: 0.5em;
+}
+
+div.listingblock > div.content {
+  border: 1px solid silver;
+  background: #f4f4f4;
+  padding: 0.5em;
+}
+
+div.quoteblock {
+  padding-left: 2.0em;
+  margin-right: 10%;
+}
+div.quoteblock > div.attribution {
+  padding-top: 0.5em;
+  text-align: right;
+}
+
+div.verseblock {
+  padding-left: 2.0em;
+  margin-right: 10%;
+}
+div.verseblock > div.content {
+  white-space: pre;
+}
+div.verseblock > div.attribution {
+  padding-top: 0.75em;
+  text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+  text-align: left;
+}
+
+div.admonitionblock .icon {
+  vertical-align: top;
+  font-size: 1.1em;
+  font-weight: bold;
+  text-decoration: underline;
+  color: #527bbd;
+  padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+  padding-left: 0.5em;
+  border-left: 2px solid silver;
+}
+
+div.exampleblock > div.content {
+  border-left: 2px solid silver;
+  padding: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+
+dl {
+  margin-top: 0.8em;
+  margin-bottom: 0.8em;
+}
+dt {
+  margin-top: 0.5em;
+  margin-bottom: 0;
+  font-style: normal;
+  color: navy;
+}
+dd > *:first-child {
+  margin-top: 0.1em;
+}
+
+ul, ol {
+    list-style-position: outside;
+}
+ol.arabic {
+  list-style-type: decimal;
+}
+ol.loweralpha {
+  list-style-type: lower-alpha;
+}
+ol.upperalpha {
+  list-style-type: upper-alpha;
+}
+ol.lowerroman {
+  list-style-type: lower-roman;
+}
+ol.upperroman {
+  list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+  margin-top: 0.1em;
+  margin-bottom: 0.1em;
+}
+
+div.tableblock > table {
+  border: 3px solid #527bbd;
+}
+thead {
+  font-family: sans-serif;
+  font-weight: bold;
+}
+tfoot {
+  font-weight: bold;
+}
+td > div.verse {
+  white-space: pre;
+}
+p.table {
+  margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+  border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+  border-left-style: none;
+  border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+  border-top-style: none;
+  border-bottom-style: none;
+}
+
+
+div.hdlist {
+  margin-top: 0.8em;
+  margin-bottom: 0.8em;
+}
+div.hdlist tr {
+  padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+  font-weight: bold;
+}
+td.hdlist1 {
+  vertical-align: top;
+  font-style: normal;
+  padding-right: 0.8em;
+  color: navy;
+}
+td.hdlist2 {
+  vertical-align: top;
+}
+div.hdlist.compact tr {
+  margin: 0;
+  padding-bottom: 0;
+}
+
+.comment {
+  background: yellow;
+}
+
+@media print {
+  div#footer-badges { display: none; }
+}
+
+div#toctitle {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-size: 1.1em;
+  font-weight: bold;
+  margin-top: 1.0em;
+  margin-bottom: 0.1em;
+}
+
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+div.toclevel2 {
+  margin-left: 2em;
+  font-size: 0.9em;
+}
+div.toclevel3 {
+  margin-left: 4em;
+  font-size: 0.9em;
+}
+div.toclevel4 {
+  margin-left: 6em;
+  font-size: 0.9em;
+}
+/* Workarounds for IE6's broken and incomplete CSS2. */
+
+div.sidebar-content {
+  background: #ffffee;
+  border: 1px solid silver;
+  padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  margin-top: 0.0em;
+  margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+  border: 1px solid silver;
+  background: #f4f4f4;
+  padding: 0.5em;
+}
+
+div.quoteblock-attribution {
+  padding-top: 0.5em;
+  text-align: right;
+}
+
+div.verseblock-content {
+  white-space: pre;
+}
+div.verseblock-attribution {
+  padding-top: 0.75em;
+  text-align: left;
+}
+
+div.exampleblock-content {
+  border-left: 2px solid silver;
+  padding-left: 0.5em;
+}
+
+/* IE6 sets dynamically generated links as visited. */
+div#toc a:visited { color: blue; }
+</style>
+</head>
+<body>
+<div id="header">
+<h1>churn</h1>
+</div>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph"><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></div>
+<div class="paragraph"><p>Currently has Full Git and Mercurial (hg) support, and partial SVN support (supports only file level churn currnetly)</p></div>
+<div class="paragraph"><p>Authors:
+* danmayer
+* ajwalters
+* cldwalker</p></div>
+</div>
+</div>
+<h2 id="_example_output">Example Output</h2>
+<div class="sectionbody">
+<div class="literalblock">
+<div class="content">
+<pre><tt>**********************************************************************
+* Revision Changes
+**********************************************************************
+Files:
++-------------------------------+
+| file                          |
++-------------------------------+
+| Rakefile                      |
+| lib/churn/churn_calculator.rb |
++-------------------------------+</tt></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>Classes:
++-------------------------------+-----------------+
+| file                          | klass           |
++-------------------------------+-----------------+
+| lib/churn/churn_calculator.rb | ChurnCalculator |
++-------------------------------+-----------------+</tt></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>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          |
++-------------------------------+-----------------+-------------------------------+</tt></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>**********************************************************************
+* Project Churn
+**********************************************************************
+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             |
++------------------------------------+---------------+</tt></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>Classes:
++-------------------------------+-----------------+---------------+
+| file                          | klass           | times_changed |
++-------------------------------+-----------------+---------------+
+| lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
+| lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
++-------------------------------+-----------------+---------------+</tt></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>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             |
++-------------------------------+-----------------+-----------------------------------------+---------------+</tt></pre>
+</div></div>
+<div class="paragraph"><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></div>
+<div class="paragraph"><p>Executable Usage:
+* <em>gem install churn</em>
+* go to project root run <em>churn</em></p></div>
+<div class="paragraph"><p>Rake Usage:
+* <em>gem install churn</em>
+* on any project you want to use churn, add "require <em>churn</em>" to your rake file
+* run <em>rake churn</em> 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></div>
+</div>
+<h2 id="_note_on_patches_pull_requests">Note on Patches/Pull Requests</h2>
+<div class="sectionbody">
+<div class="ulist"><ul>
+<li>
+<p>
+Fork the project.
+</p>
+</li>
+<li>
+<p>
+Make your feature addition or bug fix.
+</p>
+</li>
+<li>
+<p>
+Add tests for it. This is important so I don&#8217;t break it in a
+  future version unintentionally.
+</p>
+</li>
+<li>
+<p>
+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)
+</p>
+</li>
+<li>
+<p>
+Send me a pull request. Bonus points for topic branches.
+</p>
+</li>
+</ul></div>
+</div>
+<h2 id="_copyright">Copyright</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Copyright (c) 2010 Dan Mayer. See LICENSE for details.</p></div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2010-01-20 10:38:32 EDT
+</div>
+</div>
+</body>
+</html>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 12
-  version: 0.0.12
+  - 13
+  version: 0.0.13
 platform: ruby
 authors: 
 - Dan Mayer
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-23 00:00:00 -05:00
+date: 2010-11-30 00:00:00 -05:00
 default_executable: churn
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -84,7 +84,7 @@ dependencies:
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
@@ -159,6 +159,8 @@ files:
 - lib/churn/source_control.rb
 - lib/churn/svn_analyzer.rb
 - lib/tasks/churn_tasks.rb
+- man/churn.1
+- man/churn.html
 - test/data/churn_calculator.rb
 - test/data/test_helper.rb
 - test/test_helper.rb