capistrano-postgresql 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64756f3cbd959704ddb49e120d669ce593817398
-  data.tar.gz: 476e3f52826affad3fbcba2beb04db05a0a30593
+  metadata.gz: 86fb4bf23488e11c1621ea0220f0f9de556bd54b
+  data.tar.gz: fb80400a70f99e7235f18e154ebe413903716f97
 SHA512:
-  metadata.gz: 43b02bb91ec6bfa9d8ed3cd59408961bf5a81f8556e02718937c5c86796411c07731a00ae509820a1a14b7c75fcfb9448034d907b2b7a58575d8c50da773ec0c
-  data.tar.gz: e6d8cb4b11369573d62faf246a4ec479c8eb78e4b7ac7e395df238b4f74d82a76fdcc20650b785fd54fea1f463c637472126a745c4e076d81954acf56d5d0f81
+  metadata.gz: 2a26868b035dc682b3a9a73c332b0837c91f8ef5738d580a20e13df409204005a9bb5ff3b347ad05183b3abeebc1128f43149bd26541bfd129aa212975956829
+  data.tar.gz: a109426f8a310440d3827c5938883e9688f2dcb9a15e10ced05ea690ad52b0a7d099aa2615b9df3a13b8f870dde89d936c68d26ba4e389727a3b59db5d3e14e9

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### v2.0.0, 2014-03-30
+- shorten variable names: postgresql -> pg
+- better helpers module separation
+- lots of code styling updates
+- lots of code improvements
+- less layered and simpler code
+- readme updates
+### v1.0.0, 2014-03-19
+- all the v1.0.0 features

data/README.md

@@ -15,30 +15,34 @@ Here are the specific things this plugin does for your capistrano deployment
 process:
 
 * creates a new PostgreSQL database and database user on the server
-* generates and populates `database.yml` file with the right data on the server
+* generates and populates `database.yml` file
   (no need to ssh to the server and do this manually!)
-* no config necessary (or it's kept to a minimum)
+* zero-config
 
 ### Installation
 
 Put the following in your application's `Gemfile`:
 
     group :development do
-      gem 'capistrano' ~> '3.1'
+      gem 'capistrano', '~> 3.1'
       gem 'capistrano-postgresql'
     end
 
-Install the gem with:
+Then:
 
     $ bundle install
 
-### Standard usage
+### Usage
 
 If you're deploying a standard rails app, all you need to do is put
 the following in `Capfile` file:
 
     require 'capistrano/postgresql'
 
+And deploy:
+
+    $ bundle exec cap production deploy
+
 Easy, right?
 
 Check below to see what happens in the background.
@@ -50,49 +54,40 @@ Check here for the full capistrano deployment flow
 
 The following tasks run automatically after `deploy:started` task:
 
+* `postgresql:create_db_user`<br/>
+creates a postgresql user. Password for the user is automatically generated and
+used in the next steps.
 * `postgresql:create_database`<br/>
-creates a postgresql user and a database for your app. Password for the user is
-automatically generated and used in the next step.
+creates database for your app.
 * `postgresql:generate_database_yml`<br/>
 creates a `database.yml` file and copies it to
 `#{shared_path}/config/database.yml` on the server.
-* `postgresql:ensure_database_yml_symlink`<br/>
-adds `config/database.yml` to the `linked_files` array. Capistrano handles
-symlinking `database.yml` to the application release path.
 
-The above tasks are all you need for getting rails app to work with PostgreSQL.
+Also, the plugin ensures `config/database.yml` is symlinked from `shared_path`.
+The above tasks are all you need for getting a Rails app to work with PostgreSQL.
 
 ### Gotchas
 
 Be sure to remove `config/database.yml` from your application's version control.
 
-### Debugging
-
-A debugging task is provided. Run `bundle exec <your_stage> cap postgres:debug`
-and you should get a list of all capistrano-postgresql settings and their
-values.
-
-I deeply hope you'll never need to use this, as this plugins strives to be
-very easy to use with minimal or no configuration.
-
 ### Configuration
 
 This plugin should just work with no configuration whatsoever. However,
 configuration is possible. Put all your configs in capistrano stage files i.e.
-`config/deploy/production.rb`, `config/deploy/staging.rb`.
+`config/deploy/production.rb`.
 
 Here's the list of options and the defaults for each option:
 
-* `set :postgresql_database`<br/>
+* `set :pg_database`<br/>
 Name of the database for your app. Defaults to `#{application}_#{stage}`,
 example: `myface_production`.
 
-* `set :postgresql_user`<br/>
-Name of the database user. Defaults to whatever is set for `postgresql_database`
+* `set :pg_user`<br/>
+Name of the database user. Defaults to whatever is set for `pg_database`
 option.
 
-* `set :postgresql_password`<br/>
-Password for the database user. By default this option is not set and
+* `set :pg_password`<br/>
+Password for the database user. By default this option is not set and a
 **new random password** is generated each time you create a new database.<br/>
 If you set this option to `"some_secure_password"` - that will be the db user's
 password. Keep in mind that having a hardcoded password in `deploy.rb` (or
@@ -101,29 +96,23 @@ I recommend sticking to the default and generating a new secure and random
 password each time a db user is generated. That way you don't have to worry
 about it or try to remember it.
 
-* `set :postgresql_ask_for_password`<br/>
+* `set :pg_ask_for_password`<br/>
 Default `false`. Set this option to `true` if you want to be prompted for the
 password when database user is created. This is safer than setting the password
-via `postgresql_password`. The downside is you have to choose and remember
+via `pg_password`. The downside is you have to choose and remember
 yet another fricking password.<br/>
-`postgresql_password` option has precedence. If it is set,
-`postgresql_ask_for_password` is ignored.
-
-* `set :postgresql_default_tasks`<br/>
-This task determines whether capistrano tasks from this plugin are executed
-automatically during capistrano deploy process. Defaults to `true`. Tasks that
-run automatically are: `postgresql:create_database`,
-`postgresql:generate_database_yml` and `postgresql:ensure_database_yml_symlink`.
+`pg_password` option has precedence. If it is set,
+`pg_ask_for_password` is ignored.
 
 `database.yml` template-only settings:
 
-* `set :postgresql_pool`<br/>
+* `set :pg_pool`<br/>
 Pool config in `database.yml` template. Defaults to `5`.
 
-* `set :postgresql_host`<br/>
+* `set :pg_host`<br/>
 `hostname` config in `database.yml` template. Defaults to `localhost`.
 
-* `set :postgresql_encoding`<br/>
+* `set :pg_encoding`<br/>
 `encoding` config in `database.yml` template. Defaults to `unicode`.
 
 ### Customizing the `database.yml` template
@@ -134,26 +123,39 @@ shared directory on the server:
 ```yml
 <%= fetch :stage %>:
   adapter: postgresql
-  encoding: <%= postgresql_encoding %>
-  database: <%= postgresql_database %>
-  pool: <%= postgresql_pool %>
-  username: <%= postgresql_user %>
-  password: '<%= postgresql_password %>'
-  host: <%= postgresql_host %>
+  encoding: <%= pg_encoding %>
+  database: <%= pg_database %>
+  pool: <%= pg_pool %>
+  username: <%= pg_user %>
+  password: '<%= pg_password %>'
+  host: <%= pg_host %>
 ```
 
 If for any reason you want to edit or tweak this template, you can copy it to
 `config/deploy/templates/postgresql.yml.erb` with this command:
 
-    bundle exec rails g capistrano:postgresql:template
+    $ bundle exec rails g capistrano:postgresql:template
 
 After you edit this newly created file in your repo, it will be used as a
 template for `database.yml` on the server.
 
 You can configure the template location. For example:
-`set :postgresql_templates_path, "config"` and the template will be copied to
+`set :pg_templates_path, "config"` and the template will be copied to
 `config/postgresql.yml.erb`.
 
+### More Capistrano automation?
+
+If you'd like to streamline your Capistrano deploys, you might want to check
+these zero-configuration, plug-n-play plugins:
+
+- [capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx)<br/>
+no-configuration unicorn and nginx setup with sensible defaults
+- [capistrano-rbenv-install](https://github.com/bruno-/capistrano-rbenv-install)<br/>
+would you like Capistrano to install rubies for you?
+- [capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)<br/>
+if you're annoyed that Capistrano does **not** create a deployment path for the
+app on the server (default `/var/www/myapp`), this is what you need!
+
 ### Contributing and bug reports
 
 Contributions and improvements are very welcome. Just open a pull request and
@@ -169,11 +171,6 @@ Here are other plugins and people this project was based upon:
 from this plugin are heavily based on his
 [capistrano-recipes repo](https://github.com/mattdbridges/capistrano-recipes).
 
-* [Kalys Osmonom](https://github.com/kalys) - his
-[capistrano-nginx-unicorn](https://github.com/kalys/capistrano-nginx-unicorn)
-gem structure was an inspiration for this plugin. A lot of the features were
-directly copied from his project (example: `database.yml` template generator).
-
 ### License
 
 [MIT](LICENSE.md)

data/lib/capistrano/postgresql/helper_methods.rb

@@ -1,79 +1,22 @@
-require 'securerandom'
 require 'erb'
 
 module Capistrano
   module Postgresql
     module HelperMethods
 
-      def database_yml_template(template_name, target)
-        config_file = "#{fetch(:postgresql_templates_path)}/#{template_name}"
+      def pg_template(template_name)
+        config_file = "#{fetch(:pg_templates_path)}/#{template_name}"
         # If there's no customized file in your rails app template directory,
         # proceed with the default.
         unless File.exists?(config_file)
-          config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/postgresql/templates/#{template_name}")
+          default_config_path = "../../generators/capistrano/postgresql/templates/#{template_name}"
+          config_file = File.join(File.dirname(__FILE__), default_config_path)
         end
-        upload! StringIO.new(ERB.new(File.read(config_file)).result(binding)), target
+        StringIO.new ERB.new(File.read(config_file)).result(binding)
       end
 
-      # This method is invoked only if `:postgresql_password` is not already set in
-      # `config/deploy.rb`. Directly setting `:postgresql_password` has precedence.
-      def ask_for_or_generate_password
-        if fetch(:postgresql_ask_for_password)
-          ask :postgresql_password, "Postgresql database password for the app: "
-        else
-          set :postgresql_password, generate_random_password
-        end
-      end
-
-      def generate_random_password
-        SecureRandom.hex(10)
-      end
-
-      def db_user_exists?(name)
-        psql "-tAc", %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{name}';" | grep -q 1}
-      end
-
-      def create_db_user(name, password)
-        if psql "-c", %Q{"CREATE user #{name} WITH password '#{password}';"}
-          info "postgresq: database user '#{name}' created"
-        else
-          error "postgresql: creating database user failed!"
-          exit 1
-        end
-      end
-
-      def ensure_db_user_created(name, password)
-        unless db_user_exists?(name)
-          create_db_user(name, password)
-        end
-      end
-
-      def database_exists?(db_name)
-        psql "-tAc", %Q{"SELECT 1 FROM pg_database WHERE datname='#{db_name}';" | grep -q 1}
-      end
-
-      def create_database(db_name, user_name)
-        if psql "-c", %Q{"CREATE database #{db_name} owner #{user_name};"}
-          info "postgresql: database '#{db_name}' created"
-        else
-          error "postgresql: creating database '#{db_name}' failed!"
-          exit 1
-        end
-      end
-
-      def ensure_database_created(db_name, user_name)
-        unless database_exists?(db_name)
-          create_database(db_name, user_name)
-        end
-      end
-
-      # returns true or false depending on the remote command exit status
-      def psql(*args)
-        test :sudo, "-u postgres psql", *args
-      end
-
-      def remote_file_exists?(path)
-        test "[ -e #{path} ]"
+      def database_yml_file
+        shared_path.join('config/database.yml')
       end
 
     end

data/lib/capistrano/postgresql/password_helpers.rb

@@ -0,0 +1,25 @@
+require 'securerandom'
+
+module Capistrano
+  module Postgresql
+    module PasswordHelpers
+
+      def generate_random_password
+        SecureRandom.hex(10)
+      end
+
+      # This method is invoked only if `:pg_password` is not already
+      # set in `config/#{:stage}/deploy.rb`. Directly setting
+      # `:pg_password` has precedence.
+      def ask_for_or_generate_password
+        if fetch(:pg_ask_for_password)
+          ask :pg_password, "Postgresql database password for the app: "
+        else
+          set :pg_password, generate_random_password
+        end
+      end
+
+    end
+  end
+end
+

data/lib/capistrano/postgresql/psql_helpers.rb

@@ -0,0 +1,21 @@
+module Capistrano
+  module Postgresql
+    module PsqlHelpers
+
+      # returns true or false depending on the remote command exit status
+      def psql(*args)
+        test :sudo, '-u postgres psql', *args
+      end
+
+      def db_user_exists?(name)
+        psql '-tAc', %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{name}';" | grep -q 1}
+      end
+
+      def database_exists?(db_name)
+        psql '-tAc', %Q{"SELECT 1 FROM pg_database WHERE datname='#{db_name}';" | grep -q 1}
+      end
+
+    end
+  end
+end
+

data/lib/capistrano/postgresql/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Postgresql
-    VERSION = "1.0.1"
+    VERSION = "2.0.0"
   end
 end

data/lib/capistrano/tasks/postgresql.rake

@@ -1,110 +1,78 @@
 require 'capistrano/postgresql/helper_methods'
+require 'capistrano/postgresql/password_helpers'
+require 'capistrano/postgresql/psql_helpers'
 
 include Capistrano::Postgresql::HelperMethods
+include Capistrano::Postgresql::PasswordHelpers
+include Capistrano::Postgresql::PsqlHelpers
 
 namespace :load do
   task :defaults do
-    set :postgresql_database,   -> { "#{fetch(:application)}_#{fetch(:stage)}" }
-    set :postgresql_user,       -> { fetch(:postgresql_database) }
-    set :postgresql_password,   -> { ask_for_or_generate_password }
-    set :postgresql_ask_for_password, false
-    set :postgresql_default_tasks,    true
-
-    # template only settings (used in postgresql.yml.erb)
-    set :postgresql_templates_path,   "config/deploy/templates"
-    set :postgresql_pool,     5
-    set :postgresql_encoding, "unicode"
-    set :postgresql_host,     "localhost"
+    set :pg_database, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :pg_user, -> { fetch(:pg_database) }
+    set :pg_ask_for_password, false
+    set :pg_password, -> { ask_for_or_generate_password }
+    # template only settings
+    set :pg_templates_path, 'config/deploy/templates'
+    set :pg_pool, 5
+    set :pg_encoding, 'unicode'
+    set :pg_host, 'localhost'
   end
 end
 
 namespace :postgresql do
 
-  desc "Print all the variables"
-  task :debug do
-    puts "postgresql_database:         #{fetch(:postgresql_database)}"
-    puts "postgresql_user:             #{fetch(:postgresql_user)}"
-    puts "postgresql_password:         #{fetch(:postgresql_password)}"
-    puts "postgresql_ask_for_password: #{fetch(:postgresql_ask_for_password)}"
-    puts "postgresql_default_tasks:    #{fetch(:postgresql_default_tasks)}"
-    puts "postgresql_pool:             #{fetch(:postgresql_pool)}"
-    puts "postgresql_encoding:         #{fetch(:postgresql_encoding)}"
-    puts "postgresql_host              #{fetch(:postgresql_host)}"
-  end
-
-  # This task never runs automatically
-  # desc "Drop a database for this application"
-  task :drop_database do
-    on roles(:db) do
-      psql "-c", %Q{"DROP database #{fetch(:postgresql_database)};"}
+  # undocumented, for a reason: drops database. Use with care!
+  task :remove_all do
+    on roles :app do
+      if test "[ -e #{database_yml_file} ]"
+        execute :rm, database_yml_file
+      end
     end
-  end
-
-  # This task never runs automatically
-  # desc "Delete database user for this application"
-  task :delete_db_user do
-    on roles(:db) do
-      psql "-c", %Q{"DROP user #{fetch(:postgresql_user)};"}
+    on roles :db do
+      psql '-c', %Q{"DROP database #{fetch(:pg_database)};"}
+      psql '-c', %Q{"DROP user #{fetch(:pg_user)};"}
     end
   end
 
-  # this task never runs automatically
-  # desc "Delete `config/database.yml` from the shared path on the server"
-  task :delete_database_yml do
-    on roles(:app) do
-      database_yml_path = shared_path.join("config/database.yml")
-      if remote_file_exists? database_yml_path
-        execute :rm, database_yml_path
+  desc 'Create DB user'
+  task :create_db_user do
+    on roles :db do
+      next if db_user_exists? fetch(:pg_user)
+      unless psql '-c', %Q{"CREATE user #{fetch(:pg_user)} WITH password '#{fetch(:pg_password)}';"}
+        error 'postgresql: creating database user failed!'
+        exit 1
       end
     end
   end
 
-  # this task never runs automatically. DANGEROUS! Destroys database on the server!
-  # desc "Removes application database, DB user and removes `database.yml` from the server"
-  task remove_all: [:drop_database, :delete_db_user, :delete_database_yml]
-
-
-  desc "Create a database for this application"
+  desc 'Create database'
   task :create_database do
-    on roles(:db) do
-      ensure_db_user_created fetch(:postgresql_user), fetch(:postgresql_password)
-      ensure_database_created fetch(:postgresql_database), fetch(:postgresql_user)
+    on roles :db do
+      next if database_exists? fetch(:pg_database)
+      unless psql '-c', %Q{"CREATE database #{fetch(:pg_database)} owner #{fetch(:pg_user)};"}
+        error 'postgresql: creating database failed!'
+        exit 1
+      end
     end
   end
 
-  desc "Generate the database.yml configuration file"
+  desc 'Generate database.yml'
   task :generate_database_yml do
-    on roles(:app) do
-      database_yml_path = shared_path.join("config/database.yml")
-      if remote_file_exists? database_yml_path
-        info "postgresql: database.yml already exists in the shared path"
-      else
-        info "postgresql: generating database.yml in shared path"
-        execute :mkdir, "-p", shared_path.join("config")
-        database_yml_template "postgresql.yml.erb", database_yml_path
-      end
+    on roles :app do
+      next if test "[ -e #{database_yml_file} ]"
+      execute :mkdir, '-pv', shared_path.join('config')
+      upload! pg_template('postgresql.yml.erb'), database_yml_file
     end
   end
 
-  desc "Adds `config/database.yml` to the linked_files array"
-  task :ensure_database_yml_symlink do
-    on roles(:app) do
-      if fetch(:linked_files).nil?
-        set :linked_files, ["config/database.yml"]
-      elsif !fetch(:linked_files).include? "config/database.yml"
-        fetch(:linked_files) << "config/database.yml"
-      end
-    end
+  task :database_yml_symlink do
+    set :linked_files, fetch(:linked_files, []).push('config/database.yml')
   end
 
-  after "deploy:started", "postgresql:started" do
-    # `postgresql_default_tasks` true by default -> capistrano-postgresql tasks
-    # run automatically on deploy
-    if fetch(:postgresql_default_tasks)
-      invoke "postgresql:create_database"
-      invoke "postgresql:generate_database_yml"
-      invoke "postgresql:ensure_database_yml_symlink"
-    end
-  end
+  after 'deploy:started', 'postgresql:create_db_user'
+  after 'deploy:started', 'postgresql:create_database'
+  after 'deploy:started', 'postgresql:generate_database_yml'
+  after 'deploy:started', 'postgresql:database_yml_symlink'
 
 end

data/lib/generators/capistrano/postgresql/templates/postgresql.yml.erb

@@ -1,8 +1,8 @@
 <%= fetch :stage %>:
   adapter: postgresql
-  encoding: <%= fetch :postgresql_encoding %>
-  database: <%= fetch :postgresql_database %>
-  pool: <%= fetch :postgresql_pool %>
-  username: <%= fetch :postgresql_user %>
-  password: '<%= fetch :postgresql_password %>'
-  host: <%= fetch :postgresql_host %>
+  encoding: <%= fetch :pg_encoding %>
+  database: <%= fetch :pg_database %>
+  pool: <%= fetch :pg_pool %>
+  username: <%= fetch :pg_user %>
+  password: '<%= fetch :pg_password %>'
+  host: <%= fetch :pg_host %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-postgresql
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Bruno Sutic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -49,6 +49,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -57,6 +58,8 @@ files:
 - lib/capistrano-postgresql.rb
 - lib/capistrano/postgresql.rb
 - lib/capistrano/postgresql/helper_methods.rb
+- lib/capistrano/postgresql/password_helpers.rb
+- lib/capistrano/postgresql/psql_helpers.rb
 - lib/capistrano/postgresql/version.rb
 - lib/capistrano/tasks/postgresql.rake
 - lib/generators/capistrano/postgresql/README.md