chasqui 1.0.0.pre.rc1 → 1.0.0

data/spec/support/chasqui_spec_helpers.rb

@@ -13,8 +13,6 @@ module ChasquiSpecHelpers
   end
 
   def reset_chasqui_workers
-    Chasqui::Worker.workers.clear
-
     Chasqui::Workers.constants.each do |c|
       Chasqui::Workers.send :remove_const, c
     end
@@ -32,23 +30,4 @@ module ChasquiSpecHelpers
   def flush_redis
     nnredis.keys('*').each { |k| nnredis.del k }
   end
-
-  def new_subscriber(class_name, options={})
-    queue = options.fetch :queue
-    channel = options.fetch :channel
-
-    @subscriber_registry ||= {}
-
-    if @subscriber_registry[class_name] && options[:force]
-      Object.send :remove_const, class_name
-      @subscriber_registry[class_name] = nil
-    end
-
-    @subscriber_registry[class_name] ||= Class.new
-    
-    @subscriber_registry[class_name].tap do |sub|
-      sub.send :include, Chasqui::Subscriber
-      sub.subscribe channel: channel, queue: queue
-    end
-  end
 end

data/spec/support/fake_worker.rb

@@ -0,0 +1,2 @@
+class FakeWorker
+end

data/spec/support/shared_examples/subscription_builder_examples.rb

@@ -0,0 +1,99 @@
+shared_examples 'a subscription builder' do |worker|
+  before { reset_chasqui_workers }
+
+  # hook for any backend specific assertions on the generated worker class
+  # for a proc
+  def expect_worker_to_support_backend(worker)
+    # noop
+  end
+
+  describe '#on' do
+    let(:channel) { 'busy.channel' }
+    let(:queue) { 'pubsub' }
+
+    let(:subscriptions) { double }
+
+    let(:builder) { described_class.new subscriptions }
+
+    it 'subscribes the worker to the channel' do
+      expect(subscriptions).to receive(:register) do |subscriber|
+        expect(subscriber.channel).to eq(channel)
+        expect(subscriber.worker).to eq(worker)
+        expect(subscriber.queue).to eq(queue)
+      end
+
+      builder.on channel, worker
+    end
+
+    it 'prefixes the queue name' do
+      full_queue_name = "app_id:#{queue}"
+
+      expect(subscriptions).to receive(:register) do |subscriber|
+        expect(subscriber.channel).to eq(channel)
+        expect(subscriber.worker).to eq(worker)
+        expect(subscriber.queue).to eq(full_queue_name)
+      end
+
+      builder.on channel, worker, queue_prefix: 'app_id'
+
+      expect(queue_name(worker)).to eq(full_queue_name)
+    end
+
+    it 'uses a different queue' do
+      expect(subscriptions).to receive(:register) do |subscriber|
+        expect(subscriber.channel).to eq(channel)
+        expect(subscriber.worker).to eq(worker)
+        expect(subscriber.queue).to eq('other:queue')
+      end
+
+      builder.on channel, worker, queue: 'other:queue'
+
+      expect(queue_name(worker)).to eq('other:queue')
+    end
+
+    it 'does something expected when both options are used' do
+      expect(subscriptions).to receive(:register) do |subscriber|
+        expect(subscriber.channel).to eq(channel)
+        expect(subscriber.worker).to eq(worker)
+        expect(subscriber.queue).to eq('prefix:other:queue')
+      end
+
+      builder.on channel, worker, queue: 'other:queue', queue_prefix: 'prefix'
+
+      expect(queue_name(worker)).to eq('prefix:other:queue')
+    end
+
+    it 'converts a proc to a worker' do
+      expect(subscriptions).to receive(:register) do |subscriber|
+        queue = "app_id:#{Chasqui.default_queue}"
+
+        expect(subscriber.channel).to eq('busy.channel')
+        expect(subscriber.queue).to eq(queue)
+
+        worker = subscriber.worker
+        expect(worker.name).to eq('Chasqui::Workers::BusyChannelWorker')
+        expect(queue_name(worker)).to eq(queue)
+
+        event = { 'payload' => [3] }
+        expect(perform(worker, event)).to eq(6)
+        expect_worker_to_support_backend(worker)
+      end
+
+      builder.on channel, ->(event, x) { x + x }, queue_prefix: 'app_id'
+    end
+
+    context 'default options' do
+      let(:builder) do
+        described_class.new subscriptions, queue_prefix: 'unique', queue: 'low-priority'
+      end
+
+      it 'uses options supplied during initialization when not supplied to #on' do
+        expect(subscriptions).to receive(:register) do |subscriber|
+          expect(subscriber.queue).to eq('unique:high-priority')
+        end
+
+        builder.on channel, worker, queue: 'high-priority'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chasqui
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordan Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-12 00:00:00.000000000 Z
+date: 2015-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -164,33 +164,37 @@ files:
 - lib/chasqui/cli.rb
 - lib/chasqui/config.rb
 - lib/chasqui/queue_adapter.rb
-- lib/chasqui/queue_adapters/redis_queue_adapter.rb
+- lib/chasqui/queue_adapter/redis_queue_adapter.rb
 - lib/chasqui/subscriber.rb
