ruby-mysql2 0.5.4

data/lib/mysql2/result.rb

@@ -0,0 +1,176 @@
+module Mysql2
+  # Mysql2::Result
+  class Result
+    attr_reader :server_flags
+
+    include Enumerable
+
+    # @param result [Mysql::Result]
+    # @param options [Hash]
+    def initialize(result, options)
+      @result = result
+      @query_options = options
+      server_status = result.server_status
+      @server_flags = {
+        no_good_index_used: server_status & Mysql::SERVER_QUERY_NO_GOOD_INDEX_USED != 0,
+        no_index_used: server_status & Mysql::SERVER_QUERY_NO_INDEX_USED != 0,
+        query_was_slow: server_status & Mysql::SERVER_QUERY_WAS_SLOW != 0,
+      }
+    end
+
+    def size
+      @result.size
+    end
+    alias count size
+
+    def free
+      # dummy
+    end
+
+    def fields
+      @result.fields.map{|f| f.name.freeze}
+    end
+
+    def field_types
+      @result.fields.map{|f| field_type_string(f)}
+    end
+
+    def each(**opts, &block)
+      opts = @query_options.merge(opts)
+
+      raise Mysql2::Error, 'Result set has already been freed' if opts[:stream] && @all_retrieved
+      return enum_for(:each, **opts) unless block
+
+      @pos ||= 0
+      @cached ||= []
+      @pos = 0 unless opts[:stream]
+
+      while @pos < @cached.size
+        block.call @cached[@pos]
+        @pos += 1
+      end
+
+      @result.data_seek @pos
+      while (row = @result.fetch(**opts))
+        row = @result.fields.map.with_index do |f, i|
+          opts[:cast] ? convert_type(row[i], f, opts) : row[i]
+        end
+        if opts[:as] == :hash
+          row = @result.fields.map.with_index.to_h do |f, i|
+            key = opts[:symbolize_keys] ? f.name.intern : f.name
+            [key, row[i]]
+          end
+        end
+        @cached.push row if opts[:cache_rows]
+        @pos += 1
+        block.call row
+      end
+      @all_retrieved = true
+      self
+    rescue Mysql::Error => e
+      raise Mysql2::Error, e.message
+    end
+
+    FIELD_TYPE_STRING = {
+      Mysql::Field::TYPE_DECIMAL     => "decimal",
+      Mysql::Field::TYPE_TINY        => "tinyint",
+      Mysql::Field::TYPE_SHORT       => "smallint",
+      Mysql::Field::TYPE_LONG        => "int",
+      Mysql::Field::TYPE_FLOAT       => "float",
+      Mysql::Field::TYPE_DOUBLE      => "double",
+      Mysql::Field::TYPE_NULL        => "null",
+      Mysql::Field::TYPE_TIMESTAMP   => "timestamp",
+      Mysql::Field::TYPE_LONGLONG    => "bigint",
+      Mysql::Field::TYPE_INT24       => "mediumint",
+      Mysql::Field::TYPE_DATE        => "date",
+      Mysql::Field::TYPE_TIME        => "time",
+      Mysql::Field::TYPE_DATETIME    => "datetime",
+      Mysql::Field::TYPE_YEAR        => "year",
+      Mysql::Field::TYPE_NEWDATE     => "date",
+      Mysql::Field::TYPE_VARCHAR     => "varchar",
+      Mysql::Field::TYPE_BIT         => "bit",
+      Mysql::Field::TYPE_TIMESTAMP2  => "timestamp",
+      Mysql::Field::TYPE_DATETIME2   => "datetime",
+      Mysql::Field::TYPE_TIME2       => "time",
+      Mysql::Field::TYPE_TYPED_ARRAY => "typed_array",
+      Mysql::Field::TYPE_INVALID     => "invalid",
+      Mysql::Field::TYPE_BOOL        => "bool",
+      Mysql::Field::TYPE_JSON        => "json",
+      Mysql::Field::TYPE_NEWDECIMAL  => "decimal",
+      Mysql::Field::TYPE_ENUM        => "enum",
+      Mysql::Field::TYPE_SET         => "set",
+      Mysql::Field::TYPE_TINY_BLOB   => "tinyblob",
+      Mysql::Field::TYPE_MEDIUM_BLOB => "mediumblob",
+      Mysql::Field::TYPE_LONG_BLOB   => "longblob",
+      Mysql::Field::TYPE_BLOB        => "blob",
+      Mysql::Field::TYPE_VAR_STRING  => "varchar",
+      Mysql::Field::TYPE_STRING      => "char",
+      Mysql::Field::TYPE_GEOMETRY    => "geometry",
+      Mysql::Field::TYPE_CHAR        => "tinyint",
+      Mysql::Field::TYPE_INTERVAL    => "interval",
+    }.freeze
+
+    BINARY_CHARSET = 63
+
+    def field_type_string(field)
+      if field.type == Mysql::Field::TYPE_STRING
+        return 'enum' if field.flags & Mysql::Field::ENUM_FLAG != 0
+        return 'set' if field.flags & Mysql::Field::SET_FLAG != 0
+      end
+      type = FIELD_TYPE_STRING[field.type]
+      if type =~ /int$|bit$|year$/
+        type += "(#{field.length})"
+      elsif type =~ /char$/
+        if field.charsetnr == BINARY_CHARSET
+          type = type.sub(/char/, 'binary') + "(#{field.length})"
+        else
+          type += "(#{field.length / 3})"
+        end
+      elsif type =~ /float|double/
+        type += "(#{field.length},#{field.decimals})"
+      elsif type == 'decimal'
+        type += "(#{field.length - (field.decimals > 0 ? 2 : 1)},#{field.decimals})"
+      elsif type == 'blob'
+        if field.charsetnr == BINARY_CHARSET
+          case field.length
+          when 255
+            type = 'tinyblob'
+          when 65535
+            type = 'blob'
+          when 16777215
+            type = 'mediumblob'
+          when 4294967295
+            type = 'longblob'
+          end
+        else
+          type = 'text'
+          case field.length
+          when 255 * 3
+            type = 'tinytext'
+          when 65535 * 3
+            type = 'text'
+          when 16777215 * 3
+            type = 'mediumtext'
+          when 4294967295
+            type = 'longtext'
+          end
+        end
+      end
+      type
+    end
+
+    def convert_type(value, field, opts)
+      return nil if value.nil?
+      case field.type
+      when Mysql::Field::TYPE_BIT
+        opts[:cast_booleans] ? value != "\x00" : value
+      when Mysql::Field::TYPE_TINY
+        opts[:cast_booleans] && field.length == 1 ? value != 0 : value
+      when Mysql::Field::TYPE_TIME
+        Time.new(2000, 1, 1) + value
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mysql2/statement.rb

@@ -0,0 +1,103 @@
+module Mysql2
+  class Statement
+    # @param stmt [Mysql::Stmt]
+    def initialize(stmt, **opts)
+      @stmt = stmt
+      @opts = opts
+    end
+
+    def param_count
+      @stmt.param_count
+    end
+
+    def field_count
+      @stmt.field_count
+    end
+
+    def fields
+      field_count == 0 ? nil : @stmt.fields.map(&:name)
+    end
+
+    def execute(*args, **opts)
+      res = @stmt.execute(*args, **opts)
+      opts = @opts.merge(opts)
+      StatementResult.new(res, **opts)
+    rescue Mysql::Error => e
+      raise Mysql2::Error, e.message
+    end
+
+    def affected_rows
+      @stmt.affected_rows
+    end
+
+    def last_id
+      @stmt.insert_id
+    end
+
+    def close
+      @stmt.close
+    end
+  end
+
+  class StatementResult
+    include Enumerable
+
+    def initialize(result, **opts)
+      if !opts[:cache_rows] && !opts[:stream]
+        warn ':cache_rows is forced for prepared statements (if not streaming)'
+      end
+      @result = result
+      @opts = opts
+    end
+
+    def each(**opts, &block)
+      opts = @opts.merge(opts)
+
+      raise Mysql2::Error, 'Result set has already been freed' if opts[:stream] && @all_retrieved
+      return enum_for(:each, **opts) unless block
+
+      @pos ||= 0
+      @cached ||= []
+      @pos = 0 unless opts[:stream]
+
+      while @pos < @cached.size
+        block.call @cached[@pos]
+        @pos += 1
+      end
+
+      @result.data_seek @pos
+      while (row = @result.fetch(**opts))
+        row = @result.fields.map.with_index do |f, i|
+          convert_type(row[i], f, opts)
+        end
+        if opts[:as] == :hash
+          row = @result.fields.map.with_index.to_h do |f, i|
+            key = opts[:symbolize_keys] ? f.name.intern : f.name
+            [key, row[i]]
+          end
+        end
+        @cached.push row if opts[:cache_rows]
+        @pos += 1
+        block.call row
+      end
+      @all_retrieved = true
+      self
+    rescue Mysql::Error => e
+      raise Mysql2::Error, e.message
+    end
+
+    def convert_type(value, field, opts)
+      return nil if value.nil?
+      case field.type
+      when Mysql::Field::TYPE_BIT
+        opts[:cast_booleans] ? value != "\x00" : value
+      when Mysql::Field::TYPE_TINY
+        opts[:cast_booleans] && field.length == 1 ? value != 0 : value
+      when Mysql::Field::TYPE_TIME
+        Time.new(2000, 1, 1) + value
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mysql2/version.rb

@@ -0,0 +1,3 @@
+module Mysql2
+  VERSION = "0.5.4".freeze
+end

data/lib/mysql2.rb

@@ -0,0 +1,87 @@
+require 'mysql'
+require 'date'
+require 'bigdecimal'
+
+# Load libmysql.dll before requiring mysql2/mysql2.so
+# This gives a chance to be flexible about the load path
+# Or to bomb out with a clear error message instead of a linker crash
+if RUBY_PLATFORM =~ /mswin|mingw/
+  dll_path = if ENV['RUBY_MYSQL2_LIBMYSQL_DLL']
+    # If this environment variable is set, it overrides any other paths
+    # The user is advised to use backslashes not forward slashes
+    ENV['RUBY_MYSQL2_LIBMYSQL_DLL']
+  elsif File.exist?(File.expand_path('../vendor/libmysql.dll', File.dirname(__FILE__)))
+    # Use vendor/libmysql.dll if it exists, convert slashes for Win32 LoadLibrary
+    File.expand_path('../vendor/libmysql.dll', File.dirname(__FILE__))
+  elsif defined?(RubyInstaller)
+    # RubyInstaller-2.4+ native build doesn't need DLL preloading
+  else
+    # This will use default / system library paths
+    'libmysql.dll'
+  end
+
+  if dll_path
+    require 'fiddle'
+    kernel32 = Fiddle.dlopen 'kernel32'
+    load_library = Fiddle::Function.new(
+      kernel32['LoadLibraryW'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT,
+    )
+    if load_library.call(dll_path.encode('utf-16le')).zero?
+      abort "Failed to load libmysql.dll from #{dll_path}"
+    end
+  end
+end
+
+require 'mysql2/version' unless defined? Mysql2::VERSION
+require 'mysql2/error'
+require 'mysql2/result'
+require 'mysql2/client'
+require 'mysql2/field'
+require 'mysql2/statement'
+
+# = Mysql2
+#
+# A modern, simple and very fast Mysql library for Ruby - binding to libmysql
+module Mysql2
+end
+
+if defined?(ActiveRecord::VERSION::STRING) && ActiveRecord::VERSION::STRING < "3.1"
+  begin
+    require 'active_record/connection_adapters/mysql2_adapter'
+  rescue LoadError
+    warn "============= WARNING FROM mysql2 ============="
+    warn "This version of mysql2 (#{Mysql2::VERSION}) doesn't ship with the ActiveRecord adapter."
+    warn "In Rails version 3.1.0 and up, the mysql2 ActiveRecord adapter is included with rails."
+    warn "If you want to use the mysql2 gem with Rails <= 3.0.x, please use the latest mysql2 in the 0.2.x series."
+    warn "============= END WARNING FROM mysql2 ============="
+  end
+end
+
+# For holding utility methods
+module Mysql2
+  module Util
+    #
+    # Rekey a string-keyed hash with equivalent symbols.
+    #
+    def self.key_hash_as_symbols(hash)
+      return nil unless hash
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
+
+    #
+    # In Mysql2::Client#query and Mysql2::Statement#execute,
+    # Thread#handle_interrupt is used to prevent Timeout#timeout
+    # from interrupting query execution.
+    #
+    # Timeout::ExitException was removed in Ruby 2.3.0, 2.2.3, and 2.1.8,
+    # but is present in earlier 2.1.x and 2.2.x, so we provide a shim.
+    #
+    require 'timeout'
+    TIMEOUT_ERROR_CLASS = if defined?(::Timeout::ExitException)
+      ::Timeout::ExitException
+    else
+      ::Timeout::Error
+    end
+    TIMEOUT_ERROR_NEVER = { TIMEOUT_ERROR_CLASS => :never }.freeze
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mysql2
+version: !ruby/object:Gem::Version
+  version: 0.5.4
+platform: ruby
+authors:
+- Tomita Masahiro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-mysql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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'
+description:
+email: tommy@tmtm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- README.org.md
+- lib/mysql2.rb
+- lib/mysql2/client.rb
+- lib/mysql2/console.rb
+- lib/mysql2/error.rb
+- lib/mysql2/field.rb
+- lib/mysql2/result.rb
+- lib/mysql2/statement.rb
+- lib/mysql2/version.rb
+homepage: https://gitlab.com/tmtms/ruby-mysql2
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/tmtms/ruby-mysql2/issues
+  changelog_uri: https://gitlab.com/tmtms/ruby-mysql2/releases/tag/0.5.4
+  documentation_uri: https://www.rubydoc.info/gems/ruby-mysql2/0.5.4
+  homepage_uri: https://gitlab.com/tmtms/ruby-mysql2
+  source_code_uri: https://gitlab.com/tmtms/ruby-mysql2/tree/0.5.4
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.0.dev
+signing_key:
+specification_version: 4
+summary: Mysql2 compatible pure Ruby library
+test_files: []