tax_code 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tax_code.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugene Kalenkovich
+
+MIT License
+
+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.md

@@ -0,0 +1,93 @@
+# TaxCode
+
+Each time we need to modify a file for a new feature or a bug fix we increase a
+maintenance cost of this file and the whole code base. 
+TaxCode calculates cumulative maintenance 'taxes' introduced by all changes in the git repository.
+
+Files with higher taxes are most probably ones that carry too many responsibilities and/or
+are too complex - they should be considered for refactoring.
+
+You can see the tax value for particular file as a 'perceptual size increase' - e.g. if the file
+size is 500 lines and its tax is 400, this file maintenance costs the same as for untouched 
+900 lines long one (please note that there is no science behind tax calculation, this is author's opinionated taks on the problem)
+
+TaxCode differences from other similar scripts and gems:
+- TaxCode takes into account that maintenance cost decreases over time - if you do not
+touch some files for a long time, they may be stable enogh and not have as high cost as recently modified ones. 
+- It gives you a 'tax credit' for changes that reduce the size of your files
+- It tracks files that are renamed and/or moed around
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tax_code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tax_code
+
+## Usage
+
+Main intent of this gem is to be used from command line. The number of options and commands will be increased in future releases
+
+To get repository or directory aggregated tax or a file tax:
+
+    $ cd test/repo
+    $ taxes
+    19
+
+    $ cd ../..
+    $ taxes test/repo
+    19
+
+    $ taxes test/repo/multiple_commits
+    14
+
+Too narrow path specification will not take into account file renames that happened outside of this path
+
+    $ taxes test/repo/renamed
+    0
+
+To get the list of top (up to) 25 expensive files in your repository (non-taxed files are not included in the report):
+    
+    $ cd test/repo
+    $ worst_taxed
+    14  test/repo/multiple_commits
+    5   test/repo/renamed
+
+    $ cd ../..
+    $ worst_taxed test/repo
+    14  test/repo/multiple_commits
+    5   test/repo/renamed
+
+Please note that limiting to particular directory or file may miss data about renamed files. E.g:
+    
+    $ worst_taxed test/repo/multiple_commits
+    14  test/repo/multiple_commits
+
+    $ worst_taxed test/repo/renamed
+    No taxed files found
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## TODO
+
+* Add more options and commands to CLI
+* Output partial path (instead of full path from git root)
+* Do full repo log on runs limited to directory/file
+* Calculate tax on a single commit (last or specified)
+* Historical snapshot - taxes up to particular commit or date
+* Taxes accumulated after particular commit or date
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/bin/taxes

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+require_relative '../lib/tax_code'
+
+target = ARGV[0] || '.'
+
+puts TaxCode.taxes(target).map(&:last).inject(0, &:+)

data/bin/worst_taxed

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+require_relative '../lib/tax_code'
+
+worst = TaxCode.worst(ARGV[0] || '.')
+
+puts 'No taxed files found' and exit if worst.empty?
+
+puts worst.map{ |f, t| "#{t}\t#{f}" } 

data/lib/tax_code/version.rb

@@ -0,0 +1,3 @@
+class TaxCode
+  VERSION = "0.0.1"
+end

data/lib/tax_code.rb

@@ -0,0 +1,89 @@
+require_relative "tax_code/version"
+require 'date'
+
+class TaxCode
+  class << self
+    def taxes(path = '.')
+      TaxCode.new(path).taxes    
+    end
+
+    def worst(path = '.', num = 25)
+      TaxCode.new(path).worst(num)
+    end
+  
+    def taxed_only(path = '.')
+      TaxCode.new(path).taxed_only
+    end
+  end
+
+  def initialize(path = '.')
+    dir = path
+    file = '.'
+    unless File.directory? path
+      dir = File.dirname path
+      file = File.basename path
+    end
+    Dir.chdir(dir) do
+      log = `git log --numstat -M #{file}`.encode('UTF-8', 'UTF-8', :invalid => :replace)
+      raise 'Path has to be inside your git repository' if log == ""
+      compute_history(log)
+    end  
+  end
+
+  def taxes
+    @hist.inject({}) do |res, (f, changes)|
+      size, tax = changes[0][1], 0
+      changes[1..-1].each do |c|
+        tax += score(size, *c)
+        size += c[1] - c[2]
+      end
+      size > 0 ? res.merge(f => [tax.to_i, 0].max) : res
+    end
+  end
+
+  def taxed_only
+    taxes.select{ |_, t| t > 0 }
+  end
+
+  def worst(num = 25)
+    taxed_only.sort_by(&:last).last(num).reverse 
+  end
+  
+private
+
+  def score(s, age, a, d)
+    hpr = 2 ** ( - age / 180.0)
+    (s/40.0 + a * 2 - d ) * hpr 
+  end
+
+  def commits(log)
+    log.split(/^Date:\s+(.*)$/)[1..-1].each_slice(2).map do |(d,all)| 
+      age = (Date.today - Date.parse(d)).to_i 
+      all.split(/\n/).grep(/^\d/).inject({}) do |h, s| 
+        a, d, f = s.split(/\t/)
+        h.merge f => [age, a.to_i, d.to_i]
+      end
+    end
+  end
+
+  def compute_history(log)
+    @hist = Hash.new{|h,k| h[k] = []}
+    commits(log).reverse.each do |cmt|
+      cmt.each do |f, ar|
+        fn = f
+        if p = moved(f)
+          fo, fn = p
+          @hist[fn] = @hist[fo]
+          @hist.delete(fo)
+        end
+        @hist[fn] << ar
+      end
+    end
+  end
+
+  def moved(f)
+    if f =~ /^(.*){([^\s]*) => ([^\s}]*)}(.*)$/
+      [$1 + $2 + $4, $1 + $3 + $4].map{|fn| fn.sub('//','/')}
+    end
+  end
+end

