sequent 4.0.0 → 4.3.0

data/lib/sequent/core/stream_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 module Sequent
@@ -14,8 +16,7 @@ module Sequent
     end
 
     class StreamRecord < Sequent::ApplicationRecord
-
-      self.table_name = "stream_records"
+      self.table_name = 'stream_records'
 
       validates_presence_of :aggregate_type, :aggregate_id
       validates_numericality_of :snapshot_threshold, only_integer: true, greater_than: 0, allow_nil: true
@@ -23,7 +24,12 @@ module Sequent
       has_many :event_records
 
       def event_stream
-        EventStream.new(aggregate_type: aggregate_type, aggregate_id: aggregate_id, snapshot_threshold: snapshot_threshold, stream_record_id: id)
+        EventStream.new(
+          aggregate_type: aggregate_type,
+          aggregate_id: aggregate_id,
+          snapshot_threshold: snapshot_threshold,
+          stream_record_id: id,
+        )
       end
 
       def event_stream=(data)

data/lib/sequent/core/transactions/active_record_transaction_provider.rb

@@ -1,15 +1,37 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Transactions
-
+      ##
+      # Always require a new transaction.
+      #
+      # Read:
+      # http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html
+      #
+      # Without this change, there is a potential bug:
+      #
+      # ```ruby
+      # ActiveRecord::Base.transaction do
+      #   Sequent.configuration.command_service.execute_commands command
+      # end
+      #
+      # on Command do
+      #   do.some.things
+      #   fail ActiveRecord::Rollback
+      # end
+      # ```
+      #
+      # In this example, you might be surprised to find that `do.some.things`
+      # does not get rolled back! This is because AR doesn't automatically make
+      # a "savepoint" for us when we call `.transaction` in a nested manner. In
+      # order to enable this behaviour, we have to call `.transaction` like
+      # this: `.transaction(requires_new: true)`.
+      #
       class ActiveRecordTransactionProvider
-        def transactional
-          Sequent::ApplicationRecord.transaction(requires_new: true) do
-            yield
-          end
-          while(!after_commit_queue.empty?) do
-            after_commit_queue.pop.call
-          end
+        def transactional(&block)
+          Sequent::ApplicationRecord.transaction(requires_new: true, &block)
+          after_commit_queue.pop.call until after_commit_queue.empty?
         ensure
           clear_after_commit_queue
         end
@@ -28,7 +50,6 @@ module Sequent
           after_commit_queue.clear
         end
       end
-
     end
   end
 end

data/lib/sequent/core/transactions/no_transactions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sequent
   module Core
     module Transactions
@@ -11,7 +13,6 @@ module Sequent
           yield
         end
       end
-
     end
   end
 end

data/lib/sequent/core/transactions/read_only_active_record_transaction_provider.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sequent
+  module Core
+    module Transactions
+      class ReadOnlyActiveRecordTransactionProvider
+        def initialize(transaction_provider)
+          @transaction_provider = transaction_provider
+        end
+
+        def transactional(&block)
+          register_call
+          @transaction_provider.transactional do
+            Sequent::ApplicationRecord.connection.execute('SET TRANSACTION READ ONLY')
+            block.call
+          rescue ActiveRecord::StatementInvalid
+            @skip_set_transaction = true
+            raise
+          ensure
+            deregister_call
+            reset_stack_size if stack_size == 0
+          end
+        end
+
+        private
+
+        def stack_size
+          Thread.current[:read_only_active_record_transaction_provider_calls]
+        end
+
+        def register_call
+          Thread.current[:read_only_active_record_transaction_provider_calls] ||= 0
+          Thread.current[:read_only_active_record_transaction_provider_calls] += 1
+        end
+
+        def deregister_call
+          Thread.current[:read_only_active_record_transaction_provider_calls] -= 1
+        end
+
+        def reset_stack_size
+          Thread.current[:read_only_active_record_transaction_provider_calls] = nil
+        end
+      end
+    end
+  end
+end

data/lib/sequent/core/transactions/transactions.rb

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'active_record_transaction_provider'
 require_relative 'no_transactions'
+require_relative 'read_only_active_record_transaction_provider'

data/lib/sequent/core/value_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require_relative 'helpers/string_support'
 require_relative 'helpers/equal_support'
@@ -6,7 +8,6 @@ require_relative 'helpers/attribute_support'
 require_relative 'helpers/param_support'
 
 module Sequent
-
   module Core
     #
     # ValueObject is a container for data that belongs together but requires no identity
@@ -26,20 +27,17 @@ module Sequent
     #
     # This a deep clone of the address with the street attribute containing "New Street"
     class ValueObject
-      include Sequent::Core::Helpers::StringSupport,
-              Sequent::Core::Helpers::EqualSupport,
-              Sequent::Core::Helpers::Copyable,
-              Sequent::Core::Helpers::AttributeSupport,
-              Sequent::Core::Helpers::ParamSupport,
-              ActiveModel::Validations
+      include ActiveModel::Validations
+      include Sequent::Core::Helpers::ParamSupport
+      include Sequent::Core::Helpers::AttributeSupport
+      include Sequent::Core::Helpers::Copyable
+      include Sequent::Core::Helpers::EqualSupport
+      include Sequent::Core::Helpers::StringSupport
       include Sequent::Core::Helpers::TypeConversionSupport
 
       def initialize(args = {})
         update_all_attributes args
       end
-
     end
-
   end
 end
-

data/lib/sequent/core/workflow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'helpers/message_handler'
 require_relative 'current_event'
 
@@ -6,12 +8,17 @@ module Sequent
     class Workflow
       include Helpers::MessageHandler
 
+      def self.inherited(subclass)
+        super
+        Workflows << subclass
+      end
+
       def self.on(*message_classes, &block)
         decorated_block = ->(event) do
           begin
             old_event = CurrentEvent.current
             CurrentEvent.current = event
-            self.instance_exec(event, &block)
+            instance_exec(event, &block)
           ensure
             CurrentEvent.current = old_event
           end
@@ -31,12 +38,35 @@ module Sequent
       # jobs processor is not using the same database connection
       # to enqueue jobs.
       def after_commit(ignore_errors: false, &block)
-        Sequent.configuration.transaction_provider.after_commit &block
-      rescue StandardError => error
+        Sequent.configuration.transaction_provider.after_commit(&block)
+      rescue StandardError => e
         if ignore_errors
-          Sequent.logger.warn("An exception was raised in an after_commit hook: #{error}, #{error.inspect}")
+          Sequent.logger.warn("An exception was raised in an after_commit hook: #{e}, #{e.inspect}")
         else
-          raise error
+          raise e
+        end
+      end
+    end
+
+    #
+    # Utility class containing all subclasses of Workflow
+    #
+    class Workflows
+      class << self
+        def workflows
+          @workflows ||= []
+        end
+
+        def all
+          workflows
+        end
+
+        def <<(workflow)
+          workflows << workflow
+        end
+
+        def find(workflow_name)
+          workflows.find { |c| c.name == workflow_name }
         end
       end
     end

data/lib/sequent/generator/aggregate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'active_support'
 require 'active_support/core_ext/string'
@@ -7,8 +9,6 @@ class TargetAlreadyExists < StandardError; end
 module Sequent
   module Generator
     class Aggregate
-      attr_reader :name
-
       def initialize(name)
         @name = name
       end
@@ -20,6 +20,10 @@ module Sequent
         replace_template_aggregate
       end
 
+      def name
+        @name ||= File.basename(path)
+      end
+
       private
 
       def copy_files
@@ -30,8 +34,14 @@ module Sequent
         FileUtils.mv("#{path}/template_aggregate.rb", "#{path}/#{name_underscored}.rb")
         FileUtils.mv("#{path}/template_aggregate", "#{path}/#{name_underscored}")
 
-        FileUtils.mv("#{path}/#{name_underscored}/template_aggregate_command_handler.rb", "#{path}/#{name_underscored}/#{name_underscored}_command_handler.rb")
-        FileUtils.mv("#{path}/#{name_underscored}/template_aggregate.rb", "#{path}/#{name_underscored}/#{name_underscored}.rb")
+        FileUtils.mv(
+          "#{path}/#{name_underscored}/template_aggregate_command_handler.rb",
+          "#{path}/#{name_underscored}/#{name_underscored}_command_handler.rb",
+        )
+        FileUtils.mv(
+          "#{path}/#{name_underscored}/template_aggregate.rb",
+          "#{path}/#{name_underscored}/#{name_underscored}.rb",
+        )
       end
 
       def replace_template_aggregate
@@ -46,11 +56,7 @@ module Sequent
       end
 
       def path
-        @path ||= File.expand_path("lib")
-      end
-
-      def name
-        @name ||= File.basename(path)
+        @path ||= File.expand_path('lib')
       end
 
       def name_underscored
@@ -63,7 +69,7 @@ module Sequent
 
       def ensure_not_used!
         if File.directory?("#{path}/#{name_underscored}") || File.exist?("#{path}/#{name_underscored}.rb")
-          raise TargetAlreadyExists
+          fail TargetAlreadyExists
         end
       end
     end

data/lib/sequent/generator/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'active_support'
 require 'active_support/core_ext/string'
@@ -9,12 +11,12 @@ class NoAggregateFound < StandardError; end
 module Sequent
   module Generator
     class Command
-      attr_reader :name, :command, :attrs
+      attr_reader :command, :attrs
 
       def initialize(name, command, attrs)
         @name = name
         @command = command
-        @attrs = attrs.map{|a| a.split(':')}
+        @attrs = attrs.map { |a| a.split(':') }
       end
 
       def execute
@@ -22,32 +24,39 @@ module Sequent
         add_command_to_aggregate
       end
 
+      def name
+        @name ||= File.basename(path)
+      end
+
       private
+
       def append_command_handler
         ast = Parser::CurrentRuby.parse(File.read("#{path_to_dir}/#{name_underscored}_command_handler.rb"))
         target_cursor_position = find_target_cursor_position(ast)
-        
+
         File.open("#{path_to_dir}/#{name_underscored}_command_handler.rb", 'r+') do |f|
           f.seek(target_cursor_position, IO::SEEK_SET)
           lines_to_be_overwritten = f.read
           f.seek(target_cursor_position, IO::SEEK_SET)
-          f << command_handler_template.result(binding).gsub(/^.+(\s)$/) { |x| x.gsub!($1, '')}
+          f << command_handler_template.result(binding).gsub(/^.+(\s)$/) { |x| x.gsub!(Regexp.last_match(1), '') }
           f << lines_to_be_overwritten
         end
       end
 
       def find_target_cursor_position(ast)
         return unless ast.children.any?
+        return if ast.children.any? { |c| c.class.to_s != 'Parser::AST::Node' }
+        if (child = ast.children.find { |c| c.type.to_s == 'block' })
+          return child.loc.expression.end_pos
+        end
 
-        ast.children.map do |child|
-          return if child.class.to_s != "Parser::AST::Node"
-          return child.loc.expression.end_pos if child.type.to_s == 'block'
-          find_target_cursor_position(child)
-        end.flatten.compact.max
+        ast.children.map do |c|
+          find_target_cursor_position(c)
+        end&.flatten&.compact&.max
       end
 
       def append_command
-        File.open("#{path_to_dir}/commands.rb", "a") { |f| f << command_template.result(binding) }
+        File.open("#{path_to_dir}/commands.rb", 'a') { |f| f << command_template.result(binding) }
       end
 
       def add_command_to_aggregate
@@ -56,11 +65,7 @@ module Sequent
       end
 
       def path
-        @path ||= File.expand_path("lib")
-      end
-
-      def name
-        @name ||= File.basename(path)
+        @path ||= File.expand_path('lib')
       end
 
       def name_underscored
@@ -72,17 +77,19 @@ module Sequent
       end
 
       def ensure_existing_aggregate!
-        if !File.directory?(path_to_dir) || !File.exist?("#{path_to_dir}/#{name_underscored}_command_handler.rb") || !File.exist?("#{path_to_dir}/commands.rb")
-          raise NoAggregateFound
+        if !File.directory?(path_to_dir) ||
+           !File.exist?("#{path_to_dir}/#{name_underscored}_command_handler.rb") ||
+           !File.exist?("#{path_to_dir}/commands.rb")
+          fail NoAggregateFound
         end
       end
 
       def command_template
-        ERB.new(File.read(File.join( File.dirname(__FILE__), 'template_command.erb' )))
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'template_command.erb')))
       end
 
       def command_handler_template
-        ERB.new(File.read(File.join( File.dirname(__FILE__), 'template_command_handler.erb' )))
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'template_command_handler.erb')))
       end
     end
   end

data/lib/sequent/generator/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'active_support'
 require 'active_support/core_ext/string'
@@ -7,12 +9,16 @@ class NoAggregateFound < StandardError; end
 module Sequent
   module Generator
     class Event
-      attr_reader :name, :event, :attrs
+      attr_reader :event, :attrs
 
       def initialize(name, event, attrs)
         @name = name
         @event = event
-        @attrs = attrs.map{|a| a.split(':')}
+        @attrs = attrs.map { |a| a.split(':') }
+      end
+
+      def name
+        @name ||= File.basename(path)
       end
 
       def execute
@@ -23,29 +29,31 @@ module Sequent
       private
 
       def append_event
-        File.open("#{path_to_dir}/events.rb", "a") { |f| f << event_template.result(binding) }
+        File.open("#{path_to_dir}/events.rb", 'a') { |f| f << event_template.result(binding) }
       end
 
       def append_event_to_domain
         ast = Parser::CurrentRuby.parse(File.read("#{path_to_dir}/#{name_underscored}.rb"))
         target_cursor_position = find_target_cursor_position(ast)
-        
+
         File.open("#{path_to_dir}/#{name_underscored}.rb", 'r+') do |f|
           f.seek(target_cursor_position, IO::SEEK_SET)
           lines_to_be_overwritten = f.read
           f.seek(target_cursor_position, IO::SEEK_SET)
-          f << event_handler_template.result(binding).gsub(/^.+(\s)$/) { |x| x.gsub!($1, '')}
+          f << event_handler_template.result(binding).gsub(/^.+(\s)$/) { |x| x.gsub!(Regexp.last_match(1), '') }
           f << lines_to_be_overwritten
         end
       end
 
       def find_target_cursor_position(ast)
         return unless ast.children.any?
+        return if ast.children.any? { |c| c.class.to_s != 'Parser::AST::Node' }
+        if (child = ast.children.find { |c| c.type.to_s == 'block' })
+          return child.loc.expression.end_pos
+        end
 
-        ast.children.reverse.map do |child|
-          return if child.class.to_s != "Parser::AST::Node"
-          return child.loc.expression.end_pos if child.type.to_s == 'block'
-          find_target_cursor_position(child)
+        ast.children.reverse.map do |c|
+          find_target_cursor_position(c)
         end.flatten.compact.max
       end
 
@@ -55,11 +63,7 @@ module Sequent
       end
 
       def path
-        @path ||= File.expand_path("lib")
-      end
-
-      def name
-        @name ||= File.basename(path)
+        @path ||= File.expand_path('lib')
       end
 
       def name_underscored
@@ -71,9 +75,7 @@ module Sequent
       end
 
       def ensure_existing_aggregate!
-        if !File.directory?(path_to_dir) || !File.exist?("#{path_to_dir}/#{name_underscored}.rb")
-          raise NoAggregateFound
-        end
+        fail NoAggregateFound if !File.directory?(path_to_dir) || !File.exist?("#{path_to_dir}/#{name_underscored}.rb")
       end
 
       def event_template

data/lib/sequent/generator/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'aggregate'
 require_relative 'command'
 require_relative 'project'

data/lib/sequent/generator/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'active_support'
 require 'active_support/core_ext/string'
@@ -12,6 +14,7 @@ module Sequent
       def execute
         make_directory
         copy_files
+        rename_ruby_version
         rename_app_file
         replace_app_name
       end
@@ -26,6 +29,12 @@ module Sequent
         FileUtils.copy_entry(File.expand_path('template_project', __dir__), path)
       end
 
+      # Hidden files are by default excluded from gem build.
+      # Therefor we need to rename the ruby-version to .ruby-version.
+      def rename_ruby_version
+        FileUtils.mv("#{path}/ruby-version", "#{path}/.ruby-version")
+      end
+
       def rename_app_file
         FileUtils.mv("#{path}/my_app.rb", "#{path}/#{name_underscored}.rb")
       end

data/lib/sequent/generator/template_project/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
-ruby "2.6.5"
+ruby "3.0.0"
 
 gem 'rake'
 # let's use the latest and greatest

data/lib/sequent/generator/template_project/ruby-version

@@ -0,0 +1 @@
+3.0.0

data/lib/sequent/generator.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative './generator/generator'

data/lib/sequent/migrations/executor.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'sql'
 
 module Sequent
   module Migrations
-
     ##
     # The executor is the implementation of the 3-phase deploy in Sequent.
     # is responsible for executing the `Planner::Plan`.
@@ -25,18 +26,22 @@ module Sequent
         plan.replay_tables.each do |migration|
           table = migration.record_class
           original_table_name = table.table_name.gsub("_#{migration.version}", '')
-          indexes_file_name = "#{Sequent.configuration.migration_sql_files_directory}/#{original_table_name}.indexes.sql"
-          if File.exist?(indexes_file_name)
-            statements = sql_file_to_statements(indexes_file_name) { |raw_sql| raw_sql.gsub('%SUFFIX%', "_#{migration.version}") }
-            statements.each(&method(:exec_sql))
+          indexes_file_name = <<~EOS.chomp
+            #{Sequent.configuration.migration_sql_files_directory}/#{original_table_name}.indexes.sql
+          EOS
+          next unless File.exist?(indexes_file_name)
+
+          statements = sql_file_to_statements(indexes_file_name) do |raw_sql|
+            raw_sql.gsub('%SUFFIX%', "_#{migration.version}")
           end
+          statements.each(&method(:exec_sql))
         end
       end
 
       def execute_offline(plan, current_version)
         plan.replay_tables.each do |migration|
           table = migration.record_class
-          current_table_name = table.table_name.gsub("_#{migration.version}", "")
+          current_table_name = table.table_name.gsub("_#{migration.version}", '')
           # 2 Rename old table
           exec_sql("ALTER TABLE IF EXISTS #{current_table_name} RENAME TO #{current_table_name}_#{current_version}")
           # 3 Rename new table
@@ -48,7 +53,9 @@ module Sequent
 
         plan.alter_tables.each do |migration|
           table = migration.record_class
-          sql_file = "#{Sequent.configuration.migration_sql_files_directory}/#{table.table_name}_#{migration.version}.sql"
+          sql_file = <<~EOS.chomp
+            #{Sequent.configuration.migration_sql_files_directory}/#{table.table_name}_#{migration.version}.sql
+          EOS
           statements = sql_file_to_statements(sql_file)
           statements.each(&method(:exec_sql))
         end
@@ -57,7 +64,7 @@ module Sequent
       def reset_table_names(plan)
         plan.replay_tables.each do |migration|
           table = migration.record_class
-          table.table_name = table.table_name.gsub("_#{migration.version}", "")
+          table.table_name = table.table_name.gsub("_#{migration.version}", '')
           table.reset_column_information
         end
       end
@@ -65,14 +72,16 @@ module Sequent
       def set_table_names_to_new_version(plan)
         plan.replay_tables.each do |migration|
           table = migration.record_class
-          unless table.table_name.end_with?("_#{migration.version}")
-            table.table_name = "#{table.table_name}_#{migration.version}"
-            table.reset_column_information
-            fail MigrationError.new("Table #{table.table_name} does not exist. Did you run ViewSchema.migrate_online first?") unless table.table_exists?
+          next if table.table_name.end_with?("_#{migration.version}")
+
+          table.table_name = "#{table.table_name}_#{migration.version}"
+          table.reset_column_information
+          unless table.table_exists?
+            fail MigrationError,
+                 "Table #{table.table_name} does not exist. Did you run ViewSchema.migrate_online first?"
           end
         end
       end
-
     end
   end
 end