cottontail 2.0.0.pre.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fffe7fed426e7be9c4107730b1ca60cf85d6e976
-  data.tar.gz: 93d238e96dafe0b22e3497e41ac9f8041a3b7401
+  metadata.gz: d9bee2a9a93ed919f90a527fc37c7ff1ac07077c
+  data.tar.gz: 8220742b6ca0c05d36aaaf54bc90befd6aba9992
 SHA512:
-  metadata.gz: 6cf61ebc80120a7a4351a11c2a86b541c38bb9c93b0af68d84cfcb184c069b2eb00e2fc9e711e9ff8014736ee15da54a7c3c83a9f490de36ce4e7cb546d9c5f5
-  data.tar.gz: 62be0c8eac7b7abc0ac355c8c8e1a2bedd9f3817810b9bb349783ae2c2b58ec56062a10d5b3a283513cf757ff556f4adc1021cd8052fae2e16c3f4a1f684e2ea
+  metadata.gz: 3ceaaa8c4383d3e0249aefe4e9f870debdb9dd8b367b7988fca7398af4e70683c59b083d0de2a55f13a8bcc712b8a1dc4fa0fe1b68a49914f2c477e3e1cd20d3
+  data.tar.gz: 8fac03100e7b0eb3bbe3905dfcd7dda8001623b4c1df38aea096e4653fb21290ab648c7ecf67483d2b8849e0ff4b7886bd4156d9b0375a273c4a8482672d34ae

data/.gitignore

@@ -1,3 +1,4 @@
+/.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -7,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.byebug_history

data/.travis.yml

@@ -13,3 +13,7 @@ services:
 notifications:
   on_success: change
   on_failure: change
+
+addons:
+  code_climate:
+    repo_token: 6eeabdfc385d32e919fca3b405ca275387c530d13e2f29eb0e4eecb6c8fc514f

data/Gemfile

@@ -10,6 +10,5 @@ group :development, :test do
   gem 'rspec-core', '~> 3'
   gem 'rspec-expectations', '~> 3'
 
-  gem 'simplecov', require: false, platform: :ruby_21
-  gem 'coveralls', require: false, platform: :ruby_21
+  gem 'coveralls', require: false
 end

data/README.md

@@ -31,7 +31,7 @@ require 'cottontail'
 class Worker
   include Cottontail::Consumer
 
-  session ENV['RABBITMQ_URL'] do |session, worker|
+  session ENV['RABBITMQ_URL'] do |worker, session|
     channel = session.create_channel
 
     queue = channel.queue('', durable: true)

data/cottontail.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "bunny", "~> 2"
-  s.add_runtime_dependency "yell", ">= 2", "<= 3"
-  s.add_runtime_dependency "activesupport", ">= 3", "<= 4"
+  s.add_runtime_dependency "yell", ">= 2", "< 3"
+  s.add_runtime_dependency "activesupport", ">= 3", "< 5"
 end

data/lib/cottontail/configurable.rb

@@ -15,8 +15,7 @@ module Cottontail #:nodoc:
           if respond_to?(:superclass) && superclass.respond_to?(:config)
             superclass.config.inheritable_copy
           else
-            # create a new "anonymous" class that will host the compiled
-            # reader methods
+            # create a new "anonymous" class
             Class.new(Configuration).new
           end
       end
@@ -33,8 +32,12 @@ module Cottontail #:nodoc:
     private
 
     class Configuration #:nodoc:
-      def initialize
+      def initialize(parent = nil)
         reset!
+
+        if parent.kind_of?(Cottontail::Configuration)
+          parent.each { |k, v| set(k, v) }
+        end
       end
 
       # Set a configuration option.
@@ -43,7 +46,7 @@ module Cottontail #:nodoc:
       #   set :logger, Yell.new($stdout)
       #   set :logger, -> { Yell.new($stdout) }
       def set(key, value = nil, &block)
-        @settings[key] = !block.nil? ? block : value
+        @settings[key] = block.nil? ? value : block
       end
 
       # Get a configuration option. It will be evalued of the first time
@@ -59,6 +62,16 @@ module Cottontail #:nodoc:
         @settings[key]
       end
 
+      # @private
+      def each(&block)
+        @settings.each(&block)
+      end
+
+      # @private
+      def inheritable_copy
+        self.class.new(self)
+      end
+
       # @private
       def reset!
         @settings = {}

data/lib/cottontail/consumer.rb

@@ -1,4 +1,6 @@
 require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/callbacks'
 
 require File.dirname(__FILE__) + '/configurable'
 require File.dirname(__FILE__) + '/consumer/launcher'
@@ -57,12 +59,19 @@ module Cottontail
     extend ActiveSupport::Concern
 
     included do
+      include ActiveSupport::Callbacks
+      define_callbacks :initialize
+      define_callbacks :consume
+
       include Cottontail::Configurable
 
-      # default settings
-      set :consumables, -> { Cottontail::Consumer::Collection.new }
-      set :session, -> { [nil, -> {}] }
-      set :logger, -> { Cottontail.get(:logger) }
+      # default config
+      set :consumables, Cottontail::Consumer::Collection.new
+      set :session, [nil, -> {}]
+      set :logger, Cottontail.get(:logger)
+
+      # config for consumer behaviour
+      set :raise_on_exception, true
     end
 
     module ClassMethods #:nodoc:
@@ -133,7 +142,6 @@ module Cottontail
       #   consume type: ['ChatMessage', 'PushMessage'] do |delivery_info, properties, payload|
       #     # stuff to do
       #   end
-      #
       def consume(route = {}, options = {}, &block)
         options =
           if route.is_a?(Hash)
@@ -162,9 +170,17 @@ module Cottontail
       end
     end
 
-    def initialize
-      @__launcher__ = Cottontail::Consumer::Launcher.new(self)
-      @__session__ = Cottontail::Consumer::Session.new(self)
+    attr_accessor :options
+
+    def initialize(options = {})
+      @options = options
+
+      run_callbacks :initialize do
+        @__running__ = false
+
+        @__launcher__ = Cottontail::Consumer::Launcher.new(self)
+        @__session__ = Cottontail::Consumer::Session.new(self)
+      end
 
       logger.debug '[Cottontail] initialized'
     end
@@ -173,14 +189,22 @@ module Cottontail
       logger.info '[Cottontail] starting up'
 
       @__session__.start
+      @__running__ = true
       @__launcher__.start if blocking
     end
 
     def stop
+      return unless running?
+
       logger.info '[Cottontail] shutting down'
 
-      # @__launcher__.stop
+      @__launcher__.stop
       @__session__.stop
+      @__running__ = false
+    end
+
+    def running?
+      @__running__
     end
 
     # @private
@@ -190,26 +214,35 @@ module Cottontail
       end
     end
 
+    # @private
+    def logger
+      config.get(:logger)
+    end
+
     private
 
     def consume(delivery_info, properties, payload)
-      consumable = consumables.find(delivery_info, properties, payload)
-
-      if consumable.nil?
-        logger.error '[Cottontail] Could not consume message'
-      else
-        consumable.exec(self, delivery_info, properties, payload)
+      run_callbacks :consume do
+        execute(delivery_info, properties, payload)
       end
     rescue => exception
       logger.error exception
-    end
 
-    def consumables
-      config.get(:consumables)
+      if config.get(:raise_on_exception)
+        stop
+
+        raise(exception, caller)
+      end
     end
 
-    def logger
-      config.get(:logger)
+    def execute(delivery_info, properties, payload)
+      entity = config.get(:consumables).find(delivery_info, properties, payload)
+
+      if entity.nil?
+        logger.warn '[Cottontail] Could not consume message'
+      else
+        entity.exec(self, delivery_info, properties, payload)
+      end
     end
   end
 end

data/lib/cottontail/consumer/launcher.rb

@@ -14,7 +14,7 @@ module Cottontail #:nodoc:
         stop unless @launcher.nil?
 
         SIGNALS.each do |signal|
-          Signal.trap(signal) { Thread.new { stop } }
+          Signal.trap(signal) { Thread.new { @consumer.stop } }
         end
 
         @launcher = Thread.new { sleep }
@@ -22,8 +22,6 @@ module Cottontail #:nodoc:
       end
 
       def stop
-        @consumer.stop if @consumer.respond_to?(:stop)
-
         @launcher.kill if @launcher.respond_to?(:kill)
         @launcher = nil
       end

data/lib/cottontail/version.rb

@@ -1,3 +1,3 @@
 module Cottontail #:nodoc:
-  VERSION = '2.0.0.pre.1'
+  VERSION = '2.0.0'
 end

data/spec/cottontail/configurable_inheritance_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe 'Cottontail::Configurable inheritance' do
+  let(:base_klass) do
+    Class.new do
+      include Cottontail::Configurable
+
+      set :foo, 123
+    end
+  end
+
+  let(:child_klass) do
+    Class.new(base_klass)
+  end
+
+  let(:base_config) { base_klass.config }
+  let(:child_config) { child_klass.config }
+
+  it 'inherits configuration' do
+    expect(base_config.get(:foo)).to eq(123)
+    expect(child_config.get(:foo)).to eq(123)
+  end
+
+  it 'does not override configuration of superclass' do
+    child_config.set(:foo, 456)
+
+    expect(child_config.get(:foo)).to eq(456)
+    expect(base_config.get(:foo)).to eq(123)
+  end
+end

data/spec/cottontail/configurable_spec.rb

@@ -1,12 +1,13 @@
 require 'spec_helper'
 
-RSpec.describe Cottontail::Configurable do
-  class ConfigurationFactory #:nodoc:
-    include Cottontail::Configurable
+RSpec.describe 'Cottontail::Configurable' do
+  let(:base_klass) do
+    Class.new do
+      include Cottontail::Configurable
+    end
   end
 
-  let(:config) { ConfigurationFactory.config }
-  before { config.reset! }
+  let(:config) { base_klass.config }
 
   it 'responds to :get' do
     expect(config).to respond_to(:get)
@@ -16,7 +17,7 @@ RSpec.describe Cottontail::Configurable do
     expect(config).to respond_to(:set)
   end
 
-  context 'String' do
+  context ':set with String' do
     let(:value) { 'value' }
     before { config.set(:key, value) }
 
@@ -25,7 +26,7 @@ RSpec.describe Cottontail::Configurable do
     end
   end
 
-  context 'Proc' do
+  context ':set with Proc' do
     let(:value) { -> { 'value' } }
     before { config.set(:key, value) }
 

data/spec/cottontail/consumer/collection_spec.rb

@@ -64,7 +64,25 @@ RSpec.describe Cottontail::Consumer::Collection do
       expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to eq(ann)
       expect(collection.find(delivery_info_stub('x', 'a', 'x'))).to eq(nan)
       expect(collection.find(delivery_info_stub('x', 'x', 'a'))).to eq(nna)
-      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to eq(nil)
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to be_nil
+    end
+  end
+
+  context 'find for multiple entities with the same signature' do
+    let!(:ann_1) { push_entity('a', nil, nil) }
+    let!(:ann_2) { push_entity('a', nil, nil) }
+    let!(:nan_1) { push_entity(nil, 'a', nil) }
+    let!(:nan_2) { push_entity(nil, 'a', nil) }
+    let!(:nna_1) { push_entity(nil, nil, 'a') }
+    let!(:nna_2) { push_entity(nil, nil, 'a') }
+    let!(:nnn_1) { push_entity(nil, nil, nil) }
+    let!(:nnn_2) { push_entity(nil, nil, nil) }
+
+    it 'returns the last added entity for :exchange, :queue, :route' do
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to eq(ann_2)
+      expect(collection.find(delivery_info_stub('x', 'a', 'x'))).to eq(nan_2)
+      expect(collection.find(delivery_info_stub('x', 'x', 'a'))).to eq(nna_2)
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to eq(nnn_2)
     end
   end
 

