geordi 12.5.0 → 12.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8dcb193d83d352bffb4f62670c93732de779a9471e51f942a0c20ddf19b89b
-  data.tar.gz: 152f889f12fe2cfdeea9b1457bc1b6c9d083169d3400a1189588470fc061f4b2
+  metadata.gz: 2f8359f51e8fa9d619b9d84ede59104e711d59e33c2f034e6a3bc1a8933fd457
+  data.tar.gz: 2d234986282ecc98a4853a8d6b4f8103556ca10694596b399b534aab3b8ce3d5
 SHA512:
-  metadata.gz: 04732b8f09ba0f7eba641fe8fa5cbff9ea625f311ce42db3b588345a7565b4631d4e67e81420b3b4f357afc98fff3021a458cdb08a03daf15ea93110512e444d
-  data.tar.gz: '02938cfa637e316e97b70666a7615696ccc1d881711c8823954529fc109af32ef16f98f132938ce1e04e49c0f007b1e60563e725669aff040eb504e207b7dc5f'
+  metadata.gz: 8415640931dfa6738300ab40b3a4ace0d232993cf7b29aacc924f3b9de3a13b82b45b9064984dcc263883ec50bcc8717e97671140c8c45413842a94566e6ff13
+  data.tar.gz: c4f0ed717cd6dadfc770019444b35e47fc8176ff65971a99fef0e71eeb37d2e740201b000738db5e12bdf8d3043e957f77a05d92165fc2562fde9de6ea8239ec

data/CHANGELOG.md

@@ -10,6 +10,14 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
+## 12.6.0 2025-09-22
+
+### Compatible changes
+
+- `geordi dump`: Allow to forward the compression option to the underlying `dumple` command, e.g. `geordi dump --compress=zstd:3` (for PostgreSQL) or `geordi dump --compress` (for MySQL).
+- `dumple`: Allow to specify a compression algorithm for PostgreSQL, e.g. `dumple --compress=zstd:3`. The already supported compression for MySQL `dumple --compress` is kept untouched.
+
+
 ## 12.5.0 2025-09-09
 
 ### Compatible changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (12.5.0)
+    geordi (12.6.0)
       highline
       thor (~> 1)
 

data/README.md

@@ -65,8 +65,8 @@ Example: `geordi chromedriver_update`
 This command will find and install the matching chromedriver for the currently
 installed Chrome.
 
-Setting `auto_update_chromedriver` to `true` in your global Geordi config file 
-(`~/.config/geordi/global.yml`), will automatically update chromedriver before 
+Setting `auto_update_chromedriver` to `true` in your global Geordi config file
+(`~/.config/geordi/global.yml`), will automatically update chromedriver before
 cucumber tests if a newer chromedriver version is available.
 
 
@@ -98,8 +98,8 @@ servers. When passed a number, directly connects to the selected server.
 IRB flags can be given as `irb_flags: '...'` in the global or local Geordi config file
 (`~/.config/geordi/global.yml` / `./.geordi.yml`). If you define irb_flags in both files, the local config file will be
 used. For IRB >=1.2 in combination with Ruby <3 geordi automatically sets the `--nomultiline` flag, to prevent slow
-pasting. You can override this behavior by setting `--multiline` in the global config file or by defining `irb_flags` 
-in the local config file. The latter will always turn off the automatic behavior, even if you don't set any values for 
+pasting. You can override this behavior by setting `--multiline` in the global config file or by defining `irb_flags`
+in the local config file. The latter will always turn off the automatic behavior, even if you don't set any values for
 the irb_flags key.
 
 **Options**
@@ -191,8 +191,8 @@ and offer to delete them. Excluded are databases that are whitelisted. This come
 in handy when you're keeping your currently active projects in the whitelist files
 and perform regular housekeeping with Geordi.
 
-Per default, Geordi will try to connect to the databases as a local user without 
-password authorization.  
+Per default, Geordi will try to connect to the databases as a local user without
+password authorization.
 
 Geordi will ask for confirmation before actually dropping databases and will
 offer to edit the whitelist instead.
@@ -234,6 +234,7 @@ not match, please issue separate commands for dumping (`dump -d`) and sourcing
 **Options**
 - `-l, --load=[DUMP_FILE]`: Load a dump
 - `-d, --database=NAME`: Target database, if there are multiple databases
+- `-c, --compress=[ALGORITHM]`: Compress the dump file (default for PSQL)
 
 
 ### `geordi help [COMMAND]`
@@ -341,7 +342,7 @@ Run all employed tests.
 When running `geordi tests` without any arguments, all unit tests, rspec specs
 and cucumber features will be run.
 
-When passing file paths or directories as arguments, Geordi will forward them to `rspec` and `cucumber`. 
+When passing file paths or directories as arguments, Geordi will forward them to `rspec` and `cucumber`.
 All rspec specs and cucumber features matching the given paths will be run.
 
 
@@ -389,7 +390,9 @@ Stores a timestamped database dump for the given Rails environment in `~/dumps`:
 
 **Options**
 - `-i`: Print disk usage of `~/dumps`
-- `--compress`: After dumping, run gzip to compress the dump in place
+- `--fail-gently`: On error, do not crash but print a warning and exit(0)
+- `--for-download`: Dump to `~/dumps/dump_for_download.dump`
+- `--compress`: Compress the dump (default for PostgreSQL) and optionally set the compression algorithm (only available for PostgreSQL)
 
 
 Contributing

data/exe/dumple

@@ -50,7 +50,7 @@ def cd_to_project_root(fail_gently)
   end
 end
 
-def dump_command(dump_file, config)
+def dump_command(dump_file, config, compress)
   host = config['host']
   port = config['port']
 
