sequent 3.2.2 → 4.0.0

data/lib/sequent/rake/migration_tasks.rb

@@ -55,7 +55,7 @@ module Sequent
 
             def create_event_store(db_config)
               event_store_schema = Sequent.configuration.event_store_schema_name
-              sequent_schema = File.join(Sequent.configuration.database_config_directory, "#{event_store_schema}.rb")
+              sequent_schema = File.join(Sequent.configuration.database_schema_directory, "#{event_store_schema}.rb")
               fail "File #{sequent_schema} does not exist. Check your Sequent configuration." unless File.exists?(sequent_schema)
 
               Sequent::Support::Database.establish_connection(db_config)
@@ -117,7 +117,7 @@ module Sequent
             end
 
             task :delete_all => ['sequent:init', :init] do
-              result = ActiveRecord::Base.connection.execute("DELETE FROM #{Sequent.configuration.event_record_class.table_name} WHERE event_type = 'Sequent::Core::SnapshotEvent'")
+              result = Sequent::ApplicationRecord.connection.execute("DELETE FROM #{Sequent.configuration.event_record_class.table_name} WHERE event_type = 'Sequent::Core::SnapshotEvent'")
               Sequent.logger.info "Deleted #{result.cmd_tuples} aggregate snapshots from the event store"
             end
           end

data/lib/sequent/rake/tasks.rb

@@ -57,7 +57,7 @@ module Sequent
 
           task :establish_connection do
             env_db = db_config(options.fetch(:environment))
-            Sequent::Support::Database.establish_connection(env_db)
+            ActiveRecord::Base.establish_connection(env_db)
           end
 
           desc 'Migrate the database'

data/lib/sequent/sequent.rb

@@ -6,7 +6,7 @@ require_relative 'core/aggregate_root'
 require_relative 'core/projector'
 require_relative 'core/workflow'
 require_relative 'core/value_object'
-require_relative 'generator'
+require_relative 'migrations/migrations'
 
 module Sequent
   def self.new_uuid
@@ -64,6 +64,10 @@ module Sequent
     configuration.aggregate_repository
   end
 
+  def self.dry_run(*commands)
+    Sequent::Util::DryRun.these_commands(commands)
+  end
+
   # Shortcut classes for easy usage
   Event = Sequent::Core::Event
   Command = Sequent::Core::Command

data/lib/sequent/support/database.rb

@@ -47,7 +47,7 @@ module Sequent
       def self.create_schema(schema)
         sql = "CREATE SCHEMA IF NOT EXISTS #{schema}"
         if user = ActiveRecord::Base.connection_config[:username]
-          sql += " AUTHORIZATION #{user}"
+          sql += %Q{ AUTHORIZATION "#{user}"}
         end
         execute_sql(sql)
       end
@@ -61,12 +61,16 @@ module Sequent
 
         disconnect!
         original_search_paths = db_config['schema_search_path'].dup
-        ActiveRecord::Base.configurations[env.to_s] = ActiveSupport::HashWithIndifferentAccess.new(db_config).stringify_keys
+
+        if ActiveRecord::VERSION::MAJOR < 6
+          ActiveRecord::Base.configurations[env.to_s] = ActiveSupport::HashWithIndifferentAccess.new(db_config).stringify_keys
+        end
+
         db_config['schema_search_path'] = search_path
+
         ActiveRecord::Base.establish_connection db_config
 
         yield
-
       ensure
         disconnect!
         db_config['schema_search_path'] = original_search_paths
@@ -95,14 +99,15 @@ module Sequent
         self.class.execute_sql(sql)
       end
 
-      def migrate(migrations_path, verbose: true)
+      def migrate(migrations_path, schema_migration: ActiveRecord::SchemaMigration, verbose: true)
         ActiveRecord::Migration.verbose = verbose
-        if ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 2
+        if ActiveRecord::VERSION::MAJOR >= 6
+          ActiveRecord::MigrationContext.new([migrations_path], schema_migration).up
+        elsif ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 2
           ActiveRecord::MigrationContext.new([migrations_path]).up
         else
           ActiveRecord::Migrator.migrate(migrations_path)
         end
-
       end
     end
   end

data/lib/sequent/test/command_handler_helpers.rb

@@ -92,6 +92,10 @@ module Sequent
           @event_streams.has_key?(aggregate_id)
         end
 
+        def events_exists?(aggregate_id)
+          @event_streams[aggregate_id].present?
+        end
+
         private
 
         def to_event_streams(events)

data/lib/sequent/util/dry_run.rb

