debt_ceiling 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f143bb4a889c52ce57b69ee02ecaa062dde87eb
-  data.tar.gz: d31f7da0e0e5221bb10dbbb2db7f382cdcc6f603
+  metadata.gz: f6633e0f63267821bc8ae8c99dcfe483c2d81d01
+  data.tar.gz: d35de5e19c075db347e4aabfa8d2c78faf3aac40
 SHA512:
-  metadata.gz: 93f9335622c57589b9d7de6a207074af558b2e111dd2056351e7db133eee7c8dfa40a99627e884ad4b408758720fbd81d1abf15933b185e052a1cc6661b84f90
-  data.tar.gz: 57423abb6795759193d1e27c064e4ec9bfe83a2b2efe32bddb10ed7dfedeb73aa64449e21d054f892ce887696e1a104241a1bf238fc476c25325c087af2a08b3
+  metadata.gz: 16f339daef3a6ea79e3a79bab28e160b7520a899306fe6c83108336eeeb39b41478a9f7130487faf0cd9c935bbf4e2e501319fc7ba2ece3ea58595006121eb36
+  data.tar.gz: 211d1887abc5d273a27a3b4a14795c8935fd9adf1ab24224d488830fd2e2f5e2c45e3fe0ea51ec41688526d7a27d1df4245c766d155e6c43a8fb10dabd5cb079

data/.debt_ceiling.rb

@@ -0,0 +1,5 @@
+DebtCeiling.configure do |c|
+  c.whitelist = %w(bin lib)
+  c.max_debt_per_module = 150
+  c.debt_ceiling = 250
+end

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - jruby-19mode # JRuby in 1.9 mode
+  - jruby-9.0.0.0.rc1
   - 2.1.1
   - rbx-2.2
 addons:

data/README.md

@@ -11,7 +11,10 @@ Main goal is to enforce a technical debt ceiling and tech debt reduction deadlin
 Travis tests are running on 1.9.3, 2.1.1, Rubinius 2.2 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)
+* configuring points per [RubyCritic](https://github.com/whitesmith/rubycritic) grade per file
+* configuring multipliers for specific static analysis attributes, including complexity, duplication, method count, reek smells
+* configuring ideal max lines per file/module, and a per line penalty for each additional line
+* configuing a max debt per file/module, exceeding which will fail tests
 * Comment added explicit/manual debt assignment, via `#TECH DEBT +100` or custom word/phrase
 * Whitelisting/blacklisting files by matching path/filename
 * Modifying or replacing default calculation on a per file basis
@@ -21,7 +24,7 @@ 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.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:
+To integrate in a test suite, set a value for `debt_ceiling`, `max_debt_per_module` 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 call and/or configuration directly in your spec helper:
 ```ruby
   config.after(:all) do
     DebtCeiling.configure do |c|
@@ -36,21 +39,21 @@ To integrate in a test suite, set a value for `debt_ceiling` and/or `reduction_t
 
 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.
 
-Additional customization is supported via two method hooks in the debt class, which DebtCeiling will load from a provided extension_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)
+Additional customization is supported via two method hooks in the debt class, which DebtCeiling will load from a provided extension_path in the main config file, which should look like the [example file](https://github.com/bglusman/debt_ceiling/blob/master/examples/custom_debt.rb.example)
 
 You can configure/customize the debt calculated using a few simple commands in a .debt_ceiling.rb file in the project's home directory:
 
 ```
 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
+  c.debt_ceiling = 250
   #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'
   #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"
+  #load custom debt calculations (see examples/custom_debt.rb) from this path
+  c.extension_path = "./custom_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}
@@ -64,16 +67,14 @@ DebtCeiling.configure do |c|
 end
 ```
 
-As mentioned/linked above, additional customization is supported via a debt.rb file which may define one or both of two methods DebtCeiling will call if defined when calculating debt for each module scanned (if it passes the whitelist/blacklist stage of filtering).
+As mentioned/linked above, additional customization is supported via a custom_debt.rb file which may define one or both of two methods DebtCeiling will call if defined when calculating debt for each module scanned (if it passes the whitelist/blacklist stage of filtering).
 
-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.
+As shown in example file, set a path for `extension_path` pointing to a file defining `DebtCeiling::CustomDebt` like the one in examples directory, and define its methods for your own additional calculation per file.
 
 ### Improvement ideas/suggestsions for contributing:
 
 * rubocop/cane integration debt for style violations
 
-* default/custom points per reek smell detected (not currently part of RubyCritic grading, but available in full analysis)
-
 * multipliers for important files
 
 * 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)

data/debt_ceiling.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   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

data/lib/debt_ceiling/version.rb

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

data/lib/debt_ceiling.rb

@@ -38,7 +38,7 @@ module DebtCeiling
   end
 
 
-  def audit(dir, opts= {})
+  def audit(dir='.', opts= {})
     Audit.new(dir, opts)
   end
-end
+end

data/spec/debt_ceiling_spec.rb

@@ -30,16 +30,16 @@ describe DebtCeiling do
   it 'adds debt for todos with specified value' do
     todo_amount = 50
     DebtCeiling.configure {|c| c.cost_per_todo = todo_amount }
-    expect(DebtCeiling.audit('spec/support/todo_example.rb').total_debt).to be todo_amount
+    expect(DebtCeiling.audit('spec/support/todo_example.rb', preconfigured: true).total_debt).to be todo_amount
   end
 
   it 'allows manual debt with TECH DEBT comment' do
-    expect(DebtCeiling.audit('spec/support/manual_example.rb').total_debt).to be 100 # hardcoded in example file
+    expect(DebtCeiling.audit('spec/support/manual_example.rb', preconfigured: true).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.audit('spec/support/manual_example.rb').total_debt).to be 150 # hardcoded in example file
+    expect(DebtCeiling.audit('spec/support/manual_example.rb', preconfigured: true).total_debt).to be 150 # hardcoded in example file
   end
 
   it 'assigns debt for file length over ideal file size' do

data/spec/spec_helper.rb

@@ -3,13 +3,5 @@ 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 } }
-  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
+  config.after(:all) { DebtCeiling.audit }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -114,10 +114,10 @@ email:
 - bglusman@shutterstock.com
 executables:
 - debt_ceiling
-extensions:
-- Rakefile
+extensions: []
 extra_rdoc_files: []
 files:
+- ".debt_ceiling.rb"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile