litestream 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f258761331d8d31a676947be30d7238e156753598f22675e354c9a30f76c2ad
-  data.tar.gz: 85ba82f6d006a45014db99ea33b20d1e5a1e3e0e8c68bfa96df30c3caaa5c22d
+  metadata.gz: 3437fcda9be45b8f50a4fcae89e6cc07d3ea590d7e3f0d2f10e50c9f8c6058b6
+  data.tar.gz: f53e83796ed362491b50929d2924d070b6efa166830f7de6195e39300121be81
 SHA512:
-  metadata.gz: 377ae9660470f5a65376b6b2f0f75ef143c4d1a01c4c99eaa15b7e5b7eac101e45f50f1b6ee41ea0eaa7f1537c1cc6fe1f84e07aaf17f5096135733f72a5aa0a
-  data.tar.gz: e93cdf8397d7285728ae8d04bd93bbc06b567ce061a340ed7b393b14a30e9119803e2182e79b7f5530b5e17efae488a57da92c840e4683c69f955cbf35d4d6b5
+  metadata.gz: d8731b80f97dee5bc512e4f4acd58aebb63a435379736d281edc8bd2b42e6cc524c2eb7a55fefc2cf93218b91b2fb12c4fe180685031c9924dacd73a918fe344
+  data.tar.gz: 209fec5c3e355675feeee661ca64194cae370b85cbe90e162aaa2df059b2ccc5806b44e94daf706c29140e106e716eb1d3505a5efeeec65dfecbe4ee763ece09

data/README.md

