churn 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c816b4eab0ce4a1311378d6aebf5a7ab04d4ac1d
-  data.tar.gz: 380238f8db9acad2b7cf0c1f3760f0e75767eb79
+SHA256:
+  metadata.gz: dbe39389e7238ce9ac55fb37224083a50b65692de78df6189e1b2cba21819211
+  data.tar.gz: adf3e40ea5e98297181a1bf78316fc42c368c560e336797f1d59c38dabfcee4a
 SHA512:
-  metadata.gz: 64e214dd33714eba3d30b6f22689b3edc60d1c7d9b6a09085df33aa0aeed8f3fa49607fdd841f39bdb8c49f18752ab966f929bec3ddbd0807cf65844da07a867
-  data.tar.gz: 884d1fa121966359dcb8df8d457bbc2dc209bde2084ce496a972dcc8820c24a5de9ffe2aee239421a783a7d026248ce3016c38719f5078bc42308fee61cc3a43
+  metadata.gz: fca92c6967f4873fa57836bf5ebbc2f05d80a510eda2b61b3fd9fce40b2ca80338962cef98d56930a5520cd73bb53d4665753d41512cb33c86ac3edf40b1470f
+  data.tar.gz: d8228f4bcf60a6777e0a590170462019b46d0cfde0fcba4324b2ca5bffef8cf351ce4d4b6036861ac7eb1d6de6d0e77739d5436e45beee8eb1ccbff72be17609

data/README.md

