debt_ceiling 0.0.6 → 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - 2.1.1

data/MIT-LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2014 Brian Glusman <bglusman@shutterstock.com>
+
+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

@@ -1,82 +1,78 @@
+[![Gem Version](https://badge.fury.io/rb/debt_ceiling.svg)](http://badge.fury.io/rb/debt_ceiling)
+[![Build Status](https://travis-ci.org/bglusman/debt_ceiling.svg?branch=master)](https://travis-ci.org/bglusman/debt_ceiling)
 [![Debt Ceiling Chat](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/bglusman/debt_ceiling)
+[![debt_ceiling API Documentation](https://www.omniref.com/ruby/gems/debt_ceiling.png)](https://www.omniref.com/ruby/gems/debt_ceiling)
 
 #DebtCeiling
 
-### Work in progress, feedback and PR's appreciated
+Main goal is to enforce a technical debt ceiling and tech debt reduction deadlines for your Ruby project programmatically via a configurable combination of static analysis and/or manual assignment/recognition from explicit source code references as part of your application's test suite.  Eventually perhaps will aid in visualizing this quantification as a graph or graphs, and breaking down debt into various categories and sources.  Currently it highlights the single largest source of debt as a suggestion for reduction, as well out outputting the total quantity, both in test suite integration or by manually running `debt_ceiling` binary.
 
-Main goal is to enforce a technical debt ceiling and tech debt reduction deadlines for your Ruby project programmatically via static analysis as part of your application's test suite.  Eventually perhaps will aid in visualizing tech debt as a graph or graphs (breakind down debt into various categories and sources).
+Travis tests are running on 1.9.3, 2.1.1 and JRuby 1.9 mode.
 
 Current features include:
 * configuring points per [RubyCritic](https://github.com/whitesmith/rubycritic) grade per file line (add FULL_ANALYSIS=true for a lengthier analysis by RubyCritic including churn and more code smells, but same grading logic, made available for use by hooks)
+* Comment added explicit/manual debt assignment, via #TECH DEBT +100 or custom phrases
 * Whitelisting/blacklisting files by matching path/filename
 * Modifying or replacing default calculation on a per file basis
 * Reporting the single greatest source of debt based on your definitions
 * Reporting total debt for the git repo based on your definitions
 * Adding cost for TODOs or deprecated references you specify (see .debt_ceiling.example)
-* Running the binary from a test suite to fail if debt ceiling is exceeded
-* Running the binary from a test suite to fail if debt deadline is missed
+* Running from a test suite to fail if debt ceiling is exceeded
+* Running from a test suite to fail if debt deadline is missed (currently only supports a single deadline, could add support for multiple targets if there's interest)
 
-To integrate in a test suite, use `set_debt_ceiling` and/or `debt_reduction_target_and_date` in your configuration and call `DebtCeiling.calculate(root_dir)` from your test helper as an additional test.  It will exit with a non-zero failure if you exceed your ceiling or miss your target, failing the test suite.
+To integrate in a test suite, set a value for `debt_ceiling` and/or `reduction_target` and `reduction_date` in your configuration and call `DebtCeiling.calculate(root_dir)` from your test helper as an additional test.  It will exit with a non-zero failure if you exceed your ceiling or miss your target, failing the test suite.
 
-These features are largely are demonstrated/discussed in [examples/.debt_ceiling](https://github.com/bglusman/debt_ceiling/blob/master/examples/.debt_ceiling.example) which demonstrates configuring debt ceiling
+These features are largely are demonstrated/discussed in [examples/.debt_ceiling.rb.example](https://github.com/bglusman/debt_ceiling/blob/master/examples/.debt_ceiling.rb.example) which demonstrates configuring debt ceiling
 
 Additional customization is supported via two method hooks in the debt class, which debt_ceiling will load from a provided extension_file_path in the main config file, which should look like the [example file](https://github.com/bglusman/debt_ceiling/blob/master/examples/debt.rb.example)
 
-You can configure/customize the debt calculated using a few simple commands in a .debt_ceiling file in the project's home directory
+You can configure/customize the debt calculated using a few simple commands in a .debt_ceiling.rb file in the project's home directory:
 
 ```
-set_debt_ceiling 500
-#exceeding this will fail a test, if you run debt_ceiling binary from test suite
-debt_reduction_target_and_date 100, 'Jan 1 2015'
-#exceeding this will fail after the target date (parsed by Chronic)
-
-#set the multipliers per line of code in a file with each letter grade
-b_cost_per_line 10
-c_cost_per_line 20
-d_cost_per_line 40
-f_cost_per_line 100
-
-#load custom debt calculations (see examples/debt.rb) from this path
-extension_file_path "./debt.rb"
-
-#only count debt scores for files matching these strings (converted to regexes)
-whitelist_matching %w(app lib)
-
-#or.... exclude debt scores for files matching these strings (obviously mutually exclusive, raises error if both present)
-#blacklist_matching %w(schema.rb routes.rb)
+DebtCeiling.configure do |c|
+  #exceeding this will fail a test, if you run debt_ceiling binary/calculate method from test suite
+  c.debt_ceiling = 500
+  #exceeding this target will fail after the reduction date (parsed by Chronic)
+  c.reduction_target = 100
+  c.reduction_date   = 'Jan 1 2015'
+  #set the multipliers per line of code in a file with each letter grade, these are the current defaults
+  c.grade_points = { a: 0, b: 10, c: 20, d: 40, f: 100 }
+  #load custom debt calculations (see examples/debt.rb) from this path
+  c.extension_path = "./debt.rb"
+  #below two both use same mechanic, todo just assumes capital TODO as string, cost_per_todo defaults to 0
+  c.cost_per_todo  = 50
+  c.deprecated_reference_pairs = { 'DEPRECATED_API' => 20}
+  #manually assign debt to code sections with these or with default "TECH DEBT", as a comment like #TECH DEBT +50
+  c.manual_callouts += ["REFACTOR THIS", "HORRIBLE HACK"]
+  #only count debt scores for files/folders matching these strings (converted to regexes)
+  c.whitelist = %w(app lib)
+  #or
+  #exclude debt scores for files/folders matching these strings (commented as mutually exclusive)
+  #c.blacklist = %w(config version debt_ceiling.rb)
+end
 ```
 
 As mentioned/linked above, additional customization is supported.
 
-As shown in example file, pass a path to `extension_file_path` command pointing to a file defining DebtCeiling::Debt like the one in examples directory, and define its methods for your own additional calculation per file.
-
-Right now it lacks all tests...  feel free to open a PR!
-
-I'll try and add test coverage where it makes sense as API matures.
-
-## TODO: planned features/ideas
-
-todo_cost 500      #cost per comment matching /TODO/
-
-debt_per_reference_to deprecated_regex, 500 # help transition away from deprecated APIs
-
-points_per_regex_match REGEX, 500 # seems like an alias for above maybe, nix?
+As shown in example file, set a path for `extension_path` pointing to a file defining DebtCeiling::Debt like the one in examples directory, and define its methods for your own additional calculation per file.
 
+### Improvement ideas/suggestsions for contributing:
 
-### Other ideas:
+* rubocop/cane integration debt for style violations
 
-rubocop/cane integration debt for style violations
+* default/custom points per reek smell detected (not currently part of rubycritic grading, despite integration)
 
-every line over x ideal file size is y points of debt
+* every line over x ideal file size is y points of debt
 
-multipliers for important files
+* multipliers for important files
 
-visualization/history of debt would be nice, but unclear how to best support...  one possibility is running it against each commit in a repo, and using git-notes to add score data (and some metadata perhaps?) to store it for comparing/graphing, and for comparing branches etc. optionally configured could do this for every commit that doesn't already have a note attached, or for which the note's metadata/version is out of sync with current definitions.
+* command line options to configure options per run/without a .debt_ceiling file (could be done with [ENVied](https://github.com/eval/envied) gem perhaps, or [commander](https://github.com/tj/commander) or [one of these](https://www.ruby-toolbox.com/categories/CLI_Option_Parsers)
 
-include one of the JS complexity/debt analysis libraries below, or another if anyone had another suggestion:
+* visualization/history of debt would be nice, but unclear how to best support...  one possibility is running it against each commit in a repo, and using git-notes to add score data (and some metadata perhaps?) to store it for comparing/graphing, and for comparing branches etc. optionally configured could do this for every commit that doesn't already have a note attached, or for which the note's metadata/version is out of sync with current definitions.
 
-* https://github.com/es-analysis/plato
+* optionally include/integrate with one of these JS analysis libraries, or another if anyone had another suggestion: [plato](https://github.com/es-analysis/plato) [jsprime](https://github.com/dpnishant/jsprime) [doctorjs](https://github.com/mozilla/doctorjs)
 
-* https://github.com/dpnishant/jsprime
+## License
 
-* https://github.com/mozilla/doctorjs
+`debt_ceiling` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
 
-task :default => 'test'
+task default: 'test'
 task :test do
-  sh "ruby test/debt_ceiling_test.rb"
+  sh 'rspec spec'
 end

data/bin/debt_ceiling

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-require_relative "../lib/debt_ceiling"
-DebtCeiling.calculate(ARGV[0] ? ARGV[0] : ".")
+require_relative '../lib/debt_ceiling'
+DebtCeiling.calculate(ARGV[0] ? ARGV[0] : '.')

data/debt_ceiling.gemspec

@@ -1,32 +1,32 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
-require "debt_ceiling/version"
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'debt_ceiling/version'
 
 Gem::Specification.new do |s|
-  s.name        = "debt_ceiling"
+  s.name        = 'debt_ceiling'
   s.version     = DebtCeiling::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Brian Glusman"]
-  s.email       = ["bglusman@shutterstock.com"]
-  s.homepage    = "https://github.com/bglusman/debt_ceiling"
-  s.summary     = "DebtCeiling helps you track Tech Debt"
-  s.rubyforge_project = "debt_ceiling"
-  s.extensions = ["Rakefile"]
+  s.authors     = ['Brian Glusman']
+  s.email       = ['bglusman@shutterstock.com']
+  s.homepage    = 'https://github.com/bglusman/debt_ceiling'
+  s.summary     = 'DebtCeiling helps you track Tech Debt'
+  s.rubyforge_project = 'debt_ceiling'
+  s.extensions = ['Rakefile']
 
   s.description = <<-DESC
     Get a grip on your technical debt
   DESC
 
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  s.add_runtime_dependency "rubycritic", "~> 1.1.1"
-  s.add_runtime_dependency "chronic", "~> 0.10"
-  s.add_development_dependency "pry", '~> 0.10'
-  s.add_development_dependency "rake", '~> 10.3'
-  s.add_development_dependency "minitest", '~> 5.4'
+  s.add_runtime_dependency 'rubycritic', '~> 1.1.1'
+  s.add_runtime_dependency 'chronic', '~> 0.10'
+  s.add_runtime_dependency 'configurations', '~> 2.0.0.pre'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'rspec', '~> 3.1'
 end

data/examples/.debt_ceiling.rb.example

@@ -0,0 +1,27 @@
+DebtCeiling.configure do |c|
+  #exceeding this will fail a test, if you run debt_ceiling binary/calculate method from test suite
+  c.debt_ceiling = 500
+  #exceeding this target will fail after the reduction date (parsed by Chronic)
+  c.reduction_target = 100
+  c.reduction_date   = 'Jan 1 2015'
+  #set the multipliers per line of code in a file with each letter grade, these are the current defaults
+  c.grade_points = { a: 0, b: 10, c: 20, d: 40, f: 100 }
+  #load custom debt calculations (see examples/debt.rb) from this path
+  c.extension_path = "./debt.rb"
+  #below two both use same mechanic, todo just assumes capital TODO as string, cost_per_todo defaults to 0
+  c.cost_per_todo  = 50
+  c.deprecated_reference_pairs = { 'DEPRECATED_API' => 20}
+  #manually assign debt to code sections with these or with default "TECH DEBT", as a comment like #TECH DEBT +50
+  c.manual_callouts += ["REFACTOR THIS", "HORRIBLE HACK"]
+  #only count debt scores for files/folders matching these strings (converted to regexes)
+  c.whitelist = %w(app lib)
+  #or
+  #exclude debt scores for files/folders matching these strings (commented as mutually exclusive)
+  #c.blacklist = %w(config version debt_ceiling.rb)
+end
+
+
+
+
+
+

data/lib/debt_ceiling/accounting.rb

@@ -17,12 +17,13 @@ module DebtCeiling
 
       def construct_debts(modules)
         modules.map do |mod|
+          path            = mod.path
           file_attributes = OpenStruct.new
-          file_attributes.linecount = `wc -l #{mod.path}`.match(/\d+/)[0].to_i
-          file_attributes.path = mod.path
+          file_attributes.linecount = `wc -l #{path}`.match(/\d+/)[0].to_i
+          file_attributes.path = path
           file_attributes.analysed_module = mod
-          file_attributes.source_code = File.read(mod.path)
-          debt_rule = Debt.new(file_attributes)
+          file_attributes.source_code = File.read(path)
+          Debt.new(file_attributes)
         end
       end
 
@@ -30,10 +31,10 @@ module DebtCeiling
         if ENV['FULL_ANALYSIS']
           Rubycritic::Orchestrator.new.critique([path])
         else
-        #temporarily use Rubycritic internals until they provide an API
-          require "rubycritic/modules_initializer"
-          require "rubycritic/analysers/complexity"
-          require "rubycritic/analysers/smells/flay"
+          # temporarily use Rubycritic internals until they provide an API
+          require 'rubycritic/modules_initializer'
+          require 'rubycritic/analysers/complexity'
+          require 'rubycritic/analysers/smells/flay'
 
           modules = Rubycritic::ModulesInitializer.init([path])
           [Rubycritic::Analyser::Complexity, Rubycritic::Analyser::FlaySmells].each do |analyser|

data/lib/debt_ceiling/debt.rb

@@ -1,31 +1,28 @@
+require 'forwardable'
 module DebtCeiling
   class Debt
+    extend Forwardable
     DoNotWhitelistAndBlacklistSimulateneously = Class.new(StandardError)
 
-    attr_reader :file_attributes, :path, :analysed_module, :module_name, :linecount, :source_code
+    attr_reader :file_attributes
+    def_delegators :file_attributes, :path, :analysed_module, :module_name, :linecount, :source_code
+    def_delegator :analysed_module, :rating
     attr_accessor :debt_amount
+    def_delegator :debt_amount, :to_i
+
     def initialize(file_attributes)
       @file_attributes  = file_attributes
-      @path             = file_attributes.path
-      @analysed_module  = file_attributes.analysed_module
-      @module_name      = file_attributes.name
-      @linecount        = file_attributes.linecount
-      @source_code      = file_attributes.source_code
       default_measure_debt if valid_debt?
     end
 
     def default_measure_debt
-      if self.respond_to?(:measure_debt)
-        cost = self.public_send(:measure_debt)
-      end
-      if !cost
-        cost = if self.respond_to?(:augment_debt)
-          self.public_send(:augment_debt) || 0
-        else
-          0
-        end
-        letter_grade = file_attributes.analysed_module.rating.to_s.downcase
-        cost_per_line = DebtCeiling.public_send("#{letter_grade}_current_cost_per_line")
+      cost = public_send(:measure_debt) if self.respond_to?(:measure_debt)
+
+      unless cost
+        cost = public_send(:augment_debt) if respond_to?(:augment_debt)
+        cost = cost.to_i
+        letter_grade = rating.to_s.downcase
+        cost_per_line = DebtCeiling.configuration.grade_points[letter_grade.to_sym]
         cost += file_attributes.linecount * cost_per_line
         cost += debt_from_source_code_rules
       end
@@ -33,43 +30,54 @@ module DebtCeiling
     end
 
     def debt_from_source_code_rules
-      text_match_debt('TODO', DebtCeiling.current_cost_per_todo) +
-      DebtCeiling.deprecated_reference_pairs.map {|string, value|
-        text_match_debt(string, value.to_i) }.inject(&:+).to_i
+      manual_callout_debt +
+      text_match_debt('TODO', DebtCeiling.cost_per_todo) +
+      DebtCeiling.deprecated_reference_pairs
+        .reduce(0) {|accum, (string, value)| accum + text_match_debt(string, value.to_i) }
     end
 
     def text_match_debt(string, cost)
-      source_code.scan(string).count * cost
+      source_code.scan(string).count * cost.to_i
+    end
+
+    def manual_callout_debt
+      DebtCeiling.manual_callouts.reduce(0) do |sum, callout|
+        sum + debt_from_callout(callout)
+      end
+    end
+
+    def debt_from_callout(callout)
+      source_code.each_line.reduce(0) do |sum, line|
+        match_data = line.match(Regexp.new(callout + '.*'))
+        string = match_data.to_s.split(callout).last
+        amount = string.match(/\d+/).to_s if string
+        sum + amount.to_i
+      end
     end
 
     def valid_debt?
       black_empty = DebtCeiling.blacklist.empty?
       white_empty = DebtCeiling.whitelist.empty?
-      raise DoNotWhitelistAndBlacklistSimulateneously if (!black_empty && !white_empty)
+      fail DoNotWhitelistAndBlacklistSimulateneously unless black_empty || white_empty
       (black_empty && white_empty) ||
       (black_empty && self.class.whitelist_includes?(self)) ||
       (white_empty && !self.class.blacklist_includes?(self))
     end
 
     def self.whitelist_includes?(debt)
-      DebtCeiling.whitelist.detect {|filename| filename.match debt.path }
+      DebtCeiling.whitelist.find { |filename| filename.match debt.path }
     end
 
     def self.blacklist_includes?(debt)
-      DebtCeiling.blacklist.detect {|filename| filename.match debt.path }
+      DebtCeiling.blacklist.find { |filename| filename.match debt.path }
     end
 
     def name
       file_attributes.analysed_module.name || path.to_s.split('/').last
     end
 
-    def to_i
-      debt_amount.to_i
-    end
-
     def +(other)
-      self.to_i + other.to_i
+      to_i + other.to_i
     end
-
   end
-end
+end

data/lib/debt_ceiling/version.rb

@@ -1,3 +1,3 @@
 module DebtCeiling
-  VERSION = "0.0.6"
+  VERSION = '0.1.0'
 end

data/lib/debt_ceiling.rb

@@ -1,88 +1,78 @@
+require 'configurations'
+require 'chronic'
 require_relative 'debt_ceiling/accounting'
 require_relative 'debt_ceiling/debt'
-require 'chronic'
 
 module DebtCeiling
+  include Configurations
+  extend Forwardable
   extend self
 
-  def calculate(dir=".")
-    if File.exists?(Dir.pwd + '/.debt_ceiling')
-       File.open(Dir.pwd + "/.debt_ceiling") {|f| DebtCeiling.module_eval(f.read)}
-    elsif File.exists?(Dir.home + '/.debt_ceiling')
-       File.open(Dir.home + '/.debt_ceiling') {|f| DebtCeiling.module_eval(f.read)}
+  attr_reader :debt
+  def_delegator :configuration, :extension_path
+  def_delegator :configuration, :blacklist
+  def_delegator :configuration, :whitelist
+  def_delegator :configuration, :cost_per_todo
+  def_delegator :configuration, :deprecated_reference_pairs
+  def_delegator :configuration, :manual_callouts
+  def_delegator :configuration, :grade_points
+  def_delegator :configuration, :reduction_date
+  def_delegator :configuration, :reduction_target
+  def_delegator :configuration, :debt_ceiling
+
+  configuration_defaults do |c|
+    c.extension_path = "#{Dir.pwd}/debt.rb"
+    c.blacklist = []
+    c.whitelist = []
+    c.deprecated_reference_pairs = {}
+    c.manual_callouts = ['TECH DEBT']
+    c.grade_points = { a: 0, b: 10, c: 20, d: 40, f: 100 }
+  end
+
+  def load_configuration
+    if File.exist?(Dir.pwd + '/.debt_ceiling.rb')
+      load(Dir.pwd + '/.debt_ceiling.rb')
+    elsif File.exist?(Dir.home + '/.debt_ceiling.rb')
+      load(Dir.home + '/.debt_ceiling.rb')
     else
-      puts "No .debt_ceiling configuration file detected in #{Dir.pwd} or ~/, using defaults"
+      puts "No .debt_ceiling.rb configuration file detected in #{Dir.pwd} or ~/, using defaults"
     end
 
-    extension_path = DebtCeiling.current_extension_file_path
-    load extension_path if extension_path && File.exists?(extension_path)
+    load extension_path if extension_path && File.exist?(extension_path)
+    @loaded = true
+  end
 
+  def calculate(dir = '.', opts={preconfigured: false})
+    load_configuration unless @loaded || opts[:preconfigured]
     @debt = DebtCeiling::Accounting.calculate(dir)
     evaluate
   end
 
-  @extension_file_path = "#{Dir.pwd}/debt.rb"
-  def extension_file_path(path)
-    @extension_file_path = path
-  end
-
-  def current_extension_file_path
-    @extension_file_path
-  end
-
   def blacklist_matching(matchers)
-    @blacklist = matchers.map {|matcher| Regexp.new(matcher)}
+    @blacklist = matchers.map { |matcher| Regexp.new(matcher) }
   end
 
   def whitelist_matching(matchers)
-    @whitelist =  matchers.map {|matcher| Regexp.new(matcher)}
+    @whitelist =  matchers.map { |matcher| Regexp.new(matcher) }
   end
 
-  def set_debt_ceiling(value)
-    @ceiling_amount = value
-  end
-
-  def cost_per_todo(value)
-    @current_cost_per_todo = value.to_i
-  end
 
   def debt_per_reference_to(string, value)
     deprecated_reference_pairs[string] = value
   end
 
-  def debt_reduction_target_and_date(target_value, date_to_parse)
-    @reduction_target = target_value
-    @reduction_date   = Chronic.parse(date_to_parse)
-  end
 
   def evaluate
-    if ceiling_amount && ceiling_amount <= debt
+    if debt_ceiling && debt_ceiling <= debt
       fail_test
     elsif reduction_target && reduction_target <= debt &&
           Time.now > reduction_date
       fail_test
     end
+    debt
   end
 
   def fail_test
     Kernel.exit 1
   end
-
-  attr_reader :blacklist, :whitelist, :ceiling_amount, :reduction_date, :reduction_target,
-              :debt, :current_cost_per_todo, :deprecated_reference_pairs
-  @blacklist = []
-  @whitelist = []
-  @current_cost_per_todo = 0
-  @deprecated_reference_pairs = {}
-
-  GRADE_MAP = {a: 0, b: 10, c: 20, d: 40, f: 100} #arbitrary default grades for now
-  GRADE_MAP.keys.each do |grade|
-    instance_variable_set "@#{grade}_cost_per_line", GRADE_MAP[grade]
-    define_method("#{grade}_current_cost_per_line") do
-      instance_variable_get "@#{grade}_cost_per_line"
-    end
-    define_method("#{grade}_cost_per_line") do |value| #def set methods, no =
-      instance_variable_set "@#{grade}_cost_per_line", value
-    end
-  end
 end

data/spec/debt_ceiling_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'debt_ceiling'
+
+describe DebtCeiling do
+  it 'has failing exit status when debt_ceiling is exceeded' do
+    DebtCeiling.configure {|c| c.debt_ceiling = 0 }
+    expect(DebtCeiling.debt_ceiling).to eq(0)
+    expect { DebtCeiling.calculate('.', preconfigured: true) }.to raise_error
+  end
+
+  it 'has failing exit status when target debt reduction is missed' do
+    DebtCeiling.configure {|c| c.reduction_target =0; c.reduction_date =  Time.now.to_s }
+    expect(DebtCeiling.debt_ceiling).to eq(nil)
+    expect { DebtCeiling.calculate('.', preconfigured: true) }.to raise_error
+  end
+
+  it 'returns quantity of total debt' do
+    expect(DebtCeiling.calculate('.')).to be > 5 # arbitrary non-zero amount
+  end
+
+  it 'adds debt for todos with specified value' do
+    todo_amount = 50
+    DebtCeiling.configure {|c| c.cost_per_todo = todo_amount }
+    expect(DebtCeiling.calculate('spec/support/todo_example.rb')).to be todo_amount
+  end
+
+  it 'allows manual debt with TECH DEBT comment' do
+    expect(DebtCeiling.calculate('spec/support/manual_example.rb')).to be 100 # hardcoded in example file
+  end
+
+  it 'allows manual debt with arbitrarily defined comment' do
+    DebtCeiling.configure {|c| c.manual_callouts += ['REFACTOR'] }
+    expect(DebtCeiling.calculate('spec/support/manual_example.rb')).to be 150 # hardcoded in example file
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.before { allow($stdout).to receive(:puts) }
+  config.after(:each) { DebtCeiling.configure {|c| c.debt_ceiling = nil; c.reduction_target = nil; c.reduction_date = nil } }
+end

data/spec/support/manual_example.rb

@@ -0,0 +1,4 @@
+class Whatever
+  # TECH DEBT + 100
+  # REFACTOR + 50
+end

data/spec/support/todo_example.rb

@@ -0,0 +1,3 @@
+class Whatever
+  # TODO add some points for this line
+end

metadata

@@ -1,87 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: configurations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '5.4'
-description: |2
-      Get a grip on your technical debt
+        version: '3.1'
+description: ! '    Get a grip on your technical debt
+
+'
 email:
 - bglusman@shutterstock.com
 executables:
@@ -90,43 +118,48 @@ extensions:
 - Rakefile
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
+- MIT-LICENSE.md
 - README.md
 - Rakefile
 - bin/debt_ceiling
 - debt_ceiling.gemspec
-- examples/.debt_ceiling.example
+- examples/.debt_ceiling.rb.example
 - examples/debt.rb.example
 - lib/debt_ceiling.rb
 - lib/debt_ceiling/accounting.rb
 - lib/debt_ceiling/debt.rb
 - lib/debt_ceiling/version.rb
-- test/debt_ceiling_test.rb
-- test/test_helper.rb
+- spec/debt_ceiling_spec.rb
+- spec/spec_helper.rb
+- spec/support/manual_example.rb
+- spec/support/todo_example.rb
 homepage: https://github.com/bglusman/debt_ceiling
 licenses: []
-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'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: debt_ceiling
-rubygems_version: 2.2.2
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: DebtCeiling helps you track Tech Debt
 test_files: []
 has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: bea87b2ccec435c3759009586048f178a40d963f
-  data.tar.gz: 9538baf4d664690d4deb022db375f1a024471a2c
-SHA512:
-  metadata.gz: 9545baeb0a2fb3f1f5bb21d3642d3e63d7aae32a9124dce6bfd11a3536a8e177f5854c37917fda715439702d18f088b97a0134c75bc9d904685d497c84fe4a9f
-  data.tar.gz: ed0148e021b41fa1618abf56458068a7afa1d01ee959c316987ea5f4198170a812d5a15db9ac88bb1b50295f52a7055ced1130e401139087ac1ac20db569cf47

data/examples/.debt_ceiling.example

@@ -1,25 +0,0 @@
-set_debt_ceiling 500
-#exceeding this will fail a test, if you run debt_ceiling binary from test suite
-debt_reduction_target_and_date 100, 'Jan 1 2015'
-#exceeding this will fail after the target date (parsed by Chronic)
-
-#set the multipliers per line of code in a file with each letter grade
-b_cost_per_line 10
-c_cost_per_line 20
-d_cost_per_line 40
-f_cost_per_line 100
-
-#load custom debt calculations (see examples/debt.rb) from this path
-extension_file_path "./debt.rb"
-
-#below two both same mechanic, todo just assumes capital TODO as string
-cost_per_todo 50
-
-debt_per_reference_to 'DEPRECATED_API', 20
-
-
-#only count debt scores for file paths matching these strings (converted to regexes)
-whitelist_matching %w(app lib)
-#or
-#exclude debt scores for files matching these strings (commented as mutually exclusive)
-#blacklist_matching %w(schema.rb routes.rb)

data/test/debt_ceiling_test.rb

@@ -1,5 +0,0 @@
-require_relative 'test_helper'
-
-module DebtCeiling
-
-end

data/test/test_helper.rb

@@ -1,3 +0,0 @@
-require_relative '../lib/debt_ceiling'
-require 'minitest/spec'
-require 'minitest/autorun'