octoshark 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edbe9d237528071174741f9625af2b2f752ebb3f
-  data.tar.gz: a0f0081430d9987ceaa43f375526cab9acec3817
+  metadata.gz: 161e067d71a05ad670c0878c76c81cf2f12e46f6
+  data.tar.gz: 2ea1161f0943be6a2898098ce33a45d71c198d79
 SHA512:
-  metadata.gz: 01b1279e3d8036eed43a2ef8f780fe5ec13281d424f1202ea2a3d3857cea5a9a826a508a10d35603082fef1b9304883d7a12a801d41e2663bce639cd721ffe37
-  data.tar.gz: 5050e8c20e16acae21138f85cea4cc033500f27f6fba0c4c1c57d85ff20c08a10a233bbcd6517c3592752ed1895250e9c7113ff35ad84e07ae1bfb1feb188dd2
+  metadata.gz: e564f3d12510245908fa909d14712e1a3c7be6463b9bdd48c5040951762f08aeaa4052a7e17a434671396dae16a19c6a3c64c7164db2463884551b316895a5c2
+  data.tar.gz: 770a6674f4dfb97311027811c613450dabc42c95894f314477b174f121793357f529efb81257aa7972b94696963d45ad1760588c7fa62323bb771b63f63c67b2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -5,4 +5,7 @@ cache:
 notifications:
   email:
     - dalibor.nasevic@gmail.com
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4.gemfile
 script: bundle exec rspec spec

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails3" do
+  gem "activerecord", "~> 3.0.0"
+end
+
+appraise "rails4" do
+  gem "activerecord", "~> 4.0.0"
+end

data/README.md

@@ -31,7 +31,7 @@ $ gem install octoshark
 Specify the connections for Octoshark to manage. This is usually done in an app initializer.
 
 ```ruby
-Octoshark.setup({
+Octoshark.configure({
   db1: { adapter: "sqlite3", database: "db/db1.sqlite" },
   db2: { adapter: "sqlite3", database: "db/db2.sqlite" }
 })
@@ -100,6 +100,12 @@ When we want to do something in the slave database with all ActiveRecord models,
 ```ruby
 class ActiveRecord::Base
   def self.connection
+    # Some rake tasks like `rake db:create` does not load initializers,
+    # and because we're overriding ActiveRecord::Base.connection,
+    # we need to make sure Octoshark is configured before using it.
+    Octoshark.configure(configs) unless Octoshark.configured?
+
+    # Return the current connection (from with_connection block) or default one
     Octoshark.current_or_default_connection
   end
 end

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gemfiles/rails3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/lib/octoshark.rb

@@ -17,13 +17,13 @@ module Octoshark
       :connection_pools, :find_connection_pool,
       :disconnect!, to: :switcher
 
-    def setup(configs)
+    def configure(configs)
       @configs = configs
       @switcher = ConnectionSwitcher.new(configs)
     end
 
     def reset!
-      return unless enabled?
+      return unless configured?
       disconnect!
       @confings = nil
       @switcher = nil
@@ -36,7 +36,7 @@ module Octoshark
       @switcher = ConnectionSwitcher.new(@configs)
     end
 
-    def enabled?
+    def configured?
       !@switcher.nil?
     end
 
@@ -46,7 +46,7 @@ module Octoshark
 
     private
     def raise_not_configured_error
-      raise NotConfiguredError, "Octoshark is not setup"
+      raise NotConfiguredError, "Octoshark is not configured, use Octoshark.configure"
     end
   end
 end

data/lib/octoshark/active_record_extensions.rb

@@ -11,7 +11,7 @@ module Octoshark
     module ClassMethods
       def establish_connection_with_octoshark(*args)
         establish_connection_without_octoshark(*args)
-        Octoshark.reload! if Octoshark.enabled?
+        Octoshark.reload! if Octoshark.configured?
       end
     end
   end

data/lib/octoshark/connection_switcher.rb

@@ -8,15 +8,13 @@ module Octoshark
       @connection_pools = { default: @default_pool }.with_indifferent_access
 
       configs.each_pair do |name, config|
-        spec = ActiveRecord::ConnectionAdapters::ConnectionSpecification.new(
-          config, "#{config[:adapter]}_connection"
-        )
+        spec = spec_class.new(config, "#{config[:adapter]}_connection")
         @connection_pools[name] = ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
       end
     end
 
     def current_connection
-      Thread.current[OCTOSHARK] || raise(NoCurrentConnectionError, "No current connection")
+      Thread.current[OCTOSHARK] || raise(NoCurrentConnectionError, "No current connection, use Octoshark.with_connection")
     end
 
     def current_or_default_connection
@@ -39,7 +37,7 @@ module Octoshark
       result
     end
 
-    def find_connection_pool(name, &block)
+    def find_connection_pool(name)
       @connection_pools[name] || raise(NoConnectionError, "No such database connection '#{name}'")
     end
 
@@ -48,5 +46,14 @@ module Octoshark
         connection_pool.disconnect!
       end
     end
+
+    private
+    def spec_class
+      if defined?(ActiveRecord::ConnectionAdapters::ConnectionSpecification)
+        spec_class = ActiveRecord::ConnectionAdapters::ConnectionSpecification
+      else
+        spec_class = ActiveRecord::Base::ConnectionSpecification
+      end
+    end
   end
 end

data/lib/octoshark/version.rb

@@ -1,3 +1,3 @@
 module Octoshark
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/octoshark.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec",    "~> 3.0.0"
   spec.add_development_dependency "sqlite3",  "~> 1.3.0"
+  spec.add_development_dependency "appraisal"
 end

data/spec/octoshark/active_record_extensions_spec.rb

@@ -2,16 +2,12 @@ require 'spec_helper'
 
 describe Octoshark::ActiveRecordExtensions do
 
-  it "reloads Octoshark when re-establishing new connection" do
-    Octoshark.setup(configs)
-    spec = ActiveRecord::Base.remove_connection
-
-    expect { Octoshark.with_connection(:default) {} }.to raise_error(ActiveRecord::ConnectionNotEstablished)
-    expect { Octoshark.with_connection(:db1) {} }.not_to raise_error
+  it "reloads Octoshark connection pools when establishing a new connection" do
+    Octoshark.configure(configs)
 
+    spec = ActiveRecord::Base.remove_connection
     ActiveRecord::Base.establish_connection(spec)
 
-    expect { Octoshark.with_connection(:default) {} }.not_to raise_error
-    expect { Octoshark.with_connection(:db1) {} }.not_to raise_error
+    expect(ActiveRecord::Base.connection_pool).to eq(Octoshark.find_connection_pool(:default))
   end
 end

data/spec/octoshark_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe Octoshark do
 
-  describe ".setup" do
+  describe ".configure" do
     it "creates connection switcher" do
-      Octoshark.setup({})
+      Octoshark.configure({})
 
       expect(Octoshark.switcher).to_not be_nil
     end
@@ -12,14 +12,14 @@ describe Octoshark do
 
   describe ".reset!" do
     it "removes connection switcher" do
-      Octoshark.setup({})
+      Octoshark.configure({})
       Octoshark.reset!
 
       expect { Octoshark.switcher }.to raise_error(Octoshark::NotConfiguredError)
     end
 
     it "cleans octoshark thread key" do
-      Octoshark.setup({})
+      Octoshark.configure({})
       Octoshark.reset!
 
       expect(Thread.current[Octoshark::OCTOSHARK]).to be_nil
@@ -32,7 +32,7 @@ describe Octoshark do
 
   describe ".reload!" do
     it "replaces connection switcher" do
-      Octoshark.setup({})
+      Octoshark.configure({})
       switcher = Octoshark.switcher
 
       Octoshark.reload!
@@ -46,26 +46,26 @@ describe Octoshark do
     end
   end
 
-  describe ".enabled?" do
-    it "is not enabled by default" do
-      expect(Octoshark.enabled?).to be_falsey
+  describe ".configured?" do
+    it "is not configured by default" do
+      expect(Octoshark.configured?).to be_falsey
     end
 
-    it "is enabled when it's setup" do
-      Octoshark.setup({})
+    it "is configured is switcher is configured" do
+      Octoshark.configure({})
 
-      expect(Octoshark.enabled?).to be_truthy
+      expect(Octoshark.configured?).to be_truthy
     end
   end
 
   describe ".switcher" do
     it "returns connection switcher" do
-      Octoshark.setup({})
+      Octoshark.configure({})
 
       expect(Octoshark.switcher).to be_an_instance_of(Octoshark::ConnectionSwitcher)
     end
 
-    it "raises 'NotConfiguredError' error if not setup" do
+    it "raises 'NotConfiguredError' error if not configured" do
       expect { Octoshark.switcher }.to raise_error(Octoshark::NotConfiguredError)
     end
   end
@@ -77,7 +77,7 @@ describe Octoshark do
   ].each do |method_name|
     describe ".#{method_name}" do
       it "delegates #{method_name} to connection switcher" do
-        Octoshark.setup({})
+        Octoshark.configure({})
         expect(Octoshark.switcher).to receive(method_name)
 
         Octoshark.send(method_name)

data/spec/spec_helper.rb

@@ -1,16 +1,26 @@
 require 'octoshark'
+require 'fileutils'
 
+ROOT = File.expand_path('../', File.dirname(__FILE__))
+TMP  = 'tmp'
 
 # Load support files
-ROOT = File.expand_path('../', File.dirname(__FILE__))
 Dir["#{ROOT}/spec/support/**/*.rb"].each { |f| require f }
 
 
 RSpec.configure do |config|
   config.include Helpers
 
+  config.before :suite do
+    FileUtils.mkdir_p(TMP)
+  end
+
   config.before :each do
     ActiveRecord::Base.establish_connection({adapter: 'sqlite3', database: 'tmp/default.sqlite'})
     Octoshark.reset!
   end
+
+  config.after :suite do
+    FileUtils.rm_rf(TMP)
+  end
 end

data/spec/support/helpers.rb

@@ -15,7 +15,7 @@ module Helpers
   end
 
   def check_connections_clean_up
-    Octoshark.setup({})
+    Octoshark.configure({})
     switcher = Octoshark.switcher
 
     Octoshark.with_connection(:default) { |connection| connection.execute("SELECT 1") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octoshark
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dalibor Nasevic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
 description: Octoshark is a library for switching between multiple ActiveRecord connections
 email:
 - dalibor.nasevic@gmail.com
@@ -90,10 +104,13 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails3.gemfile
+- gemfiles/rails4.gemfile
 - lib/octoshark.rb
 - lib/octoshark/active_record_extensions.rb
 - lib/octoshark/connection_switcher.rb