sucker_punch 1.6.0 → 2.0.0.beta1

data/test/sucker_punch/queue_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+module SuckerPunch
+  class QueueTest < Minitest::Test
+    def setup
+      @queue = "fake"
+    end
+
+    def teardown
+      SuckerPunch::Queue.clear
+    end
+
+    def test_queue_is_created_if_it_doesnt_exist
+      SuckerPunch::Queue::QUEUES.clear
+      assert SuckerPunch::Queue::QUEUES.empty?
+      queue = SuckerPunch::Queue.find_or_create(@queue)
+      assert queue.send(:pool).is_a?(Concurrent::ThreadPoolExecutor)
+    end
+
+    def test_queue_is_created_with_2_workers
+      queue = SuckerPunch::Queue.find_or_create(@queue)
+      assert_equal 2, queue.max_length
+      assert_equal 2, queue.min_length
+    end
+
+    def test_queue_num_workers_can_be_set
+      queue = SuckerPunch::Queue.find_or_create(@queue, 4)
+      assert_equal 4, queue.max_length
+      assert_equal 4, queue.min_length
+    end
+
+    def test_same_queue_is_returned_on_subsequent_queries
+      SuckerPunch::Queue::QUEUES.clear
+      queue = SuckerPunch::Queue.find_or_create(@queue)
+      assert_equal queue, SuckerPunch::Queue.find_or_create(@queue)
+    end
+
+    def test_all_returns_all_instances_of_a_queue
+      queue1 = SuckerPunch::Queue.find_or_create("fake")
+      queue2 = SuckerPunch::Queue.find_or_create("other_fake")
+      assert SuckerPunch::Queue.all.is_a?(Array)
+      assert SuckerPunch::Queue.all.first.is_a?(SuckerPunch::Queue)
+      assert SuckerPunch::Queue.all.include?(queue1)
+      assert SuckerPunch::Queue.all.include?(queue2)
+    end
+
+    def test_clear_removes_queues_and_stats
+      SuckerPunch::Queue.find_or_create(@queue)
+      SuckerPunch::Counter::Busy.new(@queue).increment
+      SuckerPunch::Counter::Processed.new(@queue).increment
+      SuckerPunch::Counter::Failed.new(@queue).increment
+
+      SuckerPunch::Queue.clear
+
+      assert SuckerPunch::Counter::Busy.new(@queue).value == 0
+      assert SuckerPunch::Counter::Processed.new(@queue).value == 0
+      assert SuckerPunch::Counter::Failed.new(@queue).value == 0
+    end
+
+    def test_returns_queue_stats
+      latch = Concurrent::CountDownLatch.new
+
+      # run a job to setup workers
+      2.times { FakeNilJob.perform_async }
+
+      queue = SuckerPunch::Queue.find_or_create(FakeNilJob.to_s)
+      queue.post { latch.count_down }
+      latch.wait(0.1)
+
+      all_stats = SuckerPunch::Queue.stats
+      stats = all_stats[FakeNilJob.to_s]
+      assert stats["workers"]["total"] > 0
+      assert stats["workers"]["busy"] == 0
+      assert stats["workers"]["idle"] > 0
+      assert stats["jobs"]["processed"] > 0
+      assert stats["jobs"]["failed"] == 0
+      assert stats["jobs"]["enqueued"] == 0
+    end
+
+    def test_queue_name_is_accessible
+      queue = SuckerPunch::Queue.find_or_create(FakeNilJob.to_s)
+      assert_equal "SuckerPunch::QueueTest::FakeNilJob", queue.name
+    end
+
+    def test_default_running_state_is_true
+      queue = SuckerPunch::Queue.find_or_create(FakeNilJob.to_s)
+      assert_equal true, queue.running?
+    end
+
+    private
+
+    class FakeNilJob
+      include SuckerPunch::Job
+      def perform
+        nil
+      end
+    end
+  end
+end

data/test/sucker_punch_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class SuckerPunchTest < Minitest::Test
+  def setup
+    SuckerPunch::Queue.clear
+  end
+
+  def teardown
+    SuckerPunch::Queue.clear
+    SuckerPunch.logger = nil
+    SuckerPunch.exception_handler = nil
+  end
+
+  def test_that_it_has_a_version_number
+    refute_nil ::SuckerPunch::VERSION
+  end
+
+  def test_logger_defaults_to_stdout
+    SuckerPunch.logger = SuckerPunch.default_logger
+    assert SuckerPunch.logger.is_a?(Logger)
+    assert_equal Logger::INFO, SuckerPunch.logger.level
+  end
+
+  def test_can_reset_logger
+    SuckerPunch.logger = nil
+    assert SuckerPunch.logger.is_a?(Logger)
+  end
+
+  def test_logger_can_be_set
+    logger = Logger.new(nil)
+    SuckerPunch.logger = logger
+    assert_equal logger, SuckerPunch.logger
+  end
+
+  def test_default_exception_handler_is_logger
+    @mock = Minitest::Mock.new
+    SuckerPunch.logger = @mock
+    @mock.expect(:error, nil, ["Sucker Punch job error for class: '' args: []\nStandardError fake\n"])
+    SuckerPunch.exception_handler.call(StandardError.new("fake"), '', [])
+    assert @mock.verify
+  end
+
+  def test_exception_handler_can_be_set
+    SuckerPunch.exception_handler = -> (ex, _, _) { raise "bad stuff" }
+    assert_raises(::RuntimeError) { SuckerPunch.exception_handler.call(StandardError.new("bad"), nil, nil) }
+  end
+
+  def test_shutdown_timeout_can_be_set
+    SuckerPunch.shutdown_timeout = 15
+    assert_equal 15, SuckerPunch.shutdown_timeout
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sucker_punch'
+
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+SuckerPunch.logger = nil

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,23 +53,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: celluloid
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.2
+        version: 1.0.0
 description: Asynchronous processing library for Ruby
 email:
 - brandonhilkert@gmail.com
-executables: []
+executables:
+- load
+- shutdown
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,27 +82,33 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/load
+- bin/shutdown
 - lib/generators/sucker_punch/job_generator.rb
 - lib/generators/sucker_punch/templates/job.rb
 - lib/sucker_punch.rb
+- lib/sucker_punch/async_syntax.rb
 - lib/sucker_punch/core_ext.rb
+- lib/sucker_punch/counter.rb
 - lib/sucker_punch/job.rb
 - lib/sucker_punch/queue.rb
 - lib/sucker_punch/railtie.rb
 - lib/sucker_punch/testing/inline.rb
 - lib/sucker_punch/version.rb
-- spec/spec_helper.rb
-- spec/sucker_punch/core_ext_spec.rb
-- spec/sucker_punch/job_spec.rb
-- spec/sucker_punch/queue_spec.rb
-- spec/sucker_punch/testing/inline_spec.rb
-- spec/sucker_punch_spec.rb
 - sucker_punch.gemspec
+- test/sucker_punch/async_syntax_test.rb
+- test/sucker_punch/counter_test.rb
+- test/sucker_punch/job_test.rb
+- test/sucker_punch/queue_test.rb
+- test/sucker_punch_test.rb
+- test/test_helper.rb
 homepage: https://github.com/brandonhilkert/sucker_punch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Sucker Punch Version 2.0 introduces backwards-incompatible changes.
+  Please see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#20
+  for details.
 rdoc_options: []
 require_paths:
 - lib
@@ -111,21 +119,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced
   by Sidekiq and girl_friday.
 test_files:
-- spec/spec_helper.rb
-- spec/sucker_punch/core_ext_spec.rb
-- spec/sucker_punch/job_spec.rb
-- spec/sucker_punch/queue_spec.rb
-- spec/sucker_punch/testing/inline_spec.rb
-- spec/sucker_punch_spec.rb
-has_rdoc: 
+- test/sucker_punch/async_syntax_test.rb
+- test/sucker_punch/counter_test.rb
+- test/sucker_punch/job_test.rb
+- test/sucker_punch/queue_test.rb
+- test/sucker_punch_test.rb
+- test/test_helper.rb

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-begin
-  require 'pry'
-rescue LoadError
-end
-
-require 'sucker_punch'
-
-RSpec.configure do |config|
-end

data/spec/sucker_punch/core_ext_spec.rb

@@ -1,13 +0,0 @@
-require "spec_helper"
-
-describe "Core extensions" do
-  describe String do
-    before :each do
-      class FakeQueue; end
-    end
-
-    it "underscores a class name" do
-      expect(FakeQueue.to_s.underscore).to eq("fake_queue")
-    end
-  end
-end

