simplificator-flogger 0.0.2

data/lib/flogger.rb

@@ -0,0 +1,8 @@
+#$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+require 'flogger/assertions'
+require 'test/unit'
+require 'rubygems'
+require 'flog'
+Test::Unit::TestCase.send(:include, Flogger::InstanceMethods)
+
+puts 'loaded flogger'

data/lib/flogger/assertions.rb

@@ -0,0 +1,85 @@
+module Flogger
+  module InstanceMethods
+    # 
+    # assert the flog score of file(s) is below a treshold.
+    # 
+    # = 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'})
+    # 
+    # == options
+    #  * :treshold what flog score do we allow at most. __default__ is 20.
+    #  * :tresholds customize tresholds on a per class/method base, overrides :treshold option
+    # 
+    # == Message
+    # This assertion does not support passing in your own message like 
+    # other assertions do (optional last parameter) because the error message 
+    # lists all failures from flog.
+    #
+    def assert_flog(*args)
+      files, options = extract_files_and_options(args)
+      options = {:treshold => 20}.merge(options)
+      flogger = Flog.new()
+      flogger.flog_files(files)
+      failures = reject_success(flogger.totals, options)
+      assert_block(build_flog_message(failures, options)) do
+        failures.size == 0
+      end
+    end
+    
+    
+    def assert_floq_rails(*args)
+      assert_flog([RAILS_ROOT] + args)
+    end
+    
+    
+    private
+    
+    #
+    # Extracts an optional Hash (options) from an Array of Strings
+    #
+    def extract_files_and_options(args)
+      raise ArgumentError.new('To few argumnets') if args.size < 1
+      if args.size == 1 || args.last.is_a?(String)
+        [args, {}]
+      else
+        [args[0...-1], args.last]
+      end
+    end
+    #
+    # 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})"
+      end
+      message.join("\n")
+    end
+    
+    #
+    # Remove all values which are not exceeding the limit
+    #
+    def reject_success(totals, options)
+      totals.reject do |key, value| 
+        value < treshold_for_key(key, options)
+      end
+    end
+    
+    
+    def treshold_for_key(key, options)
+      options.has_key?(:tresholds) && options[:tresholds].has_key?(key) ? 
+        options[:tresholds][key] : options[:treshold]
+    end
+
+  end
+end
+
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: simplificator-flogger
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Simplificator GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: adds custom assertions to test/unit so you can test for your flog score
+email: info@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flogger.rb
+- lib/flogger/assertions.rb
+has_rdoc: false
+homepage: http://simplificator.com/en/lab
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: flog assertions for unit tests
+test_files: []
+