mysql-pr 2.9.11 → 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 740a7c4a533c1dfee294b1fd1d5d71a094c758309157bc1b0366eeaa30417e7f
+  data.tar.gz: a50dc6eae35b3c41b166e7532b798b32b414c9753fadc06f9e43aaf413502aee
+SHA512:
+  metadata.gz: e5b48f7d27454ee4f21d0bb5d3f785d2edd98d32c3ed5629be97fb2809f7705f0650ae6d460695c95f3e42a36e23f94c15266cb533b99e66b50aae1c0867d0d3
+  data.tar.gz: 44ced5a010465b9cee5abb5522401f1429575bc3787f63637d7818776aa4f01ed61a496a8fa4b30820a60734b5a5a33068e29a030bba46d2be52fa3d5443790c

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,84 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: disable
+  SuggestExtensions: false
+  Exclude:
+    - "vendor/**/*"
+    - "bin/**/*"
+    - "spec/**/*"
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+# Metrics - Relaxed for protocol parsing code
+Metrics/AbcSize:
+  Max: 60
+  Exclude:
+    - "lib/mysql-pr/protocol.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+
+Metrics/ClassLength:
+  Max: 750
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+# Layout
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "lib/mysql-pr/error.rb"
+    - "lib/mysql-pr/charset.rb"
+
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Naming
+Naming/PredicatePrefix:
+  AllowedMethods:
+    - is_num?
+    - is_not_null?
+    - is_pri_key?
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Lint/UnreachableCode:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.1] - 2025-11-25
+
+### Fixed
+
+- Fixed RuboCop style issues across codebase
+- Fixed CI configuration for GitHub Actions
+
+## [3.0.0] - 2025-11-25
+
+### Changed
+
+- **BREAKING**: Minimum Ruby version is now 3.0
+- Modernized codebase with frozen string literals
+- Updated to modern Ruby conventions and style
+- Replaced deprecated `Fixnum` with `Integer`
+
+### Removed
+
+- Ruby 1.8.x and 1.9.x support
+- Legacy encoding compatibility code
+
+### Added
+
+- **SSL/TLS connection support** - encrypted connections using Ruby's OpenSSL
+  - `ssl_set` method for configuring SSL certificates
+  - `ssl_options=` method for advanced SSL configuration
+  - `ssl_enabled?` and `ssl_cipher` methods to query SSL status
+  - Support for TLS 1.2 and TLS 1.3
+- **MySQL 8.0 `caching_sha2_password` authentication** support
+  - Full support for MySQL 8.0's default authentication plugin
+  - Fast authentication path when password is cached
+  - Full authentication via SSL or RSA encryption
+  - Automatic auth plugin detection and switching
+- Modern project structure with Bundler
+- RSpec test configuration
+- RuboCop for code style enforcement
+- GitHub Actions CI pipeline
+- Docker Compose configuration for testing
+- Comprehensive README documentation
+
+## [2.9.11] - 2012-06-13
+
+### Added
+
+- Initial release as mysql-pr (fork from mysql-ruby)
+- Pure Ruby MySQL client implementation
+- Prepared statements support
+- Character set handling

data/LICENSE

@@ -0,0 +1,83 @@
+mysql-pr is derived from the original mysql-pr/mysql-ruby by TOMITA Masahiro
+<tommy@tmtm.org>.
+
+This version (3.0.0+) is copyright 2025 Alex Jokela <alex@camulus.com>.
+
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see below), or the Ruby License (see below).
+
+--------------------------------------------------------------------------------
+
+The 2-clause BSD License:
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------------------------------------------------------------------------
+
+The Ruby License:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise make them
+      Freely Available, such as by posting said modifications to Usenet
+      or an equivalent medium, or by allowing the author to include your
+      modifications in the software.
+
+   b. use the modified software only within your corporation or organization.
+
+   c. give non-standard binaries non-standard names, with instructions on
+      where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form, provided
+   that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software, together
+      with instructions (in the manual page or equivalent) on where to get
+      the original distribution.
+
+   b. accompany the distribution with the machine-readable source of the
+      software.
+
+   c. give non-standard binaries non-standard names, with instructions on
+      where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial). But some files in the distribution are
+   not written by the author, so that they are not under these terms.
+
+5. The scripts and library files supplied as input to or produced as output
+   from the software do not automatically fall under the copyright of the
+   software, but belong to whomever generated them, and may be sold
+   commercially, and may be aggregated with this software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
+   WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

data/README.md

@@ -0,0 +1,199 @@
+# mysql-pr
+
+A pure Ruby MySQL client library. No native extensions required.
+
+[![CI](https://github.com/ajokela/mysql-pr/actions/workflows/ci.yml/badge.svg)](https://github.com/ajokela/mysql-pr/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/mysql-pr.svg)](https://badge.fury.io/rb/mysql-pr)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql-pr'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install mysql-pr
+```
+
+## Requirements
+
+- Ruby 3.0 or higher
+- MySQL 5.7+ or MySQL 8.0+
+
+## Usage
+
+### Basic Connection
+
+```ruby
+require 'mysql-pr'
+
+# Connect to MySQL
+my = MysqlPR.connect('hostname', 'username', 'password', 'database')
+
+# Execute a query
+result = my.query("SELECT id, name FROM users WHERE active = 1")
+result.each do |id, name|
+  puts "#{id}: #{name}"
+end
+
+# Close connection
+my.close
+```
+
+### Prepared Statements
+
+```ruby
+# Using prepared statements (recommended for user input)
+stmt = my.prepare('INSERT INTO users (name, email) VALUES (?, ?)')
+stmt.execute('John Doe', 'john@example.com')
+
+# Select with prepared statement
+stmt = my.prepare('SELECT * FROM users WHERE id = ?')
+stmt.execute(123)
+stmt.each do |row|
+  puts row.inspect
+end
+```
+
+### Transactions
+
+```ruby
+my.autocommit(false)
+
+begin
+  my.query("INSERT INTO accounts (name) VALUES ('test')")
+  my.query("UPDATE balances SET amount = amount - 100 WHERE id = 1")
+  my.commit
+rescue => e
+  my.rollback
+  raise e
+end
+```
+
+### Connection Options
+
+```ruby
+my = MysqlPR.init
+my.options(MysqlPR::OPT_CONNECT_TIMEOUT, 10)
+my.options(MysqlPR::OPT_READ_TIMEOUT, 30)
+my.options(MysqlPR::SET_CHARSET_NAME, 'utf8mb4')
+my.connect('hostname', 'username', 'password', 'database')
+```
+
+### Escaping Strings
+
+```ruby
+# Class method (no connection required)
+safe_string = MysqlPR.escape_string("O'Reilly")
+
+# Instance method
+safe_string = my.escape_string(user_input)
+```
+
+### SSL/TLS Connections
+
+```ruby
+my = MysqlPR.init
+
+# Simple SSL (no certificate verification - for self-signed certs)
+my.ssl_options = { verify: false }
+my.connect('hostname', 'username', 'password', 'database')
+
+# SSL with CA certificate verification
+my.ssl_set(nil, nil, '/path/to/ca-cert.pem')
+my.connect('hostname', 'username', 'password', 'database')
+
+# SSL with client certificate
+my.ssl_set(
+  '/path/to/client-key.pem',
+  '/path/to/client-cert.pem',
+  '/path/to/ca-cert.pem'
+)
+my.connect('hostname', 'username', 'password', 'database')
+
+# Check SSL status
+puts my.ssl_enabled?  # => true
+puts my.ssl_cipher    # => ["TLS_AES_256_GCM_SHA384", "TLSv1.3", 256, 256]
+```
+
+## Features
+
+- Pure Ruby implementation - no compilation required
+- MySQL protocol 4.1+ support
+- **Full MySQL 8.0 support** including `caching_sha2_password` authentication
+- **SSL/TLS encrypted connections** (TLS 1.2, 1.3)
+- Prepared statements with parameter binding
+- Multiple result sets
+- Character set support with automatic encoding conversion
+- Thread-safe connections
+
+## Differences from mysql2 gem
+
+This gem is a pure Ruby implementation, which means:
+
+- **Pros**: No native compilation, works on any Ruby platform, easier to install
+- **Cons**: Generally slower than native extensions for high-throughput applications
+
+Choose `mysql-pr` when you need:
+- Easy installation without native dependencies
+- Compatibility with JRuby or other alternative Ruby implementations
+- A lightweight MySQL client for simple applications
+
+## Development
+
+### Running Tests
+
+Unit tests can be run without a MySQL server:
+
+```bash
+bundle exec rspec spec/unit spec/mysql
+```
+
+### Integration Tests with Docker
+
+To run integration tests against a real MySQL server:
+
+```bash
+# Start MySQL container
+docker compose up -d
+
+# Run integration tests
+./bin/test-with-docker
+
+# Stop MySQL container when done
+docker compose down
+```
+
+Or configure your own MySQL server using environment variables:
+
+```bash
+MYSQL_SERVER=localhost \
+MYSQL_USER=root \
+MYSQL_PASSWORD=secret \
+MYSQL_DATABASE=test_for_mysql_ruby \
+MYSQL_PORT=3306 \
+bundle exec rspec spec/mysql_spec.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ajokela/mysql-pr.
+
+## License
+
+This gem is available under the Ruby License. See the LICENSE file for more details.
+
+## Authors
+
+- TOMITA Masahiro (tommy@tmtm.org) - Original author
+- Alex Jokela (alex@camulus.com) - Current maintainer

data/Rakefile

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

data/docker-compose.yml

@@ -0,0 +1,25 @@
+version: "3.8"
+
+services:
+  mysql:
+    image: mysql:8.0
+    container_name: mysql-pr-test
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: test_for_mysql_ruby
+    ports:
+      - "3306:3306"
+    command:
+      - --default-authentication-plugin=mysql_native_password
+      - --character-set-server=utf8mb4
+      - --collation-server=utf8mb4_unicode_ci
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-proot"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    volumes:
+      - mysql-data:/var/lib/mysql
+
+volumes:
+  mysql-data: