adaptation 0.0.1 → 0.0.2

data/lib/adaptation/test/test_help.rb

@@ -38,6 +38,13 @@ end
 
 class Test::Unit::TestCase
 
+  # Asserts that a message[link:/classes/Adaptation/Message.html] in a xml
+  # fixture file is converted into an Adaptation::Message that if serialized
+  # again to xml is equivalent to the xml data in the initial fixture file.
+  # An Adaptation::Message object cretaed from a xml fixture, will only
+  # have the xml tags specified in its class definition (using has_one,
+  # has_many, has_text...) so this assertion can be useful to check that
+  # the class is defined correctly.
   def assert_parsed message_symbol
     data, message_object = load_message_fixture message_symbol
     
@@ -53,6 +60,13 @@ class Test::Unit::TestCase
     end
   end
 
+  # Asserts that a message[link:/classes/Adaptation/Message.html] in a xml
+  # fixture file is converted into an Adaptation::Message that if serialized
+  # again to xml is not equivalent to the xml data in the initial fixture file.
+  # An Adaptation::Message object cretaed from a xml fixture, will only
+  # have the xml tags specified in its class definition (using has_one,
+  # has_many, has_text...) so this assertion can be useful to check that
+  # undesired xml tags are filtered.
   def assert_not_parsed message_symbol
     data, message_object = load_message_fixture message_symbol
 
@@ -63,10 +77,14 @@ class Test::Unit::TestCase
             parsed_data.to_s, 
             message_object.to_xml.to_s
     assert_block error do
-      message_object.to_xml.to_s != parsed_data.to_s
+      #message_object.to_xml.to_s != parsed_data.to_s
+      !compare_xml_elements parsed_data.root, message_object.to_xml
     end
   end
 
+  # Asserts that an Adaptation::Message message[link:/classes/Adaptation/Message.html]
+  # build from a xml fixture file passes all the validations specified in the
+  # class definition.
   def assert_validates message_symbol
     data, message_object = load_message_fixture message_symbol
     error = build_message error,
@@ -78,6 +96,9 @@ class Test::Unit::TestCase
     end
   end
 
+  # Asserts that an Adaptation::Message message[link:/classes/Adaptation/Message.html],
+  # build from a xml fixture file doesn't pass all the validations specified in
+  # the class definition.
   def assert_not_validates message_symbol
     data, message_object = load_message_fixture message_symbol
     error = build_message error,
@@ -88,6 +109,10 @@ class Test::Unit::TestCase
     end
   end
 
+  # Asserts that a message[link:/classes/Adaptation/Message.html] has been
+  # published in test environment. This means that the
+  # message[link:/classes/Adaptation/Message.html] will be searched where
+  # the mock object <em>test/mocks/test/publish.rb</em> left it.
   def assert_message_published xml_message
     # build Message object with xml_data
     message_type = xml_message[1..(xml_message.index(/(>| )/) - 1)]
@@ -95,7 +120,7 @@ class Test::Unit::TestCase
     message_object = message_class.to_object(xml_message)
 
     # check for all messages "published" in the mom (that's file /tmp/mom.txt),
