capistrano-pg 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor/ruby

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-pg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Tkalin
+
+MIT License
+
+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.md

@@ -0,0 +1,144 @@
+# Capistrano-Pg
+
+Capistrano tasks for basic configuration and management of PostgreSQL database.
+
+Provides capistrano tasks to:
+
+* create database.yml in `shared` folder and symlink into `config`
+* create user and database in postgres
+
+Provides several capistrano variables for easy customization.
+Also, for full customization, template of `database.yml` file can be copied to
+the application using generator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-pg', require: false, group: :development
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-pg
+
+## Usage
+
+Add this line to your `deploy.rb`
+
+    require 'capistrano-pg'
+
+Next, add role `pg` to the server which has running instance of PostgreSQL.
+Address of this server will be automatically used as `pg_host` (see below),
+`create_user` and `create_database` tasks will be executed on this server:
+
+```ruby
+# for dedicated database server it could look like this:
+server "192.168.33.12", :db, :pg, no_release: true
+
+# for all-in-one server it could look like this:
+server "192.168.33.11", :web, :app, :db, :pg, primary: true
+```
+
+Note, that following capistrano variables should be defined in the `deploy.rb` file:
+
+    application
+    current_path
+    shared_path
+    user
+
+You can check that new tasks are available (`cap -T`):
+
+    # create database user for the application
+    cap pg:create_user
+
+    # create database for the application
+    cap pg:create_database
+
+    # generates `database.yml` file in the `shared/config` folder
+    cap pg:setup
+
+    # symlinks `database.yml` from the `shared/config` folder to `current/config` folder
+    cap pg:symlink
+
+There is no need to execute any of these tasks manually.
+They will be called automatically on different deploy stages:
+
+* `pg:create_user`, `pg:create_database` and `pg:setup` are hooked to `deploy:setup`
+* `pg:symlink` is hooked to `deploy:finalize_update`
+
+This means that if you run `cap deploy:setup`,
+user and database will be created and `database.yml` file will be generated.
+And on each deploy, `database.yml` will be automatically linked to current version.
+
+However, if you changed variables or customized templates,
+you can run any of these tasks to update configuration.
+
+## Customization
+
+### Using variables
+
+You can customize `database.yml` using capistrano variables:
+
+```ruby
+# path to customized templates (see below for details)
+# default value: "config/deploy/templates"
+set :templates_path, "config/deploy/templates"
+
+# `host` value in `database.yml`
+# default value: address of the server, marked with `pg` role
+set :pg_host, "localhost"
+
+# `port` value in `database.yml`
+# default value: 5432
+set :pg_port, "5432"
+
+# `database` value in `database.yml`
+# default value: application variable value
+set :pg_database, "myapp_production"
+
+# `pool` value in `database.yml`
+# default value: 5
+set :pg_pool, "5"
+
+# `username` value in `database.yml`
+# default value: application variable value
+set :pg_user, application
+
+# `password` value in `database.yml`
+# default value: will be asked if not set
+# setting this value in config file is not recommended
+set :pg_password, application
+
+# indicates, it new database should be created on `deploy:setup` or not
+# default value: true
+set :pg_create_db, true
+```
+
+### Template Customization
+
+If you want to change default template, you can generate it using `rails generator`
+
+    rails g capistrano:pg:config
+
+This will copy default template to `config/deploy/templates` directory,
+so you can customize them as you like, and capistrano tasks will use this templates instead of default.
+
+You can also provide path, where to generate template:
+
+    rails g capistrano:nginx_unicorn:config config/templates
+
+# TODO:
+
+* add tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-pg.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/pg/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-pg"
+  gem.version       = Capistrano::Pg::VERSION
+  gem.authors       = ["Ivan Tkalin"]
+  gem.email         = ["itkalin@gmail.com"]
+  gem.description   = %q{Deprecated! Capistrano tasks for basic configuration and management of PostgreSQL database. Allows to create user/database and generate and symlink database.yml}
+  gem.summary       = %q{Deprecated! Manage PostgreSQL and database.yml from capistrano}
+  gem.homepage      = "https://github.com/ivalkeen/capistrano-pg"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '>= 2.0'
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano-pg.rb

