mysql2-nested_hash_bind 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e539ad716d3ade8fb1bcd312f188b5266704d090d330e3dc28e6aaf4629adad
+  data.tar.gz: 8f53a6de9feaaca5e105d96aa7e2b9c8cb5ff4656d7a4a2d675e6b66e7671be5
+SHA512:
+  metadata.gz: 37f1014bae85abb91d12613f7cea23f2b0a574db4306d3fd5dc7979d80f30731d9d54e590ea8ba155561ad44dbd308dbb8e5519ef01b56c26b43ef78622a5fa1
+  data.tar.gz: a8dd965a418ac76c7021771875a69a56a17505bcd53073c696b5bb849669d71dd0e2edfb4df61cfc823de6e23cb97638683acf50619fca0b70119b0b54ddbc0f

data/.env.example

@@ -0,0 +1,5 @@
+# MYSQL_HOST=127.0.0.1
+# MYSQL_PORT=3306
+# MYSQL_USERNAME=root
+# MYSQL_PASSWORD=
+# MYSQL_DATABASE=mysql2_test

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Naming/FileName:
+  Exclude:
+    - lib/mysql2-nested_hash_bind.rb
+
+Style/SymbolArray:
+  Exclude:
+    # Exclude for rspec-its syntax
+    - spec/**/*_spec.rb
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  Exclude:
+    # Exclude for rspec-its syntax
+    - spec/**/*_spec.rb

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--no-private
+--hide-void-return
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mysql2-nested_hash_bind.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# mysql2-nested_hash_bind
+[mysql2](https://github.com/brianmario/mysql2) and [mysql2-cs-bind](https://github.com/tagomoris/mysql2-cs-bind) extension to bind response to nested `Hash`.
+
+This is inspired by https://github.com/jmoiron/sqlx
+
+[![test](https://github.com/sue445/mysql2-nested_hash_bind/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/mysql2-nested_hash_bind/actions/workflows/test.yml)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-nested_hash_bind'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mysql2-nested_hash_bind
+
+## Usage
+Write `require "mysql2-nested_hash_bind"` and `using Mysql2::NestedHashBind::QueryExtension` in your code
+
+## Example
+```ruby
+require "mysql2-nested_hash_bind"
+
+using Mysql2::NestedHashBind::QueryExtension
+
+db = Mysql2::Client.new(
+  host: ENV.fetch("MYSQL_HOST", "127.0.0.1"),
+  port: ENV.fetch("MYSQL_PORT", "3306"),
+  username: ENV.fetch("MYSQL_USERNAME"),
+  database: ENV.fetch("MYSQL_DATABASE"),
+  password: ENV.fetch("MYSQL_PASSWORD", ""),
+  charset: "utf8mb4",
+  database_timezone: :local,
+  cast_booleans: true,
+  symbolize_keys: true,
+  reconnect: true,
+)
+
+rows = db.query(<<~SQL)
+  SELECT
+    `posts`.`id`,
+    `posts`.`user_id`,
+    `posts`.`body`,
+    `users`.`account_name` AS `users.account_name`,
+    `users`.`authority` AS `users.authority`,
+    `users`.`del_flg` AS `users.del_flg`
+  FROM `posts`
+  INNER JOIN `users` ON `posts`.`user_id` = `users`.`id`
+SQL
+
+rows.first
+#=> {:id=>1, :user_id=>445, :body=>"test", :users=>{:account_name=>"sue445", :authority=>false, :del_flg=>false}}
+```
+
+If you do not write `using Mysql2::NestedHashBind::QueryExtension`, it will look like this. (This is the original behavior of `Mysql2::Client#query` and `Mysql2::Client#xquery`)
+
+```ruby
+rows.first
+#=> {:id=>1, :user_id=>445, :body=>"test", :"users.account_name"=>"sue445", :"users.authority"=>false, :"users.del_flg"=>false}
+```
+
+## Note
+* If exists columns containing dots, `Mysql2::Client#query` and `Mysql2::Client#xquery` returns `Array<Hash>`
+* If no exists columns containing dots, `Mysql2::Client#query` and `Mysql2::Client#xquery` returns [Mysql2::Result](https://www.rubydoc.info/gems/mysql2/Mysql2/Result) (This is the original behavior of `Mysql2::Client#query` and `Mysql2::Client#xquery`)
+
+## Development
+At first, create test database.
+
+e.g.
+
+```sql
+CREATE DATABASE mysql2_test;
+```
+
+```bash
+cp .env.example .env
+vi .env
+```
+
+## Benchmark
+See [benchmark/](benchmark/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/mysql2-nested_hash_bind.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/benchmark/README.md

@@ -0,0 +1,106 @@
+# Benchmark report
+## Setup
+```bash
+cp ../.env.example .env
+vi .env
+```
+
+## [xquery_bench.rb](xquery_bench.rb)
+```bash
+$ ruby -v
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+
+$ bundle exec ruby xquery_bench.rb
+============== Benchmark with LIMIT 10, without to_a ==============
+Warming up --------------------------------------
+Mysql2::Client#xquery
+                       490.000  i/100ms
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension
+                       362.000  i/100ms
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension
+                       483.000  i/100ms
+Calculating -------------------------------------
+Mysql2::Client#xquery
+                          5.107k (± 3.1%) i/s -     25.970k in   5.090386s
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension
+                          3.649k (± 3.3%) i/s -     18.462k in   5.064792s
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension
+                          4.804k (± 4.3%) i/s -     24.150k in   5.037482s
+
+Comparison:
+Mysql2::Client#xquery:     5106.6 i/s
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension:     4803.5 i/s - same-ish: difference falls within error
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension:     3649.1 i/s - 1.40x  (± 0.00) slower
+
+============== Benchmark with LIMIT 10, with to_a ==============
+Warming up --------------------------------------
+Mysql2::Client#xquery.to_a
+                       446.000  i/100ms
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                       359.000  i/100ms
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                       451.000  i/100ms
+Calculating -------------------------------------
+Mysql2::Client#xquery.to_a
+                          4.440k (± 4.7%) i/s -     22.300k in   5.035494s
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                          3.587k (± 7.1%) i/s -     17.950k in   5.034172s
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                          4.330k (± 4.3%) i/s -     21.648k in   5.009239s
+
+Comparison:
+Mysql2::Client#xquery.to_a:     4439.7 i/s
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension:     4330.2 i/s - same-ish: difference falls within error
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension:     3587.1 i/s - 1.24x  (± 0.00) slower
+
+============== Benchmark with LIMIT 100, without to_a ==============
+Warming up --------------------------------------
+Mysql2::Client#xquery
+                       223.000  i/100ms
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension
+                        94.000  i/100ms
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension
+                       224.000  i/100ms
+Calculating -------------------------------------
+Mysql2::Client#xquery
+                          2.368k (± 4.8%) i/s -     11.819k in   5.002685s
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension
+                        942.892  (± 4.9%) i/s -      4.794k in   5.096560s
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension
+                          2.183k (± 9.7%) i/s -     10.976k in   5.069075s
+
+Comparison:
+Mysql2::Client#xquery:     2368.0 i/s
+Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension:     2183.3 i/s - same-ish: difference falls within error
+Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension:      942.9 i/s - 2.51x  (± 0.00) slower
+
+============== Benchmark with LIMIT 100, with to_a ==============
+Warming up --------------------------------------
+Mysql2::Client#xquery.to_a
+                       157.000  i/100ms
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                        93.000  i/100ms
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                       141.000  i/100ms
+Calculating -------------------------------------
+Mysql2::Client#xquery.to_a
+                          1.478k (± 2.8%) i/s -      7.536k in   5.102039s
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                        947.848  (± 4.3%) i/s -      4.743k in   5.013320s
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension
+                          1.449k (± 3.6%) i/s -      7.332k in   5.066700s
+
+Comparison:
+Mysql2::Client#xquery.to_a:     1478.3 i/s
+Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension:     1449.1 i/s - same-ish: difference falls within error
+Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension:      947.8 i/s - 1.56x  (± 0.00) slower
+```
+
+## [xquery_stackprof.rb](xquery_stackprof.rb)
+### Usage
+```bash
+bundle exec ruby xquery_stackprof.rb
+bundle exec stackprof-webnav -d tmp/
+```
+
+open http://localhost:9292/

data/benchmark/xquery_bench.rb

@@ -0,0 +1,148 @@
+# rubocop:disable all
+
+require "mysql2-nested_hash_bind"
+require "benchmark/ips"
+require "dotenv"
+require "securerandom"
+
+Dotenv.load(File.join(__dir__, "..", ".env"))
+
+require_relative "../spec/support/database_helper"
+
+class DatabaseClient
+  SELECT_SQL_WITH_DOT_FORMAT = <<~SQL
+    SELECT 
+      `posts`.`id`,
+      `posts`.`user_id`,
+      `posts`.`body`,
+      `users`.`account_name` AS `users.account_name`,
+      `users`.`authority` AS `users.authority`,
+      `users`.`del_flg` AS `users.del_flg`
+    FROM `posts`
+    INNER JOIN `users` ON `posts`.`user_id` = `users`.`id`
+    LIMIT %d
+  SQL
+
+  SELECT_SQL_WITHOUT_DOT_FORMAT = <<~SQL
+    SELECT 
+      `posts`.`id`,
+      `posts`.`user_id`,
+      `posts`.`body`,
+      `users`.`account_name` AS `users_account_name`,
+      `users`.`authority` AS `users_authority`,
+      `users`.`del_flg` AS `users_del_flg`
+    FROM `posts`
+    INNER JOIN `users` ON `posts`.`user_id` = `users`.`id`
+    LIMIT %d
+  SQL
+
+  attr_reader :db
+
+  def initialize
+    @db = DatabaseHelper.client
+  end
+
+  def setup
+    db.query(<<~SQL)
+      CREATE TABLE `users` (
+        `id` int NOT NULL AUTO_INCREMENT,
+        `account_name` varchar(64) NOT NULL,
+        `authority` tinyint(1) NOT NULL DEFAULT '0',
+        `del_flg` tinyint(1) NOT NULL DEFAULT '0',
+        `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (`id`),
+        UNIQUE KEY `account_name` (`account_name`)
+      )
+    SQL
+
+    db.query(<<~SQL)
+      CREATE TABLE `posts` (
+        `id` int NOT NULL AUTO_INCREMENT,
+        `user_id` int NOT NULL,
+        `body` text NOT NULL,
+        `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (`id`)
+    )
+    SQL
+
+    (1000...1100).each do |id|
+      db.xquery(<<~SQL, id, SecureRandom.uuid)
+        INSERT INTO `users` (`id`, `account_name`) VALUES(?, ?)
+      SQL
+
+      db.xquery(<<~SQL, id, id)
+        INSERT INTO `posts` (`id`, `user_id`, `body`) VALUES(?, ?, 'test')
+      SQL
+    end
+  end
+
+  def teardown
+    db.query("DROP TABLE IF EXISTS `posts`")
+    db.query("DROP TABLE IF EXISTS `users`")
+  end
+
+  def select_with_dot(limit)
+    db.xquery(SELECT_SQL_WITH_DOT_FORMAT % limit)
+  end
+
+  def select_without_dot(limit)
+    db.xquery(SELECT_SQL_WITHOUT_DOT_FORMAT % limit)
+  end
+end
+
+class DatabaseClientWithQueryExtension < DatabaseClient
+  using Mysql2::NestedHashBind::QueryExtension
+
+  def select_with_dot(limit)
+    db.xquery(SELECT_SQL_WITH_DOT_FORMAT % limit)
+  end
+
+  def select_without_dot(limit)
+    db.xquery(SELECT_SQL_WITHOUT_DOT_FORMAT % limit)
+  end
+end
+
+client = DatabaseClient.new
+patched_client = DatabaseClientWithQueryExtension.new
+
+begin
+  client.setup
+
+  [10, 100].each do |limit|
+    puts "============== Benchmark with LIMIT #{limit}, without to_a =============="
+    Benchmark.ips do |x|
+      x.report("Mysql2::Client#xquery") do
+        client.select_with_dot(limit)
+      end
+
+      x.report("Mysql2::Client#xquery(sql_with_dot) using Mysql2::NestedHashBind::QueryExtension") do
+        patched_client.select_with_dot(limit)
+      end
+
+      x.report("Mysql2::Client#xquery(sql_without_dot) using Mysql2::NestedHashBind::QueryExtension") do
+        patched_client.select_without_dot(limit)
+      end
+
+      x.compare!
+    end
+
+    puts "============== Benchmark with LIMIT #{limit}, with to_a =============="
+    Benchmark.ips do |x|
+      x.report("Mysql2::Client#xquery.to_a") do
+        client.select_with_dot(limit).to_a
+      end
+
+      x.report("Mysql2::Client#xquery(sql_with_dot).to_a using Mysql2::NestedHashBind::QueryExtension") do
+        patched_client.select_with_dot(limit).to_a
+      end
+
+      x.report("Mysql2::Client#xquery(sql_without_dot).to_a using Mysql2::NestedHashBind::QueryExtension") do
+        patched_client.select_without_dot(limit).to_a
+      end
+
+      x.compare!
+    end
+  end
+ensure
+  client.teardown
+end

data/benchmark/xquery_stackprof.rb

@@ -0,0 +1,80 @@
+# rubocop:disable all
+
+require "mysql2-nested_hash_bind"
+require "dotenv"
+require "securerandom"
+require "stackprof"
+
+Dotenv.load(File.join(__dir__, "..", ".env"))
+
+using Mysql2::NestedHashBind::QueryExtension
+
+require_relative "../spec/support/database_helper"
+
+@db = DatabaseHelper.client
+
+def setup
+  @db.query(<<~SQL)
+    CREATE TABLE `users` (
+      `id` int NOT NULL AUTO_INCREMENT,
+      `account_name` varchar(64) NOT NULL,
+      `authority` tinyint(1) NOT NULL DEFAULT '0',
+      `del_flg` tinyint(1) NOT NULL DEFAULT '0',
+      `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`),
+      UNIQUE KEY `account_name` (`account_name`)
+    )
+  SQL
+
+  @db.query(<<~SQL)
+    CREATE TABLE `posts` (
+      `id` int NOT NULL AUTO_INCREMENT,
+      `user_id` int NOT NULL,
+      `body` text NOT NULL,
+      `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`)
+    )
+  SQL
+
+  (1000...1100).each do |id|
+    @db.xquery(<<~SQL, id, SecureRandom.uuid)
+      INSERT INTO `users` (`id`, `account_name`) VALUES(?, ?)
+    SQL
+
+    @db.xquery(<<~SQL, id, id)
+      INSERT INTO `posts` (`id`, `user_id`, `body`) VALUES(?, ?, 'test')
+    SQL
+  end
+end
+
+def perform
+  1000.times do
+    @db.xquery(<<~SQL)
+      SELECT
+        `posts`.`id`,
+        `posts`.`user_id`,
+        `posts`.`body`,
+        `users`.`account_name` AS `users.account_name`,
+        `users`.`authority` AS `users.authority`,
+        `users`.`del_flg` AS `users.del_flg`
+      FROM `posts`
+      INNER JOIN `users` ON `posts`.`user_id` = `users`.`id`
+    SQL
+  end
+end
+
+def teardown
+  @db.query("DROP TABLE IF EXISTS `posts`")
+  @db.query("DROP TABLE IF EXISTS `users`")
+end
+
+begin
+  setup
+
+  StackProf.run(mode: :cpu, raw: true, out: "#{__dir__}/tmp/stackprof_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump") do
+    perform
+  end
+
+ensure
+  teardown
+end

data/lib/mysql2/nested_hash_bind/query_extension.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Mysql2
+  module NestedHashBind
+    # Apply patches to `Mysql2::Client#query` and `Mysql2::Client#xquery`
+    module QueryExtension
+      # @!method query(sql, **options)
+      #
+      # @param sql [String]
+      # @param options [Hash]
+      #
+      # @return [Array<Hash>] Exists columns containing dots
+      # @return [Mysql2::Result] No columns containing dots (This is the original behavior of `Mysql2::Client#query`)
+      # @return [nil] No response was returned. (e.g. `ROLLBACK`)
+      #
+      # @see https://www.rubydoc.info/gems/mysql2/Mysql2/Client#query-instance_method
+
+      # @!method xquery(sql, *args, **options)
+      #
+      # @param sql [String]
+      # @param args [Array]
+      # @param options [Hash]
+      #
+      # @return [Array<Hash>] Exists columns containing dots
+      # @return [Mysql2::Result] No columns containing dots (This is the original behavior of `Mysql2::Client#xquery`)
+      # @return [nil] No response was returned. (e.g. `ROLLBACK`)
+      #
+      # @see https://rubydoc.info/gems/mysql2-cs-bind/Mysql2/Client#xquery-instance_method
+
+      refine(Mysql2::Client) do
+        # @param sql [String]
+        # @param options [Hash]
+        #
+        # @return [Array<Hash>] Exists columns containing dots
+        # @return [Mysql2::Result] No columns containing dots (This is the original behavior of `Mysql2::Client#query`)
+        # @return [nil] No response was returned. (e.g. `ROLLBACK`)
+        def query_with_bind(sql, **options)
+          rows = query_without_bind(sql, **options)
+
+          __transform_rows(rows)
+        end
+
+        alias_method :query_without_bind, :query
+        alias_method :query, :query_with_bind
+
+        # @param sql [String]
+        # @param args [Array]
+        # @param options [Hash]
+        #
+        # @return [Array<Hash>] Exists columns containing dots
+        # @return [Mysql2::Result] No columns containing dots (This is the original behavior of `Mysql2::Client#xquery`)
+        # @return [nil] No response was returned. (e.g. `ROLLBACK`)
+        def xquery_with_bind(sql, *args, **options)
+          rows = xquery_without_bind(sql, *args, **options)
+
+          __transform_rows(rows)
+        end
+
+        alias_method :xquery_without_bind, :xquery
+        alias_method :xquery, :xquery_with_bind
+
+        private
+
+        # @param [Mysql2::Result,nil] rows
+        #
+        # @return [Array<Hash>] Exists columns containing dots
+        # @return [Mysql2::Result] No columns containing dots
+        #                          (This is the original behavior of `Mysql2::Client#query` and `Mysql2::Client#xquery`)
+        # @return [nil] No response was returned. (e.g. `ROLLBACK`)
+        def __transform_rows(rows)
+          column_names = rows&.first&.keys
+
+          # No columns containing dots
+          return rows unless column_names
+
+          return rows unless column_names.any? { |column_name| __include_column_name_dot?(column_name) }
+
+          # NOTE: Caching result of `column_name.split`
+          columns_cache = __split_columns(column_names)
+
+          rows.map { |row| __transform_row(row: row, columns_cache: columns_cache) }
+        end
+
+        # @param column_names [Array<String,Symbol>]
+        # @return [Hash{String,Symbol=>Array<String,Symbol>}]
+        def __split_columns(column_names)
+          column_names.each_with_object({}) do |column_name, hash|
+            str_key = column_name.respond_to?(:name) ? column_name.name : column_name
+            parent_key, child_key = *str_key.split(".", 2)
+
+            next unless child_key
+
+            if query_options[:symbolize_keys]
+              parent_key = parent_key.to_sym
+              child_key = child_key.to_sym
+            end
+
+            hash[column_name] = { parent_key: parent_key, child_key: child_key }
+          end
+        end
+
+        # @param column_name [String,Symbol]
+        # @return [Boolean]
+        def __include_column_name_dot?(column_name)
+          # NOTE: Call Symbol#name if possible
+          return column_name.name.include?(".") if column_name.respond_to?(:name)
+
+          column_name.include?(".")
+        end
+
+        # @param row [Hash]
+        # @param columns_cache [Hash{String,Symbol=>Array<String,Symbol>}]
+        #
+        # @return [Hash]
+        def __transform_row(row:, columns_cache:)
+          row.each_with_object({}) do |(k, v), new_row|
+            if columns_cache[k]
+              __update_for_nested_hash(row: new_row, key: k, value: v, columns_cache: columns_cache)
+            else
+              new_row[k] = v
+            end
+          end
+        end
+
+        # @param row [Hash]
+        # @param key [String,Symbol]
+        # @param value [Object]
+        # @param columns_cache [Hash{String,Symbol=>Array<String,Symbol>}]
+        def __update_for_nested_hash(row:, key:, value:, columns_cache:)
+          parent_key = columns_cache[key][:parent_key]
+          child_key = columns_cache[key][:child_key]
+
+          row[parent_key] ||= {}
+          row[parent_key][child_key] = value
+        end
+      end
+    end
+  end
+end

data/lib/mysql2/nested_hash_bind/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mysql2
+  module NestedHashBind
+    VERSION = "0.1.0"
+  end
+end

data/lib/mysql2/nested_hash_bind.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "mysql2"
+require "mysql2-cs-bind"
+
+require_relative "nested_hash_bind/version"
+require_relative "nested_hash_bind/query_extension"
+
+module Mysql2
+  module NestedHashBind
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/mysql2-nested_hash_bind.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "mysql2/nested_hash_bind"

data/mysql2-nested_hash_bind.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "lib/mysql2/nested_hash_bind/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mysql2-nested_hash_bind"
+  spec.version = Mysql2::NestedHashBind::VERSION
+  spec.authors = ["sue445"]
+  spec.email = ["sue445@sue445.net"]
+
+  spec.summary = "mysql2 and mysql2-cs-bind extension to bind response to nested Hash"
+  spec.description = "mysql2 and mysql2-cs-bind extension to bind response to nested Hash"
+  spec.homepage = "https://github.com/sue445/mysql2-nested_hash_bind"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mysql2"
+  spec.add_dependency "mysql2-cs-bind"
+
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop_auto_corrector"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "yard"
+
+  # benchmark
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "stackprof"
+  spec.add_development_dependency "stackprof-webnav"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/mysql2/nested_hash_bind.rbs

@@ -0,0 +1,6 @@
+module Mysql2
+  module NestedHashBind
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-nested_hash_bind
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2-cs-bind
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rake
+  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: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop_auto_corrector
+  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-performance
+  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: yard
+  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: benchmark-ips
+  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: stackprof
+  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: stackprof-webnav
+  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: mysql2 and mysql2-cs-bind extension to bind response to nested Hash
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/README.md
+- benchmark/tmp/.keep
+- benchmark/xquery_bench.rb
+- benchmark/xquery_stackprof.rb
+- lib/mysql2-nested_hash_bind.rb
+- lib/mysql2/nested_hash_bind.rb
+- lib/mysql2/nested_hash_bind/query_extension.rb
+- lib/mysql2/nested_hash_bind/version.rb
+- mysql2-nested_hash_bind.gemspec
+- sig/mysql2/nested_hash_bind.rbs
+homepage: https://github.com/sue445/mysql2-nested_hash_bind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/mysql2-nested_hash_bind
+  source_code_uri: https://github.com/sue445/mysql2-nested_hash_bind
+  changelog_uri: https://github.com/sue445/mysql2-nested_hash_bind/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: mysql2 and mysql2-cs-bind extension to bind response to nested Hash
+test_files: []