ruby-mysql 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13656e5ef8a79113c2dce1fac6f1a47e510c2cd6bfb9958518a966b349bdbb13
-  data.tar.gz: 55a2f5e70d73add2e6d71eb0bb02e19d0d498cacd46c78f0415f8f31620c76ab
+  metadata.gz: fd37c2f40ef7277952c0be41848abc338e29d3a4e9da3f3eed1d1d8f61407c76
+  data.tar.gz: 754994f1cb1f5e4cb007d5f1a3d81238e626ce8d224aef23c58c8af3d5fd351f
 SHA512:
-  metadata.gz: a01515533387aaa8280be8c5244b80d4b245052e2750732f03c6198827dd5975a32f8f472481ba44b14f731135b31aa3744180475444388c7e1158d49bf95556
-  data.tar.gz: 53fe3127e8c358f77a3874e26ae1de91dcd72af11fcd45f40b18875c21a884d21105eccce4808b308bde1e938970316cf6d7f54ac21f9bf94cebb9fc2b8dcbd5
+  metadata.gz: c31c8170682621713905f820a2816377a045b3ba489adc39d3575543483475411bdd7ecead30f806494533dd91819e8e53dad1bd3c090164b80d7600666ea1a4
+  data.tar.gz: 6f59d7638d0f09bd3c21cd34e32cae9e995f26219efc5594b3982b94562a0c3726a1258ebfff5e3b0afbe53764135d96eff0250d57d6d75289f65e3b9957e720

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.1.0] - 2023-10-08
+
+- Support geometry column <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/1>
+- FIX: If the server is localhost and disconnect the connection, Errno::EPIPE is raised <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/3> <https://gitlab.com/tmtms/ruby-mysql/-/issues/1>
+- Allow for existing socket when connecting <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/2> <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/5>
+  - add `io` keyword parameter
+
 ## [4.0.0] - 2022-11-09
 
 ### Incompatible changes

data/README.md

@@ -2,17 +2,21 @@
 
 ## Description
 
-MySQL connector for Ruby.
+ruby-mysql is a MySQL client library.
+It is written entirely in Ruby.
+Therefore libmysqlclient is not required and no compilation is required during installation.
 
 ## Installation
 
-```
+```ruby
 gem install ruby-mysql
 ```
 
 ## Synopsis
 
 ```ruby
+require 'mysql'
+
 my = Mysql.connect('mysql://username:password@hostname:port/dbname?charset=utf8mb4')
 my.query("select col1, col2 from tblname").each do |col1, col2|
   p col1, col2
