debt_ceiling 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb989ae976353da509970f25093e1ae303ec8b6f
+  data.tar.gz: a473a4ba56137d62578d03522e1519f11ab4d982
+SHA512:
+  metadata.gz: 1d4243bb0c4569c7d42d37de59102d36dc29211647f087295fe4b5807f5493c416203f54734a295a744b8b0adc65672263dedabaa2f38594ea4f67e214e6f288
+  data.tar.gz: a4820d63a6f400e833c7015d85751aa539a58ae2c89d979d087b17eb350f397b1c2382cba9105cd5c8297b1d4b7adcb02d1e9929127c9038dad905c77cf04e74

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.debt_ceiling_definition

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brian Glusman
+
+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

@@ -0,0 +1,8 @@
+#DebtCeiling
+
+###
+Work in progress, trying to use some automatic heuristic plus manual mechanisms to help visibility and tracking of technical debt.
+
+Current plan is to configure/customize the weight given to heuristic grade
+based first on a simple DSL in a .debt_ceiling file in the project's home directory, and if additional customization is desired, pass a path to 
+`extension_file_path` command in the DSL file to a file defining DebtCeiling::Debt like the one in examples directory, and replace/augment it's methods with your own additional calculation per file.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/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"
+end

data/bin/debt_ceiling

@@ -0,0 +1,24 @@
+#!/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.enforce(ARGV[0] ? ARGV[0] : ".")

data/debt_ceiling.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require "debt_ceiling/version"
+
+# module ::Gem
+#  post_install {|gem_installer| puts 'in hook'; DebtCeiling.post_install(gem_installer) }
+# end
+
+Gem::Specification.new do |s|
+  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/DebtCeiling"
+  s.summary     = "DebtCeiling helps you track Tech Debt"
+  s.rubyforge_project = "debt_ceiling"
+  s.extensions = ["Rakefile"]
+
+  s.description = <<-DESC
+    Quantify and add visibility/history to (some half-baked standin for) 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.add_runtime_dependency "rubycritic", "~> 1.1.1"
+  s.add_runtime_dependency "pry"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+end

data/examples/.debt_ceiling.example

@@ -0,0 +1,36 @@
+#TODO example gradings
+# debt_ceiling 15000
+
+b_cost_per_line 10
+c_cost_per_line 20
+d_cost_per_line 40
+f_cost_per_line 100
+# todo_cost 500
+
+# debt_per_reference_to blah
+
+# points_per_regex_match REGEX, points
+
+#rubocop/cane integration debt for style violations
+
+#every line over x ideal file size is y points of debt
+
+#whitelist/blacklist API: TODO
+
+#multipliers for important files
+
+#ditch/augment module eval and use below or something
+
+# class DebtRule
+#   def measure_file(filename, metrics)
+#     cost = 0
+
+#     cost += 0 if metrics.rubycritic.grade == :a
+#     cost += 10 if metrics.rubycritic.grade == :b
+
+#     churn = measure_churn(filename)
+#     cost += whatever if churn > something
+#   end
+
+#   def measure_churn...
+# end 

data/examples/debt.rb.example

@@ -0,0 +1,19 @@
+module DebtCeiling
+  class Debt
+    #replace the DebtCeiling cost calculation per file with your own
+
+
+    def measure_debt
+      #calculcate entire cost based on #file_attributes
+      #or return false/nil to use defaults if you want to conditionally
+      #override default cost calculation
+    end
+
+    #OR do your own calcuation first, and add defaults on top of that
+    def augment_custom_debt
+      #output additional cost beyond defaults based on #file_attributes
+    end
+
+    #augment_custom_debt is only called if measure_debt is undefined or returns nil/false
+  end
+end

data/lib/debt_ceiling/debt.rb

