kaal-hanami 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5eb7f6bfd10c50d917f398cb8dc3bb86890287b089dd0acb5a2917057c734c9
-  data.tar.gz: cfa820d9b97bd7cc987886211cbb63fe95022072dc7c8f3f68288e98a645f859
+  metadata.gz: e1ec2250d7b6d9b2a8af4fe3c9e5b5d542a9e1ee6623d36c411e3fa89d8f676c
+  data.tar.gz: 06d0e49ac88b8a03ed5cc107a405714bde70b992a7db01b1362e9fc385110ef4
 SHA512:
-  metadata.gz: 5b150d1fac759cdc90be18ce0e5c3ff695ce3f1d356cc0bc76eb6c34f7081ed06d9e30fe443bad4c77f851845c35b2225f78b3263114c409713d409dd16393af
-  data.tar.gz: 0f18e4f660296296d41fb3829dc0ba8b928ee15410033789f2a46e3621c45390f5215fb2a6714b3821cc0f244edd6d91fcc5666149aafce510acf8b8b7634acf
+  metadata.gz: 9286c5220ef5ccbc51ea1e4dd08d896a5d36db98fcb09f6ece02a6a7c455df9e0da6ebbd0d04d495fe0fe7e0ed1de5ff47abf3dc5ad93427254d9ede276cec02
+  data.tar.gz: 37caed455e28e8f4052637116d0d595de74ddc0ed5796b464460a0468bce1974a089c849cc0a3ca3b9427045e35488aded439037e66c91f434614f2e9bc75451

data/README.md

@@ -29,7 +29,7 @@ If you use SQL persistence, create the Kaal tables using Sequel migrations. `kaa
 - 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
 
@@ -50,8 +50,7 @@ module MyApp
   class App < Hanami::App
     Kaal::Hanami.configure!(
       self,
-      backend: Kaal::Backend::MemoryAdapter.new,
-      scheduler_config_path: 'config/scheduler.yml',
+      scheduler_config_path: 'config/kaal-scheduler.yml',
       namespace: 'my-app',
       start_scheduler: false
     )
@@ -66,12 +65,12 @@ require 'redis'
 
 module MyApp
   class App < Hanami::App
-    REDIS = Redis.new(url: ENV.fetch('REDIS_URL'))
+    REDIS = Redis.new(url: "redis://127.0.0.1:6379/0")
 
     Kaal::Hanami.configure!(
       self,
       redis: REDIS,
-      scheduler_config_path: 'config/scheduler.yml',
+      scheduler_config_path: 'config/kaal-scheduler.yml',
       namespace: 'my-app',
       start_scheduler: false
     )
@@ -94,7 +93,7 @@ module MyApp
       self,
       database: database,
       adapter: 'postgres', # optional when Sequel can infer it
-      scheduler_config_path: 'config/scheduler.yml'
+      scheduler_config_path: 'config/kaal-scheduler.yml'
     )
   end
 end
@@ -126,7 +125,7 @@ Preferred deployment model:
 ## Public API
 
 - `Kaal::Hanami.configure!(app, **options)`
-- `Kaal::Hanami.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::Hanami.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::Hanami.configure_backend!(backend: nil, database: nil, redis: nil, adapter: nil, configuration: Kaal.configuration)`
 - `Kaal::Hanami.detect_backend_name(database, adapter: nil)`
 - `Kaal::Hanami.load_scheduler_file!(root:, environment: nil)`

data/lib/kaal/hanami/middleware.rb

@@ -14,7 +14,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,

data/lib/kaal/hanami/version.rb

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

data/lib/kaal/hanami.rb

@@ -24,7 +24,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,
@@ -32,11 +32,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:),
@@ -72,6 +73,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: runtime_environment_name(environment))
+        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
@@ -119,6 +125,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,55 @@
+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 Hanami
+  def self.env: () -> String
+
+  class App
+  end
+end

data/sig/kaal/hanami/middleware.rbs

@@ -0,0 +1,11 @@
+module Kaal
+  module Hanami
+    class Middleware
+      @app: ::Kaal::rbs_any
+
+      def initialize: (::Kaal::rbs_any app, hanami_app: ::Kaal::rbs_any, ?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?) -> void
+
+      def call: (::Kaal::rbs_any env) -> ::Kaal::rbs_any
+    end
+  end
+end

data/sig/kaal/hanami/version.rbs

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

data/sig/kaal/hanami.rbs

@@ -0,0 +1,43 @@
+module Kaal
+  module Hanami
+    self.@shutdown_hook_mutex: ::Kaal::rbs_any
+
+    def self.configure!: (::Kaal::rbs_any app, **::Kaal::rbs_any) -> ::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.runtime_environment_name: (::Kaal::rbs_any environment) -> ::Kaal::rbs_any
+
+    def self.start_managed_scheduler!: () -> (nil | ::Kaal::rbs_any)
+
+    def self.install_shutdown_hook: () -> (nil | ::Kaal::rbs_any)
+  end
+end

metadata

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