kaal-roda 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b98e312b2cb03226a195c6dffe239cabdd5e380d57801b0b2348d4f0c752cd
-  data.tar.gz: 19d47df4d5ba23d17c25e82ae5524a118245a295d9affc54d7805a37330d2c61
+  metadata.gz: 7a11aeb89323c30bbd519aaf6b5781045ffad311a36a6961df5df7b36d289a80
+  data.tar.gz: 8e1fcd5ed671d2938f0b1774d21c7e07ee4a5fbd75cbf473f170b5c2beeea585
 SHA512:
-  metadata.gz: '0988b21d2d825cebb420c16289db800dfa82cec6c8b8cd35fb824fe9dc813c7852577cd88761fdcb3f5ee850278449351fc75cafb48f088c597161e0ea1d58fa'
-  data.tar.gz: cb5e89ba9f906e8570aa91acb207a800857ef7d2cbb0b0f03af923dcaf3baacb6f24d964d74c44625012048df591c4dc77cd00dc9a88401aaed40764f99b8001
+  metadata.gz: 84d2ee2371e4896f8d5225666d940c7a5e2aa1be8b6978a28cffe7d6e3be15c998457b0732de8b3845da7e4b50921ff2982cb9f4e905abac5aee56390e837076
+  data.tar.gz: a28fed7f7d93ed282c1b80d008d3d69f295c013a1df3b86c232ae313c07d75abc0c3729daf3c4677e7556542c68449a8858bd2c7fe047a8e22465b0da8283e84

data/README.md

@@ -25,11 +25,11 @@ gem 'sqlite3' # or pg / mysql2 for SQL
 
 If you use SQL persistence, create the Kaal tables using Sequel migrations. `kaal` exposes the Sequel migration templates for:
 
-- SQLite: `kaal_dispatches`, `kaal_locks`, `kaal_definitions`
-- PostgreSQL: `kaal_dispatches`, `kaal_definitions`
-- MySQL: `kaal_dispatches`, `kaal_definitions`
+- SQLite: `kaal_dispatches`, `kaal_locks`, `kaal_definitions`, `kaal_delayed_jobs`
+- PostgreSQL: `kaal_dispatches`, `kaal_definitions`, `kaal_delayed_jobs`
+- MySQL: `kaal_dispatches`, `kaal_definitions`, `kaal_delayed_jobs`
 
-Your app should also provide `config/scheduler.yml`.
+Your app should also provide `config/kaal-scheduler.yml`.
 
 ## What It Provides
 
@@ -38,6 +38,7 @@ Your app should also provide `config/scheduler.yml`.
 - redis convenience wiring when the app passes a redis client
 - automatic SQL backend selection from the Sequel adapter unless the app passes `adapter:`
 - explicit lifecycle helpers so web processes do not implicitly start background scheduler threads
+- the normal Kaal runtime API inside a Roda app
 
 ## Minimal Roda
 
@@ -54,8 +55,7 @@ end
 class App < Roda
   plugin :kaal
 
-  kaal backend: Kaal::Backend::MemoryAdapter.new,
-       scheduler_config_path: 'config/scheduler.yml',
+  kaal scheduler_config_path: 'config/kaal-scheduler.yml',
        namespace: 'my-app',
        start_scheduler: false
 
@@ -73,12 +73,12 @@ require 'redis'
 require 'kaal/roda'
 
 class App < Roda
-  REDIS = Redis.new(url: ENV.fetch('REDIS_URL'))
+  REDIS = Redis.new(url: "redis://127.0.0.1:6379/0")
 
   plugin :kaal
 
   kaal redis: REDIS,
-       scheduler_config_path: 'config/scheduler.yml',
+       scheduler_config_path: 'config/kaal-scheduler.yml',
        namespace: 'my-app',
        start_scheduler: false
 end
@@ -98,7 +98,7 @@ class App < Roda
 
   kaal database: database,
        adapter: 'postgres', # optional when Sequel can infer it
