debt_ceiling 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1125eec0668d278a574a419d40d4b40996e3a318
-  data.tar.gz: f6ae9f67c06f1ee678bb07e53df65b14a9c8cafd
+  metadata.gz: 2d7432d28a7ec4031eecec3fa65514b9fd1ad72b
+  data.tar.gz: 47b5bd46ff993349004cc868951e8ae65498e05b
 SHA512:
-  metadata.gz: ff07b0f6c4d044c439ab9a376586f9fb13b00db3c1dbded832851d591454624324ac6ab0ea3f1e5318001b377070efe5022ef6f710ae9dcc293575069e966654
-  data.tar.gz: ef856854187389e9f2c89b7337446c97ebe6091d0ffdf4efe3d655539843fa2bdbd6758bf20cf0e19d877c9b43d02444a1cb69f0cf035edb03bfb216fcf01ee9
+  metadata.gz: 7046c3ebf95657217a84892680f8f394b0798308f5aa63cd00fde6a055d6b2409e7d5729810905bcd8ca7a1fce3e473b738dc4d1e2742d2b6c18f1a1d339dd10
+  data.tar.gz: 00a701fac5fb15dae1262910ac606c899449539f224f3f72dfc4a780afb0c42844bef0b75425506a8c6425e484a1c1b71b1c96046db3a948393737f91d4647dc

data/.debt_ceiling.rb

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

data/.travis.yml

@@ -2,9 +2,12 @@ language: ruby
 rvm:
   - 1.9.3
   - jruby-19mode # JRuby in 1.9 mode
-  - jruby-9.0.0.0.rc1
+  - jruby-9.0.0.0
   - 2.1.1
-  - rbx-2.2
+  - 2.2.2
+  - 2.3.0
+  - rbx-2.8
 addons:
   code_climate:
-    repo_token: cd7df1b0973b1b3323ce8b2f09fe9c087010115889fed6
+    repo_token: cd7df1b0973b1b3323ce8b2f09fe9c087010115889fed6
+sudo: false

data/README.md

@@ -23,6 +23,13 @@ Current features include:
 * Adding cost for TODOs or deprecated references you specify (see [.debt_ceiling.rb.example](https://github.com/bglusman/debt_ceiling/blob/master/examples/.debt_ceiling.rb.example))
 * 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)
+* Analyzing the history of the master branch (or current/default branch)
+  * Calculates total debt and pass/fail state for the state of the code at each commit.
+  * It will print this out as a sparkline command line graph, which is basically useless and just for kicks
+  * Store the entire result in Redis (if available), or return the results as a `DebtCeiling::ArcheologicalDig` object if called via `DebtCeiling.dig(path)`, which has an array of hashes available via `#results` method representing the individual commit results at the specified level of detail per commit.
+  * Plans to visualize this history
+  * Memoizes each commit's calculation, either to Redis if Redis gem is installed (specify host and port via `ENV['REDIS_HOST']` and `ENV['REDIS_PORT']` or uses defaults of localhost and 6379) or by creating git notes associated with each commit if not.  Also supports Mercurial in theory, but haven't tested it, and requires Redis for Mercurial since no git notes option there.
+  * Run the historical analysis for a repository with `debt_ceiling dig`, defaulting to current directory.
 
 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` from your test helper as an additional test, or drop the call and/or configuration directly in your spec helper:
 ```ruby
@@ -46,7 +53,7 @@ Additional customization is supported via two method hooks in the debt class, wh
 
 You can configure/customize the debt calculated using a few simple commands in a .debt_ceiling.rb file in the project's home directory:
 
-```
+```ruby
 DebtCeiling.configure do |c|
   #exceeding this will fail a test, if you run debt_ceiling binary/calculate method from test suite
   c.debt_ceiling = 250

data/bin/debt_ceiling

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

data/debt_ceiling.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = DebtCeiling::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Brian Glusman']
-  s.email       = ['bglusman@shutterstock.com']
+  s.email       = ['bglusman@stridenyc.com']
   s.homepage    = 'https://github.com/bglusman/debt_ceiling'
   s.summary     = 'DebtCeiling helps you track Tech Debt'
   s.rubyforge_project = 'debt_ceiling'
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rubycritic', '~> 1.4'
   s.add_runtime_dependency 'chronic', '~> 0.10'
+  s.add_runtime_dependency 'sparkr', '~> 0.4.1'
   s.add_runtime_dependency 'configurations', '~> 2.0'
   s.add_development_dependency 'pry', '~> 0.10'
   s.add_development_dependency 'rake', '~> 10.3'

data/lib/debt_ceiling.rb

@@ -1,5 +1,6 @@
 require 'configurations'
 require 'chronic'
+require 'sparkr'
 require 'rubycritic'
 require 'rubycritic/cli/application'
 require 'ostruct'
@@ -12,14 +13,38 @@ require_relative 'debt_ceiling/static_analysis_debt'
 require_relative 'debt_ceiling/debt'
 require_relative 'debt_ceiling/compatibility'
 require_relative 'debt_ceiling/file_attributes'
+require_relative 'debt_ceiling/archeological_dig'
 
 module DebtCeiling
   include Configurations
   extend Forwardable
   extend self
-  def_delegators :configuration,
-                 :extension_path, :blacklist, :whitelist, :max_debt_per_module, :reduction_date,
-                 :reduction_target, :debt_ceiling
+  CONFIGURATION_OPTIONS = [
+    :extension_path,
+    :blacklist, :whitelist,
+    :max_debt_per_module,
+    :reduction_date,
+    :reduction_target,
+    :debt_ceiling,
+    :deprecated_reference_pairs,
+    :manual_callouts,
+    :grade_points,
+    :complexity_multiplier,
+    :method_count_multiplier,
+    :smells_multiplier,
+    :duplication_multiplier,
+    :ideal_max_line_count,
+    :cost_per_line_over_ideal,
+    :debt_types,
+    :archeology_detail,
+    :memoize_records_in_repo
+  ]
+  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"
+
+  def_delegators  :configuration, *CONFIGURATION_OPTIONS
+
 
   configuration_defaults do |config|
     config.extension_path = "#{Dir.pwd}/custom_debt.rb"
@@ -35,10 +60,34 @@ module DebtCeiling
     config.ideal_max_line_count     = 100
     config.cost_per_line_over_ideal = 1
     config.debt_types               = [CustomDebt, StaticAnalysisDebt]
+    config.archeology_detail        = :low
+    config.memoize_records_in_repo  = true #is this OK as a default? effects repo
   end
 
 
   def audit(dir='.', opts= {})
     Audit.new(dir, opts)
   end
+
+  def dig(dir='.', opts={})
+    dig = ArcheologicalDig.new(dir, opts)
+    puts Sparkr.sparkline(dig.records.map {|r| r['debt'] })
+    dig
+  end
+
+  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 config_array
+    CONFIGURATION_OPTIONS.map {|option| public_send(option) }
+  end
+
 end

data/lib/debt_ceiling/archeological_dig.rb

@@ -0,0 +1,119 @@
+require_relative "source_control_systems/base"
+require 'digest/sha1'
+require 'json'
+module DebtCeiling
+  class ArcheologicalDig
+    ARCHEOLOGY_RECORD_VERSION_NUMBER = "v0" #increment for backward incompatible changes in record format
+    attr_reader :source_control, :records, :redis, :path, :opts
+
+    def self.dig_json_key(path)
+      project_name = File.expand_path(path).split('/').last
+      "DebtCeiling_#{project_name}_#{ARCHEOLOGY_RECORD_VERSION_NUMBER}"
+    end
+
+    def initialize(path='.', opts={})
+      @redis = redis_if_available
+      @path = path
+      @opts = opts
+      @source_control =  SourceControlSystem::Base.create
+      DebtCeiling.load_configuration unless opts[:preconfigured]
+      @records = source_control.revisions_refs(path).map do |commit|
+        if note = config_note_present_on_commit(commit)
+          extract_record_from_note(note)
+        else
+          build_record(commit)
+        end
+      end
+      redis.set(self.class.dig_json_key(path), records.to_json) if redis
+    end
+
+    private
+
+    def build_record(commit)
+      result = nil
+      source_control.travel_to_commit(commit) do
+        result = Audit.new(path,
+                           opts.merge(skip_report: true,
+                                     warn_only: true,
+                                     preconfigured: true,
+                                     silent: true
+                                     )
+                          )
+        create_note_on_commit(result, commit) if DebtCeiling.memoize_records_in_repo
+      end
+      archeology_record(result, commit)
+    end
+
+    def redis_if_available
+      require 'redis'
+      host = ENV['REDIS_HOST'] || 'localhost'
+      port = ENV['REDIS_PORT'] ? ENV['REDIS_PORT'].to_i : 6379
+      Redis.new(host: host, port: port)
+      rescue LoadError
+    end
+
+    def read_note_on(commit)
+      if redis
+        redis.get(commit_identifier(commit))
+      else
+        source_control.read_note_on(commit)
+      end
+    end
+
+    def config_note_present_on_commit(commit)
+      note = read_note_on(commit)
+      matched = !!note.match(commit_identifier(commit)) if note
+      note if matched
+    end
+
+    def extract_record_from_note(note)
+      note.split("\n").each_cons(2).each do |comment, json|
+        return JSON.parse(json) if comment.match(config_string)
+      end
+    end
+
+    def create_note_on_commit(result, commit)
+      note = <<-DATA
+            #{commit_identifier(commit)}
+            #{archeology_record_json(result, commit)}
+            DATA
+      if redis
+        redis.set(commit_identifier(commit), note)
+      else
+        source_control.add_note_to(commit, note)
+      end
+    end
+
+    def commit_identifier(commit)
+      "debt_ceiling_#{commit}_#{config_string}"
+    end
+
+    def archeology_record_json(result, commit)
+      json = "#{archeology_record(result, commit).to_json}"
+      json.gsub!('"','\"') unless redis
+      json
+    end
+
+    def archeology_record(result, commit)
+      case DebtCeiling.archeology_detail
+      when :low
+        default_record(result, commit)
+      else
+        {max_debt: result.accounting.max_debt}.merge(default_record(result, commit))
+      end
+    end
+
+    def default_record(result, commit)
+      {debt: result.total_debt, failed: !!result.failed_condition?, commit: commit}
+    end
+
+    def config_string
+      @config_string ||= config_hash_string + ARCHEOLOGY_RECORD_VERSION_NUMBER
+    end
+
+    def config_hash_string
+      Digest::SHA1.hexdigest(DebtCeiling.config_array.to_json)
+    end
+
+  end
+end

data/lib/debt_ceiling/audit.rb

@@ -4,18 +4,15 @@ module DebtCeiling
     include CommonMethods
     undef :+
 
-    CONFIG_FILE_NAME = ".debt_ceiling.rb"
-    CONFIG_LOCATIONS = ["#{Dir.pwd}/#{CONFIG_FILE_NAME}", "#{Dir.home}/#{CONFIG_FILE_NAME}"]
     FAILURE_MESSAGE       = "DEBT CEILING FAILURE: "
     TOTAL_LIMIT           = "EXCEEDED TOTAL DEBT CEILING "
-    NO_CONFIG_FOUND       = "No #{CONFIG_FILE_NAME} configuration file detected in #{Dir.pwd} or ~/, using defaults"
     PER_MODULE_MESSAGE    = "MAX DEBT PER MODULE EXCEEDED IN AT LEAST ONE LOCATION"
     MISSED_TARGET_MESSAGE = "MISSED DEBT REDUCTION TARGET "
 
     attr_reader :accounting, :dir, :loaded
 
     def_delegators :configuration,
-                   :extension_path, :debt_ceiling, :reduction_target, :reduction_date, :max_debt_per_module
+                   :debt_ceiling, :reduction_target, :reduction_date, :max_debt_per_module
 
     def_delegator :accounting, :total_debt
 
@@ -24,25 +21,18 @@ module DebtCeiling
       @dir        = dir
       @accounting = perform_accounting
       accounting.print_results unless opts[:skip_report]
-      puts failure_message
+      puts failure_message unless opts[:silent]
       fail_test if failed_condition? && !opts[:warn_only]
     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
+    def failed_condition?
+      exceeded_total_limit || missed_target || max_debt_per_module_exceeded
     end
 
-    def config_file_location
-      CONFIG_LOCATIONS.find {|loc| File.exist?(loc) }
-    end
+    private
 
     def perform_accounting
-      load_configuration unless loaded
+      DebtCeiling.load_configuration unless loaded
       Accounting.new(dir)
     end
 
@@ -59,10 +49,6 @@ module DebtCeiling
       deprecated_reference_pairs[string] = value
     end
 
-    def failed_condition?
-      exceeded_total_limit || missed_target || max_debt_per_module_exceeded
-    end
-
     def failure_message
       <<-MESG
         #{FAILURE_MESSAGE if failed_condition?}#{exceeded_total_limit}#{missed_target}

data/lib/debt_ceiling/source_control_systems/base.rb

@@ -0,0 +1,37 @@
+require "shellwords"
+#copied from rubycritic, hope/plan to augment, pull into seperate gem and PR as shared code?
+module DebtCeiling
+  module SourceControlSystem
+
+    class Base
+      @@systems = []
+
+      def self.register_system
+        @@systems << self
+      end
+
+      def self.systems
+        @@systems
+      end
+
+      def self.create
+        supported_system = systems.find(&:supported?)
+        if supported_system
+          supported_system.new
+        else
+          puts "DebtCeiling can provide more feedback if you use a #{connected_system_names} repository."
+          Double.new
+        end
+      end
+
+      def self.connected_system_names
+        "#{systems[0...-1].join(', ')} or #{systems[-1]}"
+      end
+    end
+
+  end
+end
+
+require_relative "base"
+require_relative "git"
+require_relative "mercurial"

data/lib/debt_ceiling/source_control_systems/double.rb

@@ -0,0 +1,38 @@
+module DebtCeiling
+  module SourceControlSystem
+    class Double < Base
+      def revisions_count(_)
+        "N/A"
+      end
+
+      def date_of_last_commit(_)
+        nil
+      end
+
+      def add_note_to(ref, message)
+        nil
+      end
+
+      def read_note_on(ref)
+        nil
+      end
+
+      def travel_to_commit(ref)
+        nil
+      end
+
+      def revisions_count(path)
+        nil
+      end
+
+      def revisions_refs(path)
+        []
+      end
+
+      def revision?
+        false
+      end
+    end
+
+  end
+end

data/lib/debt_ceiling/source_control_systems/git.rb

@@ -0,0 +1,84 @@
+module DebtCeiling
+  module SourceControlSystem
+    require 'open3'
+    class Git < Base
+      register_system
+
+      def self.supported?
+        `git branch 2>&1` && $?.success?
+      end
+
+      def self.to_s
+        "Git"
+      end
+
+      def revisions_count(path)
+        revisions_refs(path).count
+      end
+
+      def revisions_refs(path)
+        popen3("git log --follow --format=%h #{path.shellescape}").split("\n")
+      end
+
+      def date_of_last_commit(path)
+        popen3("git log -1 --date=iso --format=%ad #{path.shellescape}").chomp!
+      end
+
+      def revision?
+        head_reference && $?.success?
+      end
+
+      def head_reference
+        popen3("git rev-parse --verify HEAD").chomp
+      end
+
+      def add_note_to(ref, message)
+        popen3(%Q(git notes append #{ref} -m "#{message}"))
+      end
+
+      def read_note_on(ref)
+        popen3("git notes show #{ref}")
+      end
+
+      def travel_to_commit(ref)
+        stash_successful = stash_changes
+        current_branch = popen3("git symbolic-ref HEAD").chomp.split('/').last
+        popen3("git checkout #{ref}")
+        yield
+      ensure
+        popen3("git checkout #{current_branch}")
+        travel_to_original_state if stash_successful
+      end
+
+      def travel_to_head
+        stash_successful = stash_changes
+        yield
+      ensure
+        travel_to_original_state if stash_successful
+      end
+
+      private
+
+      def stash_changes
+        stashes_count_before = stashes_count
+        popen3("git stash")
+        stashes_count_after = stashes_count
+        stashes_count_after > stashes_count_before
+      end
+
+      def stashes_count
+        popen3("git stash list --format=%h").count("\n")
+      end
+
+      def travel_to_original_state
+        popen3("git stash pop")
+      end
+
+      def popen3(cmd)
+        Open3.popen3(cmd) do |_,stdout,error|
+          stdout.read if error.read.empty?
+        end
+      end
+    end
+  end
+end

data/lib/debt_ceiling/source_control_systems/mercurial.rb

@@ -0,0 +1,49 @@
+module DebtCeiling
+  module SourceControlSystem
+
+    class Mercurial < Base
+      register_system
+
+      def self.supported?
+        `hg verify 2>&1` && $?.success?
+      end
+
+      def self.to_s
+        "Mercurial"
+      end
+
+      def revisions_count(path)
+        `hg log #{path.shellescape} --template '1'`.size
+      end
+
+      def date_of_last_commit(path)
+        `hg log #{path.shellescape} --template '{date|isodate}' --limit 1`.chomp
+      end
+
+      def add_note_to(ref, message)
+        nil #unsupported AFAIK
+      end
+
+      def read_note_on(ref)
+        nil
+      end
+
+      def travel_to_commit(ref)
+        nil #TODO
+      end
+
+      def revisions_count(path)
+        nil #TODO
+      end
+
+      def revisions_refs(path)
+        [] #TODO
+      end
+
+      def revision?
+        false
+      end
+    end
+
+  end
+end

data/lib/debt_ceiling/version.rb

@@ -1,3 +1,3 @@
 module DebtCeiling
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: sparkr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: configurations
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +125,7 @@ dependencies:
 description: |2
       Get a grip on your technical debt
 email:
-- bglusman@shutterstock.com
+- bglusman@stridenyc.com
 executables:
 - debt_ceiling
 extensions: []
@@ -131,12 +145,17 @@ files:
 - examples/custom_debt.rb.example
 - lib/debt_ceiling.rb
 - lib/debt_ceiling/accounting.rb
+- lib/debt_ceiling/archeological_dig.rb
 - lib/debt_ceiling/audit.rb
 - lib/debt_ceiling/common_methods.rb
 - lib/debt_ceiling/compatibility.rb
 - lib/debt_ceiling/custom_debt.rb
 - lib/debt_ceiling/debt.rb
 - lib/debt_ceiling/file_attributes.rb
+- lib/debt_ceiling/source_control_systems/base.rb
+- lib/debt_ceiling/source_control_systems/double.rb
+- lib/debt_ceiling/source_control_systems/git.rb
+- lib/debt_ceiling/source_control_systems/mercurial.rb
 - lib/debt_ceiling/static_analysis_debt.rb
 - lib/debt_ceiling/version.rb
 - spec/debt_ceiling_spec.rb
@@ -168,3 +187,4 @@ signing_key:
 specification_version: 4
 summary: DebtCeiling helps you track Tech Debt
 test_files: []
+has_rdoc: