postgresql-backup 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2a632cc3b5edbcfe9efbcccda2d26dad60d9c71442fafa13f6956bb4070799
-  data.tar.gz: 9c00fd45add770d9cf55d163cdf5067341943fc4e69ad62cea4b5feac2981f5d
+  metadata.gz: 9d8de117460200af5ebacdfaa61c91cb8f46de9b7d91123d8d0f606e31fce16d
+  data.tar.gz: a8484224c080047669ca383459f69d5269f393198ded85b7a96c06048ae9ecd6
 SHA512:
-  metadata.gz: 2093299a3a8736fb8ed84af7011d0e8aac5731f86e4adc7fd61102fdb19e514dea2e9b150c207122e52a707ca284c71c4f8c98430926d46ea2e6d53e07af7aa3
-  data.tar.gz: 2ee8cf68d198f4947f599e4d9dda49a4ffbb3397133bb46f91fc1a83f9ebc25bb2ef1f7076a91b9a92d48bf2720ce7425dc6f9658e9d2407bb931db9696b8c48
+  metadata.gz: 8ac205a5ff92a7ed2298d9c7c07af0130f8b41cb4b809d0e07788b9ae3d7b7e8f53c24690e3d2ccae2d7448287ba369ff9c21bebbe245c7dc800d3153a3b7150
+  data.tar.gz: e8d7921301d7a67ef563c5996686289bf6581d47d44a08dd99120d9a0023c4c682b88f72426dfc9ada53d1507668537ab142743b14723bc3d1b04933365f537d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### v0.0.8 - 2023-07-07
+
+- Add support to hooks (methods to run before/after dump and restore)
+
 ### v0.0.7 - 2022-04-19
 
 - Add support for ruby 3 and fog-aws 3.13.0

data/README.md

@@ -26,7 +26,13 @@ Go to the terminal and update your gems using bundler:
 bundle install
 ```
 
-Right now, your project already has two new rake tasks: `backup` and `restore`.
+In the Rakefile of your project, add `require 'postgresql_backup'` anywhere **before** this line:
+
+```
+Rails.application.load_tasks
+```
+
+Right now, your project already has two new rake tasks: `postgresql_backup:dump` and `postgresql_backup:restore`.
 
 ## Configuration
 
@@ -39,6 +45,8 @@ Create a file inside the `config/initializers` folder. The name is not important
 Here is an example with all available options you can change:
 
 ```ruby
+require 'postgresql_backup'
+
 PostgresqlBackup.configure do |config|
   # This gem works with two possible repositories:
   #
@@ -84,6 +92,20 @@ PostgresqlBackup.configure do |config|
   # path where they are going to be stored. The remote path is the
   # place to do that. The default value is `_backups/database/`
   config.remote_path = ''
+
+  # There are cases where we need to run a command before or after the database
+  # is restored or a backup is created. To accomplish this, you can set the
+  # `hooks` attribute to a class or an instance of a class that
+  # responds to the method you need.
+  #
+  #  Available hook methods are:
+  #
+  #  * before_restore
+  #  * after_restore
+  #  * before_dump
+  #  * after_dump
+  #
+  config.hooks = nil
 end
 ```
 
@@ -150,6 +172,85 @@ Everything will work just fine, but you may come across some strange warnings, l
 
 To prevent this, every time the rake restores a backup file it tries to replace the environment being copied into the ar_internal_metadata table with the current Rails environment. Thus, `environment production` will become `environment development`.
 
+## Database restore hooks
+
+Sometimes we need to run things every time a database restore is about to happen, or maybe after the restore is completed. You may even need to run code before or after a backup is created.
+
+For example, if you use Elasticsearch you may need to reindex it after restoring a database.
+
+To accomplish this, you can use the `hooks` configurations:
+
+Examples:
+
+```ruby
+class DatabaseBackupHooks
+  def before_restore
+    puts 'Backup is going to be restored...'
+  end
+
+  def after_restore
+    puts 'Backup restored!'
+  end
+
+  def before_dump
+    puts 'Database backup is about to be created...'
+  end
+
+  def after_dump
+    puts 'Dump created!'
+  end
+end
+```
+
+Then, you can set the `hooks` in the initializer:
+
+```ruby
+PostgresqlBackup.configure do |config|
+  config.hooks = DatabaseBackupHooks.new
+end
+```
+
+It also works with classes with class methods:
+
+```ruby
+class DatabaseBackupHooks
+  def self.before_restore
+    puts 'Backup is going to be restored...'
+  end
+
+  def self.after_restore
+    puts 'Backup restored!'
+  end
+
+  def self.before_dump
+    puts 'Database backup is about to be created...'
+  end
+
+  def self.after_dump
+    puts 'Dump created!'
+  end
+end
+
+```
+
+```ruby
+PostgresqlBackup.configure do |config|
+  config.hooks = DatabaseBackupHooks # Note that here we no longer instantiate the class
+end
+```
+
+You can even create a class on the fly:
+
+```ruby
+PostgresqlBackup.configure do |config|
+  config.hooks = Class.new do
+    def self.after_restore
+      puts "after restore hook"
+    end
+  end
+end
+```
+
 ## I want to contribute
 
 Feel free to open a pull request with the changes you want to make. Remember to update `CHANGELOG.md` with the change you are proposing, because once the PR is merged, it is important to show which changes are being made to the gem.
@@ -164,4 +265,4 @@ To run the tests, we use rspec:
 
 ```
 rspec
-```
+```

data/lib/configuration.rb

@@ -1,25 +1,39 @@
+require_relative 'hooks'
+
 class Configuration
-  attr_accessor :repository, :backup_folder, :bucket, :region, :file_suffix,
-    :remote_path, :aws_access_key_id, :aws_secret_access_key
+  attr_accessor :aws_access_key_id,
+    :aws_secret_access_key,
+    :backup_folder,
+    :bucket,
+    :file_suffix,
+    :region,
+    :remote_path,
+    :repository
+
+  attr_reader :hooks
 
   def initialize(
-    repository: 'file system',
-    backup_folder: 'db/backups',
-    file_suffix: '',
     aws_access_key_id: '',
     aws_secret_access_key: '',
+    backup_folder: 'db/backups',
     bucket: '',
+    file_suffix: '',
     region: '',
-    remote_path: '_backups/database/'
+    remote_path: '_backups/database/',
+    repository: 'file system'
   )
-    @repository = repository
-    @backup_folder = backup_folder
-    @file_suffix = file_suffix
     @aws_access_key_id = aws_access_key_id
     @aws_secret_access_key = aws_secret_access_key
+    @backup_folder = backup_folder
     @bucket = bucket
+    @file_suffix = file_suffix
     @region = region
     @remote_path = remote_path
+    @repository = repository
+  end
+
+  def hooks=(hooks)
+    @hooks = Hooks.new(hooks)
   end
 
   def s3?

data/lib/hooks.rb

@@ -0,0 +1,29 @@
+class Hooks
+  def initialize(hooks)
+    @hooks = hooks
+  end
+
+  def before_restore
+    return unless @hooks.respond_to?(:before_restore)
+
+    @hooks.before_restore
+  end
+
+  def after_restore
+    return unless @hooks.respond_to?(:after_restore)
+
+    @hooks.after_restore
+  end
+
+  def before_dump
+    return unless @hooks.respond_to?(:before_dump)
+
+    @hooks.before_dump
+  end
+
+  def after_dump
+    return unless @hooks.respond_to?(:after_dump)
+
+    @hooks.after_dump
+  end
+end

data/lib/tools/database.rb

@@ -12,11 +12,15 @@ module Tools
     #
     # Return the full path of the backup file created in the disk.
     def dump(debug: false)
+      hooks.before_dump
+
       file_path = File.join(backup_folder, "#{file_name}#{file_suffix}.sql")
 
       cmd = "PGPASSWORD='#{password}' pg_dump -F p -v -O -U '#{user}' -h '#{host}' -d '#{database}' -f '#{file_path}' -p '#{port}' "
       debug ? system(cmd) : system(cmd, err: File::NULL)
 
+      hooks.after_dump
+
       file_path
     end
 
@@ -35,11 +39,15 @@ module Tools
     # If you need to make the command more verbose, pass
     # `debug: true` in the arguments of the function.
     def restore(file_name, debug: false)
+      hooks.before_restore
+
       file_path = File.join(backup_folder, file_name)
       output_redirection = debug ? '': ' > /dev/null'
       cmd = "PGPASSWORD='#{password}' psql -U '#{user}' -h '#{host}' -d '#{database}' -f '#{file_path}' -p '#{port}' #{output_redirection}"
       system(cmd)
 
+      hooks.after_restore
+
       file_path
     end
 
@@ -92,5 +100,9 @@ module Tools
         end
       end
     end
+
+    def hooks
+      @hooks ||= configuration.hooks
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postgresql-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Artur Caliendo Prado
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -120,6 +120,7 @@ files:
 - README.md
 - lib/Rakefile
 - lib/configuration.rb
+- lib/hooks.rb
 - lib/postgresql_backup.rb
 - lib/railtie.rb
 - lib/tasks/backup.rake
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Automate PostgreSQL's backup and restore