queue-bus 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18ed6e21b956ce928e0c3ede7e1493eb7806413706e92e1f4c991667e9e06b8
-  data.tar.gz: 4043918b7705741e3719d6460b9823367b9e271e6344193c2b616aab063a4d9a
+  metadata.gz: 89735322de0ab91d94ca27b4f58598ef5049f829adfdc4788aa84eccd4d4597e
+  data.tar.gz: b6955c5ac09371018feddf9236f756de49c024ae1ac199b1498c00137761ab6d
 SHA512:
-  metadata.gz: 6894d383941edf09df6d245eaffc57ecd2ef3185bb3196d89a29c7714cc7b3f849639e285764ee57832158a566538bc2c1b8b6691af2d73ab5a3760d8893ef5e
-  data.tar.gz: 9b08d34ff3309f039640a1c154b5f33cfc186f69f18511a09201e4eeb5553ef8f5b8ad053405fc6f9bf3658d5750543d7fa92d431d88ba72af5c3ab8f0d50e45
+  metadata.gz: f4c49c5180981e584fa91e0ba8a185c82b82f9c82533b36a75e2dc57cab75ff327d3585ac109940f234c9414c64ebae33aaa1f54ccbf5ab4b0e16cd1965128bd
+  data.tar.gz: 7486eb2fbd2cb8ede93beb3af7b2046b224e74983986045577997f227d9df4e056aac8f8054bb42f09c1194354b4c0306c45a30c059c6cab099710365ee58a9e

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  ExtraDetails: true
+
+# http://rubocop.readthedocs.io/en/latest/cops_style/#stylefrozenstringliteralcomment
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# https://rubocop.readthedocs.io/en/latest/cops_style/#styledatetime
+Style/DateTime:
+  Enabled: true
+
+# http://rubocop.readthedocs.io/en/latest/cops_metrics/#metricslinelength
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# https://rubocop.readthedocs.io/en/latest/cops_layout/#layoutdotposition
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: leading
+
+# https://rubocop.readthedocs.io/en/latest/cops_style/#stylehashsyntax
+Style/HashSyntax:
+  Enabled: true
+
+# https://rubocop-rspec.readthedocs.io/en/latest/cops_rspec/#rspecfocus
+RSpec/Focus:
+  Enabled: true

data/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0]
+
+### Added
+- Adds `QueueBus.has_adapter?` to check whether the adapter is set.
+
+### Changed
+- Now uses `Process.hostname` to determine hostname versus relying on unix shell.
+- Rubocop is now a dev dependency.
+- Accessors to config are now done with actual attrs.
+- Logging with the adapter will use the logger if present.
+
+### Fixed
+- Passing a class to `adapter=` would error on a `NameError`.
+
 ## [0.6.0]
 
 ### Added

data/lib/queue-bus.rb

@@ -38,7 +38,7 @@ module QueueBus
                             :before_publish=, :before_publish_callback,
                             :logger=, :logger, :log_application, :log_worker,
                             :hostname=, :hostname,
-                            :adapter=, :adapter,
+                            :adapter=, :adapter, :has_adapter?,
                             :incoming_queue=, :incoming_queue,
                             :redis, :worker_middleware_stack
 
@@ -60,5 +60,4 @@ module QueueBus
       @_dispatchers ||= ::QueueBus::Dispatchers.new
     end
   end
-
 end

data/lib/queue_bus/config.rb

@@ -1,102 +1,70 @@
-module QueueBus
-  class Config
-    def adapter=val
-      raise "Adapter already set to #{@adapter_instance.class.name}" if @adapter_instance
-      if val.is_a?(Class)
-        @adapter_instance = name_or_klass.new
-      elsif val.is_a?(::QueueBus::Adapters::Base)
-        @adapter_instance = val
-      else
-        class_name = ::QueueBus::Util.classify(val)
-        @adapter_instance = ::QueueBus::Util.constantize("::QueueBus::Adapters::#{class_name}").new
-      end
-      @adapter_instance
-    end
-
-    def adapter
-      return @adapter_instance if @adapter_instance
-      raise "no adapter has been set"
-    end
-
-    def redis(&block)
-      # TODO: could allow setting for non-redis adapters
-      adapter.redis(&block)
-    end
+# frozen_string_literal: true
 
-    def default_app_key=val
-      @default_app_key = Application.normalize(val)
-    end
+require 'socket'
+require 'logger'
 
-    def default_app_key
-      @default_app_key
-    end
+module QueueBus
+  # This class contains all the configuration for a running queue bus application.
+  class Config
+    attr_accessor :default_queue, :local_mode, :hostname, :incoming_queue, :logger
 
-    def default_queue=val
-      @default_queue = val
-    end
+    attr_reader :worker_middleware_stack
 
-    def default_queue
-      @default_queue
+    def initialize
+      @worker_middleware_stack = QueueBus::Middleware::Stack.new
+      @incoming_queue = 'bus_incoming'
+      @hostname = Socket.gethostname
     end
 
-    def local_mode=value
-      @local_mode = value
-    end
+    def adapter=(val)
+      raise "Adapter already set to #{@adapter_instance.class.name}" if has_adapter?
 
-    def local_mode
-      @local_mode
+      @adapter_instance =
+        if val.is_a?(Class)
+          val.new
+        elsif val.is_a?(::QueueBus::Adapters::Base)
+          val
+        else
+          class_name = ::QueueBus::Util.classify(val)
+          ::QueueBus::Util.constantize("::QueueBus::Adapters::#{class_name}").new
+        end
     end
 
-    def incoming_queue=val
-      @incoming_queue = val
-    end
+    def adapter
+      return @adapter_instance if has_adapter?
 
-    def incoming_queue
-      @incoming_queue ||= "bus_incoming"
+      raise 'no adapter has been set'
     end
 
-    def worker_middleware_stack
-      @worker_middleware_stack ||= QueueBus::Middleware::Stack.new
+    # Checks whether an adapter is set and returns true if it is.
+    def has_adapter? # rubocop:disable Naming/PredicateName
+      !@adapter_instance.nil?
     end
 
-    def hostname
-      @hostname ||= `hostname 2>&1`.strip.sub(/.local/,'')
+    def redis(&block)
+      # TODO: could allow setting for non-redis adapters
+      adapter.redis(&block)
     end
 
-    def hostname=val
-      @hostname = val
+    attr_reader :default_app_key
+    def default_app_key=(val)
+      @default_app_key = Application.normalize(val)
     end
 
-    def before_publish=(proc)
-      @before_publish_callback = proc
+    def before_publish=(callback)
+      @before_publish_callback = callback
     end
 
     def before_publish_callback(attributes)
-      if @before_publish_callback
-        @before_publish_callback.call(attributes)
-      end
-    end
-
-    def logger
-      @logger
-    end
-
-    def logger=val
-      @logger = val
+      @before_publish_callback&.call(attributes)
     end
 
     def log_application(message)
-      if logger
-        time = Time.now.strftime('%H:%M:%S %Y-%m-%d')
-        logger.info("** [#{time}] #$$: QueueBus #{message}")
-      end
+      logger&.info(message)
     end
 
     def log_worker(message)
-      if ENV['LOGGING'] || ENV['VERBOSE'] || ENV['VVERBOSE']
-        time = Time.now.strftime('%H:%M:%S %Y-%m-%d')
-        puts "** [#{time}] #$$: #{message}"
-      end
+      logger&.debug(message)
     end
   end
 end

data/lib/queue_bus/version.rb

@@ -1,3 +1,3 @@
 module QueueBus
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/queue-bus.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec")
   s.add_development_dependency("timecop")
   s.add_development_dependency("json_pure")
+  s.add_development_dependency("rubocop")
 end

data/spec/config_spec.rb

@@ -1,83 +1,124 @@
-require 'spec_helper'
-
-module QueueBus
-  module Adapters
-    class TestOne
+# frozen_string_literal: true
 
-    end
-  end
-end
+require 'spec_helper'
 
-describe "QueueBus config" do
-  it "should set the default app key" do
+describe 'QueueBus config' do
+  it 'sets the default app key' do
     expect(QueueBus.default_app_key).to eq(nil)
 
-    QueueBus.default_app_key = "my_app"
-    expect(QueueBus.default_app_key).to eq("my_app")
+    QueueBus.default_app_key = 'my_app'
+    expect(QueueBus.default_app_key).to eq('my_app')
 
-    QueueBus.default_app_key = "something here"
-    expect(QueueBus.default_app_key).to eq("something_here")
+    QueueBus.default_app_key = 'something here'
+    expect(QueueBus.default_app_key).to eq('something_here')
   end
 
-  it "should set the default queue" do
+  it 'sets the default queue' do
     expect(QueueBus.default_queue).to eq(nil)
 
-    QueueBus.default_queue = "my_queue"
-    expect(QueueBus.default_queue).to eq("my_queue")
+    QueueBus.default_queue = 'my_queue'
+    expect(QueueBus.default_queue).to eq('my_queue')
   end
 
-  it "should set the local mode" do
+  it 'sets the local mode' do
     expect(QueueBus.local_mode).to eq(nil)
     QueueBus.local_mode = :standalone
     expect(QueueBus.local_mode).to eq(:standalone)
   end
 
-  it "should set the hostname" do
+  it 'sets the hostname' do
     expect(QueueBus.hostname).not_to eq(nil)
-    QueueBus.hostname = "whatever"
-    expect(QueueBus.hostname).to eq("whatever")
+    QueueBus.hostname = 'whatever'
+    expect(QueueBus.hostname).to eq('whatever')
   end
 
