rails-sharding 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b567029d770be424e7c1141bd5f483fd5fee49a630ee31248d66af9d57976ab9
-  data.tar.gz: 0aa3dd59efebe3aba5949784fcd342d3595dbe719057db9a68341480d3dae9bd
+  metadata.gz: 6b542040ae9301ac69b9ce91bd32321c41b25638257a76499171a8e2cc0f56c3
+  data.tar.gz: 01a21bafcf195bb8e63943f99a8044a905b10999d1800a98d2260b7e126e1d4f
 SHA512:
-  metadata.gz: 88089653b9b9c99acb012872175d426d5b60aad54b7e65a2d98afb6b128c7b7a1e904cdc62d06db1d68bd4c3d2589d1ed5cc7e6537d9ced97bc2f9e0044ba35b
-  data.tar.gz: 338d7f533b28c46625a0102cc861932a8819bde1084a02b37cf8a7ae1593b948bd35aefc6b0c5355967399453a70232f28bb465aaefdb86aaf2fe965c1d3b4c1
+  metadata.gz: 634c7ab62a151f7b07cb5f3faae84eec62b3a488dd7bd29c406effc8ac42085ef1470bc38c2fbeceec1cad8d42d50eb20269b0bbfa28d03c35855de5263286c6
+  data.tar.gz: ec85fb6f79150cfd31dea3a6767be50046c447bb908e9366fa6ba7484acd0004d50f40bac839449e2f6d72b5f2b5596fa3bb7b2b6c9752b2d20b1c7fbfbd7df5

data/.env.example

@@ -0,0 +1,4 @@
+MYSQL_USERNAME=____
+MYSQL_PASSWORD=____
+POSTGRES_USERNAME=____
+POSTGRES_PASSWORD=____

data/.gitignore

@@ -11,3 +11,4 @@
 /tmp/
 .byebug_history
 rails-sharding-*.*.*.gem
+.env

data/README.md

@@ -11,6 +11,7 @@ Simple and robust sharding gem for Rails, including Migrations and ActiveRecord
 This gems allows you to easily create extra databases to your rails application, and freely allocate ActiveRecord instances to any of the databases.
 
 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')
@@ -20,6 +21,7 @@ Accessing shards is as simple as:
 ```
 
 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
@@ -34,14 +36,16 @@ You can also use the block syntax:
 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, 5.1 and 5.2
-* Databases: MySQL, MariaDB, Postgres
+
+- Rails 5.0, 5.1 and 5.2
+- Databases: MySQL, MariaDB, Postgres
 
 Gem version 0.x.x:
-* Rails 4.2
-* Databases: MySQL, MariaDB
 
+- Rails 4.2
+- Databases: MySQL, MariaDB
 
 ## Installation
 
@@ -52,6 +56,7 @@ gem 'rails-sharding'
 ```
 
 And then execute:
+
 ```
 bundle
 ```
@@ -59,19 +64,21 @@ bundle
 ## Creating Shards
 
 To start with the rails-sharding gem, run the command
+
 ```
 rails g rails_sharding:scaffold
 ```
 
 This will generate a `config/shards.yml.example` like this:
+
 ```ruby
 default: &default
   adapter: mysql2
   encoding: utf8
   reconnect: false
   pool: 5
-  username: ___
-  password: ___
+  username: <%= ENV["MYSQL_USERNAME"] %>
+  password: <%= ENV["MYSQL_PASSWORD"] %>
   socket: /var/run/mysqld/mysqld.sock
 
 development:
@@ -90,18 +97,19 @@ Rename it to `config/shards.yml` and change it to your database configuration. T
 **A shard group is a set of shards that should have the same schema.**
 
 When you're ready to create the shards run
+
 ```
 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.
 
+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]
@@ -119,11 +127,13 @@ end
 ```
 
 Then run:
+
 ```
 rake shards:migrate
 ```
 
 All the shards will be migrated, and one schema file will be dumped for each of the shards (just like rails would do for your master database). You can see the schema of the shards in `db/shards_schemas/shard_group1/`, and it will be something like:
+
 ```ruby
 ActiveRecord::Schema.define(version: 20160808000000) do
 
@@ -137,32 +147,37 @@ end
 ```
 
 ## Other rake tasks
+
 The rails-sharding gem offers several rake tasks analogous to the ones offered by ActiveRecord:
+
 ```
