yobi 0.1.0 → 0.3.0

data/sig/yobi.rbs

@@ -1,10 +1,20 @@
 module Yobi
   VERSION: String
 
+  class FancyHash < Hash[String, untyped]
+    def initialize: (Hash[String, untyped] raw) -> void
+  end
+
+  class Initialized < FancyHash
+    def id: () -> String
+
+    def repository: () -> String
+  end
+
   class Error < StandardError
   end
 
-  class ExitError < SimpleDelegator
+  class ExitError < FancyHash
     LINE_PATTERN: Regexp
 
     def self.from_output: (ResticOutput output) -> ExitError?
@@ -79,7 +89,7 @@ module Yobi
     attr_reader io: IO
     attr_reader pid: Integer
 
-    def initialize: (IO io, pid: Integer, output_file: File, argv: Array[String]) -> void
+    def initialize: (IO io, pid: Integer, output: ResticOutput, argv: Array[String]) -> void
 
     def closed?: () -> bool
 
@@ -88,10 +98,10 @@ module Yobi
     def each: () { (String chunk) -> void } -> void
   end
 
-  class Mount
+  class MountHandle
     attr_reader mountpoint: String
 
-    def initialize: (wait_thr: Process::Waiter, mountpoint: String, output: IO, output_file: File, argv: Array[String]) -> void
+    def initialize: (wait_thr: Process::Waiter, mountpoint: String, pipe: IO, output: ResticOutput, argv: Array[String]) -> void
 
     def pid: () -> Integer
 
@@ -103,7 +113,9 @@ module Yobi
   class ResticOutput
     DEFAULT_TAIL_CHUNK_SIZE: Integer
 
-    def initialize: (File file, ?tail_chunk_size: Integer) -> void
+    attr_reader file: File
+
+    def initialize: (?tail_chunk_size: Integer, ?transform: ^(Hash[String, untyped]) -> untyped) -> void
 
     def index: () -> Hash[String, Array[Integer]]
 
@@ -114,10 +126,31 @@ module Yobi
     def each_line: () { (String line) -> void } -> void
                  | () -> Enumerator[String, void]
 
-    def to_s: () -> String
+    def messages: [T] (?String? message_type) { (Hash[String, untyped] message) -> T } -> ResticOutput::LazyList[T]
+                | (?String? message_type) -> Enumerator[Hash[String, untyped], void]
+
+    def stderr_lines: () { (String line) -> void } -> void
+                     | () -> Enumerator[String, void]
+
+    def write_and_parse: (String line, (:stdout | :stderr) origin) -> untyped
+
+    class LazyList[Elem]
+      include Enumerable[Elem]
+
+      INSPECT_PREVIEW_SIZE: Integer
+
+      def initialize: (ResticOutput output, Array[Integer] offsets, ^(Hash[String, untyped]) -> Elem transform) -> void
+
+      def each: () { (Elem item) -> void } -> void
+              | () -> Enumerator[Elem, void]
+
+      def size: () -> Integer
+
+      alias length size
+    end
   end
 
-  class Snapshot < SimpleDelegator
+  class Snapshot < FancyHash
     def id: () -> String
 
     def short_id: () -> String
@@ -131,11 +164,64 @@ module Yobi
     def paths: () -> Array[String]
 
     def parent_id: () -> String?
+
+    def summary: () -> SnapshotSummary
+  end
+
+  class SnapshotSummary < FancyHash
+    def backup_start: () -> Time?
+
+    def backup_end: () -> Time?
+
+    def files_new: () -> Integer
+
+    def files_changed: () -> Integer
+
+    def files_unmodified: () -> Integer
+
+    def dirs_new: () -> Integer
+
+    def dirs_changed: () -> Integer
+
+    def dirs_unmodified: () -> Integer
+
+    def data_blobs: () -> Integer
+
+    def tree_blobs: () -> Integer
+
+    def data_added: () -> Integer
+
+    def data_added_packed: () -> Integer
+
+    def total_files_processed: () -> Integer
+
+    def total_bytes_processed: () -> Integer
   end
 
