uff_db_loader 3.2.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc0ae683bfbb729b2f2c68db73cf2848561ac41d7b3f062fa98d42578ee73b9
-  data.tar.gz: d4fd732e0bd9191080e96e2de07edc0ce40e1af604d50f00ecd72c3bfbc5ee4d
+  metadata.gz: 35997f212e0fe2b696781f3092c23fdaa6e11c0158c0053c8250422d553dcf3d
+  data.tar.gz: f4442306686b14c31606c740c9b83692825ca28cd7cf1564e35cc5b2aa746c53
 SHA512:
-  metadata.gz: 63499cc1c3bf6a205d5287fd2c77edb4842501f12a22095b72bfdddc0153e46afa0dd0c20652ea66fab6b2cbbb7d4eb45ff11a944b866ef9e83f8e313b1a1a5f
-  data.tar.gz: 68fc4f568372a36c37c671dc6d9b78af11ed26524eede15bb8eab72baabd58e4e8886b3cf181d9a33ededb0642afa11559db56b3b63cfccecade37bc918769bf
+  metadata.gz: dac31add2ebbb9beb4d5734aeb7e4c3a249d2eefcbecf6a547a664b83670bab9a39069bb4d87385aeebaeb8f59cf9511321655cf3104407182b9ff0d84a3de4d
+  data.tar.gz: 6298da746d92328491e89ff84983cb39c2bc6a32c309fa4cda6915d210e9a3d30851ade48101741d6a6279fcf87a73f32d971050804bb22f26153ac21d07e671

data/.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: Test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 permissions:
   contents: read
@@ -14,14 +14,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2']
+        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4", "4.0"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/README.md

@@ -27,19 +27,23 @@ Run the installation script:
 ## Configuration
 
 You can configure the gem by running the following during the initialization of the Rails app:
+
 ```ruby
 UffDbLoader.configure do |config|
   config.environments = ['staging', 'production']
-  config.ssh_user = 'Francina'
-  config.ssh_host = 'host.of.yoursite'
-  config.db_name = 'twotter'
+  config.ssh_user = ->(_app_name, environment) { environment == 'production' ? 'Francina' : 'FrancinaStaging' } # It accepts a static string too.
+  config.ssh_host = ->(_app_name, environment) { "#{environment}.host.of.yoursite" } # It accepts a static string too.
+  config.db_name = ->(app_name, environment) { "#{app_name}_#{environment}" } # Defaults to ssh_user. It accepts a static string too.
   config.db_system = :postgresql # Possible values are 'postgresql' and 'mysql'.
   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.
+  config.local_restore_command_path = '' # Sets the path to the db-cli (pg_restore, mysql). Defaults to nil so it's using the default binary (mysql, pg_dump) in $PATH.
+  config.restore_command_template = '%command% --jobs=4 --dbname %database% %file%' # Customize the restore command. Available placeholders: %command% (e.g. `pg_restore`), %database%, %file%. Defaults to the database system's template.
 end
 ```
+
 For example in a file like `config/initializers/uff_db_loader.rb`.
 
 Make sure the app's database user has the superuser role. Otherwise the app will crash on startup due to missing permissions.
@@ -54,6 +58,7 @@ Make sure the app's database user has the superuser role. Otherwise the app will
 - `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
+- `current`: Shows the currently connected database and the one UffDbLoader has selected
 
 ## Development
 

data/lib/configuration.rb

@@ -15,7 +15,8 @@ module UffDbLoader
       :dumps_directory,
       :database_config_file,
       :container_name,
-      :local_restore_command_path
+      :local_restore_command_path,
+      :restore_command_template
     )
 
     def initialize
@@ -29,10 +30,7 @@ module UffDbLoader
       @database_config_file = File.join(Dir.pwd, "config", "database.yml")
       @container_name = nil
       @local_restore_command_path = nil
-    end
-
-    def database
-      db_name || ssh_user
+      @restore_command_template = nil
     end
 
     def database_system

data/lib/uff_db_loader/mysql.rb

@@ -10,8 +10,12 @@ module UffDbLoader
       "ssh %user%@%host% \"docker exec -i %container_name% sh -c 'exec mysqldump --opt --single-transaction --routines --triggers --events --no-tablespaces -uroot -p\"\\$MYSQL_ROOT_PASSWORD\" %database%'\" > %target%"
     end
 
-    def self.restore_command(database_name, result_file_path, config)
-      "#{File.join(config.local_restore_command_path || "mysql")} -uroot #{database_name} < #{result_file_path}"
+    def self.restore_command_template
+      "%command% -uroot %database% < %file%"
+    end
+
+    def self.default_restore_command
+      "mysql"
     end
 
     def self.list_databases

data/lib/uff_db_loader/postgresql.rb

@@ -7,11 +7,15 @@ module UffDbLoader
     end
 
     def self.dump_command_template
-      "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%"
+      "ssh %user%@%host% \"docker exec -i %container_name% sh -c 'exec pg_dump --username \\$POSTGRES_USER --no-owner --no-acl --format=c %database%'\" > %target%"
     end
 
-    def self.restore_command(database_name, result_file_path, config)
-      "#{File.join(config.local_restore_command_path || "pg_restore")} --username postgres --clean --if-exists --no-owner --no-acl --dbname #{database_name} #{result_file_path}"
+    def self.restore_command_template
+      "%command% --username postgres --no-owner --no-acl --dbname %database% %file%"
+    end
+
+    def self.default_restore_command
+      "pg_restore"
     end
 
     def self.list_databases

data/lib/uff_db_loader/tasks/uff_db_loader.rake

@@ -89,4 +89,15 @@ namespace :uff_db_loader do
 
     UffDbLoader.log "♻️  Restarted rails server with default database."
   end
+
+  desc "Shows the currently selected and connected database"
+  task current: :environment do
+    UffDbLoader.ensure_installation!
+    selected_database = UffDbLoader.current_database_name
+
+    UffDbLoader.log "Active Record connected to: #{ActiveRecord::Base.connection.current_database}"
+    unless selected_database.nil?
+      UffDbLoader.log "Selected database: #{selected_database}"
+    end
+  end
 end

data/lib/uff_db_loader/templates/uff_db_loader_initializer.erb

@@ -14,7 +14,10 @@ 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.db_name = ->(app_name, environment) { "#{app_name}_#{environment}" } # Defaults to ssh_user. It accepts a static string too.
+    # config.ssh_user = ->(_app_name, environment) { "my-user-for-#{environment}" } # It accepts a static string too.
+    # config.ssh_host = ->(_app_name, environment) { "#{environment}.host.of.yoursite" } # It accepts a static string too.
     # config.container_name = ->(app_name, environment) { "#{app_name}_#{environment}_custom_suffix" } # Defaults to "#{app_name}_#{environment}_db". It accepts a static string too.
-    # config.local_restore_command_path = '' # Sets the path to the db-cli (pg_restore, mysql). Defaults to nil so it uses what is configured in $PATH.
+    # config.local_restore_command_path = '' # Sets the path to the db-cli (pg_restore, mysql). Defaults to nil so it's using the default binary (mysql, pg_dump) in $PATH.
   end
 end

data/lib/uff_db_loader/version.rb

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

data/lib/uff_db_loader.rb

@@ -145,9 +145,29 @@ module UffDbLoader
 
     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)
+      resolve_dynamic_setting(config.container_name, environment)
+    end
+
+    def ssh_user(environment)
+      resolve_dynamic_setting(config.ssh_user, environment)
+    end
+
+    def ssh_host(environment)
+      resolve_dynamic_setting(config.ssh_host, environment)
+    end
+
+    def database_name(environment)
+      database_name = resolve_dynamic_setting(config.db_name, environment)
+      return database_name if database_name.present?
+
+      ssh_user(environment)
+    end
+
+    def resolve_dynamic_setting(setting, environment)
+      return setting unless setting.respond_to? :call
+
+      setting.call(config.app_name, environment)
     end
 
     def initializer_template_path
@@ -169,15 +189,21 @@ module UffDbLoader
       config
         .database_system
         .dump_command_template
-        .gsub("%host%", config.ssh_host)
-        .gsub("%user%", config.ssh_user)
-        .gsub("%database%", config.database)
+        .gsub("%host%", ssh_host(environment))
+        .gsub("%user%", ssh_user(environment))
+        .gsub("%database%", database_name(environment))
         .gsub("%target%", target)
         .gsub("%container_name%", container_name(environment))
     end
 
     def restore_command(database_name, result_file_path)
-      config.database_system.restore_command(database_name, result_file_path, config)
+      template = config.restore_command_template || config.database_system.restore_command_template
+      command = config.local_restore_command_path || config.database_system.default_restore_command
+
+      template
+        .gsub("%command%", command)
+        .gsub("%database%", database_name)
+        .gsub("%file%", result_file_path)
     end
 
     def database_name_template(old_database_name)

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: uff_db_loader
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Andreas Hellwig
 - Fynn Heintz
 - Robin Mehner
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -88,9 +87,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/3.2.0
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/4.1.0
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/3.2.0
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/4.1.0
 post_install_message: Please run `bin/rails uff_db_loader:install` to complete the
   installation.
 rdoc_options: []
@@ -107,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Allows to dump, download and restore databases from docker servers.
 test_files: []