sedna 0.4.0 → 0.5.0

data/CHANGES

@@ -1,3 +1,9 @@
+=== 0.5.0
+
+* Released on April 26th, 2009.
+* Added Sedna::Exception#code, which returns the \Sedna error code that can
+  be used to reliably identify which specific error occurred.
+
 === 0.4.0
 
 * Released on January 4th, 2009.

data/README

@@ -32,7 +32,7 @@ limitations under the License.
 
 === Current version
 
-The current version of this library is 0.4.0. This release is a <b>beta version</b>.
+The current version of this library is 0.5.0. This is a <b>stable release</b>.
 For a complete overview all recent and previous changes, see CHANGES.
 
 === Requirements
@@ -51,7 +51,7 @@ library as a rubygem.
 
   % gem install sedna
 
-If the library or header files of the S<i></i>edna C driver are located at non-default
+If the library or header files of the \Sedna C driver are located at non-default
 locations, you can specify these locations by adding the <tt>--with-sedna-lib</tt>
 or <tt>--with-sedna-include</tt> options when installing.
 

data/Rakefile

@@ -57,7 +57,7 @@ end
 
 gem_spec = Gem::Specification.new do |s|
   s.name = "sedna"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.summary = "Sedna XML DBMS client library."
   s.description = %{Ruby extension that provides a client library for the Sedna XML DBMS, making use of the official C driver of the Sedna project.}
@@ -84,8 +84,8 @@ Rake::GemPackageTask.new gem_spec do |p|
   p.need_zip = true
 end
 
-Rake::RDocTask.new { |rdoc|
+Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title = RDOC_TITLE
   rdoc.rdoc_files.include *RDOC_FILES
-}
+end

data/ext/sedna.c

@@ -62,6 +62,7 @@
 #define IV_PW "@password"
 #define IV_AUTOCOMMIT "@autocommit"
 #define IV_MUTEX "@mutex"
+#define IV_EXC_CODE "@code"
 
 // Define a shorthand for the common SednaConnection structure.
 typedef struct SednaConnection SC;
@@ -129,43 +130,57 @@ static VALUE cSednaTrnError;
 // called that generated the error and should be passed as res.
 static void sedna_err(SC *conn, int res)
 {
-	VALUE exception;
+	VALUE exc_class, exc;
 	const char *msg;
-	char *err, *details, *p;
+	char *code, *err, *details, *p, exc_message[BUFSIZ];
 
 	switch(res) {
 		case SEDNA_AUTHENTICATION_FAILED:
-			exception = cSednaAuthError; break;
+			exc_class = cSednaAuthError; break;
 		case SEDNA_OPEN_SESSION_FAILED:
 		case SEDNA_CLOSE_SESSION_FAILED:
-			exception = cSednaConnError; break;
+			exc_class = cSednaConnError; break;
 		case SEDNA_BEGIN_TRANSACTION_FAILED:
 		case SEDNA_ROLLBACK_TRANSACTION_FAILED:
 		case SEDNA_COMMIT_TRANSACTION_FAILED:
-			exception = cSednaTrnError; break;
+			exc_class = cSednaTrnError; break;
 		case SEDNA_ERROR:
 		default:
-			exception = cSednaException;
+			exc_class = cSednaException;
 	}
 
 	msg = SEgetLastErrorMsg(conn);
+	// SEgetLastErrorCode(conn) is useless, because it varies if the order of
+	// errors changes. The actual code is a string which is defined in error_codes.h
+	// in the Sedna source code.
+    code = strstr(msg, "ERROR ");
 	err = strstr(msg, "\n");
 	details = strstr(err, "\nDetails: ");
 
+    if(code != NULL) {
+        code += 6; // Advance beyond "ERROR "
+        if((p = strstr(code, "\n")) != NULL) strncpy(p, "\0", 1);
+    }
+
 	if(err != NULL) {
-		err++;
+		err++; // Advance beyond "\n"
 		if((p = strstr(err, "\n")) != NULL) strncpy(p, "\0", 1);
 	} else {
 		err = "Unknown error.";
 	}
 
 	if(details != NULL) {
-		details += 10;
+		details += 10; // Advance beyond "\nDetails: "
 		while((p = strstr(details, "\n")) != NULL) strncpy(p, " ", 1);
-		rb_raise(exception, "%s (%s)", err, details);
+        snprintf(exc_message, BUFSIZ, "%s (%s)", err, details);
 	} else {
-		rb_raise(exception, "%s", err);
+        snprintf(exc_message, BUFSIZ, "%s", err);
 	}
+    exc = rb_exc_new2(exc_class, exc_message);
+    if(code != NULL) {
+        rb_iv_set(exc, IV_EXC_CODE, rb_str_new2(code));
+    }
+    rb_exc_raise(exc);
 }
 
 // Retrieve the SednaConnection struct from the Ruby Sedna object obj.
@@ -982,7 +997,10 @@ void Init_sedna()
 
 	/*
 	 * Generic exception class for errors. All errors raised by the \Sedna
-	 * client library are of type Sedna::Exception.
+	 * client library are of type Sedna::Exception. The original error code
+	 * can be retrieved with the +code+ attribute. A list of all error codes
+	 * is defined in the \Sedna source:
+	 * http://modis.ispras.ru/src/sedna/kernel/common/errdbg/error.codes
 	 *
 	 * === Subclasses
 	 *
@@ -1000,6 +1018,13 @@ void Init_sedna()
 	 *   Raised when a transaction could not be committed.
 	 */
 	cSednaException = rb_define_class_under(cSedna, "Exception", rb_eStandardError);
+	/*
+     * Returns the error code associated with this exception. This code is a string
+     * that can be used to accurately identify which error has occurred. Some
+     * errors are thrown by the Ruby client rather than the C bindings. In these
+     * cases, the error code is +nil+.
+     */
+    rb_define_attr(cSednaException, "code", 1, 0);
 
 	/*
 	 * Sedna::AuthenticationError is a subclass of Sedna::Exception, and is

data/test/sedna_test.rb

@@ -798,4 +798,57 @@ class SednaTest < Test::Unit::TestCase
     @@sedna.transaction
     assert_nil @@sedna.rollback
   end
+  
+  # Test Sedna::Exception#code
+  test "code should return error code after connection failure" do
+    code = false
+    begin
+      Sedna.connect @@spec.merge(:username => "non-existent-user")
+    rescue Sedna::AuthenticationError => error
+      code = error.code
+    end
+    assert_equal "SE3053", code
+  end
+
+  test "code should return error code after trying to execute invalid statements" do
+    code = false
+    begin
+      @@sedna.execute "INVALID"
+    rescue Sedna::Exception => error
+      code = error.code
+    end
+    assert_equal "XPDY0002", code
+  end
+
+  test "code should return error code after trying to start a transaction within a transaction" do
+    code = false
+    @@sedna.transaction
+    begin
+      @@sedna.transaction
+    rescue Sedna::TransactionError => error
+      code = error.code
+    end
+    @@sedna.commit
+    assert_equal "SE4612", code
+  end
+  
+  test "code should return error code after trying to load an invalid document" do
+    code = false
+    begin
+      @@sedna.load_document "<doc/> this is an invalid document", "some_doc"
+    rescue Sedna::Exception => error
+      code = error.code
+    end
+    assert_equal "SE2005", code
+  end
+
+  test "code should be nil if error is raised from inside the ruby client" do
+    code = false
+    begin
+      @@sedna.commit
+    rescue Sedna::TransactionError => error
+      code = error.code
+    end
+    assert_nil code
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sedna
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Rolf Timmermans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-04 00:00:00 +01:00
+date: 2009-04-26 00:00:00 +02:00
 default_executable: 
 dependencies: []