simplificator-flogger 0.1.1 → 0.2.5

data/README

@@ -0,0 +1,35 @@
+= flogger
+== What is it
+It's a test/unit extension so you can unit test your flog scores
+
+
+== Installation
+sudo gem install flog
+sudo gem install simplificator-flogger
+
+== usage
+In your unit tests do
+
+def test_something
+  assert_flog(a_file_or_a_dir)
+end
+
+= Samples:
+== Flog a file or all ruby files in a directory
+assert_flog(file_or_dir)
+== Flog several files or directories
+assert_flog(file_or_dir_1, file_or_dir_2, file_or_fir_n)
+== set your own flog threshold
+assert_flog(file_or_dir, :threshold => 20)
+== set your own flog threshold for a specific method
+assert_flog(file_or_dir, :thresholds => {'FooClass#bar_method'})
+     
+= Credits
+Thanks to the ruby sadists at http://ruby.sadi.st/Ruby_Sadist.html 
+
+= More
+See lib/flogger/assertions.rb for more
+
+= About us
+Simplificator writes Ruby and Ruby on Rails apps for a living.
+http://simplificator.com

data/lib/flogger/assertions.rb

@@ -1,5 +1,8 @@
 module Flogger
   module InstanceMethods
+    ERROR_MESSAGE_PREFIX = 'Error when flogging your files:'
+    ERROR_MESSAGE = "%s has a flog score of %.2f (exceeding treshold of %.2f by %.2f)"
+    
     # 
     # assert the flog score of file(s) is below a treshold (default treshold is 20).
     # 
@@ -27,7 +30,7 @@ module Flogger
       options = {:treshold => 20}.merge(options)
       flogger = Flog.new()
       flogger.flog_files(files)
-      failures = reject_success(flogger.totals, options)
+      failures = reject_success_and_sort(flogger.totals, options)
       assert_block(build_flog_message(failures, options)) do
         failures.size == 0
       end
@@ -50,10 +53,11 @@ module Flogger
     # Builds a 'nice' error message listing all failed methods
     #
     def build_flog_message(failures, options)
-      message = ['Error when flogging your files:']
-      failures.each do |key, value|
-        limit = treshold_for_key(key, options)
-        message << "#{key.ljust(40, ' ')} has a flog score of #{value} (exceeding treshold of #{limit} by #{value - limit})"
+      max = failures.inject(0) {|memo, item| memo = [memo, item.first.length].max}
+      message = [ERROR_MESSAGE_PREFIX]
+      failures.each do |item|
+        limit = treshold_for_key(item.first, options)
+        message <<  ERROR_MESSAGE % [item.first.ljust(max + 2, ' '), item.last, limit, (item.last - limit)]
       end
       message.join("\n")
     end
@@ -61,10 +65,10 @@ module Flogger
     #
     # Remove all values which are not exceeding the threshold
     #
-    def reject_success(totals, options)
+    def reject_success_and_sort(totals, options)
       totals.reject do |key, value| 
         value < treshold_for_key(key, options)
-      end
+      end.to_a.sort() {|a, b| b.last <=> a.last}
     end
     
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-flogger
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.5
 platform: ruby
 authors: 
 - Simplificator GmbH
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files: 
 - lib/flogger.rb
 - lib/flogger/assertions.rb
+- README
 has_rdoc: false
 homepage: http://simplificator.com/en/lab
 post_install_message: