assit 0.0.2 → 0.0.3

data/lib/assit/actions/debug_action.rb

@@ -0,0 +1,19 @@
+require 'ruby-debug'
+Debugger.start
+
+module Assit
+  
+  # Error class for the asserts
+  class AssertionFailure < StandardError
+  end
+  
+  # Raises an error if the assertion fails
+  class DebugAction
+    
+    # The action
+    def assert_it(message)
+      debugger
+    end
+  end
+  
+end

data/lib/assit/assertions.rb

@@ -19,7 +19,7 @@ module Assit
     # 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}"
+        message += " (Expected #{klass} but was #{object.class})"
         assit(false, message)
       end
     end
@@ -54,5 +54,12 @@ module Assit
       end
     end
     
+    # Executes the given block and asserts if the result is true. This allows
+    # you to assert on complex, custom expressions and be able to disable
+    # those expressions together with the assertions. See the README for more.
+    def assit_block(message = "Assertion failed.", &block)
+      assit(block.call, message)
+    end 
+    
   end
 end

data/lib/assit/disable_assertions.rb

@@ -3,7 +3,7 @@
 class Object
   
   # The base assertion is the NOP 
-  def assit(*params) # :nodoc:
+  def assit(*params, &block) # :nodoc:
   end
   
   # Now create an alias for each assertion

data/lib/assit/loader.rb

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

data/lib/assit/setup_assertions.rb

@@ -5,7 +5,7 @@ class Object
   # The main assertion method
   def assit(bool, message = "Assertion failed.")
     unless(bool)
-      Assit::Config::action.assert_it(message)
+      AssitConfig::action.assert_it(message)
     end
   end
   

data/lib/assit_config.rb

@@ -0,0 +1,119 @@
+# 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 AssitConfig
+  
+  # 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('assit', '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  

data/test/assit_test.rb

@@ -65,4 +65,14 @@ class AssitTest < Test::Unit::TestCase
     assert_raise(Assit::AssertionFailure) { assit_quack(object_duck, :growl) }
   end
   
+  # Test the block assertion
+  def test_assert_block
+    assit_block { true }
+  end
+  
+  # Test the block assertions failure
+  def test_assert_block_fail
+    assert_raise(Assit::AssertionFailure) { assit_block { 'foo' == 'bar' } }
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: assit
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Daniel Hahn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-20 00:00:00 +01:00
+date: 2008-02-25 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -25,14 +25,15 @@ files:
 - lib/assit
 - lib/assit/actions
 - lib/assit/actions/console_action.rb
+- lib/assit/actions/debug_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
+- lib/assit_config.rb
 has_rdoc: true
 homepage: http://assit.rubyforge.org
 post_install_message: 

data/lib/assit/config.rb

@@ -1,122 +0,0 @@
-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