data/spec/sucker_punch/job_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-describe SuckerPunch::Job do
-  before :each do
-    class ::FakeJob
-      include SuckerPunch::Job
-      workers 4
-
-      def perform(name)
-        "response #{name}"
-      end
-    end
-  end
-
-  after :each do
-    Celluloid::Actor.clear_registry
-  end
-
-  it "includes Celluloid into requesting class when included" do
-    expect(FakeJob).to respond_to(:pool)
-  end
-
-  it "sets the pool size to 4" do
-    pool = FakeJob.new
-    expect(pool.size).to eq(4)
-  end
-
-  it "returns the same pool on each instantiation" do
-    pool = FakeJob.new
-    pool2 = FakeJob.new
-    expect(pool.thread).to eq(pool2.thread)
-  end
-
-  describe "when pool hasn't been created" do
-    it "registers queue" do
-      queue = double("queue")
-      allow(SuckerPunch::Queue).to receive(:new).and_return(queue)
-      expect(queue).to receive(:register){ 4 }
-      pool = FakeJob.new
-    end
-  end
-end

data/spec/sucker_punch/queue_spec.rb

@@ -1,69 +0,0 @@
-require 'spec_helper'
-
-describe SuckerPunch::Queue do
-  before :each do
-    class ::FakeJob
-      include SuckerPunch::Job
-
-      def perform(name)
-        "response #{name}"
-      end
-    end
-  end
-
-  after :each do
-    Celluloid::Actor.clear_registry
-  end
-
-  describe ".find" do
-    it "returns the Celluloid Actor from the registry" do
-      SuckerPunch::Queue.new(FakeJob).register
-      queue = SuckerPunch::Queue.find(FakeJob)
-      expect(queue.class).to eq Celluloid::Supervision::Container::Pool
-    end
-  end
-
-  describe "#register" do
-    let(:job) { FakeJob }
-    let(:queue) { SuckerPunch::Queue.new(job) }
-
-    it "initializes and registers the pool with Celluloid" do
-      expected_pool_name = "#{SuckerPunch::Queue::PREFIX}_fake_job".to_sym
-
-      pool = queue.register
-
-      expect(Celluloid::Actor[expected_pool_name]).to eq(pool)
-    end
-
-    it "registers the pool with Celluloid and 3 workers" do
-      expected_pool_name = "#{SuckerPunch::Queue::PREFIX}_fake_job"
-
-      queue.register(3)
-
-      expect(Celluloid::Actor[expected_pool_name].size).to eq(3)
-    end
-
-    context "when too many workers are specified" do
-      it "raises a MaxWorkersExceeded exception" do
-        expect{ queue.register(201) }.to raise_error(SuckerPunch::Queue::MaxWorkersExceeded)
-      end
-    end
-
-    context "when too few workers are specified" do
-      it "raises a NotEnoughWorkers exception" do
-        expect{ queue.register(0) }.to raise_error(SuckerPunch::Queue::NotEnoughWorkers)
-      end
-    end
-  end
-
-  describe "#registered?" do
-    it "returns true if queue has already been registered" do
-      queue = SuckerPunch::Queue.new(FakeJob)
-
-      expect{
-        queue.register
-      }.to change{ queue.registered? }.from(false).to(true)
-    end
-  end
-end
-

data/spec/sucker_punch/testing/inline_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require_relative '../../../lib/sucker_punch/testing/inline'
-
-describe "SuckerPunch Inline Testing" do
-  before :each do
-    class PatchedJob
-      def perform
-        "do stuff"
-      end
-      include SuckerPunch::Job
-    end
-  end
-
-  it "processes jobs inline" do
-    job = PatchedJob.new.async.perform
-    expect(job).to eq "do stuff"
-  end
-end

data/spec/sucker_punch_spec.rb

@@ -1,14 +0,0 @@
-require 'spec_helper'
-
-describe SuckerPunch do
-  describe 'logger' do
-    it "delegates get to Celluloid's logger" do
-      expect(SuckerPunch.logger).to eq Celluloid.logger
-    end
-
-    it "delegates set to Celluloid's logger" do
-      expect(Celluloid).to receive(:logger=)
-      SuckerPunch.logger = nil
-    end
-  end
-end