cap_db_dump 1.2.1 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b17670872f50b5f6e4ced82d27850b86d69f5f544c16ffd2255f9be0550d0f5
+  data.tar.gz: 95a520425a6edf34da30890fb9cc898fac58b20c9ba5c152b6ca0e7dd7fe89ec
+SHA512:
+  metadata.gz: 4e9a93f1adcbbf42ceeff9f4da05913f2df61ca31be12afa6c42fb44dd0334258f633cc0ce3f7cf91ad5938668b0031ea27df22962f8f9bafc4874983e7208ba
+  data.tar.gz: a990d7fc1d50cf589c1d0b0af8be81aa238f6c1e75a7f55855d28170213a3f9357aebcd63fbd248a2988fa5ba5afe8e038aa5d2edfcaa362adb2270fec6cddd9

data/lib/cap_db_dump/recipes.rb

@@ -0,0 +1,167 @@
+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
+        "#{dump_root_path}/#{database_name}_dump_#{formatted_time}.sql"
+      end
+
+      def give_description(desc_string)
+        puts "  ** #{desc_string}"
+      end
+
+      def database_name
+        database_yml_in_env["database"]
+      end
+
+      def database_username
+        database_yml_in_env["username"]
+      end
+
+      def database_host
+        database_yml_in_env["host"] || "localhost"
+      end
+
+      def database_password
+        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
+
+      def database_yml
+        @database_yml ||= read_db_yml
+      end
+
+      def tasks_matching_for_db_dump
+        { :only => { :db_dump => true } }
+      end
+    end
+
+    extend CapDbDumpHelpers
+
+    task :read_db_yml, tasks_matching_for_db_dump do
+      @database_yml ||= begin
+        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 mysql_password_field
+      database_password && database_password.length > 0 ? "-p#{database_password}" : ""
+    end
+
+    def postgres_port
+      database_port ? "-p #{database_port}" : ""
+    end
+
+    def pg_password
+      database_password && !database_password.empty? ?
+        "PGPASSWORD=#{database_password}" :
+        ""
+    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 -u #{database_username} -h #{database_host} #{mysql_password_field} -Q "
+        command << "--add-drop-table -O add-locks=FALSE --lock-tables=FALSE --single-transaction "
+        command << "#{ignored_tables} #{database_name} > #{dump_path}"
+      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}"
+      else
+        raise "Unknown database engine. use one of: #{DATABASE_ENGINES.inspect}"
+      end
+
+      give_description "About to dump production DB"
+
+      run command
+      dump_schema_tables if schema_only_tables.any?
+    end
+
+    task :dump_schema_tables, tasks_matching_for_db_dump do
+      if schema_only_tables.any?
+        table_names = schema_only_tables.join(" ")
+
+        if database_engine == MYSQL
+          command = "mysqldump -u #{database_username} -h #{database_host} #{mysql_password_field} "
+          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
+      end
+    end
+
+    desc "Create a dump of the production database"
+    task :dump, tasks_matching_for_db_dump do
+      create_dump
+
+      cmd = "gzip -9 #{dump_path}"
+
+      give_description "Gzip'ing the file"
+      run cmd
+    end
+
+    desc "Make a production dump, transfer it to this machine"
+    task :dump_and_transfer, tasks_matching_for_db_dump do
+      dump
+      transfer
+    end
+
+    task :transfer, tasks_matching_for_db_dump do
+      # TODO: should look in /tmp for latest file
+      give_description "Grabbing the dump"
+      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.1
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Scott Taylor
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
-dependencies: []
+date: 2024-05-24 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
@@ -18,29 +45,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/cap_db_dump.rb
+- 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: []

data/lib/cap_db_dump.rb

@@ -1,109 +0,0 @@
-Capistrano::Configuration.instance(:must_exist).load do
-  namespace :database do
-    # 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")
-
-    module CapDbDumpHelpers
-      def dump_path
-        "#{dump_root_path}/#{database_name}_dump_#{formatted_time}.sql"
-      end
-
-      def give_description(desc_string)
-        puts "  ** #{desc_string}"
-      end
-
-      def database_name
-        database_yml_in_env["database"]
-      end
-
-      def database_username
-        database_yml_in_env["username"]
-      end
-
-      def database_host
-        database_yml_in_env["host"] || "localhost"
-      end
-
-      def database_password
-        database_yml_in_env["password"]
-      end
-
-      def database_yml_in_env
-        database_yml[rails_env]
-      end
-
-      def database_yml
-        @database_yml ||= read_db_yml
-      end
-
-      def tasks_matching_for_db_dump
-        { :only => { :db_dump => true } }
-      end
-    end
-
-    extend CapDbDumpHelpers
-
-    task :read_db_yml, tasks_matching_for_db_dump do
-      @database_yml ||= begin
-        yaml = capture("cat #{shared_path}/config/database.yml")
-        YAML.load(yaml)
-      end
-    end
-
-    def password_field
-      database_password && database_password.length > 0 ? "-p#{database_password}" : ""
-    end
-
-    task :create_dump, tasks_matching_for_db_dump do
-      ignored_tables = schema_only_tables.map { |table_name|
-        "--ignore-table=#{database_name}.#{table_name}"
-      }
-
-      ignored_tables = ignored_tables.join(" ")
-
-      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}"
-
-      give_description "About to dump production DB"
-
-      run command
-      dump_schema_tables if schema_only_tables.any?
-    end
-
-    task :dump_schema_tables, tasks_matching_for_db_dump 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}"
-
-        give_description "Dumping schema for tables: #{schema_only_tables.join(", ")}"
-        run command
-      end
-    end
-
-    desc "Create a dump of the production database"
-    task :dump, tasks_matching_for_db_dump do
-      create_dump
-
-      cmd = "gzip -9 #{dump_path}"
-
-      give_description "Gzip'ing the file"
-      run cmd
-    end
-
-    desc "Make a production dump, transfer it to this machine"
-    task :dump_and_transfer, tasks_matching_for_db_dump do
-      dump
-      transfer
-    end
-
-    task :transfer, tasks_matching_for_db_dump do
-      give_description "Grabbing the dump"
-      download("#{dump_path}.gz", ".", :via => :scp)
-    end
-  end
-end