uff_db_loader 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95175e122ab4572d155f684796d9093587d5764d330855f3f50707491d223185
-  data.tar.gz: da94a660905f4e8a768735343347bf7b8016d67a2a706c245360a14ab0eb7a02
+  metadata.gz: 7bd8cbc61f1a00104d4331da35c5e46cd08d3458977a8b59f2f16bd97ff1d9f3
+  data.tar.gz: c164595210489cc21d090672c3ff2e571184440a1a1aeb7810e070ad976d6ad4
 SHA512:
-  metadata.gz: f9ca8396b85bb4d5665f209d50dc183b97ce8020ac0393429e6f884f3455fa81cf4c6206bf05c80a6c8c1ac85d35ae254cfc919db0aa14b7a6c6425c39ac7dd1
-  data.tar.gz: a64fb6d2c537c3b5004234253ad7c7fc5acd150fa1e5b09265d8a3d89a730834dd49a1510251e1934684fe88df34a74e6453948d44ff4e45e9f5ab94eac0d1d2
+  metadata.gz: 8c63cf3e6671df456a8a5094505e28151d4c98c9410b920742ca685c91ecf683167471ad6c91d16f43dcac97e0f93f9b7ed21e784cb9f8d808fd36f3ab15544b
+  data.tar.gz: bd6e2f2f5b5ea9e5d95dd7e2fe3eb40280d52d7b2803601f71fe3daa4f5b5edb3921fe7ddabd9e0868662457c30d760a5ef63920c2881443c59ff01d963c1216

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/mysql.rb

@@ -13,5 +13,17 @@ module UffDbLoader
     def self.restore_command(database_name, result_file_path)
       "mysql -uroot #{database_name} < #{result_file_path}"
     end
+
+    def self.list_databases
+      ActiveRecord::Base.connection.execute("SHOW DATABASES;").to_a.flatten
+    end
+
+    def self.create_database(database_name)
+      ActiveRecord::Base.connection.execute("CREATE DATABASE #{database_name};")
+    end
+
+    def self.drop_database(database_name)
+      ActiveRecord::Base.connection.execute("DROP DATABASE IF EXISTS #{database_name};")
+    end
   end
 end

data/lib/uff_db_loader/postgresql.rb

@@ -13,5 +13,21 @@ module UffDbLoader
     def self.restore_command(database_name, result_file_path)
       "pg_restore --username postgres --clean --if-exists --no-owner --no-acl --dbname #{database_name} #{result_file_path}"
     end
+
+    def self.list_databases
+      ActiveRecord::Base
+        .connection
+        .execute("SELECT datname FROM pg_database;")
+        .values
+        .flatten
+    end
+
+    def self.create_database(database_name)
+      ActiveRecord::Base.connection.execute("CREATE DATABASE #{database_name};")
+    end
+
+    def self.drop_database(database_name)
+      ActiveRecord::Base.connection.execute("DROP DATABASE IF EXISTS #{database_name};")
+    end
   end
 end

data/lib/uff_db_loader/tasks/remote_database.rake

@@ -5,33 +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, ".*")
-    ActiveRecord::Base.connection.execute("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 "🧐 Please note this task is called 'uff_db_loader:load' now."
+    Rake::Task["uff_db_loader:load"].invoke
+  end
 
-    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`)"
+  desc "Delete all downloaded db dumps and emove all databases created by UffDbLoader"
+  task prune: :environment do
+    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,48 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+namespace :uff_db_loader 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)
+  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`)"
+  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
+  end
+end

data/lib/uff_db_loader/version.rb

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

data/lib/uff_db_loader.rb

@@ -18,12 +18,20 @@ module UffDbLoader
     yield(config)
   end
 
+  def self.dump_filename(environment)
+    File.join(
+      config.dumps_directory,
+      Time.now.strftime("#{config.app_name}_#{environment}_%Y_%m_%d_%H_%M_%S.#{config.database_system.dump_extension}")
+    )
+  end
+
   def self.dump_from(environment)
     FileUtils.mkdir_p(config.dumps_directory)
 
     puts "⬇️  Creating dump ..."
 
-    target = File.join(config.dumps_directory, Time.now.strftime("#{config.app_name}_#{environment}_%Y_%m_%d_%H_%M_%S.#{config.database_system.dump_extension}"))
+    target = dump_filename(environment)
+
     command_successful = system(dump_command(environment, target))
     raise "Command did not run succesful: #{dump_command(environment, target)}" unless command_successful
 
@@ -32,6 +40,10 @@ module UffDbLoader
     target
   end
 
+  def self.create_database(database_name)
+    config.database_system.create_database(database_name)
+  end
+
   def self.dump_command(environment, target)
     config
       .database_system
@@ -54,6 +66,20 @@ module UffDbLoader
     config.database_system.restore_command(database_name, result_file_path)
   end
 
+  def self.prune_dump_directory
+    FileUtils.rm_rf("#{config.dumps_directory}/.", secure: true)
+  end
+
+  def self.drop_database(database_name)
+    config.database_system.drop_database(database_name)
+  end
+
+  def self.databases
+    config.database_system.list_databases.select do |line|
+      line =~ /#{config.app_name}_(#{config.environments.join("|")})_(\d|_)+/
+    end
+  end
+
   class ForbiddenEnvironmentError < StandardError; end
 
   class UnknownDatabaseSystem < StandardError; end

data/uff_db_loader.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description = "Allows to dump, download and restore databases from servers with a specific docker setup, that UFF uses commonly."
   spec.homepage = "https://github.com/rmehner/uff_db_loader"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.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: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andreas Hellwig
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -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,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/1.0.0
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/1.2.0
   homepage_uri: https://github.com/rmehner/uff_db_loader
-  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/1.0.0
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/1.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -98,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="