solid_backup 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195e930fb3a17dcfc67ad285b28ccdcd4dd7bcb3fc659a7bc85c4f7e1ab915e6
-  data.tar.gz: 1db537f2585f0548b73444e8f3661b811ea040a4ac306ed0a46eae3e9783c544
+  metadata.gz: dd198b0749b8c0ec8bbbf9371c95c95e3bf7967b3c76353b6bc8af310acbd160
+  data.tar.gz: 6c22706156961bcf44051d1023f6e5b2c50e4e02607a8b87f0dc6b774053963c
 SHA512:
-  metadata.gz: ed4aba930756d2f3b32ad5571a5d84095497e9f63b3952f212350258608dc5f2ed0af100d19764d25d69146606560976d38630906bae695412a87c7b0b7befdb
-  data.tar.gz: 4189596b8c2468d089306a01d11ce08d3f8dd42e036a0eeb96e2e4837205cd4987011ca8d4102b70708848766140021d32cc19619681ce9c800d270958fbfab7
+  metadata.gz: 2fdd803df8a709d66657b09bec4b49f27a94cc593a95ad27bb82daa1dd812391fb0e71a755124cdb3833c24fd10086b135b66f26665440c4a3d258c39110973d
+  data.tar.gz: 40649b13dfeacc3fc4db7c159ae017b0d2034e7075883ce4ad4bb0f1dc48b51ca4db9b62459898134477dede39c653590f095565aa587f4f3807cd52926aad03

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Solid Backup
 
+## 0.4.0
+
+- Add backup compression support via the `compressor:` option; currently
+  `SolidBackup::Compressor::Gzip` is the only supported value.
+
 ## 0.3.0
 
 - `destination` is the directory where backup files will be placed, not a

data/README.md

@@ -34,6 +34,8 @@ Modes other than `SolidBackup::Backup::None` take the following parameters:
                           backup after the previous one finished.
 - `expiration` - backup expiration policy; expired backups are automatically
                  removed.
+- `compressor` - backup compression policy; `nil` be default which turns
+                 compression off, but can be set to SolidBackup::Compressor::Gzip.
 
 Additionally, `SolidBackup::Backup::API` takes the following parameters:
 
@@ -65,7 +67,10 @@ SolidBackup.configure do |config|
                       wait: 0.1,
 
                       # Remove backups older than 30 days.
-                      expiration: SolidBackup::Expiration::Age.new(maximum: 30.days)
+                      expiration: SolidBackup::Expiration::Age.new(maximum: 30.days),
+
+                      # Compress backups using gzip.
+                      compressor: SolidBackup::Compressor::Gzip
 
     # Don't back up the cache database.
     production.backup "cache", SolidBackup::Backup::None
@@ -79,7 +84,10 @@ SolidBackup.configure do |config|
                       interval_in_minutes: 60,
 
                       # Remove backups older than 12 hours.
-                      expiration: SolidBackup::Expiration::Age.new(maximum: 12.hours)
+                      expiration: SolidBackup::Expiration::Age.new(maximum: 12.hours),
+
+                      # Don't compress backups. This is the default setting.
+                      compressor: nil
   end
 end
 ```

data/lib/solid_backup/backup/none.rb

@@ -7,7 +7,7 @@
 # - destination and interval_in_minutes - to allow nil values
 class SolidBackup::Backup::None < SolidBackup::Backup
   def initialize(database:)
-    super(database:, destination: nil, interval_in_minutes: 0, expiration: nil)
+    super(database:, destination: nil, interval_in_minutes: 0, expiration: nil, compressor: nil)
   end
 
   def tick

data/lib/solid_backup/backup.rb

@@ -4,11 +4,12 @@ module SolidBackup
   class Backup
     attr_reader :database
 
-    def initialize(database:, destination:, interval_in_minutes:, expiration:)
+    def initialize(database:, destination:, interval_in_minutes:, expiration:, compressor:)
       self.database = database
       self.destination = destination
       self.interval_in_minutes = interval_in_minutes
       self.expiration = expiration
+      self.compressor = compressor
 
       reset_countdown
     end
@@ -27,14 +28,20 @@ module SolidBackup
 
     private
 
-    attr_accessor :countdown, :expiration
+    attr_accessor :countdown, :expiration, :compressor
     attr_writer :database
     attr_reader :destination, :interval_in_minutes
 
     def perform
       ActiveSupport::Notifications.instrument("backup.solid_backup", database:) do
         lock do
-          do_perform(Time.now.utc.strftime((destination / file_name_pattern).to_s))
+          backup_path = Pathname(Time.now.utc.strftime((destination / file_name_pattern).to_s))
+          do_perform(backup_path)
+
+          next if compressor.nil?
+
+          compressor.compress(backup_path)
+          backup_path.unlink
         end
       end
     end
@@ -91,7 +98,7 @@ module SolidBackup
     end
 
     def file_name_pattern
-      "#{database}_%Y%m%dT%H%M%S.sqlite3"
+      "#{database}_%Y%m%dT%H%M%S%Z.sqlite3"
     end
 
     delegate :with_connection, to: :connection_pool

data/lib/solid_backup/compressor.rb

@@ -0,0 +1,14 @@
+module SolidBackup::Compressor
+  module Gzip
+    def self.compress(source_path)
+      target_path = "#{source_path}.gz"
+      source_path = Pathname(source_path)
+
+      Zlib::GzipWriter.open(target_path) do |gzip|
+        gzip.mtime = source_path.mtime
+        gzip.orig_name = source_path.basename.to_s
+        gzip.write(source_path.binread)
+      end
+    end
+  end
+end

data/lib/solid_backup/expiration.rb

@@ -11,7 +11,7 @@ module SolidBackup::Expiration
     end
 
     def select_expired(pathnames)
-      threshold = maximum.ago
+      threshold = maximum.ago.utc
       pathnames.select do |pathname|
         timestamp = yield(pathname)
         timestamp && timestamp < threshold

data/lib/solid_backup/generators/install_generator.rb

@@ -18,6 +18,7 @@ module SolidBackup
                                 destination: "storage/backups",
                                 interval_in_minutes: 60,
                                 expiration: SolidBackup::Expiration::Age.new(maximum: 24.hours),
+                                compressor: SolidBackup::Compressor::Gzip,
                                 step: 100,
                                 wait: 0.1
             CODE

data/lib/solid_backup/version.rb

@@ -1,3 +1,3 @@
 module SolidBackup
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/solid_backup.rb

@@ -7,6 +7,7 @@ require "solid_backup/backup/vacuum_into"
 require "solid_backup/configuration"
 require "solid_backup/configuration/environment"
 require "solid_backup/expiration"
+require "solid_backup/compressor"
 require "solid_backup/version"
 require "solid_backup/railtie"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_backup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Greg Navis
@@ -108,6 +108,7 @@ files:
 - lib/solid_backup/backup/api.rb
 - lib/solid_backup/backup/none.rb
 - lib/solid_backup/backup/vacuum_into.rb
+- lib/solid_backup/compressor.rb
 - lib/solid_backup/configuration.rb
 - lib/solid_backup/configuration/environment.rb
 - lib/solid_backup/expiration.rb
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Solid Backup provides simple backups for SQLite databases in Ruby on Rails
   apps.