+- lib/chasqui/subscription_builder.rb
+- lib/chasqui/subscription_builder/resque_subscription_builder.rb
+- lib/chasqui/subscription_builder/sidekiq_subscription_builder.rb
 - lib/chasqui/subscriptions.rb
 - lib/chasqui/version.rb
-- lib/chasqui/worker.rb
 - spec/integration/pubsub_examples.rb
 - spec/integration/resque_spec.rb
 - spec/integration/setup/resque.rb
 - spec/integration/setup/sidekiq.rb
-- spec/integration/setup/subscribers.rb
 - spec/integration/sidekiq_spec.rb
 - spec/lib/chasqui/broker_spec.rb
 - spec/lib/chasqui/brokers/redis_broker_spec.rb
 - spec/lib/chasqui/cli_spec.rb
 - spec/lib/chasqui/config_spec.rb
 - spec/lib/chasqui/fake_queue_adapter_spec.rb
-- spec/lib/chasqui/queue_adapters/redis_queue_adapter_spec.rb
+- spec/lib/chasqui/queue_adapter/redis_queue_adapter_spec.rb
 - spec/lib/chasqui/subscriber_spec.rb
+- spec/lib/chasqui/subscription_builder/resque_subscription_builder_spec.rb
+- spec/lib/chasqui/subscription_builder/sidekiq_subscription_builder_spec.rb
+- spec/lib/chasqui/subscription_builder_spec.rb
 - spec/lib/chasqui/subscriptions_spec.rb
-- spec/lib/chasqui/worker_spec.rb
 - spec/lib/chasqui_spec.rb
 - spec/spec_helper.rb
 - spec/support/chasqui_spec_helpers.rb
 - spec/support/fake_logger.rb
 - spec/support/fake_queue_adapter.rb
-- spec/support/fake_subscriber.rb
+- spec/support/fake_worker.rb
 - spec/support/shared_examples/queue_adapter_examples.rb
+- spec/support/shared_examples/subscription_builder_examples.rb
 - spec/support/sidekiq_compatibility_check.rb
 - tmp/.keep
 homepage: https://github.com/jbgo/chasqui
@@ -208,37 +212,39 @@ 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: 
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Chasqui is a simple, lightweight, persistent implementation of the publish-subscribe
-  (pub/sub) messaging pattern for service oriented architectures.
+summary: Chasqui adds persistent publish-subscribe (pub-sub) messaging capabilities
+  to Sidekiq and Resque workers.
 test_files:
 - spec/integration/pubsub_examples.rb
 - spec/integration/resque_spec.rb
 - spec/integration/setup/resque.rb
 - spec/integration/setup/sidekiq.rb
-- spec/integration/setup/subscribers.rb
 - spec/integration/sidekiq_spec.rb
 - spec/lib/chasqui/broker_spec.rb
 - spec/lib/chasqui/brokers/redis_broker_spec.rb
 - spec/lib/chasqui/cli_spec.rb
 - spec/lib/chasqui/config_spec.rb
 - spec/lib/chasqui/fake_queue_adapter_spec.rb
-- spec/lib/chasqui/queue_adapters/redis_queue_adapter_spec.rb
+- spec/lib/chasqui/queue_adapter/redis_queue_adapter_spec.rb
 - spec/lib/chasqui/subscriber_spec.rb
+- spec/lib/chasqui/subscription_builder/resque_subscription_builder_spec.rb
+- spec/lib/chasqui/subscription_builder/sidekiq_subscription_builder_spec.rb
+- spec/lib/chasqui/subscription_builder_spec.rb
 - spec/lib/chasqui/subscriptions_spec.rb
-- spec/lib/chasqui/worker_spec.rb
 - spec/lib/chasqui_spec.rb
 - spec/spec_helper.rb
 - spec/support/chasqui_spec_helpers.rb
 - spec/support/fake_logger.rb
 - spec/support/fake_queue_adapter.rb
-- spec/support/fake_subscriber.rb
+- spec/support/fake_worker.rb
 - spec/support/shared_examples/queue_adapter_examples.rb
+- spec/support/shared_examples/subscription_builder_examples.rb
 - spec/support/sidekiq_compatibility_check.rb

data/lib/chasqui/worker.rb