@@ -49,13 +49,13 @@ LITESTREAM_INSTALL_DIR=.bin
 
 You configure the Litestream executable through the [`config/litestream.yml` file](https://litestream.io/reference/config/), which is a standard Litestream configuration file as if Litestream was running in a traditional installation.
 
-The gem streamlines the configuration process by providing a default configuration file for you. This configuration file will backup one application database to one replication bucket. In order to ensure that no secrets are stored in plain-text in your repository, this configuration file leverages Litestream's support for environment variables. The default configuration file looks like this:
+The gem streamlines the configuration process by providing a default configuration file for you. This configuration file will backup all SQLite databases defined in your `config/database.yml` file to one replication bucket. In order to ensure that no secrets are stored in plain-text in your repository, this configuration file leverages Litestream's support for environment variables. The default configuration file looks like this if you only have one SQLite database:
 
 ```yaml
 dbs:
   - path: $LITESTREAM_DATABASE_PATH
     replicas:
-      - url: $LITESTREAM_REPLICA_URL
+      - url: $LITESTREAM_REPLICA_BUCKET
         access-key-id: $LITESTREAM_ACCESS_KEY_ID
         secret-access-key: $LITESTREAM_SECRET_ACCESS_KEY
 ```
@@ -66,7 +66,7 @@ The gem also provides a default initializer file at `config/initializers/litestr
 litestream_credentials = Rails.application.credentials.litestream
 Litestream.configure do |config|
   config.database_path = ActiveRecord::Base.connection_db_config.database
-  config.replica_url = litestream_credentials.replica_url
+  config.replica_bucket = litestream_credentials.replica_bucket
   config.replica_key_id = litestream_credentials.replica_key_id
   config.replica_access_key = litestream_credentials.replica_access_key
 end
@@ -113,7 +113,7 @@ Once you have a MinIO server running, you can create a bucket for Litestream to
 ```ruby
 Litestream.configure do |config|
   config.database_path = ActiveRecord::Base.connection_db_config.database
-  config.replica_url = "s3://mybkt.localhost:9000/"
+  config.replica_bucket = "s3://mybkt.localhost:9000/"
   config.replica_key_id = "minioadmin"
   config.replica_access_key = "minioadmin"
 end

data/lib/litestream/commands.rb

@@ -74,8 +74,7 @@ module Litestream
 
     def self.replicate(argv = {})
       if Litestream.configuration
-        ENV["LITESTREAM_DATABASE_PATH"] = Litestream.configuration.database_path
-        ENV["LITESTREAM_REPLICA_URL"] = Litestream.configuration.replica_url
+        ENV["LITESTREAM_REPLICA_BUCKET"] = Litestream.configuration.replica_bucket
         ENV["LITESTREAM_ACCESS_KEY_ID"] = Litestream.configuration.replica_key_id
         ENV["LITESTREAM_SECRET_ACCESS_KEY"] = Litestream.configuration.replica_access_key
       end
@@ -86,7 +85,12 @@ module Litestream
 
       command = [executable, "replicate", *args]
       puts command.inspect
-      system(*command)
+
+      # 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,7 +8,7 @@ module Litestream
       source_root File.expand_path("templates", __dir__)
 
       def copy_config_file
-        template "config.yml", "config/litestream.yml"
+        template "config.yml.erb", "config/litestream.yml"
       end
 
       def copy_initializer_file
@@ -27,6 +27,16 @@ module Litestream
           end
         end
       end
+
+      private
+
+      def production_sqlite_databases
+        ActiveRecord::Base
+          .configurations
+          .configs_for(env_name: "production", include_hidden: true)
+          .select { |config| ["sqlite3", "litedb"].include? config.adapter }
+          .map(&:database)
+      end
     end
   end
 end

data/lib/litestream/generators/litestream/templates/{config.yml → config.yml.erb}

@@ -10,8 +10,12 @@
 #
 # For more details, see: https://litestream.io/reference/config/
 dbs:
-  - path: $LITESTREAM_DATABASE_PATH
+  <%- production_sqlite_databases.each do |database| -%>
+  - path: <%= database %>
     replicas:
-      - url: $LITESTREAM_REPLICA_URL
+      - type: s3
+        bucket: $LITESTREAM_REPLICA_BUCKET
+        path: <%= database %>
         access-key-id: $LITESTREAM_ACCESS_KEY_ID
         secret-access-key: $LITESTREAM_SECRET_ACCESS_KEY
+  <%- end -%>

data/lib/litestream/generators/litestream/templates/initializer.rb

@@ -1,30 +1,25 @@
 # Use this hook to configure the litestream-ruby gem.
 # All configuration options will be available as environment variables, e.g.
-# config.database_path becomes LITESTREAM_DATABASE_PATH
+# config.replica_bucket becomes LITESTREAM_REPLICA_BUCKET
 # This allows you to configure Litestream using Rails encrypted credentials,
 # or some other mechanism where the values are only avaialble at runtime.
 
 Litestream.configure do |config|
   # An example of using Rails encrypted credentials to configure Litestream.
   # litestream_credentials = Rails.application.credentials.litestream
-  #
-  # The absolute or relative path to a SQLite database file.
-  # Litestream will monitor this file for changes and replicate them to the
-  # any of the configured replicas specified for this database in the
-  # `litestream.yml` configuration file.
-  # When using SQLite as your database engine for ActiveRecord, you should always
-  # set this to the path of your SQLite database file. You can do so using Rails'
-  # existing knowledge of the database path.
-  # config.database_path = ActiveRecord::Base.connection_db_config.database
 
-  # Short-hand form of specifying a replica location.
-  # When using S3, a value will look like "s3://mybkt.litestream.io/db"
-  # Litestream also supports Azure Blog Storage, Backblaze B2, DigitalOcean Spaces,
+  # Replica-specific bucket location.
+  # This will be your bucket's URL without the `https://` prefix.
+  # For example, if you used DigitalOcean Spaces, your bucket URL could look like:
+  #   https://myapp.fra1.digitaloceanspaces.com
+  # And so you should set your `replica_bucket` to:
+  #   myapp.fra1.digitaloceanspaces.com
+  # Litestream supports Azure Blog Storage, Backblaze B2, DigitalOcean Spaces,
   # Scaleway Object Storage, Google Cloud Storage, Linode Object Storage, and
   # any SFTP server.
   # In this example, we are using Rails encrypted credentials to store the URL to
   # our storage provider bucket.
-  # config.replica_url = litestream_credentials.replica_url
+  # config.replica_bucket = litestream_credentials.replica_bucket
 
   # Replica-specific authentication key.
   # Litestream needs authentication credentials to access your storage provider bucket.

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/litestream.rb

@@ -11,7 +11,7 @@ module Litestream
   end
 
   class Configuration
-    attr_accessor :database_path, :replica_url, :replica_key_id, :replica_access_key
+    attr_accessor :database_path, :replica_bucket, :replica_key_id, :replica_access_key
 
     def initialize
       @mailer_sender = "donotreply@example.com"

data/lib/tasks/litestream_tasks.rake

@@ -6,8 +6,7 @@ namespace :litestream do
       next
     end
 
-    puts "LITESTREAM_DATABASE_PATH=#{Litestream.configuration.database_path}"
-    puts "LITESTREAM_REPLICA_URL=#{Litestream.configuration.replica_url}"
+    puts "LITESTREAM_REPLICA_BUCKET=#{Litestream.configuration.replica_bucket}"
     puts "LITESTREAM_ACCESS_KEY_ID=#{Litestream.configuration.replica_key_id}"
     puts "LITESTREAM_SECRET_ACCESS_KEY=#{Litestream.configuration.replica_access_key}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -67,7 +67,7 @@ files:
 - lib/litestream.rb
 - lib/litestream/commands.rb
 - lib/litestream/generators/litestream/install_generator.rb
-- lib/litestream/generators/litestream/templates/config.yml
+- lib/litestream/generators/litestream/templates/config.yml.erb
 - lib/litestream/generators/litestream/templates/initializer.rb
 - lib/litestream/railtie.rb
 - lib/litestream/upstream.rb