debt_ceiling 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50413717fff100682e4d62f350b6b0625c92f5bf
-  data.tar.gz: 17ad97252626d36a70b221725fd7213962951dd6
+  metadata.gz: 1f143bb4a889c52ce57b69ee02ecaa062dde87eb
+  data.tar.gz: d31f7da0e0e5221bb10dbbb2db7f382cdcc6f603
 SHA512:
-  metadata.gz: 9cb9b3b28fa5aa7f3b09e832b7b279412181d71157e7ac4cbd9f8bc4e5fb2d3d7cc759a76806aad8193bb9f997e15d9ec732a617d65619ff620081fd6131d4ae
-  data.tar.gz: 76afab03d0406fe9a1988ec25e648629afea95702e9356645073253b325d00a28b6cde6ea74169fd36dcc43805a97c6216e1cbeb14a97f5695083b24190da677
+  metadata.gz: 93f9335622c57589b9d7de6a207074af558b2e111dd2056351e7db133eee7c8dfa40a99627e884ad4b408758720fbd81d1abf15933b185e052a1cc6661b84f90
+  data.tar.gz: 57423abb6795759193d1e27c064e4ec9bfe83a2b2efe32bddb10ed7dfedeb73aa64449e21d054f892ce887696e1a104241a1bf238fc476c25325c087af2a08b3

data/README.md

@@ -1,8 +1,8 @@
-[![Gem Version](https://badge.fury.io/rb/debt_ceiling.svg)](http://badge.fury.io/rb/debt_ceiling) 
+[![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)
-[![Coverage Status](https://img.shields.io/coveralls/bglusman/debt_ceiling.svg)](https://coveralls.io/r/bglusman/debt_ceiling?branch=master) 
-[![Debt Ceiling Chat](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/bglusman/debt_ceiling) 
-[![Stories in Ready](https://badge.waffle.io/bglusman/debt_ceiling.png?label=ready&title=Ready)](https://waffle.io/bglusman/debt_ceiling) 
+[![Coverage Status](https://img.shields.io/coveralls/bglusman/debt_ceiling.svg)](https://coveralls.io/r/bglusman/debt_ceiling?branch=master)
+[![Debt Ceiling Chat](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/bglusman/debt_ceiling)
+[![Stories in Ready](https://badge.waffle.io/bglusman/debt_ceiling.png?label=ready&title=Ready)](https://waffle.io/bglusman/debt_ceiling)
 [![Code Climate](https://codeclimate.com/github/bglusman/debt_ceiling/badges/gpa.svg)](https://codeclimate.com/github/bglusman/debt_ceiling)
 #DebtCeiling
 
@@ -21,7 +21,18 @@ Current features include:
 * 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, 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.
+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.audit(root_dir)` from your test helper as an additional test, or drop the configuration directly in your spec helper as debt ceiling does to calculate it's own debt:
+```ruby
+  config.after(:all) do
+    DebtCeiling.configure do |c|
+      c.whitelist = %w(app lib)
+      c.max_debt_per_module = 150
+      c.debt_ceiling = 250
+    end
+    DebtCeiling.audit('.', preconfigured: true)
+  end
+```
+  It will exit with a non-zero failure if you exceed your ceiling(s) or miss your target, failing the test suite.
 
 These features are largely demonstrated/discussed in [examples/.debt_ceiling.rb.example](https://github.com/bglusman/debt_ceiling/blob/master/examples/.debt_ceiling.rb.example) or below snippet which demonstrates configuring debt ceiling around a team or maintainer's agreed ideas about how to quantify debt automatically and/or manually in the project source code.
 
@@ -63,12 +74,8 @@ As shown in example file, set a path for `extension_path` pointing to a file def
 
 * default/custom points per reek smell detected (not currently part of RubyCritic grading, but available in full analysis)
 
-* every line over x ideal file size is y points of debt
-
 * multipliers for important files
 
-* `debt_ceiling_per_file` option to cap max debt for any one analyzed module
-
 * command line options to configure options per run/without a `.debt_ceiling.rb` 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)
 
 * 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.

data/bin/debt_ceiling

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

data/debt_ceiling.gemspec

@@ -30,5 +30,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.3'
   s.add_development_dependency 'rspec', '~> 3.1'
   s.add_development_dependency 'coveralls', '~> 0.7'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
 end

data/examples/.debt_ceiling.rb.example

@@ -3,7 +3,7 @@ DebtCeiling.configure do |c|
   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'
+  c.reduction_date   = 'Jan 1 2016'
   #Max debt to allow in any one file/module before failing tests
   c.max_debt_per_module = 200
 
@@ -16,14 +16,14 @@ DebtCeiling.configure do |c|
   #set the base cost per file for each letter grade, these are the current defaults
   c.grade_points = { a: 0, b: 3, c: 13, d: 55, f: 144 }
   #default multiplier for debt factors from flog, flay, reek and method count
-  c.complexity_multiplier = 0.5
-  c.method_count_multiplier = 0.5
-  c.smells_multiplier = 3
-  c.duplication_multiplier = 1.5
-  c.ideal_max_line_count   = 100
+  c.complexity_multiplier    = 0.5
+  c.method_count_multiplier  = 0.5
+  c.smells_multiplier        = 3
+  c.duplication_multiplier   = 1.5
+  c.ideal_max_line_count     = 100
   c.cost_per_line_over_ideal = 1
-  #load custom debt calculations (see examples/debt.rb) from this path
-  c.extension_path = "./debt.rb"
+  #load custom debt calculations (see examples/custom_debt.rb) from this path
+  c.extension_path = "./custom_debt.rb"
   #below two both use same mechanic, cost_per_todo just assumes capital
   #TODO as string, cost_per_todo defaults to 0
   c.cost_per_todo  = 50

data/examples/{debt.rb.example → custom_debt.rb.example}

@@ -1,5 +1,5 @@
 module DebtCeiling
-  class Debt
+  class CustomDebt
     #replace the DebtCeiling cost calculation per file with your own
 
 
@@ -14,7 +14,7 @@ module DebtCeiling
       #output additional cost beyond defaults based on #file_attributes
     end
 
-    #augment_debt is only called if measure_debt is undefined or returns nil/false 
+    #augment_debt is only called if measure_debt is undefined or returns nil/false
     #for this instance of debt (which is 1:1 mapping of Rubycritic::AnalysedModule at the moment)
   end
 end

data/lib/debt_ceiling/accounting.rb

@@ -2,57 +2,52 @@ module DebtCeiling
   class Accounting
     DebtCeilingExceeded  = Class.new(StandardError)
     TargetDeadlineMissed = Class.new(StandardError)
-    class << self
-      attr_reader :result, :path
-      def calculate(path)
-        @path = path
-        print_results
-        result
-      end
-
-      def result
-        @result ||= result_from_analysed_modules(construct_rubycritic_modules(path))
-      end
-
-      def clear
-        @result = nil
-      end
-
-      def result_from_analysed_modules(analysed_modules)
-        analysis            = OpenStruct.new
-        analysis.debts      = analysed_modules.map {|mod| Debt.new(FileAttributes.new(mod)) }
-        analysis.max_debt   = analysis.debts.max_by(&:to_i)
-        analysis.total_debt = analysis.debts.map(&:to_i).reduce(:+)
-        analysis
-      end
-
-      def print_results
-        puts <<-RESULTS
-          Current total tech debt: #{result.total_debt}
-          Largest source of debt is: #{max_debt.name} at #{max_debt.to_i}
-          The rubycritic grade for that debt is: #{max_debt.letter_grade}
-          The flog complexity for that debt is: #{max_debt.analysed_module.complexity}
-          Flay suspects #{max_debt.analysed_module.duplication.to_i} areas of code duplication
-          There are #{method_count} methods and #{smell_count} smell(s) from reek.
-          The file is #{max_debt.linecount} lines long.
-        RESULTS
-      end
-
-      def max_debt
-        result.max_debt
-      end
-
-      def method_count
-        max_debt.analysed_module.methods_count
-      end
-
-      def smell_count
-        max_debt.analysed_module.smells.count
-      end
-
-      def construct_rubycritic_modules(path)
-        Rubycritic.create(mode: :ci, format: :json, paths: Array(path)).critique
-      end
+    extend Forwardable
+    attr_reader :result, :path, :debts, :total_debt, :max_debt
+
+    def_delegator :max_debt, :analysed_module
+    alias_method :max_module, :analysed_module
+    def initialize(path)
+      @path = path
+      calc_debt_for_modules(construct_rubycritic_modules(path))
+    end
+
+    def calc_debt_for_modules(analysed_modules)
+      @debts      = analysed_modules.map {|mod| Debt.new(FileAttributes.new(mod)) }
+      @total_debt = get_total_debt
+      @max_debt   = get_max_debt
+    end
+
+    def print_results
+      puts <<-RESULTS
+        Current total tech debt: #{total_debt}
+        Largest source of debt is: #{max_debt.name} at #{max_debt.to_i}
+        The rubycritic grade for that debt is: #{max_debt.letter_grade}
+        The flog complexity for that debt is: #{max_module.complexity}
+        Flay suspects #{max_module.duplication.to_i} areas of code duplication
+        There are #{method_count} methods and #{smell_count} smell(s) from reek.
+        The file is #{max_debt.linecount} lines long.
+      RESULTS
+    end
+
+    def get_max_debt
+      debts.max_by(&:to_i)
+    end
+
+    def get_total_debt
+      debts.map(&:to_i).reduce(:+)
+    end
+
+    def method_count
+      max_module.methods_count
+    end
+
+    def smell_count
+      max_module.smells.count
+    end
+
+    def construct_rubycritic_modules(path)
+      Rubycritic.create(mode: :ci, format: :json, paths: Array(path)).critique
     end
   end
 end

data/lib/debt_ceiling/audit.rb

@@ -0,0 +1,80 @@
+module DebtCeiling
+  class Audit
+    extend Forwardable
+    include CommonMethods
+    undef :+
+
+    CONFIG_FILE_NAME = ".debt_ceiling.rb"
+    CONFIG_LOCATIONS = ["#{Dir.pwd}/#{CONFIG_FILE_NAME}", "#{Dir.home}/#{CONFIG_FILE_NAME}"]
+    NO_CONFIG_FOUND  = "No #{CONFIG_FILE_NAME} configuration file detected in #{Dir.pwd} or ~/, using defaults"
+
+    attr_reader :accounting, :dir, :loaded
+
+    def_delegators :configuration,
+                   :extension_path, :debt_ceiling, :reduction_target, :reduction_date, :max_debt_per_module
+
+    def_delegator :accounting, :total_debt
+
+    def initialize(dir = '.', opts = {})
+      @loaded     = opts[:preconfigured]
+      @dir        = dir
+      @accounting = perform_accounting
+      accounting.print_results unless opts[:skip_report]
+      fail_test if failed_condition?
+    end
+
+    private
+
+    def load_configuration
+      config_file_location ? load(config_file_location) : puts(NO_CONFIG_FOUND)
+
+      load extension_path if extension_path && File.exist?(extension_path)
+      @loaded = true
+    end
+
+    def config_file_location
+      CONFIG_LOCATIONS.find {|loc| File.exist?(loc) }
+    end
+
+    def perform_accounting
+      load_configuration unless loaded
+      Accounting.new(dir)
+    end
+
+    def blacklist_matching(matchers)
+      @blacklist = matchers.map { |matcher| Regexp.new(matcher) }
+    end
+
+    def whitelist_matching(matchers)
+      @whitelist =  matchers.map { |matcher| Regexp.new(matcher) }
+    end
+
+
+    def debt_per_reference_to(string, value)
+      deprecated_reference_pairs[string] = value
+    end
+
+    def failed_condition?
+      exceeded_total_limit? || missed_target? || max_debt_per_module_exceeded?
+    end
+
+    def exceeded_total_limit?
+      debt_ceiling && debt_ceiling <= total_debt
+    end
+
+    def missed_target?
+      reduction_target && reduction_target <= total_debt &&
+            Time.now > Chronic.parse(reduction_date)
+    end
+
+    def max_debt_per_module_exceeded?
+      max_debt_per_module && max_debt_per_module <= accounting.max_debt.to_i
+    end
+
+    def fail_test
+      at_exit do
+        Kernel.exit 1
+      end
+    end
+  end
+end

data/lib/debt_ceiling/common_methods.rb

@@ -0,0 +1,13 @@
+module DebtCeiling
+  module CommonMethods
+
+    def configuration
+      DebtCeiling.configuration
+    end
+
+    def +(other)
+      self.to_i + other.to_i
+    end
+
+  end
+end

data/lib/debt_ceiling/{custom_debt_analysis.rb → custom_debt.rb}

@@ -1,17 +1,40 @@
 module DebtCeiling
-  module CustomDebtAnalysis
+  class CustomDebt
+    extend Forwardable
+    include CommonMethods
+
+    def_delegators :configuration,
+                   :deprecated_reference_pairs, :manual_callouts, :cost_per_todo
+
+    def_delegator :file_attributes, :source_code
+
+    def_delegator  :debt_amount, :to_i
+
+    def initialize(file_attributes)
+      @file_attributes  = file_attributes
+      @debt_amount      = default_measure_debt
+    end
+
+    private
+
+    attr_reader :file_attributes, :debt_amount
 
     def external_measure_debt
       public_send(:measure_debt) if self.respond_to?(:measure_debt)
     end
 
+    def default_measure_debt
+      external_measure_debt || debt_from_source_code_rules
+    end
+
     def external_augmented_debt
       (public_send(:augment_debt) if respond_to?(:augment_debt)).to_i
     end
 
+
     def debt_from_source_code_rules
       manual_callout_debt +
-      text_match_debt('TODO', DebtCeiling.cost_per_todo) +
+      text_match_debt('TODO', cost_per_todo) +
       deprecated_reference_debt
     end
 
@@ -20,13 +43,13 @@ module DebtCeiling
     end
 
     def manual_callout_debt
-      DebtCeiling.manual_callouts.reduce(0) do |sum, callout|
+      manual_callouts.reduce(0) do |sum, callout|
         sum + debt_from_callout(callout)
       end
     end
 
     def deprecated_reference_debt
-      DebtCeiling.deprecated_reference_pairs
+      deprecated_reference_pairs
         .reduce(0) {|accum, (string, value)| accum + text_match_debt(string, value.to_i) }
     end
 
@@ -38,14 +61,5 @@ module DebtCeiling
         sum + amount.to_i
       end
     end
-
-    def valid_debt?
-      black_empty = DebtCeiling.blacklist.empty?
-      white_empty = DebtCeiling.whitelist.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
   end
 end

data/lib/debt_ceiling/debt.rb

@@ -1,28 +1,27 @@
-require 'forwardable'
 module DebtCeiling
   class Debt
     extend Forwardable
-    include CustomDebtAnalysis
+    include CommonMethods
     DoNotWhitelistAndBlacklistSimulateneously = Class.new(StandardError)
 
-    def_delegators :file_attributes, :path, :analysed_module, :module_name, :linecount, :source_code
-    def_delegators :non_grade_scoring, :complexity_multiplier, :duplication_multiplier, :smells_multiplier,
-                   :method_count_multiplier, :ideal_max_line_count, :cost_per_line_over_ideal
+    def_delegators :file_attributes,
+                   :path, :analysed_module, :module_name, :linecount, :source_code
+    def_delegators :configuration,
+                  :whitelist, :blacklist
+
     def_delegator :analysed_module, :rating
-    attr_accessor :debt_amount
     def_delegator :debt_amount, :to_i
 
     def initialize(file_attributes)
       @file_attributes  = file_attributes
-      default_measure_debt if valid_debt?
+      if valid_debt?
+        debt_components = configuration.debt_types.map {|type| type.new(file_attributes) }
+        @debt_amount    = debt_components.reduce(&:+)
+      end
     end
 
     def name
-      file_attributes.analysed_module.name || path.to_s.split('/').last
-    end
-
-    def +(other)
-      to_i + other.to_i
+      analysed_module.name || path.to_s.split('/').last
     end
 
     def letter_grade
@@ -31,54 +30,27 @@ module DebtCeiling
 
     private
 
-    attr_reader :file_attributes
-
-    def default_measure_debt
-      self.debt_amount = external_measure_debt || internal_measure_debt
-    end
+    attr_reader :file_attributes, :debt_amount
 
     def internal_measure_debt
-      external_augmented_debt +
-      cost_from_static_analysis_points +
-      debt_from_source_code_rules
-    end
-
-    def cost_from_static_analysis_points
-      DebtCeiling.grade_points[letter_grade] + cost_from_non_grade_scoring
-    end
-
-    def cost_from_non_grade_scoring
-      flog_flay_debt + method_count_debt + smells_debt + line_count_debt
-    end
-
-    def smells_debt
-      analysed_module.smells.map(&:cost).inject(0, :+) * smells_multiplier
-    end
-
-    def method_count_debt
-      analysed_module.methods_count * method_count_multiplier
-    end
-
-    def flog_flay_debt
-      analysed_module.complexity *  complexity_multiplier +
-      analysed_module.duplication * duplication_multiplier
-    end
-
-    def line_count_debt
-      excess_lines = linecount - ideal_max_line_count
-      excess_lines > 0 ? excess_lines * cost_per_line_over_ideal : 0
+      debt_types.reduce(&:+)
     end
 
-    def non_grade_scoring
-      DebtCeiling
+    def whitelist_includes?(debt)
+      whitelist.find { |filename| debt.path.match filename }
     end
 
-    def self.whitelist_includes?(debt)
-      DebtCeiling.whitelist.find { |filename| debt.path.match filename }
+    def blacklist_includes?(debt)
+      blacklist.find { |filename| debt.path.match filename }
     end
 
-    def self.blacklist_includes?(debt)
-      DebtCeiling.blacklist.find { |filename| debt.path.match filename }
+    def valid_debt?
+      black_empty = blacklist.empty?
+      white_empty = whitelist.empty?
+      fail DoNotWhitelistAndBlacklistSimulateneously unless black_empty || white_empty
+      (black_empty && white_empty) ||
+      (black_empty && whitelist_includes?(self)) ||
+      (white_empty && !blacklist_includes?(self))
     end
   end
 end

data/lib/debt_ceiling/static_analysis_debt.rb

@@ -0,0 +1,58 @@
+module DebtCeiling
+  class StaticAnalysisDebt
+    extend Forwardable
+    include CommonMethods
+    def_delegators :configuration,
+                   :complexity_multiplier, :duplication_multiplier, :smells_multiplier,
+                   :grade_points, :method_count_multiplier, :ideal_max_line_count,
+                   :cost_per_line_over_ideal
+
+    def_delegators :analysed_module,
+                   :smells, :methods_count, :complexity, :duplication, :rating
+
+    def_delegators :file_attributes,
+                   :analysed_module, :linecount
+
+    def_delegator  :debt_amount, :to_i
+
+    def initialize(file_attributes)
+      @file_attributes  = file_attributes
+      @debt_amount      = cost_from_static_analysis_points
+    end
+
+    private
+
+    attr_reader :file_attributes, :debt_amount
+
+    def cost_from_static_analysis_points
+      grade_points[letter_grade] + cost_from_non_grade_scoring
+    end
+
+    def cost_from_non_grade_scoring
+      flog_flay_debt + method_count_debt + smells_debt + line_count_debt
+    end
+
+    def letter_grade
+      rating.to_s.downcase.to_sym
+    end
+
+    def smells_debt
+      smells.map(&:cost).inject(0, :+) * smells_multiplier
+    end
+
+    def method_count_debt
+      methods_count * method_count_multiplier
+    end
+
+    def flog_flay_debt
+      complexity *  complexity_multiplier +
+      duplication * duplication_multiplier
+    end
+
+    def line_count_debt
+      excess_lines = linecount - ideal_max_line_count
+      excess_lines > 0 ? excess_lines * cost_per_line_over_ideal : 0
+    end
+
+  end
+end

data/lib/debt_ceiling/version.rb

@@ -1,3 +1,3 @@
 module DebtCeiling
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/debt_ceiling.rb

@@ -3,8 +3,12 @@ require 'chronic'
 require 'rubycritic'
 require 'rubycritic/cli/application'
 require 'ostruct'
+require 'forwardable'
+require_relative 'debt_ceiling/common_methods'
+require_relative 'debt_ceiling/audit'
 require_relative 'debt_ceiling/accounting'
-require_relative 'debt_ceiling/custom_debt_analysis'
+require_relative 'debt_ceiling/custom_debt'
+require_relative 'debt_ceiling/static_analysis_debt'
 require_relative 'debt_ceiling/debt'
 require_relative 'debt_ceiling/compatibility'
 require_relative 'debt_ceiling/file_attributes'
@@ -13,18 +17,12 @@ module DebtCeiling
   include Configurations
   extend Forwardable
   extend self
-
-  attr_reader :total_debt, :accounting_result
-
-  def_delegators :configuration, :extension_path, :blacklist, :whitelist,
-                 :cost_per_todo, :deprecated_reference_pairs, :manual_callouts,
-                 :grade_points, :reduction_date, :reduction_target, :debt_ceiling,
-                 :max_debt_per_module, :non_grade_scoring, :complexity_multiplier ,
-                 :method_count_multiplier, :smells_multiplier, :duplication_multiplier,
-                 :ideal_max_line_count, :cost_per_line_over_ideal
+  def_delegators :configuration,
+                 :extension_path, :blacklist, :whitelist, :max_debt_per_module, :reduction_date,
+                 :reduction_target, :debt_ceiling
 
   configuration_defaults do |config|
-    config.extension_path = "#{Dir.pwd}/debt.rb"
+    config.extension_path = "#{Dir.pwd}/custom_debt.rb"
     config.blacklist = []
     config.whitelist = []
     config.deprecated_reference_pairs = {}
@@ -36,78 +34,11 @@ module DebtCeiling
     config.duplication_multiplier   = 1.5
     config.ideal_max_line_count     = 100
     config.cost_per_line_over_ideal = 1
-    #smells are pretty valid/fixable, complexity and method count
-    #may be inherent/way to improve smells
-  end
-
-
-  def calculate(dir = '.', opts={preconfigured: false})
-    @total_debt = accounting_result(dir, opts).total_debt
-    fail_test if failed_condition?
-    total_debt
-  end
-
-  def accounting_result(dir = '.', opts={preconfigured: false})
-    @accounting_result ||= begin
-      load_configuration unless @loaded || opts[:preconfigured]
-      Accounting.calculate(dir)
-    end
-  end
-
-  def load_configuration(config_file_name=".debt_ceiling.rb")
-    pwd = Dir.pwd
-    home = Dir.home
-    if File.exist?("#{pwd}/#{config_file_name}")
-      load("#{pwd}/#{config_file_name}")
-    elsif File.exist?("#{home}/#{config_file_name}")
-      load("#{home}/#{config_file_name}")
-    else
-      puts "No #{config_file_name} configuration file detected in #{pwd} or ~/, using defaults"
-    end
-
-    load extension_path if extension_path && File.exist?(extension_path)
-    @loaded = true
-  end
-
-  def clear
-    @accounting_result = nil
-    Accounting.clear
-  end
-
-  private
-
-
-  def blacklist_matching(matchers)
-    @blacklist = matchers.map { |matcher| Regexp.new(matcher) }
-  end
-
-  def whitelist_matching(matchers)
-    @whitelist =  matchers.map { |matcher| Regexp.new(matcher) }
-  end
-
-
-  def debt_per_reference_to(string, value)
-    deprecated_reference_pairs[string] = value
+    config.debt_types               = [CustomDebt, StaticAnalysisDebt]
   end
 
-  def failed_condition?
-    exceeded_total_limit? || missed_target? || max_debt_per_module_exceeded?
-  end
-
-  def exceeded_total_limit?
-    debt_ceiling && debt_ceiling <= total_debt
-  end
-
-  def missed_target?
-    reduction_target && reduction_target <= total_debt &&
-          Time.now > Chronic.parse(reduction_date)
-  end
-
-  def max_debt_per_module_exceeded?
-    max_debt_per_module && max_debt_per_module <= accounting_result.max_debt.to_i
-  end
 
-  def fail_test
-    Kernel.exit 1
+  def audit(dir, opts= {})
+    Audit.new(dir, opts)
   end
-end
+end

data/spec/debt_ceiling_spec.rb

@@ -5,43 +5,46 @@ 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
+    expect_any_instance_of(DebtCeiling::Audit).to receive(:fail_test)
+    DebtCeiling.audit('.', preconfigured: true)
   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(SystemExit)
+    expect_any_instance_of(DebtCeiling::Audit).to receive(:fail_test)
+    DebtCeiling.audit('.', preconfigured: true)
   end
 
   it 'has failing exit status when max debt per modile is exceeded' do
     DebtCeiling.configure {|c| c.max_debt_per_module =5 }
     expect(DebtCeiling.debt_ceiling).to eq(nil)
-    expect { DebtCeiling.calculate('.', preconfigured: true) }.to raise_error(SystemExit)
+    expect_any_instance_of(DebtCeiling::Audit).to receive(:fail_test)
+    DebtCeiling.audit('.', preconfigured: true)
   end
 
   it 'returns quantity of total debt' do
-    expect(DebtCeiling.calculate('.')).to be > 5 # arbitrary non-zero amount
+    expect(DebtCeiling.audit('.').total_debt).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
+    expect(DebtCeiling.audit('spec/support/todo_example.rb').total_debt).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
+    expect(DebtCeiling.audit('spec/support/manual_example.rb').total_debt).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
+    expect(DebtCeiling.audit('spec/support/manual_example.rb').total_debt).to be 150 # hardcoded in example file
   end
 
   it 'assigns debt for file length over ideal file size' do
     DebtCeiling.configure {|c| c.ideal_max_line_count = 10; c.cost_per_line_over_ideal = 100 }
-    expect(DebtCeiling.calculate('spec/support/long_file_example.rb', preconfigured: true)).to be 300 # hardcoded 13 lines long example file
+    expect(DebtCeiling.audit('spec/support/long_file_example.rb', preconfigured: true).total_debt).to be 300 # hardcoded 13 lines long example file
   end
 
 end

data/spec/spec_helper.rb

@@ -1,17 +1,15 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
 require 'coveralls'
 Coveralls.wear!
 
 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 } ; DebtCeiling.clear }
+  config.after(:each) { DebtCeiling.configure {|c| c.debt_ceiling = nil; c.reduction_target = nil; c.reduction_date = nil } }
   config.after(:all) do
     DebtCeiling.configure do |c|
       c.whitelist = %w(app lib)
       c.max_debt_per_module = 150
-      c.debt_ceiling = 300
+      c.debt_ceiling = 250
     end
-    DebtCeiling.calculate('.')
+    DebtCeiling.audit('.', preconfigured: true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -108,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 description: |2
       Get a grip on your technical debt
 email:
@@ -142,13 +128,16 @@ files:
 - bin/debt_ceiling
 - debt_ceiling.gemspec
 - examples/.debt_ceiling.rb.example
-- examples/debt.rb.example
+- examples/custom_debt.rb.example
 - lib/debt_ceiling.rb
 - lib/debt_ceiling/accounting.rb
+- lib/debt_ceiling/audit.rb
+- lib/debt_ceiling/common_methods.rb
 - lib/debt_ceiling/compatibility.rb
-- lib/debt_ceiling/custom_debt_analysis.rb
+- lib/debt_ceiling/custom_debt.rb
 - lib/debt_ceiling/debt.rb
 - lib/debt_ceiling/file_attributes.rb
+- lib/debt_ceiling/static_analysis_debt.rb
 - lib/debt_ceiling/version.rb
 - spec/debt_ceiling_spec.rb
 - spec/spec_helper.rb