active_job_channel 0.0.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '058d0b861b22420aa23b79986d3d73bb01cbe27d7279ef706382edb7a4d47ba5'
-  data.tar.gz: 79aaf5fbd4416e22a93c9a14353ef41c7d6965d58670d4815e3af6f86b88f726
+  metadata.gz: e15e3cd0deda9ddda3a0d594f125554938b14233444b6f7f6f53ae24cbb3bbac
+  data.tar.gz: 448bfe9ff104ebc3f489de2fe8f95591fcca443efef647d63c264717187542ba
 SHA512:
-  metadata.gz: 5f12183f81a90854fb76a584d93b96ef6e656f41b4ff0926ef6a242b275b14fe3e6172abd830264ee425732016fafc4b448476b3b32ba15d76f4f7c900b8ea96
-  data.tar.gz: b5e178a2ed8ac074fd4350d9f884373e142aa0ea73712570e3e10d86efc196f70eb4b083d604e78d8a4aec277b844d91bdb8aa2217634ed8274ff49813416bd0
+  metadata.gz: 52748705d9f2f217353138fc768910c5e2ef5daa4df099fc9f9e2a6a863c82df66dfadadc1d8a8307a8bc719a0fbf2bb1d5a6d336e7f20458787810e1a18762c
+  data.tar.gz: 56dad2e05f5e500f228c0b0c1ee89d53ad3064d54946ab599a0613706f940ce60b34d91ae70b4674871b85fd804788ff398776d50b23bd2c118615fc26f295d9

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/active_job_channel.svg)](https://badge.fury.io/rb/active_job_channel)
+
 # ActiveJobChannel
 Use ActionCable to alert front-end users of finished ActiveJobs
 

data/Rakefile

@@ -11,10 +11,19 @@ Bundler::GemHelper.install_tasks
 
 Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 
+# bundler-audit task
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# RuboCop task
+require 'rubocop/rake_task'
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RuboCop::RakeTask.new
+
+# RSpec Task
 require 'rspec/core'
 require 'rspec/core/rake_task'
-
 desc 'Run all specs in spec directory (excluding plugin specs)'
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new
 
-task default: :spec
+task default: %i[bundle:audit rubocop spec]

data/lib/active_job_channel/broadcaster.rb

@@ -20,7 +20,7 @@ module ActiveJobChannel
       def active_job_channel(options = {})
         class_attribute :ajc_config
         self.ajc_config = { global_broadcast: false }
-        self.ajc_config.merge!(options)
+        ajc_config.merge!(options)
 
         after_perform :broadcast_success
         rescue_from '::StandardError' do |exception|

data/lib/active_job_channel/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobChannel
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/active_job_channel/broadcaster_spec.rb

@@ -0,0 +1,145 @@
+require 'active_job_channel/broadcaster'
+require 'spec_helper'
+
+module ActiveJobChannel
+  module Broadcaster
+    RSpec.describe ClassMethods do
+      before(:each) do
+        class DummyJob < ActiveJob::Base
+          active_job_channel global_broadcast: true
+          def perform
+            fake
+          end
+
+          private
+
+          def fake; end
+        end
+        DummyJob.extend(described_class)
+      end
+
+      describe '.active_job_channel' do
+        it 'sets ajc_config with options hash' do
+          DummyJob.active_job_channel
+          expect(DummyJob.ajc_config).to eq(global_broadcast: false)
+
+          DummyJob.active_job_channel global_broadcast: true
+          expect(DummyJob.ajc_config).to eq(global_broadcast: true)
+        end
+      end
+
+      describe '#broadcast_failure' do
+        it 'handles an error' do
+          allow_any_instance_of(DummyJob).
+            to receive(:fake).
+            and_raise(StandardError)
+          expect_any_instance_of(DummyJob).
+            to receive(:broadcast_failure).
+            with(StandardError).
+            and_call_original
+
+          action_cable_server = double 'action_cable_server'
+          allow(ActionCable).to receive(:server).and_return(action_cable_server)
+          expect(action_cable_server).
+            to receive(:broadcast).
+            with(
+              ::ActiveJobChannel::Channel::CHANNEL_NAME,
+              status: 'failure',
+              job_name: DummyJob.to_s,
+              error: StandardError.new.inspect
+            )
+
+          expect { DummyJob.perform_now }.to raise_error(StandardError)
+        end
+
+        context 'with ajc_identifier' do
+          it 'broadcast failure to the identifier' do
+            DummyJob.active_job_channel global_broadcast: false
+            ajc_identifier = 'ajc_identifier'
+            allow_any_instance_of(DummyJob).
+              to receive(:fake).
+              and_raise(StandardError)
+            allow_any_instance_of(DummyJob).
+              to receive(:ajc_identifier).
+              and_return(ajc_identifier)
+            expect_any_instance_of(DummyJob).
+              to receive(:broadcast_failure).
+              with(StandardError).
+              and_call_original
+
+            action_cable_server = double 'action_cable_server'
+            allow(ActionCable).
+              to receive(:server).
+              and_return(action_cable_server)
+            expect(action_cable_server).
+              to receive(:broadcast).
+              with(
+                "#{::ActiveJobChannel::Channel::CHANNEL_NAME}#" \
+                  "#{ajc_identifier}",
+                status: 'failure',
+                job_name: DummyJob.to_s,
+                error: StandardError.new.inspect
+              )
+
+            expect { DummyJob.perform_now }.to raise_error(StandardError)
+          end
+        end
+      end
+
+      describe '#broadcast_success' do
+        it 'broadcasts' do
+          expect_any_instance_of(DummyJob).
+            to receive(:broadcast_success).
+            and_call_original
+
+          action_cable_server = double 'action_cable_server'
+          allow(ActionCable).to receive(:server).and_return(action_cable_server)
+          expect(action_cable_server).
+            to receive(:broadcast).
+            with(
+              ::ActiveJobChannel::Channel::CHANNEL_NAME,
+              status: 'success',
+              job_name: DummyJob.to_s
+            )
+
+          DummyJob.perform_now
+        end
+
+        context 'with ajc_identifier' do
+          it 'broadcast success to the identifier' do
+            DummyJob.active_job_channel global_broadcast: false
+            ajc_identifier = 'ajc_identifier'
+            allow_any_instance_of(DummyJob).
+              to receive(:ajc_identifier).
+              and_return(ajc_identifier)
+            expect_any_instance_of(DummyJob).
+              to receive(:broadcast_success).
+              and_call_original
+
+            action_cable_server = double 'action_cable_server'
+            allow(ActionCable).
+              to receive(:server).
+              and_return(action_cable_server)
+            expect(action_cable_server).
+              to receive(:broadcast).
+              with(
+                "#{::ActiveJobChannel::Channel::CHANNEL_NAME}#" \
+                  "#{ajc_identifier}",
+                status: 'success',
+                job_name: DummyJob.to_s
+              )
+
+            DummyJob.perform_now
+          end
+        end
+      end
+
+      describe 'NoIdentifierError' do
+        it 'is raised when ajc_identifier is missing for private broadcast' do
+          DummyJob.active_job_channel global_broadcast: false
+          expect { DummyJob.perform_now }.to raise_error(NoIdentifierError)
+        end
+      end
+    end
+  end
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -1,7 +1,7 @@
 class ApplicationJob < ActiveJob::Base
   active_job_channel global_broadcast: true
 
-  def perform(identifier)
+  def perform(identifier = nil)
     @ajc_identifier = identifier
     fake
   end