startback 0.11.4 → 0.12.1

data/lib/startback/support/env.rb

@@ -0,0 +1,41 @@
+module Startback
+  module Support
+    # This method provides the `env` and `env!` methods that
+    # help querying environment variables easily.
+    module Env
+
+      # Returns an environment variable or raise an error if
+      # not set.
+      #
+      # The result is always a String with no leading/trailing
+      # spaces.
+      #
+      # If a block is given, the environment variable is yield
+      # and the result of the block returned.
+      def env!(key, default = nil, &bl)
+        v = ENV[key].to_s.strip
+        raise Startback::Error, "Missing ENV var `#{key}`" if v.empty?
+
+        env(key, default, &bl)
+      end
+      module_function :env!
+
+      # Returns an environment variable or the default value
+      # passed as second argument.
+      #
+      # The result is always a String with no leading/trailing
+      # spaces.
+      #
+      # If a block is given, the environment variable is yield
+      # and the result of the block returned.
+      def env(key, default = nil, &bl)
+        v = ENV[key].to_s.strip
+        v = v.empty? ? default : v
+        v = bl.call(v) if bl && v
+        v
+      end
+      module_function :env
+
+    end # module Env
+  end # module Support
+end # module Startback

data/lib/startback/support/robustness.rb

@@ -43,7 +43,7 @@ module Startback
           @@default_logger ||= begin
             l = ::Logger.new(STDOUT)
             l.formatter = LogFormatter.new
-            l.warn(op: "#{self}", op_data: { msg: "Using default logger", trace: caller })
+            l.warn(op: "#{self}", op_data: { msg: "Using default logger to STDOUT" })
             @@default_logger = l
           end
           @@default_logger
@@ -107,8 +107,6 @@ module Startback
         }
         Tools.info(args, op_took: took)
         result
-      rescue => ex
-        raise
       end
 
       # Executes the block without letting errors propagate.

data/lib/startback/support.rb

@@ -14,6 +14,7 @@ module Startback
 
   end # module Support
 end # module Startback
+require_relative 'support/env'
 require_relative 'support/log_formatter'
 require_relative 'support/logger'
 require_relative 'support/robustness'

data/lib/startback/version.rb

@@ -1,8 +1,8 @@
 module Startback
   module Version
     MAJOR = 0
-    MINOR = 11
-    TINY  = 4
+    MINOR = 12
+    TINY  = 1
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'startback'
-require 'startback/bus'
+require 'startback/event'
 require 'startback/support/fake_logger'
 require 'rack/test'
 
@@ -10,3 +10,8 @@ end
 RSpec.configure do |c|
   c.include SpecHelpers
 end
+
+class User
+  class Changed < Startback::Event
+  end
+end

data/spec/unit/context/test_middleware.rb

@@ -10,18 +10,18 @@ module Startback
       include Rack::Test::Methods
 
       def app
-        opts = middleware_options
+        build_args = self.build_args
         Rack::Builder.new do
-          use Middleware, opts
+          use Middleware, *build_args
           run ->(env){
-            ctx = env[Startback::Context::Middleware::RACK_ENV_KEY] 
+            ctx = env[Startback::Context::Middleware::RACK_ENV_KEY]
             [200, {}, ctx.class.to_s]
           }
         end
       end
 
-      context 'when used without option' do
-        let(:middleware_options){ nil }
+      context 'when used without context' do
+        let(:build_args){ [] }
 
         it 'sets the default context class' do
           get '/'
@@ -31,9 +31,7 @@ module Startback
       end
 
       context 'when specifying the context class' do
-        let(:middleware_options){{
-          context_class: MyContextSubClass
-        }}
+        let(:build_args){ [MyContextSubClass.new] }
 
         it 'sets the default context class' do
           get '/'