@@ -79,6 +79,7 @@ def dump_command(dump_file, config)
     command << " pg_dump #{config['database']}"
     command << " --clean"
     command << " --format=custom"
+    command << " --compress=#{compress}" if compress.is_a?(String)
     command << " --file=#{dump_file}"
     command << " --username=\"#{config['username']}\""
     command << " --host=#{host}" if host
@@ -124,7 +125,7 @@ def prepare_dump_path(config)
     run "chmod 700 #{DUMPS_DIR}"
   end
 
-  if ARGV.include? '--for_download'
+  if ARGV.include?('--for_download') || 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"
@@ -133,8 +134,14 @@ end
 
 begin
   fail_gently = ARGV.include?("--fail-gently")
-  compress = ARGV.include?("--compress")
-  environment, database = ARGV.reject { |arg| arg[0].chr == '-' }
+  compress = ARGV.find do |argument|
+    if argument == '--compress'
+      break true
+    elsif argument.start_with?('--compress=')
+      break argument.split('=').last
+    end
+  end
+  environment, database = ARGV.reject { |argument| argument.start_with?('-') }
 
   cd_to_project_root(fail_gently)
   config = find_database_config(DB_CONFIG_PATH, environment, database)
@@ -142,12 +149,17 @@ begin
 
   # Dump!
   given_database = database ? %(#{database} ) : ""
-  command = dump_command(dump_path, config)
+  command = dump_command(dump_path, config, compress)
   puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
   run command or raise "x Creating the dump failed."
   run "chmod 600 #{dump_path}"
 
-  if compress
+  if config['adapter'] == 'mysql' && compress.is_a?(String)
+    puts "> Cannot compress a MySQL dump with #{compress}, falling back to gzip."
+  end
+
+  # For PostgreSQL, #dump_command will do the compression. MySQL needs manual compression.
+  if config['adapter'] == 'mysql' && compress
     puts "> Compressing the dump ..."
     # gzip compresses in place
     compress_success = run "gzip #{dump_path}"

data/lib/geordi/commands/dump.rb

@@ -26,11 +26,11 @@ DESC
 
 option :load, aliases: '-l', type: :string, desc: 'Load a dump', banner: '[DUMP_FILE]'
 option :database, aliases: '-d', type: :string, desc: 'Target database, if there are multiple databases', banner: 'NAME'
+option :compress, aliases: '-c', type: :string, desc: 'Compress the dump file (default for PSQL)', banner: '[ALGORITHM]'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'
   require 'geordi/remote'
-  database = options[:database] ? "#{options[:database]} " : ''
 
   if target.nil? # Local …
     if options.load # … dump loading
@@ -46,14 +46,17 @@ def dump(target = nil, *_args)
 
     else # … dump creation
       Interaction.announce 'Dumping the development database'
-      Util.run!("dumple development #{database}")
+      Util.run!(Util.dumple_command('development', options))
+
+      database = "#{options[:database]} " if options[:database]
       Interaction.success "Successfully dumped the #{database}development database."
     end
 
   else # Remote dumping …
-    database_label = options[:database] ? " (#{database}database)" : ""
+    database_label = target.dup
+    database_label << " (#{options[:database]} database)" if options[:database]
 
-    Interaction.announce "Dumping the database of #{target}#{database_label}"
+    Interaction.announce "Dumping the database of #{database_label}"
     dump_path = Geordi::Remote.new(target).dump(options)
 
     if options.load # … and dump loading
@@ -65,7 +68,7 @@ def dump(target = nil, *_args)
       Util.run! "rm #{dump_path}"
       Interaction.note "Dump file removed"
 
-      Interaction.success "Your #{loader.config['database']} database has now the data of #{target}#{database_label}."
+      Interaction.success "Your #{loader.config['database']} database has now the data of #{database_label}."
     end
   end
 

data/lib/geordi/remote.rb

@@ -33,11 +33,9 @@ module Geordi
     end
 
     def dump(options = {})
-      database = options[:database] ? " #{options[:database]}" : ''
       # Generate dump on the server
-      shell options.merge({
-        remote_command: "dumple #{@config.env}#{database} --for_download",
-      })
+      dumple = Util.dumple_command(@config.env, options.merge(for_download: true))
+      shell(options.merge(remote_command: dumple))
 
       destination_directory = File.join(@config.root, 'tmp')
       FileUtils.mkdir_p destination_directory
@@ -48,6 +46,7 @@ module Geordi
       server = @config.primary_server
       Util.run!("scp -C #{@config.user(server)}@#{server}:#{REMOTE_DUMP_PATH} #{destination_path}")
 
+      database = " #{options[:database]}" if options[:database]
       Interaction.success "Dumped the#{database} #{@stage} database to #{relative_destination}."
 
       destination_path

data/lib/geordi/util.rb

@@ -119,6 +119,21 @@ module Geordi
         end
       end
 
+      def dumple_command(environment, options)
+        compress = if options[:compress] == 'compress'
+          '--compress'
+        elsif options[:compress]
+          "--compress=#{options[:compress]}"
+        end
+
+        cmd = ['dumple']
+        cmd << environment
+        cmd << options[:database]
+        cmd << compress
+        cmd << '--for-download' if options[:for_download]
+
+        cmd.compact.join(' ')
+      end
 
       def deploy_targets
         Dir['config/deploy/*'].map do |f|
@@ -205,6 +220,7 @@ module Geordi
       def rspec_path?(path)
         %r{(^|\/)spec|_spec\.rb($|:)}.match?(path)
       end
+
     end
   end
 end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '12.5.0'.freeze
+  VERSION = '12.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 12.5.0
+  version: 12.6.0
 platform: ruby
 authors:
 - Henning Koch