sedna 0.1.0 → 0.2.0

data/CHANGES

@@ -1,6 +1,12 @@
+=== 0.2.0
+
+* Released on December 15th, 2008.
+* Added support for importing documents from a string or file (Sedna#load_document).
+* Fixed garbage collection error for unsuccessful connections.
+
 === 0.1.0
 
-* Released on the December 8th, 2008.
+* Released on December 8th, 2008.
 * Development preview (alpha) release.
 * Simple, high-level API.
 * Tested with Ruby 1.8.7 and Ruby 1.9.0.

data/README

@@ -32,7 +32,7 @@ limitations under the License.
 
 === Current version
 
-The current version of this library is 0.1.0. This version is a <b>development
+The current version of this library is 0.2.0. This version is a <b>development
 preview</b>. The API may change significantly between minor versions.
 For a complete overview all recent and previous changes, see CHANGES.
 

data/ext/sedna.c

@@ -24,7 +24,8 @@
 #include "libsedna.h"
 
 // Size of the read buffer.
-#define BUF_LEN 8192
+#define RESULT_BUF_LEN 8192
+#define LOAD_BUF_LEN 8192
 
 // Use macros to fool RDoc and hide some of our methods/aliases.
 #define rb_define_undocumented_alias(kl, new, old) rb_define_alias(kl, new, old)
@@ -83,7 +84,7 @@ static void sedna_err(SC *conn, int res)
 	}
 	if(details != NULL) {
 		details += 10;
-		if((p = strstr(details, "\n")) != NULL) strncpy(p, "\0", 1);
+		while((p = strstr(details, "\n")) != NULL) strncpy(p, " ", 1);
 		rb_raise(exception, "%s (%s)", err, details);
 	} else {
 		rb_raise(exception, "%s", err);
@@ -114,10 +115,10 @@ static void sedna_mark(SC *conn)
 static VALUE sedna_read(SC *conn, int strip_n)
 {
 	int bytes_read = 0;
-	char buffer[BUF_LEN];
+	char buffer[RESULT_BUF_LEN];
 	VALUE str = rb_str_buf_new(0);
 	do {
-		bytes_read = SEgetData(conn, buffer, BUF_LEN - 1);
+		bytes_read = SEgetData(conn, buffer, RESULT_BUF_LEN - 1);
 		if(bytes_read == SEDNA_ERROR) {
 			sedna_err(conn, SEDNA_ERROR);
 		} else {
@@ -215,7 +216,16 @@ static VALUE cSedna_initialize(VALUE self, VALUE options)
 	if(NIL_P(pw_v = rb_hash_aref(options, pw_k))) pw = "MANAGER"; else pw = STR2CSTR(pw_v);
 
 	res = SEconnect(conn, host, db, user, pw);
-	verify_res(SEDNA_SESSION_OPEN, res, conn);
+	if(res != SEDNA_SESSION_OPEN) {
+		// We have to set the connection status to closed explicitly here,
+		// because the GC routine sedna_free() will test for this status, but
+		// the socket is already closed by SEconnect(). If we do not change the
+		// status, sedna_free() will attempt to close the connection again by
+		// calling SEclose(), which will definitely lead to unpredictable
+		// results.
+		conn->isConnectionOk = SEDNA_CONNECTION_CLOSED;
+		sedna_err(conn, res);
+	}
 
 	// Initialize @autocommit to true (default argument).
 	rb_iv_set(self, "@autocommit", Qtrue);
@@ -297,7 +307,7 @@ static VALUE cSedna_s_connect(VALUE klass, VALUE options)
  *   sedna.execute(query) -> array or nil
  *   sedna.query(query) -> array or nil
  *
- * Execute the given +query+ against a \Sedna database. Returns an array if the
+ * Executes the given +query+ against a \Sedna database. Returns an array if the
  * given query is a select query. The elements of the array are strings that
  * correspond to each result in the result set. If the query is an update query
  * or a (bulk) load query, +nil+ is returned. When attempting to \execute a
@@ -340,6 +350,60 @@ static VALUE cSedna_execute(VALUE self, VALUE query)
 	}
 }
 
+/*
+ * call-seq:
+ *   sedna.load_document(document, doc_name, col_name = nil) -> nil
+ *
+ * Creates a new document named +doc_name+ in collection +col_name+, or as a
+ * stand-alone document if +col_name+ is +nil+. The string +document+ is
+ * subsequently loaded into the newly created document. As an alternative, the
+ * argument +document+ may be an IO object (or any descendant, such as a File
+ * object).
+ *
+ * If the document was successfully loaded, this method returns +nil+. If an
+ * error occurs, a Sedna::Exception is raised.
+ *
+ * ==== Examples
+ *
+ * Create a new standalone document and retrieve it.
+ *
+ *   sedna.load_document "<my_document>Hello world!</my_document>", "my_doc"       
+ *     #=> nil
+ *   sedna.execute "doc('my_doc')"
+ *     #=> ["<?xml version=\"1.0\" standalone=\"yes\"?><my_document>Hello world!</my_document>"]
+ *
+ * Open a file and import its contents into a new document in an existing collection.
+ *
+ *   File.open "document.xml" do |file|
+ *     sedna.load_document file, "my_doc", "my_col"
+ *   end
+ */
+static VALUE cSedna_load_document(int argc, VALUE *argv, VALUE self)
+{
+	int res = 0;
+	SC *conn = sedna_struct(self);
+	VALUE document, doc_name, col_name, buf;
+	char *doc_name_c, *col_name_c;
+	if(SEconnectionStatus(conn) != SEDNA_CONNECTION_OK) rb_raise(cSednaConnError, "Connection is closed.");
+	rb_scan_args(argc, argv, "21", &document, &doc_name, &col_name); // 2 mandatory args, 1 optional.
+	doc_name_c = STR2CSTR(doc_name);
+	col_name_c = NIL_P(col_name) ? NULL : STR2CSTR(col_name);
+	if(TYPE(document) == T_FILE) {
+		while(!NIL_P(buf = rb_funcall(document, rb_intern("read"), 1, INT2NUM(LOAD_BUF_LEN)))) {
+			res = SEloadData(conn, STR2CSTR(buf), RSTRING_LEN(buf), doc_name_c, col_name_c);
+			verify_res(SEDNA_DATA_CHUNK_LOADED, res, conn);
+		}
+		if(res == 0) rb_raise(cSednaException, "Document is empty.");
+	} else {
+		if(RSTRING_LEN(document) == 0) rb_raise(cSednaException, "Document is empty.");
+		res = SEloadData(conn, STR2CSTR(document), RSTRING_LEN(document), doc_name_c, col_name_c);
+		verify_res(SEDNA_DATA_CHUNK_LOADED, res, conn);
+	}
+	res = SEendLoadData(conn);
+	verify_res(SEDNA_BULK_LOAD_SUCCEEDED, res, conn);
+	return Qnil;
+}
+
 /* :nodoc:
  *
  * Turn autocommit on or off.
@@ -364,7 +428,7 @@ static VALUE cSedna_autocommit_get(VALUE self)
 
 /*
  * call-seq:
- *   sedna.transaction { ... } -> true
+ *   sedna.transaction { ... } -> nil
  *
  * Wraps the given block in a \transaction. If the block runs
  * completely, the \transaction is committed. If the stack is unwinded
@@ -373,7 +437,7 @@ static VALUE cSedna_autocommit_get(VALUE self)
  * invoking +throw+. Note that Exceptions will not be rescued -- they will be
  * re-raised after rolling back the \transaction.
  *
- * This method returns +true+ if the \transaction is successfully committed
+ * This method returns +nil+ if the \transaction is successfully committed
  * to the database. If the given block completes successfully, but the
  * \transaction fails to be committed, a Sedna::TransactionError will
  * be raised. 
@@ -381,14 +445,14 @@ static VALUE cSedna_autocommit_get(VALUE self)
  * ==== Examples
  *
  *   sedna.transaction do
- *     count = sedna.execute "count(collection('mycol')/items)"  #=> 0
- *     sedna.execute "update insert <total>#{count}</total> into doc('mydoc')"
+ *     count = sedna.execute "count(collection('my_col')/items)"  #=> 0
+ *     sedna.execute "update insert <total>#{count}</total> into doc('my_doc')"
  *     # ...
  *   end
  *   # Transaction is committed.
  *
  *   sedna.transaction do
- *     count = sedna.execute "count(collection('mycol')/items)"  #=> 0
+ *     count = sedna.execute "count(collection('my_col')/items)"  #=> 0
  *     throw :no_items if count == 0
  *     # ... never get here
  *   end
@@ -412,7 +476,7 @@ static VALUE cSedna_transaction(VALUE self)
 		switch_sedna_autocommit(conn, rb_iv_get(self, "@autocommit"));
 		rb_jump_tag(status); // Re-raise exception.
 	}
-	return Qtrue;
+	return Qnil;
 }
 
 void Init_sedna()
@@ -440,6 +504,7 @@ void Init_sedna()
 	rb_define_singleton_method(cSedna, "connect", cSedna_s_connect, 1);
 	rb_define_method(cSedna, "initialize", cSedna_initialize, 1);
 	rb_define_method(cSedna, "execute", cSedna_execute, 1);
+	rb_define_method(cSedna, "load_document", cSedna_load_document, -1);
 	rb_define_undocumented_alias(cSedna, "query", "execute");
 	rb_define_method(cSedna, "close", cSedna_close, 0);
 

data/test/{test_sedna.rb → sedna_test.rb}

@@ -20,11 +20,13 @@
 # This file contains the test suite to verify the client library is working
 # correctly.
 
+$:.unshift(File.dirname(__FILE__) + '/../ext')
+
 require 'test/unit'
-require '../ext/sedna'
+require 'sedna'
 require 'socket'
 
-class TestSedna < Test::Unit::TestCase
+class SednaTest < Test::Unit::TestCase
   def setup
     @connection = {
       :database => "test",
@@ -36,7 +38,9 @@ class TestSedna < Test::Unit::TestCase
   
   def teardown
   end
-  
+
+  # Faux test that just checks if we can connect, otherwise the test
+  # suite is aborted.
   def test_aaa_connection
     port = 5050
     begin
@@ -59,19 +63,19 @@ class TestSedna < Test::Unit::TestCase
 
   def test_connect_should_raise_exception_when_host_not_found
     assert_raises Sedna::ConnectionError do
-      Sedna.connect @connection.merge(:host => "non-existant-host")
+      Sedna.connect @connection.merge(:host => "non-existent-host")
     end
   end
 
   def test_connect_should_raise_exception_when_credentials_are_incorrect
     assert_raises Sedna::AuthenticationError do
-      Sedna.connect @connection.merge(:username => "non-existant-user")
+      Sedna.connect @connection.merge(:username => "non-existent-user")
     end
   end
   
   def test_connect_should_return_nil_on_error
     begin
-      sedna = Sedna.connect @connection.merge(:username => "non-existant-user")
+      sedna = Sedna.connect @connection.merge(:username => "non-existent-user")
     rescue
     end
     assert_nil sedna
@@ -126,16 +130,6 @@ class TestSedna < Test::Unit::TestCase
       end
     end
   end
-
-  # TODO: Fix the following strangely-failing test case.
-  #def test_zzz_connect_should_not_fail_to_close_connection_when_require_called_inside_block
-  #  # Squash a strange bug -- only appears to work if this test is run last and nothing else fails.
-  #  assert_nothing_raised do
-  #    Sedna.connect @connection do |sedna|
-  #      require 'pp'
-  #    end
-  #  end
-  #end
   
   # Test sedna.close.
   def test_close_should_return_nil
@@ -221,6 +215,138 @@ class TestSedna < Test::Unit::TestCase
       assert_equal ["<test/>"], sedna.query("<test/>")
     end
   end
+
+  # Test sedna.load_document.
+  def test_load_document_should_create_document_in_given_collection
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_create_document_in_given_collection"
+      col = "test_collection"
+      doc = "<?xml version=\"1.0\" standalone=\"yes\"?><document>\n <node/>\n</document>"
+
+      sedna.execute "create collection '#{col}'" rescue Sedna::Exception
+      sedna.execute "drop document '#{name}' in collection '#{col}'" rescue Sedna::Exception
+      sedna.load_document doc, name, col
+      assert_equal doc, sedna.execute("doc('#{name}', '#{col}')").first
+      sedna.execute "drop document '#{name}' in collection '#{col}'" rescue Sedna::Exception
+      sedna.execute "drop collection '#{col}'" rescue Sedna::Exception
+    end
+  end
+
+  def test_load_document_should_create_standalone_document_if_collection_is_unspecified
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_create_standalone_document_if_collection_is_unspecified"
+      doc = "<?xml version=\"1.0\" standalone=\"yes\"?><document>\n <node/>\n</document>"
+
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      sedna.load_document doc, name
+      assert_equal doc, sedna.execute("doc('#{name}')").first
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
+  
+  def test_load_document_should_create_standalone_document_if_collection_is_nil
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_create_standalone_document_if_collection_is_unspecified"
+      doc = "<?xml version=\"1.0\" standalone=\"yes\"?><document>\n <node/>\n</document>"
+
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      sedna.load_document doc, name, nil
+      assert_equal doc, sedna.execute("doc('#{name}')").first
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
+  
+  def test_load_document_should_return_nil_if_standalone_document_loaded_successfully
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_return_nil_if_document_loaded_successfully"
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      assert_nil sedna.load_document("<document><node/></document>", name)
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
+
+  def test_load_document_should_fail_if_autocommit_is_false
+    Sedna.connect @connection do |sedna|
+      sedna.autocommit = false
+      assert_raises Sedna::Exception do
+        sedna.load_document "<test/>", "some_doc"
+      end
+    end
+  end
+  
+  def test_load_document_should_fail_with_sedna_exception_for_invalid_documents
+    Sedna.connect @connection do |sedna|
+      assert_raises Sedna::Exception do
+        sedna.load_document "<doc/> this is an invalid document", "some_doc"
+      end
+    end
+  end
+  
+  def test_load_document_should_raise_exception_with_complete_details_for_invalid_documents
+    Sedna.connect @connection do |sedna|
+      e = nil
+      begin
+        sedna.load_document "<doc/> junk here", "some_doc"
+      rescue Sedna::Exception => e
+      end
+      assert_match /junk after document element/, e.message
+    end
+  end
+  
+  def test_load_document_should_fail_with_sedna_connection_error_if_connection_is_closed
+    Sedna.connect @connection do |sedna|
+      sedna.close
+      assert_raises Sedna::ConnectionError do
+        sedna.load_document "<doc/>", "some_doc"
+      end
+    end
+  end
+
+  def test_load_document_should_create_document_if_given_document_is_io_object
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_create_document_if_given_document_is_io_object"
+      doc = "<?xml version=\"1.0\" standalone=\"yes\"?><document>" << ("\n <some_very_often_repeated_node/>" * 800) << "\n</document>"
+      p_out, p_in = IO.pipe
+      p_in.write doc
+      p_in.close
+
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      sedna.load_document p_out, name, nil
+      assert_equal doc.length, sedna.execute("doc('#{name}')").first.length
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
+
+  def test_load_document_should_raise_sedna_exception_if_given_document_is_empty_io_object
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_raise_sedna_exception_if_given_document_is_empty_io_object"
+      p_out, p_in = IO.pipe
+      p_in.close
+
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      e = nil
+      begin
+        sedna.load_document p_out, name, nil
+      rescue Sedna::Exception => e
+      end
+      assert_equal "Document is empty.", e.message
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
+
+  def test_load_document_should_raise_sedna_exception_if_given_document_is_empty_string
+    Sedna.connect @connection do |sedna|
+      name = "test_load_document_should_raise_sedna_exception_if_given_document_is_empty_string"
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+      e = nil
+      begin
+        sedna.load_document "", name, nil
+      rescue Sedna::Exception => e
+      end
+      assert_equal "Document is empty.", e.message
+      sedna.execute "drop document '#{name}'" rescue Sedna::Exception
+    end
+  end
   
   # Test sedna.autocommit= / sedna.autocommit.
   def test_autocommit_should_return_true_by_default
@@ -276,9 +402,9 @@ class TestSedna < Test::Unit::TestCase
   end
   
   # Test sedna.transaction.
-  def test_transaction_should_return_true_if_committed
+  def test_transaction_should_return_nil_if_committed
     Sedna.connect @connection do |sedna|
-      assert_equal true, sedna.transaction(){}
+      assert_nil sedna.transaction(){}
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sedna
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rolf Timmermans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-08 00:00:00 +01:00
+date: 2008-12-15 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -26,7 +26,7 @@ extra_rdoc_files:
 files: 
 - ext/extconf.rb
 - ext/sedna.c
-- test/test_sedna.rb
+- test/sedna_test.rb
 - CHANGES
 - README
 has_rdoc: true
@@ -59,4 +59,4 @@ signing_key:
 specification_version: 2
 summary: Sedna XML DBMS client library.
 test_files: 
-- test/test_sedna.rb
+- test/sedna_test.rb