dust 0.1.2 → 0.1.4

data/README

@@ -0,0 +1,31 @@
+= Dust
+
+Dust adds descriptive block syntax test definition.
+
+by Jay[http://blog.jayfields.com] Fields[http://blog.jayfields.com]
+
+== Download and Installation
+
+You can download Dust from here[http://rubyforge.org/projects/dust] or install it with the following command.
+
+ $ gem install dust
+
+== License
+ 	
+You may use, copy and redistribute this library under the same terms as Ruby itself (see http://www.ruby-lang.org/en/LICENSE.txt).
+
+== Examples
+
+unit_tests do
+
+  test "assert true" do
+    assert_equal true, true
+  end
+
+end
+
+See the tests for more examples
+
+== Contributors
+
+Dan Manges

data/lib/array_extension.rb

@@ -1,4 +1,4 @@
-class Array
+class Array  #:nodoc:
   def arrayize
     self
   end

data/lib/definition_error.rb

@@ -1,4 +1,20 @@
-module Dust
+module Dust #:nodoc:
+  # Dust::DefinitionError is raised when you attempt to define a disallowed method within a test file.
+  # 
+  #    Test::Unit::TestCase.disallow_setup!
+  # 
+  #    unit_tests do
+  #      def setup
+  #        ...
+  #      end
+  #        
+  #      test "name" do
+  #        ...
+  #      end
+  #    end
+  # 
+  # The above code will generate the following error
+  #    Dust::DefinitionError: setup is not allowed on class Units::[TestClassName]
   class DefinitionError < StandardError
   end
 end

data/lib/dust.rb

@@ -1,6 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/object_extension')
 require File.expand_path(File.dirname(__FILE__) + '/array_extension')
 require File.expand_path(File.dirname(__FILE__) + '/nil_extension')
+require File.expand_path(File.dirname(__FILE__) + '/string_extension')
 require File.expand_path(File.dirname(__FILE__) + '/symbol_extension')
 require File.expand_path(File.dirname(__FILE__) + '/test_case_extension')
 require File.expand_path(File.dirname(__FILE__) + '/definition_error')

data/lib/nil_extension.rb

@@ -1,4 +1,4 @@
-class NilClass
+class NilClass #:nodoc:
   def arrayize
     []
   end

data/lib/object_extension.rb

@@ -1,31 +1,57 @@
 class Object
+  # call-seq: unit_tests(options={}, &block)
+  # 
+  # Used to define a block of unit tests.
+  # 
+  #    unit_tests do
+  #      test "verify something" do                                   
+  #        ...
+  #      end                                                     
+  #    end                 
+  # 
+  # Configuration Options:
+  #   * allow - Allows you to specify the methods that are allowed despite being disallowed.  
+  #     See Test::Unit::TestCase.disallow_helpers! or Test::Unit::TestCase.disallow_setup! for more info
   def unit_tests(options={}, &block)
     do_tests("Units", options, &block)
   end
 
+  # call-seq: unit_tests(options={}, &block)
+  # 
+  # Used to define a block of functional tests.
+  # 
+  #    functional_tests do
+  #      test "verify something" do                                   
+  #        ...
+  #      end                                                     
+  #    end                                                       
+  # 
+  # Configuration Options:
+  #   * allow - Allows you to specify the methods that are allowed despite being disallowed.  
+  #     See Test::Unit::TestCase.disallow_helpers! or Test::Unit::TestCase.disallow_setup! for more info
   def functional_tests(options={}, &block)
     do_tests("Functionals", options, &block)
   end
   
-  private
-  def do_tests(type, options, &block)
+  protected
+  def do_tests(type, options, &block) #:nodoc:
     options[:allow] = options[:allow].arrayize
     full_path_file_name = eval "__FILE__", block.binding
     test_name = File.basename(full_path_file_name, ".rb")
-    test_class = eval "module #{type}; class #{test_name.capitalize} < Test::Unit::TestCase; self; end; end"
+    test_class = eval "module #{type}; class #{test_name.to_class_name} < Test::Unit::TestCase; self; end; end"
     test_class.class_eval &block
     check_for_setup(test_class, options)
     check_for_helpers(test_class, options)
   end
   
-  def check_for_setup(test_class, options)
+  def check_for_setup(test_class, options) #:nodoc:
     if test_class.instance_methods(false).include?("setup") && Test::Unit::TestCase.disallow_setup? && 
        !options[:allow].include?(:setup)
       raise Dust::DefinitionError.new("setup is not allowed on class #{test_class.name}")
     end
   end
   
-  def check_for_helpers(test_class, options)
+  def check_for_helpers(test_class, options) #:nodoc:
     test_class.instance_methods(false).each do |method_name|
       if method_name !~ /^test_/ && Test::Unit::TestCase.disallow_helpers? && !options[:allow].include?(method_name.to_sym)
         p method_name.to_sym

data/lib/string_extension.rb

@@ -0,0 +1,5 @@
+class String #:nodoc:
+  def to_class_name
+    gsub(/(^|_)(.)/) { $2.upcase }  
+  end
+end

data/lib/symbol_extension.rb

@@ -1,4 +1,4 @@
-class Symbol
+class Symbol #:nodoc:
   def arrayize
     [self]
   end

data/lib/test_case_extension.rb

@@ -1,25 +1,76 @@
-class Test::Unit::TestCase
-  def self.disallow_setup!
-    @disallow_setup = true
-  end
+module Test #:nodoc:
+  module Unit #:nodoc:
+    class TestCase
+      # call-seq: disallow_setup!
+      # 
+      # Used to disallow setup methods in test specifications.
+      # 
+      #    Test::Unit::TestCase.disallow_setup!
+      #
+      # A test specification can override this behavior by passing :setup in the :allow options.
+      # 
+      #    unit_tests :allow => :setup do
+      #      def setup
+      #        ...
+      #      end        
+      #                                              
+      #      test "verify something" do                                   
+      #        ...
+      #      end                                                     
+      #    end
+      def self.disallow_setup!
+        @disallow_setup = true
+      end
   
-  def self.disallow_setup?
-    @disallow_setup
-  end
+      def self.disallow_setup? #:nodoc:
+        @disallow_setup
+      end
   
-  def self.disallow_helpers!
-    @disallow_helpers = true
-  end
+      # call-seq: disallow_helpers!
+      # 
+      # Used to disallow helper methods in test specifications.
+      # 
+      #    Test::Unit::TestCase.disallow_helper!
+      # 
+      # A test specification can override this behavior by passing the helper name (as a symbol) in the :allow options.
+      # 
+      #    unit_tests :allow => [:create_something, :destroy_something] do
+      #      test "verify something" do                                   
+      #        ...
+      #      end                   
+      #                                   
+      #      def create_something
+      #        ...
+      #      end                          
+      #                            
+      #      def destroy_something
+      #        ...
+      #      end                                                     
+      #    end
+      def self.disallow_helpers!
+        @disallow_helpers = true
+      end
   
-  def self.disallow_helpers?
-    @disallow_helpers
-  end
+      def self.disallow_helpers? #:nodoc:
+        @disallow_helpers
+      end
 
-  def self.test(name, &block)
-    test_name = "test_#{name.gsub(/[\s]/,'_')}".to_sym
-    raise "#{test_name} is already defined in #{self}" if self.instance_methods.include? test_name.to_s
-    define_method test_name do
-      instance_eval &block
+      # call-seq: test(name, &block)
+      # 
+      # Used to define a test and assign it a descriptive name.
+      # 
+      #    unit_tests do
+      #      test "verify something" do                                   
+      #        ...
+      #      end                                                     
+      #    end                                                       
+      def self.test(name, &block)
+        test_name = "test_#{name.gsub(/[\s]/,'_')}".to_sym
+        raise "#{test_name} is already defined in #{self}" if self.instance_methods.include? test_name.to_s
+        define_method test_name do
+          instance_eval &block
+        end
+      end
     end
   end
 end

data/rakefile.rb

@@ -28,7 +28,7 @@ Gem::manage_gems
 specification = Gem::Specification.new do |s|
 	s.name   = "dust"
   s.summary = "Dust is an add on for Test::Unit that allows an alternative test definintion syntax."
-	s.version = "0.1.2"
+	s.version = "0.1.4"
 	s.author = 'Jay Fields'
 	s.description = "Dust is an add on for Test::Unit that allows an alternative test definintion syntax."
 	s.email = 'dust-developer@rubyforge.org'

data/test/failing_with_helper_unit_test.rb

@@ -10,7 +10,7 @@ begin
   end
   raise "shouldn't be here"
 rescue Dust::DefinitionError => ex
-  raise unless ex.message == "helper methods are not allowed on class Units::Failing_with_helper_unit_test"
+  raise unless ex.message == "helper methods are not allowed on class Units::FailingWithHelperUnitTest"
 ensure
   Test::Unit::TestCase.class_eval {  @disallow_helpers = nil }
 end

data/test/failing_with_setup_unit_test.rb

@@ -10,7 +10,7 @@ begin
   end
   raise "shouldn't be here"
 rescue Dust::DefinitionError => ex
-  raise unless ex.message == "setup is not allowed on class Units::Failing_with_setup_unit_test"
+  raise unless ex.message == "setup is not allowed on class Units::FailingWithSetupUnitTest"
 ensure
   Test::Unit::TestCase.class_eval {  @disallow_setup = nil }
 end

data/test/functional_test.rb

@@ -4,4 +4,9 @@ functional_tests do
   test "assert true" do
     assert_equal true, true
   end
+  
+  test "class name is Functionals::FunctionalTest" do
+    assert_equal "Functionals::FunctionalTest", self.class.name
+  end
+
 end

data/test/passing_unit_test.rb

@@ -4,4 +4,8 @@ unit_tests do
   test "assert true" do
     assert_equal true, true
   end
+  
+  test "class name is Units::PassingUnitTest" do
+    assert_equal "Units::PassingUnitTest", self.class.name
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: dust
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-08-14 00:00:00 -04:00
+  version: 0.1.4
+date: 2007-08-17 00:00:00 -04:00
 summary: Dust is an add on for Test::Unit that allows an alternative test definintion syntax.
 require_paths: 
 - lib
@@ -34,6 +34,7 @@ files:
 - lib/dust.rb
 - lib/nil_extension.rb
 - lib/object_extension.rb
+- lib/string_extension.rb
 - lib/symbol_extension.rb
 - lib/test_case_extension.rb
 - test/all_tests.rb