geordi 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1060f10e77e6173a1b8d63fd8c2d89579e5be0597a683f5358b01173e4c266de
-  data.tar.gz: 8a44e3cd313e779b84ae9ecfa0f92283f4dd3f45f7525ec0bc298b11a719c389
+  metadata.gz: 337e7767788852ee10b537112f4151f4b12e267740fa20557b7786e12babd97d
+  data.tar.gz: 0dd146812562eb28fa115cbbdefa1bffcc8b172f1b509d44414bcca667ce3774
 SHA512:
-  metadata.gz: c7793fda9e1494d3b1a2cf50dfa7b8c10ff61e8c7462596828fe6e44721f50dedbfe18ba2a2c2fb4e0b354500de9528f6e948e8716c9c1a31ceb42a49c8ea845
-  data.tar.gz: fedd7f3106bc5283b25b5f4e20fe1eda099d76c7e4b01483362cebde5cca516d559241d976ad51486a3bc71e11df5a3c21d14288c10805ad9af8307f48d7dab3
+  metadata.gz: '07256569d49cf31224e4a69d5fc0e240d9c8df820e527fd615b1e5956f320fa01077572b4e79401bf7a5ee8b8d9bf135b94c369ef807a2bc40c36aa76eb7180a'
+  data.tar.gz: 18bf3b9d1026575a5c0c3d33281de6b211ffa38c8c0d316656c6aee90bcdc2b81e5cec2feae0f006f2ef3fb8458834c1813dcd8d2aff5adcdf17bed732a06217

data/CHANGELOG.md

@@ -11,10 +11,18 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
+## 9.1.0 2022-02-14
+
+### Compatible changes
+* `geordi dump` and `dumple` now default to "primary" database or the first
+  entry in a multi-db setup
+* Also added feature tests for `dumple` and structured the script
+
+
 ## 9.0.0 2021-12-02
 
 ### Breaking changes
-* Remove the `geordi docker` command.
+* Remove the `geordi docker` command set.
 
 
 ## 8.0.0 2021-11-08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (9.0.0)
+    geordi (9.1.0)
       thor (~> 1)
 
 GEM

data/README.md

@@ -194,7 +194,9 @@ specified target's database and downloads it to `tmp/`.
 `geordi dump staging -l` (with a Capistrano deploy target and the `--load`
 option) sources the dump into the development database after downloading it.
 
-If you are using multiple databases per environment, pass the database name like this:
+If you are using multiple databases per environment, Geordi defaults to the
+"primary" database, or the first entry in database.yml. To dump a specific
+database, pass the database name like this:
 
     geordi dump -d primary
 

data/exe/dumple

@@ -1,28 +1,33 @@
 #!/usr/bin/env ruby
 
-require 'erb'
-
-fail_gently = ARGV.include?("--fail-gently")
-compress = ARGV.include?("--compress")
-
 if ARGV.include?("-i")
   puts "*******************************************************"
   puts
   system("du -sh ~/dumps")
   puts
   puts "*******************************************************"
+
   exit
 end
 
-###
-
+require 'erb'
 require "yaml"
-config_path = 'config/database.yml'
 
-begin
-  # go to project root
+DB_CONFIG_PATH = 'config/database.yml'
+DUMPS_DIR = "#{ENV['HOME']}/dumps"
+
+def run(*args)
+  if !!ENV['GEORDI_TESTING']
+    puts "system #{args.join(', ')}"
+    true # "Command succeeded"
+  else
+    system *args
+  end
+end
+
+def cd_to_project_root(fail_gently)
   current = Dir.pwd
-  until (File.exists? config_path)
+  until File.exists?(DB_CONFIG_PATH)
     Dir.chdir '..'
     if current == Dir.pwd
       if fail_gently
@@ -38,46 +43,24 @@ begin
         sleep 5
         exit
       else
-        raise "Call me from inside a Rails project."
+        raise "x Call me from inside a Rails project."
       end
     end
     current = Dir.pwd
   end
+end
 
-  config = YAML::load(ERB.new(File.read(config_path)).result)
-  environment, database = ARGV.reject{ |arg| arg[0].chr == '-' }
-  environment ||= 'production'
-  config = config[environment] or raise "No #{environment} database found.\nUsage: dumple ENVIRONMENT [DATABASE]"
-
-  if database
-    config = config[database] or raise %(Unknown #{environment} database "#{database}")
-  end
-
-  dump_dir = "#{ENV['HOME']}/dumps"
-  unless File.directory?(dump_dir)
-    Dir.mkdir(dump_dir)
-    system("chmod 700 #{dump_dir}")
-  end
-
-  if ARGV.find{ |arg| arg == '--for_download'}
-    dump_path = "#{dump_dir}/dump_for_download.dump"
-  else
-    dump_path = "#{dump_dir}/#{config['database']}_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump"
-  end
-
-  given_database = database ? %(#{database} ) : ""
-  puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
-
+def dump_command(dump_file, config)
   host = config['host']
   port = config['port']
 
-  dump_command = case config['adapter']
+  case config['adapter']
   when /mysql/
     command = "mysqldump"
     command << " -u\"#{config['username']}\""
     command << " -p\"#{config['password']}\""
     command << " #{config['database']}"
-    command << " -r #{dump_path}"
+    command << " -r #{dump_file}"
     # Using a transaction to allow concurrent request while creating a dump.
     # This works only reliable for InnoDB tables.
     # More details: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_single-transaction
@@ -96,25 +79,75 @@ begin
     command << " pg_dump #{config['database']}"
     command << " --clean"
     command << " --format=custom"
-    command << " --file=#{dump_path}"
+    command << " --file=#{dump_file}"
     command << " --username=\"#{config['username']}\""
     command << " --host=#{host}" if host
     command << " --port=#{port}" if port
     command
   else
-    raise "Adapter \"#{config['adapter']}\" is not supported"
+    raise %(x Adapter "#{config['adapter']}" is not supported.)
+  end
+end
+
+def find_database_config(config_path, environment, database)
+  environment ||= 'production'
+  database_yml = ERB.new(File.read(config_path)).result
+  config = YAML::load(database_yml)
+  config = config[environment] or raise "x No #{environment} database found.\nUsage: dumple ENVIRONMENT [DATABASE]"
+
+  if config.values[0].is_a? Hash # Multi-db setup
+    if database # Explicitly requested
+      config = config[database] or raise %(x Unknown #{environment} database "#{database}".)
+    elsif config.key? 'primary'
+      puts '> Multiple databases detected. Defaulting to primary database.'
+      config = config['primary']
+    else
+      puts "> Multiple databases detected. Defaulting to first entry (#{config.keys[0]})."
+      config = config.values[0]
+    end
+  else # Single-db setup
+    if database
+      raise %(x Could not select "#{database}" database in a single-db environment.)
+    end
   end
-  success = system(dump_command)
-  success or raise "Creating the dump failed"
 
-  system "chmod 600 #{dump_path}"
+  config
+end
+
+def prepare_dump_path(config)
+  unless File.directory?(DUMPS_DIR)
+    Dir.mkdir(DUMPS_DIR)
+    run "chmod 700 #{DUMPS_DIR}"
+  end
+
+  if ARGV.include? '--for_download'
+    "#{DUMPS_DIR}/dump_for_download.dump"
+  else
+    "#{DUMPS_DIR}/#{config['database']}_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump"
+  end
+end
+
+begin
+  fail_gently = ARGV.include?("--fail-gently")
+  compress = ARGV.include?("--compress")
+  environment, database = ARGV.reject { |arg| arg[0].chr == '-' }
+
+  cd_to_project_root(fail_gently)
+  config = find_database_config(DB_CONFIG_PATH, environment, database)
+  dump_path = prepare_dump_path(config)
+
+  # Dump!
+  given_database = database ? %(#{database} ) : ""
+  command = dump_command(dump_path, config)
+  puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
+  run command or raise "x Creating the dump failed."
+  run "chmod 600 #{dump_path}"
 
   if compress
     puts "> Compressing the dump ..."
-
     # gzip compresses in place
-    compress_success = system("gzip #{dump_path}")
-    compress_success or raise "Compressing the dump failed"
+    compress_success = run "gzip #{dump_path}"
+    compress_success or raise "x Compressing the dump failed."
     dump_path << ".gz"
   end
 

data/geordi.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary
   spec.homepage = 'https://makandra.com'
   spec.license = 'MIT'
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/geordi/commands/dump.rb

@@ -11,7 +11,9 @@ specified target's database and downloads it to `tmp/`.
 `geordi dump staging -l` (with a Capistrano deploy target and the `--load`
 option) sources the dump into the development database after downloading it.
 
-If you are using multiple databases per environment, pass the database name like this:
+If you are using multiple databases per environment, Geordi defaults to the
+"primary" database, or the first entry in database.yml. To dump a specific
+database, pass the database name like this:
 
     geordi dump -d primary
 
@@ -26,9 +28,8 @@ def dump(target = nil, *_args)
   require 'geordi/remote'
   database = options[:database] ? "#{options[:database]} " : ''
 
-  if target.nil?
-    if options.load
-      # validate load option
+  if target.nil? # Local …
+    if options.load # … dump loading
       Interaction.fail 'Missing a dump file.' if options.load == 'load'
       File.exist?(options.load) || raise('Could not find the given dump file: ' + options.load)
 
@@ -39,19 +40,19 @@ def dump(target = nil, *_args)
 
       Interaction.success "Your #{loader.config['database']} database has now the data of #{options.load}."
 
-    else
+    else # … dump creation
       Interaction.announce 'Dumping the development database'
       Util.run!("dumple development #{database}")
       Interaction.success "Successfully dumped the #{database}development database."
     end
 
-  else
+  else # Remote dumping …
     database_label = options[:database] ? " (#{database}database)" : ""
 
     Interaction.announce "Dumping the database of #{target}#{database_label}"
     dump_path = Geordi::Remote.new(target).dump(options)
 
-    if options.load
+    if options.load # … and dump loading
       loader = DumpLoader.new(dump_path)
 
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '9.0.0'.freeze
+  VERSION = '9.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -96,11 +96,12 @@ files:
 homepage: https://makandra.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 'Support for sequential running of integration tests tagged
   with @solo has been dropped.
 
-'
+  '
 rdoc_options: []
 require_paths:
 - lib
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails