debt_ceiling 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdaed8c0afa61cf7344d8408f594a2a2a46e7e7c
-  data.tar.gz: c24c856b988deed8436fd94251738699d4fd7d80
+  metadata.gz: 1125eec0668d278a574a419d40d4b40996e3a318
+  data.tar.gz: f6ae9f67c06f1ee678bb07e53df65b14a9c8cafd
 SHA512:
-  metadata.gz: 587e74eea5569336e755092841a477f011de54e8a739f16513854f921e427b2b23a143e9ee13f97e4552489d4ba77a71e053cad941f1d71ad25d0490210226e5
-  data.tar.gz: 185f0229cd4709b4151b09384975065db999fbeccc4805c8cb1befd266c9d5056b2a91368a96b3657df8b7365207780e40877efcd2c0396f4c1108f3cb9bcbdf
+  metadata.gz: ff07b0f6c4d044c439ab9a376586f9fb13b00db3c1dbded832851d591454624324ac6ab0ea3f1e5318001b377070efe5022ef6f710ae9dcc293575069e966654
+  data.tar.gz: ef856854187389e9f2c89b7337446c97ebe6091d0ffdf4efe3d655539843fa2bdbd6758bf20cf0e19d877c9b43d02444a1cb69f0cf035edb03bfb216fcf01ee9

data/README.md

@@ -24,18 +24,21 @@ 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`, `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:
+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
+  require 'debt_ceiling'
   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)
+    DebtCeiling.audit(preconfigured: true)
   end
 ```
-  It will exit with a non-zero failure if you exceed your ceiling(s) or miss your target, failing the test suite.
+`audit` defaults to '.' as root directory, since specs are usually run from root, but you can pass it a relative path as an argument, i.e. `DebtCeiling.audit('./lib')`
+
+It will exit with a non-zero failure, failing the test suite, if you exceed your ceiling(s) or miss your target and print the failure and reason for failure.  If you wish debt ceiling to run and print the failures, but not fail the test suite when thresholds are exceeded or targets are missed, call the audit method with the `warn_only` option, i.e.: `DebtCeiling.audit(warn_only: true)`
 
 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.
 

data/lib/debt_ceiling/audit.rb

@@ -6,7 +6,11 @@ module DebtCeiling
 
     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"
+    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
 
@@ -20,7 +24,8 @@ module DebtCeiling
       @dir        = dir
       @accounting = perform_accounting
       accounting.print_results unless opts[:skip_report]
-      fail_test if failed_condition?
+      puts failure_message
+      fail_test if failed_condition? && !opts[:warn_only]
     end
 
     private
@@ -55,33 +60,30 @@ module DebtCeiling
     end
 
     def failed_condition?
-      exceeded_total_limit? || missed_target? || max_debt_per_module_exceeded?
+      exceeded_total_limit || missed_target || max_debt_per_module_exceeded
     end
 
     def failure_message
-      message = ""
-      message += "DEBT CEILING FAILURE: " if failed_condition?
-      message += "EXCEEDED TOTAL DEBT CEILING " if exceeded_total_limit?
-      message += "MISSED DEBT REDUCTION TARGET " if missed_target?
-      message += "MAX DEBT PER MODULE EXCEEDED IN AT LEAST ONE LOCATION" if max_debt_per_module_exceeded?
-      message
+      <<-MESG
+        #{FAILURE_MESSAGE if failed_condition?}#{exceeded_total_limit}#{missed_target}
+        #{max_debt_per_module_exceeded}
+      MESG
     end
 
-    def exceeded_total_limit?
-      debt_ceiling && debt_ceiling <= total_debt
+    def exceeded_total_limit
+      TOTAL_LIMIT if debt_ceiling && debt_ceiling <= total_debt
     end
 
-    def missed_target?
-      reduction_target && reduction_target <= total_debt &&
+    def missed_target
+      MISSED_TARGET_MESSAGE if reduction_target && reduction_target <= total_debt &&
             Time.now > Chronic.parse(reduction_date)
     end
 
-    def max_debt_per_module_exceeded?
-      max_debt_per_module && max_debt_per_module <= accounting.max_debt.to_i
+    def max_debt_per_module_exceeded
+      PER_MODULE_MESSAGE if max_debt_per_module && max_debt_per_module <= accounting.max_debt.to_i
     end
 
     def fail_test
-      puts failure_message
       at_exit do
         Kernel.exit 1
       end

data/lib/debt_ceiling/version.rb

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

data/spec/debt_ceiling_spec.rb

@@ -16,13 +16,21 @@ describe DebtCeiling do
     DebtCeiling.audit('.', preconfigured: true)
   end
 
-  it 'has failing exit status when max debt per modile is exceeded' do
+  it 'has failing exit status when max debt per module is exceeded' do
     DebtCeiling.configure {|c| c.max_debt_per_module =5 }
     expect(DebtCeiling.debt_ceiling).to eq(nil)
     expect_any_instance_of(DebtCeiling::Audit).to receive(:fail_test)
     DebtCeiling.audit('.', preconfigured: true)
   end
 
+  it 'has no failing exit status when in warn only mode' do
+    DebtCeiling.configure {|c| c.max_debt_per_module =5 }
+    expect(DebtCeiling.debt_ceiling).to eq(nil)
+    expect_any_instance_of(DebtCeiling::Audit).to receive(:failed_condition?).at_least(:once).and_return(true)
+        expect_any_instance_of(DebtCeiling::Audit).not_to receive(:fail_test)
+    DebtCeiling.audit('.', preconfigured: true, warn_only: true)
+  end
+
   it 'returns quantity of total debt' do
     expect(DebtCeiling.audit('.').total_debt).to be > 5 # arbitrary non-zero amount
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debt_ceiling
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Brian Glusman