debt_ceiling 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b3cdc1008d893ea9057c63dd4834d2b801dfaff
-  data.tar.gz: 8df6b9d644c3efc86e93b84426ef96bbd10cd105
+  metadata.gz: bea87b2ccec435c3759009586048f178a40d963f
+  data.tar.gz: 9538baf4d664690d4deb022db375f1a024471a2c
 SHA512:
-  metadata.gz: 3cb2015140741a74a2a3a70f499cc26cd236b5da6d47280f4e8e0471b61761b458d587acc1ed7748dedbfba31e5e8c7b231655b1d7f2ef1cc56738aa611a4c5c
-  data.tar.gz: 0748963438e02fd19db6646ab1ea71e08bf6d956931b5d0be120c31f150214c64711b5acc8ada8ff44324138b01090f05c2672041da078416c3124ddae24d0e2
+  metadata.gz: 9545baeb0a2fb3f1f5bb21d3642d3e63d7aae32a9124dce6bfd11a3536a8e177f5854c37917fda715439702d18f088b97a0134c75bc9d904685d497c84fe4a9f
+  data.tar.gz: ed0148e021b41fa1618abf56458068a7afa1d01ee959c316987ea5f4198170a812d5a15db9ac88bb1b50295f52a7055ced1130e401139087ac1ac20db569cf47

data/README.md

@@ -7,11 +7,12 @@
 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
+* 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)
 * 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
 
@@ -49,7 +50,7 @@ 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!  
+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.
 
@@ -57,7 +58,7 @@ I'll try and add test coverage where it makes sense as API matures.
 
 todo_cost 500      #cost per comment matching /TODO/
 
-debt_per_reference_to deprecated_regex, 500 # help transition away from deprecated APIs 
+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?
 
@@ -70,7 +71,9 @@ every line over x ideal file size is y points of debt
 
 multipliers for important files
 
-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.
+
+include one of the JS complexity/debt analysis libraries below, or another if anyone had another suggestion:
 
 * https://github.com/es-analysis/plato
 

data/Rakefile

@@ -1,10 +1,5 @@
 #!/usr/bin/env rake
 
-if Regexp.new('RUBYARCHDIR') === ARGV[0]
-  require_relative "lib/debt_ceiling/post_install"
-  DebtCeiling::PostInstall.new(ARGV[0])
-end
-
 task :default => 'test'
 task :test do
   sh "ruby test/debt_ceiling_test.rb"

data/examples/.debt_ceiling.example

@@ -12,8 +12,14 @@ 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)
+#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)
+#blacklist_matching %w(schema.rb routes.rb)

data/lib/debt_ceiling/accounting.rb

@@ -6,32 +6,42 @@ module DebtCeiling
     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(&:+)
+        analysed_modules = construct_rubycritic_modules(path)
+        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}"
+        puts "Largest source of debt is: #{max_debt.name} at #{max_debt.to_i}"
         total_debt
       end
 
       def construct_debts(modules)
-        modules.map do |mod| 
+        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
+          file_attributes.source_code = File.read(mod.path)
           debt_rule = Debt.new(file_attributes)
         end
       end
+
+      def construct_rubycritic_modules(path)
+        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"
+
+          modules = Rubycritic::ModulesInitializer.init([path])
+          [Rubycritic::Analyser::Complexity, Rubycritic::Analyser::FlaySmells].each do |analyser|
+            analyser.new(modules).run
+          end
+          modules
+        end
+      end
     end
   end
 end

data/lib/debt_ceiling/debt.rb

@@ -2,7 +2,7 @@ module DebtCeiling
   class Debt
     DoNotWhitelistAndBlacklistSimulateneously = Class.new(StandardError)
 
-    attr_reader :file_attributes, :path, :analysed_module, :module_name, :linecount
+    attr_reader :file_attributes, :path, :analysed_module, :module_name, :linecount, :source_code
     attr_accessor :debt_amount
     def initialize(file_attributes)
       @file_attributes  = file_attributes
@@ -10,6 +10,7 @@ module DebtCeiling
       @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
 
@@ -26,10 +27,21 @@ module DebtCeiling
         letter_grade = file_attributes.analysed_module.rating.to_s.downcase
         cost_per_line = DebtCeiling.public_send("#{letter_grade}_current_cost_per_line")
         cost += file_attributes.linecount * cost_per_line
+        cost += debt_from_source_code_rules
       end
       self.debt_amount = cost
     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
+    end
+
+    def text_match_debt(string, cost)
+      source_code.scan(string).count * cost
+    end
+
     def valid_debt?
       black_empty = DebtCeiling.blacklist.empty?
       white_empty = DebtCeiling.whitelist.empty?
@@ -47,6 +59,10 @@ module DebtCeiling
       DebtCeiling.blacklist.detect {|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

data/lib/debt_ceiling/version.rb

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

data/lib/debt_ceiling.rb

@@ -42,6 +42,14 @@ module DebtCeiling
     @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)
@@ -50,7 +58,7 @@ module DebtCeiling
   def evaluate
     if ceiling_amount && ceiling_amount <= debt
       fail_test
-    elsif reduction_target && reduction_target <= debt && 
+    elsif reduction_target && reduction_target <= debt &&
           Time.now > reduction_date
       fail_test
     end
@@ -60,9 +68,12 @@ module DebtCeiling
     Kernel.exit 1
   end
 
-  attr_reader :blacklist, :whitelist, :ceiling_amount, :reduction_date, :reduction_target, :debt
+  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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic