kaal 0.3.0 → 0.4.0

data/lib/kaal/internal/sequel.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Copyright Codevedas Inc. 2025-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+require 'kaal/internal/sequel/database_backend'
+require 'kaal/internal/sequel/postgres_backend'
+require 'kaal/internal/sequel/mysql_backend'
+require 'kaal/definition/database_engine'
+require 'kaal/dispatch/database_engine'
+require 'kaal/persistence/database'

data/lib/kaal/persistence/database.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright Codevedas Inc. 2025-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+module Kaal
+  module Persistence
+    # Thin wrapper around a Sequel connection to keep table access consistent.
+    class Database
+      attr_reader :connection
+
+      def initialize(connection)
+        Kaal::Sequel.require_sequel!
+        @connection = if connection.is_a?(::Sequel::Database)
+                        connection
+                      else
+                        ::Sequel.connect(connection)
+                      end
+      end
+
+      def definitions_dataset
+        connection[:kaal_definitions]
+      end
+
+      def dispatches_dataset
+        connection[:kaal_dispatches]
+      end
+
+      def locks_dataset
+        connection[:kaal_locks]
+      end
+    end
+  end
+end

data/lib/kaal/persistence/migration_templates.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright Codevedas Inc. 2025-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+module Kaal
+  module Persistence
+    # Sequel migration templates emitted by `kaal init`.
+    module MigrationTemplates
+      module_function
+
+      def for_backend(backend)
+        case backend.to_s
+        when 'sqlite'
+          {
+            '001_create_kaal_dispatches.rb' => dispatches_template,
+            '002_create_kaal_locks.rb' => locks_template,
+            '003_create_kaal_definitions.rb' => definitions_template
+          }
+        when 'postgres', 'mysql'
+          {
+            '001_create_kaal_dispatches.rb' => dispatches_template,
+            '002_create_kaal_definitions.rb' => definitions_template
+          }
+        else
+          {}
+        end
+      end
+
+      def dispatches_template
+        <<~RUBY
+          Sequel.migration do
+            change do
+              create_table?(:kaal_dispatches) do
+                primary_key :id
+                String :key, null: false
+                Time :fire_time, null: false
+                Time :dispatched_at, null: false
+                String :node_id, null: false
+                String :status, null: false, default: 'dispatched', size: 50
+              end
+
+              add_index :kaal_dispatches, [:key, :fire_time], unique: true
+              add_index :kaal_dispatches, :key
+              add_index :kaal_dispatches, :node_id
+              add_index :kaal_dispatches, :status
+              add_index :kaal_dispatches, :fire_time
+            end
+          end
+        RUBY
+      end
+
+      def locks_template
+        <<~RUBY
+          Sequel.migration do
+            change do
+              create_table?(:kaal_locks) do
+                primary_key :id
+                String :key, null: false
+                Time :acquired_at, null: false
+                Time :expires_at, null: false
+              end
+
+              add_index :kaal_locks, :key, unique: true
+              add_index :kaal_locks, :expires_at
+            end
+          end
+        RUBY
+      end
+
+      def definitions_template
+        <<~RUBY
+          Sequel.migration do
+            change do
+              create_table?(:kaal_definitions) do
+                primary_key :id
+                String :key, null: false
+                String :cron, null: false
+                TrueClass :enabled, null: false, default: true
+                String :source, null: false
+                String :metadata, text: true, null: false, default: '{}'
+                Time :disabled_at
+                Time :created_at, null: false
+                Time :updated_at, null: false
+              end
+
+              add_index :kaal_definitions, :key, unique: true
+              add_index :kaal_definitions, :enabled
+              add_index :kaal_definitions, :source
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/kaal/registry.rb

@@ -20,9 +20,7 @@ module Kaal
 
     ##
     # Entry class representing a single registered cron job
-    # rubocop:disable Style/RedundantStructKeywordInit
     Entry = Struct.new(:key, :cron, :enqueue, keyword_init: true)
-    # rubocop:enable Style/RedundantStructKeywordInit
 
     ##
     # Initialize a new Registry instance.

data/lib/kaal/sequel_support.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright Codevedas Inc. 2025-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+require 'fileutils'
+
+module Kaal
+  # Sequel migration/install support for SQL-backed Kaal backends.
+  module Sequel
+    module_function
+
+    def install_postgres_migration(target_dir:, migration_name: 'create_kaal_postgres_backend')
+      install_migrations(target_dir:, backend: 'postgres', migration_name:)
+    end
+
+    def install_mysql_migration(target_dir:, migration_name: 'create_kaal_mysql_backend')
+      install_migrations(target_dir:, backend: 'mysql', migration_name:)
+    end
+
+    def install_sqlite_migration(target_dir:, migration_name: 'create_kaal_sqlite_backend')
+      install_migrations(target_dir:, backend: 'sqlite', migration_name:)
+    end
+
+    def install_migrations(target_dir:, backend:, migration_name: nil)
+      require_sequel!
+
+      normalized_name = normalize_migration_name(migration_name, fallback: default_migration_name_for(backend))
+      base_path = File.expand_path(target_dir)
+      FileUtils.mkdir_p(base_path)
+
+      Kaal::Persistence::MigrationTemplates.for_backend(backend).map.with_index do |(_name, contents), index|
+        suffix = migration_suffixes_for(backend).fetch(index)
+        path = File.expand_path("#{timestamp(index)}_#{normalized_name}_#{suffix}.rb", base_path)
+        File.write(path, contents)
+        path
+      end
+    end
+
+    def require_sequel!
+      require 'sequel'
+    rescue LoadError => e
+      raise LoadError,
+            "#{e.message}. Add `gem 'sequel'` to your Gemfile to use Sequel-backed Kaal SQL support.",
+            cause: e
+    end
+
+    def normalize_migration_name(name, fallback:)
+      normalized = name.to_s.each_char.with_object(+'') do |char, buffer|
+        if letter?(char) || digit?(char)
+          buffer << char.downcase
+        elsif !buffer.empty? && !buffer.end_with?('_')
+          buffer << '_'
+        end
+      end.delete_suffix('_')
+      normalized.empty? ? fallback : normalized
+    end
+
+    def default_migration_name_for(backend)
+      "create_kaal_#{backend}_backend"
+    end
+
+    def migration_suffixes_for(backend)
+      return %w[dispatches locks definitions] if backend.to_s == 'sqlite'
+
+      %w[dispatches definitions]
+    end
+
+    def timestamp(offset = 0)
+      (Time.now.utc + offset).strftime('%Y%m%d%H%M%S')
+    end
+
+    def letter?(char)
+      char.between?('a', 'z') || char.between?('A', 'Z')
+    end
+
+    def digit?(char)
+      char.between?('0', '9')
+    end
+  end
+end

data/lib/kaal/version.rb

@@ -5,5 +5,5 @@
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 module Kaal
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/kaal.rb

@@ -16,8 +16,14 @@ require 'kaal/definition/redis_engine'
 require 'kaal/backend/adapter'
 require 'kaal/backend/memory_adapter'
 require 'kaal/backend/redis_adapter'
+require 'kaal/backend/sqlite'
+require 'kaal/backend/postgres'
+require 'kaal/backend/mysql'
 require 'kaal/backend/dispatch_registry_accessor'
 require 'kaal/backend/dispatch_attempt_logger'
+require 'kaal/persistence/migration_templates'
+require 'kaal/sequel_support'
+require 'kaal/active_record_support'
 require 'kaal/utils'
 require 'kaal/register_conflict_support'
 require 'kaal/definitions/registry_accessor'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nitesh Purohit
@@ -84,12 +84,16 @@ files:
 - config/scheduler.yml
 - exe/kaal
 - lib/kaal.rb
+- lib/kaal/active_record_support.rb
 - lib/kaal/backend/adapter.rb
 - lib/kaal/backend/dispatch_attempt_logger.rb
 - lib/kaal/backend/dispatch_logging.rb
 - lib/kaal/backend/dispatch_registry_accessor.rb
 - lib/kaal/backend/memory_adapter.rb
+- lib/kaal/backend/mysql.rb
+- lib/kaal/backend/postgres.rb
 - lib/kaal/backend/redis_adapter.rb
+- lib/kaal/backend/sqlite.rb
 - lib/kaal/cli.rb
 - lib/kaal/config.rb
 - lib/kaal/config/configuration.rb
@@ -99,15 +103,35 @@ files:
 - lib/kaal/core/coordinator.rb
 - lib/kaal/core/enabled_entry_enumerator.rb
 - lib/kaal/core/occurrence_finder.rb
+- lib/kaal/definition/database_engine.rb
 - lib/kaal/definition/memory_engine.rb
 - lib/kaal/definition/persistence_helpers.rb
 - lib/kaal/definition/redis_engine.rb
 - lib/kaal/definition/registry.rb
 - lib/kaal/definitions/registration_service.rb
 - lib/kaal/definitions/registry_accessor.rb
+- lib/kaal/dispatch/database_engine.rb
 - lib/kaal/dispatch/memory_engine.rb
 - lib/kaal/dispatch/redis_engine.rb
 - lib/kaal/dispatch/registry.rb
+- lib/kaal/internal/active_record.rb
+- lib/kaal/internal/active_record/base_record.rb
+- lib/kaal/internal/active_record/connection_support.rb
+- lib/kaal/internal/active_record/database_backend.rb
+- lib/kaal/internal/active_record/definition_record.rb
+- lib/kaal/internal/active_record/definition_registry.rb
+- lib/kaal/internal/active_record/dispatch_record.rb
+- lib/kaal/internal/active_record/dispatch_registry.rb
+- lib/kaal/internal/active_record/lock_record.rb
+- lib/kaal/internal/active_record/migration_templates.rb
+- lib/kaal/internal/active_record/mysql_backend.rb
+- lib/kaal/internal/active_record/postgres_backend.rb
+- lib/kaal/internal/sequel.rb
+- lib/kaal/internal/sequel/database_backend.rb
+- lib/kaal/internal/sequel/mysql_backend.rb
+- lib/kaal/internal/sequel/postgres_backend.rb
+- lib/kaal/persistence/database.rb
+- lib/kaal/persistence/migration_templates.rb
 - lib/kaal/register_conflict_support.rb
 - lib/kaal/registry.rb
 - lib/kaal/runtime.rb
@@ -123,6 +147,7 @@ files:
 - lib/kaal/scheduler_file/loader.rb
 - lib/kaal/scheduler_file/payload_loader.rb
 - lib/kaal/scheduler_file/placeholder_support.rb
+- lib/kaal/sequel_support.rb
 - lib/kaal/support/hash_tools.rb
 - lib/kaal/utils.rb
 - lib/kaal/utils/cron_humanizer.rb