-       scheduler_config_path: 'config/scheduler.yml'
+       scheduler_config_path: 'config/kaal-scheduler.yml'
 end
 ```
 
@@ -127,7 +127,7 @@ Preferred deployment model:
 
 ## Public API
 
-- `Kaal::Roda.register!(app, backend: nil, database: nil, redis: nil, scheduler_config_path: 'config/scheduler.yml', namespace: nil, start_scheduler: false, adapter: nil, root: nil, environment: nil)`
+- `Kaal::Roda.register!(app, backend: nil, database: nil, redis: nil, scheduler_config_path: 'config/kaal-scheduler.yml', namespace: nil, start_scheduler: false, adapter: nil, root: nil, environment: nil)`
 - `Kaal::Roda.configure_backend!(backend: nil, database: nil, redis: nil, adapter: nil, configuration: Kaal.configuration)`
 - `Kaal::Roda.detect_backend_name(database, adapter: nil)`
 - `Kaal::Roda.load_scheduler_file!(root:, environment: nil)`

data/lib/kaal/roda/version.rb

@@ -6,6 +6,6 @@
 # LICENSE file in the root directory of this source tree.
 module Kaal
   module Roda
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/kaal/roda.rb

@@ -18,7 +18,7 @@ module Kaal
         backend: nil,
         database: nil,
         redis: nil,
-        scheduler_config_path: 'config/scheduler.yml',
+        scheduler_config_path: 'config/kaal-scheduler.yml',
         namespace: nil,
         start_scheduler: false,
         adapter: nil,
@@ -26,11 +26,12 @@ module Kaal
         environment: nil
       )
         configuration = Kaal.configuration
-        normalized_scheduler_config_path = scheduler_config_path.to_s.strip
-        normalized_namespace = namespace.to_s.strip
-        configuration.scheduler_config_path = normalized_scheduler_config_path unless normalized_scheduler_config_path.empty?
-        configuration.namespace = normalized_namespace unless normalized_namespace.empty?
-
+        load_config_file!(
+          root: root_path_for(app, root:),
+          environment: environment_name_for(app, environment:),
+          configuration:
+        )
+        apply_runtime_overrides(configuration:, scheduler_config_path:, namespace:)
         configure_backend!(backend:, database:, redis:, adapter:, configuration:)
         load_scheduler_file!(
           root: root_path_for(app, root:),
@@ -66,6 +67,11 @@ module Kaal
         configuration.backend = build_backend(backend_name, database)
       end
 
+      def load_config_file!(root:, environment:, configuration: Kaal.configuration)
+        runtime_context = Kaal::Runtime::RuntimeContext.new(root_path: root, environment_name: environment.to_s)
+        Kaal::Config::FileLoader.new(configuration:, runtime_context:).load
+      end
+
       def detect_backend_name(database, adapter: nil)
         explicit_adapter = normalize_backend_name(adapter)
         return explicit_adapter if explicit_adapter
@@ -113,6 +119,13 @@ module Kaal
         end
       end
 
+      def apply_runtime_overrides(configuration:, scheduler_config_path:, namespace:)
+        normalized_scheduler_config_path = scheduler_config_path.to_s.strip
+        normalized_namespace = namespace.to_s.strip
+        configuration.scheduler_config_path = normalized_scheduler_config_path unless normalized_scheduler_config_path.empty?
+        configuration.namespace = normalized_namespace unless normalized_namespace.empty?
+      end
+
       def database_adapter_name(database)
         return if database.nil?
 

data/sig/00_types.rbs

@@ -0,0 +1,12 @@
+module Kaal
+  interface _RBSOpaque
+  end
+
+  interface _RBSCallable
+    def call: (*rbs_any args, **rbs_any kwargs) -> rbs_any
+  end
+
+  type rbs_scalar = nil | bool | Integer | Float | Rational | String | Symbol | Time
+  type rbs_hash_key = String | Symbol | Integer
+  type rbs_any = rbs_scalar | _RBSOpaque | _RBSCallable | Array[rbs_any] | Hash[rbs_hash_key, rbs_any]
+end

data/sig/dependencies.rbs

@@ -0,0 +1,54 @@
+module Kaal
+  module Backend
+    class MemoryAdapter
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+    end
+
+    class RedisAdapter
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+    end
+
+    class SQLite
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+    end
+
+    class Postgres
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+    end
+
+    class MySQL
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+    end
+  end
+
+  def self.configuration: () -> rbs_any
+  def self.running?: () -> bool
+  def self.start!: () -> rbs_any
+  def self.stop!: (*rbs_any args, **rbs_any kwargs) -> rbs_any
+  def self.load_scheduler_file!: (*rbs_any args, **rbs_any kwargs) -> rbs_any
+
+  module Runtime
+    class RuntimeContext
+      def self.new: (*rbs_any args, **rbs_any kwargs) -> RuntimeContext
+      def self.environment_name_from: (Hash[String, String] env) -> String
+    end
+
+    class SchedulerBootLoader
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+      def load_on_boot!: () -> rbs_any
+    end
+  end
+
+  module Config
+    class FileLoader
+      def initialize: (*rbs_any args, **rbs_any kwargs) -> void
+      def load: (*rbs_any args, **rbs_any kwargs) -> rbs_any
+    end
+  end
+end
+
+class Roda
+  module RodaPlugins
+    def self.register_plugin: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) -> void
+  end
+end

data/sig/kaal/roda/version.rbs

@@ -0,0 +1,5 @@
+module Kaal
+  module Roda
+    VERSION: String
+  end
+end

data/sig/kaal/roda.rbs

@@ -0,0 +1,39 @@
+module Kaal
+  module Roda
+    self.@shutdown_hook_mutex: ::Kaal::rbs_any
+
+    def self.register!: (::Kaal::rbs_any app, ?backend: ::Kaal::rbs_any?, ?database: ::Kaal::rbs_any?, ?redis: ::Kaal::rbs_any?, ?scheduler_config_path: ::String, ?namespace: ::Kaal::rbs_any?, ?start_scheduler: bool, ?adapter: ::Kaal::rbs_any?, ?root: ::Kaal::rbs_any?, ?environment: ::Kaal::rbs_any?) -> ::Kaal::rbs_any
+
+    def self.configure_backend!: (?backend: ::Kaal::rbs_any?, ?database: ::Kaal::rbs_any?, ?redis: ::Kaal::rbs_any?, ?adapter: ::Kaal::rbs_any?, ?configuration: ::Kaal::rbs_any) -> ::Kaal::rbs_any
+
+    def self.load_config_file!: (root: ::Kaal::rbs_any, environment: ::Kaal::rbs_any, ?configuration: ::Kaal::rbs_any) -> ::Kaal::rbs_any
+
+    def self.detect_backend_name: (::Kaal::rbs_any database, ?adapter: ::Kaal::rbs_any?) -> ::Kaal::rbs_any
+
+    def self.load_scheduler_file!: (root: ::Kaal::rbs_any, ?environment: ::Kaal::rbs_any?) -> ::Kaal::rbs_any
+
+    def self.start!: () -> ::Kaal::rbs_any
+
+    def self.stop!: (?timeout: ::Integer) -> ::Kaal::rbs_any
+
+    private
+
+    def self.build_redis_backend: (::Kaal::rbs_any redis, ::Kaal::rbs_any configuration) -> ::Kaal::rbs_any
+
+    def self.build_backend: (::Kaal::rbs_any backend_name, ::Kaal::rbs_any database) -> ::Kaal::rbs_any
+
+    def self.apply_runtime_overrides: (configuration: ::Kaal::rbs_any, scheduler_config_path: ::Kaal::rbs_any, namespace: ::Kaal::rbs_any) -> ::Kaal::rbs_any
+
+    def self.database_adapter_name: (::Kaal::rbs_any database) -> (nil | ::Kaal::rbs_any)
+
+    def self.normalize_backend_name: (::Kaal::rbs_any adapter_name) -> (nil | "sqlite" | "postgres" | "mysql")
+
+    def self.root_path_for: (::Kaal::rbs_any app, ?root: ::Kaal::rbs_any?) -> ::Kaal::rbs_any
+
+    def self.environment_name_for: (::Kaal::rbs_any app, ?environment: ::Kaal::rbs_any?) -> ::Kaal::rbs_any
+
+    def self.start_managed_scheduler!: () -> (nil | ::Kaal::rbs_any)
+
+    def self.install_shutdown_hook: () -> (nil | ::Kaal::rbs_any)
+  end
+end

data/sig/roda/plugins/kaal.rbs

@@ -0,0 +1,9 @@
+class Roda
+  module RodaPlugins
+    module Kaal
+      module ClassMethods
+        def kaal: (**::Kaal::rbs_any) -> ::Kaal::rbs_any
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaal-roda
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nitesh Purohit
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,11 @@ files:
 - lib/kaal/roda.rb
 - lib/kaal/roda/version.rb
 - lib/roda/plugins/kaal.rb
+- sig/00_types.rbs
+- sig/dependencies.rbs
+- sig/kaal/roda.rbs
+- sig/kaal/roda/version.rbs
+- sig/roda/plugins/kaal.rbs
 homepage: https://github.com/Code-Vedas/kaal
 licenses:
 - MIT