churn 0.0.26 → 0.0.27

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    churn (0.0.26)
+    churn (0.0.27)
       chronic (>= 0.2.3)
       hirb
       json_pure

data/README.md

@@ -8,7 +8,7 @@ Currently has full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SV
 Authors:
 
 * danmayer
-* ajwalters 
+* ajwalters
 * cldwalker
 * absurdhero
 
@@ -18,50 +18,51 @@ __CI Build Status__
 
 This project runs [travis-ci.org](http://travis-ci.org)
 
-__Churn Usage__  
+__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']  
+  * use environment variables to control churn defaults
+
+        ENV['CHURN_MINIMUM_CHURN_COUNT']
+        ENV['CHURN_START_DATE']
         ENV['CHURN_IGNORE_FILES']
-  
-* CLI:  
+
+* 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__  
+        churn --start_date "6 months ago" #Start looking at file changes from 6 months ago
+
+
+__Example Output__
 
     **********************************************************************
-    * Revision Changes 
+    * Revision Changes
     **********************************************************************
-    Files: 
+    Files:
     +-------------------------------+
     | file                          |
     +-------------------------------+
     | Rakefile                      |
     | lib/churn/churn_calculator.rb |
     +-------------------------------+
-     
-    Classes: 
+
+    Classes:
     +-------------------------------+-----------------+
     | file                          | klass           |
     +-------------------------------+-----------------+
     | lib/churn/churn_calculator.rb | ChurnCalculator |
     +-------------------------------+-----------------+
-     
-    Methods: 
+
+    Methods:
     +-------------------------------+-----------------  +-------------------------------+
     | file                          | klass           | method                        |
     +-------------------------------+-----------------+-------------------------------+
@@ -69,11 +70,11 @@ __Example Output__
     | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#display_array |
     | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s          |
     +-------------------------------+-----------------+-------------------------------+
-   
+
     **********************************************************************
-    * Project Churn 
+    * Project Churn
     **********************************************************************
-    Files: 
+    Files:
     +------------------------------------+---------------+
     | file_path                          | times_changed |
     +------------------------------------+---------------+
@@ -86,17 +87,17 @@ __Example Output__
     | test/test_helper.rb                | 4             |
     | test/unit/churn_calculator_test.rb | 3             |
     | test/churn_test.rb                 | 3             |
-    +------------------------------------+---------------+ 
-   
-    Classes: 
+    +------------------------------------+---------------+
+
+    Classes:
     +-------------------------------+-----------------+---------------+
     | file                          | klass           | times_changed |
     +-------------------------------+-----------------+---------------+
     | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
     | lib/churn/churn_calculator.rb | ChurnCalculator | 1             |
     +-------------------------------+-----------------+---------------+
-     
-    Methods: 
+
+    Methods:
     +-------------------------------+-----------------+-----------------------------------------+---------------+
     | file                          | klass           | method                                  | times_changed |
     +-------------------------------+-----------------+-----------------------------------------+---------------+
@@ -114,31 +115,32 @@ __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 
+    --minimum_churn_count=minimum_churn_count, -c (0 ~>  int(minimum_churn_count=3))
+    --yaml, -y
+    --ignore_files=[ignore_files], -i (0 ~> string(ignore_files=))
+    --start_date=[start_date], -s (0 ~> string(start_date=))
+    --help, -h
 
-__TODO:__  
+__TODO:__
 
-* SVN only supports file, add full SVN support 
-* support bazaar, cvs, and darcs
+* SVN only supports file, add full SVN support (method and line numbers)
+* add support for 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/
+* allow passing in directories to churn
+* add a filter that allows for other files besides. *.rb to get method/class checks
+* improve line number matching for Ruby files
+* add line number matching for other langauges
 * finish adding better documenation using YARD
-* rake task for building manpage (currently manually run  ronn -b1 README.rdoc)
+* 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
@@ -150,4 +152,4 @@ __Notes on Patches/Pull Requests__
 
 __Copyright__
 
-Copyright (c) 2012 Dan Mayer. See LICENSE for details.
+Copyright (c) 2013 Dan Mayer. See LICENSE for details.

data/bin/churn

@@ -21,9 +21,15 @@ Main do
     default ''
   end
 
+  option('start_date', 's') 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, :ignore_files => params['ignore_files'].value}).report(output_string)
+    result = Churn::ChurnCalculator.new({:minimum_churn_count => params['minimum_churn_count'].value, :ignore_files => params['ignore_files'].value, :start_date => params['start_date'].value}).report(output_string)
     unless output_string
       result = YAML::dump(result)
     end

data/lib/churn/churn_calculator.rb

@@ -23,6 +23,7 @@ module Churn
 
     # intialized the churn calculator object
     def initialize(options={})
+      options[:start_date]=nil if options[:start_date]==''
       start_date = options.fetch(:start_date) { '3 months ago' }
       @minimum_churn_count = options.fetch(:minimum_churn_count) { 5 }.to_i
       @ignore_files     = (options.fetch(:ignore_files){ "" }).to_s.split(',').map(&:strip)

data/lib/churn/version.rb

@@ -1,3 +1,3 @@
 module Churn
-  VERSION = "0.0.26"
+  VERSION = "0.0.27"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: churn
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 41
   prerelease: 
   segments: 
   - 0
   - 0
-  - 26
-  version: 0.0.26
+  - 27
+  version: 0.0.27
 platform: ruby
 authors: 
 - Dan Mayer