active_record-connection_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86a8111734864f7f391204ad04e1b46b20a7dd8910493e1dab651a00b274be91
+  data.tar.gz: 7475c705e69f077fbe3546522fc7fb96f3e2022399f6149da5b049b3d912e2c6
+SHA512:
+  metadata.gz: 32e076818e42ede2041e7bd57357fc13faed032b8644f83802b888ab164982eb30dfd0c2e145634e61593c9eae77d1db3fd6ca408adebad9db33bcee33547c32
+  data.tar.gz: 48671cbb87f44e843f06296ca862545a0c6976f6a9cfed93655cbe9d818fae485200baa812267e92e3f1c5d58c971a4963323b2d1add55d99d7ea517e3247ae3

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record-connection_proxy.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 r7kamura
+
+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,88 @@
+# ActiveRecord::ConnectionProxy
+
+Provides proxy-based connection switching logic for ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-connection_proxy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_record-connection_proxy
+
+## Usage
+
+To avoid overcomplication, this library only provides `ActiveRecord::ConnectionProxy` class that borrows ActiveRecord connection from another model.
+So you'll need to assemble some parts yourself.
+
+For example, if you do replication on production environment, the first step is to setup database configuration:
+
+```yaml
+# config/database.yml
+development:
+  url: ...
+
+test:
+  url: ...
+
+produciton:
+  url: ...
+
+production_replica: # <- This one!
+  url: ...
+```
+
+then create an empty abstract model class to borrow connection:
+
+```ruby
+# app/models/replica.rb
+class Replica < ActiveRecord::Base
+  self.abstract_class = true
+
+  if ::Rails.env.production?
+    establish_connection(:production_replica)
+  end
+end
+```
+
+then add some handy method like this:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  def with_replica
+    ::ActiveRecord::ConnectionProxy.new(
+      connection: ::Replica.connection,
+      klass: self,
+    )
+  end
+end
+```
+
+After that, you can read records from `production_replica` connection on production env like this:
+
+```ruby
+User.with_replica.where(status: :active).order(created_at: :desc).first
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/active_record-connection_proxy.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/active_record-connection_proxy.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/active_record/connection_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record-connection_proxy"
+  spec.version       = ActiveRecord::ConnectionProxy::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+
+  spec.summary       = 'Provides proxy-based connection switching logic for ActiveRecord.'
+  spec.homepage      = 'https://github.com/r7kamura/active_record-connection_proxy'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/connection_proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/connection_proxy.rb

@@ -0,0 +1,32 @@
+require "active_record/connection_proxy/version"
+
+module ActiveRecord
+  class ConnectionProxy
+    attr_reader :connection
+
+    def initialize(connection:, klass:)
+      @connection = connection
+      @klass = klass
+    end
+
+    def ==(*args)
+      method_missing(:==, *args)
+    end
+
+    def method_missing(method_name, *args, &block)
+      result = @klass.__send__(method_name, *args, &block)
+      if result.respond_to?(:all)
+        Proxy.new(
+          connection: @connection,
+          klass: result
+        )
+      else
+        result
+      end
+    end
+
+    def respond_to_missing?(method_name, *args, &block)
+      @klass.__send__(:respond_to_missing?, method_name, *args, &block)
+    end
+  end
+end

data/lib/active_record/connection_proxy/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class ConnectionProxy < ::BasicObject
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: active_record-connection_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-connection_proxy.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/connection_proxy.rb
+- lib/active_record/connection_proxy/version.rb
+homepage: https://github.com/r7kamura/active_record-connection_proxy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r7kamura/active_record-connection_proxy
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Provides proxy-based connection switching logic for ActiveRecord.
+test_files: []