uff_db_loader 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b136a4cf8a5a4bbbe44371bdee9f33a97417bc22c88937d3e826af7c4a8b459
-  data.tar.gz: bc16630dc38a5cf6de7af81307b61dabe20f9b83675303b22addeb80288ae20c
+  metadata.gz: 68a5cb60e3cf41f8a59e5ff1f0c08c6d186473633adbf8976f9ffc8b23f86af2
+  data.tar.gz: 44dda910a3252b9f5c2b2d9b6c3b82c60a78e4d07855f774cab8b7676db2ef28
 SHA512:
-  metadata.gz: da774d613024ae9ff97ad3a8d6d7500b9f4e7b69dff732a9877941d2f810234b00899a7d1bcc3e69c97fe5689a96e98eeba218bbe467fa9584d2f04f44d8deca
-  data.tar.gz: 577d9b103ae12261c9d6a099a274f33f54413062d487a391e50e811e6fa91c64f122c706100df1d99fef9b9fe4869acbd5a1e171e857f402b5d7ca08e1d8b6c9
+  metadata.gz: 8550673f5245e23f16d92fbf89f231db925f4827c9ba3ee35bfc2bcd94d8cf32a5b138a9012eeb957fe87f6b83dbf20a3a051801ddee54e4e40f28a587edc80e
+  data.tar.gz: 450d57b8b60f9d5d0c847d67b18144ae5ec5a8c415fd1b5f2fa5a90039f61190db61484f0e7a4092cfc14ca0e8ccd0542c3deed6a7e9ead3b8636c9f2d0b1928

data/.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v3

data/.standard.yml

@@ -1,3 +1,3 @@
 # For available configuration options, see:
 #   https://github.com/testdouble/standard
-ruby_version: 2.6
+ruby_version: 3.0

data/README.md

@@ -37,6 +37,7 @@ UffDbLoader.configure do |config|
   config.app_name = 'my_app' # Defaults to the Rails app name
   config.dumps_directory = '/path/to/dumps' # Defaults to Rails.root.join('dumps')
   config.database_config_file = 'path/to/database.yml' # Defaults to Rails.root.join('config', 'database.yml')