-rake shards:create                                      
-rake shards:drop                                        
-rake shards:migrate                                     
-rake shards:migrate:down                                
-rake shards:migrate:redo                                
-rake shards:migrate:reset                               
-rake shards:migrate:up                                  
-rake shards:rollback                                    
-rake shards:schema:dump                                 
-rake shards:schema:load                                 
-rake shards:test:load_schema                            
-rake shards:test:prepare                                
-rake shards:test:purge               
+rake shards:create
+rake shards:drop
+rake shards:migrate
+rake shards:migrate:down
+rake shards:migrate:redo
+rake shards:migrate:reset
+rake shards:migrate:up
+rake shards:rollback
+rake shards:schema:dump
+rake shards:schema:load
+rake shards:test:load_schema
+rake shards:test:prepare
+rake shards:test:purge
 rake shards:version
 ```
 
 They work just the same as the tasks `rake:db:...` but they operate on all shards of all shard groups. If you want to run a rake task just to a specific shard group or shard you can use the `SHARD_GROUP` and `SHARD` options:
+
 ```
 rake shards:migrate SHARD_GROUP=shard_group_1
 rake shards:migrate SHARD_GROUP=shard_group_1 SHARD=shard1
 ```
 
 ## Gem Options
+
 Running the `rails g rails_sharding:scaffold` will create an initializer at `config/initializers/rails-sharding.rb`. You can pass additional configurations on this initializer to control the gem behavior. You can see below all available options and their default values:
+
 ```ruby
 # config/initializers/rails-sharding.rb
 
@@ -189,6 +204,7 @@ 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
@@ -199,13 +215,14 @@ After checking out the repo:
 
 1. Create your `spec/fixtures/shards.yml` based on the example on this same folder (you need MySQL and Postgres)
 
+1. Create your `.env` based on the example on this same folder.
+
 1. Run `rake db:test:prepare` to create the test shards.
 
 1. Run `rspec` to run the tests.
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hsgubert/rails-sharding.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rails/sharding.rb

@@ -8,11 +8,9 @@ require 'rails/sharding/railtie' if defined?(Rails::Railtie)
 
 module Rails
   module Sharding
-
     # delegates all methods to Core, to shorten method calls
     def self.method_missing(method_sym, *arguments, &block)
       Core.send(method_sym, *arguments, &block)
     end
-
   end
 end

data/lib/rails/sharding/core.rb

@@ -29,7 +29,7 @@ module Rails::Sharding
     end
 
     def self.configurations(environment=Rails.env)
-      @@db_configs ||= YAML.load_file(Config.shards_config_file)
+      @@db_configs ||= YAML.load(ERB.new(File.read(Config.shards_config_file)).result)
       environment_config = @@db_configs[environment]
       return environment_config if environment_config
 

data/lib/rails/sharding/shard_thread_registry.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/module'
 
 module Rails::Sharding
   class ShardThreadRegistry

data/lib/rails/sharding/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Sharding
-    VERSION = "1.2.1"
+    VERSION = "1.2.2"
   end
 end

data/rails-sharding.gemspec

@@ -1,36 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rails/sharding/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rails-sharding"
+  spec.name          = 'rails-sharding'
   spec.version       = Rails::Sharding::VERSION
-  spec.authors       = ["Henrique Gubert"]
-  spec.email         = ["guberthenrique@hotmail.com"]
+  spec.authors       = ['Henrique Gubert']
+  spec.email         = ['guberthenrique@hotmail.com']
 
-  spec.summary       = %q{Simple and robust sharding for Rails, including
-    Migrations and ActiveRecord extensions}
-  spec.description   = %q{This gems allows you to easily create extra databases
+  spec.summary       = 'Simple and robust sharding for Rails, including
+    Migrations and ActiveRecord extensions'
+  spec.description   = '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.}
-  spec.homepage      = "https://github.com/hsgubert/rails-sharding"
-  spec.license       = "MIT"
+    you manage the schema by shard groups.'
+  spec.homepage      = 'https://github.com/hsgubert/rails-sharding'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'rails', '~> 5.2.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", '~> 11'
-  spec.add_development_dependency "mysql2", '~> 0'
-  spec.add_development_dependency "pg", '~> 0' # postgres driver
-  spec.add_development_dependency "codeclimate-test-reporter", '~> 1'
-  spec.add_development_dependency "simplecov", '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'byebug', '~> 11'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1'
+  spec.add_development_dependency 'mysql2', '~> 0'
+  spec.add_development_dependency 'pg', '~> 0' # postgres driver
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-sharding
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Henrique Gubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,49 +39,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,33 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".env.example"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple and robust sharding for Rails, including Migrations and ActiveRecord