ruby-mysql 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13656e5ef8a79113c2dce1fac6f1a47e510c2cd6bfb9958518a966b349bdbb13
-  data.tar.gz: 55a2f5e70d73add2e6d71eb0bb02e19d0d498cacd46c78f0415f8f31620c76ab
+  metadata.gz: b0fae682668684b92f92ebf353cc0bcfaaeffc5afc922a82f6203fce60fc21ce
+  data.tar.gz: d289a2371c8cf2e60188ee6c0364640297116629c15a825b24048914b7470bc4
 SHA512:
-  metadata.gz: a01515533387aaa8280be8c5244b80d4b245052e2750732f03c6198827dd5975a32f8f472481ba44b14f731135b31aa3744180475444388c7e1158d49bf95556
-  data.tar.gz: 53fe3127e8c358f77a3874e26ae1de91dcd72af11fcd45f40b18875c21a884d21105eccce4808b308bde1e938970316cf6d7f54ac21f9bf94cebb9fc2b8dcbd5
+  metadata.gz: 6581d6cc73e910bbce33bb6024eda12971a0757a8d53ffa79b7c2fee983c19007821250af2a717217f6213b0a8a7b34285731988fba77f67b66496a03342e035
+  data.tar.gz: 8be3f83e953ea70aa80da335f8f2b4dbb7bd23bdb463b1abf3d6625e16f73558ff485112a958ffa737c10febb115c7de7538c8994b420fdd56525052e22c440b

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [4.2.0] - 2024-12-23
+
+- Skip storing records if auto_store_result is false <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/6>
+-  Ruby 3.3 & MySQL 8.4 <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/7>
+- COM_KILL and COM_REFRESH are not supported by MySQL 8.4 <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/8>
+- add Mysql#use_result and fix Mysql::Result#size <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/9>
+- avoid warning for Ruby 3.4 <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/10>
+- bundle update and rubocop <https://gitlab.com/tmtms/ruby-mysql/-/merge_requests/11>
+
+## [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/error.rb

@@ -14,7 +14,7 @@ class Mysql
         errname = errname.to_s
         next unless errname =~ prefix_re
         errno = self.const_get errname
-        excname = errname.sub(prefix_re, '').gsub(/(\A.|_.)([A-Z]+)/){$1+$2.downcase}.gsub(/_/, '')
+        excname = errname.sub(prefix_re, '').gsub(/(\A.|_.)([A-Z]+)/){$1+$2.downcase}.gsub('_', '')
         klass = Class.new self
         klass.const_set 'ERRNO', errno
         self.const_set excname, klass
@@ -908,7 +908,7 @@ class Mysql
   end
 
   ServerError.define_error_class(/\AER_/)
-  ServerError::ERROR_MAP.each_value{|v| Mysql.const_set v.name.split(/::/).last, v} # for compatibility
+  ServerError::ERROR_MAP.each_value{|v| Mysql.const_set v.name.split('::').last, v} # for compatibility
 
   # client side error
   class ClientError < Error

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.
@@ -510,7 +513,7 @@ class Mysql
     # @return [Packet] packet data
     # @rails [ProtocolError] invalid packet sequence number
     def read
-      data = ''
+      data = +''
       len = nil
       begin
         timeout = @state == :INIT ? @opts[:connect_timeout] : @opts[:read_timeout]
@@ -551,7 +554,7 @@ class Mysql
 
     def read_timeout(len, timeout)
       return @socket.read(len) if timeout.nil? || timeout == 0
-      result = ''
+      result = +''
       e = Time.now + timeout
       while result.size < len
         now = Time.now
@@ -786,7 +789,7 @@ class Mysql
           username,
           Packet.lcs(scrambled_password),
         ]
-        pack = "VVCa23Z*A*"
+        pack = +"VVCa23Z*A*"
         if databasename
           data.push databasename
           pack.concat "Z*"
@@ -814,7 +817,7 @@ class Mysql
     class ExecutePacket
       def self.serialize(statement_id, cursor_type, values)
         nbm = null_bitmap values
-        netvalues = ""
+        netvalues = +""
         types = values.map do |v|
           t, n = Protocol.value2net v
           netvalues.concat n unless v.nil?

data/lib/mysql/result.rb

@@ -15,8 +15,9 @@ class Mysql
     def initialize(fields, protocol, record_class, **opts)
       @fields = fields
       @field_index = 0             # index of field
-      @records = []                # all records
+      @records = nil               # all records
       @index = 0                   # index of record
+      @size = 0                    # retrieved record count
       @fieldname_with_table = nil
       @protocol = protocol
       @record_class = record_class
@@ -25,6 +26,7 @@ class Mysql
 
     def retrieve
       @records = @protocol.retr_all_records(@record_class)
+      @size = @records.size
     end
 
     # ignore
@@ -34,22 +36,22 @@ class Mysql
     end
 
     # @return [Integer] number of record
-    def size
-      @records.size
-    end
+    attr_reader :size
     alias num_rows size
+    alias count size
 
     # @return [Array] current record data
     def fetch(**)