@@ -1,81 +0,0 @@
-module Chasqui
-  module Chasqui::Workers
-  end
-
-  class Worker
-    class << self
-
-      BACKENDS = {
-        resque: 'ResqueWorkerFactory',
-        sidekiq: 'SidekiqWorkerFactory'
-      }
-
-      def create(subscriber)
-        workers[subscriber.object_id] ||= create_worker(subscriber)
-      end
-
-      def workers
-        @workers ||= {}
-      end
-
-      private
-
-      def check_for_worker_backend
-        unless BACKENDS.keys.include? Chasqui.worker_backend
-          msg = "Chasqui.config.worker_backend must be one of #{BACKENDS.keys}"
-          raise ConfigurationError.new msg
-        end
-      end
-
-      def worker_factory
-        Chasqui.const_get BACKENDS[Chasqui.worker_backend]
-      end
-
-      def create_worker(subscriber)
-        check_for_worker_backend
-        worker = worker_factory.create subscriber
-        Chasqui::Workers.const_set subscriber.name, worker
-      end
-
-    end
-  end
-
-  class ResqueWorkerFactory
-    def self.create(subscriber)
-      Class.new do
-        @queue = subscriber.queue
-        @subscriber = subscriber
-
-        class << self
-          attr_reader :subscriber
-        end
-
-        def self.perform(event)
-          instance = @subscriber.new event: event, logger: Resque.logger
-          instance.perform event['payload']
-        end
-      end
-    end
-  end
-
-  class SidekiqWorkerFactory
-    def self.create(subscriber)
-      Class.new do
-        include Sidekiq::Worker
-        sidekiq_options 'queue' => 'foo-queue'
-
-        @subscriber = subscriber
-
-        class << self
-          attr_reader :subscriber
-        end
-
-        def perform(event)
-          instance = self.class.subscriber.new event: event, logger: logger
-          instance.perform event['payload']
-        end
-      end
-    end
-  end
-
-end

data/spec/integration/setup/subscribers.rb

@@ -1,30 +0,0 @@
-def log_event subscriber, payload
-  Chasqui.redis.rpush "#{subscriber.class.queue}:event_log", subscriber.event.to_json
-end
-
-class UserSignupSubscriber
-  include Chasqui::Subscriber
-  subscribe channel: 'user.signup', queue: 'app1'
-
-  def perform(payload)
-    log_event self, payload
-  end
-end
-
-class AccountSubscriber
-  include Chasqui::Subscriber
-  subscribe channel: ['account.credit', 'account.debit'], queue: 'app2'
-
-  def perform(payload)
-    log_event self, payload
-  end
-end
-
-class UserCancelSubscriber
-  include Chasqui::Subscriber
-  subscribe channel: 'user.cancel', queue: 'app2'
-
-  def perform(payload)
-    log_event self, payload
-  end
-end

data/spec/lib/chasqui/worker_spec.rb

@@ -1,96 +0,0 @@
-require 'spec_helper'
-
-class MockSubscriber
-  include Chasqui::Subscriber
-  subscribe channel: 'foo-channel', prefix: nil, queue: 'foo-queue'
-
-  def perform(payload)
-    self.class.info[:event] = event
-    self.class.info[:payload] = payload
-    self.class.info[:redis] = redis
-    self.class.info[:logger] = logger
-  end
-
-  class << self
-    def info
-      @info ||= {}
-    end
-  end
-end
-
-describe Chasqui::Worker do
-  before do
-    reset_config
-    Chasqui::Worker.workers.clear
-    MockSubscriber.instance_variable_set :@info, nil
-  end
-
-  let(:subscriber) { MockSubscriber }
-
-  context 'no worker backend' do
-    describe '.create' do
-      it 'raises' do
-        Chasqui.config.worker_backend = :does_not_exist
-
-        expect(-> {
-          Chasqui::Worker.create subscriber
-        }).to raise_error(Chasqui::ConfigurationError)
-      end
-    end
-  end
-
-  context 'resque' do
-    before { Chasqui.config.worker_backend = :resque }
-    after { Chasqui::Workers.send :remove_const, :MockSubscriber }
-
-    describe '.create' do
-      let(:worker) { Chasqui::Worker.create subscriber }
-
-      it { expect(worker.name).to eq('Chasqui::Workers::MockSubscriber') }
-      it { expect(worker.instance_variable_get(:@queue)).to eq(subscriber.queue) }
-      it { expect(worker.instance_variable_get(:@subscriber)).to eq(subscriber) }
-
-      it 'delegates #perform to the subscriber' do
-        event = {
-          'channel' => 'foo-channel',
-          'payload' => { 'some' => 'data' }
-        }
-
-        worker.perform event
-
-        expect(subscriber.info[:event]).to eq(event)
-        expect(subscriber.info[:payload]).to eq(event['payload'])
-      end
-    end
-  end
-
-  if sidekiq_supported_ruby_version?
-    context 'sidekiq' do
-      before { Chasqui.config.worker_backend = :sidekiq }
-      after { Chasqui::Workers.send :remove_const, :MockSubscriber }
-
-      describe '.create' do
-        let(:worker) { Chasqui::Worker.create subscriber }
-
-        it { expect(worker.name).to eq('Chasqui::Workers::MockSubscriber') }
-        it { expect(worker.instance_variable_get(:@subscriber)).to eq(subscriber) }
-        it { expect(worker.sidekiq_options).to include('queue' => 'foo-queue') }
-        it { expect(worker.included_modules).to include(Sidekiq::Worker) }
-
-        it 'delegates #perform to the subscriber' do
-          event = {
-            'channel' => 'foo-channel',
-            'payload' => { 'some' => 'data' }
-          }
-
-          sidekiq_worker = worker.new
-          sidekiq_worker.perform event
-
-          expect(subscriber.info[:event]).to eq(event)
-          expect(subscriber.info[:payload]).to eq(event['payload'])
-          expect(subscriber.info[:logger]).to eq(sidekiq_worker.logger)
-        end
-      end
-    end
-  end
-end