litestream 0.3.1-x86_64-darwin → 0.3.3-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378bd8eca04dbdce307ee60010dcba9bb799e88f30cba90a3610ea305d14397b
-  data.tar.gz: d8111352141a9202fcc2caa0c1ea608590990bd1bd744f0be91a974487090cca
+  metadata.gz: 00647a209b5a0e901a8fac0c3e86b27d880479fe9af05dda02d9c6a8af1e073b
+  data.tar.gz: 2ea3f1d5c06707550dc99923ceb8259b81984dc159c9a6edec661a4b063effc1
 SHA512:
-  metadata.gz: f3764d6f471413dbf245e120aca3faebe7aee53d14187c5caa3695899e2f2897423c054247f5143ecf970c6c2969cee921af8122b445fa9cbbc905ac0bf5813d
-  data.tar.gz: 224e0c8975bc4389c6cc28616dce6ab3728b46463f7076cf63ce49d148657211639ae92b2dffe2557747bae0099bbd8545ceec8b11a7dcb29cb0db9b6e016e1f
+  metadata.gz: 1e6e4e494a0552c3f0969f8bbb294e4176544485c9b58a277fe39b732ba5277e35c39194c3ed6d2dc2e5bef94de1edc95b14251f5aad9dfd72e62187bcbd7362
+  data.tar.gz: bc578ed44bb4903098984baac438a465d3d85409e28c8bcdb9f26d49e63f6cff1a885fdbdaedc73685e4919245cb21195afb97dc68dab236496b86e1a9c154fb

data/README.md

@@ -76,9 +76,23 @@ However, if you need manual control over the Litestream configuration, you can m
 
 ### Replication
 
-By default, the gem will create or append to a `Procfile` to start the Litestream process via the gem's provided `litestream:replicate` rake task. This rake task will automatically load the configuration file and set the environment variables before starting the Litestream process.
+By default, the gem will create or append to a `Procfile` to start the Litestream process via the gem's provided `litestream:replicate` rake task. This rake task will automatically load the configuration file and set the environment variables before starting the Litestream process. You can also execute this rake task yourself:
 
-Again, however, you can take full manual control over the replication process and simply run the `litestream replicate --config config/litestream.yml` command to start the Litestream process. Since the gem installs the native executable via Bundler, the `litestream` command will be available in your `PATH`.
+```shell
+bin/rails litestream:replicate
+# or
+bundle exec rake litestream:replicate
+```
+
+If you need to pass arguments through the rake task to the underlying `litestream` command, that can be done with argument forwarding:
+
+```shell
+bin/rails litestream:replicate -- -exec "foreman start"
+```
+
+This example utilizes the `-exec` option available on [the `replicate` command](https://litestream.io/reference/replicate/) which provides basic process management, since Litestream will exit when the child process exits. In this example, we only launch our collection of Rails application processes (like Rails and SolidQueue, for example) after the Litestream replication process is ready.
+
+The rake task is the recommended way to interact with the Litestream replication process in your Rails application or Ruby project. But, you _can_ take full manual control over the replication process and simply run the `litestream replicate --config config/litestream.yml` command to start the Litestream process. Since the gem installs the native executable via Bundler, the `litestream` command will be available in your `PATH`.
 
 The full set of commands available to the `litestream` executable are covered in Litestream's [command reference](https://litestream.io/reference/). Currently, only the `replicate` command is provided as a rake task by the gem.
 

data/lib/litestream/commands.rb

@@ -72,7 +72,7 @@ module Litestream
       exe_file
     end
 
-    def self.replicate
+    def self.replicate(argv = {})
       if Litestream.configuration
         ENV["LITESTREAM_DATABASE_PATH"] = Litestream.configuration.database_path
         ENV["LITESTREAM_REPLICA_URL"] = Litestream.configuration.replica_url
@@ -80,7 +80,18 @@ module Litestream
         ENV["LITESTREAM_SECRET_ACCESS_KEY"] = Litestream.configuration.replica_access_key
       end
 
-      system(executable, "replicate", "--config", Rails.root.join("config", "litestream.yml").to_s)
+      args = {
+        "--config" => Rails.root.join("config", "litestream.yml").to_s
+      }.merge(argv).to_a.flatten.compact
+
+      command = [executable, "replicate", *args]
+      puts command.inspect
+
+      # To release the resources of the Ruby process, just fork and exit.
+      # The forked process executes litestream and replaces itself.
+      if fork.nil?
+        exec(*command)
+      end
     end
   end
 end

data/lib/litestream/generators/litestream/install_generator.rb

@@ -8,11 +8,11 @@ module Litestream
       source_root File.expand_path("templates", __dir__)
 
       def copy_config_file
-        template "litestream.yml", "config/litestream.yml"
+        template "config.yml", "config/litestream.yml"
       end
 
       def copy_initializer_file
-        template "litestream.rb", "config/initializers/litestream.rb"
+        template "initializer.rb", "config/initializers/litestream.rb"
       end
 
       def create_or_update_procfile

data/lib/litestream/railtie.rb

@@ -9,7 +9,7 @@ module Litestream
       require_relative "generators/litestream/install_generator"
     end
 
-    # Load the `litestream:env` Rake task into the host Rails app
+    # Load the `litestream:*` Rake task into the host Rails app
     rake_tasks do
       load "tasks/litestream_tasks.rake"
     end

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

data/lib/tasks/litestream_tasks.rake

@@ -14,8 +14,15 @@ namespace :litestream do
     true
   end
 
-  desc ""
+  desc "Start a process to monitor and continuously replicate the SQLite databases defined in your configuration file"
   task replicate: :environment do
-    Litestream::Commands.replicate
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+
+    Litestream::Commands.replicate(options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: x86_64-darwin
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -69,8 +69,8 @@ files:
 - lib/litestream.rb
 - lib/litestream/commands.rb
 - lib/litestream/generators/litestream/install_generator.rb
-- lib/litestream/generators/litestream/templates/litestream.rb
-- lib/litestream/generators/litestream/templates/litestream.yml
+- lib/litestream/generators/litestream/templates/config.yml
+- lib/litestream/generators/litestream/templates/initializer.rb
 - lib/litestream/railtie.rb
 - lib/litestream/upstream.rb
 - lib/litestream/version.rb