-    # if any line corresponds to the message passes as a parameter.
+    # if any line corresponds to the message passed as a parameter.
     message_found = false
     File.open('/tmp/mom.txt', 'r').each{ |line|
       mom_message = REXML::Document.new line
@@ -114,6 +139,16 @@ class Test::Unit::TestCase
     
   end
 
+  # Asserts a database exists. To do so this method tries to establish a
+  # connection with the specified database. Conection information must
+  # be provided with a hash:
+  # <tt>:database</tt>:: <tt>=> database name</tt>
+  # <tt>:host</tt>::     <tt>=> database host</tt>
+  # <tt>:username</tt>:: <tt>=> database user</tt>
+  # <tt>:password</tt>:: <tt>=> database password</tt>
+  # <tt>:adapter</tt>::  <tt>=> database type (default is "mysql")</tt>
+  # These options correspond to those in
+  # Activerecord::Base.establish_conection[http://ar.rubyonrails.com/classes/ActiveRecord/Base.html#M000370]
   def assert_database_present db_settings_hash
     update_activerecord_test_configuration db_settings_hash
 
@@ -138,6 +173,18 @@ class Test::Unit::TestCase
 
   end
 
+  # Asserts a database doesn't exist. To do so this method tries to establish a
+  # connection with the specified database. Connection information must
+  # be provided with a hash. This method assert if connection fails, but that
+  # could also mean that provided connection hash is wrong. The connection options
+  # are the same as in assert_database_present:
+  # <tt>:database</tt>:: <tt>=> database name</tt>
+  # <tt>:host</tt>::     <tt>=> database host</tt>
+  # <tt>:username</tt>:: <tt>=> database user</tt>
+  # <tt>:password</tt>:: <tt>=> database password</tt>
+  # <tt>:adapter</tt>::  <tt>=> database type (default is "mysql")</tt>
+  # These options correspond to those in
+  # Activerecord::Base.establish_conection[http://ar.rubyonrails.com/classes/ActiveRecord/Base.html#M000370]
   def assert_database_not_present db_settings_hash
     update_activerecord_test_configuration db_settings_hash
 
@@ -162,12 +209,6 @@ class Test::Unit::TestCase
 
   end
 
-  def update_activerecord_test_configuration db_settings_hash
-    unless db_settings_hash.nil?
-      ActiveRecord::Base.configurations.update("test" => db_settings_hash)
-    end
-  end
-
   def assert_file_present file
     error = build_message error,
             "? not found",
@@ -185,8 +226,34 @@ class Test::Unit::TestCase
       !File.exists?(file)
     end
   end
+  
+  # Builds a message[link:/classes/Adaptation/Message.html] from a xml fixture
+  # file and processes it the same way mesages from the mom are processed by
+  # adaptation, but using a test environment. Published messages will be
+  # published to a mock MOM.
+  def message message_symbol
+    # build a message object from fixture
+    message_xml, message_object = load_message_fixture message_symbol
+
+    # load mock objects
+    Dir["test/mocks/test/*.rb"].each do |f|
+      require f
+    end 
 
-  def get_message_fixture fixture_name
+    # clean mom (delete mom.txt file)
+    mom_mock_file = 'test/mocks/test/mom.txt'
+    if File.exists? mom_mock_file
+      File.delete mom_mock_file
+    end
+
+    # process message
+    @adaptor.process message_object
+
+  end
+  
+  private
+
+  def get_message_fixture fixture_name #:nodoc:
     fixture_file = ADAPTOR_ROOT + '/test/fixtures/' + fixture_name + '.xml'
     fixture_contents = ""
     File.open(fixture_file).each { |line|
@@ -197,7 +264,7 @@ class Test::Unit::TestCase
     fixture_contents.chomp
   end
 
-  def load_message_fixture fixture_symbol
+  def load_message_fixture fixture_symbol #:nodoc:
     data = get_message_fixture(fixture_symbol.to_s)
     class_name = self.class.to_s.gsub("Test", "")
     class_name = class_name.gsub("Adaptor", "")
@@ -205,8 +272,8 @@ class Test::Unit::TestCase
     message_object = message_class.to_object(data)
     [data, message_object]
   end
-
-  def get_class_object(searched_class)
+  
+  def get_class_object(searched_class) #:nodoc:
     class_object = nil
     ObjectSpace.each_object(Class){|aClass|
       class_object = aClass if aClass.to_s == searched_class
@@ -218,27 +285,7 @@ class Test::Unit::TestCase
     end
   end
 
-  def message message_symbol
-    # build a message object from fixture
-    message_xml, message_object = load_message_fixture message_symbol
-
-    # load mock objects
-    Dir["test/mocks/test/*.rb"].each do |f|
-      require f
-    end 
-
-    # clean mom (delete mom.txt file)
-    mom_mock_file = 'test/mocks/test/mom.txt'
-    if File.exists? mom_mock_file
-      File.delete mom_mock_file
-    end
-
-    # process message
-    @adaptor.process message_object
-
-  end
-
-  def compare_xml_elements element1, element2
+  def compare_xml_elements element1, element2 #:nodoc:
     if element1.has_attributes?
        if !elements2.has_attributes?
          return false
@@ -279,4 +326,10 @@ class Test::Unit::TestCase
     return true
   end
   
+  def update_activerecord_test_configuration db_settings_hash #:nodoc:
+    unless db_settings_hash.nil?
+      ActiveRecord::Base.configurations.update("test" => db_settings_hash)
+    end
+  end
+  
 end

data/lib/rails_generator/generators/components/message/message_generator.rb

@@ -6,7 +6,7 @@ class MessageGenerator < Rails::Generator::NamedBase
       m.class_collisions class_path, class_name, "#{class_name}Test"
 
       # Model, test, and fixture directories.
-      m.directory File.join('app/mmessages', class_path)
+      m.directory File.join('app/messages', class_path)
       m.directory File.join('test/unit', class_path)
       m.directory File.join('test/fixtures', class_path)
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: adaptation
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 date: 2007-04-30 00:00:00 +02:00
 summary: Framework to facilitate web-application interaction.
 require_paths: