replicat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4318b9a2e2e1c7e637af213a8ae09f2d292235e
-  data.tar.gz: 5063232ce2dcc9403137e7d4ec2f5ea4d011a5b9
+  metadata.gz: b0943235f899b2c1ae3617e2516a4616a5eb2da8
+  data.tar.gz: 4a793e61900339e0b78259c86f8c9af8a1d2ea6c
 SHA512:
-  metadata.gz: 8220a33336d837f1adfe5b848eaf9a301ddbdf9c9487abb4f7c90a6e6558f43907195e517ef435ab18c60b3b75ac08a605202646d5e08ff52b0a5d9225125e1d
-  data.tar.gz: 66bf65c92a44b0935e92473c77a0ecae0f09b72b64668e33ef7c56a58b0fde6068e594fc24613c43fcc24f010d812d202e354993da4475e6acdf4279b39d5986
+  metadata.gz: 2ab0acafcf8ff55fa4feb51ccadfbbc068ef5f0ebc4409305ad84d5466fb3319bb80f6806e19663b520c7b93733e053909c3f14d842fb533fe9b389fdcab3bff
+  data.tar.gz: a353681af3ecae8761a906b443df27fccd4b2b7e986eec5b05785dcff62da41bb44ad0a760fc3fd8f099a4ced8d9671fa503f00221451b951c46c31af7fdda67

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+* using(:slave1) can be used as scope method
+
+## 0.0.1
+* 1st release on 2013-11-27

data/README.md

@@ -45,33 +45,44 @@ production:
 Now SELECT queries of User model will be sent to slave connections.
 
 ```ruby
+# INSERT query is sent to master.
 User.create(name: "replicat")
-User.first #=> nil
+
+# SELECT query is sent to slave.
+User.first
 ```
 
 ### using
 `using` can help you specify particular connection.
-`using(:master)` uses master connection.
+When you want to send queries to master,
+you can use `using(:master)` to do that (:master is reserved name for `using` method).
+When you want to send queries to a particular slave,
+you can use the slave's name on database.yml like `using(:slave1)`.
 
 ```ruby
-User.create(name: "replicat")
-User.using(:master) { User.first } #=> #<User id: 2, name: "replicat">
+# SELECT query is sent to master.
+User.using(:master).first
+
+# INSERT query is sent to slave1.
+User.using(:slave1).create(name: "replicat")
+
+# :slave1 is used for User connection in the passed block.
+User.using(:slave1) { blog.user }
 ```
 
 ### round-robin
 slave connections are balanced by round-robin way.
 
 ```ruby
-User.using(:slave1) { User.create(name: "replicat") }
-User.first #=> #<User id: 2, name: "replicat">
-User.first #=> nil
-User.first #=> nil
-User.first #=> #<User id: 2, name: "replicat">
-User.first #=> nil
-User.first #=> nil
-User.first #=> #<User id: 2, name: "replicat">
-User.first #=> nil
-User.first #=> nil
+User.first # sent to slave1
+User.first # sent to slave2
+User.first # sent to slave3
+User.first # sent to slave1
+User.first # sent to slave2
+User.first # sent to slave3
+User.first # sent to slave1
+User.first # sent to slave2
+User.first # sent to slave3
 ```
 
 ### multi master-slave set

data/lib/replicat.rb

@@ -2,5 +2,6 @@ require "active_record"
 require "replicat/model"
 require "replicat/proxy"
 require "replicat/replicable"
+require "replicat/scope_proxy"
 require "replicat/version"
 require "replicat/active_record"

data/lib/replicat/model.rb

@@ -4,6 +4,11 @@ module Replicat
       raise "You must set `connection_name` of this model class." if !connection_name && !defined?(Rails)
       include Replicat::Replicable
       self.connection_name = connection_name || Rails.env.to_s
+      self
+    end
+
+    def replicated?
+      ancestors.include?(Replicable)
     end
   end
 end

data/lib/replicat/replicable.rb

@@ -44,10 +44,14 @@ module Replicat
       end
 
       def using(connection_name)
-        proxy.current_connection_name = connection_name
-        yield
+        if block_given?
+          proxy.current_connection_name = connection_name
+          yield
+        else
+          ScopeProxy.new(klass: self, connection_name: connection_name)
+        end
       ensure
-        proxy.current_connection_name = nil
+        proxy.current_connection_name = nil if block_given?
       end
     end
   end

data/lib/replicat/scope_proxy.rb

@@ -0,0 +1,24 @@
+module Replicat
+  class ScopeProxy
+    def initialize(attributes)
+      @klass = attributes[:klass]
+      @connection_name = attributes[:connection_name]
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      result = using { @klass.send(method_name, *args, &block) }
+      if result.respond_to?(:scoped)
+        @klass = result
+        self
+      else
+        result
+      end
+    end
+
+    def using
+      @klass.using(@connection_name) { yield }
+    end
+  end
+end

data/lib/replicat/version.rb

@@ -1,3 +1,3 @@
 module Replicat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/replicat.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "coffee-rails", ">= 3.0.10"
+  spec.add_development_dependency "database_cleaner", "1.2.0"
   spec.add_development_dependency "jquery-rails"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-rails"

data/spec/dummy/app/models/ingredient.rb

@@ -0,0 +1,5 @@
+class Ingredient < ActiveRecord::Base
+  replicate "test"
+
+  belongs_to :recipe
+end

data/spec/dummy/app/models/recipe.rb

@@ -1,3 +1,5 @@
 class Recipe < ActiveRecord::Base
   replicate "test"
+
+  has_many :ingredients
 end

data/spec/dummy/db/schema.rb

@@ -23,4 +23,11 @@ ActiveRecord::Schema.define(version: 0) do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+
+  create_table "ingredients", force: true do |t|
+    t.string "name", null: false
+    t.integer "recipe_id", null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 end

data/spec/replicat/model_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Replicat::Model do
+  let(:model_class) do
+    Class.new(ActiveRecord::Base)
+  end
+
+  describe ".replicate" do
+    context "with no args" do
+      it "includes Replicat::Replicable" do
+        model_class.replicate.ancestors.should include Replicat::Replicable
+      end
+
+      it "assigns connection_name attribute with Rails.env" do
+        model_class.replicate.connection_name.should == Rails.env
+      end
+
+      it "returns itself" do
+        model_class.replicate.should == model_class
+      end
+    end
+
+    context "with args" do
+      it "uses given value as connection_name attribute" do
+        model_class.replicate("master1").connection_name.should == "master1"
+      end
+    end
+  end
+
+  describe ".replicated?" do
+    context "with replicated model" do
+      it "returns true" do
+        model_class.replicate.should be_replicated
+      end
+    end
+
+    context "with non-replicated model" do
+      it "returns false" do
+        model_class.should_not be_replicated
+      end
+    end
+  end
+end

data/spec/replicat/replicable_spec.rb

@@ -1,14 +1,6 @@
 require "spec_helper"
 
 describe Replicat::Replicable do
-  describe ".has_any_replication?" do
-    context "with any replication in connection settings" do
-      it "returns true" do
-        Recipe.should have_any_replication
-      end
-    end
-  end
-
   describe ".connection_with_proxy" do
     context "with non-replicable model" do
       it "returns normal connection" do
@@ -52,6 +44,48 @@ describe Replicat::Replicable do
         end
       end
     end
+
+    context "with no block" do
+      it "can be used as scope" do
+        Recipe.using(:slave1).create(title: "test")
+        Recipe.using(:slave1).first.should_not == nil
+      end
+    end
+
+    context "with scope" do
+      it "works well" do
+        Recipe.all.using(:slave1).create(title: "test")
+        Recipe.where(title: "test").using(:slave1).first.should_not == nil
+      end
+    end
+
+    context "with belongs_to association" do
+      let!(:ingredient) do
+        Ingredient.using(:slave1).create(name: "test", recipe_id: recipe.id)
+      end
+
+      let(:recipe) do
+        Recipe.using(:slave1).create(title: "test")
+      end
+
+      it "works well" do
+        Recipe.using(:slave1) { ingredient.recipe.should == recipe }
+      end
+    end
+
+    context "with has_many association" do
+      let!(:ingredient) do
+        Ingredient.using(:slave1) { Ingredient.create(name: "test", recipe_id: recipe.id) }
+      end
+
+      let(:recipe) do
+        Recipe.using(:slave1) { Recipe.create(title: "test") }
+      end
+
+      it "works well" do
+        Ingredient.using(:slave1) { recipe.ingredients.should == [ingredient] }
+      end
+    end
   end
 
   describe ".proxy" do

data/spec/spec_helper.rb

@@ -4,12 +4,24 @@ require "replicat"
 ENV["RAILS_ENV"] ||= "test"
 require File.expand_path("../dummy/config/environment", __FILE__)
 require "rspec/rails"
-
-3.times {|i| FileUtils.copy("#{Rails.root}/db/test.sqlite3", "#{Rails.root}/db/test_slave#{i + 1}.sqlite3") }
+require "database_cleaner"
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.use_transactional_fixtures = true
   config.filter_run :focus
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :deletion
+    3.times do |i|
+      FileUtils.copy("#{Rails.root}/db/test.sqlite3", "#{Rails.root}/db/test_slave#{i + 1}.sqlite3")
+    end
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+    3.times do |i|
+      FileUtils.copy("#{Rails.root}/db/test.sqlite3", "#{Rails.root}/db/test_slave#{i + 1}.sqlite3")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: replicat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +228,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -223,6 +238,7 @@ files:
 - lib/replicat/model.rb
 - lib/replicat/proxy.rb
 - lib/replicat/replicable.rb
+- lib/replicat/scope_proxy.rb
 - lib/replicat/version.rb
 - replicat.gemspec
 - spec/dummy/Rakefile
@@ -232,6 +248,7 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/ingredient.rb
 - spec/dummy/app/models/recipe.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -259,6 +276,7 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/replicat/model_spec.rb
 - spec/replicat/replicable_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/replicat
@@ -293,6 +311,7 @@ test_files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/ingredient.rb
 - spec/dummy/app/models/recipe.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -320,5 +339,6 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/replicat/model_spec.rb
 - spec/replicat/replicable_spec.rb
 - spec/spec_helper.rb