ruby_raider 4.1.0 → 4.2.0

data/ruby_raider.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 13.0.6'
   s.add_development_dependency 'reek', '~> 6.5'
   s.add_development_dependency 'rspec', '~> 3.11.0'
+  s.add_development_dependency 'rspec-retry', '~> 0.6'
   s.add_development_dependency 'rubocop', '~> 1.27'
   s.add_development_dependency 'rubocop-performance', '~> 1.15.0'
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'

data/sig/commands/schedule_commands.rbs

@@ -0,0 +1,12 @@
+# Type definitions for ScheduleCommands
+class ScheduleCommands < Thor
+  def add: (String name, *String files) -> void
+  def list: () -> void
+  def remove: (String name) -> void
+  def run_schedule: (String name) -> bot
+  def new_project: () -> RubyRaider::Schedules::Project
+  def cleaned_project: () -> RubyRaider::Schedules::Project
+  def cleanup: (RubyRaider::Schedules::Project project) -> String?
+  def scheduler: () -> RubyRaider::Schedules::Scheduler
+  def stop: (RubyRaider::Schedules::Error error) -> bot
+end

data/sig/ruby_raider/runtime/retry_reset.rbs

@@ -0,0 +1,7 @@
+module Raider
+  module RetryReset
+    CALLBACK: Proc
+
+    def self?.install: (?untyped config) -> bool
+  end
+end

data/sig/ruby_raider/runtime/show_browser.rbs

@@ -0,0 +1,27 @@
+module Raider
+  module ShowBrowser
+    ENV_KEY: String
+    OPTIONS: Array[String]
+    SWITCHES: Array[String]
+    PREFIX: String
+    ARGS_KEYS: Array[Symbol | String]
+
+    def self.headless?: (untyped arg) -> bool
+    def self.without_headless: (untyped args) -> untyped
+    def self.install: (?_Env env) -> Array[Module]
+
+    def headless?: (untyped arg) -> bool
+    def without_headless: (untyped args) -> untyped
+    def install: (?_Env env) -> Array[Module]
+
+    interface _Env
+      def []: (String) -> String?
+    end
+
+    module Filter
+      def initialize: (**untyped opts) -> void
+      def add_argument: (untyped arg) -> untyped
+      def args=: (untyped value) -> untyped
+    end
+  end
+end

data/sig/ruby_raider.rbs

@@ -1,7 +1,11 @@
 # Type definitions for main RubyRaider entry point
 module RubyRaider
   class Raider < Thor
+    GUARDED: Array[String]
+    LEGACY: Array[String]
+
     def self.start: (?Array[String] given_args, ?Hash[Symbol, untyped] config) -> void
+    def self.legacy_stub: (Array[String] given_args) -> Integer
 
     def current_version: () -> String
 

data/sig/utilities/schedules/adapter.rbs

@@ -0,0 +1,5 @@
+module RubyRaider
+  module Schedules
+    def self.adapter: (kind: Kind, ?runner: Os::CommandRunner, ?host_os: String) -> (Os::Launchd | Os::TaskScheduler | Os::Linux)
+  end
+end

data/sig/utilities/schedules/base.rbs

@@ -0,0 +1,15 @@
+module RubyRaider
+  module Schedules
+    NAME: Regexp
+    DAYS: Array[String]
+
+    def self.valid_name?: (untyped name) -> bool
+    def self.printable: (untyped text) -> String
+
+    class Error < StandardError
+      attr_reader exit_code: Integer
+
+      def initialize: (String message, ?exit_code: Integer) -> void
+    end
+  end
+end

data/sig/utilities/schedules/kind.rbs

@@ -0,0 +1,32 @@
+module RubyRaider
+  module Schedules
+    class Kind
+      FLOW_LEGACY: Kind
+      TESTS: Kind
+
+      attr_reader command: String
+      attr_reader os_id_prefix: String
+      attr_reader os_id_pattern: Regexp
+      attr_reader dir: String
+      attr_reader noun: String
+      attr_reader plural: String
+      attr_reader remove_command: String
+      attr_reader stranded_hint: String?
+      attr_reader reserved: Array[String]
+
+      def initialize: (command: String, dir: String, noun: String, plural: String, remove_command: String, ?stranded_hint: String?, ?reserved: Array[String]) -> void
+      def valid_name?: (untyped name) -> bool
+      def name_in: (untyped os_id) -> String?
+      def listed?: (untyped os_id, String prefix) -> bool
+      def cron_tag: () -> String
+      def our_command?: (String text, String? name) -> bool
+      def task_description: (String name, String rule) -> String
+      def task_file_prefix: () -> String
+      def service_description: (String name) -> String
+      def timer_description: (String name) -> String
+      def not_ours: () -> String
+      def stranded: (String name) -> String
+      def unsupported: (String host_os) -> String
+    end
+  end
+end

data/sig/utilities/schedules/legacy.rbs

@@ -0,0 +1,45 @@
+module RubyRaider
+  module Schedules
+    class Legacy
+      KIND: Kind
+      FILE: String
+      MAX_BYTES: Integer
+      NOFOLLOW: Integer
+      NONBLOCK: Integer
+
+      class OldRule < Rule
+        def self.kind: () -> Kind
+      end
+
+      @project: Project
+      @root: String
+      @adapter: untyped
+      @err: untyped
+      @yml_clean: bool
+
+      def self.folder?: (Project project) -> bool
+
+      def initialize: (Project project, ?adapter: untyped, ?err: untyped) -> void
+      def cleanup: (?last: String?) -> String?
+
+      private
+
+      def adapter: () -> untyped
+      def remove_all: (untyped current, Array[String] names) -> [Array[String], Array[[String, String]]]
+      def remove_own: (untyped current, String name) -> void
+      def notice: (Array[String] removed, Array[[String, String]] failed) -> String?
+      def removed_text: (Array[String] names) -> String
+      def failed_text: (Array[[String, String]] failed) -> String
+      def counted: (Integer count) -> String
+      def say: (String text) -> String?
+      def dir: () -> String
+      def yml: () -> String
+      def real_dirs?: () -> bool
+      def yml_names: () -> Array[String]
+      def entry_name: (untyped entry) -> String?
+      def read_entries: () -> Array[untyped]?
+      def read_text: () -> String?
+      def delete_yml: () -> void
+    end
+  end
+end

data/sig/utilities/schedules/legacy_stub.rbs

@@ -0,0 +1,15 @@
+module RubyRaider
+  module Schedules
+    module LegacyStub
+      EXIT: Integer
+      REMOVED: String
+      OPTION: String
+
+      def self.run: (Array[untyped] argv, ?err: untyped) -> Integer
+      def self.clean: (String root, String? name, untyped err) -> void
+      def self.project_root: (Array[untyped] argv) -> String?
+      def self.project_value: (Array[untyped] argv) -> untyped
+      def self.own_name: (Array[untyped] argv) -> String?
+    end
+  end
+end

data/sig/utilities/{flows → schedules}/next_run.rbs

@@ -1,13 +1,13 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module NextRun
       WDAYS: Array[String]
       SEARCH_DAYS: Integer
       SEARCH_MINUTES: Integer
 
-      def self?.after: (Schedule schedule, Time now) -> Time
+      def self?.after: (_OsEntry schedule, Time now) -> Time
       def self?.next_minute: (Integer minute, Time now) -> Time
-      def self?.next_day: (Schedule schedule, Time now) -> Time
+      def self?.next_day: (_OsEntry schedule, Time now) -> Time
       def self?.local: (Date date, Integer hour, Integer minute) -> Time
       def self?.wall: (Time time) -> Array[Integer]
     end

data/sig/utilities/{flows → schedules}/notifier.rbs

@@ -1,5 +1,5 @@
 module RubyRaider
-  module Flows
+  module Schedules
     class Notifier
       MAX: Integer
       TIMEOUT: Integer

data/sig/utilities/{flows → schedules}/os/command_runner.rbs

@@ -1,5 +1,5 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class CommandRunner
         MISSING: Integer

data/sig/utilities/{flows → schedules}/os/cron.rbs

@@ -1,26 +1,26 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class Cron
         CRONTAB: String
-        TAG: String
         MAX_LINE: Integer
-        OS_ID: Regexp
 
+        @kind: Kind
         @runner: CommandRunner
 
-        def initialize: (?runner: CommandRunner) -> void
+        def initialize: (kind: Kind, ?runner: CommandRunner) -> void
         def label: () -> String
         def missed_runs_note: () -> String
-        def line: (Schedule schedule) -> String
-        def install: (Schedule schedule) -> true
+        def line: (_OsEntry schedule) -> String
+        def install: (_OsEntry schedule) -> true
         def remove: (String os_id) -> bool
         def present?: (String os_id) -> bool
+        def list_ids: (String prefix) -> Array[String]
         def usable?: () -> bool
 
         private
 
-        def fields: (Schedule schedule) -> String
+        def fields: (_OsEntry schedule) -> String
         def weekday: (String day) -> Integer
         def escape: (String word) -> String
         def without: (String table, String os_id) -> [String, bool]

data/sig/utilities/{flows → schedules}/os/launchd.rbs

@@ -1,5 +1,5 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class Launchd
         LAUNCHCTL: String
@@ -7,19 +7,20 @@ module RubyRaider
         NOFOLLOW: Integer
         ESCAPES: Hash[String, String]
         HEADER: String
-        OS_ID: Regexp
 
+        @kind: Kind
         @runner: CommandRunner
         @home: String
         @uid: Integer
 
-        def initialize: (?runner: CommandRunner, ?home: String, ?uid: Integer) -> void
+        def initialize: (kind: Kind, ?runner: CommandRunner, ?home: String, ?uid: Integer) -> void
         def label: () -> String
-        def plist: (Schedule schedule) -> String
+        def plist: (_OsEntry schedule) -> String
         def plist_path: (String os_id) -> String
-        def install: (Schedule schedule) -> true
+        def install: (_OsEntry schedule) -> true
         def remove: (String os_id) -> bool
         def present?: (String os_id) -> bool
+        def list_ids: (String prefix) -> Array[String]
 
         private
 
@@ -35,7 +36,7 @@ module RubyRaider
         def array: (Array[Array[String]] items) -> Array[String]
         def dict: (Array[[String, Array[String]]] pairs) -> Array[String]
         def indent: (Array[String] lines) -> Array[String]
-        def calendar: (Schedule schedule) -> Array[String]
+        def calendar: (_OsEntry schedule) -> Array[String]
         def weekday: (String day) -> Integer
         def discard: (String path) -> String
         def write: (String path, String text) -> void

data/sig/utilities/{flows → schedules}/os/linux.rbs

@@ -1,22 +1,28 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class Linux
+        @kind: Kind
         @primary: Systemd | Cron
         @other: Cron?
         @systemd: Systemd
 
-        def self.pick: (?CommandRunner runner) -> Linux
+        def self.pick: (?CommandRunner runner, kind: Kind) -> Linux
 
-        def initialize: (?runner: CommandRunner, ?systemd: Systemd, ?cron: Cron) -> void
+        def initialize: (kind: Kind, ?runner: CommandRunner, ?systemd: Systemd, ?cron: Cron) -> void
         def label: () -> String
         def missed_runs_note: () -> String?
-        def install: (Schedule schedule) -> true
+        def install: (_OsEntry schedule) -> true
         def remove: (String os_id) -> bool
         def present?: (String os_id) -> bool
 
+        def list_ids: (String prefix) -> Array[String]
+
         private
 
+        def other_ids: (String prefix) -> Array[String]
+        def quietly: () { () -> Array[String] } -> Array[String]
+
         def stranded?: (String os_id) -> bool
         def refuse_stranded: (String os_id) -> void
 

