Rename encoding keyword argument to charset

`encoding` denotes the actual `Encoding` then used to associate strings.

Author: andyundso

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, intern_active, intern_connect;
+static ID intern_new, intern_dup, 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;
@@ -15,15 +15,6 @@ static VALUE cTinyTdsResult, cKernel, cDate;
 rb_encoding *binaryEncoding;
 VALUE opt_onek, opt_onebil, opt_float_zero, opt_four, opt_tenk;
 
-static void rb_tinytds_client_mark(void *ptr)
-{
-  tinytds_client_wrapper *cwrap = (tinytds_client_wrapper *)ptr;
-
-  if (cwrap) {
-    rb_gc_mark(cwrap->charset);
-  }
-}
-
 static void rb_tinytds_client_free(void *ptr)
 {
   tinytds_client_wrapper *cwrap = (tinytds_client_wrapper *)ptr;
@@ -51,7 +42,7 @@ static size_t tinytds_client_wrapper_size(const void* data)
 static const rb_data_type_t tinytds_client_wrapper_type = {
   .wrap_struct_name = "tinytds_client_wrapper",
   .function = {
-    .dmark = rb_tinytds_client_mark,
+    .dmark = NULL,
     .dfree = rb_tinytds_client_free,
     .dsize = tinytds_client_wrapper_size,
   },
@@ -459,7 +450,6 @@ static VALUE allocate(VALUE klass)
   tinytds_client_wrapper *cwrap;
   obj = TypedData_Make_Struct(klass, tinytds_client_wrapper, &tinytds_client_wrapper_type, cwrap);
   cwrap->closed = 1;
-  cwrap->charset = Qnil;
   cwrap->userdata = malloc(sizeof(tinytds_client_userdata));
   cwrap->userdata->closed = 1;
   rb_tinytds_client_reset_userdata(cwrap->userdata);
@@ -910,12 +900,6 @@ static VALUE rb_tiny_tds_do(VALUE self, VALUE sql)
   return rb_tinytds_affected_rows(cwrap->client);
 }
 
-static VALUE rb_tinytds_charset(VALUE self)
-{
-  GET_CLIENT_WRAPPER(self);
-  return cwrap->charset;
-}
-
 static VALUE rb_tinytds_encoding(VALUE self)
 {
   GET_CLIENT_WRAPPER(self);
@@ -954,7 +938,7 @@ static VALUE rb_tinytds_connect(VALUE self)
   contained = rb_iv_get(self, "@contained");
   database = rb_iv_get(self, "@database");
   dataserver = rb_iv_get(self, "@dataserver");
-  charset = rb_iv_get(self, "@encoding");
+  charset = rb_iv_get(self, "@charset");
   login_timeout = rb_iv_get(self, "@login_timeout");
   password = rb_iv_get(self, "@password");
   tds_version = rb_iv_get(self, "@tds_version");
@@ -1021,7 +1005,6 @@ static VALUE rb_tinytds_connect(VALUE self)
     VALUE transposed_encoding, timeout_string;
 
     cwrap->closed = 0;
-    cwrap->charset = charset;
 
     if (!NIL_P(tds_version)) {
       dbsetversion(NUM2INT(tds_version));
@@ -1043,8 +1026,7 @@ static VALUE rb_tinytds_connect(VALUE self)
       dbuse(cwrap->client, StringValueCStr(database));
     }
 
-    transposed_encoding = rb_funcall(cTinyTdsClient, intern_transpose_iconv_encoding, 1, charset);
-    cwrap->encoding = rb_enc_find(StringValueCStr(transposed_encoding));
+    cwrap->encoding = rb_enc_find(StringValueCStr(charset));
     cwrap->identity_insert_sql = "SELECT CAST(SCOPE_IDENTITY() AS bigint) AS Ident";
   }
 
@@ -1068,7 +1050,6 @@ void init_tinytds_client()
   rb_define_method(cTinyTdsClient, "execute", rb_tinytds_execute, -1);
   rb_define_method(cTinyTdsClient, "insert", rb_tiny_tds_insert, 1);
   rb_define_method(cTinyTdsClient, "do", rb_tiny_tds_do, 1);
-  rb_define_method(cTinyTdsClient, "charset", rb_tinytds_charset, 0);
   rb_define_method(cTinyTdsClient, "encoding", rb_tinytds_encoding, 0);
   rb_define_method(cTinyTdsClient, "escape", rb_tinytds_escape, 1);
   rb_define_method(cTinyTdsClient, "return_code", rb_tinytds_return_code, 0);
@@ -1082,7 +1063,6 @@ void init_tinytds_client()
   /* Intern Misc */
   intern_new = rb_intern("new");
   intern_dup = rb_intern("dup");
-  intern_transpose_iconv_encoding = rb_intern("transpose_iconv_encoding");
   intern_local_offset = rb_intern("local_offset");
   intern_gsub = rb_intern("gsub");
   intern_call = rb_intern("call");

lib/tiny_tds/client.rb

@@ -1,6 +1,6 @@
 module TinyTds
   class Client
-    attr_reader :app_name, :contained, :database, :dataserver, :encoding, :message_handler, :login_timeout, :password, :port, :tds_version, :timeout, :username, :use_utf16
+    attr_reader :app_name, :charset, :contained, :database, :dataserver, :message_handler, :login_timeout, :password, :port, :tds_version, :timeout, :username, :use_utf16
 
     @default_query_options = {
       as: :hash,
@@ -13,14 +13,6 @@ class Client
     class << self
       attr_reader :default_query_options
 
-      # Most, if not all, iconv encoding names can be found by ruby. Just in case, you can
-      # overide this method to return a string name that Encoding.find would work with. Default
-      # is to return the passed encoding.
-      #
-      def transpose_iconv_encoding(encoding)
-        encoding
-      end
-
       def local_offset
         ::Time.local(2010).utc_offset.to_r / 86_400
       end
@@ -30,7 +22,7 @@ def local_offset
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
-    def initialize(app_name: "TinyTds", azure: false, contained: false, database: nil, dataserver: nil, encoding: "UTF-8", message_handler: nil, host: nil, login_timeout: 60, password: nil, port: 1433, tds_version: nil, timeout: 5, username: nil, use_utf16: true)
+    def initialize(app_name: "TinyTds", azure: false, charset: "UTF-8", contained: false, database: nil, dataserver: nil, message_handler: nil, host: nil, login_timeout: 60, password: nil, port: 1433, tds_version: nil, timeout: 5, username: nil, use_utf16: true)
       if dataserver.to_s.empty? && host.to_s.empty?
         raise ArgumentError, "missing :host option if no :dataserver given"
       end
@@ -42,9 +34,9 @@ def initialize(app_name: "TinyTds", azure: false, contained: false, database: ni
       end
 
       @app_name = app_name
+      @charset = (charset.nil? || charset.casecmp("utf8").zero?) ? "UTF-8" : charset.upcase
       @database = database
       @dataserver = dataserver || "#{host}:#{port}"
-      @encoding = (encoding.nil? || encoding.casecmp("utf8").zero?) ? "UTF-8" : encoding.upcase
       @login_timeout = login_timeout.to_i
       @password = password if password && password.to_s.strip != ""
       @port = port.to_i

test/client_test.rb

@@ -45,11 +45,11 @@ class ClientTest < TinyTds::TestCase
       assert_equal "''hello''", @client.escape("'hello'")
     end
 
-    ["CP850", "CP1252", "ISO-8859-1"].each do |encoding|
-      it "allows valid iconv character set - #{encoding}" do
-        client = new_connection(encoding: encoding)
-        assert_equal encoding, client.charset
-        assert_equal Encoding.find(encoding), client.encoding
+    ["CP850", "CP1252", "ISO-8859-1"].each do |charset|
+      it "allows valid iconv character set - #{charset}" do
+        client = new_connection(charset:)
+        assert_equal charset, client.charset
+        assert_equal Encoding.find(charset), client.encoding
       ensure
         client&.close
       end