dbdump_command 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Will Bryant, Sekuda Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,25 @@
+DbdumpCommand
+=============
+
+This plugin adds a script/dbdump command which dumps your Rails database out.
+
+This master branch supports Rails 3.0.  For Rails 2.3, use the rails_2_3 branch.
+
+Like script/dbconsole, it takes your database connection details from
+config/database.yml, and supports mysql, postgresql, and sqlite.
+
+It takes the same options as script/dbconsole, ie. -p to supply the password
+to your dump program for mysql and postgresql.   (Note that for mysql, this
+means that the password is visible when other users on the system run 'ps'.
+Postgresql does not have this problem as it uses an environment variable set
+in ENV before execing and so not visible in ps.)
+
+
+Example
+=======
+
+RAILS_ENV=production script/dbdump -p >mysite_production_`date +%Y-%m-%d`
+  - dumps your production database to a file named like mysite_production_2009-01-27.
+
+
+Copyright (c) 2009-2011 Will Bryant, Sekuda Ltd, released under the MIT license

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake'

data/bin/dbdump

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'config/boot'
+require 'config/application'
+require File.expand_path('../../lib/commands/dbdump',  __FILE__)
+Rails::DBDump.start(Rails.application)

data/dbdump_command.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dbdump_command/version', __FILE__)
+
+spec = Gem::Specification.new do |gem|
+  gem.name         = 'dbdump_command'
+  gem.version      = DbdumpCommand::VERSION
+  gem.summary      = "Adds support for displaying your ActiveRecord tables, named scopes, collections, or plain arrays in a table view when working in script/console, shell, or email template."
+  gem.description  = <<-EOF
+This plugin adds a dbdump command which dumps your Rails database out.
+
+This master branch supports Rails 3.0 and above, as a gem command.
+For Rails 2.3, use the rails_2_3 branch from github and install as a plugin.
+
+Like rails dbconsole, it takes your database connection details from
+config/database.yml, and supports mysql, mysql2, postgresql, and sqlite.
+
+It takes the same options as rails dbconsole, ie. -p to supply the password
+to your dump program for mysql and postgresql.   (Note that for mysql, this
+means that the password is visible when other users on the system run 'ps'.
+Postgresql does not have this problem as it uses an environment variable set
+in ENV before execing and so not visible in ps.)
+EOF
+  gem.has_rdoc     = false
+  gem.author       = "Will Bryant"
+  gem.email        = "will.bryant@gmail.com"
+  gem.homepage     = "http://github.com/willbryant/dbdump_command"
+  
+  gem.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files        = `git ls-files`.split("\n")
+  gem.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_path = "lib"
+
+  gem.add_dependency 'activerecord'  
+  gem.add_development_dependency "rake"
+end

data/install.rb

@@ -0,0 +1,5 @@
+require 'fileutils'
+FileUtils.cp(
+  File.join(File.dirname(__FILE__), "bin", "dbdump"),
+  File.join(Rails.root, "script", "dbdump"),
+  :preserve => true) # copy +x

data/lib/commands/dbdump.rb

@@ -0,0 +1,104 @@
+require 'erb'
+require 'yaml'
+require 'optparse'
+
+module Rails
+  class DBDump
+    def self.start(app)
+      new(app).start
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def start
+      include_password = false
+      options = {}
+      OptionParser.new do |opt|
+        opt.banner = "Usage: dbdump [options] [environment]"
+        opt.on("-p", "--include-password", "Automatically provide the password from database.yml") do |v|
+          include_password = true
+        end
+
+        opt.parse!(ARGV)
+        abort opt.to_s unless (0..1).include?(ARGV.size)
+      end
+
+      unless config = YAML::load(ERB.new(IO.read("#{@app.root}/config/database.yml")).result)[Rails.env]
+        abort "No database is configured for the environment '#{Rails.env}'"
+      end
+
+
+      def find_cmd(*commands)
+        dirs_on_path = ENV['PATH'].to_s.split(File::PATH_SEPARATOR)
+        commands += commands.map{|cmd| "#{cmd}.exe"} if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+
+        full_path_command = nil
+        found = commands.detect do |cmd|
+          dir = dirs_on_path.detect do |path|
+            full_path_command = File.join(path, cmd)
+            File.executable? full_path_command
+          end
+        end
+        found ? full_path_command : abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
+      end
+
+      case config["adapter"]
+      when /^mysql/
+        args = {
+          'host'      => '--host',
+          'port'      => '--port',
+          'socket'    => '--socket',
+          'username'  => '--user',
+          'encoding'  => '--default-character-set'
+        }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact
+
+        if config['password'] && include_password
+          args << "--password=#{config['password']}"
+        elsif config['password'] && !config['password'].to_s.empty?
+          args << "-p"
+        end
+
+        args << config['database']
+
+        exec(find_cmd('mysqldump', 'mysql5dump'), "--single-transaction", *args)
+
+      when "postgresql"
+        ENV['PGUSER']     = config["username"] if config["username"]
+        ENV['PGHOST']     = config["host"] if config["host"]
+        ENV['PGPORT']     = config["port"].to_s if config["port"]
+        ENV['PGPASSWORD'] = config["password"].to_s if config["password"] && include_password
+        
+        args = {
+          'encoding'  => '--encoding'
+        }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact
+        
+        args << config["database"]
+        
+        exec(find_cmd('pg_dump'), *args)
+
+      when "sqlite"
+        exec(find_cmd('sqlite'), config["database"], ".dump")
+
+      when "sqlite3"
+        args = []
+
+        args << "-#{options['mode']}" if options['mode']
+        args << "-header" if options['header']
+        args << config['database']
+        args << ".dump"
+
+        exec(find_cmd('sqlite3'), *args)
+
+      else
+        abort "Unknown command-line dump client for #{config['database']}. Submit a dbdump patch to add support!"
+      end
+    end
+  end
+end
+
+# Has to set the RAILS_ENV before config/application is required
+if ARGV.first && !ARGV.first.index("-") && env = ARGV.first
+  ENV['RAILS_ENV'] = %w(production development test).find { |e| e.index(env) } || env
+end

data/lib/dbdump_command/version.rb

@@ -0,0 +1,3 @@
+module DbdumpCommand
+  VERSION = '0.2.0'
+end

data/uninstall.rb

@@ -0,0 +1,2 @@
+require 'fileutils'
+FileUtils.rm(File.join(Rails.root, "script", "dbdump"))

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: dbdump_command
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Will Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: |
+  This plugin adds a dbdump command which dumps your Rails database out.
+  
+  This master branch supports Rails 3.0 and above, as a gem command.
+  For Rails 2.3, use the rails_2_3 branch from github and install as a plugin.
+  
+  Like rails dbconsole, it takes your database connection details from
+  config/database.yml, and supports mysql, mysql2, postgresql, and sqlite.
+  
+  It takes the same options as rails dbconsole, ie. -p to supply the password
+  to your dump program for mysql and postgresql.   (Note that for mysql, this
+  means that the password is visible when other users on the system run 'ps'.
+  Postgresql does not have this problem as it uses an environment variable set
+  in ENV before execing and so not visible in ps.)
+
+email: will.bryant@gmail.com
+executables: 
+- dbdump
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- bin/dbdump
+- dbdump_command.gemspec
+- install.rb
+- lib/commands/dbdump.rb
+- lib/dbdump_command/version.rb
+- uninstall.rb
+homepage: http://github.com/willbryant/dbdump_command
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Adds support for displaying your ActiveRecord tables, named scopes, collections, or plain arrays in a table view when working in script/console, shell, or email template.
+test_files: []
+