data/spec/integration/consumer_simple_spec.rb

@@ -3,30 +3,40 @@ require 'spec_helper'
 RSpec.describe 'A Cottontail::Consumer instance' do
   pending 'RabbitMQ not running' unless rabbitmq_running?
 
-  let(:rand) { SecureRandom.uuid }
-  let(:topic) { "cottontail-test-#{rand}" }
-  let(:queue) { "cottontail-test-#{rand}" }
-  let(:payload) { 'hello world' }
-
-  let :consumer do
-    CottontailTestConsumer.new(topic, queue)
+  let(:payload) { SecureRandom.uuid }
+  let(:queue_name) { "cottontail-#{SecureRandom.uuid}" }
+
+  let(:consumer_class) do
+    Class.new(Cottontail::Test::Consumer) do
+      session do |worker, session|
+        channel = session.create_channel
+        queue = channel.queue(
+          options[:queue_name],
+          auto_delete: true,
+          durable: false
+        )
+
+        subscribe(queue, exclusive: false)
+      end
+    end
   end
-  let(:consumable) { consumer.consumable }
+
+  let(:consumer) { consumer_class.new(queue_name: queue_name) }
 
   let :publisher do
     session = Bunny.new
     session.start
+
     session
   end
 
   before do
-    # start consumer
     consumer.start(false)
 
     # publish message
     channel = publisher.create_channel
-    channel.topic(topic)
-      .publish(payload, routing_key: 'cottontail-spec')
+    exchange = channel.default_exchange
+    exchange.publish(payload, routing_key: queue_name)
   end
 
   after do
@@ -35,7 +45,10 @@ RSpec.describe 'A Cottontail::Consumer instance' do
   end
 
   it 'consumes the message' do
-    5.times { sleep 0.1 if consumable.payload.nil? }
-    expect(consumable.payload).to eq(payload)
+    # wait for received message
+    10.times { sleep 0.02 if consumer.running? }
+
+    message = consumer.messages.last
+    expect(message[:payload]).to eq(payload)
   end
 end

data/spec/performance/consumer_simple_spec.rb

@@ -0,0 +1,57 @@
+require 'benchmark'
+require 'spec_helper'
+
+RSpec.describe 'A Cottontail::Consumer instance', :performance do
+  pending 'RabbitMQ not running' unless rabbitmq_running?
+
+  let(:payload) { SecureRandom.uuid }
+  let(:max_messages) { 10_000 }
+  let(:queue_name) { "cottontail-#{SecureRandom.uuid}" }
+
+  let(:consumer_class) do
+    Class.new(Cottontail::Test::Consumer) do
+      session do |worker, session|
+        channel = session.create_channel
+        queue = channel.queue(
+          options[:queue_name],
+          auto_delete: true,
+          durable: false
+        )
+
+        subscribe(queue, exclusive: false)
+      end
+    end
+  end
+
+  let :consumer do
+    consumer_class.new(
+      queue_name: queue_name,
+      max_messages: max_messages
+    )
+  end
+
+  let :publisher do
+    session = Bunny.new
+    session.start
+
+    session
+  end
+
+  before do
+    # publish messages
+    channel = publisher.create_channel
+    channel.queue(queue_name, auto_delete: true, durable: false) # create queue
+
+    exchange = channel.default_exchange
+    max_messages.times { exchange.publish(payload, routing_key: queue_name) }
+  end
+
+  after do
+    publisher.stop
+  end
+
+  it 'consumes the message' do
+    seconds = Benchmark.realtime { consumer.start }
+    expect(seconds).to be < 2 # seconds
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,30 @@
 $LOAD_PATH.unshift File.expand_path('..', __FILE__)
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'cottontail'
-
 require 'json'
 require 'byebug'
 require 'securerandom'
 require 'rspec/core'
 require 'rspec/expectations'
 
+begin
+  require 'coveralls'
+  # Coveralls.wear!
+
+  require 'simplecov'
+  SimpleCov.start do
+    formatter = SimpleCov::Formatter::MultiFormatter[
+      Coveralls::SimpleCov::Formatter,
+      SimpleCov::Formatter::HTMLFormatter
+    ]
+    add_filter 'spec'
+  end
+rescue LoadError
+  $stderr.puts 'Not running coverage'
+end
+
+require 'cottontail'
+
 Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|

data/spec/support/test_consumer.rb

@@ -1,32 +1,33 @@
-class CottontailTestConsumer
-  include Cottontail::Consumer
-
-  set :logger, -> { Yell.new(:null) } # no logging
-  attr_accessor :consumable
-
-  def initialize(topic = 'cottontail-test-topic', queue = 'cottontail-test-queue')
-    super()
-
-    @consumable = OpenStruct.new
-    @topic = topic
-    @queue = queue
-  end
-
-  session do |worker, session|
-    channel = session.create_channel
-
-    exchange = channel.topic(@topic)
-    queue = channel.queue(@queue, :auto_delete => true, :durable => false)
-            .bind(exchange, routing_key: '#')
-
-    worker.subscribe(queue, exclusive: true)
-  end
-
-  consume do |delivery_info, properties, payload|
-    consumable.delivery_info = delivery_info
-    consumable.properties = properties
-    consumable.payload = payload
+module Cottontail #:nodoc
+  module Test #:nodoc
+    class Consumer #:nodoc:
+      include Cottontail::Consumer
+      set :logger, -> { Yell.new(:null) }
+
+      set_callback :initialize, :after do
+        @max_messages = options[:max_messages] || 1
+      end
+
+      set_callback :consume, :after do
+        stop if stop?
+      end
+
+      consume do |delivery_info, properties, payload|
+        messages << {
+          consumable: :default,
+          delivery_info: delivery_info,
+          properties: properties,
+          payload: payload
+        }
+      end
+
+      def messages
+        @messages ||= []
+      end
+
+      def stop?
+        messages.count >= @max_messages
+      end
+    end
   end
 end
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cottontail
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
@@ -41,7 +41,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
@@ -51,9 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -61,9 +61,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 description: Convenience wrapper around the AMQP Bunny gem to better handle routing_key
   specific messages
 email: 
@@ -87,12 +87,13 @@ files:
 - lib/cottontail/consumer/launcher.rb
 - lib/cottontail/consumer/session.rb
 - lib/cottontail/version.rb
+- spec/cottontail/configurable_inheritance_spec.rb
 - spec/cottontail/configurable_spec.rb
 - spec/cottontail/consumer/collection_spec.rb
 - spec/cottontail/consumer/entity_spec.rb
 - spec/integration/consumer_simple_spec.rb
+- spec/performance/consumer_simple_spec.rb
 - spec/spec_helper.rb
-- spec/support/coverage.rb
 - spec/support/rabbitmq.rb
 - spec/support/test_consumer.rb
 homepage: http://github.com/rudionrails/cottontail
@@ -110,22 +111,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: cottontail
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sinatra inspired wrapper around the AMQP Bunny gem
 test_files:
+- spec/cottontail/configurable_inheritance_spec.rb
 - spec/cottontail/configurable_spec.rb
 - spec/cottontail/consumer/collection_spec.rb
 - spec/cottontail/consumer/entity_spec.rb
 - spec/integration/consumer_simple_spec.rb
+- spec/performance/consumer_simple_spec.rb
 - spec/spec_helper.rb
-- spec/support/coverage.rb
 - spec/support/rabbitmq.rb
 - spec/support/test_consumer.rb
-has_rdoc: 

data/spec/support/coverage.rb

@@ -1,16 +0,0 @@
-begin
-  require 'coveralls'
-  require 'simplecov'
-
-  $stdout.puts 'Running coverage...'
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    add_filter 'spec'
-  end
-rescue LoadError
-  $stderr.puts 'Not running coverage'
-end