data/sig/utilities/{flows → schedules}/os/systemd.rbs

@@ -1,28 +1,29 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class Systemd
         SYSTEMCTL: String
         NOFOLLOW: Integer
         QUOTED: Hash[String, String]
         CALENDAR: Hash[String, String]
-        OS_ID: Regexp
         UNSAFE_PATH: Regexp
 
+        @kind: Kind
         @runner: CommandRunner
         @home: String
         @config_home: String?
 
-        def initialize: (?runner: CommandRunner, ?home: String, ?config_home: String?) -> void
+        def initialize: (kind: Kind, ?runner: CommandRunner, ?home: String, ?config_home: String?) -> void
         def label: () -> String
         def missed_runs_note: () -> nil
-        def service: (Schedule schedule) -> String
-        def timer: (Schedule schedule) -> String
-        def unit_path: (String os_id, String kind) -> String
-        def install: (Schedule schedule) -> true
+        def service: (_OsEntry schedule) -> String
+        def timer: (_OsEntry schedule) -> String
+        def unit_path: (String os_id, String unit) -> String
+        def install: (_OsEntry schedule) -> true
         def remove: (String os_id) -> bool
         def present?: (String os_id) -> bool
         def usable?: () -> bool
+        def list_ids: (String prefix) -> Array[String]
         def unit_files?: (String os_id) -> bool
 
         private

data/sig/utilities/{flows → schedules}/os/task_scheduler.rbs

@@ -1,5 +1,5 @@
 module RubyRaider
-  module Flows
+  module Schedules
     module Os
       class TaskScheduler
         interface _Clock
@@ -9,12 +9,13 @@ module RubyRaider
         FOLDER: String
         ESCAPES: Hash[String, String]
         NAMESPACE: String
-        OS_ID: Regexp
         NEEDS_QUOTES: Regexp
         GLOB: Regexp
         EXPANDS: Regexp
         DAY_NAMES: Array[String]
+        ROW: Regexp
 
+        @kind: Kind
         @runner: CommandRunner
         @clock: _Clock
         @schtasks: String
@@ -24,29 +25,31 @@ module RubyRaider
         def self.odd_doubled: (String slashes) -> String
         def self.join: (Array[String] args) -> String
 
-        def initialize: (?runner: CommandRunner, ?clock: _Clock, ?schtasks: String) -> void
+        def initialize: (kind: Kind, ?runner: CommandRunner, ?clock: _Clock, ?schtasks: String) -> void
         def label: () -> String
         def task_name: (untyped os_id) -> String
-        def task_xml: (Schedule schedule) -> String
-        def install: (Schedule schedule) -> true
+        def task_xml: (_OsEntry schedule) -> String
+        def install: (_OsEntry schedule) -> true
         def remove: (String os_id) -> bool
         def present?: (String os_id) -> bool
+        def list_ids: (String prefix) -> Array[String]
 
         private
 
         def schtasks: (*String args) -> CommandRunner::Result
         def list: () -> CommandRunner::Result
-        def listed?: (CommandRunner::Result listing, String name) -> bool
-        def refuse_expansion: (Schedule schedule) -> void
+        def tasks: () -> String
+        def listed?: (String text, String name) -> bool
+        def refuse_expansion: (_OsEntry schedule) -> void
         def checked_os_id: (untyped os_id) -> String
         def escape: (untyped value) -> String
         def text: (String name, untyped value) -> Array[String]
         def element: (String tag, Array[untyped] children) -> Array[String]
         def indent: (Array[String] lines) -> Array[String]
-        def trigger: (Schedule schedule) -> Array[untyped]
-        def calendar: (Schedule schedule, String every) -> Array[String]
+        def trigger: (_OsEntry schedule) -> Array[untyped]
+        def calendar: (_OsEntry schedule, String every) -> Array[String]
         def settings: () -> Array[Array[String]]
-        def action: (Schedule schedule) -> Array[Array[String]]
+        def action: (_OsEntry schedule) -> Array[Array[String]]
       end
     end
   end