@@ -21,6 +25,95 @@ stmt = my.prepare('insert into tblname (col1,col2) values (?,?)')
 stmt.execute 123, 'abc'
 ```
 
+## Major incompatibility with 3.0
+
+### Result values are now converted by default
+
+| MySQL type          | Ruby class         |
+|---------------------|--------------------|
+| NULL                | NilClass           |
+| INT                 | Integer            |
+| DECIMAL             | BigDecimal         |
+| FLOAT, DOUBLE       | Float              |
+| DATE                | Date               |
+| DATETIME, TIMESTAMP | Time               |
+| TIME                | Float (as seconds) |
+| YEAR                | Integer            |
+| CHAR, VARCHAR       | String             |
+| BIT                 | String             |
+| TEXT, BLOB, JSON    | String             |
+
+3.0:
+```ruby
+pp my.query('select 123,123.45,now(),cast(now() as date)').fetch.map{[_1, _1.class]}
+#=> [["123", String],
+#    ["123.45", String],
+#    ["2022-11-15 00:17:11", String],
+#    ["2022-11-15", String]]
+```
+
+4.0:
+```ruby
+pp my.query('select 123,123.45,now(),cast(now() as date)').fetch.map{[_1, _1.class]}
+#=> [[123, Integer],
+#    [0.12345e3, BigDecimal],
+#    [2022-11-15 00:17:17 +0900, Time],
+#    [#<Date: 2022-11-15 ((2459899j,0s,0n),+0s,2299161j)>, Date]]
+```
+
+To specify `cast: false`, you get the same behavior as in 3.0.
+```ruby
+my.query('select 123,123.45,now(),cast(now() as date)', cast: false).fetch.map{[_1, _1.class]}
+#=> [["123", String],
+#    ["123.45", String],
+#    ["2022-11-15 00:19:18", String],
+#    ["2022-11-15", String]]
+```
+
+It can also be specified during Mysql.new and Mysql.connect.
+
+```ruby
+my = Mysql.connect('mysql://user:pass@localhost/', cast: false)
+```
+
+Changing mysql.default_options will affect the behavior of subsequently created instances.
+
+```ruby
+my1 = Mysql.connect('mysql://user:pass@localhost/')
+Mysql.default_options[:cast] = false
+my2 = Mysql.connect('mysql://user:pass@localhost/')
+pp my1.query('select 123,123.45,now(),cast(now() as date)').fetch.map{[_1, _1.class]}
+#=> [[123, Integer],
+#    [0.12345e3, BigDecimal],
+#    [2022-11-15 00:26:09 +0900, Time],
+#    [#<Date: 2022-11-15 ((2459899j,0s,0n),+0s,2299161j)>, Date]]
+pp my2.query('select 123,123.45,now(),cast(now() as date)').fetch.map{[_1, _1.class]}
+#=> [["123", String],
+#    ["123.45", String],
+#    ["2022-11-15 00:26:09", String],
+#    ["2022-11-15", String]]
+```
+
+### Mysql::Result#each now always return records from the beginning
+
+3.0:
+```ruby
+res = my.query('select 123 union select 456')
+res.entries
+#=> [["123"], ["456"]]
+res.entries
+#=> []
+```
+
+4.0:
+```ruby
+res = my.query('select 123 union select 456')
+res.entries
+#=> [[123], [456]]
+res.entries
+#=> [[123], [456]]
+```
+
 ## Copyright
 
 * Author: TOMITA Masahiro <tommy@tmtm.org>

data/lib/mysql/protocol.rb

@@ -24,7 +24,7 @@ class Mysql
     # @return [Object] converted value.
     def self.net2value(pkt, type, unsigned)
       case type
-      when Field::TYPE_STRING, Field::TYPE_VAR_STRING, Field::TYPE_BLOB, Field::TYPE_JSON
+      when Field::TYPE_STRING, Field::TYPE_VAR_STRING, Field::TYPE_BLOB, Field::TYPE_JSON, Field::TYPE_GEOMETRY
         return pkt.lcs
       when Field::TYPE_NEWDECIMAL
         s = pkt.lcs
@@ -160,6 +160,7 @@ class Mysql
     # @option :ssl_mode [Integer]
     # @option :ssl_context_params [Hash<:Symbol, String>]
     # @option :get_server_public_key [Boolean]
+    # @option :io [BasicSocket, OpenSSL::SSL::SSLSocket] Existing socket instance that will be used instead of creating a new socket
     # @raise [ClientError] connection timeout
     def initialize(opts)
       @mutex = Mutex.new
@@ -172,7 +173,9 @@ class Mysql
       set_state :INIT
       @get_server_public_key = @opts[:get_server_public_key]
       begin
-        if @opts[:host].nil? or @opts[:host].empty? or @opts[:host] == "localhost"
+        if @opts[:io]
+          @socket = @opts[:io]
+        elsif @opts[:host].nil? or @opts[:host].empty? or @opts[:host] == "localhost"
           socket = @opts[:socket] || ENV["MYSQL_UNIX_PORT"] || MYSQL_UNIX_PORT
           @socket = Socket.unix(socket)
         else
@@ -185,7 +188,7 @@ class Mysql
     end
 
     def close
-      @socket.close
+      @socket.close rescue nil
     end
 
     # initial negotiate and authenticate.

data/lib/mysql.rb

@@ -22,7 +22,7 @@ class Mysql
   require_relative "mysql/protocol"
   require_relative "mysql/packet"
 
-  VERSION            = -'4.0.0'             # Version number of this library
+  VERSION            = -'4.1.0'             # Version number of this library
   MYSQL_UNIX_PORT    = -"/tmp/mysql.sock"   # UNIX domain socket filename
   MYSQL_TCP_PORT     = 3306                # TCP socket port number
 
@@ -40,6 +40,8 @@ class Mysql
   #   @return [String, nil] socket filename
   # @!attribute [rw] flags
   #   @return [Integer, nil]
+  # @!attribute [rw] io
+  #   @return [[BasicSocket, OpenSSL::SSL::SSLSocket], nil]
   # @!attribute [rw] connect_timeout
   #   @return [Numeric, nil]
   # @!attribute [rw] read_timeout
@@ -78,6 +80,7 @@ class Mysql
     port: nil,
     socket: nil,
     flags: 0,
+    io: nil,
     charset: nil,
     connect_timeout: nil,
     read_timeout: nil,
@@ -172,6 +175,7 @@ class Mysql
   #   @option opts :ssl_context_params [Hash<Symbol, String>]
   #   @option opts :get_server_public_key [Boolean]
   #   @option opts :connect_attrs [Hash]
+  #   @option opts :io [BasicSocket, OpenSSL::SSL::SSLSocket] Existing socket instance that will be used instead of creating a new socket
   def initialize(*args, **opts)
     @fields = nil
     @result = nil

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mysql
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Tomita Masahiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: power_assert
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2023-10-08 00:00:00.000000000 Z
+dependencies: []
 description: This is MySQL connector. pure Ruby version
 email: tommy@tmtm.org
 executables: []
@@ -96,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: MySQL connector