@@ -0,0 +1,191 @@
+require_relative '../test/command_handler_helpers'
+
+module Sequent
+  module Util
+    ##
+    # Dry run provides the ability to inspect what would
+    # happen if the given commands would be executed
+    # without actually committing the results.
+    # You can inspect which commands are executed
+    # and what the resulting events would be
+    # with theSequent::Projector's and Sequent::Workflow's
+    # that would be invoked (without actually invoking them).
+    #
+    # Since the Workflow's are not actually invoked new commands
+    # resulting from this Workflow will of course not be in the result.
+    #
+    # Caution: Since the Sequent Configuration is shared between threads this method
+    # is not Thread safe.
+    #
+    # Example usage:
+    #
+    #   result = Sequent.dry_run(create_foo_command, ping_foo_command)
+    #
+    #   result.print(STDOUT)
+    #
+    module DryRun
+      EventInvokedHandler = Struct.new(:event, :handler)
+
+      ##
+      # Proxies the given EventStore implements commit_events
+      # that instead of publish and store just publishes the events.
+      class EventStoreProxy
+        attr_reader :command_with_events, :event_store
+
+        delegate :load_events_for_aggregates,
+          :load_events,
+          :publish_events,
+          :stream_exists?,
+          to: :event_store
+
+        def initialize(result)
+          @event_store = Sequent::Test::CommandHandlerHelpers::FakeEventStore.new
+          @command_with_events = {}
+          @result = result
+        end
+
+        def commit_events(command, streams_with_events)
+          event_store.commit_events(command, streams_with_events)
+
+          new_events = streams_with_events.flat_map { |_, events| events }
+          @result.published_command_with_events(command, new_events)
+        end
+      end
+
+      ##
+      # Records which Projector's and Workflow's are executed
+      #
+      class RecordingEventPublisher < Sequent::Core::EventPublisher
+        attr_reader :projectors, :workflows
+
+        def initialize(result)
+          @result = result
+        end
+
+        def process_event(event)
+          Sequent.configuration.event_handlers.each do |handler|
+            next unless handler.class.handles_message?(event)
+
+            if handler.is_a?(Sequent::Workflow)
+              @result.invoked_workflow(EventInvokedHandler.new(event, handler.class))
+            elsif handler.is_a?(Sequent::Projector)
+              @result.invoked_projector(EventInvokedHandler.new(event, handler.class))
+            else
+              fail "Unrecognized event_handler #{handler.class} called for event #{event.class}"
+            end
+          rescue
+            raise PublishEventError.new(handler.class, event)
+          end
+        end
+      end
+
+      ##
+      # Contains the result of a dry run.
+      #
+      # @see #tree
+      # @see #print
+      #
+      class Result
+        EventCalledHandlers = Struct.new(:event, :projectors, :workflows)
+
+        def initialize
+          @command_with_events = {}
+          @event_invoked_projectors = []
+          @event_invoked_workflows = []
+        end
+
+        def invoked_projector(event_invoked_handler)
+          event_invoked_projectors << event_invoked_handler
+        end
+
+        def invoked_workflow(event_invoked_handler)
+          event_invoked_workflows << event_invoked_handler
+        end
+
+        def published_command_with_events(command, events)
+          command_with_events[command] = events
+        end
+
+        ##
+        # Returns the command with events as a tree structure.
+        #
+        # {
+        #   command => [
+        #     EventCalledHandlers,
+        #     EventCalledHandlers,
+        #     EventCalledHandlers,
+        #   ]
+        # }
+        #
+        # The EventCalledHandlers contains an Event with the
+        # lists of `Sequent::Projector`s and `Sequent::Workflow`s
+        # that were called.
+        #
+        def tree
+          command_with_events.reduce({}) do |memo, (command, events)|
+            events_to_handlers = events.map do |event|
+              for_current_event = ->(pair) { pair.event == event }
+              EventCalledHandlers.new(
+                event,
+                event_invoked_projectors.select(&for_current_event).map(&:handler),
+                event_invoked_workflows.select(&for_current_event).map(&:handler),
+              )
+            end
+            memo[command] = events_to_handlers
+            memo
+          end
+        end
+
+        ##
+        # Prints the output from #tree to the given `io`
+        #
+        def print(io)
+          tree.each_with_index do |(command, event_called_handlerss), index|
+            io.puts "+++++++++++++++++++++++++++++++++++" if index == 0
+            io.puts "Command: #{command.class} resulted in #{event_called_handlerss.length} events"
+            event_called_handlerss.each_with_index do |event_called_handlers, i|
+              io.puts "" if i > 0
+              io.puts "-- Event #{event_called_handlers.event.class} was handled by:"
+              io.puts "-- Projectors: [#{event_called_handlers.projectors.join(', ')}]"
+              io.puts "-- Workflows: [#{event_called_handlers.workflows.join(', ')}]"
+            end
+
+            io.puts "+++++++++++++++++++++++++++++++++++"
+          end
+        end
+
+        private
+
+        attr_reader :command_with_events, :event_invoked_projectors, :event_invoked_workflows
+      end
+
+      ##
+      # Main method of the DryRun.
+      #
+      # Caution: Since the Sequent Configuration is changed and is shared between threads this method
+      # is not Thread safe.
+      #
+      # After invocation the sequent configuration is reset to the state it was before
+      # invoking this method.
+      #
+      # @param commands - the commands to dry run
+      # @return Result - the Result of the dry run. See Result.
+      #
+      def self.these_commands(commands)
+        current_event_store = Sequent.configuration.event_store
+        current_event_publisher = Sequent.configuration.event_publisher
+        result = Result.new
+
+        Sequent.configuration.event_store = EventStoreProxy.new(result)
+        Sequent.configuration.event_publisher = RecordingEventPublisher.new(result)
+
+        Sequent.command_service.execute_commands(*commands)
+
+        result
+      ensure
+        Sequent.configuration.event_store = current_event_store
+        Sequent.configuration.event_publisher = current_event_publisher
+      end
+    end
+  end
+end