data/spec/unit/event/bus/memory/test_async.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+module Startback
+  class Event
+    describe Bus::Memory do
+
+      subject{
+        Bus::Memory::Async.new
+      }
+
+      it 'allows emiting an receiving' do
+        seen = nil
+        subject.listen("user_changed") do |evt|
+          seen = evt
+        end
+        subject.emit(Event.new("user_changed", {id: 12}))
+        expect(seen).to be_a(Event)
+        expect(seen.type).to eql("user_changed")
+        expect(seen.data.to_h).to eql({id: 12})
+      end
+
+      it 'allows mixin Symbol vs. String for event type' do
+        seen = nil
+        subject.listen(:user_changed) do |evt|
+          seen = evt
+        end
+        subject.emit(Event.new(:user_changed, {id: 12}))
+        expect(seen).to be_a(Event)
+        expect(seen.type).to eql("user_changed")
+        expect(seen.data.to_h).to eql({id: 12})
+      end
+
+      it 'does not raise errors synchronously' do
+        subject.listen("user_changed") do |evt|
+          raise "An error occured"
+        end
+        expect {
+          subject.emit(Event.new("user_changed", {id: 12}))
+        }.not_to raise_error
+      end
+
+    end
+  end
+end

data/spec/unit/event/bus/memory/test_sync.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+module Startback
+  class Event
+    describe Bus::Memory do
+
+      subject{
+        Bus::Memory::Sync.new
+      }
+
+      it 'allows emiting an receiving' do
+        seen = nil
+        subject.listen("user_changed") do |evt|
+          seen = evt
+        end
+        subject.emit(Event.new("user_changed", {id: 12}))
+        expect(seen).to be_a(Event)
+        expect(seen.type).to eql("user_changed")
+        expect(seen.data.to_h).to eql({id: 12})
+      end
+
+      it 'allows mixin Symbol vs. String for event type' do
+        seen = nil
+        subject.listen(:user_changed) do |evt|
+          seen = evt
+        end
+        subject.emit(Event.new(:user_changed, {id: 12}))
+        expect(seen).to be_a(Event)
+        expect(seen.type).to eql("user_changed")
+        expect(seen.data.to_h).to eql({id: 12})
+      end
+
+      it 'raises emit errors synchronously' do
+        subject.listen("user_changed") do |evt|
+          raise "An error occured"
+        end
+        expect {
+          subject.emit(Event.new("user_changed", {id: 12}))
+        }.to raise_error("An error occured")
+      end
+
+    end
+  end
+end

data/spec/unit/support/test_env.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+module Startback
+  module Support
+    describe Env do
+      include Env
+
+      before do
+        ENV['FOO'] = 'BAR'
+        ENV['FOOL'] = ''
+        ENV['FOOLISH'] = ' BAR '
+      end
+
+      after do
+        ENV.delete('FOO')
+        ENV.delete('FOOL')
+      end
+
+      describe "env" do
+        it 'returns an env variable' do
+          expect(env('FOO')).to eql('BAR')
+        end
+
+        it 'returns nil otherwise' do
+          expect(env('BAR')).to be_nil
+        end
+
+        it 'strips the value' do
+          expect(env('FOOLISH')).to eql('BAR')
+        end
+
+        it 'yields the block if any' do
+          expect(env('FOO'){|x| x.downcase }).to eql('bar')
+        end
+
+        it 'support a default value' do
+          expect(env('BAR', 'BAZ')).to eql('BAZ')
+        end
+
+        it 'yields the block with the default if any' do
+          expect(env('BAR', 'BAZ'){|x| x.downcase }).to eql('baz')
+        end
+
+        it 'returns nil when empty' do
+          expect(env('FOOL')).to be_nil
+        end
+
+        it 'yields the block with the default if empty' do
+          expect(env('FOOL', 'BAZ'){|x| x.downcase }).to eql('baz')
+        end
+      end
+
+      describe "env!" do
+        it 'returns an env variable' do
+          expect(env!('FOO')).to eql('BAR')
+        end
+
+        it 'strips the value' do
+          expect(env!('FOOLISH')).to eql('BAR')
+        end
+
+        it 'raise otherwise' do
+          expect{ env!('BAR') }.to raise_error(Startback::Errors::Error, /BAR/)
+        end
+
+        it 'raise on empty' do
+          expect{ env!('FOOL') }.to raise_error(Startback::Errors::Error, /FOOL/)
+        end
+
+        it 'yields the block if any' do
+          expect(env('FOO'){|x| x.downcase }).to eql('bar')
+        end
+      end
+    end
+  end
+end

data/spec/unit/test_event.rb

@@ -4,7 +4,7 @@ module Startback
   describe Event do
 
     subject{
-      Event.new("user_changed", { "foo" => "bar" })
+      Event.new("User::Changed", { "foo" => "bar" })
     }
 
     it 'presents an ostruct on top of its data' do
@@ -15,7 +15,7 @@ module Startback
 
       JSON_SRC = <<-JSON.gsub(/\s+/, "")
         {
-          "type": "user_changed",
+          "type": "User::Changed",
           "data": {
             "foo": "bar"
           }
@@ -27,10 +27,10 @@ module Startback
       end
 
       it 'has a to_json that dumps the context if any' do
-        evt = Event.new("user_changed", { "foo" => "bar" }, { "baz": "context" })
+        evt = Event.new("User::Changed", { "foo" => "bar" }, { "baz": "context" })
         expect(evt.to_json).to eql(<<-JSON.gsub(/\s+/, ""))
           {
-            "type": "user_changed",
+            "type": "User::Changed",
             "data": {
               "foo": "bar"
             },
@@ -43,26 +43,16 @@ module Startback
 
 
       it 'has a json class method that works as expected' do
-        evt = Event.json(JSON_SRC)
+        evt = Event.json(JSON_SRC, nil)
         expect(evt).to be_a(Event)
-        expect(evt.type).to eql("user_changed")
+        expect(evt.type).to eql("User::Changed")
         expect(evt.data).to eql(subject.data)
       end
 
-      it 'accepts an explicit context in the world' do
-        evt = Event.json(JSON_SRC, context: 12)
+      it 'accepts an explicit context as second argument' do
+        evt = Event.json(JSON_SRC, 12)
         expect(evt.context).to eql(12)
       end
-
-      it 'accepts an context factory in the world' do
-        cf = ->(arg) {
-          expect(arg).to eql(JSON.parse(JSON_SRC))
-          12
-        }
-        evt = Event.json(JSON_SRC, context_factory: cf)
-        expect(evt.context).to eql(12)
-      end
-
     end
 
   end

data/spec/unit/web/test_catch_all.rb

@@ -53,7 +53,7 @@ module Startback
 
         def app
           Rack::Builder.new do
-            use Context::Middleware, context_class: MyContextWithErrorHandler
+            use Context::Middleware, MyContextWithErrorHandler.new
             use CatchAll
             run ->(env){ raise AnError, "Hello error" }
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: startback
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.12.1
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -385,12 +385,6 @@ files:
 - lib/startback/audit/prometheus.rb
 - lib/startback/audit/shared.rb
 - lib/startback/audit/trailer.rb
-- lib/startback/bus.rb
-- lib/startback/bus/bunny.rb
-- lib/startback/bus/bunny/async.rb
-- lib/startback/bus/memory.rb
-- lib/startback/bus/memory/async.rb
-- lib/startback/bus/memory/sync.rb
 - lib/startback/caching/entity_cache.rb
 - lib/startback/caching/no_store.rb
 - lib/startback/caching/store.rb
@@ -398,6 +392,16 @@ files:
 - lib/startback/context/middleware.rb
 - lib/startback/errors.rb
 - lib/startback/event.rb
+- lib/startback/event/agent.rb
+- lib/startback/event/bus.rb
+- lib/startback/event/bus/bunny.rb
+- lib/startback/event/bus/bunny/async.rb
+- lib/startback/event/bus/memory.rb
+- lib/startback/event/bus/memory/async.rb
+- lib/startback/event/bus/memory/sync.rb
+- lib/startback/event/engine.rb
+- lib/startback/event/ext/context.rb
+- lib/startback/event/ext/operation.rb
 - lib/startback/ext.rb
 - lib/startback/ext/date_time.rb
 - lib/startback/ext/time.rb
@@ -405,6 +409,7 @@ files:
 - lib/startback/operation/error_operation.rb
 - lib/startback/operation/multi_operation.rb
 - lib/startback/support.rb
+- lib/startback/support/env.rb
 - lib/startback/support/fake_logger.rb
 - lib/startback/support/hooks.rb
 - lib/startback/support/log_formatter.rb
@@ -428,17 +433,18 @@ files:
 - spec/spec_helper.rb
 - spec/unit/audit/test_prometheus.rb
 - spec/unit/audit/test_trailer.rb
-- spec/unit/bus/memory/test_async.rb
-- spec/unit/bus/memory/test_sync.rb
 - spec/unit/caching/test_entity_cache.rb
 - spec/unit/context/test_abstraction_factory.rb
 - spec/unit/context/test_dup.rb
 - spec/unit/context/test_h_factory.rb
 - spec/unit/context/test_middleware.rb
+- spec/unit/event/bus/memory/test_async.rb
+- spec/unit/event/bus/memory/test_sync.rb
 - spec/unit/support/hooks/test_after_hook.rb
 - spec/unit/support/hooks/test_before_hook.rb
 - spec/unit/support/operation_runner/test_around_run.rb
 - spec/unit/support/operation_runner/test_before_after_call.rb
+- spec/unit/support/test_env.rb
 - spec/unit/support/test_robusteness.rb
 - spec/unit/support/test_transaction_manager.rb
 - spec/unit/test_event.rb

data/lib/startback/bus/bunny/async.rb

@@ -1,123 +0,0 @@
-require 'bunny'
-module Startback
-  class Bus
-    module Bunny
-      #
-      # Asynchronous implementation of the bus abstraction, on top of RabbitMQ
-      # and using the 'bunny' gem (you need to include it in your Gemfile
-      # yourself: it is NOT a startback official dependency).
-      #
-      # This bus implementation emits events by dumping them to RabbitMQ using
-      # the event type as exchange name. Listeners may use the `processor`
-      # parameter to specify the queue name ; otherwise a default "main" queue
-      # is used.
-      #
-      # Examples:
-      #
-      #     # Connects to RabbitMQ using all default options
-      #     #
-      #     # Uses the STARTBACK_BUS_BUNNY_ASYNC_URL environment variable for
-      #     # connection URL if present.
-      #     Startback::Bus::Bunny::Async.new
-      #
-      #     # Connects to RabbitMQ using a specific URL
-      #     Startback::Bus::Bunny::Async.new("amqp://rabbituser:rabbitpass@192.168.17.17")
-      #     Startback::Bus::Bunny::Async.new(url: "amqp://rabbituser:rabbitpass@192.168.17.17")
-      #
-      #     # Connects to RabbitMQ using specific connection options. See Bunny's own
-      #     # documentation
-      #     Startback::Bus::Bunny::Async.new({
-      #       connection_options: {
-      #         host: "192.168.17.17"
-      #       }
-      #     })
-      #
-      class Async
-        include Support::Robustness
-
-        CHANNEL_KEY = 'Startback::Bus::Bunny::Async::ChannelKey'
-
-        DEFAULT_OPTIONS = {
-          # (optional) The URL to use for connecting to RabbitMQ.
-          url: ENV['STARTBACK_BUS_BUNNY_ASYNC_URL'],
-
-          # (optional) The options has to pass to ::Bunny constructor
-          connection_options: nil,
-
-          # (optional) The options to use for the emitter/listener fanout
-          fanout_options: {},
-
-          # (optional) The options to use for the listener queue
-          queue_options: {},
-
-          # (optional) Default event factory to use, if any
-          event_factory: nil,
-
-          # (optional) A default context to use for general logging
-          context: nil
-        }
-
-        # Creates a bus instance, using the various options provided to
-        # fine-tune behavior.
-        def initialize(options = {})
-          options = { url: options } if options.is_a?(String)
-          @options = DEFAULT_OPTIONS.merge(options)
-          retried = 0
-          conn = options[:connection_options] || options[:url]
-          try_max_times(10) do
-            @bunny = ::Bunny.new(conn)
-            @bunny.start
-            channel
-            log(:info, {op: "#{self.class.name}#connect", op_data: conn}, options[:context])
-          end
-        end
-        attr_reader :options
-
-        def channel
-          Thread.current[CHANNEL_KEY] ||= @bunny.create_channel
-        end
-
-        def emit(event)
-          stop_errors(self, "emit", event.context) do
-            fanout = channel.fanout(event.type.to_s, fanout_options)
-            fanout.publish(event.to_json)
-          end
-        end
-
-        def listen(type, processor = nil, listener = nil, &bl)
-          raise ArgumentError, "A listener must be provided" unless listener || bl
-          fanout = channel.fanout(type.to_s, fanout_options)
-          queue = channel.queue((processor || "main").to_s, queue_options)
-          queue.bind(fanout)
-          queue.subscribe do |delivery_info, properties, body|
-            event = stop_errors(self, "listen") do
-              factor_event(body)
-            end
-            stop_errors(self, "listen", event.context) do
-              (listener || bl).call(event)
-            end
-          end
-        end
-
-      protected
-
-        def fanout_options
-          options[:fanout_options]
-        end
-
-        def queue_options
-          options[:queue_options]
-        end
-
-        def factor_event(body)
-          if options[:event_factory]
-            options[:event_factory].call(body)
-          else
-            Event.json(body, options)
-          end
-        end
-
-      end # class Async
-    end # module Bunny
-  end # class Bus
-end # module Klaro

data/lib/startback/bus/memory/async.rb

@@ -1,40 +0,0 @@
-module Startback
-  class Bus
-    module Memory
-      #
-      # Asynchronous implementation of the Bus abstraction, for use between
-      # components sharing the same process.
-      #
-      # This implementation actually calls listeners synchronously (it mays)
-      # but hides error raised by them. See Bus::Bunny::Async for another
-      # implementation that is truly asynchronous and relies on RabbitMQ.
-      #
-      class Async
-        include Support::Robustness
-
-        DEFAULT_OPTIONS = {
-        }
-
-        def initialize(options = {})
-          @options = DEFAULT_OPTIONS.merge(options)
-          @listeners = {}
-        end
-
-        def emit(event)
-          (@listeners[event.type.to_s] || []).each do |l|
-            stop_errors(self, "emit", event) {
-              l.call(event)
-            }
-          end
-        end
-
-        def listen(type, processor = nil, listener = nil, &bl)
-          raise ArgumentError, "A listener must be provided" unless listener || bl
-          @listeners[type.to_s] ||= []
-          @listeners[type.to_s] << (listener || bl)
-        end
-
-      end # class Sync
-    end # module Memory
-  end # class Bus
-end # module Klaro

data/lib/startback/bus/memory/sync.rb

@@ -1,30 +0,0 @@
-module Startback
-  class Bus
-    module Memory
-      #
-      # Synchronous implementation of the Bus abstraction, for use between
-      # components sharing the same process.
-      #
-      class Sync
-        include Support::Robustness
-
-        def initialize
-          @listeners = {}
-        end
-
-        def emit(event)
-          (@listeners[event.type.to_s] || []).each do |l|
-            l.call(event)
-          end
-        end
-
-        def listen(type, processor = nil, listener = nil, &bl)
-          raise ArgumentError, "A listener must be provided" unless listener || bl
-          @listeners[type.to_s] ||= []
-          @listeners[type.to_s] << (listener || bl)
-        end
-
-      end # class Sync
-    end # module Memory
-  end # class Bus
-end # module Klaro