assit 0.0.2

data/lib/assit.rb

@@ -0,0 +1,14 @@
+=begin
+  This adds simple assert() functionality to the object class. It can be
+  packagd into it's own gem and extended later.
+  
+  We call the functions "assit_*" to differentiate them from the unit
+  test asserts.
+
+
+=end
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), 'assit'))
+
+require 'assertions.rb'
+require 'loader.rb'

data/lib/assit/actions/console_action.rb

@@ -0,0 +1,13 @@
+module Assit
+  
+  # Prints to stderr if the assertion fails
+  class ConsoleAction
+    
+    # The action
+    def assert_it(message)
+      $stderr.puts("Assertion failed: " + message.to_s)
+      $stderr.puts("at: " + caller.to_s)
+    end
+  end
+  
+end

data/lib/assit/actions/raise_action.rb

@@ -0,0 +1,16 @@
+module Assit
+  
+  # Error class for the asserts
+  class AssertionFailure < StandardError
+  end
+  
+  # Raises an error if the assertion fails
+  class RaiseAction
+    
+    # The action
+    def assert_it(message)
+      raise AssertionFailure.new("ASSIT FAILED: #{message}")
+    end
+  end
+  
+end

data/lib/assit/assertions.rb

@@ -0,0 +1,58 @@
+module Assit
+  
+  # Contains the assertion methods for the framework
+  module Assertions
+
+    # Assert if an object is not nil
+    def assit_not_nil(object, message = "Object is nil")
+      assit(object != nil, message)
+    end
+
+    # Assert if two objects are equal
+    def assit_equal(expected, actual, message = "Object expected to be equal")
+      if(expected != actual)
+        message += " expected #{expected} but was #{actual}"
+        assit(false, message)
+      end
+    end
+
+    # Assert if something is of the right type
+    def assit_kind_of(klass, object, message = "Object of wrong type")
+      if(!object.kind_of?(klass))
+        message += " expected #{klass} but was #{object.class}"
+        assit(false, message)
+      end
+    end
+    
+    # Fails the assertion
+    def assit_fail(message = "Assertion with assit_fail")
+      assit(false, message)
+    end
+    
+    # Duck typing assertion: This checks if the given object responds to the
+    # given method calls. This won't detect any calls that will be handled
+    # through method_missing, of course.
+    #
+    # Methods can be a single method name, or an Enumerable with multiple names
+    def assit_quack(object, methods, message = "Quack assert failed.")
+      unless(methods.kind_of?(Enumerable))
+        methods = [methods]
+      end
+      
+      methods.each do |method|
+        unless(object.respond_to?(method.to_sym))
+          assit(false, "#{message} - Method: #{method.to_s}")
+        end
+      end
+    end
+    
+    # Asserts that the given element is a string that is not nil and not an
+    # empty string, or a string only containing whitspaces
+    def assit_real_string(object, message = "Not a non-empty string.")
+      unless(object && object.kind_of?(String) && object.strip != "")
+        assit(false, message)
+      end
+    end
+    
+  end
+end

data/lib/assit/assit_config.rb_example

@@ -0,0 +1,8 @@
+# Configuration file for the Assit framework
+module Assit
+  # Set to true to completely disable the framework
+  assit_disabled false
+
+  # Sets the action to use when an assert fails
+  assit_action :raise
+end

data/lib/assit/config.rb

@@ -0,0 +1,122 @@
+module Assit
+  
+  # Helper module for the configuration
+  # Ths is used to load the Assit module. The following configuration 
+  # options exist: 
+  # 
+  # * assit_disabled - If set it will completely disable the assertions
+  # * assit_action  - Selects the action that will be executed if the assert fails
+  #
+  # The Assit framework can be configured through environment variables or
+  # a config file (assit_config.rb) in the current load path. 
+  #
+  # If environment variables are used, the should have ALL UPPERCASE
+  # names, as ASSIT_DISABLED and ASSIT_ACTION.
+  #
+  # Environment variables take precedence over the config file.
+  #
+  # If no configuration is given, the module is configured 
+  # automatically:
+  #
+  # A Rails installation run in 'production' mode will have the
+  # assertions disabled.
+  #
+  # A Rails installation in the other modes will use :raise as
+  # the default action.
+  #
+  # Other scripts will use :raise if the $DEBUG flag is set, otherwise
+  # :log is used as the default action
+  module Config
+  
+    # defines the methods used for the config file
+    
+    # Sets the "disable" flag
+    def self.assit_disabled(disable)
+      @assit_disabled = disable
+      @assit_disabled_conf = true
+    end
+
+    # Gets the "disable" flag
+    def self.disabled?
+      @assit_disabled
+    end
+
+    # Get the action for failed assertions
+    def self.action
+      @@assit_action_object ||= begin
+        action_name = "#{@assit_action.to_s.downcase}_action"
+
+        # require the action's file
+        require File.join('actions', action_name)
+
+        # Get the class of the widget and check, just to be sure
+        klass = Assit.const_get(camelize(action_name))
+        raise(RuntimeError, "Action class does not exist") unless(klass.is_a?(Class))
+
+        # Create the new widget
+        klass.new()
+      end
+    end
+
+    # Sets the action for failed assertions. This will
+    # create the AssitAction object that can be used by the
+    # framework
+    def self.assit_action(action)
+      @assit_action = action.to_sym
+    end
+
+    # Sets up the Assit configuration parameters
+    def self.do_config!
+      # Try to load the configuration
+      begin
+        require 'assit_config'
+      rescue LoadError
+        # Fail silently, we don't care if there is no config file
+      end
+
+      # Check for the environment variables. They can overwrite the 
+      # config file variables.
+      @assit_disabled ||= ENV['ASSIT_DISABLED'] && (ENV['ASSIT_DISABLED'].downcase == 'true' || ENV['ASSIT_DISABLED'].downcase == 'yes') 
+      @assit_disabled_conf ||= (ENV['ASSIT_DISABLED'] != nil)
+      @assit_action ||= ENV['ASSIT_ACTION'] ? ENV['ASSIT_ACTION'].downcase.to_sym : nil
+
+      # If still not configured, use the auto-config
+      @assit_disabled ||= auto_disable unless(@assit_disabled_conf)
+      @assit_action ||= auto_action
+      
+      # Call the action one time to create and load it
+      action
+      
+      # return true
+      true
+    end
+    
+    protected 
+    
+    # Used to auto-configure the action
+    def self.auto_action
+      # Raise if the debug mode is set or rails is in test or development
+      if($DEBUG || (ENV['RAILS_ENV'] && ENV['RAILS_ENV'] != 'production'))
+        :raise
+      else
+        :console
+      end
+    end
+
+    # Used to auto-configure the "disable" flag
+    def self.auto_disable
+      # In Rails production we auto-disable
+      (ENV['RAILS_ENV'] && ENV['RAILS_ENV'] == 'production')
+    end
+
+   # Stolen from Rails ;-)
+   def self.camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+     if first_letter_in_uppercase
+       lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+     else
+       lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+     end
+   end
+  
+  end  
+end

data/lib/assit/disable_assertions.rb

@@ -0,0 +1,17 @@
+# This disables all assertions by providing a "nop" operation for each
+# assertion that is defined
+class Object
+  
+  # The base assertion is the NOP 
+  def assit(*params) # :nodoc:
+  end
+  
+  # Now create an alias for each assertion
+  Assit::Assertions.instance_methods.each do |assertion_method|
+    # Check if this is an assert method, if yes create alias
+    if(assertion_method =~ /assit_.*/)
+      alias_method assertion_method.to_s, :assit
+    end
+  end
+  
+end

data/lib/assit/loader.rb

@@ -0,0 +1,11 @@
+# Loads the Assit framework and configures it
+require 'config.rb'
+
+# Do the configuration
+Assit::Config::do_config!
+
+if(Assit::Config.disabled?)
+  require 'disable_assertions'
+else
+  require 'setup_assertions'
+end

data/lib/assit/setup_assertions.rb

@@ -0,0 +1,15 @@
+# This sets up the assertions to be used
+
+class Object
+  
+  # The main assertion method
+  def assit(bool, message = "Assertion failed.")
+    unless(bool)
+      Assit::Config::action.assert_it(message)
+    end
+  end
+  
+  # Include the assertions
+  include Assit::Assertions
+  
+end

data/test/assit_test.rb

@@ -0,0 +1,68 @@
+# Set up
+ENV['ASSIT_ACTION'] = 'raise'
+
+require 'rubygems'
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/assit"
+
+if(File.exists?(File.dirname(__FILE__) + '/tesly_reporter.rb'))
+  printf("Continuing with tesly\n")
+  require File.dirname(__FILE__) + '/tesly_reporter'
+end
+
+# Helper class for the duck typing assertion
+class QuackClass
+  def quack
+  end
+  
+  def moo
+  end
+end
+
+# Test the simple assert facility
+class AssitTest < Test::Unit::TestCase
+  
+  # Tests the basic assert facility
+  def test_assert
+    assit(true)
+    assert_raise(Assit::AssertionFailure) { assit(false, "boing") }
+  end
+  
+  # Test nil assert
+  def test_assert_not_nil
+    not_nil = "xxx"
+    assit_not_nil(not_nil, "message")
+    assert_raise(Assit::AssertionFailure) { assit_not_nil(nil) }
+  end
+  
+  # Test type assert
+  def test_assert_kind_of
+    my_string = String.new
+    my_hash = Hash.new
+    
+    assit_kind_of(Object, my_string)
+    assit_kind_of(String, my_string, "message")
+    assert_raise(Assit::AssertionFailure) { assit_kind_of(String, my_hash, "message") }
+  end
+  
+  # Test equality assert
+  def test_assert_equal
+    assit_equal(1, 1)
+    assert_raise(Assit::AssertionFailure) { assit_equal(0, 1) }
+  end
+  
+  # Test fail 
+  def test_assert_fail
+    assert_raise(Assit::AssertionFailure) { assit_fail }
+  end
+  
+  # Test the duck typing assertions
+  def test_assert_quack
+    object_duck = QuackClass.new
+    assit_quack(object_duck, :quack)
+    assit_quack(object_duck, [:quack, :moo])
+    assit_quack(object_duck, :moo, "test")
+    assert_raise(Assit::AssertionFailure) { assit_quack(object_duck, :growl) }
+  end
+  
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: assit
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Daniel Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-20 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: This is an assertion framework for Ruby.
+email: dhahn@gmx.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/assit
+- lib/assit/actions
+- lib/assit/actions/console_action.rb
+- lib/assit/actions/raise_action.rb
+- lib/assit/assertions.rb
+- lib/assit/assit_config.rb_example
+- lib/assit/config.rb
+- lib/assit/disable_assertions.rb
+- lib/assit/loader.rb
+- lib/assit/setup_assertions.rb
+- lib/assit.rb
+has_rdoc: true
+homepage: http://assit.rubyforge.org
+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: assit
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: An assertion framework for Ruby
+test_files: 
+- test/assit_test.rb