litestream 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9a72285610321f39ded2e66eca9bc926f1643b03216d83f34f1395b7465a76
-  data.tar.gz: abfde27ae5ee756fa0c508005d09e6d0f3228d681e2c2cdf07caabe45f2492b0
+  metadata.gz: f1633c03c287fff1a52b19f8f626c402d29dded8f9d89ff7322f2d423dcb8224
+  data.tar.gz: e7758adbc37e052f8a77ca5cb2b54b3695d4931493bc741791f3fa8e462021ee
 SHA512:
-  metadata.gz: 5bf7e5b45727750a18e8bdc2af52be0514a78e4f5c0e2ecce8bc592b07c215e9680d9f05acaee664fecc609b3b95e2e3dfb51ea3c1e902ec9ad030a85a3c2ce8
-  data.tar.gz: 49776dc61cc1001badd86a87e297058befa36295e7fff95e133a45fd27d881172f5ef0ce7c7d8d9069a9905f07190432892e01f2afb501e9f00ef817d6dfb148
+  metadata.gz: 5dfdda1fef5de161f13418a2d2bd5eea97a522c16296f8fdf5828f9e9c2e03d035efd8b60f76c2cbf201141de26e992cf69ee56d0d587e6ca880b08082e65f4b
+  data.tar.gz: f0346447a34190849d752113227890a53c6155589c21471c33cbba10dc0e40c87bb7224573f01c40eca67938428cd2dc04beaacd9c4f64d34a1c1e733cb5ea7b

data/lib/litestream/commands.rb

@@ -17,8 +17,8 @@ module Litestream
     # raised when a litestream command requires a database argument but it isn't provided
     DatabaseRequiredException = Class.new(StandardError)
 
-    # raised when litestream fails to restore a database backup
-    BackupFailedException = Class.new(StandardError)
+    # raised when a litestream command fails
+    CommandFailedException = Class.new(StandardError)
 
     class << self
       def platform
@@ -77,16 +77,14 @@ module Litestream
       end
 
       def replicate(async: false, **argv)
-        execute("replicate", argv, async: async, hashify: false)
+        execute("replicate", argv, async: async, tabled_output: false)
       end
 
       def restore(database, async: false, **argv)
         raise DatabaseRequiredException, "database argument is required for restore command, e.g. litestream:restore -- --database=path/to/database.sqlite" if database.nil?
         argv.stringify_keys!
 
-        execute("restore", argv, database, async: async, hashify: false)
-
-        argv["-o"] || database
+        execute("restore", argv, database, async: async, tabled_output: false)
       end
 
       def verify(database, async: false, **argv)
@@ -101,10 +99,7 @@ module Litestream
         args = {
           "-o" => backup
         }.merge(argv)
-
-        backup = restore(database, async: false, **args)
-
-        raise BackupFailedException, "Failed to create backup for validation" unless File.exist?(backup)
+        restore(database, async: false, **args)
 
         restored_tables_count = `sqlite3 #{backup} "select count(*) from sqlite_schema where type='table';"`.chomp.to_i
         restored_size = File.size(backup)
@@ -120,26 +115,32 @@ module Litestream
       end
 
       def databases(async: false, **argv)
-        execute("databases", argv, async: async, hashify: true)
+        execute("databases", argv, async: async, tabled_output: true)
       end
 
       def generations(database, async: false, **argv)
         raise DatabaseRequiredException, "database argument is required for generations command, e.g. litestream:generations -- --database=path/to/database.sqlite" if database.nil?
 
-        execute("generations", argv, database, async: async, hashify: true)
+        execute("generations", argv, database, async: async, tabled_output: true)
       end
 
       def snapshots(database, async: false, **argv)
         raise DatabaseRequiredException, "database argument is required for snapshots command, e.g. litestream:snapshots -- --database=path/to/database.sqlite" if database.nil?
 
-        execute("snapshots", argv, database, async: async, hashify: true)
+        execute("snapshots", argv, database, async: async, tabled_output: true)
       end
 
       private
 
-      def execute(command, argv = {}, database = nil, async: false, hashify: false)
+      def execute(command, argv = {}, database = nil, async: false, tabled_output: false)
         cmd = prepare(command, argv, database)
-        run(cmd, async: async, hashify: hashify)
+        results = run(cmd, async: async, tabled_output: tabled_output)
+
+        if Array === results && results.one? && results[0]["level"] == "ERROR"
+          raise CommandFailedException, "Failed to execute `#{cmd.join(" ")}`; Reason: #{results[0]["error"]}"
+        else
+          results
+        end
       end
 
       def prepare(command, argv = {}, database = nil)
@@ -158,14 +159,14 @@ module Litestream
         cmd
       end
 
-      def run(cmd, async: false, hashify: false)
+      def run(cmd, async: false, tabled_output: false)
         if async
           # To release the resources of the Ruby process, just fork and exit.
           # The forked process executes litestream and replaces itself.
           exec(*cmd) if fork.nil?
         else
-          out = `#{cmd.join(" ")}`
-          text_table_to_hashes(out) if hashify
+          stdout = `#{cmd.join(" ")}`.champ
+          tabled_output ? text_table_to_hashes(stdout) : stdout.split("\n").map { Logfmt.parse(_1) }
         end
       end
 

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logfmt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement