solid_backup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee957011ccc278fb06096635c8b158939f283538bb5ccc25869ba07d3bb7bb5a
-  data.tar.gz: ea9cdbdbd9e9ae3ae0fdb4b252b9db1c412e80d3288258c8ccf4062e59a70b66
+  metadata.gz: ee0e8ba44bfedbddb05671e68d06bdfc8e9e88f1d79ab38678cd15ce8023aba8
+  data.tar.gz: 3f1b4ec2ea4fa5b28528e398db334f9f987c34458f572ea3c2a36f5c3ebd45bd
 SHA512:
-  metadata.gz: '0802038b0aeac7c0b0bebbf1b8b6d68054b52621ef1c50c9c21f1a640866fb2f1e51ee9a3d98bc6fef80a5b63ab85c4ed9cec500e7ba86ddc24bf45fe65d3c33'
-  data.tar.gz: 82bec8bad5efe105b5ad7247b6f0754fda99381baafdcaff36704c249a36996c86bf0d1e65e1d4cd81a896a03513cc631a0c4540dc6b501115b5b3134f0936c5
+  metadata.gz: 3b0025209e6f305cff67b6d3fb19e86a371541c299cd38ea092a8252ed4635c62b072b64f5e6221affa1028cf222b038c634c3f496b9a18384db34eb52cf37f6
+  data.tar.gz: 020ef132f3024278de2e68a440cfd5c613f1f55397525164da15a4fdb2d27307606010f7f06ea830751d1229016432b98fce7d9d0b31119bdd46e6f4cfdf8295

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Solid Backup
+
+## 0.2.0
+
+- Support for per-environment backup configuration.
+
+## 0.1.0
+
+- Initial release.

data/README.md

@@ -44,22 +44,28 @@ mode in practice:
 
 ```ruby
 SolidBackup.configure do |config|
-	# Back up the primary database using the SQLite backup API.
-  config.backup "primary",
-                SolidBackup::Backup::API,
-                destination: "storage/backups/primary_%Y%m%dT%H%M%S.sqlite3",
-                interval_in_minutes: 15, # Start the next backup 15 minutes after the previous one.
-                step: 100,               # Back up in 100-page increments.
-                wait: 0.1                # Wait 0.1 seconds if a lock interrupts a backup step.
-
-	# Don't back up the cache database.
-  config.backup "cache", SolidBackup::Backup::None
-
-  # Back up the queue database using VACUUM INTO.
-  config.backup "queue",
-                SolidBackup::Backup::VacuumInto,
-                destination: "storage/backups/queue_%Y%m%dT%H%M%S.sqlite3",
-                interval_in_minutes: 60 # Start the next backup 60 minutes after the previous one.
+  config.enabled = true
+
+  # Configure backups for all production databases. Other environments can have
+  # backups configured for them via additional config.environment blocks.
+  config.environment("production") do |production|
+    # Back up the primary database using the SQLite backup API.
+    production.backup "primary",
+                      SolidBackup::Backup::API,
+                      destination: "storage/backups/primary_%Y%m%dT%H%M%S.sqlite3",
+                      interval_in_minutes: 15, # Start the next backup 15 minutes after the previous one.
+                      step: 100,               # Back up in 100-page increments.
+                      wait: 0.1                # Wait 0.1 seconds if a lock interrupts a backup step.
+
+    # Don't back up the cache database.
+    production.backup "cache", SolidBackup::Backup::None
+
+    # Back up the queue database using VACUUM INTO.
+    production.backup "queue",
+                      SolidBackup::Backup::VacuumInto,
+                      destination: "storage/backups/queue_%Y%m%dT%H%M%S.sqlite3",
+                      interval_in_minutes: 60 # Start the next backup 60 minutes after the previous one.
+  end
 end
 ```
 

data/lib/solid_backup/backup/none.rb

@@ -6,8 +6,8 @@
 # - perform - to avoid creating lock files and emitting instrumentation events
 # - destination and interval_in_minutes - to allow nil values
 class SolidBackup::Backup::None < SolidBackup::Backup
-  def initialize(name:)
-    super(name:, destination: nil, interval_in_minutes: 0)
+  def initialize(database:)
+    super(database:, destination: nil, interval_in_minutes: 0)
   end
 
   def tick

data/lib/solid_backup/backup.rb

@@ -1,9 +1,9 @@
 module SolidBackup
   class Backup
-    attr_reader :name
+    attr_reader :database
 
-    def initialize(name:, destination:, interval_in_minutes:)
-      self.name = name
+    def initialize(database:, destination:, interval_in_minutes:)
+      self.database = database
       self.destination = destination
       self.interval_in_minutes = interval_in_minutes
 
@@ -22,7 +22,7 @@ module SolidBackup
     end
 
     def perform
-      ActiveSupport::Notifications.instrument("backup.solid_backup", name:) do
+      ActiveSupport::Notifications.instrument("backup.solid_backup", database:) do
         lock do
           do_perform(Time.now.utc.strftime(destination.to_s))
         end
@@ -32,13 +32,13 @@ module SolidBackup
     private
 
     attr_accessor :countdown
-    attr_writer :name
+    attr_writer :database
     attr_reader :destination, :interval_in_minutes
 
     def interval_in_minutes=(value)
-      if !value.is_a?(Integer) && value <= 0
+      if !value.is_a?(Integer) || value <= 0
         raise TypeError.new(<<~ERROR)
-          invalid backup configuration for #{name}: interval_in_minutes is set to #{interval_in_minutes.inspect}, but should be set to a positive integer
+          invalid backup configuration for #{database}: interval_in_minutes is set to #{value.inspect}, but should be set to a positive integer
         ERROR
       end
 
@@ -50,14 +50,14 @@ module SolidBackup
       directory = value.dirname
 
       if !directory.directory?
-        raise "invalid backup configuration for #{name}: destination directory #{directory} must exist"
+        raise "invalid backup configuration for #{database}: destination directory #{directory} must exist"
       end
 
       test_path = directory / "solid_backup.txt"
       begin
         test_path.write("Solid Backup Test")
-      rescue Errno::EACCESS
-        raise "invalid backup configuration for #{name}: destination directory #{directory} must be writeable"
+      rescue Errno::EACCES
+        raise "invalid backup configuration for #{database}: destination directory #{directory} must be writeable"
       ensure
         test_path.unlink
       end
@@ -74,13 +74,13 @@ module SolidBackup
     end
 
     def connection_pool
-      ActiveRecord::Base.connection_handler.establish_connection(name.to_sym)
+      ActiveRecord::Base.connection_handler.establish_connection(database.to_sym)
     end
 
     delegate :with_connection, to: :connection_pool
 
     def lock
-      path = destination.dirname / ".solid_backup.#{name}.lock"
+      path = destination.dirname / ".solid_backup.#{database}.lock"
 
       File.open(path, File::RDWR | File::CREAT) do |f|
         if f.flock(File::LOCK_EX | File::LOCK_NB)
@@ -94,7 +94,7 @@ module SolidBackup
 
       begin
         File.unlink(path)
-      rescue ERRNO::ENOENT
+      rescue Errno::ENOENT
       end
     end
   end

data/lib/solid_backup/configuration/environment.rb

@@ -0,0 +1,41 @@
+class SolidBackup::Configuration::Environment
+  attr_reader :name, :backups
+
+  def initialize(name)
+    self.name = name
+    self.backups = []
+
+    yield(self)
+  end
+
+  def tick
+    backups.each(&:tick)
+  end
+
+  def backup(database, algorithm_class, **algorithm_arguments)
+    database = database.to_s
+    if backups.any? { it.database == database }
+      raise ArgumentError.new("backups for #{database} in #{name} have already been configured")
+    end
+
+    backups << algorithm_class.new(database:, **algorithm_arguments)
+  end
+
+  def validate!
+    configured_databases = backups.map(&:database)
+    all_databases = ActiveRecord::Base.configurations.configs_for(env_name: name).select do |db_config|
+      db_config.adapter == "sqlite3"
+    end.map(&:name)
+
+    if (missing_databases = all_databases - configured_databases).present?
+      raise "SQLite databases missing from backup configuration for #{name}: #{missing_databases.join(", ")}"
+    end
+    if (unknown_databases = configured_databases - all_databases).present?
+      raise "unknown SQLite databases present in backup configuration for #{name}: #{unknown_databases.join(", ")}"
+    end
+  end
+
+  private
+
+  attr_writer :name, :backups
+end

data/lib/solid_backup/configuration.rb

@@ -1,20 +1,25 @@
 module SolidBackup
   class Configuration
     attr_accessor :enabled
-    attr_reader :algorithms
+    attr_reader :environments
 
     def initialize
       self.enabled = nil
-      self.algorithms = []
+      self.environments = []
     end
 
-    def backup(name, algorithm_class, **algorithm_arguments)
+    def environment(name, &)
       name = name.to_s
-      if algorithms.find { it.name == name }
-        raise ArgumentError.new("#{name} has had backups configured already")
+      if environments.any? { it.name == name }
+        raise ArgumentError.new("environment #{name} has already been configured")
       end
 
-      algorithms << algorithm_class.new(name:, **algorithm_arguments)
+      environments << SolidBackup::Configuration::Environment.new(name, &)
+    end
+
+    def tick(env_name)
+      env_name = env_name.to_s
+      environments.find { it.name == env_name }&.tick
     end
 
     def validate!
@@ -22,17 +27,7 @@ module SolidBackup
         raise TypeError.new("enabled is set to #{enabled.inspect}, but allowed values are true or false")
       end
 
-      configured_database_names = algorithms.map(&:name)
-      all_database_names = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env).select do |db_config|
-        db_config.adapter == "sqlite3"
-      end.map(&:name)
-
-      if (missing_databases = all_database_names - configured_database_names).present?
-        raise "SQLite databases missing from backup configuration: #{missing_databases.join(", ")}"
-      end
-      if (unknown_databases = configured_database_names - all_database_names).present?
-        raise "unknown SQLite databases present in backup configuration: #{unknown_databases.join(", ")}"
-      end
+      environments.each(&:validate!)
     end
 
     def enabled?
@@ -45,6 +40,6 @@ module SolidBackup
 
     private
 
-    attr_writer :algorithms
+    attr_writer :environments
   end
 end

data/lib/solid_backup/generators/install_generator.rb

@@ -13,15 +13,15 @@ module SolidBackup
         ActiveRecord::Base.configurations.configs_for(env_name: "production").each do |db_config|
           backups << if yes?("Back up #{db_config.name} in production?")
             <<~CODE.chomp
-              config.backup #{db_config.name.inspect},
-                            SolidBackup::Backup::API,
-                            destination: "storage/backups/#{db_config.name}_%Y%m%dT%H%M%S.sqlite3",
-                            interval_in_minutes: 60,
-                            step: 100,
-                            wait: 0.1
+              production.backup #{db_config.name.inspect},
+                                SolidBackup::Backup::API,
+                                destination: "storage/backups/#{db_config.name}_%Y%m%dT%H%M%S.sqlite3",
+                                interval_in_minutes: 60,
+                                step: 100,
+                                wait: 0.1
             CODE
           else
-            "config.backup #{db_config.name.inspect}, SolidBackup::Backup::None"
+            "production.backup #{db_config.name.inspect}, SolidBackup::Backup::None"
           end
         end
 
@@ -34,7 +34,9 @@ module SolidBackup
             #
             # IMPORTANT: all databases must be explicitly configured, even if they're not
             # backed up, to avoid accidentally excluding new databases from backups.
-          #{backups.join("\n").indent(2)}
+            config.environment("production") do |production|
+          #{backups.join("\n").indent(4)}
+            end
           end
         CODE
 

data/lib/solid_backup/version.rb

@@ -1,3 +1,3 @@
 module SolidBackup
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/solid_backup.rb

@@ -3,6 +3,7 @@ require "solid_backup/backup/none"
 require "solid_backup/backup/api"
 require "solid_backup/backup/vacuum_into"
 require "solid_backup/configuration"
+require "solid_backup/configuration/environment"
 require "solid_backup/version"
 require "solid_backup/railtie"
 
@@ -18,7 +19,7 @@ module SolidBackup
     end
 
     def tick
-      configuration.algorithms.each(&:tick)
+      configuration.tick(Rails.env)
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_backup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Greg Navis
@@ -99,6 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE.txt
 - README.md
 - lib/puma/plugin/solid_backup.rb
@@ -108,6 +109,7 @@ files:
 - lib/solid_backup/backup/none.rb
 - lib/solid_backup/backup/vacuum_into.rb
 - lib/solid_backup/configuration.rb
+- lib/solid_backup/configuration/environment.rb
 - lib/solid_backup/generators/install_generator.rb
 - lib/solid_backup/railtie.rb
 - lib/solid_backup/version.rb