-  it "should set before_publish callback" do
-    QueueBus.before_publish = lambda {|attributes| 42 }
+  it 'sets before_publish callback' do
+    QueueBus.before_publish = ->(_attr) { 42 }
     expect(QueueBus.before_publish_callback({})).to eq(42)
   end
 
-
-  it "should use the default Redis connection" do
+  it 'uses the default Redis connection' do
     expect(QueueBus.redis { |redis| redis }).not_to eq(nil)
   end
 
-  it "should default to given adapter" do
+  it 'defaults to given adapter' do
     expect(QueueBus.adapter.is_a?(adapter_under_test_class)).to eq(true)
 
     # and should raise if already set
-    expect {
-      QueueBus.adapter = :data
-    }.to raise_error(RuntimeError, "Adapter already set to QueueBus::Adapters::Data")
+    expect { QueueBus.adapter = :data }
+      .to raise_error(RuntimeError, 'Adapter already set to QueueBus::Adapters::Data')
   end
 
-  context "with a fresh load" do
+  context 'with a fresh load' do
     before(:each) do
       QueueBus.send(:reset)
     end
 
-    it "should be able to be set to resque" do
-      QueueBus.adapter = adapter_under_test_symbol
-      expect(QueueBus.adapter.is_a?(adapter_under_test_class)).to eq(true)
+    context 'when set to adapter under test' do
+      before do
+        QueueBus.adapter = adapter_under_test_symbol
+      end
+
+      it 'sets to that adapter' do
+        expect(QueueBus.adapter).to be_a adapter_under_test_class
+      end
+    end
 
-      # and should raise if already set
-      expect {
+    context 'when already set' do
+      before do
         QueueBus.adapter = :data
-      }.to raise_error(RuntimeError, "Adapter already set to QueueBus::Adapters::Data")
+      end
+
+      it 'raises' do
+        expect { QueueBus.adapter = :data }
+          .to raise_error(RuntimeError, 'Adapter already set to QueueBus::Adapters::Data')
+      end
+
+      it 'knows the adapter is set' do
+        expect(QueueBus).to have_adapter
+      end
     end
 
-    it "should be able to be set to something else" do
+    context 'with a symbol' do
+      before do
+        QueueBus.adapter = :data
+      end
 
-      QueueBus.adapter = :test_one
-      expect(QueueBus.adapter.is_a?(QueueBus::Adapters::TestOne)).to eq(true)
+      it 'looks up the known class' do
+        expect(QueueBus.adapter).to be_a QueueBus::Adapters::Data
+      end
     end
-  end
 
+    context 'with a custom adapter' do
+      let(:klass) do
+        Class.new(QueueBus::Adapters::Base) do
+          def enabled!
+            # no op
+          end
+
+          def redis
+            # no op
+          end
+        end
+      end
+
+      before do
+        QueueBus.adapter = klass.new
+      end
+
+      it 'sets it to something else' do
+        expect(QueueBus.adapter).to be_a klass
+      end
+    end
+
+    context 'with a class' do
+      before do
+        QueueBus.adapter = QueueBus::Adapters::Data
+      end
 
+      it 'creates a new one' do
+        expect(QueueBus.adapter).to be_a QueueBus::Adapters::Data
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'timecop'
 require 'queue-bus'
 require 'adapter/support'
@@ -33,9 +35,9 @@ module QueueBus
   end
 end
 
-def test_sub(event_name, queue="default")
-  matcher = {"bus_event_type" => event_name}
-  QueueBus::Subscription.new(queue, event_name, "::QueueBus::Rider", matcher, nil)
+def test_sub(event_name, queue = 'default')
+  matcher = { 'bus_event_type' => event_name }
+  QueueBus::Subscription.new(queue, event_name, '::QueueBus::Rider', matcher, nil)
 end
 
 def test_list(*args)
@@ -50,6 +52,7 @@ RSpec.configure do |config|
   config.mock_with :rspec do |c|
     c.syntax = :expect
   end
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
@@ -57,10 +60,12 @@ RSpec.configure do |config|
   config.before(:each) do
     reset_test_adapter
   end
+
   config.after(:each) do
     begin
-      QueueBus.redis { |redis| redis.flushall }
-    rescue
+      QueueBus.redis(&:flushall)
+    rescue RuntimeError # rubocop:disable Lint/HandleExceptions
+      # We raise if redis isn't there.
     end
     QueueBus.send(:reset)
     QueueBus::Runner1.reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue-bus
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Brian Leonard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple event bus on top of common background queues. Publish and subscribe
   to events as they occur using what you already have.
 email:
@@ -91,6 +105,7 @@ files:
 - ".gitignore"
 - ".rbenv-version"
 - ".rspec"
+- ".rubocop.yml"
 - ".rvmrc"
 - CHANGELOG.md
 - Gemfile