+  config.container_name = ->(app_name, environment) { "#{app_name}_#{environment}_custom_suffix" } # Defaults to "#{app_name}_#{environment}_db". It accepts a static string too.
 end
 ```
 For example in a file like `config/initializers/uff_db_loader.rb`.

data/lib/configuration.rb

@@ -5,7 +5,17 @@ require "uff_db_loader/mysql"
 
 module UffDbLoader
   class Configuration
-    attr_accessor :environments, :ssh_host, :ssh_user, :db_name, :db_system, :app_name, :dumps_directory, :database_config_file
+    attr_accessor(
+      :environments,
+      :ssh_host,
+      :ssh_user,
+      :db_name,
+      :db_system,
+      :app_name,
+      :dumps_directory,
+      :database_config_file,
+      :container_name
+    )
 
     def initialize
       @environments = nil
@@ -16,6 +26,7 @@ module UffDbLoader
       @app_name = Dir.pwd.split("/").last
       @dumps_directory = File.join(Dir.pwd, "dumps")
       @database_config_file = File.join(Dir.pwd, "config", "database.yml")
+      @container_name = nil
     end
 
     def database

data/lib/uff_db_loader/mysql.rb

@@ -7,7 +7,7 @@ module UffDbLoader
     end
 
     def self.dump_command_template
-      "ssh %user%@%host% \"docker exec -i %app_name%_%environment%_db sh -c 'exec mysqldump --opt --no-tablespaces -uroot -p\"\\$MYSQL_ROOT_PASSWORD\" %database%'\" > %target%"
+      "ssh %user%@%host% \"docker exec -i %container_name% sh -c 'exec mysqldump --opt --no-tablespaces -uroot -p\"\\$MYSQL_ROOT_PASSWORD\" %database%'\" > %target%"
     end
 
     def self.restore_command(database_name, result_file_path)

data/lib/uff_db_loader/postgresql.rb

@@ -7,7 +7,7 @@ module UffDbLoader
     end
 
     def self.dump_command_template
-      "ssh %user%@%host% \"docker exec -i %app_name%_%environment%_db sh -c 'exec pg_dump --username \\$POSTGRES_USER --clean --no-owner --no-acl --format=c %database%'\" > %target%"
+      "ssh %user%@%host% \"docker exec -i %container_name% sh -c 'exec pg_dump --username \\$POSTGRES_USER --clean --no-owner --no-acl --format=c %database%'\" > %target%"
     end
 
     def self.restore_command(database_name, result_file_path)

data/lib/uff_db_loader/tasks/uff_db_loader.rake

@@ -29,6 +29,11 @@ namespace :uff_db_loader do
   task restore: :environment do
     UffDbLoader.ensure_installation!
 
+    # switch to default db so we can restore the currently connected database
+    UffDbLoader.remember_database_name("")
+    ActiveRecord::Base.remove_connection
+    ActiveRecord::Base.establish_connection(Rails.configuration.database_configuration["development"])
+
     prompt = TTY::Prompt.new
     existing_dumps = Dir.glob("#{UffDbLoader.config.dumps_directory}/#{UffDbLoader.config.app_name}*").map { |f| File.basename(f, ".*") }
     database_name = prompt.select("Which dump should be restored?", existing_dumps)
@@ -67,11 +72,9 @@ namespace :uff_db_loader do
 
   desc "Delete all downloaded db dumps and removes all databases created by UffDbLoader"
   task prune: :environment do
-    # switch to default db so we can also drop the currently connected database
-    UffDbLoader.remember_database_name("")
-    ActiveRecord::Base.connection.reconnect!
-
     UffDbLoader.databases.each do |database_name|
+      next if database_name == ActiveRecord::Base.connection.current_database
+
       puts "Dropping #{database_name}"
       UffDbLoader.drop_database(database_name)
     end

data/lib/uff_db_loader/templates/uff_db_loader_initializer.erb

@@ -14,5 +14,6 @@ if defined?(UffDbLoader)
     # config.app_name = 'my_app' # Defaults to the Rails app name
     # config.dumps_directory = '/path/to/dumps' # Defaults to Rails.root.join('dumps')
     # config.database_config_file = 'path/to/database.yml' # Defaults to Rails.root.join('config', 'database.yml')
+    # config.container_name = ->(app_name, environment) { "#{app_name}_#{environment}_custom_suffix" } # Defaults to "#{app_name}_#{environment}_db". It accepts a static string too.
   end
 end

data/lib/uff_db_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UffDbLoader
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

data/lib/uff_db_loader.rb

@@ -45,7 +45,9 @@ module UffDbLoader
     end
 
     def prune_dump_directory
-      FileUtils.rm_rf("#{config.dumps_directory}/.", secure: true)
+      FileUtils.rm_f(
+        FileList["#{config.dumps_directory}/*"].exclude(dump_file_path(current_database_name)).to_a
+      )
     end
 
     def create_database(database_name)
@@ -74,8 +76,8 @@ module UffDbLoader
 
     def current_database_name
       File.read(database_name_file).strip.presence
-    rescue IOError, Errno::ENOENT => e
-      puts "Could not read #{database_name_file}. #{e.message} – Falling back to default database. 🥱"
+    rescue IOError, Errno::ENOENT
+      # We expect this file to be missing in non-dev environments.
     end
 
     def remember_database_name(database_name)
@@ -125,6 +127,13 @@ module UffDbLoader
 
     private
 
+    def container_name(environment)
+      return "#{config.app_name}_#{environment}_db" if config.container_name.blank?
+      return config.container_name unless config.container_name.respond_to? :call
+
+      config.container_name.call(config.app_name, environment)
+    end
+
     def initializer_template_path
       File.join(__dir__, "uff_db_loader", "templates", "uff_db_loader_initializer.erb")
     end
@@ -144,12 +153,11 @@ module UffDbLoader
       config
         .database_system
         .dump_command_template
-        .gsub("%environment%", environment)
         .gsub("%host%", config.ssh_host)
         .gsub("%user%", config.ssh_user)
         .gsub("%database%", config.database)
         .gsub("%target%", target)
-        .gsub("%app_name%", config.app_name)
+        .gsub("%container_name%", container_name(environment))
     end
 
     def restore_command(database_name, result_file_path)

data/uff_db_loader.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.post_install_message = "Please run `bin/rails uff_db_loader:install` to complete the installation."
   spec.homepage = "https://github.com/rmehner/uff_db_loader"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata = {
     "bug_tracker_uri" => "#{spec.homepage}/issues",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uff_db_loader
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Andreas Hellwig
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -88,9 +88,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rmehner/uff_db_loader/issues
-  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/2.1.0
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/3.0.0
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/2.1.0
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/3.0.0
 post_install_message: Please run `bin/rails uff_db_loader:install` to complete the
   installation.
 rdoc_options: []
@@ -100,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Allows to dump, download and restore databases from docker servers.