@@ -0,0 +1,36 @@
+module DebtCeiling
+  class Debt
+    attr_reader :file_attributes
+    attr_accessor :debt_amount
+    def initialize(file_attributes)
+      @file_attributes = file_attributes
+      default_measure_debt
+    end
+
+    def default_measure_debt
+      if self.respond_to?(:measure_file)
+        cost = self.public_send(:measure_debt)
+      end
+      if !cost
+        cost = if self.respond_to?(:augment_custom_debt)
+          self.public_send(:augment_custom_debt) || 0
+        else
+          0
+        end
+        letter_grade = file_attributes.analyzed_module.rating.to_s.downcase
+        cost_per_line = DebtCeiling.public_send("#{letter_grade}_current_cost_per_line")
+        cost += file_attributes.linecount * cost_per_line
+      end
+      self.debt_amount = cost
+    end
+
+    def to_i
+      debt_amount
+    end
+
+    def +(other)
+      self.to_i + other.to_i
+    end
+
+  end
+end

data/lib/debt_ceiling/enforcement.rb

@@ -0,0 +1,25 @@
+require 'rubycritic'
+require 'ostruct'
+module DebtCeiling
+  class Enforcement
+    class << self
+      attr_reader :rules
+      def add(rule)
+        @rules ||= []
+        @rules << rule
+      end
+
+      def process_directory(path, output=:destructured)
+        modules = Rubycritic::Orchestrator.new.critique([path])
+        debts = 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.analyzed_module = mod
+          debt_rule = Debt.new(file_attributes)
+        end
+        puts "Current total tech debt: #{debts.map(&:to_i).reduce(&:+)}"
+      end
+    end
+  end
+end

data/lib/debt_ceiling/version.rb

@@ -0,0 +1,3 @@
+module DebtCeiling
+  VERSION = "0.0.1"
+end

data/lib/debt_ceiling.rb

@@ -0,0 +1,54 @@
+require 'ripper'
+require_relative 'debt_ceiling/enforcement'
+require_relative 'debt_ceiling/debt'
+
+
+
+module DebtCeiling
+  extend self
+
+  def debt_ceiling(pattern, message=nil, options={})
+    if pattern.kind_of?(String)
+      rule = Rule.new(pattern, message, options)
+      DebtCeiling::Enforcement.add(rule)
+    else
+      DebtCeiling::Enforcement.add(self.send(pattern))
+    end
+  end
+
+  def enforce(dir=".")
+    DebtCeiling::Enforcement.process_directory(dir, :stdout)
+  end
+
+  def validate_files(files)
+    files.reduce(error: false, output:"") do |results, file|
+      error, output = DebtCeiling::Enforcement.process_file(file)
+      results[:error] ||= error
+      results[:output] += output
+      results
+    end
+  end
+
+  @extension_file_path = "#{Dir.pwd}/debt_rule.rb"
+  def extension_file_path(path)
+    @extension_file_path = path
+  end
+
+  def current_extension_file_path
+    @extension_file_path
+  end
+
+  GRADES = [:a, :b, :c, :d, :f]
+  GRADE_DEFAULTS = [0, 10, 20, 40, 100]
+  GRADE_MAP = GRADES.zip(0..4).to_h
+  GRADES.each do |grade|
+    default_index = GRADE_MAP[grade]
+    instance_variable_set "@#{grade}_cost_per_line", GRADE_DEFAULTS[default_index]
+    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/test/debt_ceiling_test.rb

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

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: debt_ceiling
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Glusman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Quantify and add visibility/history to (some half-baked standin for) Technical Debt
+email:
+- bglusman@shutterstock.com
+executables:
+- debt_ceiling
+extensions:
+- Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/debt_ceiling
+- debt_ceiling.gemspec
+- examples/.debt_ceiling.example
+- examples/debt.rb.example
+- lib/debt_ceiling.rb
+- lib/debt_ceiling/debt.rb
+- lib/debt_ceiling/enforcement.rb
+- lib/debt_ceiling/version.rb
+- test/debt_ceiling_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bglusman/DebtCeiling
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: debt_ceiling
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DebtCeiling helps you track Tech Debt
+test_files: []