churn 0.0.35 → 1.0.1

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
-  - rbx
   - 2.0.0
   - jruby-19mode

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    churn (0.0.35)
+    churn (1.0.1)
       chronic (>= 0.2.3)
       hirb
       json_pure
@@ -16,30 +16,37 @@ GEM
     activesupport (3.2.10)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    arrayfields (4.9.0)
+    arrayfields (4.9.2)
     chronic (0.10.2)
-    fattr (2.2.1)
+    coderay (1.1.0)
+    fattr (2.2.2)
     hirb (0.7.1)
     i18n (0.6.1)
     json (1.8.1)
-    json_pure (1.8.0)
-    main (5.2.0)
+    json_pure (1.8.1)
+    main (5.3.2)
       arrayfields (>= 4.7.4)
       chronic (>= 0.6.2)
       fattr (>= 2.2.0)
       map (>= 5.1.0)
-    map (6.5.1)
-    mime-types (1.25)
+      pry (>= 0.9)
+    map (6.5.3)
+    method_source (0.8.2)
+    mime-types (2.2)
     mocha (0.9.12)
     multi_json (1.5.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (10.0.3)
     rdoc (4.0.1)
       json (~> 1.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    ruby_parser (3.2.2)
+    ruby_parser (3.4.1)
       sexp_processor (~> 4.1)
-    sexp_processor (4.3.0)
+    sexp_processor (4.4.2)
     shoulda (3.3.2)
       shoulda-context (~> 1.0.1)
       shoulda-matchers (~> 1.4.1)
@@ -50,6 +57,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    slop (3.5.0)
     test-construct (1.2.0)
 
 PLATFORMS

data/lib/churn/calculator.rb

@@ -28,10 +28,10 @@ module Churn
 
     # intialized the churn calculator object
     def initialize(options={})
-      @churn_options = ChurnOptions.instance.set_options(options)
+      @churn_options = ChurnOptions.new.set_options(options)
       
       @minimum_churn_count = @churn_options.minimum_churn_count
-      @ignore_files        = @churn_options.ignore_files
+      @ignores             = @churn_options.ignores
       @source_control      = SourceControl.set_source_control(@churn_options.start_date)
 
       @changes          = {}
@@ -91,7 +91,7 @@ module Churn
 
     # 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 || @ignore_files.include?(file) }
+      @changes   = parse_log_for_changes.reject {|file, change_count| change_count < @minimum_churn_count || @ignores.any?{ |ignore| file.match(/#{ignore}/) } }
       @revisions = parse_log_for_revision_changes
     end
 
@@ -123,7 +123,7 @@ module Churn
         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)
+      ChurnHistory.store_revision_history(first_revision, hash, @churn_options.data_directory)
       hash
     end
 
@@ -190,7 +190,7 @@ module Churn
           #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)
+          changed_files, changed_classes, changed_methods = ChurnHistory.load_revision_data(revision, @churn_options.data_directory)
         end
         calculate_changes!(changed_methods, @method_changes) if changed_methods
         calculate_changes!(changed_classes, @class_changes) if changed_classes
@@ -266,15 +266,12 @@ module Churn
     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)
       files = @source_control.get_updated_files_change_info(revision, revisions)
-      files.select{ |file, value| !@ignore_files.include?(file) }
+      files.select{ |file, value| !@ignores.any?{ |ignore| file.match(/#{ignore}/) } }
     end
 
   end

data/lib/churn/history.rb

@@ -4,16 +4,16 @@ module Churn
   # 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_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) }
+    #takes current revision and its hash_data and stores it
+    def self.store_revision_history(revision, hash_data, data_directory)
+      FileUtils.mkdir_p data_directory
+      File.open("#{data_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)
+    def self.load_revision_data(revision, data_directory)
       #load revision data from scratch folder if it exists
-      filename = "#{tmp_churn_directory}/#{revision}.json"
+      filename = "#{data_directory}/#{revision}.json"
       if File.exists?(filename)
         begin
           json_data = File.read(filename)
@@ -28,10 +28,6 @@ module Churn
       [changed_files, changed_classes, changed_methods]
     end
 
-    def self.tmp_churn_directory
-      ChurnOptions.instance.data_directory
-    end
-
   end
 
 end

data/lib/churn/options.rb

@@ -4,18 +4,17 @@ module Churn
   
   # responsible for storing the churn configuration
   class ChurnOptions
-    include Singleton 
     DEFAULT_CHURN_DIRECTORY = "tmp/churn"
     DEFAULT_MINIMUM_CHURN_COUNT = 5
     DEFAULT_START_TIME = '3 months ago'
     DEFAULT_REPORT_HOST = 'http://churn.picoappz.com'
 
-    attr_accessor :data_directory, :minimum_churn_count, :ignore_files, :start_date, :history, :report_host, :name
+    attr_accessor :data_directory, :minimum_churn_count, :ignores, :start_date, :history, :report_host, :name
     
     def initialize()
       @data_directory      = DEFAULT_CHURN_DIRECTORY
       @minimum_churn_count = DEFAULT_MINIMUM_CHURN_COUNT
-      @ignore_files        = ['/dev/null']
+      @ignores             = '/dev/null'
       @start_date          = DEFAULT_START_TIME
       @history             = nil
       @report_host         = nil
@@ -25,8 +24,8 @@ module Churn
     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')
+      @ignores             = (options.fetch(:ignores){ @ignores }).to_s.split(',').map(&:strip)
+      @ignores << '/dev/null' unless @ignores.include?('/dev/null')
       @start_date          = options[:start_date] if !options[:start_date].nil? && options[:start_date]!=''
       @history             = options[:history] if !options[:history].nil? && options[:history]!=''
       if @history=='true'

data/lib/churn/scm/svn_analyzer.rb

@@ -11,6 +11,15 @@ module Churn
       `svn log --verbose#{date_range}#{svn_credentials}`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
     end
 
+    #below 2 methods aren't supported by SVN so they become noops
+    def get_revisions
+      []
+    end
+
+    def get_updated_files_change_info(revision, revisions)
+      {}
+    end
+
     private
     def svn_credentials
       " --username #{ENV['SVN_USR']} --password #{ENV['SVN_PWD']}" if ENV['SVN_PWD'] && ENV['SVN_USR']

data/lib/churn/version.rb

@@ -1,3 +1,3 @@
 module Churn
-  VERSION = "0.0.35"
+  VERSION = "1.0.1"
 end

data/lib/tasks/churn_tasks.rb

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

data/test/unit/churn_calculator_test.rb

@@ -25,10 +25,10 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     end
   end
 
-  should "use ignore_files filter" do
+  should "use ignores filter" do
     within_construct do |container|
       Churn::GitAnalyzer.stubs(:supported?).returns(true)
-      churn = Churn::ChurnCalculator.new({:ignore_files => "file.rb"})
+      churn = Churn::ChurnCalculator.new({:ignores => "file.rb"})
 
       churn.stubs(:parse_log_for_changes).returns([['file.rb', 10],['new.rb',11]])
       churn.stubs(:parse_log_for_revision_changes).returns(['revision'])
@@ -39,7 +39,35 @@ class ChurnCalculatorTest < Test::Unit::TestCase
     end
   end
 
-  should "analize sorts changes" do
+  should "use ignores with regex" do
+    within_construct do |container|
+      Churn::GitAnalyzer.stubs(:supported?).returns(true)
+      churn = Churn::ChurnCalculator.new({:ignores => "f.*le.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 "use ignores with regex and directories" do
+    within_construct do |container|
+      Churn::GitAnalyzer.stubs(:supported?).returns(true)
+      churn = Churn::ChurnCalculator.new({:ignores => "lib/.*"})
+
+      churn.stubs(:parse_log_for_changes).returns([['lib/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 "analyze sorts changes" do
     within_construct do |container|
       Churn::GitAnalyzer.stubs(:supported?).returns(true)
       churn = Churn::ChurnCalculator.new({:minimum_churn_count => 3})

data/test/unit/churn_history_test.rb

@@ -4,7 +4,7 @@ class ChurnHistoryTest < Test::Unit::TestCase
  
   should "store results" do
     within_construct do |container|
-      Churn::ChurnHistory.store_revision_history('aaa','data')
+      Churn::ChurnHistory.store_revision_history('aaa','data','tmp/churn/')
       assert File.exists?('tmp/churn/aaa.json')
       data = File.read('tmp/churn/aaa.json')
       assert data.match(/data/)
@@ -14,7 +14,7 @@ class ChurnHistoryTest < Test::Unit::TestCase
   should "restores results" do
     within_construct do |container|
       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')
+      changed_files, changed_classes, changed_methods = Churn::ChurnHistory.load_revision_data('aaa', 'tmp/churn/')
       assert changed_files.include?("lib/churn/source_control.rb")
       assert_equal 2, changed_classes.length
       assert_equal 1, changed_methods.length

data/test/unit/churn_options_test.rb

@@ -3,14 +3,14 @@ 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
+    assert_equal Churn::ChurnOptions::DEFAULT_CHURN_DIRECTORY, Churn::ChurnOptions.new.data_directory
   end
 
   should "store get over ride directory" do
-    options = Churn::ChurnOptions.instance
+    options = Churn::ChurnOptions.new
     tmp_dir = '/tmp/fake'
     options.set_options({:data_directory => tmp_dir})
-    assert_equal tmp_dir, Churn::ChurnOptions.instance.data_directory
+    assert_equal tmp_dir, options.data_directory
   end
   
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: churn
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 1.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Dan Mayer
@@ -13,48 +14,55 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-construct
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,76 +78,87 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: main
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: sexp_processor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -146,6 +166,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -153,6 +174,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -160,6 +182,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -167,32 +190,36 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
-description: 'High method and class churn has been shown to have increased bug and
+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. '
 email: dan@mayerdan.com
@@ -243,25 +270,41 @@ files:
 homepage: http://github.com/danmayer/churn
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4401989909685383083
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: churn
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Providing additional churn metrics over the original metric_fu churn
-test_files: []
+test_files:
+- test/data/churn_calculator.rb
+- test/data/test_helper.rb
+- test/test_helper.rb
+- 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
+- test/unit/source_control_test.rb
+- test/unit/svn_analyzer_test.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b1ef198f417e616080e9ada053a19596286c0ceb
-  data.tar.gz: d42960ccea815f89f846123808fd346fb5f5f65b
-SHA512:
-  metadata.gz: e92d32eade6ace59e1ed9b663f12d90ba1d1fe91de7d6675fa4910c4e8bb2e95df14d8cf20f53a1dd574c3ed5ea737c965f72c955188399c86ca41d2442bd376
-  data.tar.gz: 4a69afaa2311f8847089b8e1b28ee820679e790b9795bbfc843554db832b6d5c48c540930529b4c29ee0ba7a30b0d5559f36fc32ddd6cf5b919c59159a04cc2a