-  type password = String | [:command, String] | [:file, String] | :insecure_no_password | (^() -> String) | nil
+  class RepositoryStats < FancyHash
+    def total_size: () -> Integer
+
+    def total_file_count: () -> Integer
+
+    def total_blob_count: () -> Integer
+
+    def snapshots_count: () -> Integer
+
+    def total_uncompressed_size: () -> Integer
+
+    def compression_ratio: () -> Float
+
+    def compression_progress: () -> Float
+
+    def compression_space_saving: () -> Float
+  end
+
+  type password = String | [:command, String] | [:file, String] | :insecure_no_password | (^() -> String)
+  type from_password = password | nil
+  type new_password = String | [:file, String] | :insecure_no_password | (^() -> String)
   type backend_credentials = Hash[String, String] | (^() -> Hash[String, String])
   type restic_or_path = Restic | String | nil
+  type from_repo = String | Repository | [:file, String]
 
   class Restic
     MINIMUM_VERSION: Gem::Version
@@ -174,13 +260,11 @@ module Yobi
 
     def append_global_flags: (ArgvBuilder a) -> void
 
-    def inspect: () -> String
-
-    def version: () -> Hash[String, untyped]
+    def version: () -> ResticVersion
 
     def cache: (?cleanup: bool, ?max_age: String?, ?no_size: bool) -> true
 
-    def run: (Array[String] argv, ?extra_env: Hash[String, String], ?skip_version_check: bool) ?{ (Hash[String, untyped] message) -> void } -> execution
+    def run: (Array[String] argv, ?extra_env: Hash[String, String], ?skip_version_check: bool, ?output: ResticOutput?) ?{ (untyped message) -> void } -> execution
 
     def self.dispatch: (execution execution) -> execution
 
@@ -189,7 +273,17 @@ module Yobi
 
     def ensure_minimum_version!: () -> void
 
-    def run_mount: (Array[String] argv, mountpoint: String, ?extra_env: Hash[String, String], ?ready_timeout: Numeric) -> Mount
+    def run_mount: (Array[String] argv, mountpoint: String, ?extra_env: Hash[String, String], ?ready_timeout: Numeric) -> MountHandle
+  end
+
+  class ResticVersion < FancyHash
+    def version: () -> String
+
+    def go_version: () -> String?
+
+    def go_os: () -> String?
+
+    def go_arch: () -> String?
   end
 
   class Repository
@@ -197,17 +291,19 @@ module Yobi
     attr_reader password: password
     attr_reader backend_credentials: backend_credentials
 
-    def initialize: (url: String, ?password: password, ?backend_credentials: backend_credentials, ?restic: restic_or_path) -> void
+    def initialize: (url: String, password: password, ?backend_credentials: backend_credentials, ?restic: restic_or_path) -> void
 
     def env: () -> Hash[String, String]
 
-    def inspect: () -> String
+    def init: (?copy_chunker_params: bool, ?from_key_hint: String?, ?from_password: from_password,
+      ?from_repo: from_repo?, ?repository_version: String?) -> Initialized
+
+    def init_mirror: (url: String, password: password, ?backend_credentials: backend_credentials,
+      ?restic: restic_or_path, ?repository_version: String?) -> Repository
 
-    def init: (?copy_chunker_params: bool, ?from_insecure_no_password: bool, ?from_key_hint: String?,
-      ?from_password_command: String?, ?from_password_file: String?, ?from_repo: String?,
-      ?from_repository_file: String?, ?repository_version: String?) -> Hash[String, untyped]
+    def cat_config: () -> Hash[String, untyped]
 
-    def config: () -> Hash[String, untyped]
+    alias config cat_config
 
     def backup: (source: String | [:stdin_from_command, String | Array[String]] | [:stdin_from_command, String | Array[String], String],
       ?excludes: Array[String] | String, ?exclude_files: Array[String] | String,
@@ -219,7 +315,7 @@ module Yobi
       ?host: String?, ?ignore_ctime: bool, ?ignore_inode: bool, ?no_scan: bool,
       ?one_file_system: bool, ?parent: String?, ?read_concurrency: Integer?,
       ?skip_if_unchanged: bool, ?time: String?, ?verbose: bool, ?with_atime: bool)
-      ?{ (BackupStatus | BackupError | BackupVerboseStatus message) -> void } -> BackupOutcome
+      ?{ (BackupStatus | BackupError | BackupVerboseStatus | BackupSummary message) -> void } -> BackupOutcome
 
     def cat_snapshot: (String | Snapshot id) -> Hash[String, untyped]
 
@@ -240,8 +336,8 @@ module Yobi
     def check: (?hosts: Array[String] | String, ?paths: Array[String] | String, ?read_data: bool,
       ?read_data_subset: String?, ?tags: Array[String] | String, ?with_cache: bool) -> CheckOutcome
 
-    def copy: (from_repo: String | Repository, ?from_password: password, ?snapshot_ids: Array[String] | String,
-      ?from_key_hint: String?, ?from_repository_file: String?, ?hosts: Array[String] | String,
+    def copy: (from_repo: from_repo, ?from_password: from_password, ?snapshot_ids: Array[String] | String,
+      ?from_key_hint: String?, ?hosts: Array[String] | String,
       ?paths: Array[String] | String, ?tags: Array[String] | String) -> true
 
     def diff: (from: String, to: String, ?metadata: bool) -> DiffOutcome
@@ -257,7 +353,7 @@ module Yobi
     def find: (patterns: Array[String] | String, ?blob: bool, ?pack: bool, ?tree: bool,
       ?hosts: Array[String] | String, ?human_readable: bool, ?ignore_case: bool, ?long: bool,
       ?newest: String?, ?oldest: String?, ?paths: Array[String] | String, ?reverse: bool,
-      ?show_pack_id: bool, ?snapshot_ids: Array[String] | String, ?tags: Array[String] | String) -> FindMatches
+      ?show_pack_id: bool, ?snapshot_ids: Array[String] | String, ?tags: Array[String] | String) -> Array[MatchesPerSnapshot]
 
     def forget: (?keep_last: Integer?, ?keep_hourly: Integer?, ?keep_daily: Integer?, ?keep_weekly: Integer?,
       ?keep_monthly: Integer?, ?keep_yearly: Integer?, ?keep_within: String?, ?keep_within_hourly: String?,
@@ -266,19 +362,19 @@ module Yobi
       ?tags: Array[String] | String, ?paths: Array[String] | String, ?compact: bool, ?group_by: String?,
       ?dry_run: bool, ?prune: bool, ?unsafe_allow_remove_all: bool, ?max_unused: String?,
       ?max_repack_size: String?, ?repack_cacheable_only: bool, ?repack_uncompressed: bool,
-      ?repack_smaller_than: String?) -> ForgetGroups
+      ?repack_smaller_than: String?) -> Array[ForgetGroup]
 
-    def key_add: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+    def key_add: (new_password: new_password, ?host: String?, ?user: String?) -> true
 
-    def add_key: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+    def add_key: (new_password: new_password, ?host: String?, ?user: String?) -> true
 
-    def key_list: () -> Keys
+    def key_list: () -> Array[Key]
 
-    def keys: () -> Keys
+    def keys: () -> Array[Key]
 
-    def key_passwd: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+    def key_passwd: (new_password: new_password, ?host: String?, ?user: String?) -> true
 
-    def change_password: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+    def change_password: (new_password: new_password, ?host: String?, ?user: String?) -> true
 
     def key_remove: (id: String) -> true
 
