rails-sharding 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f4f44b9e47e25d00cce1cd88897d85750be2465
-  data.tar.gz: c84a17b9c9a59fd471e627c0784450cba5930451
+SHA256:
+  metadata.gz: 0a9130c4b0e150421dfa3655dcb44f5638cbca380851ec171cd1a85fa24752d8
+  data.tar.gz: 78086e09183f55c0e7fd6524447894d7b81d3e846bded97a10beeae3fb23cc0a
 SHA512:
-  metadata.gz: 113d4ba656d6ff072c81a116141cc4b7057d914fa64f9ccf00f64e4a0a08b062e4fde0b388216143ef5c5ba378c564b90fb2615b7d765683901d9d335b7ca28a
-  data.tar.gz: edda93d0db35871a3dd1b2cc0a95838112dfa928da60e925ae98f7d4467e298112907a6d3b800fc7267a9d0d41d8ee5a3d68d5433f629748e6dbad1b7dacf049
+  metadata.gz: cfdf3372608f63b68a500ec4522191d30d378fb35c1d386ef525c9f74f5281f64f7c694719b85b20d7359101d11aa69640b6d5b6e2c90ad07ff7e18f5935035f
+  data.tar.gz: 27af314dc9d9475801688ca28aae49ad5ed691d8dec71bc1a96f783ad1c72ec23565c094a404931610521de61f21846d33fb7fa37932e2c86d5a954b8c62f6c0

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.1
+ruby-2.5.7

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
+  - 2.5.7
 services:
   - mysql
   - postgresql

data/README.md

@@ -8,28 +8,34 @@
 
 Simple and robust sharding gem for Rails, including Migrations and ActiveRecord extensions
 
-This gems allows you to easily create extra databases to your rails application, and freely allocate ActiveRecord instances to any of the databases. It also provides rake tasks and migrations to help you manage the schema by shard groups.
+This gems allows you to easily create extra databases to your rails application, and freely allocate ActiveRecord instances to any of the databases. 
 
-After you have setup your shards, accessing them is as simple as:
+Accessing shards is as simple as:
 ```ruby
+  # creating a user to a specific shard
   new_user = User.using_shard(:shard_group1, :shard1).create(username: 'x')
+  
+  # retrieving a user from a specific shard
   loaded_user = User.using_shard(:shard_group1, :shard1).where(username: 'x').first
 ```
 
-You can also use the block syntax, where all your queries inside will be directed to the correct shard:
+You can also use the block syntax:
 ```ruby
   Rails::Sharding.using_shard(:shard_group1, :shard1) do
+    # All statements inside this block will go to the selected shard
+    
+    # Do some queries
     new_user = User.create(username: 'x')
     loaded_user = User.where(username: 'x').first
     billing_infos = loaded_user.billing_infos.all
   end
 ```
 
-You can also pick and choose which models will be shardable, so that all the models that are not shardable will still be retrieved from the master database, even if inside a using_shard block.
+You can also pick and choose which models will be shardable. Non shardable models will be retrieved from the master database, even if inside a `using_shard` block.
 
 ## Compatibility
 Gem version 1.x.x:
-* Rails 5.0
+* Rails 5.0 and 5.1
 * Databases: MySQL, MariaDB, Postgres
 
 Gem version 0.x.x:
@@ -51,7 +57,6 @@ bundle
 ```
 
 ## Creating Shards
-This gem helps you create shards that are additional and completely separate from your master database. The master database is the one that is created and managed through rails, and is the default storage for all your models.
 
 To start with the rails-sharding gem, run the command
 ```
@@ -80,7 +85,9 @@ development:
 ...
 ```
 
-Rename it to `config/shards.yml` and change it to your database configuration. This example file defines a single shard group (named `shard_group1`) containing two shards (`shard1` and `shard2`). A shard group is simply a set of shards that should have the same schema.
+Rename it to `config/shards.yml` and change it to your database configuration. This example file defines a single shard group (named `shard_group1`) containing two shards (`shard1` and `shard2`). 
+
+**A shard group is a set of shards that should have the same schema.**
 
 When you're ready to create the shards run
 ```
@@ -88,7 +95,13 @@ rake shards:create
 ```
 
 ## Migrating Shards
-Go to the directory `db/shards_migrations/shard_group1` and add all migrations that you want to run on the shards of `shard_group1`. By design, all shards in a same group should always have the same schema. For example, add the following migration to your `db/shards_migrations/shard_group1`:
+Go to the directory `db/shards_migrations/shard_group1` and add all migrations that you want to run on the shards of `shard_group1`. By design, all shards in a same group should always have the same schema. 
+
+
+As of now, there is no generator for migrations. You can use the regular rails generator and move the migrations to the `shards_migration` folder.
+
+
+For example, add the following migration to your `db/shards_migrations/shard_group1`:
 ```ruby
 # 20160808000000_create_users.rb
 class CreateClients < ActiveRecord::Migration[5.0]
@@ -175,6 +188,9 @@ Rails::Sharding.setup do |config|
 end
 ```
 
+## Wiki
+Want to know more? How to integrate with RSpec, Capistrano, etc? Take a look at our [wiki](https://github.com/hsgubert/rails-sharding/wiki).
+
 ## Development and Contributing
 
 After checking out the repo:

data/lib/rails/sharding/connection_handler.rb

@@ -78,7 +78,7 @@ module Rails::Sharding
     end
 
     def self.with_connection(shard_group, shard_name, &block)
-    	connection_pool(shard_group, shard_name).with_connection do |connection|
+      connection_pool(shard_group, shard_name).with_connection do |connection|
         if connection && Config.add_shard_tag_to_query_logs
           connection_name = connection_name(shard_group, shard_name)
           add_shard_tag_to_connection_log(connection, connection_name)

data/lib/rails/sharding/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Sharding
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

data/lib/tasks/rails-sharding.rake

@@ -281,10 +281,17 @@ shards_namespace = namespace :shards do
           should_reconnect = Rails::Sharding::ConnectionHandler.connection_pool(shard_group, shard).active_connection?
           Rails::Sharding::ConnectionHandler.establish_connection(shard_group, shard, 'test')
 
+          # saves the current RAILS_ENV (we must change it so the environment is set correcly on the metadata table)
+          initial_rails_env = Rails.env
+          Rails.env = 'test'
+
           Rails::Sharding.using_shard(shard_group, shard) do
             ActiveRecord::Tasks::DatabaseTasks.purge(configuration)
           end
         ensure
+          # restores rails env
+          Rails.env = initial_rails_env
+          
           if should_reconnect
             # reestablishes connection for RAILS_ENV environment (whatever that is)
             Rails::Sharding::ConnectionHandler.establish_connection(shard_group, shard)

data/rails-sharding.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rails', '~> 5.1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug", '~> 9'
+  spec.add_development_dependency "byebug", '~> 11'
   spec.add_development_dependency "mysql2", '~> 0'
   spec.add_development_dependency "pg", '~> 0' # postgres driver
   spec.add_development_dependency "codeclimate-test-reporter", '~> 1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-sharding
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Henrique Gubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -193,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Simple and robust sharding for Rails, including Migrations and ActiveRecord