data/lib/sequent/util/skip_if_already_processing.rb

@@ -1,15 +1,29 @@
 module Sequent
   module Util
-    def self.skip_if_already_processing(already_processing_key, &block)
-      return if Thread.current[already_processing_key]
+    ##
+    # Returns if the current Thread is already processing work
+    # given the +processing_key+ otherwise
+    # it yields the given +&block+.
+    #
+    # Useful in a Queue and Processing strategy
+    def self.skip_if_already_processing(processing_key, &block)
+      return if Thread.current[processing_key]
 
       begin
-        Thread.current[already_processing_key] = true
+        Thread.current[processing_key] = true
 
-        block.yield
+        yield
       ensure
-        Thread.current[already_processing_key] = nil
+        Thread.current[processing_key] = nil
       end
     end
+
+    ##
+    # Reset the given +processing_key+ for the current Thread.
+    #
+    # Usefull to make a block protected by +skip_if_already_processing+ reentrant.
+    def self.done_processing(processing_key)
+      Thread.current[processing_key] = nil
+    end
   end
 end

data/lib/sequent/util/util.rb

@@ -1,3 +1,4 @@
 require_relative 'skip_if_already_processing'
 require_relative 'timer'
 require_relative 'printer'
+require_relative 'dry_run'

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Sequent
-  VERSION = '3.2.2'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Lars Vonk
@@ -9,10 +9,10 @@ authors:
 - Erik Rozendaal
 - Mike van Diepen
 - Stephan van Diepen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -23,7 +23,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 6.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -33,7 +33,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 6.0.4
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 6.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,21 +53,21 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 6.0.4
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: postgresql_cursor
   requirement: !ruby/object:Gem::Requirement
@@ -88,42 +88,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: '1.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -142,30 +142,64 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.6.5
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -186,70 +220,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.21'
 description: Sequent is a CQRS and event sourcing framework for Ruby.
 email:
 - lars.vonk@gmail.com
@@ -264,7 +298,9 @@ extra_rdoc_files: []
 files:
 - bin/sequent
 - db/sequent_schema.rb
+- lib/notices.rb
 - lib/sequent.rb
+- lib/sequent/application_record.rb
 - lib/sequent/configuration.rb
 - lib/sequent/core/aggregate_repository.rb
 - lib/sequent/core/aggregate_root.rb
@@ -318,6 +354,7 @@ files:
 - lib/sequent/generator/aggregate.rb
 - lib/sequent/generator/command.rb
 - lib/sequent/generator/event.rb
+- lib/sequent/generator/generator.rb
 - lib/sequent/generator/project.rb
 - lib/sequent/generator/template_aggregate/template_aggregate.rb
 - lib/sequent/generator/template_aggregate/template_aggregate/commands.rb
@@ -344,9 +381,13 @@ files:
 - lib/sequent/generator/template_project/spec/app/projectors/post_projector_spec.rb
 - lib/sequent/generator/template_project/spec/lib/post/post_command_handler_spec.rb
 - lib/sequent/generator/template_project/spec/spec_helper.rb
+- lib/sequent/migrations/executor.rb
+- lib/sequent/migrations/functions.rb
 - lib/sequent/migrations/migrate_events.rb
 - lib/sequent/migrations/migrations.rb
+- lib/sequent/migrations/planner.rb
 - lib/sequent/migrations/projectors.rb
+- lib/sequent/migrations/sql.rb
 - lib/sequent/migrations/view_schema.rb
 - lib/sequent/rake/migration_tasks.rb
 - lib/sequent/rake/tasks.rb
@@ -360,6 +401,7 @@ files:
 - lib/sequent/test/event_handler_helpers.rb
 - lib/sequent/test/event_stream_helpers.rb
 - lib/sequent/test/time_comparison.rb
+- lib/sequent/util/dry_run.rb
 - lib/sequent/util/printer.rb
 - lib/sequent/util/skip_if_already_processing.rb
 - lib/sequent/util/timer.rb
@@ -369,7 +411,7 @@ homepage: https://github.com/zilverline/sequent
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -377,16 +419,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Event sourcing framework for Ruby
 test_files: []