uff_db_loader 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5f7c50d83a5de12e47520cccc509935f3944ae5d4aec252e27a085483487833
-  data.tar.gz: 961477955168e96b46559142a99d5ff139c4a865920ad32d006beec1a9f0482a
+  metadata.gz: b64fcfeeeda9c2895262cabcf104828511ae1a17abe6c906c040f5b132c48bc3
+  data.tar.gz: 166953900412522babe8958ddbadef253b8e3558c487d67c53962679252dbd29
 SHA512:
-  metadata.gz: ecc86542755c63a15f5b617af89816632bda117dd24fc2e8eb145994ef6b5eef33a8cae83e907ab5279f0ac49135e7187555112df5d57f267b8b11380d4ee93f
-  data.tar.gz: dafc87709eae316b58a94b92894dff04357fcd750b3056114873b8fd6ed5ef42cae3655db24f44b3bf978a39933292b276f9a632c00c9eedb46c7fbccadfc927
+  metadata.gz: bf80b9b22d70bf31fe2b8f2d4c9d2f84e9b23a5448e2a94fcdbfe43fdd5a4155a06da935846f3df41cf34528b1e71a17dcc697bce68a5263e09becad424ae31c
+  data.tar.gz: 74b533e7f45a5b5292d74c7660709f14b60f2a3c8dfa61f390314c4145f7cdcc00f079cd3c253f24f44599518b16eb00ea6edcb37640139f2e1ae9b214b64c19

data/README.md

@@ -43,7 +43,7 @@ Make sure the app's database user has the superuser role. Otherwise the app will
 
 ## Usage
 
-`uff_db_loader` provides `rails remote_database:dump` and `rails remote_database:load` which will prompt for a configured environment.
+`uff_db_loader` provides `rails uff_db_loader:dump` and `rails uff_db_loader:load` which will prompt for a configured environment.
 `dump` will only create and download a current database dump, while `load`, will do the same and restore the database content into a new database and gives instructions on how to use it in development.
 
 

data/lib/uff_db_loader/tasks/remote_database.rake

@@ -5,44 +5,19 @@ require "tty-prompt"
 namespace :remote_database do
   desc "Dumps a remote database to #{UffDbLoader.config.dumps_directory}"
   task dump: :environment do
-    prompt = TTY::Prompt.new
-    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
-    UffDbLoader.ensure_valid_environment!(environment)
-    UffDbLoader.dump_from(environment)
+    puts "🧐 Please note this task is called 'uff_db_loader:dump' now."
+    Rake::Task["uff_db_loader:dump"].invoke
   end
 
   desc "Gets a dump from remote and loads it into the local database"
   task load: :environment do
-    prompt = TTY::Prompt.new
-    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
-    UffDbLoader.ensure_valid_environment!(environment)
-    result_file_path = UffDbLoader.dump_from(environment)
-
-    puts "🤓 Reading from to #{result_file_path}"
-
-    database_name = File.basename(result_file_path, ".*")
-    UffDbLoader.create_database(database_name)
-
-    puts "🗂  Created database #{database_name}"
-
-    command_successful = system(UffDbLoader.restore_command(database_name, result_file_path))
-    raise "Command did not run succesful: #{UffDbLoader.restore_command(database_name, result_file_path)}" unless command_successful
-
-    puts "✅ Succesfully loaded #{result_file_path} into #{database_name}"
-
-    puts "💩 Because YAML is a wonderful format, you need to adapt your config file by hand."
-    puts "🆗 Go to #{UffDbLoader.config.database_config_file} and change the development database value to: #{database_name}"
-    puts "🧑🏾‍🏫 Don't forgot to restart the Rails server after changing the database config (`rails restart`)"
+    puts "🧐 Please note this task is called 'uff_db_loader:load' now."
+    Rake::Task["uff_db_loader:load"].invoke
   end
 
   desc "Delete all downloaded db dumps and emove all databases created by UffDbLoader"
   task prune: :environment do
-    UffDbLoader.databases.each do |database_name|
-      puts "Dropping #{database_name}"
-      UffDbLoader.drop_database(database_name)
-    end
-
-    puts "Removing dumps from #{UffDbLoader.config.dumps_directory}"
-    UffDbLoader.prune_dump_directory
+    puts "🧐 Please note this task is called 'uff_db_loader:prune' now."
+    Rake::Task["uff_db_loader:prune"].invoke
   end
 end

data/lib/uff_db_loader/tasks/uff_db_loader.rake

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+namespace :uff_db_loader do
+  desc "Install uff_db_loader"
+  task install: :environment do
+    UffDbLoader.remember_database_name("") # ensure database file exists
+
+    if UffDbLoader.setup_dynamic_database_name_in_config
+      puts "🤖 Updated #{UffDbLoader.config.database_config_file}. Happy hacking, beep boop!"
+    else
+      puts "💩 Because YAML is a wonderful format, you need to adapt your config file by hand."
+      puts "🆗 Go to #{UffDbLoader.config.database_config_file} and change the development database value to: #{UffDbLoader.database_name_template("default_database_name")}"
+    end
+  end
+
+  desc "Dumps a remote database to #{UffDbLoader.config.dumps_directory}"
+  task dump: :environment do
+    prompt = TTY::Prompt.new
+    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
+    UffDbLoader.ensure_valid_environment!(environment)
+    UffDbLoader.dump_from(environment)
+  end
+
+  desc "Gets a dump from remote and loads it into the local database"
+  task load: :environment do
+    UffDbLoader.ensure_installation!
+
+    prompt = TTY::Prompt.new
+    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
+    UffDbLoader.ensure_valid_environment!(environment)
+    result_file_path = UffDbLoader.dump_from(environment)
+
+    puts "🤓 Reading from to #{result_file_path}"
+
+    database_name = File.basename(result_file_path, ".*")
+    UffDbLoader.load_dump_into_database(database_name)
+  end
+
+  desc "Loads an existing dump into the local database"
+  task restore: :environment do
+    UffDbLoader.ensure_installation!
+
+    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)
+
+    UffDbLoader.load_dump_into_database(database_name)
+  end
+
+  desc "Switches to an existing database"
+  task switch: :environment do
+    UffDbLoader.ensure_installation!
+
+    prompt = TTY::Prompt.new
+    databases = UffDbLoader.databases
+    new_database = prompt.select("Which database do you want to switch to?", databases)
+
+    UffDbLoader.remember_database_name(new_database)
+    system("bin/rails restart")
+
+    puts "♻️  Restarted rails server with new database."
+  end
+
+  desc "Delete all downloaded db dumps and remove all databases created by UffDbLoader"
+  task prune: :environment do
+    UffDbLoader.databases.each do |database_name|
+      puts "Dropping #{database_name}"
+      UffDbLoader.drop_database(database_name)
+    end
+
+    puts "Removing dumps from #{UffDbLoader.config.dumps_directory}"
+    UffDbLoader.prune_dump_directory
+  end
+end

data/lib/uff_db_loader/version.rb

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

data/lib/uff_db_loader.rb

@@ -10,6 +10,10 @@ module UffDbLoader
     @configuration ||= Configuration.new
   end
 
+  def self.database_name_file
+    Rails.root.join("tmp", "uff_db_loader_database_name")
+  end
+
   def self.reset
     @configuration = Configuration.new
   end
@@ -80,7 +84,65 @@ module UffDbLoader
     end
   end
 
+  def self.database_name_template(old_database_name)
+    "<%= UffDbLoader.current_database_name || '#{old_database_name}' %>"
+  end
+
+  def self.setup_dynamic_database_name_in_config
+    old_database_name = Rails.configuration.database_configuration["development"]["database"]
+
+    return false if old_database_name.nil?
+
+    old_config = File.read(UffDbLoader.config.database_config_file)
+    new_config = old_config.sub(old_database_name, database_name_template(old_database_name))
+    File.write(UffDbLoader.config.database_config_file, new_config)
+  end
+
+  def self.current_database_name
+    File.read(database_name_file).strip.presence
+  rescue IOError, Errno::ENOENT => e
+    puts "Could not read #{database_name_file}. #{e.message}"
+  end
+
+  def self.remember_database_name(database_name)
+    File.write(database_name_file, database_name)
+  end
+
+  def self.ensure_installation!
+    unless File.read(UffDbLoader.config.database_config_file).include?("UffDbLoader.current_database_name")
+      raise InstallationDidNotRunError, "Please run bin/rails uff_db_loader:install"
+    end
+  end
+
+  def self.dump_file_path(database_name)
+    File.join(
+      config.dumps_directory,
+      "#{database_name}.#{config.database_system.dump_extension}"
+    )
+  end
+
+  def self.load_dump_into_database(database_name)
+    UffDbLoader.drop_database(database_name)
+    UffDbLoader.create_database(database_name)
+
+    puts "🗂  Created database #{database_name}"
+
+    dump_file_path = dump_file_path(database_name)
+
+    command_successful = system(restore_command(database_name, dump_file_path))
+    raise "Command did not run succesful: #{restore_command(database_name, dump_file_path)}" unless command_successful
+
+    puts "✅ Succesfully loaded #{dump_file_path} into #{database_name}"
+
+    remember_database_name(database_name)
+    system("bin/rails restart")
+
+    puts "♻️  Restarted rails server with new database."
+  end
+
   class ForbiddenEnvironmentError < StandardError; end
 
   class UnknownDatabaseSystem < StandardError; end
+
+  class InstallationDidNotRunError < StandardError; end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: uff_db_loader
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Andreas Hellwig
 - Fynn Heintz
 - Robin Mehner
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2022-08-25 00:00:00.000000000 Z
@@ -80,6 +80,7 @@ files:
 - lib/uff_db_loader/mysql.rb
 - lib/uff_db_loader/postgresql.rb
 - lib/uff_db_loader/tasks/remote_database.rake
+- lib/uff_db_loader/tasks/uff_db_loader.rake
 - lib/uff_db_loader/version.rb
 - uff_db_loader.gemspec
 homepage: https://github.com/rmehner/uff_db_loader
@@ -87,10 +88,10 @@ 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/1.1.1
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/1.4.0
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/1.1.1
-post_install_message:
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/1.4.0
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Allows to dump, download and restore databases from docker servers.
 test_files: []