kaal-rails 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9975de587d0049dc6d0c600a8d1ae9b475d10ada23dcca56250008f4662915
-  data.tar.gz: 72cb9b8d049685add808d81a11a7bf5682580857e8973cd5f46b351d67d4c4af
+  metadata.gz: 9574f048025ccf1cf2395da1365a7b10c2f831ba2234ae4bcc27f3f5708e0cc9
+  data.tar.gz: a599d190ac316df5e2e5bf9937c610f3ebc46f02eba29cce772414e9fff7971b
 SHA512:
-  metadata.gz: 6b4d4ac608ba05a69c26ab53cb062026166fd98dbf2c10a35fed393e2e78f56e24018b834fe4c13ecc59e1f0576d03beefc1056cff6010713c6f4e75ee224014
-  data.tar.gz: a3ef5c9890a13dac180b51a74d11f8e4c35d53a436085fba627677649e3ad541dc2c9a882cd9375baf2d4dd80a40d686a6e1b41a7cdb94bc564eee0b52d2c64d
+  metadata.gz: b806c7170acb9e05dfd25abd395afa9d3b9fb4c272cc478920e5c0d6a8f1ffbcd74ccbc91f895511616cdb056193c54e0d209049af87423b03c9c15fb2fcf4ab
+  data.tar.gz: 6909cde3ec4e36d3d7cb986c5d72aa4c77288b827504a206da0775a28b9b470baeaea034619ca5114c407034b7aff4386e7199a505f2d82f9497c2b143191ec5

data/README.md

@@ -41,12 +41,15 @@ bundle exec rails generate kaal:install --backend=mysql
 bundle exec rails db:migrate
 ```
 
+These migrations install the Kaal persistence tables required by the selected backend.
+
 ## What It Provides
 
 - Rails-native setup on top of the Kaal engine
 - Active Record-backed persistence through the core `kaal` gem
 - migration templates for the Kaal tables required by the selected backend
 - automatic backend selection from the Rails database adapter unless the app sets `Kaal.configuration.backend` itself
+- the normal Kaal runtime API in a Rails install surface
 
 ## Usage
 
@@ -54,7 +57,7 @@ Add the gem to your Rails app and configure only if you need overrides:
 
 ```ruby
 Kaal.configure do |config|
-  config.scheduler_config_path = Rails.root.join('config/scheduler.yml')
+  config.scheduler_config_path = Rails.root.join('config/kaal-scheduler.yml')
 end
 ```
 

data/lib/generators/kaal/install_generator.rb

@@ -14,6 +14,8 @@ module Kaal
 
       def install_kaal
         results = Kaal::Rails.install!(root: destination_root, backend: selected_backend)
+        runtime_config = results.fetch(:runtime_config)
+        say_status(runtime_config.fetch(:status), runtime_config.fetch(:path))
         scheduler_config = results.fetch(:scheduler_config)
         say_status(scheduler_config.fetch(:status), scheduler_config.fetch(:path))
         results.fetch(:migrations).each do |migration|

data/lib/kaal/rails/installer.rb

@@ -12,6 +12,20 @@ module Kaal
   module Rails
     # Installs scheduler config and Active Record migrations into a Rails app.
     class Installer
+      KAAL_TEMPLATE = <<~YAML
+        defaults:
+          namespace: kaal
+          tick_interval: 5
+          window_lookback: 120
+          window_lookahead: 0
+          lease_ttl: 125
+          scheduler_config_path: config/kaal-scheduler.yml
+          enable_dispatch_recovery: true
+          enable_log_dispatch_registry: false
+          delayed_job_allowed_class_prefixes: []
+          backend_config: {}
+      YAML
+
       SCHEDULER_TEMPLATE = <<~YAML
         defaults:
           jobs:
@@ -31,8 +45,16 @@ module Kaal
         @time_source = time_source
       end
 
+      def install_runtime_config
+        ensure_config_dir
+        return { status: :exists, path: runtime_config_path_string } if runtime_config_exists?
+
+        File.write(runtime_config_path, KAAL_TEMPLATE)
+        { status: :create, path: runtime_config_path_string }
+      end
+
       def install_scheduler_config
-        ensure_scheduler_config_dir
+        ensure_config_dir
         return { status: :exists, path: scheduler_config_path_string } if scheduler_config_exists?
 
         File.write(scheduler_config_path, SCHEDULER_TEMPLATE)
@@ -71,18 +93,30 @@ module Kaal
       end
 
       def scheduler_config_path
-        root.join('config', 'scheduler.yml')
+        root.join('config', 'kaal-scheduler.yml')
+      end
+
+      def runtime_config_path
+        root.join('config', 'kaal.yml')
       end
 
       def scheduler_config_exists?
         scheduler_config_path.exist?
       end
 
+      def runtime_config_exists?
+        runtime_config_path.exist?
+      end
+
       def scheduler_config_path_string
         scheduler_config_path.to_s
       end
 
-      def ensure_scheduler_config_dir
+      def runtime_config_path_string
+        runtime_config_path.to_s
+      end
+
+      def ensure_config_dir
         FileUtils.mkdir_p(scheduler_config_path.dirname)
       end
     end

data/lib/kaal/rails/version.rb

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

data/lib/kaal/rails.rb

@@ -41,16 +41,26 @@ module Kaal
       end
 
       def configure_backend!(configuration: Kaal.configuration, backend: build_backend)
+        load_config_file!(configuration:)
+        logger = configuration.logger
         current_backend = configuration.backend
-        return current_backend if current_backend
-        return nil unless backend
+        selected_backend = current_backend || backend
+        return nil unless selected_backend
 
-        configuration.backend = backend
+        configuration.backend = selected_backend unless current_backend
+        Kaal.warn_on_risky_configuration!(configuration:, logger:)
+        selected_backend
+      end
+
+      def load_config_file!(configuration: Kaal.configuration, root: ::Rails.root, environment: ::Rails.env)
+        runtime_context = Kaal::Runtime::RuntimeContext.new(root_path: root, environment_name: environment.to_s)
+        Kaal::Config::FileLoader.new(configuration:, runtime_context:).load
       end
 
       def install!(root: ::Rails.root, backend: detect_backend_name)
         installer = Installer.new(root:, backend:)
         {
+          runtime_config: installer.install_runtime_config,
           scheduler_config: installer.install_scheduler_config,
           migrations: installer.install_migrations
         }

data/lib/tasks/kaal/rails_tasks.rake

@@ -10,6 +10,7 @@ namespace :kaal do
     desc 'Install Kaal scheduler config and Active Record migrations'
     task all: :environment do
       results = Kaal::Rails.install!
+      puts "#{results.fetch(:runtime_config).fetch(:status)} #{results.fetch(:runtime_config).fetch(:path)}"
       puts "#{results.fetch(:scheduler_config).fetch(:status)} #{results.fetch(:scheduler_config).fetch(:path)}"
       results.fetch(:migrations).each do |migration|
         puts "#{migration.fetch(:status)} #{migration.fetch(:path)}"

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,65 @@
+module Kaal
+  module Backend
+    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.warn_on_risky_configuration!: (*rbs_any args, **rbs_any kwargs) -> rbs_any
+
+  class RuntimeContext
+    def self.new: (*rbs_any args, **rbs_any kwargs) -> RuntimeContext
+  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
+
+  module Internal
+    module ActiveRecord
+      module MigrationTemplates
+        def self.for_backend: (rbs_any backend) -> Array[[String, String]]
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  class ConnectionNotEstablished < StandardError
+  end
+
+  class Base
+    def self.connection_db_config: () -> ::Kaal::rbs_any
+  end
+end
+
+module Rails
+  def self.root: () -> ::Kaal::rbs_any
+  def self.env: () -> String
+
+  module Generators
+    class Base
+      def self.argument: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) -> void
+      def self.class_option: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) -> void
+      def self.desc: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) -> void
+      def self.namespace: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) -> void
+    end
+  end
+
+  class Railtie
+    def self.initializer: (*::Kaal::rbs_any args, **::Kaal::rbs_any kwargs) { () -> ::Kaal::rbs_any } -> void
+    def self.rake_tasks: () { () -> ::Kaal::rbs_any } -> void
+  end
+end

data/sig/generators/kaal/install_generator.rbs

@@ -0,0 +1,11 @@
+module Kaal
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def install_kaal: () -> ::Kaal::rbs_any
+
+      private
+
+      def selected_backend: () -> ::Kaal::rbs_any
+    end
+  end
+end

data/sig/kaal/rails/installer.rbs

@@ -0,0 +1,47 @@
+module Kaal
+  module Rails
+    class Installer
+      @root: ::Kaal::rbs_any
+
+      @backend: ::Kaal::rbs_any
+
+      @time_source: ::Kaal::rbs_any
+
+      KAAL_TEMPLATE: "defaults:\n  namespace: kaal\n  tick_interval: 5\n  window_lookback: 120\n  window_lookahead: 0\n  lease_ttl: 125\n  scheduler_config_path: config/kaal-scheduler.yml\n  enable_dispatch_recovery: true\n  enable_log_dispatch_registry: false\n  delayed_job_allowed_class_prefixes: []\n  backend_config: {}\n"
+
+      SCHEDULER_TEMPLATE: "defaults:\n  jobs:\n    - key: \"example:heartbeat\"\n      cron: \"*/5 * * * *\"\n      job_class: \"ExampleHeartbeatJob\"\n      enabled: true\n      args:\n        - \"{{fire_time.iso8601}}\"\n      kwargs:\n        idempotency_key: \"{{idempotency_key}}\"\n"
+
+      def initialize: (root: ::Kaal::rbs_any, backend: ::Kaal::rbs_any, ?time_source: ::Kaal::rbs_any) -> void
+
+      def install_runtime_config: () -> ({ status: :exists, path: ::Kaal::rbs_any } | { status: :create, path: ::Kaal::rbs_any })
+
+      def install_scheduler_config: () -> ({ status: :exists, path: ::Kaal::rbs_any } | { status: :create, path: ::Kaal::rbs_any })
+
+      def install_migrations: () -> ::Kaal::rbs_any
+
+      private
+
+      attr_reader backend: ::Kaal::rbs_any
+
+      attr_reader root: ::Kaal::rbs_any
+
+      attr_reader time_source: ::Kaal::rbs_any
+
+      def validate_backend: (::Kaal::rbs_any backend_name) -> ::Kaal::rbs_any
+
+      def scheduler_config_path: () -> ::Kaal::rbs_any
+
+      def runtime_config_path: () -> ::Kaal::rbs_any
+
+      def scheduler_config_exists?: () -> ::Kaal::rbs_any
+
+      def runtime_config_exists?: () -> ::Kaal::rbs_any
+
+      def scheduler_config_path_string: () -> ::Kaal::rbs_any
+
+      def runtime_config_path_string: () -> ::Kaal::rbs_any
+
+      def ensure_config_dir: () -> ::Kaal::rbs_any
+    end
+  end
+end

data/sig/kaal/rails/railtie.rbs

@@ -0,0 +1,6 @@
+module Kaal
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/sig/kaal/rails/version.rbs

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

data/sig/kaal/rails.rbs

@@ -0,0 +1,15 @@
+module Kaal
+  module Rails
+    DETECT_BACKEND_DEFAULT: ::Kaal::rbs_any
+
+    def self.detect_backend_name: (?::Kaal::rbs_any db_config) -> ::Kaal::rbs_any
+
+    def self.build_backend: (?::Kaal::rbs_any backend_name) -> ::Kaal::rbs_any
+
+    def self.configure_backend!: (?configuration: ::Kaal::rbs_any, ?backend: ::Kaal::rbs_any) -> (nil | ::Kaal::rbs_any)
+
+    def self.load_config_file!: (?configuration: ::Kaal::rbs_any, ?root: ::Kaal::rbs_any, ?environment: ::Kaal::rbs_any) -> ::Kaal::rbs_any
+
+    def self.install!: (?root: ::Kaal::rbs_any, ?backend: ::Kaal::rbs_any) -> { runtime_config: ::Kaal::rbs_any, scheduler_config: ::Kaal::rbs_any, migrations: ::Kaal::rbs_any }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaal-rails
 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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,13 @@ files:
 - lib/kaal/rails/railtie.rb
 - lib/kaal/rails/version.rb
 - lib/tasks/kaal/rails_tasks.rake
+- sig/00_types.rbs
+- sig/dependencies.rbs
+- sig/generators/kaal/install_generator.rbs
+- sig/kaal/rails.rbs
+- sig/kaal/rails/installer.rbs
+- sig/kaal/rails/railtie.rbs
+- sig/kaal/rails/version.rbs
 homepage: https://github.com/Code-Vedas/kaal
 licenses:
 - MIT