data/sig/utilities/schedules/os_enumerator.rbs

@@ -0,0 +1,12 @@
+module RubyRaider
+  module Schedules
+    class OsEnumerator
+      @adapter: untyped
+      @kind: Kind
+      @prefix: String
+
+      def initialize: (untyped adapter, schedule_class: singleton(Rule), root: String) -> void
+      def names: () -> Array[String]
+    end
+  end
+end

data/sig/utilities/schedules/project.rbs

@@ -0,0 +1,22 @@
+module RubyRaider
+  module Schedules
+    class Project
+      DRIVER_HELPER: String
+      REQUIRES_RUNTIME: Regexp
+      MAX_HELPER_BYTES: Integer
+      NO_RUNTIME: String
+      OWN_VERSION: String
+      LOCKED_RAIDER: Regexp
+      MAX_LOCK_BYTES: Integer
+
+      attr_reader root: String
+
+      def initialize: (String path) -> void
+      def path: (String relative) -> String
+      def check_show_browser!: () -> void
+      def check_raider_version!: (?String own) -> void
+      def locked_raider_version: () -> (String | :no_lock | nil)
+      def runtime_driver?: () -> bool
+    end
+  end
+end

data/sig/utilities/{flows/schedule.rbs → schedules/rule.rbs}

@@ -1,6 +1,23 @@
 module RubyRaider
-  module Flows
-    class Schedule
+  module Schedules
+    # What an OS scheduler adapter and NextRun read from a schedule, tests or 4.1
+    interface _OsEntry
+      def name: () -> String
+      def every: () -> String
+      def on: () -> String?
+      def os_id: () -> String
+      def ruby: () -> String
+      def hour: () -> Integer
+      def minute: () -> Integer
+      def days: () -> Array[String]
+      def argv: () -> Array[String]
+      def env: () -> Hash[String, String]
+      def working_directory: () -> String
+      def log_path: () -> String
+      def rule_text: () -> String
+    end
+
+    class Rule
       EVERY: Array[String]
       DAYS: Array[String]
       DAYS_RULE: String
@@ -8,15 +25,12 @@ module RubyRaider
       MINUTE: Regexp
       GEM_ENV: Array[String]
       SYSTEM_PATH: Array[String]
-      OS_ID_PREFIX: String
-      KEYS: Array[String]
 
       attr_reader name: String
       attr_reader every: String
       attr_reader at: String
       attr_reader on: String?
       attr_reader retries: Integer
-      attr_reader inputs: Array[String]
       attr_reader notify: bool
       attr_reader os_id: String
       attr_reader ruby: String
@@ -25,13 +39,13 @@ module RubyRaider
       attr_reader project_root: String
       attr_reader created_at: String
 
-      def self.build: (project: Project, name: String, every: String, ?at: String?, ?on: String?, ?retries: untyped, ?inputs: Array[String], ?notify: bool, ?now: Time) -> Schedule
-      def self.from_h: (untyped hash, String project_root) -> Schedule
+      def self.kind: () -> Kind
       def self.os_id_for: (String project_root, String name) -> String
+      def self.os_id_prefix_for: (String project_root) -> String
       def self.bundle_path: () -> String
       def self.captured_gem_env: () -> Hash[String, String]
 
-      def initialize: (name: untyped, every: untyped, at: untyped, on: untyped, retries: untyped, inputs: untyped, os_id: untyped, ruby: untyped, bundle: untyped, gem_env: untyped, project_root: untyped, created_at: untyped, ?notify: untyped) -> void
+      def kind: () -> Kind
       def hour: () -> Integer
       def minute: () -> Integer
       def days: () -> Array[String]
@@ -40,18 +54,15 @@ module RubyRaider
       def working_directory: () -> String
       def log_path: () -> String
       def rule_text: () -> String
-      def to_h: () -> Hash[String, untyped]
 
       private
 