@@ -1,134 +1,132 @@
-Churn
-===
+[![Build Status](https://travis-ci.org/danmayer/churn.svg?branch=master)](http://travis-ci.org/danmayer/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 building up a history using churn between revisions. The history is stored in ./tmp
 
 Currently has full Git, Mercurial (hg), Bazaar (bzr) support, and partial SVN support (supports only file level churn currently)
 
-File changes can be calculated on any single commit to look at method changes you need to be running churn over time. Using a git post-commit hook, configuring your CI to run churn, or using [churn-site](http://churn.picoappz.com) is the best way to build up your churn history. See the --past_history (-p) option to do a one time run building up past class and method level churn.
-
-####Authors:
-* danmayer
-* ajwalters
-* cldwalker
-* absurdhero
-* bf4
-
-## CI Build Status
+File changes can be calculated on any single commit to look at method changes you need to be running churn over time. Using a git post-commit hook, configuring your CI to run churn. See the --past_history (-p) option to do a one time run building up past class and method level churn.
 
-[![Build Status](https://travis-ci.org/danmayer/churn.svg?branch=master)](http://travis-ci.org/danmayer/churn)
+## TODO
 
-This project runs [travis-ci.org](http://travis-ci.org)
+Want to help out, there are easy tasks ready for some attention. The list of items is hosted on [github issues](https://github.com/danmayer/churn/issues)
 
-## TODO
+## Churn Usage
 
-Want to help out, there are easy tasks ready for some attention. The list of items has been moved to the [churn wafflie.io](http://waffle.io/danmayer/churn)
+Install with `gem install churn` or for bundler add to your Gemfile
 
-[![Stories in Ready](https://badge.waffle.io/danmayer/churn.png)](http://waffle.io/danmayer/churn)
 
-## Churn Usage
+```
+group :development do
+  gem 'churn'
+end
+```
 
-Install with `gem install churn` or for bundler add to your Gemfile `gem 'churn', :require => false`.
+### Rake
 
-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.
+* Add `require 'churn'` to Rakefile
+* Then run `rake churn` or `bundle exec rake churn`
+* Use environment variables to control churn defaults
 
-* rake:
-  * add `require 'churn'` to Rakefile
-  * then run`rake churn` or `bundle exec rake churn`
-  * use environment variables to control churn defaults
+``` ruby
+ENV['CHURN_MINIMUM_CHURN_COUNT']
+ENV['CHURN_START_DATE']
+ENV['CHURN_IGNORES']
+```
 
-      ``` ruby
-        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
+* On the 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
 
-      ``` bash
-        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
-        churn --start_date "6 months ago" #Start looking at file changes from 6 months ago
-        churn -p "4 months ago" #churn the past history to build up data for the last 4 months
-        churn --past_history #churn the past history for default 3 months to build up data
-      ```
+```shell
+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
+churn -e rb                         # Specify a file extension. The dot will be prepended automatically ("rb" -> ".rb") 
+churn -f app                        # Specify a file prefix, e.g. app/models
+churn --start_date "6 months ago"   # Start looking at file changes from 6 months ago
+churn -p "4 months ago"             # Churn the past history to build up data for the last 4 months
+churn --past_history                # Churn the past history for default 3 months to build up data
+```
 
 ## 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             |
-    +-------------------------------+-----------------+-----------------------------------------+---------------+
+```
+**********************************************************************
+* 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             |
++-------------------------------+-----------------+-----------------------------------------+---------------+
+```
 
 ## CLI Options
 
+```
     [~/projects/churn] churn -h
     NAME
       churn
@@ -140,28 +138,35 @@ The reason you want require false is that when required by default churn is expe
       --minimum_churn_count=minimum_churn_count, -c (0 ~>
       int(minimum_churn_count=3))
       --yaml, -y
+      --extension, -e (0 ~> string(file_extension=))
+      --prefix, -f (0 ~> string(file_prefix=))
       --ignore_files=[ignore_files], -i (0 ~> string(ignore_files=))
       --start_date=[start_date], -s (0 ~> string(start_date=))
       --data_directory=[data_directory], -d (0 ~> string(data_directory=))
       --past_history=[past_history], -p (0 ~> string(past_history=))
       --help, -h
+```
 
 ## Library Options
 
 All the CLI options are parsed and just passed into the library. If you want to run the library directly from other code. The best way to see current options is where the [churn executable](https://github.com/danmayer/churn/blob/master/bin/churn) passes the parsed options into the `ChurnCalculator` class
 
-    ###
-    # Available options
-    ###
-    options = {: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,
-      :history => params['past_history'].value,
-      :report => params['report'].value,
-      :name => params['name'].value
-    }
-    result = Churn::ChurnCalculator.new(options).report(false)
+```ruby
+###
+# Available options
+###
+options = {:minimum_churn_count => params['minimum_churn_count'].value,
+  :ignore_files => params['ignore_files'].value,
+  :file_extension => params['file_extension'].value,
+  :file_prefix => params['file_prefix'].value,
+  :start_date => params['start_date'].value,
+  :data_directory => params['data_directory'].value,
+  :history => params['past_history'].value,
+  :report => params['report'].value,
+  :name => params['name'].value
+}
+result = Churn::ChurnCalculator.new(options).report(false)
+```
 
 ## Notes on Patches/Pull Requests
 
@@ -174,6 +179,18 @@ All the CLI options are parsed and just passed into the library. If you want to
    bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+## Authors
+
+* danmayer
+* ajwalters
+* cldwalker
+* absurdhero
+* bf4
+
+## Code of Conduct
+
+Please see our [Code of Conduct](https://github.com/danmayer/churn/blob/master/CODE_OF_CONDUCT.md)
+
 ## Copyright
 
-Copyright (c) 2013 Dan Mayer. See LICENSE for details.
+Copyright (c) 2019 Dan Mayer. See LICENSE for details.

data/bin/churn

@@ -39,7 +39,7 @@ Main do
     cast :string
     argument :optional
     default ''
-    description 'name is require if remotely reporting churn results. If available as a github project, pass name in the form of username/project_name'
+    description 'name is required if remotely reporting churn results. If available as a github project, pass name in the form of username/project_name'
   end
 
   option('start_date', 's') do
@@ -61,25 +61,40 @@ Main do
     default ''
   end
 
+  option('extension', 'e') do
+    cast :string
+    argument :optional
+    default ''
+  end
+
+  option('prefix', 'f') do
+    cast :string
+    argument :optional
+    default ''
+  end
+
   def report_churn(output_string)
-    options = {: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,
-      :history => params['past_history'].value,
-      :report => params['report'].value,
-      :name => params['name'].value
+    options = {
+      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,
+      history: params['past_history'].value,
+      report: params['report'].value,
+      name: params['name'].value,
+      file_extension: params['extension'].value,
+      file_prefix: params['prefix'].value
     }
     result = Churn::ChurnCalculator.new(options).report(output_string)
-    unless output_string
-      result = YAML::dump(result)
+    if output_string
+      result
+    else
+      YAML::dump(result)
     end
-    result
   end
 
   def run
     report = report_churn(!params['yaml'].value)
     puts report
   end
-
 end

data/churn.gemspec

@@ -6,34 +6,20 @@ Gem::Specification.new do |s|
   s.name = "churn"
   s.version = Churn::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Dan Mayer"]
-  s.date = "2012-12-17"
+  s.author = "Dan Mayer"
   s.summary = "Providing additional churn metrics over the original metric_fu churn"
   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.homepage = "http://github.com/danmayer/churn"
-  s.rubyforge_project = "churn"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables = %w[churn]
 
-  s.license = 'MIT'
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
+  s.files = %w[churn.gemspec LICENSE.txt README.md] + Dir["bin/*", "lib/**/*.rb", "man/*"]
+  s.license = "MIT"
+  s.require_paths = %w[lib]
+  s.required_ruby_version = ">= 1.9.3"
+  s.requirements = "bzr, git, hg or svn"
 
-  s.add_development_dependency "minitest", "~> 5.3"
-  s.add_development_dependency "shoulda", ">= 0"
-  s.add_development_dependency "test_construct", "~> 2.0.0"
-  s.add_development_dependency "rake", ">= 0"
-  s.add_development_dependency "mocha", "~> 1.1.0"
-  s.add_development_dependency "simplecov", ">= 0"
-  s.add_development_dependency "rdoc", ">= 0"
-  #s.add_development_dependency "ruby-debug", "~> 0.10.4"
   s.add_runtime_dependency "main", ">= 0"
   s.add_runtime_dependency "json_pure", ">= 0"
   s.add_runtime_dependency "chronic", ">= 0.2.3"

data/lib/churn/calculator.rb

@@ -6,16 +6,16 @@ require 'hirb'
 require 'fileutils'
 require 'rest_client'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'scm/source_control'
-require 'scm/git_analyzer'
-require 'scm/svn_analyzer'
-require 'scm/hg_analyzer'
-require 'scm/bzr_analyzer'
 
-require 'location_mapping'
-require 'history'
-require 'options'
+require_relative 'scm/source_control'
+require_relative 'scm/git_analyzer'
+require_relative 'scm/svn_analyzer'
+require_relative 'scm/hg_analyzer'
+require_relative 'scm/bzr_analyzer'
+
+require_relative 'location_mapping'
+require_relative 'history'
+require_relative 'options'
 
 module Churn
 
@@ -45,7 +45,7 @@ module Churn
     # prepares the data for the given project to be reported.
     # reads git/svn logs analyzes the output, generates a report and either
     # formats as a nice string or returns hash.
-    # @param [Boolean] format to return the data, true for string or false for hash
+    # @param [Boolean] print to return the data, true for string or false for hash
     # @return [Object] returns either a pretty string or a hash representing the
     # churn of the project
     def report(print = true)
@@ -89,6 +89,7 @@ module Churn
     # on the edited files
     def analyze
       @changes = sort_changes(@changes)
+      @changes = filter_changes(@changes)
       @changes = @changes.map {|file_path, times_changed| {:file_path => file_path, :times_changed => times_changed }}
 
       calculate_revision_changes
@@ -157,6 +158,18 @@ module Churn
       changes.to_a.sort! {|first,second| second[1] <=> first[1]}
     end
 
+    def filter_changes(changes)
+      if @churn_options.file_extension && !@churn_options.file_extension.empty?
+        changes = changes.select { |file_path, _revision_count| file_path =~ /\.#{@churn_options.file_extension}\z/ }
+      end
+
+      if @churn_options.file_prefix && !@churn_options.file_prefix.empty?
+        changes = changes.select! { |file_path, _revision_count| file_path =~ /\A#{@churn_options.file_prefix}/ }
+      end
+
+      changes
+    end
+
     def filters
       /.*\.rb/
     end
@@ -226,7 +239,7 @@ module Churn
       classes = classes.map{ |klass| {'file' => file, 'klass' => klass} }
       methods = methods.map{ |method| {'file' => file, 'klass' => get_klass_for(method), 'method' => method} }
       [classes, methods]
-    rescue => error
+    rescue
       [[],[]]
     end