uff_db_loader 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '060096b6203e8ec9ad703842bd1a0c8e54a8ac83bb242316b9d4e1943f3ac293'
-  data.tar.gz: 9957904bdfdd43ad6562d96e7d5cbb6b5fdc4e1c610687fcb11aff706707d051
+  metadata.gz: 4d3709fc6ef4c0ba44fdefcf81cdc25383e1602d13b764351d7768eea8c12d93
+  data.tar.gz: ddccaa836fdfbeea03e41b60af5131f26e6618adfc8c4bef0f849593874e4a24
 SHA512:
-  metadata.gz: dc35bb6b7d806afdd007acbc131651fa232d904fdc8ff51f2253fd4d9e45002e37ab01d93e0aa8823b25d2e386a1c7ba65ce25ad9170a0f4e35b10abf67079b7
-  data.tar.gz: fb6f49b13663d44312fc38ba118b7b140c38ed7ab2bb99f38dc37619e500aee1ad1137b332f0a5460f5346791d66a1885153385edc72819175419df6146b0c8d
+  metadata.gz: 48c0b323e3048c04219d18895aa291047a4a6bf2766435f6414a9178f0a0c3bc8a6f1eae6f6d52a245bcdc756efb79cf8c39c8ebf4d55f6510c1f288a7a4a511
+  data.tar.gz: aabdfc61022f10e079ee9d3aa3de6505d2fc040fab18a2d6db263e1620a1209d11873949b27ee62a0338eed49afd2ffed8898ce69489e73181ee028137fc5385

data/.gitignore

@@ -12,3 +12,4 @@ Gemfile.lock
 .rspec_status
 
 .DS_Store
+*.gem

data/README.md

@@ -31,9 +31,9 @@ You can configure the gem by running the following during the initialization of
 ```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')

data/lib/configuration.rb

@@ -33,10 +33,6 @@ module UffDbLoader
       @restore_command_template = nil
     end
 
-    def database
-      db_name || ssh_user
-    end
-
     def database_system
       case db_system.to_sym
       when :postgresql

data/lib/uff_db_loader/tasks/uff_db_loader.rake

@@ -29,10 +29,7 @@ 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"])
+    UffDbLoader.connect_to_default_database
 
     prompt = TTY::Prompt.new
     database_name = prompt.select("Which dump should be restored?", UffDbLoader.dumps, filter: true)
@@ -57,13 +54,14 @@ namespace :uff_db_loader do
   desc "Dumps a remote database from a selected environment to #{UffDbLoader.config.dumps_directory}, then restores and selects the database"
   task load: :environment do
     UffDbLoader.ensure_installation!
+    UffDbLoader.connect_to_default_database
 
     prompt = TTY::Prompt.new
     environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments, filter: true)
     UffDbLoader.ensure_valid_environment!(environment)
     result_file_path = UffDbLoader.dump_from(environment)
 
-    UffDbLoader.log "🤓 Reading from to #{result_file_path}"
+    UffDbLoader.log "🤓 Reading from #{result_file_path}"
 
     database_name = File.basename(result_file_path, ".*")
     UffDbLoader.load_dump_into_database(database_name)

data/lib/uff_db_loader/templates/uff_db_loader_initializer.erb

@@ -14,6 +14,9 @@ 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's using the default binary (mysql, pg_dump) in $PATH.
   end

data/lib/uff_db_loader/version.rb

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

data/lib/uff_db_loader.rb

@@ -9,6 +9,8 @@ module UffDbLoader
   TIMESTAMP_FORMAT = "%Y_%m_%d_%H_%M_%S"
   TIMESTAMP_LENGTH = Time.now.strftime(TIMESTAMP_FORMAT).size
 
+  class DefaultDatabaseNotFoundError < StandardError; end
+
   class << self
     def config
       @configuration ||= Configuration.new
@@ -30,6 +32,21 @@ module UffDbLoader
       system("bin/rails restart")
     end
 
+    def connect_to_default_database
+      database_config = Rails.configuration.database_configuration["development"]
+
+      # Switch away from a selected dump database before drop/create operations.
+      remember_database_name("")
+      ActiveRecord::Base.remove_connection
+      ActiveRecord::Base.establish_connection(database_config)
+      ActiveRecord::Base.connection
+    rescue ActiveRecord::NoDatabaseError
+      database_name = database_config["database"].inspect
+
+      raise DefaultDatabaseNotFoundError,
+        "Default local database #{database_name} does not exist. Run `bin/rails db:create` before using UffDbLoader."
+    end
+
     def dump_from(environment)
       FileUtils.mkdir_p(config.dumps_directory)
 
@@ -145,9 +162,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,9 +206,9 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uff_db_loader
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Andreas Hellwig
@@ -87,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/4.0.0
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/4.1.1
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/4.0.0
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/4.1.1
 post_install_message: Please run `bin/rails uff_db_loader:install` to complete the
   installation.
 rdoc_options: []
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Allows to dump, download and restore databases from docker servers.
 test_files: []