@@ -295,11 +391,11 @@ module Yobi
     def mount: (mountpoint: String, ?hosts: Array[String] | String, ?paths: Array[String] | String,
       ?tags: Array[String] | String, ?allow_other: bool, ?no_default_permissions: bool,
       ?owner_root: bool, ?path_templates: Array[String] | String, ?time_template: String?,
-      ?ready_timeout: Numeric) { (Mount mount) -> untyped } -> untyped
+      ?ready_timeout: Numeric) { (MountHandle mount) -> untyped } -> untyped
                 | (mountpoint: String, ?hosts: Array[String] | String, ?paths: Array[String] | String,
       ?tags: Array[String] | String, ?allow_other: bool, ?no_default_permissions: bool,
       ?owner_root: bool, ?path_templates: Array[String] | String, ?time_template: String?,
-      ?ready_timeout: Numeric) -> Mount
+      ?ready_timeout: Numeric) -> MountHandle
 
     def prune: (?dry_run: bool, ?max_repack_size: String?, ?max_unused: String?,
       ?repack_cacheable_only: bool, ?repack_smaller_than: String?, ?repack_uncompressed: bool,
@@ -333,10 +429,10 @@ module Yobi
       ?new_time: String?, ?snapshot_summary: bool) -> true
 
     def snapshots: (?tags: Array[String] | String, ?hosts: Array[String] | String,
-      ?paths: Array[String] | String, ?compact: bool, ?group_by: String?, ?latest: Integer?) -> Snapshots
+      ?paths: Array[String] | String, ?compact: bool, ?group_by: String?, ?latest: Integer?) -> Array[Snapshot]
 
     def stats: (?snapshot_ids: Array[String] | String, ?hosts: Array[String] | String,
-      ?mode: String | Symbol | nil, ?paths: Array[String] | String, ?tags: Array[String] | String) -> Hash[String, untyped]
+      ?mode: String | Symbol | nil, ?paths: Array[String] | String, ?tags: Array[String] | String) -> RepositoryStats
 
     def tag: (?snapshot_ids: Array[String] | String, ?add: Array[String] | String,
       ?remove: Array[String] | String, ?set: Array[String] | String, ?tags: Array[String] | String,
@@ -345,24 +441,38 @@ module Yobi
     def unlock: (?remove_all: bool) -> true
   end
 
+  module BackupMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (BackupStatus | BackupError | BackupVerboseStatus | BackupSummary | Hash[String, untyped])
+  end
+
   class BackupOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
     COMMAND_OUTPUT_LINE_PATTERN: Regexp
 
-    def success?: () -> bool
+    def initialize: (execution execution) -> void
+
+    def errors: () -> ResticOutput::LazyList[BackupError]
 
-    def partial?: () -> bool
+    def messages: () -> ResticOutput::LazyList[BackupStatus | BackupError | BackupVerboseStatus | BackupSummary | Hash[String, untyped]]
 
-    def errors: () -> BackupErrors
+    def command_output: () { (String line) -> void } -> void
+                       | () -> Enumerator[String, void]
 
-    def command_output: () -> Array[String]
+    def summary: () -> BackupSummary
 
-    def report: () -> Hash[String, untyped]
+    alias report summary
+
+    def inspect: () -> String
   end
 
-  class BackupStatus < SimpleDelegator
+  class BackupSummary < FancyHash
+    def backup_start: () -> Time?
+
+    def backup_end: () -> Time?
+  end
+
+  class BackupStatus < FancyHash
     def percent_done: () -> Float?
 
     def total_files: () -> Integer?
@@ -378,7 +488,7 @@ module Yobi
     def error_count: () -> Integer
   end
 
-  class BackupError < SimpleDelegator
+  class BackupError < FancyHash
     def message: () -> String?
 
     def during: () -> String?
@@ -386,16 +496,7 @@ module Yobi
     def item: () -> String?
   end
 
-  class BackupErrors
-    include Enumerable[BackupError]
-
-    def initialize: (ResticOutput output) -> void
-
-    def each: () { (BackupError error) -> void } -> void
-            | () -> Enumerator[BackupError, void]
-  end
-
-  class BackupVerboseStatus < SimpleDelegator
+  class BackupVerboseStatus < FancyHash
     def action: () -> String
 
     def item: () -> String
@@ -413,53 +514,97 @@ module Yobi
     def total_files: () -> Integer
   end
 
+  module CheckMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (CheckError | CheckSummary | Hash[String, untyped])
+  end
+
   class CheckOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
-    def report: () -> Hash[String, untyped]
+    def initialize: (execution execution) -> void
+
+    def summary: () -> CheckSummary
 
-    def errors: () -> CheckErrors
+    alias report summary
+
+    def errors: () -> ResticOutput::LazyList[CheckError]
   end
 
-  class CheckError < SimpleDelegator
+  class CheckError < FancyHash
     def message: () -> String
   end
 
-  class CheckErrors
-    include Enumerable[CheckError]
+  class CheckSummary < FancyHash
+    def num_errors: () -> Integer
+
+    def broken_packs: () -> Array[String]
 
-    def initialize: (ResticOutput output) -> void
+    def suggest_repair_index?: () -> bool
+
+    def suggest_prune?: () -> bool
+  end
 
-    def each: () { (CheckError error) -> void } -> void
-            | () -> Enumerator[CheckError, void]
+  module DiffMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (DiffChange | DiffStatistics | Hash[String, untyped])
   end
 
   class DiffOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
-    def report: () -> Hash[String, untyped]
+    def initialize: (execution execution) -> void
+
+    def statistics: () -> DiffStatistics
 
-    def changes: () -> DiffChanges
+    alias report statistics
+
+    def changes: () -> ResticOutput::LazyList[DiffChange]
   end
 
-  class DiffChange < SimpleDelegator
+  class DiffChange < FancyHash
     def path: () -> String
 
     def modifier: () -> String
+
+    def added?: () -> bool
+
+    def removed?: () -> bool
+
+    def type_changed?: () -> bool
+
+    def modified?: () -> bool
+
+    def metadata_updated?: () -> bool
+
+    def bitrot?: () -> bool
   end
 
-  class DiffChanges
-    include Enumerable[DiffChange]
+  class DiffStatistics < FancyHash
+    def source_snapshot: () -> String?
+
+    def target_snapshot: () -> String?
 
-    def initialize: (ResticOutput output) -> void
+    def changed_files: () -> Integer
 
-    def each: () { (DiffChange change) -> void } -> void
-            | () -> Enumerator[DiffChange, void]
+    def added: () -> DiffStat
+
+    def removed: () -> DiffStat
   end
 
-  class FindMatch < SimpleDelegator
+  class DiffStat < FancyHash
+    def files: () -> Integer
+
+    def dirs: () -> Integer
+
+    def others: () -> Integer
+
+    def data_blobs: () -> Integer
+
+    def tree_blobs: () -> Integer
+
+    def bytes: () -> Integer
+  end
+
+  class FindMatch < FancyHash
     def path: () -> String
 
     def type: () -> String
@@ -485,42 +630,17 @@ module Yobi
     def ctime: () -> Time
   end
 
-  class MatchesPerSnapshot < SimpleDelegator
-    def snapshot: () -> Hash[String, untyped]
+  class MatchesPerSnapshot < FancyHash
+    def snapshot: () -> String
+
+    alias snapshot_id snapshot
 
     def hits: () -> Integer
 
     def matches: () -> Array[FindMatch]
   end
 
-  class FindMatches
-    include Enumerable[MatchesPerSnapshot]
-
-    attr_reader output: ResticOutput
-
-    def initialize: (ResticOutput output) -> void
-
-    def each: () { (MatchesPerSnapshot matches) -> void } -> void
-            | () -> Enumerator[MatchesPerSnapshot, void]
-  end
-
-  class ForgetGroups
-    include Enumerable[ForgetGroup]
-
-    attr_reader exit_code: Integer
-    attr_reader output: ResticOutput
-
-    def initialize: (Integer exit_code, ResticOutput output) -> void
-
-    def each: () { (ForgetGroup group) -> void } -> void
-            | () -> Enumerator[ForgetGroup, void]
-
-    def success?: () -> bool
-
-    def partial?: () -> bool
-  end
-
-  class ForgetGroup < SimpleDelegator
+  class ForgetGroup < FancyHash
     def host: () -> String
 
     def tags: () -> Array[String]
@@ -531,16 +651,16 @@ module Yobi
 
     def remove: () -> Array[Snapshot]
 
-    def reasons: () -> Array[ForgetReason]
+    def reasons: () -> Array[KeepReason]
   end
 
-  class ForgetReason < SimpleDelegator
+  class KeepReason < FancyHash
     def snapshot: () -> Snapshot
 
     def matches: () -> Array[String]
   end
 
-  class Key < SimpleDelegator
+  class Key < FancyHash
     def id: () -> String
 
     def user_name: () -> String
@@ -552,27 +672,23 @@ module Yobi
     def created: () -> Time
   end
 
-  class Keys
-    include Enumerable[Key]
-
-    attr_reader output: ResticOutput
-
-    def initialize: (ResticOutput output) -> void
-
-    def each: () { (Key key) -> void } -> void
-            | () -> Enumerator[Key, void]
+  module LsMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (Snapshot | Node | Hash[String, untyped])
   end
 
   class LsOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
+    def initialize: (execution execution) -> void
+
     def snapshot: () -> Snapshot
 
-    def entries: () -> LsEntries
+    def nodes: () -> ResticOutput::LazyList[Node]
+
+    alias entries nodes
   end
 
-  class LsEntry < SimpleDelegator
+  class Node < FancyHash
     def name: () -> String
 
     def type: () -> String
@@ -596,23 +712,21 @@ module Yobi
     def ctime: () -> Time
   end
 
-  class LsEntries
-    include Enumerable[LsEntry]
-
-    def initialize: (ResticOutput output) -> void
-
-    def each: () { (LsEntry entry) -> void } -> void
-            | () -> Enumerator[LsEntry, void]
+  module RestoreMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (RestoreStatus | RestoreVerboseStatus | Hash[String, untyped])
   end
 
   class RestoreOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
-    def report: () -> Hash[String, untyped]
+    def initialize: (execution execution) -> void
+
+    def summary: () -> Hash[String, untyped]
+
+    alias report summary
   end
 
-  class RestoreStatus < SimpleDelegator
+  class RestoreStatus < FancyHash
     def percent_done: () -> Float?
 
     def total_files: () -> Integer?
@@ -624,7 +738,7 @@ module Yobi
     def bytes_restored: () -> Integer?
   end
 
-  class RestoreVerboseStatus < SimpleDelegator
+  class RestoreVerboseStatus < FancyHash
     def action: () -> String
 
     def item: () -> String
@@ -632,29 +746,29 @@ module Yobi
     def size: () -> Integer
   end
 
-  class Snapshots
-    include Enumerable[Snapshot]
-
-    attr_reader output: ResticOutput
-
-    def initialize: (ResticOutput output) -> void
-
-    def each: () { (Snapshot snapshot) -> void } -> void
-            | () -> Enumerator[Snapshot, void]
+  module TagMessageWrapper
+    def self.call: (Hash[String, untyped] raw) -> (TagChange | TagSummary | Hash[String, untyped])
   end
 
   class TagOutcome
-    attr_reader exit_code: Integer
     attr_reader output: ResticOutput
 
-    def report: () -> Hash[String, untyped]
+    def initialize: (execution execution) -> void
+
+    def summary: () -> TagSummary
 
-    def changes: () -> Array[TagChange]
+    alias report summary
+
+    def changes: () -> ResticOutput::LazyList[TagChange]
   end
 
-  class TagChange < SimpleDelegator
+  class TagChange < FancyHash
     def old_snapshot_id: () -> String
 
     def new_snapshot_id: () -> String
   end
+
+  class TagSummary < FancyHash
+    def changed_snapshots: () -> Integer
+  end
 end