rferraz-churn 0.0.16

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'rake'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rferraz-churn (0.0.16)
+      arrayfields (>= 4.7.4)
+      chronic (>= 0.2.3)
+      chronic (>= 0.2.3)
+      fattr (>= 2.2.0)
+      hirb (>= 0.5.0)
+      jeweler (>= 1.6.4)
+      json (>= 1.6.1)
+      json_pure
+      main
+      main (>= 4.6.0)
+      map (>= 4.3.0)
+      ruby_parser (>= 2.3.1)
+      ruby_parser (~> 2.3)
+      sexp_processor (>= 3.0.7)
+      sexp_processor (~> 3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    arrayfields (4.7.4)
+    chronic (0.6.6)
+    fattr (2.2.0)
+    git (1.2.5)
+    hirb (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.4)
+    json_pure (1.6.4)
+    main (4.7.1)
+    map (5.2.0)
+    mocha (0.9.12)
+    rake (0.8.7)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.10)
+    shoulda (2.11.3)
+    test-construct (1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.6.0)
+  mocha (~> 0.9.5)
+  rake
+  rferraz-churn!
+  shoulda
+  test-construct

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Mayer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,123 @@
+= 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.

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'rake'
+require 'lib/tasks/churn_tasks'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "churn"
+    gem.summary = %Q{Providing additional churn metrics over the original metric_fu churn}
+    gem.description = %Q{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. }
+    gem.email = "dan@mayerdan.com"
+    gem.homepage = "http://github.com/danmayer/churn"
+    gem.authors = ["Dan Mayer"]
+    gem.add_development_dependency "shoulda"
+    gem.add_development_dependency "jeweler", '~> 1.6.0'
+    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 "sexp_processor", '~> 3.0.3'
+    gem.add_dependency "ruby_parser", '~> 2.3'
+    gem.add_dependency 'hirb'
+    gem.executables = ['churn']
+  end
+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'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "churn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.15

data/bin/churn

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby
+require 'main'
+require 'yaml'
+
+#example usage. In the root of a project 'churn', or 'churn --help'
+Main do
+  option('minimum_churn_count', 'c') do
+    argument :required
+    cast :int
+    default 3
+  end
+
+  option('yaml', 'y') do
+    cast :boolean
+    default false
+  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)
+    unless output_string
+      result = YAML::dump(result)
+    end
+    result
+  end
+
+  def run
+    report = report_churn(!params['yaml'].value)
+    puts report
+  end
+
+end

data/churn.gemspec

@@ -0,0 +1,123 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rferraz-churn"
+  s.version = "0.0.16"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Mayer"]
+  s.date = "2011-11-22"
+  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"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/churn",
+    "churn.gemspec",
+    "lib/churn.rb",
+    "lib/churn/bzr_analyzer.rb",
+    "lib/churn/churn_calculator.rb",
+    "lib/churn/churn_history.rb",
+    "lib/churn/git_analyzer.rb",
+    "lib/churn/hg_analyzer.rb",
+    "lib/churn/location_mapping.rb",
+    "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",
+    "test/unit/bzr_analyzer_test.rb",
+    "test/unit/churn_calculator_test.rb",
+    "test/unit/churn_history_test.rb",
+    "test/unit/git_analyzer_test.rb",
+    "test/unit/hg_analyzer_test.rb",
+    "test/unit/location_mapping_test.rb"
+  ]
+  s.homepage = "http://github.com/danmayer/churn"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Providing additional churn metrics over the original metric_fu churn"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<arrayfields>, [">= 4.7.4"])
+      s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_runtime_dependency(%q<fattr>, [">= 2.2.0"])
+      s.add_runtime_dependency(%q<hirb>, [">= 0.5.0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.6.1"])
+      s.add_runtime_dependency(%q<main>, [">= 4.6.0"])
+      s.add_runtime_dependency(%q<map>, [">= 4.3.0"])
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.3.1"])
+      s.add_runtime_dependency(%q<sexp_processor>, [">= 3.0.7"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<test-construct>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_runtime_dependency(%q<main>, [">= 0"])
+      s.add_runtime_dependency(%q<json_pure>, [">= 0"])
+      s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_runtime_dependency(%q<sexp_processor>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<ruby_parser>, ["~> 2.3"])
+    else
+      s.add_dependency(%q<arrayfields>, [">= 4.7.4"])
+      s.add_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_dependency(%q<fattr>, [">= 2.2.0"])
+      s.add_dependency(%q<hirb>, [">= 0.5.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<json>, [">= 1.6.1"])
+      s.add_dependency(%q<main>, [">= 4.6.0"])
+      s.add_dependency(%q<map>, [">= 4.3.0"])
+      s.add_dependency(%q<ruby_parser>, [">= 2.3.1"])
+      s.add_dependency(%q<sexp_processor>, [">= 3.0.7"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<test-construct>, [">= 0"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_dependency(%q<main>, [">= 0"])
+      s.add_dependency(%q<json_pure>, [">= 0"])
+      s.add_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_dependency(%q<sexp_processor>, ["~> 3.0.3"])
+      s.add_dependency(%q<ruby_parser>, ["~> 2.3"])
+    end
+  else
+    s.add_dependency(%q<arrayfields>, [">= 4.7.4"])
+    s.add_dependency(%q<chronic>, [">= 0.2.3"])
+    s.add_dependency(%q<fattr>, [">= 2.2.0"])
+    s.add_dependency(%q<hirb>, [">= 0.5.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<json>, [">= 1.6.1"])
+    s.add_dependency(%q<main>, [">= 4.6.0"])
+    s.add_dependency(%q<map>, [">= 4.3.0"])
+    s.add_dependency(%q<ruby_parser>, [">= 2.3.1"])
+    s.add_dependency(%q<sexp_processor>, [">= 3.0.7"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<test-construct>, [">= 0"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+    s.add_dependency(%q<main>, [">= 0"])
+    s.add_dependency(%q<json_pure>, [">= 0"])
+    s.add_dependency(%q<chronic>, [">= 0.2.3"])
+    s.add_dependency(%q<sexp_processor>, ["~> 3.0.3"])
+    s.add_dependency(%q<ruby_parser>, ["~> 2.3"])
+  end
+end
+

data/lib/churn/bzr_analyzer.rb

@@ -0,0 +1,31 @@
+module Churn
+
+  #analizes Bzr / Bazaar SCM to find recently changed files, and what lines have been altered
+  class BzrAnalyzer < SourceControl
+    def get_logs
+      `bzr log -v --short #{date_range}`.split("\n").reject{|line| line !~ /^[ ]*(M|A)  /}.map{|line| line.strip.split(" ")[1..-1]}.flatten
+    end
+
+    def get_revisions
+      `bzr log --line #{date_range}`.split("\n").map{|line| line[/^(\S+):/, 1] }
+    end
+
+    private
+
+    def get_diff(revision, previous_revision)
+      `bzr diff -r #{previous_revision}..#{revision}`.split(/\n/).select{|line| line.match(/^@@/) || line.match(/^---/) || line.match(/^\+\+\+/) }
+    end
+
+    def date_range
+      if @start_date
+        date = Chronic.parse(@start_date)
+        "-r #{date.strftime('%Y-%m-%d')}.."
+      end
+    end
+
+    def get_recent_file(line)
+      super(line).split("\t")[0]
+    end
+
+  end
+end