cap_db_dump 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010ed3cf256f446566acc86e8cbf49aa2d4965ea5f0a057dd436c4f41c53dea0
-  data.tar.gz: 40adc98e605ef94aee244c90ad859bfc01551dc8f6c62a95a1335455e8851c6b
+  metadata.gz: 822af40344c861597562ff8fdb51b7ad8af1ed30f34851220cd24441c16d9dc4
+  data.tar.gz: 6dab1976b58d667552c715de402cc5cfe6ea832e442e88ece57325a93e21283f
 SHA512:
-  metadata.gz: 39ac68fc4e29e92b771ed8ccdb2cda3efe517d2b0b99d91db9bbe0b59034bec653334954e93e9098ff4ebd977419596c52b39e63af510dfa37124dc78028e53b
-  data.tar.gz: 8b48771c21890446cc650b1e1bd33e82390ec25933ef08c85fba01fff043a20d0b3793e9ef3638631866e137f28734f8ec22b8f7501d483d547543e30fd159e7
+  metadata.gz: 28e621ce4e25b43097096957c9203eecc76971477026a351339d7a027e678bed39ecbe649ef43f96a35892faf86bbc8b5f9bb99c10d93659fcb532bc96e8f7dc
+  data.tar.gz: 024ab1acf0daf35d58b2564fbedba76d102a702a9d7ffe7f86adc77968cbee0dd8ecd2f20e206d6c75fe98341c3eda0be3ccab6466dbb9b4353cf7e00707b673

data/lib/cap_db_dump/recipes.rb

@@ -1,3 +1,6 @@
+require "json"
+require "yaml"
+
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :database do
     DATABASE_ENGINES = [
@@ -12,6 +15,9 @@ Capistrano::Configuration.instance(:must_exist).load do
     set :database_engine, :mysql # specify :mysql | :psql
     # https://www.postgresql.org/docs/12/app-pgdump.html
     set :pg_dump_format, :c # specify c: 'compressed' (aka -Fc), :d 'directory', or set to nil for plain text
+    # :yaml reads config/database.yml as plain YAML, :rails asks `rails runner` on the server for the
+    # resolved config, and :auto uses :yaml unless database.yml contains ERB.
+    set :database_config_source, :auto
 
     module CapDbDumpHelpers
       def dump_path
@@ -50,6 +56,32 @@ Capistrano::Configuration.instance(:must_exist).load do
         @database_yml ||= read_db_yml
       end
 
+      def database_yml_path
+        "#{current_path}/config/database.yml"
+      end
+
+      def database_config_from_yaml(yaml)
+        YAML.safe_load(yaml, aliases: true)
+      end
+
+      # rvm-capistrano wraps commands in `rvm-shell '...' -c '...'`, so this must not contain single quotes.
+      def rails_runner_database_config_command
+        ruby = "puts :CAP_DB_DUMP_CONFIG_BEGIN, ActiveRecord::Base.connection_db_config.configuration_hash.to_json, :CAP_DB_DUMP_CONFIG_END"
+        "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec rails runner \"#{ruby}\""
+      end
+
+      # No pty, so stderr stays out of the captured output and the output (which has the password) isn't echoed.
+      def database_config_from_rails
+        output = capture(rails_runner_database_config_command, :pty => false)
+        json = output[/CAP_DB_DUMP_CONFIG_BEGIN\s*(\{.*?\})\s*CAP_DB_DUMP_CONFIG_END/m, 1]
+
+        unless json
+          raise "Could not find the database config in the output of rails runner"
+        end
+
+        { rails_env.to_s => JSON.parse(json) }
+      end
+
       def tasks_matching_for_db_dump
         { :only => { :db_dump => true } }
       end
@@ -63,8 +95,17 @@ Capistrano::Configuration.instance(:must_exist).load do
           raise "Cannot be run in dry_run mode!"
         end
 
-        yaml = capture("cat #{current_path}/config/database.yml")
-        YAML.safe_load(yaml, aliases: true)
+        case database_config_source.to_sym
+        when :yaml
+          database_config_from_yaml(capture("cat #{database_yml_path}"))
+        when :rails
+          database_config_from_rails
+        when :auto
+          yaml = capture("cat #{database_yml_path}")
+          yaml.include?("<%") ? database_config_from_rails : database_config_from_yaml(yaml)
+        else
+          raise "Unknown database_config_source. use one of: [:yaml, :rails, :auto]"
+        end
       end
     end
 
@@ -82,8 +123,12 @@ Capistrano::Configuration.instance(:must_exist).load do
       "[client]\npassword=\"#{escaped_password}\"\n"
     end
 
+    def database_port?
+      database_port && !database_port.to_s.strip.empty?
+    end
+
     def postgres_port
-      database_port ? "-p #{database_port}" : ""
+      database_port? ? "-p #{database_port}" : ""
     end
 
     def pg_password
@@ -104,7 +149,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     def pg_port
-      database_port && !database_port.empty? ? "-p #{database_port}" : ""
+      database_port? ? "-p #{database_port}" : ""
     end
 
     task :create_dump, tasks_matching_for_db_dump do
@@ -121,7 +166,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         password_stdin = mysql_password_stdin
       elsif database_engine == POSTGRES
         ignored_tables = schema_only_tables.map { |table_name|
-          "--exclude-table=#{database_name}.#{table_name}"
+          "--exclude-table-data=#{table_name}"
         }
 
         ignored_tables = ignored_tables.join(" ")
@@ -149,14 +194,14 @@ Capistrano::Configuration.instance(:must_exist).load do
         if database_engine == MYSQL
           command = "mysqldump #{mysql_password_field} -u #{database_username} -h #{database_host} "
           command << "-Q --add-drop-table --single-transaction --no-data #{database_name} #{table_names} >> #{dump_path}"
+
+          give_description "Dumping schema for tables: #{schema_only_tables.join(", ")}"
+          run_with_password command, mysql_password_stdin
         elsif database_engine == POSTGRES
-          raise "not yet supported. PR's welcome! (https://github.com/smtlaissezfaire/cap_db_dump)"
+          # pg_dump --exclude-table-data in create_dump already keeps the schema for these tables
         else
           raise "Unknown database engine. use one of: #{DATABASE_ENGINES.inspect}"
         end
-
-        give_description "Dumping schema for tables: #{schema_only_tables.join(", ")}"
-        run_with_password command, mysql_password_stdin
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cap_db_dump
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Scott Taylor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-03 00:00:00.000000000 Z
+date: 2026-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: cap_db_dump