churn 0.0.29 → 0.0.30

data/.gitignore

@@ -6,4 +6,5 @@ pkg
 tmp
 .rvmrc
 .bundle
-specs
+specs
+.yardoc/

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,5 @@
-__churn__
+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 churns 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
@@ -13,13 +14,14 @@ Authors:
 * absurdhero
 * bf4
 
-__CI Build Status__
+## CI Build Status
 
 [![Build Status](https://secure.travis-ci.org/danmayer/churn.png)](http://travis-ci.org/danmayer/churn)
 
 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', :require => false`. 
 
 The reason you want require false is that when required by default churn is expecting to add some rake tasks, you don't really want or need it loading when running your server or tests. Previous versions required this change, churn will now do the right thing if you forget to add `require => false`. 
@@ -45,7 +47,7 @@ The reason you want require false is that when required by default churn is expe
         churn --start_date "6 months ago" #Start looking at file changes from 6 months ago
 
 
-__Example Output__
+## Example Output
 
     **********************************************************************
     * Revision Changes
@@ -113,7 +115,7 @@ __Example Output__
     | lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s                    | 1             |
     +-------------------------------+-----------------+-----------------------------------------+---------------+
 
-__Options__
+## Options
 
     [~/projects/churn] churn -h
     NAME
@@ -129,20 +131,13 @@ __Options__
     --start_date=[start_date], -s (0 ~> string(start_date=))
     --help, -h
 
-__TODO:__
+## TODO
+
+The list of items has been moved to the [churn wafflie.io](http://waffle.io/danmayer/churn)
 
-* 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
-* 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`)
-* don't output methods and classes on a commit that has none detected (css and view only commits, etc)
+[![Stories in Ready](https://badge.waffle.io/danmayer/churn.png)](http://waffle.io/danmayer/churn)
 
-__Notes on Patches/Pull Requests__
+## Notes on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -153,6 +148,6 @@ __Notes on Patches/Pull Requests__
    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
 
 Copyright (c) 2013 Dan Mayer. See LICENSE for details.

data/bin/churn

@@ -27,9 +27,15 @@ Main do
     default ''
   end
 
+  option('data_directory', 'd') 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, :start_date => params['start_date'].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, :data_directory => params['data_directory'].value}).report(output_string)
     unless output_string
       result = YAML::dump(result)
     end

data/lib/churn/churn_calculator.rb

@@ -13,22 +13,26 @@ require 'hg_analyzer'
 require 'bzr_analyzer'
 require 'location_mapping'
 require 'churn_history'
+require 'churn_options'
 
 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.
+  # 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 on 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={})
-      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)
-      @ignore_files << '/dev/null'
-      @source_control   = set_source_control(start_date)
+      @churn_options = ChurnOptions.instance.set_options(options)
+      
+      @minimum_churn_count = @churn_options.minimum_churn_count
+      @ignore_files        = @churn_options.ignore_files
+      start_date           = @churn_options.start_date
+      @source_control      = set_source_control(start_date)
+
       @changes          = {}
       @revision_changes = {}
       @class_changes    = {}
@@ -83,9 +87,7 @@ module Churn
       hash
     end
 
-    # Pretty print the data as a string for the user
-    def to_s
-      hash   = to_h[:churn]
+    def self.to_s(hash)
       result = seperator
       result +="* Revision Changes \n"
       result += seperator
@@ -108,6 +110,11 @@ module Churn
       result += display_array(method_churn)
     end
 
+    # Pretty print the data as a string for the user
+    def to_s
+      ChurnCalculator(to_h[:churn])
+    end
+
     private
 
     def collect_items(collection, match)

data/lib/churn/churn_history.rb

@@ -1,19 +1,19 @@
 module Churn
 
-  # responcible for storing the churn history to json,
+  # responsible 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) }
+      FileUtils.mkdir_p tmp_churn_directory unless File.directory?(tmp_churn_directory)
+      File.open("#{tmp_churn_directory}/#{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"
+      filename = "#{tmp_churn_directory}/#{revision}.json"
       if File.exists?(filename)
         begin
           json_data = File.read(filename)
@@ -28,6 +28,10 @@ module Churn
       [changed_files, changed_classes, changed_methods]
     end
 
+    def self.tmp_churn_directory
+      ChurnOptions.instance.data_directory
+    end
+
   end
 
 end

data/lib/churn/version.rb

@@ -1,3 +1,3 @@
 module Churn
-  VERSION = "0.0.29"
+  VERSION = "0.0.30"
 end

data/lib/churn_options.rb

@@ -0,0 +1,31 @@
+require 'singleton'
+
+module Churn
+  
+  # responsible for storing the churn configuration
+  class ChurnOptions
+    include Singleton 
+    DEFAULT_CHURN_DIRECTORY = "tmp/churn"
+    DEFAULT_MINIMUM_CHURN_COUNT = 5
+
+    attr_accessor :data_directory, :minimum_churn_count, :ignore_files, :start_date
+    
+    def initialize()
+      @data_directory      = DEFAULT_CHURN_DIRECTORY
+      @minimum_churn_count = DEFAULT_MINIMUM_CHURN_COUNT
+      @ignore_files        = ['/dev/null']
+      @start_date          = '3 months ago'
+    end
+
+    def set_options(options = {})
+      @data_directory      = options.fetch(:data_directory){ @data_directory } unless options[:data_directory]==''
+      @minimum_churn_count = options.fetch(:minimum_churn_count){ @minimum_churn_count }.to_i
+      @ignore_files        = (options.fetch(:ignore_files){ @ignore_files }).to_s.split(',').map(&:strip)
+      @ignore_files << '/dev/null' unless @ignore_files.include?('/dev/null')
+      @start_date          = options[:start_date] if options[:start_date].nil? || options[:start_date]!=''
+      self
+    end
+        
+  end
+
+end

data/lib/tasks/churn_tasks.rb

@@ -5,6 +5,7 @@ if defined?(RakeFileUtils) # self.respond_to?(:desc)
     { :minimum_churn_count => ENV['CHURN_MINIMUM_CHURN_COUNT'],
       :start_date          => ENV['CHURN_START_DATE'],
       :ignore_files        => ENV['CHURN_IGNORE_FILES'],
+      :data_directory        => ENV['CHURN_DATA_DIRECTORY'],
     }.each {|k,v| params[k] = v unless v.nil? }
     Churn::ChurnCalculator.new(params).report
   end

data/test/unit/churn_history_test.rb

@@ -5,15 +5,15 @@ class ChurnHistoryTest < Test::Unit::TestCase
   should "store results" do
     within_construct do |container|
       Churn::ChurnHistory.store_revision_history('aaa','data')
-      assert File.exists?('tmp/aaa.json')
-      data = File.read('tmp/aaa.json')
+      assert File.exists?('tmp/churn/aaa.json')
+      data = File.read('tmp/churn/aaa.json')
       assert data.match(/data/)
     end
   end
  
   should "restores results" do
     within_construct do |container|
-      container.file('tmp/aaa.json', '{"churn":{"changes":[{"file_path":".gitignore","times_changed":2},{"file_path":"lib\/churn.rb","times_changed":2},{"file_path":"Rakefile","times_changed":2},{"file_path":"README.rdoc","times_changed":2},{"file_path":"lib\/churn\/source_control.rb","times_changed":1},{"file_path":"lib\/churn\/svn_analyzer.rb","times_changed":1},{"file_path":"lib\/tasks\/churn_tasks.rb","times_changed":1},{"file_path":"LICENSE","times_changed":1},{"file_path":"test\/churn_test.rb","times_changed":1},{"file_path":"lib\/churn\/locationmapping.rb","times_changed":1},{"file_path":"lib\/churn\/git_analyzer.rb","times_changed":1},{"file_path":".document","times_changed":1},{"file_path":"test\/test_helper.rb","times_changed":1},{"file_path":"lib\/churn\/churn_calculator.rb","times_changed":1}],"method_churn":[],"changed_files":[".gitignore","lib\/churn\/source_control.rb","lib\/tasks\/churn_tasks.rb","lib\/churn\/svn_analyzer.rb","Rakefile","README.rdoc","lib\/churn\/locationmapping.rb","lib\/churn\/git_analyzer.rb","\/dev\/null","lib\/churn\/churn_calculator.rb","lib\/churn.rb"],"class_churn":[],"changed_classes":[{"klass":"ChurnTest","file":"test\/churn_test.rb"},{"klass":"ChurnCalculator","file":"lib\/churn\/churn_calculator.rb"}],"changed_methods":[{"klass":"","method":"#report_churn","file":"lib\/tasks\/churn_tasks.rb"}]}}')
+      container.file('tmp/churn/aaa.json', '{"churn":{"changes":[{"file_path":".gitignore","times_changed":2},{"file_path":"lib\/churn.rb","times_changed":2},{"file_path":"Rakefile","times_changed":2},{"file_path":"README.rdoc","times_changed":2},{"file_path":"lib\/churn\/source_control.rb","times_changed":1},{"file_path":"lib\/churn\/svn_analyzer.rb","times_changed":1},{"file_path":"lib\/tasks\/churn_tasks.rb","times_changed":1},{"file_path":"LICENSE","times_changed":1},{"file_path":"test\/churn_test.rb","times_changed":1},{"file_path":"lib\/churn\/locationmapping.rb","times_changed":1},{"file_path":"lib\/churn\/git_analyzer.rb","times_changed":1},{"file_path":".document","times_changed":1},{"file_path":"test\/test_helper.rb","times_changed":1},{"file_path":"lib\/churn\/churn_calculator.rb","times_changed":1}],"method_churn":[],"changed_files":[".gitignore","lib\/churn\/source_control.rb","lib\/tasks\/churn_tasks.rb","lib\/churn\/svn_analyzer.rb","Rakefile","README.rdoc","lib\/churn\/locationmapping.rb","lib\/churn\/git_analyzer.rb","\/dev\/null","lib\/churn\/churn_calculator.rb","lib\/churn.rb"],"class_churn":[],"changed_classes":[{"klass":"ChurnTest","file":"test\/churn_test.rb"},{"klass":"ChurnCalculator","file":"lib\/churn\/churn_calculator.rb"}],"changed_methods":[{"klass":"","method":"#report_churn","file":"lib\/tasks\/churn_tasks.rb"}]}}')
       changed_files, changed_classes, changed_methods = Churn::ChurnHistory.load_revision_data('aaa')
       assert changed_files.include?("lib/churn/source_control.rb")
       assert_equal 2, changed_classes.length

data/test/unit/churn_options_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class ChurnOptionsTest < Test::Unit::TestCase
+ 
+  should "store get default directory" do
+    assert_equal Churn::ChurnOptions::DEFAULT_CHURN_DIRECTORY, Churn::ChurnOptions.instance.data_directory
+  end
+
+  should "store get over ride directory" do
+    options = Churn::ChurnOptions.instance
+    tmp_dir = '/tmp/fake'
+    options.set_options({:data_directory => tmp_dir})
+    assert_equal tmp_dir, Churn::ChurnOptions.instance.data_directory
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: churn
 version: !ruby/object:Gem::Version 
-  hash: 37
+  hash: 35
   prerelease: 
   segments: 
   - 0
   - 0
-  - 29
-  version: 0.0.29
+  - 30
+  version: 0.0.30
 platform: ruby
 authors: 
 - Dan Mayer
@@ -208,6 +208,7 @@ files:
 - lib/churn/source_control.rb
 - lib/churn/svn_analyzer.rb
 - lib/churn/version.rb
+- lib/churn_options.rb
 - lib/tasks/churn_tasks.rb
 - man/churn.1
 - man/churn.html
@@ -217,6 +218,7 @@ files:
 - test/unit/bzr_analyzer_test.rb
 - test/unit/churn_calculator_test.rb
 - test/unit/churn_history_test.rb
+- test/unit/churn_options_test.rb
 - test/unit/git_analyzer_test.rb
 - test/unit/hg_analyzer_test.rb
 - test/unit/location_mapping_test.rb
@@ -260,6 +262,7 @@ test_files:
 - test/unit/bzr_analyzer_test.rb
 - test/unit/churn_calculator_test.rb
 - test/unit/churn_history_test.rb
+- test/unit/churn_options_test.rb
 - test/unit/git_analyzer_test.rb
 - test/unit/hg_analyzer_test.rb
 - test/unit/location_mapping_test.rb