ar_shard 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb30eeafede0838d558ae4886d8f2c4f517f4f182435120ba0a7216568e50dc6
+  data.tar.gz: c1b60bd917fcb034565f33192582d1338a406495483f3c34af827a41d6e8dd62
+SHA512:
+  metadata.gz: 1ffca4562eabdd5f2ee9b5481d613d3f1619618e6829ce885f91dc58530237d5d90e0066fbff0695e06a827cae19e06a7d258bfdd009db5122a96a9ab37748b9
+  data.tar.gz: 0a6c6032fe0aa90979a839a1c76f82c48d6f4e3e4c3213b3f3e31958336fe6fb7c6b433c33879c61f1e0be024a642a55e1254a89076bc015f070268669e3dc1a

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.5.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 0.2.2
+- Fixed missing connection if loaded from YAML
+- Added tests for multiple connection switches with another block
+
+## 0.2.1
+
+- Added support for Proc in config
+- Fixed AR poluting
+- Removed Rails dependency
+
+## 0.2.0
+
+- Extracted to be a gem
+
+## 0.1.0
+
+- Initial Idea

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    ar_shard (0.2.2)
+      activerecord (>= 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.11.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ar_shard!
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alex Tsirel
+
+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,89 @@
+# AR Shard
+
+AR Shard is non-intrusive extenstion for ActiveRecord to add threadsafe Model based sharding or just multidatabase connection. As this gem uses connection_handlers it can work only with ActiveRecord 6 and above.
+
+## Features
+- Shard only part of you ActiveRecord w/o sharing connection
+- Work with you Sharded Model and AR model at the same time
+- Threadsafe. Battle-tested with Sidekiq and 4 mixed Databases
+- Define config as a Proc. `Due to nature of connection_handlers all DB connections are established at boot time`
+
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'ar_shard', '~> 0.2'
+```
+
+## Usage
+
+Define your separate AR like:
+
+```ruby
+class ShardRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connected_shards shards: [
+    { shard_1: { adapter: 'sqlite3', database: 'shard_1' } },
+    { shard_2: { adapter: 'postgresql', database: 'shard_2' } },
+    { shard_3: { adapter: 'sqlite3', database: 'shard_3' } }
+  ]
+end
+```
+
+or with Proc
+
+```ruby
+class ShardRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connected_shards shards: -> { YAML.load_file('path/to/config/shards.yml') }
+end
+```
+
+given we have models like:
+
+```ruby
+class User < ActiveRecord::Base
+
+end
+
+class Sharded::User < ShardRecord
+
+end
+```
+
+AR Shard is isolating and rotating connections. Same like Rails Multibase support but without overlap.
+Now we can do crazy things like:
+
+```ruby
+# Connecting to another DB
+ShardRecord.with_shard(:shard_name) do
+  Sharded::User.find_each do |user|
+    # Working with our DB and another at the same time!
+
+    u = User.find_by(email: user.email)
+    u.update(name: user.name)
+  end
+end
+```
+
+## Contributing
+
+- [Report bugs](https://github.com/noma4i/ar_shard/issues)
+- Fix bugs and [submit pull requests](https://github.com/noma4i/ar_shard/pulls)
+
+To get started with development:
+
+```sh
+git clone https://github.com/noma4i/ar_shard.git
+cd ar_shard
+bundle install
+bundle exec rake test
+```
+
+## 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/ar_shard.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/ar_shard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ar_shard'
+  spec.version       = ARShard::VERSION
+  spec.authors       = ['Alex Tsirel']
+  spec.email         = ['noma4i@gmail.com']
+
+  spec.summary       = 'Isolated Multibase Support for ActiveRecord Models with dynamic config'
+  spec.description   = 'Isolated Multibase Support for ActiveRecord Models with dynamic config'
+  spec.homepage      = 'https://github.com/noma4i/ar_shard'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/noma4i/ar_shard'
+
+  # 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 { |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']
+
+  spec.add_dependency 'activerecord', '>= 6'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ar_shard'
+
+# 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/ar_shard.rb

@@ -0,0 +1,6 @@
+require 'ar_shard/version'
+require 'ar_shard/active_record'
+
+module ARShard
+  class Error < StandardError; end
+end

data/lib/ar_shard/active_record.rb

@@ -0,0 +1,59 @@
+require 'active_record'
+require 'pry'
+
+module ActiveRecord
+  mattr_accessor :klass_name
+
+  class Base
+    mattr_accessor :isolated_connection
+
+    def self.add_shared_override!
+      shard_model.define_singleton_method(:connection) do
+        @@isolated_connection || retrieve_connection
+      end
+    end
+  end
+
+  module ConnectionHandling
+    def connected_shards(shards: nil)
+      @connected_shards ||= begin
+        config_data = parse_config(shards)
+        @@klass_name = self.name
+        connections = {}
+
+        shard_model.add_shared_override!
+
+        config_data.each do |shard|
+          key, conf = shard.flatten
+          handler = lookup_connect(key.to_sym)
+
+          connections[key.to_sym] = handler.establish_connection(conf)
+        end
+
+        connections
+      end
+    end
+
+    def parse_config(config)
+      return config.call if config.is_a?(Proc)
+      return config if config.is_a?(Array)
+
+      raise ARShard::Error.new 'Shard config should be Array or Proc'
+    end
+
+    def shard_model
+      @shard_model ||= @@klass_name.constantize
+    end
+
+    def lookup_connect(handler_key)
+      connection_handlers[handler_key] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+    end
+
+    def with_shard(handler_key, &blk)
+      shard_model.isolated_connection = connected_shards[handler_key].connection
+      yield
+    ensure
+      shard_model.isolated_connection = nil
+    end
+  end
+end

data/lib/ar_shard/version.rb

@@ -0,0 +1,3 @@
+module ARShard
+  VERSION = "0.2.2"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ar_shard
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Alex Tsirel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Isolated Multibase Support for ActiveRecord Models with dynamic config
+email:
+- noma4i@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_shard.gemspec
+- bin/console
+- bin/setup
+- lib/ar_shard.rb
+- lib/ar_shard/active_record.rb
+- lib/ar_shard/version.rb
+homepage: https://github.com/noma4i/ar_shard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noma4i/ar_shard
+  source_code_uri: https://github.com/noma4i/ar_shard
+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.0.8
+signing_key:
+specification_version: 4
+summary: Isolated Multibase Support for ActiveRecord Models with dynamic config
+test_files: []