cottontail 0.1.5 → 2.0.0.pre.1

data/spec/cottontail/consumer/collection_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe Cottontail::Consumer::Collection do
+  let(:collection) { described_class.new }
+
+  context 'find for single entity' do
+    it 'returns correctly for :exchange, :queue, :route' do
+      entity = push_entity('a', 'b', 'c')
+
+      expect(collection.find(delivery_info_stub('a', 'b', 'c'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'b', 'x'))).to be_nil
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to be_nil
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to be_nil
+    end
+
+    it 'returns correctly for :exchange, :queue, nil' do
+      entity = push_entity('a', 'b', nil)
+
+      expect(collection.find(delivery_info_stub('a', 'b', 'c'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'b', 'x'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to be_nil
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to be_nil
+    end
+
+    it 'returns correctly for :exchange, nil, nil' do
+      entity = push_entity('a', nil, nil)
+
+      expect(collection.find(delivery_info_stub('a', 'b', 'c'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'b', 'x'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to be_nil
+    end
+
+    it 'returns correctly for nil, nil, nil' do
+      entity = push_entity(nil, nil, nil)
+
+      expect(collection.find(delivery_info_stub('a', 'b', 'c'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'b', 'x'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to eq(entity)
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to eq(entity)
+    end
+  end
+
+  context 'find for multiple entities' do
+    let!(:nnn) { push_entity(nil, nil, nil) }
+    let!(:ann) { push_entity('a', nil, nil) }
+    let!(:abn) { push_entity('a', 'b', nil) }
+    let!(:abc) { push_entity('a', 'b', 'c') }
+
+    it 'returns correctly for :exchange, :queue, :route' do
+      expect(collection.find(delivery_info_stub('a', 'b', 'c'))).to eq(abc)
+      expect(collection.find(delivery_info_stub('a', 'b', 'x'))).to eq(abn)
+      expect(collection.find(delivery_info_stub('a', 'x', 'x'))).to eq(ann)
+      expect(collection.find(delivery_info_stub('x', 'x', 'x'))).to eq(nnn)
+    end
+  end
+
+  context 'find for multiple entities (mixed)' do
+    let!(:ann) { push_entity('a', nil, nil) }
+    let!(:nan) { push_entity(nil, 'a', nil) }
+    let!(:nna) { push_entity(nil, nil, 'a') }
+
+    it 'returns correctly for :exchange, :queue, :route' 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)
+    end
+  end
+
+  private
+
+  def push_entity(exchange = nil, queue = nil, route = nil)
+    entity = Cottontail::Consumer::Entity.new(
+      exchange: exchange,
+      queue: queue,
+      route: route
+    )
+    collection.push(entity)
+    entity
+  end
+
+  def delivery_info_stub(exchange = '', queue = '', route = '')
+    JSON.parse(
+      {
+        exchange: exchange,
+        consumer: {
+          queue: { name: queue }
+        },
+        routing_key: route
+      }.to_json,
+      object_class: OpenStruct
+    )
+  end
+end

data/spec/cottontail/consumer/entity_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+RSpec.shared_examples_for 'a matching property' do
+  it 'returns correctly for String' do
+    entity = described_class.new(subject => 'a')
+
+    expect(entity.matches?(subject, 'a')).to eq(true)
+    expect(entity.matches?(subject, 'x')).to eq(false)
+    expect(entity.matches?(subject, nil)).to eq(false)
+    expect(entity.matches?(subject, :any)).to eq(false)
+  end
+
+  it 'returns correctly for nil' do
+    entity = described_class.new(subject => nil)
+
+    expect(entity.matches?(subject, 'a')).to eq(true)
+    expect(entity.matches?(subject, 'x')).to eq(true)
+    expect(entity.matches?(subject, nil)).to eq(true)
+    expect(entity.matches?(subject, :any)).to eq(true)
+  end
+
+  it 'returns correctly for blank' do
+    entity = described_class.new(subject => '')
+
+    expect(entity.matches?(subject, 'a')).to eq(false)
+    expect(entity.matches?(subject, 'x')).to eq(false)
+    expect(entity.matches?(subject, nil)).to eq(false)
+    expect(entity.matches?(subject, :any)).to eq(false)
+  end
+
+  it 'returns correctly for :any' do
+    entity = described_class.new(subject => :any)
+
+    expect(entity.matches?(subject, 'a')).to eq(true)
+    expect(entity.matches?(subject, 'x')).to eq(true)
+    expect(entity.matches?(subject, nil)).to eq(true)
+    expect(entity.matches?(subject, :any)).to eq(true)
+  end
+end
+
+RSpec.describe Cottontail::Consumer::Entity do
+  context 'comparison' do
+    let(:entity) { described_class.new }
+
+    it 'is equal' do
+      other = described_class.new
+
+      expect(entity < other).to eq(false)
+      expect(entity == other).to eq(true)
+      expect(entity > other).to eq(false)
+    end
+
+    it 'is greater (exchange)' do
+      other = described_class.new(exchange: 'exchange')
+
+      expect(entity < other).to eq(false)
+      expect(entity == other).to eq(false)
+      expect(entity > other).to eq(true)
+    end
+
+    it 'is greater (queue)' do
+      other = described_class.new(queue: 'queue')
+
+      expect(entity < other).to eq(false)
+      expect(entity == other).to eq(false)
+      expect(entity > other).to eq(true)
+    end
+
+    it 'is greater (route)' do
+      other = described_class.new(route: 'route')
+
+      expect(entity < other).to eq(false)
+      expect(entity == other).to eq(false)
+      expect(entity > other).to eq(true)
+    end
+  end
+
+  context 'comparison (more complex)' do
+    let(:aaa) { described_class.new(exchange: 'a', queue: 'a', route: 'a') }
+    let(:bbb) { described_class.new(exchange: 'b', queue: 'b', route: 'b') }
+    let(:bab) { described_class.new(exchange: 'b', queue: 'a', route: 'b') }
+    let(:bba) { described_class.new(exchange: 'b', queue: 'b', route: 'a') }
+
+    let(:entities) { [bbb, bba, bab, aaa] }
+    let(:sorted_entities) { [aaa, bab, bba, bbb] }
+
+    it 'sorts correctly' do
+      expect(entities.sort).to eq(sorted_entities)
+    end
+  end
+
+  context 'comparison with nil' do
+    let(:nnn) { described_class.new(exchange: nil, queue: nil, route: nil) }
+    let(:ann) { described_class.new(exchange: 'a', queue: nil, route: nil) }
+    let(:aan) { described_class.new(exchange: 'a', queue: 'a', route: nil) }
+    let(:aaa) { described_class.new(exchange: 'a', queue: 'a', route: 'a') }
+
+    let(:entities) { [nnn, ann, aan, aaa] }
+    let(:sorted_entities) { [aaa, aan, ann, nnn] }
+
+    it 'sorts correctly' do
+      expect(entities.sort).to eq(sorted_entities)
+    end
+  end
+
+  context 'matching for :exchange' do
+    subject { :exchange }
+    it_behaves_like 'a matching property'
+  end
+
+  context 'matching for :queue' do
+    subject { :queue }
+    it_behaves_like 'a matching property'
+  end
+
+  context 'matching for :queue' do
+    subject { :route }
+    it_behaves_like 'a matching property'
+  end
+end

data/spec/integration/consumer_simple_spec.rb

@@ -0,0 +1,41 @@
+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)
+  end
+  let(:consumable) { consumer.consumable }
+
+  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')
+  end
+
+  after do
+    publisher.stop
+    consumer.stop
+  end
+
+  it 'consumes the message' do
+    5.times { sleep 0.1 if consumable.payload.nil? }
+    expect(consumable.payload).to eq(payload)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+$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'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Print the 5 slowest examples and example groups at the end of the spec run,
+  # to help surface which specs are running particularly slow.
+  config.profile_examples = 5
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+end

data/spec/support/coverage.rb

@@ -0,0 +1,16 @@
+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

data/spec/support/rabbitmq.rb

@@ -0,0 +1,14 @@
+# check if RabbitMQ is running
+def rabbitmq_running?
+  session = Bunny.new(ENV['RABBITMQ_URL'])
+
+  begin
+    session.start
+
+    return true
+  rescue Bunny::TCPConnectionFailedForAllHosts
+    return false
+  ensure
+    session.stop
+  end
+end

data/spec/support/test_consumer.rb

@@ -0,0 +1,32 @@
+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
+  end
+end
+
+

metadata

@@ -1,72 +1,131 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cottontail
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre.1
 platform: ruby
-authors: 
-  - Rudolf Schmidt
+authors:
+- Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-19 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: bunny
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :runtime
-    version_requirements: *id001
-description: Convenience wrapper around the AMQP Bunny gem to better handle routing_key specific messages
+date: 2015-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Convenience wrapper around the AMQP Bunny gem to better handle routing_key
+  specific messages
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - .gitignore
-  - Gemfile
-  - LICENSE.txt
-  - README.md
-  - Rakefile
-  - cottontail.gemspec
-  - lib/cottontail.rb
-  - lib/cottontail/version.rb
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cottontail.gemspec
+- lib/cottontail.rb
+- lib/cottontail/configurable.rb
+- lib/cottontail/consumer.rb
+- lib/cottontail/consumer/collection.rb
+- lib/cottontail/consumer/entity.rb
+- lib/cottontail/consumer/launcher.rb
+- lib/cottontail/consumer/session.rb
+- lib/cottontail/version.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/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/rabbitmq.rb
+- spec/support/test_consumer.rb
 homepage: http://github.com/rudionrails/cottontail
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: cottontail
-rubygems_version: 1.8.9
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sinatra inspired wrapper around the AMQP Bunny gem
-test_files: []
-
+test_files:
+- spec/cottontail/configurable_spec.rb
+- spec/cottontail/consumer/collection_spec.rb
+- spec/cottontail/consumer/entity_spec.rb
+- spec/integration/consumer_simple_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/rabbitmq.rb
+- spec/support/test_consumer.rb
 has_rdoc: