Separate #new and #connect

Author: andyundso

CHANGELOG.md

@@ -8,7 +8,9 @@
 * `#execute`: Replaced `opts` hash with keyword arguments 
 * Removed `symbolize_keys` and `cache_rows` from `#default_query_options`
 * `TinyTds::Client.new` now accepts keyword arguments instead of a hash
-* Renamed `tds_version` and `tds_version_info` to `server_version` and `server_version_info`.
+* Renamed `tds_version` and `tds_version_info` to `server_version` and `server_version_info`
+* Separate `#new` and `#connect`
+  * Instead, before running `#do`, `#execute` or `#insert`, `tiny_tds` will check if the connection is active and re-connect if needed.
 
 ## 3.3.0
 

ext/tiny_tds/client.c

@@ -5,7 +5,7 @@
 VALUE cTinyTdsClient;
 extern VALUE mTinyTds, cTinyTdsError;
 static ID intern_source_eql, intern_severity_eql, intern_db_error_number_eql, intern_os_error_number_eql;
-static ID intern_new, intern_dup, intern_transpose_iconv_encoding, intern_local_offset, intern_gsub, intern_call;
+static ID intern_new, intern_dup, intern_transpose_iconv_encoding, intern_local_offset, intern_gsub, intern_call, intern_active, intern_connect;
 VALUE opt_escape_regex, opt_escape_dblquote;
 
 static ID id_ivar_fields, id_ivar_rows, id_ivar_return_code, id_ivar_affected_rows, id_ivar_default_query_options, intern_bigd, intern_divide;
@@ -468,11 +468,15 @@ static VALUE allocate(VALUE klass)
 
 
 // TinyTds::Client (public)
-
 static VALUE rb_tinytds_server_version(VALUE self)
 {
   GET_CLIENT_WRAPPER(self);
-  return INT2FIX(dbtds(cwrap->client));
+
+  if (rb_funcall(self, intern_active, 0) == Qtrue) {
+    return INT2FIX(dbtds(cwrap->client));
+  } else {
+    return Qnil;
+  }
 }
 
 static VALUE rb_tinytds_close(VALUE self)
@@ -745,6 +749,11 @@ static VALUE rb_tinytds_execute(int argc, VALUE *argv, VALUE self)
   }
 
   GET_CLIENT_WRAPPER(self);
+
+  if (rb_funcall(self, intern_active, 0) == Qfalse) {
+    rb_funcall(self, intern_connect, 0);
+  }
+
   rb_tinytds_send_sql_to_server(cwrap, sql);
 
   VALUE result = rb_obj_alloc(cTinyTdsResult);
@@ -856,6 +865,11 @@ static VALUE rb_tiny_tds_insert(VALUE self, VALUE sql)
 {
   VALUE identity = Qnil;
   GET_CLIENT_WRAPPER(self);
+
+  if (rb_funcall(self, intern_active, 0) == Qfalse) {
+    rb_funcall(self, intern_connect, 0);
+  }
+
   rb_tinytds_send_sql_to_server(cwrap, sql);
   rb_tinytds_result_exec_helper(cwrap->client);
 
@@ -885,6 +899,11 @@ static VALUE rb_tiny_tds_insert(VALUE self, VALUE sql)
 static VALUE rb_tiny_tds_do(VALUE self, VALUE sql)
 {
   GET_CLIENT_WRAPPER(self);
+
+  if (rb_funcall(self, intern_active, 0) == Qfalse) {
+    rb_funcall(self, intern_connect, 0);
+  }
+
   rb_tinytds_send_sql_to_server(cwrap, sql);
   rb_tinytds_result_exec_helper(cwrap->client);
 
@@ -1054,8 +1073,7 @@ void init_tinytds_client()
   rb_define_method(cTinyTdsClient, "escape", rb_tinytds_escape, 1);
   rb_define_method(cTinyTdsClient, "return_code", rb_tinytds_return_code, 0);
   rb_define_method(cTinyTdsClient, "identity_sql", rb_tinytds_identity_sql, 0);
-  /* Define TinyTds::Client Protected Methods */
-  rb_define_protected_method(cTinyTdsClient, "connect", rb_tinytds_connect, 0);
+  rb_define_method(cTinyTdsClient, "connect", rb_tinytds_connect, 0);
   /* Intern TinyTds::Error Accessors */
   intern_source_eql = rb_intern("source=");
   intern_severity_eql = rb_intern("severity=");
@@ -1088,6 +1106,8 @@ void init_tinytds_client()
   intern_timezone = rb_intern("timezone");
   intern_utc = rb_intern("utc");
   intern_local = rb_intern("local");
+  intern_active = rb_intern("active?");
+  intern_connect = rb_intern("connect");
 
   cTinyTdsClient = rb_const_get(mTinyTds, rb_intern("Client"));
   cTinyTdsResult = rb_const_get(mTinyTds, rb_intern("Result"));

lib/tiny_tds/client.rb

@@ -52,8 +52,6 @@ def initialize(app_name: "TinyTds", azure: false, contained: false, database: ni
       @tds_version = tds_versions_setter(tds_version:)
       @username = parse_username(azure:, host:, username:)
       @use_utf16 = use_utf16.nil? || ["true", "1", "yes"].include?(use_utf16.to_s)
-
-      connect
     end
 
     def tds_73?
@@ -71,7 +69,7 @@ def active?
 
     private
 
-    def parse_username(azure: false, host: nil, username:)
+    def parse_username(username:, azure: false, host: nil)
       return username if username.nil? || !azure
       return username if username.include?("@") && !username.include?("database.windows.net")
       user, domain = username.split("@")

test/client_test.rb

@@ -10,20 +10,25 @@ class ClientTest < TinyTds::TestCase
       @client = new_connection
     end
 
-    it "must not be closed" do
-      assert !@client.closed?
-      assert @client.active?
+    it "is considered close without a connection" do
+      client = TinyTds::Client.new(**connection_options)
+
+      assert client.closed?
+      assert !client.active?
+    end
+
+    it "returns nil values for server version without a connection" do
+      client = TinyTds::Client.new(**connection_options)
+
+      assert_nil client.server_version
+      assert_nil client.server_version_info
     end
 
     it "allows client connection to be closed" do
       assert @client.close
       assert @client.closed?
       assert !@client.active?
       assert @client.dead?
-      action = lambda { @client.execute("SELECT 1 as [one]").each }
-      assert_raise_tinytds_error(action) do |e|
-        assert_match %r{closed connection}i, e.message, "ignore if non-english test run"
-      end
     end
 
     it "has getters for the server version information (brittle since conf takes precedence)" do
@@ -299,15 +304,5 @@ class ClientTest < TinyTds::TestCase
         assert_client_works(@client)
       end
     end
-
-    it "throws an error if client is closed" do
-      @client.close
-      assert @client.closed?
-
-      action = lambda { @client.insert("SELECT 1 as [one]") }
-      assert_raise_tinytds_error(action) do |e|
-        assert_match %r{closed connection}i, e.message
-      end
-    end
   end
 end

test/test_helper.rb

@@ -43,6 +43,7 @@ def close_client(client = @client)
 
     def new_connection(**options)
       client = TinyTds::Client.new(**connection_options(options))
+
       if sqlserver_azure?
         client.do("SET ANSI_NULLS ON")
         client.do("SET CURSOR_CLOSE_ON_COMMIT OFF")