churn 0.0.20 → 0.0.21

data/Gemfile.lock

@@ -1,8 +1,53 @@
+PATH
+  remote: .
+  specs:
+    churn (0.0.20)
+      chronic (>= 0.2.3)
+      churn
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.3)
+      sexp_processor (~> 3.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    arrayfields (4.7.4)
+    chronic (0.7.0)
+    fattr (2.2.1)
+    git (1.2.5)
+    hirb (0.7.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    json_pure (1.7.5)
+    main (5.1.0)
+      arrayfields (>= 4.7.4)
+      chronic (>= 0.6.2)
+      fattr (>= 2.2.0)
+      map (>= 5.1.0)
+    map (6.2.0)
+    mocha (0.9.12)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    shoulda (2.11.3)
+    test-construct (1.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  churn!
+  jeweler
+  mocha (~> 0.9.5)
+  rake
+  shoulda
+  test-construct

data/README.md

@@ -0,0 +1,147 @@
+__churn__
+
+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
+
+Currently has full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SVN support (supports only file level churn currently)
+
+Authors:
+
+* danmayer
+* ajwalters 
+* cldwalker
+* absurdhero
+
+__Churn Usage__  
+Install with `gem install churn` or for bundler add to your Gemfile `gem 'churn'`
+
+* rake:
+  * add `require 'churn'` to Rakefile
+  * then run`rake churn` or `bundle exec rake churn`
+  * use environment variables to control churn defaults  
+  
+        ENV['CHURN_MINIMUM_CHURN_COUNT']  
+        ENV['CHURN_START_DATE']  
+        ENV['CHURN_IGNORE_FILES']
+  
+* CLI:  
+  * on command line run `churn` or `bundle exec churn`
+  * need help run `churn -h` to get additional information
+  * run the executable passing in options to override defaults
+  
+        churn -i "churn.gemspec, Gemfile" #ignore files
+        churn -y #output yaml format opposed to text
+        churn -c 10 #set minimum churn count on a file to 10
+        churn -c 5 -y -i "Gemfile" #mix and match
+        
+             
+__Example Output__  
+
+    **********************************************************************
+    * Revision Changes 
+    **********************************************************************
+    Files: 
+    +-------------------------------+
+    | file                          |
+    +-------------------------------+
+    | Rakefile                      |
+    | lib/churn/churn_calculator.rb |
+    +-------------------------------+
+     
+    Classes: 
+    +-------------------------------+-----------------+
+    | file                          | klass           |
+    +-------------------------------+-----------------+
+    | lib/churn/churn_calculator.rb | ChurnCalculator |
+    +-------------------------------+-----------------+
+     
+    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          |
+    +-------------------------------+-----------------+-------------------------------+
+   
+    **********************************************************************
+    * 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             |
+    +------------------------------------+---------------+ 
+   
+    Classes: 
+    +-------------------------------+-----------------+---------------+
+    | file                          | klass           | times_changed |
+    +-------------------------------+-----------------+---------------+
+    | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
+    | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
+    +-------------------------------+-----------------+---------------+
+     
+    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             |
+    +-------------------------------+-----------------+-----------------------------------------+---------------+
+
+__Options__
+
+    [~/projects/churn] churn -h
+    NAME
+      churn
+    
+    SYNOPSIS
+      churn [options]+
+    
+    PARAMETERS
+      --minimum_churn_count=minimum_churn_count, -c (0 ~> 
+      int(minimum_churn_count=3)) 
+      --yaml, -y 
+      --ignore_files=[ignore_files], -i (0 ~> string(ignore_files=)) 
+      --help, -h 
+
+__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
+* rake task for building manpage (currently manually run  ronn -b1 README.rdoc)
+* don't output methods and classes on a commit that has none detected (css and view only commits, etc)
+
+__Notes on Patches/Pull Requests__
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* 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)
+* Send me a pull request. Bonus points for topic branches.
+
+__Copyright__
+
+Copyright (c) 2012 Dan Mayer. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.20
+0.0.21

data/bin/churn

@@ -15,9 +15,15 @@ Main do
     default false
   end
 
+  option('ignore_files', 'i') do
+    cast :string
+    argument :optional
+    default ''
+  end
+
   def report_churn(output_string)
     require File.join(File.dirname(__FILE__), '..', 'lib', 'churn', 'churn_calculator')
-    result = Churn::ChurnCalculator.new({:minimum_churn_count => params['minimum_churn_count'].value}).report(output_string)
+    result = Churn::ChurnCalculator.new({:minimum_churn_count => params['minimum_churn_count'].value, :ignore_files => params['ignore_files'].value}).report(output_string)
     unless output_string
       result = YAML::dump(result)
     end
@@ -29,4 +35,4 @@ Main do
     puts report
   end
 
-end
+end

data/churn.gemspec

@@ -5,24 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = "churn"
-  s.version = "0.0.20"
+  s.version = "0.0.21"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Mayer"]
-  s.date = "2012-09-11"
+  s.date = "2012-09-14"
   s.description = "High method and class churn has been shown to have increased bug and error rates. This gem helps you know what is changing a lot so you can do additional testing, code review, or refactoring to try to tame the volatile code. "
   s.email = "dan@mayerdan.com"
   s.executables = ["churn"]
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/churn",
@@ -58,12 +58,6 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<churn>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<test-construct>, [">= 0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, ["~> 0.9.5"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<test-construct>, [">= 0"])
@@ -76,12 +70,6 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<ruby_parser>, ["~> 2.3"])
       s.add_runtime_dependency(%q<hirb>, [">= 0"])
     else
-      s.add_dependency(%q<churn>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<test-construct>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<mocha>, ["~> 0.9.5"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<test-construct>, [">= 0"])
@@ -95,12 +83,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<hirb>, [">= 0"])
     end
   else
-    s.add_dependency(%q<churn>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<test-construct>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<mocha>, ["~> 0.9.5"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<test-construct>, [">= 0"])

data/lib/churn/churn_calculator.rb

@@ -25,7 +25,9 @@ module Churn
     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)
+      @ignore_files     = (options.fetch(:ignore_files){ "" }).split(',').map(&:strip)
+      @ignore_files << '/dev/null'
+      @source_control   = set_source_control(start_date)
       @changes          = {}
       @revision_changes = {}
       @class_changes    = {}
@@ -37,16 +39,16 @@ module Churn
     # @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.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 
+      @changes   = parse_log_for_changes.reject {|file, change_count| change_count < @minimum_churn_count || @ignore_files.include?(file) }
+      @revisions = parse_log_for_revision_changes
+    end
 
     # Analyze the source control data, filter, sort, and find more information on the editted files
     def analyze
@@ -83,7 +85,7 @@ module Churn
     # Pretty print the data as a string for the user
     def to_s
       hash   = to_h[:churn]
-      result = seperator 
+      result = seperator
       result +="* Revision Changes \n"
       result += seperator
       result += "Files: \n"
@@ -92,7 +94,7 @@ module Churn
       result += display_array(hash[:changed_classes])
       result += "\nMethods: \n"
       result += display_array(hash[:changed_methods]) + "\n"
-      result += seperator 
+      result += seperator
       result +="* Project Churn \n"
       result += seperator
       result += "Files: \n"
@@ -106,7 +108,7 @@ module Churn
     end
 
     private
-    
+
     def collect_items(collection, match)
       collection.map {|item| (item.delete(match) || {}).merge(item) }
     end
@@ -165,14 +167,14 @@ module Churn
         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|
@@ -225,10 +227,10 @@ module Churn
       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
@@ -240,11 +242,12 @@ module Churn
       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)
+      files = @source_control.get_updated_files_change_info(revision, revisions)
+      files.select{ |file, value| !@ignore_files.include?(file) }
     end
 
   end

data/lib/tasks/churn_tasks.rb

@@ -1,6 +1,10 @@
 def report_churn()
   require File.join(File.dirname(__FILE__), '..', 'churn', 'churn_calculator')
-  Churn::ChurnCalculator.new({:minimum_churn_count => 3}).report
+  Churn::ChurnCalculator.new({
+                               :minimum_churn_count => ENV['CHURN_MINIMUM_CHURN_COUNT'],
+                               :start_date => ENV['CHURN_START_DATE'],
+                               :ignore_files => ENV['CHURN_IGNORE_FILES'],
+                             }).report
 end
 
 desc "Report the current churn for the project"

data/test/unit/churn_calculator_test.rb

@@ -1,12 +1,12 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class ChurnCalculatorTest < Test::Unit::TestCase
- 
+
   should "use minimum churn count" do
     within_construct do |container|
       Churn::ChurnCalculator.stubs(:git?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})
- 
+
       churn.stubs(:parse_log_for_changes).returns([['file.rb', 4],['less.rb',1]])
       churn.stubs(:parse_log_for_revision_changes).returns(['revision'])
       churn.stubs(:analyze)
@@ -16,11 +16,25 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     end
   end
 
+  should "use ignore_files filter" do
+    within_construct do |container|
+      Churn::ChurnCalculator.stubs(:git?).returns(true)
+      churn = Churn::ChurnCalculator.new({:ignore_files => "file.rb"})
+
+      churn.stubs(:parse_log_for_changes).returns([['file.rb', 10],['new.rb',11]])
+      churn.stubs(:parse_log_for_revision_changes).returns(['revision'])
+      churn.stubs(:analyze)
+      report = churn.report(false)
+      assert_equal 1, report[:churn][:changes].length
+      assert_equal ["new.rb", 11], report[:churn][:changes].first
+    end
+  end
+
   should "analize sorts changes" do
     within_construct do |container|
       Churn::ChurnCalculator.stubs(:git?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})
- 
+
       churn.stubs(:parse_log_for_changes).returns([['file.rb', 4],['most.rb', 9],['less.rb',1]])
       churn.stubs(:parse_log_for_revision_changes).returns(['revision'])
       report = churn.report(false)
@@ -36,7 +50,7 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     within_construct do |container|
       Churn::ChurnCalculator.stubs(:git?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})
-      
+
       churn.stubs(:parse_log_for_changes).returns([['less.rb',1]])
       churn.stubs(:parse_log_for_revision_changes).returns(['first'])
       churn.stubs(:parse_logs_for_updated_files).returns({'fake_file.rb'=>[]})
@@ -49,7 +63,7 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     within_construct do |container|
       Churn::ChurnCalculator.stubs(:git?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})
-      
+
       churn.stubs(:parse_log_for_changes).returns([['less.rb',1]])
       churn.stubs(:parse_log_for_revision_changes).returns(['first'])
       churn.stubs(:parse_logs_for_updated_files).returns({'fake_file.rb'=>[]})
@@ -66,7 +80,7 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     within_construct do |container|
       Churn::ChurnCalculator.stubs(:git?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})
-      
+
       churn.stubs(:parse_log_for_changes).returns([['less.rb',1]])
       churn.stubs(:parse_log_for_revision_changes).returns(['first'])
       churn.stubs(:parse_logs_for_updated_files).returns({'fake_file.rb'=>[]})
@@ -86,5 +100,5 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     assert churn.instance_variable_get(:@source_control).is_a?(Churn::HgAnalyzer)
   end
 
-  
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: churn
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 0
-  - 20
-  version: 0.0.20
+  - 21
+  version: 0.0.21
 platform: ruby
 authors: 
 - Dan Mayer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-11 00:00:00 Z
+date: 2012-09-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -187,82 +187,10 @@ dependencies:
         version: "0"
   requirement: *id012
   prerelease: false
-  name: shoulda
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id013 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id013
-  prerelease: false
-  name: jeweler
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id014 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id014
-  prerelease: false
-  name: test-construct
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id015 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id015
-  prerelease: false
-  name: rake
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id016 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 9
-        - 5
-        version: 0.9.5
-  requirement: *id016
-  prerelease: false
-  name: mocha
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id017 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id017
-  prerelease: false
   name: main
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id018 !ruby/object:Gem::Requirement 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -271,12 +199,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id018
+  requirement: *id013
   prerelease: false
   name: json_pure
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id019 !ruby/object:Gem::Requirement 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -287,12 +215,12 @@ dependencies:
         - 2
         - 3
         version: 0.2.3
-  requirement: *id019
+  requirement: *id014
   prerelease: false
   name: chronic
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id020 !ruby/object:Gem::Requirement 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -302,12 +230,12 @@ dependencies:
         - 3
         - 0
         version: "3.0"
-  requirement: *id020
+  requirement: *id015
   prerelease: false
   name: sexp_processor
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id021 !ruby/object:Gem::Requirement 
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -317,12 +245,12 @@ dependencies:
         - 2
         - 3
         version: "2.3"
-  requirement: *id021
+  requirement: *id016
   prerelease: false
   name: ruby_parser
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id022 !ruby/object:Gem::Requirement 
+  version_requirements: &id017 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -331,7 +259,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id022
+  requirement: *id017
   prerelease: false
   name: hirb
   type: :runtime
@@ -343,13 +271,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/churn

data/README.rdoc

@@ -1,123 +0,0 @@
-= churn
-
-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
-
-Currently has full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SVN support (supports only file level churn currently)
-
-Authors:
-* danmayer
-* ajwalters 
-* cldwalker
-* absurdhero
-
-Execute with:
-    rake churn #after adding require 'lib/tasks/churn_tasks' to projects rakefile
-    churn
-    
-== Example Output
-  **********************************************************************
-  * Revision Changes 
-  **********************************************************************
-  Files: 
-  +-------------------------------+
-  | file                          |
-  +-------------------------------+
-  | Rakefile                      |
-  | lib/churn/churn_calculator.rb |
-  +-------------------------------+
-   
-  Classes: 
-  +-------------------------------+-----------------+
-  | file                          | klass           |
-  +-------------------------------+-----------------+
-  | lib/churn/churn_calculator.rb | ChurnCalculator |
-  +-------------------------------+-----------------+
-   
-  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          |
-  +-------------------------------+-----------------+-------------------------------+
- 
-  **********************************************************************
-  * 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             |
-  +------------------------------------+---------------+ 
-   
-  Classes: 
-  +-------------------------------+-----------------+---------------+
-  | file                          | klass           | times_changed |
-  +-------------------------------+-----------------+---------------+
-  | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
-  | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
-  +-------------------------------+-----------------+---------------+
-   
-  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             |
-  +-------------------------------+-----------------+-----------------------------------------+---------------+
-
-
-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
-* better man page formatting from README (switch to markdown?)
-* rake task for building manpage (currently manually run  ronn -b1 README.rdoc)
-* bug that reports '/dev/null' as a file during revision changes
-* don't output methods and classes on a commit that has none detected (css and view only commits, etc)
-
-Executable Usage:
-* 'gem install churn'
-* go to project root run 'churn'
-
-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
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* 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)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Dan Mayer. See LICENSE for details.