uff_db_loader 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4014edf9331d8b25f433d0252b62008f78db0f0038fb8e1f7877319eacf45320
-  data.tar.gz: 16d16a54291cbf8641fba3ef4fa6db469a72b4420577716139d90ba06470d298
+  metadata.gz: 1a2c7c42ed0513c36d938f46d9346c462ec22e978ed234f519d9825eb8701c8f
+  data.tar.gz: 6036d5f67b2447a2e747b6b242d4a69a96730c57f5ce45a01d618d4af91085a4
 SHA512:
-  metadata.gz: 4ea14486da00fdf735bb1310c2f70d24b274a14007960a5306c2af2faa016ce933d22aaa844ef589a336a0e7af7738de9179027429f2b425378fbb064f789673
-  data.tar.gz: c40219d3c1b3b256f324097ec25be27ee16934395e6f9bfd6362d29efbc1f796b3547dc1de388a6678464eb14578d3f82e135036889398bfdf363790c21a4913
+  metadata.gz: e843d03ce1e569f9bd03a84ec9f95321dd34f08f23ad3897392343cffb4779cc91c9d44bb6b1634c94ef6b763177cefe2489c64207bb31cbf20140e73610fa82
+  data.tar.gz: 25d012b2ba4e6bfbc066b074a95523f8782c9da9a345ad0326014c8b7da87f343452966bfa7a217c3e1783ace8c90a82e5a19777be87ce7b89b69f7fb79cd063

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
     $ gem install uff_db_loader
 
-Run the installation script: 
+Run the installation script:
 
     $ bin/rails uff_db_loader:install
 
@@ -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`.
@@ -50,6 +51,7 @@ Make sure the app's database user has the superuser role. Otherwise the app will
 - `dump`: Dumps a remote database from a selected environment and downloads it
 - `restore`: Restores a downloaded dump into a local database
 - `switch`: Selects a restored local database to use
+- `switch_to_default`: Switches database back to the default development database
 - `load`: Dumps a remote database from a selected environment and downloads it then restores and selects the database
 - `prune`: Delete all downloaded db dumps and removes all databases created by UffDbLoader
 

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

@@ -79,4 +79,12 @@ namespace :uff_db_loader do
     puts "Removing dumps from #{UffDbLoader.config.dumps_directory}"
     UffDbLoader.prune_dump_directory
   end
+
+  desc "Switch back to default database"
+  task switch_to_default: :environment do
+    UffDbLoader.remember_database_name("")
+    UffDbLoader.restart_rails_server
+
+    puts "♻️  Restarted rails server with default database."
+  end
 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.0.1"
+  VERSION = "2.2.0"
 end

data/lib/uff_db_loader.rb

@@ -108,14 +108,14 @@ module UffDbLoader
     end
 
     def initializer_path
-      File.join(__dir__, "uff_db_loader", "templates", "uff_db_loader_initializer.erb")
+      Rails.root.join("config", "initializers", "uff_db_loader.rb")
     end
 
     def create_initializer
-      template = ERB.new(File.read(initializer_path))
+      template = ERB.new(File.read(initializer_template_path))
 
       File.write(
-        Rails.root.join("config", "initializers", "uff_db_loader.rb"),
+        initializer_path,
         template.result_with_hash(
           used_database_system: used_database_system,
           environments: environments
@@ -125,6 +125,17 @@ 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
+
     def database_name_file
       Rails.root.join("tmp", "uff_db_loader_database_name")
     end
@@ -140,12 +151,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uff_db_loader
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Andreas Hellwig
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2023-02-23 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.0.1
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/2.2.0
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/2.0.1
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/2.2.0
 post_install_message: Please run `bin/rails uff_db_loader:install` to complete the
   installation.
 rdoc_options: []
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Allows to dump, download and restore databases from docker servers.