amqp-boilerplate 1.1.2 → 1.1.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+= version 1.1.3
+
+  * [ENHANCEMENT] Turned consumer prefetch into a global option (rverts change
+	in 1.1.2)
+
 = version 1.1.2
 
   * [FEATURE] Added amqp_channel options macro (consumer)

data/README.rdoc

@@ -24,6 +24,7 @@ Add a initializer +amqp.rb+ to your config/initializer folder with the following
     config.on_unhandled_exception = Proc.new { |exception, consumer, metadata, payload|
       puts "Do something with exceptions: #{exception}"
     }
+    config.consumer_prefetch = 10
   end
 
   # Require all files that are no longer auto-loaded when Rails is in thread-safe mode

data/lib/amqp/boilerplate/consumer.rb

@@ -6,7 +6,6 @@ module AMQP
     # You should call the macro {.amqp_queue} method and implement {#handle_message}.
     #
     # To specify subscription options you can call the optional macro {.amqp_subscription} method.
-    # To specify channel options you can call the optional macro {.amqp_channel} method.
     #
     # @example Basic consumer
     #   class MyConsumer < AMQP::Boilerplate::Consumer
@@ -17,11 +16,10 @@ module AMQP
     #     end
     #   end
     #
-    # @example Configuring subscription and channel
+    # @example Configuring subscription
     #   class MyConsumer < AMQP::Boilerplate::Consumer
     #     amqp_queue "queue.name.here", :durable => true
     #     amqp_subscription :ack => true
-    #     amqp_channel :prefetch => 1
     #
     #     def handle_message(payload, metadata)
     #       puts "Received message: #{payload}"
@@ -57,20 +55,11 @@ module AMQP
           @subscription_options = options
         end
 
-        # Macro that allows you to specify AMQP channel options
-        #
-        # @params [Hash] options Options that will be passed as options to {http://rubydoc.info/github/ruby-amqp/amqp/master/AMQP/Channel AMQP::Channel}
-        def amqp_channel(options={})
-          @channel_options = options
-        end
-
         def start
           consumer = new
 
           channel = AMQP.channel
           channel.on_error(&consumer.method(:handle_channel_error))
-          @channel_options ||= {}
-          channel.prefetch(@channel_options[:prefetch]) if @channel_options[:prefetch]
 
           queue = channel.queue(@queue_name, @queue_options)
           # Binding a queue to a exchange by passing a string (instead of a AMQP::Exchange instance)

data/lib/amqp/boilerplate/consumer_prefetch.rb

@@ -0,0 +1,14 @@
+module AMQP
+  module Boilerplate
+    module ConsumerPrefetch
+      attr_writer :consumer_prefetch
+
+      # Wether or not to force loading consumers even if the server_type is not Passenger
+      #
+      # @see AMQP::Boilerplate.configure
+      def consumer_prefetch
+        @consumer_prefetch ||= 0
+      end
+    end
+  end
+end

data/lib/amqp/boilerplate/version.rb

@@ -1,5 +1,5 @@
 module AMQP
   module Boilerplate
-    VERSION = "1.1.2"
+    VERSION = "1.1.3"
   end
 end

data/lib/amqp/boilerplate.rb

@@ -4,6 +4,7 @@ require 'amqp/utilities/event_loop_helper'
 require 'amqp/boilerplate/version'
 
 require 'amqp/boilerplate/consumer'
+require 'amqp/boilerplate/consumer_prefetch'
 require 'amqp/boilerplate/consumer_registry'
 require 'amqp/boilerplate/force_consumers'
 require 'amqp/boilerplate/logging'
@@ -14,6 +15,7 @@ module AMQP
     extend ConsumerRegistry
     extend Logging
     extend ForceConsumers
+    extend ConsumerPrefetch
 
     # Opens a channel to AMQP and starts all consumers
     #
@@ -42,7 +44,7 @@ module AMQP
       AMQP::Boilerplate.logger.info("[#{self.name}.boot] Started AMQP (Server Type: #{AMQP::Utilities::EventLoopHelper.server_type || 'unknown'})")
 
       EventMachine.next_tick do
-        AMQP.channel ||= AMQP::Channel.new(AMQP.connection)
+        AMQP.channel ||= AMQP::Channel.new(AMQP.connection, AMQP::Channel.next_channel_id, :prefetch => consumer_prefetch)
 
         load_consumers
 

data/spec/amqp/boilerplate/consumer_prefetch_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe AMQP::Boilerplate::ConsumerPrefetch do
+  before(:each) do
+    AMQP::Boilerplate.stub(:logger).and_return(mock.as_null_object)
+    @channel = mock(AMQP::Channel)
+    @channel.stub(:on_error).and_return(true)
+  end
+
+  describe "#consumer_prefetch" do
+    before(:each) do
+      @channel_close = mock(:reply_code => "OK", :reply_text => "Something")
+    end
+
+    it "should be 0 by default" do
+      AMQP::Boilerplate.consumer_prefetch.should == 0
+    end
+  end
+end

data/spec/amqp/boilerplate/consumer_spec.rb

@@ -6,7 +6,6 @@ describe AMQP::Boilerplate::Consumer do
     AMQP::Boilerplate.stub(:logger).and_return(mock.as_null_object)
     @channel = mock(AMQP::Channel)
     @channel.stub(:on_error).and_return(true)
-    @channel.stub(:prefetch).and_return(@channel)
   end
 
   describe "#handle_channel_error" do
@@ -67,12 +66,6 @@ describe AMQP::Boilerplate::Consumer do
       BarConsumer.start
     end
 
-    it "should pass on the prefetch channel parameter" do
-      @channel.should_receive(:prefetch).with(1).and_return(@channel)
-      BarConsumer.start
-    end
-
-
     it "should instantiate a consumer" do
       BarConsumer.should_receive(:new).and_return(@consumer)
       BarConsumer.start

data/spec/amqp/boilerplate_spec.rb

@@ -133,6 +133,12 @@ describe AMQP::Boilerplate do
       AMQP::Boilerplate.connection_options.should == connection_options
     end
 
+    it "should allow us to set a prefetch value" do
+      prefetch = 10
+      AMQP::Boilerplate.configure { |config| config.consumer_prefetch = prefetch }
+      AMQP::Boilerplate.consumer_prefetch.should == prefetch
+    end
+
     it "should let us set a handler for uncaught exceptions" do
       on_unhandled_consumer_exception = Proc.new {}
       AMQP::Boilerplate.configure { |config| config.on_unhandled_consumer_exception = on_unhandled_consumer_exception }

data/spec/spec_helper.rb

@@ -14,7 +14,6 @@ end
 class BarConsumer < AMQP::Boilerplate::Consumer
   amqp_queue "queue.name.here", :durable => true
   amqp_subscription :ack => true
-  amqp_channel :prefetch => 1
 end
 
 # "Test" producers

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amqp-boilerplate
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 1
-  - 2
-  version: 1.1.2
+  - 3
+  version: 1.1.3
 platform: ruby
 authors: 
 - Patrick Baselier
@@ -101,11 +101,13 @@ files:
 - lib/amqp-boilerplate.rb
 - lib/amqp/boilerplate.rb
 - lib/amqp/boilerplate/consumer.rb
+- lib/amqp/boilerplate/consumer_prefetch.rb
 - lib/amqp/boilerplate/consumer_registry.rb
 - lib/amqp/boilerplate/force_consumers.rb
 - lib/amqp/boilerplate/logging.rb
 - lib/amqp/boilerplate/producer.rb
 - lib/amqp/boilerplate/version.rb
+- spec/amqp/boilerplate/consumer_prefetch_spec.rb
 - spec/amqp/boilerplate/consumer_registry_spec.rb
 - spec/amqp/boilerplate/consumer_spec.rb
 - spec/amqp/boilerplate/force_consumers_spec.rb
@@ -149,6 +151,7 @@ signing_key:
 specification_version: 3
 summary: Helper modules for quickly setting up AMQP producers/consumers
 test_files: 
+- spec/amqp/boilerplate/consumer_prefetch_spec.rb
 - spec/amqp/boilerplate/consumer_registry_spec.rb
 - spec/amqp/boilerplate/consumer_spec.rb
 - spec/amqp/boilerplate/force_consumers_spec.rb