@@ -0,0 +1,2 @@
+require "capistrano/pg/version"
+require "capistrano/pg/tasks"

data/lib/capistrano/pg/tasks.rb

@@ -0,0 +1,60 @@
+require 'capistrano'
+
+Capistrano::Configuration.instance.load do
+  set_default(:templates_path, "config/deploy/templates")
+
+  set_default(:pg_host) { find_servers(roles: :pg)[0] || "localhost" }
+  set_default(:pg_port, "5432")
+  set_default(:pg_database, application)
+  set_default(:pg_pool, 5)
+  set_default(:pg_user, application)
+  set_default(:pg_password) { Capistrano::CLI.password_prompt "PG password: " }
+  set_default(:pg_create_db, true)
+
+  namespace :pg do
+    desc "Create user for application"
+    task :create_user, roles: :pg do
+      pg_params = "-p #{pg_port}"
+      check_user = %Q[#{sudo} -u postgres psql #{pg_params} postgres -c "select * from pg_user where usename='#{pg_user}'" | grep -c '#{pg_user}']
+      add_user = %Q[#{sudo} -u postgres psql #{pg_params} -c "create user #{pg_user}"]
+      run "#{check_user} || #{add_user}"
+      run %Q{#{sudo} -u postgres psql #{pg_params} -c "alter user #{pg_user} with password '#{pg_password}'" }
+    end
+
+    desc "Create database for application"
+    task :create_database, roles: :pg do
+      if pg_create_db
+        run %Q{#{sudo} -u postgres psql -c "create database #{pg_database} owner #{pg_user};"}
+      end
+    end
+
+    if find_servers(roles: :pg).size > 0
+      after "deploy:setup", "pg:create_user"
+      after "deploy:setup", "pg:create_database"
+    end
+
+    desc "Generate the database.yml configuration file."
+    task :setup, roles: :app do
+      run "mkdir -p #{shared_path}/config"
+      template "database.yml.erb", "#{shared_path}/config/database.yml"
+    end
+
+    after "deploy:setup", "pg:setup"
+
+    desc "Symlink the database.yml file into latest release"
+    task :symlink, roles: :app do
+      run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+
+    after "deploy:finalize_update", "pg:symlink"
+
+    def template(template_name, target)
+      config_file = "#{templates_path}/#{template_name}"
+      # if no customized file, proceed with default
+      unless File.exists?(config_file)
+        config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/pg/templates/#{template_name}")
+      end
+      put ERB.new(File.read(config_file)).result(binding), target
+    end
+  end
+end

data/lib/capistrano/pg/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Pg
+    VERSION = "0.0.2"
+  end
+end

data/lib/generators/capistrano/pg/USAGE

@@ -0,0 +1,9 @@
+To create local database.yml.erb configuration file call
+
+    rails generate capistrano:pg:config [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate capistrano:pg:config "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/pg/config_generator.rb

@@ -0,0 +1,17 @@
+module Capistrano
+  module Pg
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local database.yml.erb configuration files for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, :type => :string,
+          :default => "config/deploy/templates",
+          :banner => "path to templates"
+
+        def copy_template
+          copy_file "database.yml.erb", "#{templates_path}/database.yml.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/pg/templates/database.yml.erb

@@ -0,0 +1,8 @@
+production:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= pg_database %>
+  pool: <%= pg_pool %>
+  username: <%= pg_user %>
+  password: <%= pg_password %>
+  host: <%= pg_host %>

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-pg
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Tkalin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: capistrano
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+description: Deprecated! Capistrano tasks for basic configuration and management of
+  PostgreSQL database. Allows to create user/database and generate and symlink database.yml
+email:
+- itkalin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-pg.gemspec
+- lib/capistrano-pg.rb
+- lib/capistrano/pg/tasks.rb
+- lib/capistrano/pg/version.rb
+- lib/generators/capistrano/pg/USAGE
+- lib/generators/capistrano/pg/config_generator.rb
+- lib/generators/capistrano/pg/templates/database.yml.erb
+homepage: https://github.com/ivalkeen/capistrano-pg
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3226214497165467807
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3226214497165467807
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Deprecated! Manage PostgreSQL and database.yml from capistrano
+test_files: []