-      if @index < @records.size
+      if @records && @index < @records.size
         @records[@index] = @records[@index].to_a unless @records[@index].is_a? Array
         @index += 1
         return @records[@index-1]
       end
       rec = @protocol.retr_record(@record_class)&.to_a
       return nil unless rec
-      @records[@index] = rec
+      @records[@index] = rec if @records
       @index += 1
+      @size += 1
       return rec
     end
     alias fetch_row fetch
@@ -133,7 +135,6 @@ class Mysql
     # @private
     # @param [Array<Mysql::Field>] fields
     # @param [Mysql::Protocol] protocol
-    # @param [Boolean] auto_store_result
     def initialize(fields, protocol=nil, **opts)
       super fields, protocol, RawRecord, **opts
       return unless protocol
@@ -182,7 +183,7 @@ class Mysql
       when Field::TYPE_DATETIME, Field::TYPE_TIMESTAMP
         Time.parse(s) rescue nil
       when Field::TYPE_TIME
-        h, m, sec = s.split(/:/)
+        h, m, sec = s.split(':')
         if s =~ /\A-/
           h.to_i*3600 - m.to_i*60 - sec.to_f
         else

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.2.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,
@@ -102,9 +105,6 @@ class Mysql
   # @return [Array<Mysql::Field>] fields of result set
   attr_reader :fields
 
-  # @return [Mysql::Result]
-  attr_reader :result
-
   class << self
     # Make Mysql object and connect to mysqld.
     # parameter is same as arguments for {#initialize}.
@@ -172,6 +172,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
@@ -355,8 +356,7 @@ class Mysql
   # @param [Integer] pid thread id
   # @return [Mysql] self
   def kill(pid)
-    check_connection
-    @protocol.kill_command pid
+    query "KILL #{pid}"
     self
   end
 
@@ -375,11 +375,13 @@ class Mysql
     check_connection
     @fields = nil
     begin
+      @result = nil
       @protocol.query_command str
       if block
         while true
+          @result = nil
           @protocol.get_result
-          res = store_result(**opts)
+          res = result(**opts)
           block.call res if res || opts[:yield_null_result]
           break unless more_results?
         end
@@ -387,7 +389,7 @@ class Mysql
       end
       @protocol.get_result
       return self unless opts[:return_result]
-      return store_result(**opts)
+      return result(**opts)
     rescue ServerError => e
       @last_error = e
       @sqlstate = e.sqlstate
@@ -395,16 +397,32 @@ class Mysql
     end
   end
 
-  # Get all data for last query.
+  # return Mysql::Result for last query.
   # @return [Mysql::Result]
   # @return [nil] if no results
-  def store_result(**opts)
+  def result(**opts)
     return nil if @protocol.field_count.nil? || @protocol.field_count == 0
+    return @result if @result
     @fields = @protocol.retr_fields
     opts = @opts.merge(opts)
     @result = Result.new(@fields, @protocol, **opts)
   end
 
+  # return Mysql::Result for last query with all data.
+  # @return [Mysql::Result]
+  # @return [nil] if no results
+  def store_result(**opts)
+    result(auto_store_result: true, **opts.merge)
+  end
+
+  # return Mysql::Result for last query without data.
+  # Mysql::Result#data_seek, row_tell, row_seek cannot be used.
+  # @return [Mysql::Result]
+  # @return [nil] if no results
+  def use_result(**opts)
+    result(auto_store_result: false, **opts.merge)
+  end
+
   # @return [Integer] Thread ID
   def thread_id
     check_connection
@@ -433,8 +451,8 @@ class Mysql
     return nil unless more_results?
     opts = @opts.merge(opts)
     @protocol.get_result
-    @fields = nil
-    return store_result(**opts) if opts[:return_result]
+    @result = @fields = nil
+    return result(**opts) if opts[:return_result]
     true
   end
 
@@ -468,8 +486,30 @@ class Mysql
   # @param [Integer] op operation. Use Mysql::REFRESH_* value.
   # @return [Mysql] self
   def refresh(op)
-    check_connection
-    @protocol.refresh_command op
+    if server_version < 80400
+      check_connection
+      @protocol.refresh_command op
+    else
+      q = case op
+          when REFRESH_GRANT
+            "FLUSH PRIVILEGES"
+          when REFRESH_LOG
+            "FLUSH LOGS"
+          when REFRESH_TABLES
+            "FLUSH TABLES"
+          when REFRESH_HOSTS
+            "TRUNCATE TABLE performance_schema.host_cache"
+          when REFRESH_STATUS
+            "FLUSH STATUS"
+          when REFRESH_SLAVE
+            "RESET REPLICA"
+          when REFRESH_MASTER
+            "RESET BINARY LOGS AND GTIDS"
+          else
+            raise "unsupported operation for #{server_version}"
+          end
+      query q
+    end
     self
   end
 

metadata

@@ -1,57 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mysql
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.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: 2024-12-23 00:00:00.000000000 Z
+dependencies: []
 description: This is MySQL connector. pure Ruby version
 email: tommy@tmtm.org
 executables: []
@@ -81,7 +38,6 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/ruby-mysql
   source_code_uri: http://gitlab.com/tmtms/ruby-mysql
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: MySQL connector
 test_files: []