Merge pull request #15 from ninech/providing_existing_connection_through_config

Sane way of providing an existing connection

Author: cimnine

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cony (2.0.1)
+    cony (2.1.0)
       activesupport (>= 3)
       bunny (~> 2.3)
 

README.md

@@ -18,30 +18,20 @@ To configure the AMQP-Settings, use an initializer (e.g.
 
 ```ruby
 Cony.configure do |config|
+  config.test_mode = Rails.env.test?
+  # config.durable = false
   config.amqp = {
     host: 'localhost',
     exchange: 'organization.application',
     ssl: true,
     user: 'username',
     pass: 'secret',
   }
-  config.test_mode = Rails.env.test?
-  # config.durable = false
+  # or:
+  # config.amqp_connection = my_existing_bunny_session
 end
 ```
 
-### Using an existing Bunny connection
-
-You can share your already established `Bunny::Session` with Cony.
-
-```ruby
-Cony::AMQPConnection.instance.connection = your_connection
-```
-
-Cony will only accept the given connection if it's current connection is closed or if there is no current
-connection. There will be an error if Cony already has a connection!
-This restriction is imposed because else Cony might leak connections.
-
 ## Getting Started
 
 To enable the notifications for a model, you just need to include the

lib/cony.rb

@@ -13,15 +13,17 @@
 # To configure Cony:
 # <code>
 # Cony.configure do |config|
+#   config.test_mode = Rails.env.test?
+#   # config.durable = false
 #   config.amqp = {
 #     host: 'localhost',
 #     exchange: 'organization.application',
 #     ssl: true,
 #     user: 'username',
 #     pass: 'secret',
 #   }
-#   config.test_mode = Rails.env.test?
-#   # config.durable = false
+#   # or:
+#   # config.amqp_connection = my_existing_bunny_session
 # end
 # </code>
 module Cony

lib/cony/amqp_connection.rb

@@ -32,6 +32,7 @@ def publish(message, routing_key)
 
     ##
     # Sets a custom connection if no valid_connection? is already provided
+    # :deprecated: Use the Cony Initializer
     def connection=(connection)
       fail Cony::ValidConnectionAlreadyDefined, 'A connection has already been set.' if valid_connection_present?
       @connection = connection
@@ -42,7 +43,9 @@ def connection=(connection)
     def connection
       return @connection if valid_connection_present?
 
-      @connection = Bunny.new Cony.config.amqp
+      return @connection = Cony.config.amqp_connection unless Cony.config.amqp_connection.nil?
+
+      @connection = Bunny.new(Cony.config.amqp)
       ObjectSpace.define_finalizer(self, proc { cleanup })
       @connection.start
     end

spec/cony/amqp_connection_spec.rb

@@ -6,7 +6,7 @@
 
 describe Cony::AMQPConnection do
   let(:amqp_config) { { exchange: 'bunny-tests' } }
-  let(:config) { double('Cony Config', amqp: amqp_config, durable: false) }
+  let(:config) { double('Cony Config', amqp: amqp_config, durable: false, amqp_connection: nil) }
   let(:handler) { Cony::AMQPConnection }
   let(:message) { 'Bunnies are connies' }
   let(:routing_key) { 'bunny.info' }
@@ -93,16 +93,44 @@
   describe 'setting a connection' do
     let(:existing_connection) { connection_double.clone }
 
-    it 'sets the connection to the given one' do
-      subject.instance.connection = existing_connection
+    describe 'on the AmqpConnection (deprecated)' do
+      it 'sets the connection to the given one' do
+        subject.instance.connection = existing_connection
 
-      expect(subject.instance.connection).to be(existing_connection)
+        expect(subject.instance.connection).to be(existing_connection)
+      end
+
+      it 'raises exception when redefining the connection' do
+        expect(subject.instance.connection).to be(connection_double)
+        expect { subject.instance.connection = existing_connection }.
+          to raise_error(Cony::ValidConnectionAlreadyDefined)
+      end
     end
 
-    it 'raises exception when redefining the connection' do
-      expect(subject.instance.connection).to be(connection_double)
-      expect { subject.instance.connection = existing_connection }.
-        to raise_error(Cony::ValidConnectionAlreadyDefined)
+    describe 'through the config' do
+      let(:config) do
+        double('Cony Config', amqp: amqp_config, durable: false, amqp_connection: existing_connection)
+      end
+
+      it 'uses the connection from the config' do
+        expect(subject.instance.connection).to be(existing_connection)
+      end
+
+      it 'raises exception when redefining the connection' do
+        expect(subject.instance.connection).to be(existing_connection)
+        expect { subject.instance.connection = existing_connection }.
+          to raise_error(Cony::ValidConnectionAlreadyDefined)
+      end
+
+      describe 'no amqp config hash given' do
+        let(:config) do
+          double('Cony Config', amqp: nil, durable: false, amqp_connection: existing_connection)
+        end
+
+        it 'still uses the connection from the config' do
+          expect(subject.instance.connection).to be(existing_connection)
+        end
+      end
     end
   end
 end