sequent 4.0.0 → 4.1.0

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'

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.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

data/lib/sequent/migrations/functions.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Sequent
   module Migrations
     class Migration
-
       module ClassMethods
         def create(record_class, version)
           migration = new(record_class)
@@ -11,6 +12,7 @@ module Sequent
       end
 
       def self.inherited(child_class)
+        super
         class << child_class
           include ClassMethods
         end
@@ -35,11 +37,11 @@ module Sequent
       def ==(other)
         return false unless other.class == self.class
 
-        self.table_name == other.table_name && version == other.version
+        table_name == other.table_name && version == other.version
       end
 
       def hash
-        self.table_name.hash + (version&.hash || 0)
+        table_name.hash + (version&.hash || 0)
       end
     end
 
@@ -48,7 +50,6 @@ module Sequent
     class ReplayTable < Migration; end
 
     module Functions
-
       module ClassMethods
         def alter_table(name)
           AlterTable.new(name)
@@ -62,13 +63,11 @@ module Sequent
         def all_projectors
           Sequent::Core::Migratable.all
         end
-
       end
 
       def self.included(base)
         base.extend(ClassMethods)
       end
-
     end
 
     include Functions

data/lib/sequent/migrations/migrate_events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # When you need to upgrade the event store based on information of the previous schema version
 # this is the place you need to implement a migration.
@@ -20,11 +22,12 @@
 module Sequent
   module Migrations
     class MigrateEvents
-
       ##
       # @param env The string representing the current environment. E.g. "development", "production"
       def initialize(env)
-        warn '[DEPRECATED] Use of MigrateEvents is deprecated and will be removed from future version. Please use Sequent::Migrations::ViewSchema instead. See the changelog on how to update.'
+        warn <<~EOS
+          [DEPRECATED] Use of MigrateEvents is deprecated and will be removed from future version. Please use Sequent::Migrations::ViewSchema instead. See the changelog on how to update.
+        EOS
         @env = env
       end
 
@@ -32,9 +35,10 @@ module Sequent
       #
       # @param current_version The current version of the application. E.g. 10
       # @param new_version The version to migrate to. E.g. 11
-      # @param &after_migration_block an optional block (with the current upgrade version as param) to run after the migrations run. E.g. close resources
+      # @param &after_migration_block an optional block (with the current upgrade version as param)
+      #   to run after the migrations run. E.g. close resources
       #
-      def execute_migrations(current_version, new_version, &after_migration_block)
+      def execute_migrations(current_version, new_version)
         migrations(current_version, new_version).each do |migration_class|
           migration = migration_class.new(@env)
           begin
@@ -47,12 +51,11 @@ module Sequent
 
       def migrations(current_version, new_version)
         return [] if current_version == 0
+
         ((current_version + 1)..new_version).map do |upgrade_to_version|
-          begin
-            Class.const_get("Database::MigrateToVersion#{upgrade_to_version}")
-          rescue NameError
-            nil
-          end
+          Class.const_get("Database::MigrateToVersion#{upgrade_to_version}")
+        rescue NameError
+          nil
         end.compact
       end
 

data/lib/sequent/migrations/migrations.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Sequent
   module Migrations
-
   end
 end
 

data/lib/sequent/migrations/planner.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Sequent
   module Migrations
     class Planner
       Plan = Struct.new(:projectors, :migrations) do
         def replay_tables
-          migrations.select { |m| m.class == ReplayTable }
+          migrations.select { |m| m.instance_of?(ReplayTable) }
         end
 
         def alter_tables
-          migrations.select { |m| m.class == AlterTable }
+          migrations.select { |m| m.instance_of?(AlterTable) }
         end
 
         def empty?
@@ -28,7 +30,7 @@ module Sequent
           migrations.yield_self(&method(:select_projectors)),
           migrations
             .yield_self(&method(:create_migrations))
-            .yield_self(&method(:remove_redundant_migrations))
+            .yield_self(&method(:remove_redundant_migrations)),
         )
       end
 
@@ -43,11 +45,11 @@ module Sequent
 
       def remove_redundant_migrations(migrations)
         redundant_migrations = migrations
-                                 .yield_self(&method(:group_identical_migrations))
-                                 .yield_self(&method(:select_redundant_migrations))
-                                 .yield_self(&method(:remove_redundancy))
-                                 .values
-                                 .flatten
+          .yield_self(&method(:group_identical_migrations))
+          .yield_self(&method(:select_redundant_migrations))
+          .yield_self(&method(:remove_redundancy))
+          .values
+          .flatten
 
         (migrations - redundant_migrations)
           .yield_self(&method(:remove_alter_tables_before_replay_table))
@@ -64,21 +66,22 @@ module Sequent
 
       def remove_alter_tables_before_replay_table(migrations)
         migrations - migrations
-                       .each_with_index
-                       .select { |migration, _index| migration.class == AlterTable }
-                       .select { |migration, index| migrations
-                                                      .slice((index + 1)..-1)
-                                                      .find { |m| m.class == ReplayTable && m.record_class == migration.record_class }
-                       }.map(&:first)
+          .each_with_index
+          .select { |migration, _index| migration.instance_of?(AlterTable) }
+          .select do |migration, index|
+                       migrations
+                         .slice((index + 1)..-1)
+                         .find { |m| m.instance_of?(ReplayTable) && m.record_class == migration.record_class }
+                     end.map(&:first)
       end
 
       def remove_redundancy(grouped_migrations)
-        grouped_migrations.reduce({}) { |memo, (key, ms)|
+        grouped_migrations.reduce({}) do |memo, (key, ms)|
           memo[key] = ms
-                        .yield_self(&method(:order_by_version_desc))
-                        .slice(1..-1)
+            .yield_self(&method(:order_by_version_desc))
+            .slice(1..-1)
           memo
-        }
+        end
       end
 
       def order_by_version_desc(migrations)
@@ -95,13 +98,20 @@ module Sequent
       end
 
       def map_to_migrations(migrations)
-        migrations.reduce({}) do |memo, (version, _migrations)|
-          fail "Declared migrations for version #{version} must be an Array. For example: {'3' => [FooProjector]}" unless _migrations.is_a?(Array)
+        migrations.reduce({}) do |memo, (version, ms)|
+          unless ms.is_a?(Array)
+            fail "Declared migrations for version #{version} must be an Array. For example: {'3' => [FooProjector]}"
+          end
 
-          memo[version] = _migrations.flat_map do |migration|
+          memo[version] = ms.flat_map do |migration|
             if migration.is_a?(AlterTable)
-              alter_table_sql_file_name = "#{Sequent.configuration.migration_sql_files_directory}/#{migration.table_name}_#{version}.sql"
-              fail "Missing file #{alter_table_sql_file_name} to apply for version #{version}" unless File.exist?(alter_table_sql_file_name)
+              alter_table_sql_file_name = <<~EOS.chomp
+                #{Sequent.configuration.migration_sql_files_directory}/#{migration.table_name}_#{version}.sql
+              EOS
+              unless File.exist?(alter_table_sql_file_name)
+                fail "Missing file #{alter_table_sql_file_name} to apply for version #{version}"
+              end
+
               migration.copy(version)
             elsif migration < Sequent::Projector
               migration.managed_tables.map { |table| ReplayTable.create(table, version) }

data/lib/sequent/migrations/projectors.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require_relative 'planner'
 module Sequent
   module Migrations
     class Projectors
       def self.versions
-        fail "Define your own Sequent::Migrations::List class that extends this class and implements this method"
+        fail 'Define your own Sequent::Migrations::List class that extends this class and implements this method'
       end
 
       def self.version
-        fail "Define your own Sequent::Migrations::List class that extends this class and implements this method"
+        fail 'Define your own Sequent::Migrations::List class that extends this class and implements this method'
       end
 
       def self.migrations_between(old, new)
         Planner.new(versions).plan(old, new)
       end
     end
-
   end
 end

data/lib/sequent/migrations/sql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../application_record'
 
 module Sequent