-      def checked_name: (untyped name) -> String
       def checked_every: (untyped every) -> String
       def checked_at: (untyped at) -> String
       def clock: (untyped at) -> String
       def checked_on: (untyped on) -> String?
       def checked_retries: (untyped retries) -> Integer
-      def checked_inputs: (untyped inputs) -> Array[String]
-      def checked_notify: (untyped notify) -> bool
+      def checked_flag: (String label, untyped flag) -> bool
       def checked_os_id: (untyped os_id) -> String
       def checked_path: (String label, untyped path) -> String
       def checked_gem_env: (untyped gem_env) -> Hash[String, String]

data/sig/utilities/schedules/run_lock.rbs

@@ -0,0 +1,29 @@
+module RubyRaider
+  module Schedules
+    class RunLock
+      LOCK: String
+      RUNNING: String
+      MAX_RUNNING_BYTES: Integer
+
+      @project: Project
+      @lock: File?
+      @run_id: String?
+
+      def initialize: (Project project) -> void
+      def acquire: (name: String, run_id: String, started_at: String) -> bool
+      def release: () -> void
+
+      private
+
+      def lock: (String path) -> bool
+      def busy: () -> false
+      def inspect_running: (String running) -> Hash[Symbol, untyped]?
+      def remove_stale: (String running, Array[Integer]? id) -> bool
+      def restore: (String aside, String running) -> void
+      def live?: (Hash[String, untyped]? data) -> bool
+      def read_running: (String running) -> Hash[String, untyped]?
+      def parse_running: (File file) -> Hash[String, untyped]?
+      def write_running: (String running, String name, String run_id, String started_at) -> bool
+    end
+  end
+end

data/sig/utilities/schedules/run_log.rbs

@@ -0,0 +1,33 @@
+module RubyRaider
+  module Schedules
+    class RunLog
+      MAX_BYTES: Integer
+      MAX_LINES: Integer
+      FILE: String
+      LOCK: String
+      NOFOLLOW: Integer
+      NONBLOCK: Integer
+
+      @project: Project
+      @parts: Array[String]
+      @file: String
+      @lock: String
+
+      def self.private_dir: (Project project, *String parts) -> String
+
+      def initialize: (Project project, String name, ?dir: String) -> void
+      def lines: () -> Array[Hash[String, untyped]]
+      def last: () -> Hash[String, untyped]?
+      def last_result: () -> Hash[String, untyped]?
+      def find: (String run_id) -> Hash[String, untyped]?
+      def append: (Hash[String, untyped] line) -> void
+
+      private
+
+      def locked: [T] () { () -> T } -> T
+      def add: (String text) -> void
+      def replace: (String text) -> void
+      def tail: () -> String
+    end
+  end
+end

data/sig/utilities/schedules/run_report.rbs

@@ -0,0 +1,34 @@
+module RubyRaider
+  module Schedules
+    class RunReport
+      DIR: String
+      RUN: String
+      INDEX: String
+      ATTACHMENTS: String
+      SLACK: Integer
+      MAX_RUN_BYTES: Integer
+      MAX_ATTACHMENT_BYTES: Integer
+      MAX_ATTACHMENT_DEPTH: Integer
+      MAX_ATTACHMENT_FILES: Integer
+
+      @dir: String
+      @run_json: String
+
+      attr_reader counts: Hash[String, Integer]
+
+      def self.load: (Project project, since: Time) -> RunReport?
+      def self.read_file: (String path, Integer max) -> [String, Time]?
+      def self.fresh?: (untyped run, Time? mtime, Time since) -> bool
+
+      def initialize: (String dir, String run_json, Array[untyped] results) -> void
+      def copy_to: (String target) -> bool
+
+      private
+
+      def copy_attachments: (String temp) -> void
+      def copy_file: (String source, String target, Integer size) -> void
+      def regular_files: (String dir, ?String? prefix, ?Hash[String, Integer] found, ?Integer depth) -> Hash[String, Integer]?
+      def swap: (String temp, String target) -> void
+    end
+  end
+end