data/tax_code.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tax_code/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'tax_code'
+  gem.version       = TaxCode::VERSION
+  gem.authors       = ['Eugene Kalenkovich']
+  gem.email         = ['rubify@softover.com']
+  gem.description   = 'TaxCode scans git commit history and calculates maintenance tax for each file'
+  gem.summary       = 'Calculates maintenance taxes for your git repo'
+  gem.homepage      = 'https://github.com/kalenkov/tax_code'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/repo/committed_once

@@ -0,0 +1,2 @@
+This file is supposed to be committed only once
+Committed once files are supposed to have no tax

data/test/repo/multiple_commits

@@ -0,0 +1,8 @@
+Line for commit number 1
+More lines
+added
+...
+And
+even 
+more
+...

data/test/repo/refactored

@@ -0,0 +1,10 @@
+To
+refactor
+this 
+file
+we
+changed it a little
+and removed significant part of the content.
+.......
+We already made
+this a little more expensive

data/test/repo/renamed

@@ -0,0 +1,3 @@
+This file was renamed and modified
+For now we will add some content
+And some more

data/test/tax_code_test.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'tax_code'
+
+class TaxCodeTest < MiniTest::Unit::TestCase
+  def test_prebaked_files
+    res = TaxCode.new('test/repo').taxes
+    assert res['test/repo/renamed'] > 0
+    assert res['test/repo/multiple_commits'] > res['test/repo/renamed']
+    assert res['test/repo/refactored'] == 0
+    assert res['test/repo/committed_once'] == 0
+    assert res['test/repo/commited_once'] == nil # File removed from repo
+  end
+
+  def test_taxed_only
+    assert TaxCode.taxed_only('test/repo').size == 2
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: tax_code
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eugene Kalenkovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-26 00:00:00.000000000 Z
+dependencies: []
+description: TaxCode scans git commit history and calculates maintenance tax for each
+  file
+email:
+- rubify@softover.com
+executables:
+- taxes
+- worst_taxed
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/taxes
+- bin/worst_taxed
+- lib/tax_code.rb
+- lib/tax_code/version.rb
+- tax_code.gemspec
+- test/repo/committed_once
+- test/repo/multiple_commits
+- test/repo/refactored
+- test/repo/renamed
+- test/tax_code_test.rb
+homepage: https://github.com/kalenkov/tax_code
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Calculates maintenance taxes for your git repo
+test_files:
+- test/repo/committed_once
+- test/repo/multiple_commits
+- test/repo/refactored
+- test/repo/renamed
+- test/tax_code_test.rb