debt_ceiling 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1121dd0d368a02bfad9d6f2fd21a15707c8089d8
-  data.tar.gz: 7dca6e9d0b291318e5e67b99a5aa96245a416c7e
+  metadata.gz: 7b3cdc1008d893ea9057c63dd4834d2b801dfaff
+  data.tar.gz: 8df6b9d644c3efc86e93b84426ef96bbd10cd105
 SHA512:
-  metadata.gz: bf8aee5e06f3ec57e6215bd2e3a8d88471f2185b053cf4acb76a82ed175c6b5163f869f02dd6b30766f81cf68483fb01082dafc1ae91b9594139496c0bc34339
-  data.tar.gz: a3b9a6ae68acf71df05fca377df940dc5a3b85c1ed4dcaf188a681d3aeff177582c262ad3b6b6429fdf133f99f5c26ea0be16e8215196bbfe65b407188e5729d
+  metadata.gz: 3cb2015140741a74a2a3a70f499cc26cd236b5da6d47280f4e8e0471b61761b458d587acc1ed7748dedbfba31e5e8c7b231655b1d7f2ef1cc56738aa611a4c5c
+  data.tar.gz: 0748963438e02fd19db6646ab1ea71e08bf6d956931b5d0be120c31f150214c64711b5acc8ada8ff44324138b01090f05c2672041da078416c3124ddae24d0e2

data/README.md

@@ -2,18 +2,21 @@
 
 #DebtCeiling
 
+### Work in progress, feedback and PR's appreciated
 
-### Work in progress, trying to use some automatic heuristic plus manual mechanisms to help visibility and tracking of technical debt.
+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).
 
 Current features include:
 * configuring points per [RubyCritic](https://github.com/whitesmith/rubycritic) grade per file line
-* Whitelisting/blacklisting files by filename
+* 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
 * 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
 
+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.
+
 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
 
 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)
@@ -73,4 +76,4 @@ include one of the JS complexity/debt analysis libraries below, or another if an
 
 * https://github.com/dpnishant/jsprime
 
-* https://github.com/mozilla/doctorjs
+* https://github.com/mozilla/doctorjs

data/bin/debt_ceiling

@@ -1,24 +1,3 @@
 #!/usr/bin/env ruby
-
 require_relative "../lib/debt_ceiling"
-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)}
-else
-  puts "
-  ***NOTICE:***
-  Using example .debt_ceiling file, which can be copied and customized from
-  #{File.dirname(File.dirname(`gem which debt_ceiling`.chop)) + '/examples/.debt_ceiling.example'}\n
-  place .debt_ceiling file in project directory and/or home directories, debt_ceiling looks
-  at pwd first for ./debt_ceiling and then at ~/.debt_ceiling and defaults to example
-  if neither is found\n\n"
-
-   File.open(File.dirname(File.dirname(`gem which debt_ceiling`.chop)) +
-      '/examples/.debt_ceiling.example') {|f| DebtCeiling.module_eval(f.read)}
-end
-
-extension_path = DebtCeiling.current_extension_file_path
-load extension_path if File.exists?(extension_path)
-
 DebtCeiling.calculate(ARGV[0] ? ARGV[0] : ".")

data/lib/debt_ceiling/accounting.rb

@@ -0,0 +1,37 @@
+require 'rubycritic'
+require 'ostruct'
+module DebtCeiling
+  class Accounting
+    DebtCeilingExceeded  = Class.new(StandardError)
+    TargetDeadlineMissed = Class.new(StandardError)
+    class << self
+      def calculate(path)
+        #temporarily use Rubycritic internals until they provide an API
+        require "rubycritic/modules_initializer"
+        require "rubycritic/analysers/complexity"
+        require "rubycritic/analysers/smells/flay"
+
+        analysed_modules = Rubycritic::ModulesInitializer.init([path])
+        [Rubycritic::Analyser::Complexity, Rubycritic::Analyser::FlaySmells].each do |analyser|
+          analyser.new(analysed_modules).run
+        end
+        debts      = construct_debts(analysed_modules)
+        max_debt   = debts.max_by(&:to_i)
+        total_debt = debts.map(&:to_i).reduce(&:+)
+        puts "Current total tech debt: #{total_debt}"
+        puts "Largest source of debt is: #{max_debt.file_attributes.analysed_module.name} at #{max_debt.to_i}"
+        total_debt
+      end
+
+      def construct_debts(modules)
+        modules.map do |mod| 
+          file_attributes = OpenStruct.new
+          file_attributes.linecount = `wc -l #{mod.path}`.match(/\d+/)[0].to_i
+          file_attributes.path = mod.path
+          file_attributes.analysed_module = mod
+          debt_rule = Debt.new(file_attributes)
+        end
+      end
+    end
+  end
+end

data/lib/debt_ceiling/version.rb

@@ -1,3 +1,3 @@
 module DebtCeiling
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/debt_ceiling.rb

@@ -6,6 +6,17 @@ module DebtCeiling
   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)}
+    else
+      puts "No .debt_ceiling 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)
+
     @debt = DebtCeiling::Accounting.calculate(dir)
     evaluate
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -100,6 +100,7 @@ files:
 - examples/.debt_ceiling.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
@@ -128,3 +129,4 @@ signing_key:
 specification_version: 4
 summary: DebtCeiling helps you track Tech Debt
 test_files: []
+has_rdoc: