cap_db_dump 1.2.2 → 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 010ed3cf256f446566acc86e8cbf49aa2d4965ea5f0a057dd436c4f41c53dea0
+  data.tar.gz: 40adc98e605ef94aee244c90ad859bfc01551dc8f6c62a95a1335455e8851c6b
+SHA512:
+  metadata.gz: 39ac68fc4e29e92b771ed8ccdb2cda3efe517d2b0b99d91db9bbe0b59034bec653334954e93e9098ff4ebd977419596c52b39e63af510dfa37124dc78028e53b
+  data.tar.gz: 8b48771c21890446cc650b1e1bd33e82390ec25933ef08c85fba01fff043a20d0b3793e9ef3638631866e137f28734f8ec22b8f7501d483d547543e30fd159e7

data/lib/cap_db_dump/recipes.rb

@@ -1,9 +1,17 @@
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :database do
+    DATABASE_ENGINES = [
+      MYSQL = :mysql,
+      POSTGRES = :psql,
+    ]
+
     # a list of tables for which only the schema, but no data should be dumped.
     set :schema_only_tables, []
     set :dump_root_path,     "/tmp"
     set :formatted_time,     Time.now.utc.strftime("%Y-%m-%d-%H:%M:%S")
+    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
 
     module CapDbDumpHelpers
       def dump_path
@@ -30,6 +38,10 @@ Capistrano::Configuration.instance(:must_exist).load do
         database_yml_in_env["password"]
       end
 
+      def database_port
+        database_yml_in_env["port"]
+      end
+
       def database_yml_in_env
         database_yml[rails_env]
       end
@@ -47,29 +59,86 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     task :read_db_yml, tasks_matching_for_db_dump do
       @database_yml ||= begin
-        yaml = capture("cat #{shared_path}/config/database.yml")
-        YAML.load(yaml)
+        if dry_run
+          raise "Cannot be run in dry_run mode!"
+        end
+
+        yaml = capture("cat #{current_path}/config/database.yml")
+        YAML.safe_load(yaml, aliases: true)
       end
     end
 
-    def password_field
-      database_password && database_password.length > 0 ? "-p#{database_password}" : ""
+    def database_password?
+      database_password && !database_password.to_s.empty?
     end
 
-    task :create_dump, tasks_matching_for_db_dump do
-      ignored_tables = schema_only_tables.map { |table_name|
-        "--ignore-table=#{database_name}.#{table_name}"
-      }
+    # --defaults-extra-file must be the first option given to mysqldump
+    def mysql_password_field
+      database_password? ? "--defaults-extra-file=/dev/stdin" : ""
+    end
 
-      ignored_tables = ignored_tables.join(" ")
+    def mysql_password_stdin
+      escaped_password = database_password.to_s.gsub("\\") { "\\\\" }
+      "[client]\npassword=\"#{escaped_password}\"\n"
+    end
+
+    def postgres_port
+      database_port ? "-p #{database_port}" : ""
+    end
 
-      command = "mysqldump -u #{database_username} -h #{database_host} #{password_field} -Q "
-      command << "--add-drop-table -O add-locks=FALSE --lock-tables=FALSE --single-transaction "
-      command << "#{ignored_tables} #{database_name} > #{dump_path}"
+    def pg_password
+      database_password? ? "IFS= read -r PGPASSWORD && export PGPASSWORD &&" : ""
+    end
+
+    def pg_password_stdin
+      "#{database_password}\n"
+    end
+
+    # A pty would echo the password on stdin back into the (logged) output.
+    def run_with_password(command, stdin_data)
+      if database_password?
+        run command, :data => stdin_data, :eof => true, :pty => false
+      else
+        run command
+      end
+    end
+
+    def pg_port
+      database_port && !database_port.empty? ? "-p #{database_port}" : ""
+    end
+
+    task :create_dump, tasks_matching_for_db_dump do
+      if database_engine == MYSQL
+        ignored_tables = schema_only_tables.map { |table_name|
+          "--ignore-table=#{database_name}.#{table_name}"
+        }
+
+        ignored_tables = ignored_tables.join(" ")
+
+        command = "mysqldump #{mysql_password_field} -u #{database_username} -h #{database_host} -Q "
+        command << "--add-drop-table -O add-locks=FALSE --lock-tables=FALSE --single-transaction "
+        command << "#{ignored_tables} #{database_name} > #{dump_path}"
+        password_stdin = mysql_password_stdin
+      elsif database_engine == POSTGRES
+        ignored_tables = schema_only_tables.map { |table_name|
+          "--exclude-table=#{database_name}.#{table_name}"
+        }
+
+        ignored_tables = ignored_tables.join(" ")
+
+        command = "#{pg_password} pg_dump -U #{database_username} -h #{database_host} #{postgres_port} "
+        if pg_dump_format
+          command << "-F#{pg_dump_format} "
+        end
+        command << "#{ignored_tables} #{database_name} > #{dump_path}"
+        password_stdin = pg_password_stdin
+      else
+        raise "Unknown database engine. use one of: #{DATABASE_ENGINES.inspect}"
+      end
 
       give_description "About to dump production DB"
 
-      run command
+      run_with_password command, password_stdin
       dump_schema_tables if schema_only_tables.any?
     end
 
@@ -77,11 +146,17 @@ Capistrano::Configuration.instance(:must_exist).load do
       if schema_only_tables.any?
         table_names = schema_only_tables.join(" ")
 
-        command = "mysqldump -u #{database_username} -h #{database_host} #{password_field} "
-        command << "-Q --add-drop-table --single-transaction --no-data #{database_name} #{table_names} >> #{dump_path}"
+        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}"
+        elsif database_engine == POSTGRES
+          raise "not yet supported. PR's welcome! (https://github.com/smtlaissezfaire/cap_db_dump)"
+        else
+          raise "Unknown database engine. use one of: #{DATABASE_ENGINES.inspect}"
+        end
 
         give_description "Dumping schema for tables: #{schema_only_tables.join(", ")}"
-        run command
+        run_with_password command, mysql_password_stdin
       end
     end
 
@@ -102,8 +177,14 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     task :transfer, tasks_matching_for_db_dump do
+      # TODO: should look in /tmp for latest file
       give_description "Grabbing the dump"
-      download("#{dump_path}.gz", ".", :via => :scp)
+      gzip_file = "#{dump_path}.gz"
+      download(gzip_file, ".", :via => :scp)
+
+      give_description "Symlinking locally"
+      base_name = File.basename(gzip_file)
+      `ln -sf #{base_name} current.sql.gz`
     end
   end
 end

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: cap_db_dump
 version: !ruby/object:Gem::Version
-  version: 1.2.2
-  prerelease: 
+  version: 1.3.1
 platform: ruby
 authors:
 - Scott Taylor
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
-dependencies: []
+date: 2026-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.10
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.3
 description: Capistrano tasks for dumping your mysql database + transfering to your
   local machine
 email: scott@railsnewbie.com
@@ -21,26 +48,24 @@ files:
 - lib/cap_db_dump/recipes.rb
 homepage: https://github.com/smtlaissezfaire/cap_db_dump
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
 summary: cap_db_dump
 test_files: []