trilogy_aurora 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30793dcf14f37f6c04d69ff701c85b709279ce88fa81301b33e749f05c5b05ba
-  data.tar.gz: b243bfe9899bb88ecc1b0e91472567d870161b0af6074b1db0e70584d4ccdd27
+  metadata.gz: 35db8108014a6e21a985a21fbce35d8ecea1e50a610e0b90d0311494f7e766ac
+  data.tar.gz: c798f7504199f039eb435c9055ab4fbda470cb87f72afe07c0a8a4b14562a0dd
 SHA512:
-  metadata.gz: 458345a870ba34e36d5fecc6bbaa5cb432925bf04e5e09d4bba81f62d47343cdf8e717d0c254910e2d94ae3c8a0180c57272c1c347c9f368a75befda00fb6c74
-  data.tar.gz: 90d3e86cbe6d04db68d2ae23547f303a2dc7d8883b34bc8af664f9a3f1f6ddd05e3c24d84c783fc146d45356f0a52bcae9230849c37c684a03f445beb5cf0110
+  metadata.gz: 1d8844c208b6cd107473b7da1b3cf35e7b87f614249e64ace04f538850731b272896e2ff727b2c1981d3f4e4c53e0080d6b19a958c5c02459157f5efb6802fe6
+  data.tar.gz: b0e9e837a24f5f71153dc774cbcbcd5a8a83d310f02acecd84da0779d64b36a1c5c1280f4c8577cc84493bd11d4fed2d00fad6656cd5eceaa7d3b9943bab961a

data/.rspec

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

data/README.md

@@ -14,11 +14,13 @@ Essentially, the [mysql2-aurora](https://github.com/alfa-jpn/mysql2-aurora) gem
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add trilogy_aurora
+```shell
+bundle add trilogy_aurora
+```
 
 ## Usage
 
-In addition to existing initialization options for `Trilogy`, you can now also use the `aurora_max_retry` and `aurora_disconnect_on_readonly` options.
+In addition to existing initialization options for `Trilogy`, you can now also use the `aurora_disconnect_on_readonly` and `aurora_max_retry` options.
 
 ```ruby
 Trilogy.new(
@@ -32,14 +34,12 @@ Trilogy.new(
 
 with Rails >= 7.1, in `database.yml`
 
-```yml
+```yaml
 development:
-  adapter:          trilogy
-  host:             localhost
-  username:         root
-  password:         change_me
-  aurora_max_retry: 5
+  adapter: trilogy
+  # ...
   aurora_disconnect_on_readonly: true
+  aurora_max_retry: 5
 ```
 
 From the README of [mysql2-aurora](https://github.com/alfa-jpn/mysql2-aurora):
@@ -77,10 +77,14 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/a-lavi
 
 ## Testing
 
+Run Rubocop + RSpec
+
 ```shell
-# Image build
-bin/docker-build
+bundle exec rake
+```
 
-# Run tests
-bin/docker-test
+Clean up
+
+```shell
+docker compose down
 ```

data/Rakefile

@@ -3,10 +3,22 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(spec: :mysql)
 
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[rubocop spec]
+
+desc 'Ensure MySQL is available'
+task :mysql do
+  sh 'docker compose up --detach mysql &> /dev/null'
+  catch :ready do
+    loop do
+      sh 'docker compose run --rm mysql mysql -h mysql -e "SELECT 1" &> /dev/null' do |ok|
+        ok ? throw(:ready) : sleep(1)
+      end
+    end
+  end
+end

data/compose.yml

@@ -0,0 +1,7 @@
+services:
+  mysql:
+    image: mysql:8.0
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: true
+    ports:
+      - 3306

data/lib/trilogy_aurora/client.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'trilogy'
+
+module TrilogyAurora
+  # Trilogy Aurora wrapper
+  class Client
+    attr_reader :trilogy
+
+    def initialize(options = {})
+      @trilogy = TrilogyAurora::Trilogy.new(options)
+    end
+
+    # Disconnect and re-initialize TrilogyAurora::Trilogy
+    def reconnect!
+      disconnect!
+
+      @trilogy = TrilogyAurora::Trilogy.new(@trilogy.connection_options.dup)
+    end
+
+    # Close TrilogyAurora::Trilogy connection
+    def disconnect!
+      trilogy&.close
+    rescue StandardError
+      nil
+    end
+
+    # Execute a TrilogyAurora::Trilogy query, disconnecting or reconnecting after read-only errors
+    # based on initialization options.
+    def query(...) # rubocop:disable Metrics/AbcSize
+      try_count = 0
+
+      begin
+        trilogy.query(...)
+      rescue TrilogyAurora::Trilogy::Error => e
+        raise unless e.message&.include?('--read-only')
+
+        try_count += 1
+
+        if trilogy.connection_options[:aurora_disconnect_on_readonly]
+          warn <<~WARNING
+            [trilogy_aurora] Database is readonly, Aurora failover event likely occured. \
+            Closing database connection
+          WARNING
+          disconnect!
+        elsif try_count <= trilogy.connection_options[:aurora_max_retry]
+          retry_interval_seconds = [1.5 * (try_count - 1), 10].min
+          warn <<~WARNING
+            [trilogy_aurora] Database is readonly. \
+            Retry after #{retry_interval_seconds} seconds
+          WARNING
+          sleep retry_interval_seconds
+          reconnect!
+          retry
+        end
+
+        raise
+      end
+    end
+
+    # Delegate instance method calls to TrilogyAurora::Trilogy instance.
+    def method_missing(...)
+      trilogy.public_send(...)
+    end
+
+    # Delegate `respond_to?` to TrilogyAurora::Trilogy instance.
+    def respond_to_missing?(...)
+      trilogy.respond_to?(...)
+    end
+
+    # Delegate class method calls to TrilogyAurora::Trilogy.
+    def self.method_missing(...)
+      TrilogyAurora::Trilogy.public_send(...)
+    end
+
+    # Delegate `respond_to?` to TrilogyAurora::Trilogy.
+    def self.respond_to_missing?(...)
+      TrilogyAurora::Trilogy.respond_to?(...)
+    end
+
+    # Delegate const reference to TrilogyAurora::Trilogy.
+    def self.const_missing(...)
+      TrilogyAurora::Trilogy.const_get(...)
+    end
+
+    # Delegate `const_defined?` to TrilogyAurora::Trilogy.
+    def self.const_defined?(...)
+      TrilogyAurora::Trilogy.const_defined?(...)
+    end
+  end
+
+  Trilogy = Object.send(:remove_const, :Trilogy)
+end
+
+Trilogy = TrilogyAurora::Client

data/lib/trilogy_aurora/version.rb

@@ -2,5 +2,5 @@
 
 module TrilogyAurora
   # The version of this gem.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/trilogy_aurora.rb

@@ -1,111 +1,4 @@
 # frozen_string_literal: true
 
-require_relative 'trilogy_aurora/version'
-require 'trilogy'
-
-# This module contains Trilogy, a wrapper around ::Trilogy that handles read-only errors from Aurora.
-#
-# It also contains the original ::Trilogy class as ORIGINAL_TRILOGY_CLASS.
-module TrilogyAurora
-  # A wrapper around ::Trilogy that handles read-only errors from Aurora.
-  class Trilogy
-    # The ::Trilogy instance.
-    attr_reader :trilogy
-
-    # Pass in any options that ::Trilogy accepts.
-    #
-    # Additionally, you can pass in the `aurora_max_retry` and `aurora_disconnect_on_readonly` options:
-    #
-    # - `aurora_max_retry` is the number of times to retry a query when it fails due to a read-only error.
-    # The default is 5.
-    #
-    # - `aurora_disconnect_on_readonly` is a boolean that determines whether or not to disconnect from the database
-    # after a read-only error is encountered.
-    # The default is false.
-    def initialize(opts)
-      @opts = opts&.transform_keys(&:to_sym)
-      @max_retry = @opts.delete(:aurora_max_retry) || 5
-      @disconnect_only = @opts.delete(:aurora_disconnect_on_readonly) || false
-      reconnect!
-    end
-
-    # Execute a ::Trilogy query, disconnecting or reconnecting after read-only errors
-    # based on initialization options.
-    def query(...)
-      try_count = 0
-
-      begin
-        trilogy.query(...)
-      rescue TrilogyAurora::ORIGINAL_TRILOGY_CLASS::Error => e
-        raise e unless e.message&.include?('--read-only')
-
-        try_count += 1
-
-        if @disconnect_only
-          warn(
-            '[trilogy_aurora] Database is readonly, Aurora failover event likely occured, closing database connection'
-          )
-          disconnect!
-        elsif try_count <= @max_retry
-          retry_interval_seconds = [1.5 * (try_count - 1), 10].min
-
-          warn "[trilogy_aurora] Database is readonly. Retry after #{retry_interval_seconds}seconds"
-          sleep retry_interval_seconds
-          reconnect!
-          retry
-        end
-
-        raise e
-      end
-    end
-
-    # Disconnect and re-initialize ::Trilogy
-    def reconnect!
-      disconnect!
-
-      @trilogy = TrilogyAurora::ORIGINAL_TRILOGY_CLASS.new(@opts)
-    end
-
-    # Close ::Trilogy connection
-    def disconnect!
-      @trilogy&.close
-    rescue StandardError
-      nil
-    end
-
-    # Delegate instance method calls to ::Trilogy instance.
-    def method_missing(name, ...)
-      trilogy.public_send(name, ...)
-    end
-
-    # Delegate `respond_to?` to ::Trilogy instance.
-    def respond_to_missing?(name, ...)
-      trilogy.respond_to?(name, ...)
-    end
-
-    # Delegate class method calls to ::Trilogy.
-    def self.method_missing(name, ...)
-      TrilogyAurora::ORIGINAL_TRILOGY_CLASS.public_send(name, ...)
-    end
-
-    # Delegate `respond_to?` to ::Trilogy.
-    def self.respond_to_missing?(name, ...)
-      TrilogyAurora::ORIGINAL_TRILOGY_CLASS.respond_to?(name, ...)
-    end
-
-    # Delegate const reference to ::Trilogy.
-    def self.const_missing(name)
-      TrilogyAurora::ORIGINAL_TRILOGY_CLASS.const_get(name)
-    end
-
-    # Delegate `const_defined?` to ::Trilogy.
-    def self.const_defined?(name, ...)
-      TrilogyAurora::ORIGINAL_TRILOGY_CLASS.const_defined?(name, ...)
-    end
-  end
-
-  # The original ::Trilogy class.
-  ORIGINAL_TRILOGY_CLASS = ::Trilogy
-  # Swap out the original ::Trilogy class with our wrapper (Trilogy).
-  ::Trilogy = TrilogyAurora::Trilogy
-end
+require 'trilogy_aurora/version'
+require 'trilogy_aurora/client'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trilogy_aurora
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aidan Lavis
 bindir: bin
 cert_chain: []
-date: 2025-05-05 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -15,50 +15,43 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: trilogy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.5'
 email:
 - aidanlavis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
 - ".rdoc_options"
 - ".rspec"
 - ".rubocop.yml"
-- Dockerfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- docker-compose.yml
+- compose.yml
 - lib/trilogy_aurora.rb
+- lib/trilogy_aurora/client.rb
 - lib/trilogy_aurora/version.rb
 homepage: https://github.com/a-lavis/trilogy_aurora
 licenses:

data/.dockerignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/Dockerfile

@@ -1,20 +0,0 @@
-ARG RUBY_VERSION=3.4
-
-FROM ruby:${RUBY_VERSION}-alpine
-
-ARG TRILOGY_VERSION
-
-ENV TRILOGY_VERSION=$TRILOGY_VERSION
-
-# Create application directory.
-RUN mkdir /app
-WORKDIR /app
-
-# Install packages
-RUN apk upgrade && apk add --update build-base git linux-headers libxml2-dev libxslt-dev mariadb-dev ruby-dev tzdata yaml-dev zlib-dev
-
-# Deploy application
-ADD . /app
-
-# Install gems
-RUN sh /app/bin/setup

data/docker-compose.yml

@@ -1,23 +0,0 @@
-services:
-  app:
-    build:
-      context: .
-    environment:
-      TEST_DB_HOST: 'mysql'
-      TEST_DB_USER: 'root'
-      TEST_DB_PASS: ''
-    volumes:
-      - .:/app
-    depends_on:
-      mysql:
-        condition: service_healthy
-  mysql:
-    image: mysql:8.0
-    environment:
-      MYSQL_ROOT_PASSWORD: ''
-      MYSQL_ALLOW_EMPTY_PASSWORD: 1
-    healthcheck:
-      test: ["CMD-SHELL", "mysqladmin ping -h mysql"]
-      interval: 10s
-      timeout: 5s
-      retries: 3