kaal-sinatra 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a345b6806f6359b4f308f70bc9dd0c211ce035c5378b35ec4a3686d4a58ba87e
-  data.tar.gz: 1522d0326fbffc4b648307555680a4792bb0b12c4b0d59b65954b7f0211eee5c
+  metadata.gz: c3b4b16c559eaaeecfad9d566002de7f38ac34f7ae27acbf5a123238442359b1
+  data.tar.gz: 57eafe07676544d15da4d25ebdc39e16e40fa88fe5b7baa15e2c2e260ade2055
 SHA512:
-  metadata.gz: 97e641dc529820a000807fc99461c5b845d352be2d86184ccbe9fa2ab6b081875f6210d9e800c476a99e62a059a1f6437979f301dadffa49122a34d19bb22ea8
-  data.tar.gz: 07532fc1ec06532864e8f1d1c8c3131b931579f909b5e9bc510ddc63ac410e3a349aad790923b10bad58640a9ffe473b6fecd78785c983d7bd89880837b6c903
+  metadata.gz: 36c671c3da1de727a3a568d584c6b5ed568c66f08cc2dd52700b1533384244bb401a92ba571b36c5c75718c3c9042aff426a5ce446e4a28c5a9d949b261bfa3d
+  data.tar.gz: 3a9f257a6d8f46b15dbe41b5e057fa260de987f9d422accf36cea1384f0b1f88f52574aecf6b9e5d70c12b8e49494db216ff975ccd0764b2c5221afa3a51b75c

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 Sinatra app
 
 ## Classic Sinatra
 
@@ -55,8 +56,7 @@ register Kaal::Sinatra::Extension
 
 Kaal::Sinatra.register!(
   settings,
-  backend: Kaal::Backend::MemoryAdapter.new,
-  scheduler_config_path: 'config/scheduler.yml',
+  scheduler_config_path: 'config/kaal-scheduler.yml',
   namespace: 'my-app',
   start_scheduler: false
 )
@@ -76,12 +76,12 @@ class ExampleHeartbeatJob
 end
 
 class App < Sinatra::Base
-  REDIS = Redis.new(url: ENV.fetch('REDIS_URL'))
+  REDIS = Redis.new(url: "redis://127.0.0.1:6379/0")
 
   register Kaal::Sinatra::Extension
 
   kaal redis: REDIS,
-       scheduler_config_path: 'config/scheduler.yml',
+       scheduler_config_path: 'config/kaal-scheduler.yml',
        namespace: 'my-app',
        start_scheduler: false
 end
@@ -100,7 +100,7 @@ Kaal::Sinatra.register!(
   settings,
   database: database,
   adapter: 'postgres', # optional when Sequel can infer it
-  scheduler_config_path: 'config/scheduler.yml'
+  scheduler_config_path: 'config/kaal-scheduler.yml'
 )
 ```
 
@@ -129,7 +129,7 @@ Preferred deployment model:
 
 ## Public API
 
-- `Kaal::Sinatra.register!(app, backend: nil, database: nil, redis: nil, scheduler_config_path: 'config/scheduler.yml', namespace: nil, start_scheduler: false, adapter: nil)`
+- `Kaal::Sinatra.register!(app, backend: nil, database: nil, redis: nil, scheduler_config_path: 'config/kaal-scheduler.yml', namespace: nil, start_scheduler: false, adapter: nil)`
 - `Kaal::Sinatra.configure_backend!(backend: nil, database: nil, redis: nil, adapter: nil, configuration: Kaal.configuration)`
 - `Kaal::Sinatra.load_scheduler_file!(root:, environment: nil)`
 - `Kaal::Sinatra.start!`

data/lib/kaal/sinatra/version.rb

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

data/lib/kaal/sinatra.rb

@@ -18,17 +18,14 @@ 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
       )
         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), environment: environment_name_for(app), configuration:)
+        apply_runtime_overrides(configuration:, scheduler_config_path:, namespace:)
         configure_backend!(backend:, database:, redis:, adapter:, configuration:)
         load_scheduler_file!(root: root_path_for(app), environment: environment_name_for(app))
 
@@ -61,6 +58,11 @@ module Kaal
         return 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
@@ -108,6 +110,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,53 @@
+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
+
+module Sinatra
+  class Base
+  end
+end

data/sig/kaal/sinatra/version.rbs

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

data/sig/kaal/sinatra.rbs

@@ -0,0 +1,51 @@
+module Kaal
+  module Sinatra
+    self.@shutdown_hook_installed: ::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?) -> ::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) -> ::Kaal::rbs_any
+
+    def self.environment_name_for: (::Kaal::rbs_any app) -> ::Kaal::rbs_any
+
+    def self.settings_for: (::Kaal::rbs_any app) -> ::Kaal::rbs_any
+
+    def self.start_managed_scheduler!: () -> (nil | ::Kaal::rbs_any)
+
+    def self.install_shutdown_hook: () -> (nil | ::Kaal::rbs_any)
+
+    public
+
+    module Extension
+      def self.registered: (::Kaal::rbs_any app) -> ::Kaal::rbs_any
+
+      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-sinatra
 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
@@ -78,6 +78,10 @@ files:
 - bin/update-bundle
 - lib/kaal/sinatra.rb
 - lib/kaal/sinatra/version.rb
+- sig/00_types.rbs
+- sig/dependencies.rbs
+- sig/kaal/sinatra.rbs
+- sig/kaal/sinatra/version.rbs
 homepage: https://github.com/Code-Vedas/kaal
 licenses:
 - MIT