sequel-schema-sharding 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2dce85ba1914970e81126721a1bfd51d6b9208d
-  data.tar.gz: 0376b7682b6ae4b35a91146bab97332eb208962e
+  metadata.gz: e8da54e7c94ed8f3eda67c2be550c95aa722bfd3
+  data.tar.gz: 047620efbb7536b0a187b50e3d276d46539012e9
 SHA512:
-  metadata.gz: f799c6bd555910a534954d137aac874f94ba9b57315c988066b696a09c381b6b81db75cfb6965d040e9a2ad26ccdd04f0bb1b562a5acfe7245658a315b1d19b2
-  data.tar.gz: a7cf6e434056d0cd54d693f9ffb09668e3e5bddebbe42fce825f5c36830ce0323173fdf6c8b039da16703f31f1df19478be2aa696be567c18cd183f81b7919ca
+  metadata.gz: 21e6938c04438c694bd04173cf53a0b7bd9d3c6677b4477909908e750e279e3b97b39984992d94feff45f7969775b1b5224ff8d2cb17aaa2e1ae41c276eb6b88
+  data.tar.gz: 8b67577bcdf9dd92391d78a6bafca000724560e96fa11b2ceec025cbc22ceb2d0fb15a585d365d0e1bc39cc5ed5eaadf2edebbda67dddc6da4e5f60d5df40cc1

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec'
   gem 'mocha', require: false
   gem 'pry-nav'
+  gem 'guard-rspec'
 end

data/Guardfile

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#^syntax detection
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/lib/sequel/schema-sharding/connection_manager.rb

@@ -2,6 +2,9 @@ require 'singleton'
 
 module Sequel
   module SchemaSharding
+    ##
+    # Used to manage database connections separately from database shards
+
     class ConnectionManager
       attr_reader :connections
 
@@ -11,11 +14,15 @@ module Sequel
 
       def [](name)
         config = db_config_for(name)
-        @connections[name.to_s] ||= Sequel.postgres(master_config_for(config).merge!(replica_hash_for(config)))
+        @connections[name.to_s] ||= Sequel.postgres(sequel_connection_config_for(config).merge!(replica_hash_for(config)))
       end
 
+      ##
+      # Used by rake tasks that need to deterministically work against a master
+      # database even when read/write splitting is configured.
+
       def master(name)
-        @connections["master_#{name}"] ||= Sequel.postgres(master_config_for(db_config_for(name)))
+        @connections["master_#{name}"] ||= Sequel.postgres(sequel_connection_config_for(db_config_for(name)))
       end
 
       def disconnect
@@ -25,12 +32,24 @@ module Sequel
         @connections = {}
       end
 
+      ##
+      # Given +table_name+ and +shard_number+, returns the name of the
+      # PostgreSQL schema based on a +schema_name+ pattern defined in sharding.yml.
+      # +shard_number+ is interpolated into +schema_name+ via sprintf, so
+      # +schema_name+ should include a format specifier with which to interpolate
+      # it (ex. %s, %02d).
+
       def schema_for(table_name, shard_number)
         number_of_shards = config.number_of_shards(table_name)
         pattern = config.schema_name(table_name)
         sprintf pattern, shard_number
       end
 
+      ##
+      # Given +table_name+, return a functional dataset. This is used when models
+      # are loaded to read table columns and allow for data typecasting.
+      # In most cases it should not be used directly in application code.
+
       def default_dataset_for(table_name)
         shard_number = config.logical_shard_configs(table_name).keys.first
         shard_name = config.logical_shard_configs(table_name)[shard_number]
@@ -39,7 +58,7 @@ module Sequel
 
       private
 
-      def master_config_for(config)
+      def sequel_connection_config_for(config)
         {
           :user => config['username'],
           :password => config['password'],
@@ -55,7 +74,7 @@ module Sequel
         return {} if config['replicas'].nil?
         {
           :servers => {
-            :read_only => ->(db) { config['replicas'].sample }
+            :read_only => ->(db) { sequel_connection_config_for(config['replicas'].sample) }
           }
         }
       end

data/lib/sequel/schema-sharding/version.rb

@@ -1,5 +1,5 @@
 module Sequel
   module SchemaSharding
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/sequel-schema-sharding.gemspec

@@ -4,23 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sequel/schema-sharding/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sequel-schema-sharding"
+  spec.name          = 'sequel-schema-sharding'
   spec.version       = Sequel::SchemaSharding::VERSION
-  spec.authors       = ["Paul Henry", "James Hart", "Eric Saxby"]
-  spec.email         = ["dev@wanelo.com"]
+  spec.authors       = ['Paul Henry', 'James Hart', 'Eric Saxby']
+  spec.email         = %w(dev@wanelo.com)
   spec.description   = %q{}
   spec.summary       = %q{Create horizontally sharded Sequel models with Postgres}
-  spec.homepage      = "https://github.com/wanelo/sequel-schema-sharding"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/wanelo/sequel-schema-sharding'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = %w(lib)
 
-  spec.add_dependency "sequel"
-  spec.add_dependency "pg"
+  spec.add_dependency 'sequel'
+  spec.add_dependency 'pg'
+  spec.add_dependency 'ruby-usdt'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 end

data/spec/schema-sharding/connection_manager_spec.rb

@@ -24,12 +24,12 @@ describe Sequel::SchemaSharding::ConnectionManager do
         expect(subject['shard1'].servers).to_not include(:read_only)
       end
 
-      #it 'executes a select against a replica' do
-      #  shard = subject['shard2']
-      #  Sequel::ShardedThreadedConnectionPool.any_instance.expects(:hold).with(:read_only).at_least_once
-      #  Sequel::ShardedThreadedConnectionPool.any_instance.expects(:hold).with(:default).at_least_once
-      #  shard[:"sequel_explosions_boof_pickles_3__artists"].first
-      #end
+      it 'executes a select against a replica' do
+        shard = subject['shard2']
+        ds = shard[:"sequel_explosions_boof_pickles_3__artists"]
+        shard.expects(:execute).once.with(anything, server: :read_only)
+        ds.first
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-schema-sharding
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Paul Henry
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -40,6 +40,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-usdt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,7 @@ files:
 - .travis.yml
 - CONTRIBUTORS.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile