capistrano_deploy_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5296a9e851a433d01a7e542984686eb8db26911
+  data.tar.gz: 302833b411128ef298cf610a0aac7dab1327f5a0
+SHA512:
+  metadata.gz: c2ab914b531755ec048c1850e4e73c0e030b575ce2f3e40904758fa7947d24ed1401fcdd0f00db1740a016b11a934144958c2eb4dea90694f478be72169801b2
+  data.tar.gz: d5fb56e26d538f2e5692c7c33cb9b0a763a00572828e4b57b11dbb0d641e6b02c866e526afba8468b747cce0313930a2bca803d0c5f978665a5059e1add6c7d1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dmytro Kovalov
+
+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,80 @@
+# CapistranoDeployGenerator
+
+Generate deployment configuration to be used with Capistrano.
+    
+Following options are supported:
+
+* capify - simply run `capify .` command in project 
+* deploy - Create config/deploy.rb file and config/deploy directory subtree with required componenets for capistrano.
+* modules - Install supporting Git repositories as submodules.
+
+
+Example:
+    rails generate capistrano_deploy deploy
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano_deploy_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano_deploy_generator
+
+## Usage
+
+Run to get help:
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~bash
+rails generate capistrano_deploy 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+### Submodules
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~bash
+rails generate capistrano_deploy modules
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This command will install github repositories used in the cap deploy. These repositories are installed in `./config/deploy/` subdirectory. 
+
+Following submodules are configured for installation:
+
+* recipes: `git@github.com:dmytro/capistrano-recipes.git` Collection of recipes for Capistrano deployment. Each of the recipe needs to be added to `deploy.rb` file. 
+* chef-solo: `git@github.com:dmytro/chef-solo.git` Some of the recipes use Chef-solo configuration to install packages. Also Chef-solo can be used to bootstrap server before deploying. This repository implements chef-solo integration.
+
+
+### Deploy
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~bash
+rails generate capistrano_deploy deploy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generator for the `deploy.rb` file. Generator uses menu system to create the file. It will guide user throught the set of basic questions and build the file bsed on the user answers.
+
+## 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
+
+# Author
+
+Dmytro Kovalov
+
+dmytro.kovalov@gmail.com
+
+http://dmytro.github.com
+
+May, 2013
+
+# License
+
+MIT, see LICENSE.txt file

data/Rakefile

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

data/capistrano_deploy_generator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generators/capistrano_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano_deploy_generator"
+  spec.version       = CapistranoDeployGenerator::VERSION
+  spec.authors       = ["Dmytro Kovalov"]
+  spec.email         = ["dmytro.kovalov@gmail.com"]
+  spec.description   = %q{Create config/deploy.rb file and config/deploy directory subtree with required componenets for capistrano. Install support Git repositories as submodules.}
+  spec.summary       = %q{Generate deployment configuration to be used with Capistrano.}
+  spec.homepage      = "http://dmytro.github.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "rails", "~> 3.2.13"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/generators/capistrano_deploy/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Generate deployment configuration to be used with Capistrano.
+
+    Following options are supported:
+    
+    * capify - install Capfile
+    
+    * deploy - Create config/deploy.rb file and config/deploy
+      directory subtree with required componenets for capistrano.
+
+    * modules - Install supporting Git repositories as submodules.
+
+    * all - all of the above.
+
+Example:
+    rails generate capistrano_deploy deploy

data/lib/generators/capistrano_deploy/capistrano_deploy_generator.rb

@@ -0,0 +1,169 @@
+require 'rails/generators'
+require_relative "config"
+require_relative "lib/helpers"
+require_relative "lib/core_extensions"
+
+class CapistranoDeployGenerator < Rails::Generators::NamedBase  
+  source_root File.expand_path('../templates', __FILE__)
+
+  def runner
+    case file_name.to_sym
+    when :capify  then capify
+    when :modules then install_submodules
+    when :deploy  then create_deploy
+    when :all
+      capify
+      install_submodules 
+      create_deploy
+    end
+  end
+
+  private
+
+  def capify
+    template "Capfile"
+  end
+
+  ##
+  # Installs required repositories as project's submodules.
+  #
+  def install_submodules
+
+    if agree(
+             (["OK to add git submodules to your application?",
+               "If you select 'No' here some of the fuctionality can be lost",
+               "\n"
+              ] + 
+              SUBMODULES.values).join "\n"
+             )
+
+      SUBMODULES.each do |path, submodule|
+        run "git submodule add #{submodule} config/deploy/#{path}"
+      end
+    else
+      say "OK. Skipping submodules"
+    end
+  end
+
+  ##
+  # Create deploy rb file
+  def create_deploy
+    @@tpl = source_paths.first
+    empty_directory "config/deploy"
+
+    say <<-EOF
+
+config/deploy.rb generator
+
+This menu will help you creating deployment configuration file
+deploy.rb for Capistrano. It is safe to acceppt defulat values for
+most or all questions. Just hit Enter if default is provided.
+
+All values can be changed later in the file itself or you can re-run
+generator again.
+
+EOF
+    template "deploy.rb.erb", "config/deploy.rb"
+    @stages.each do |stage|
+      template "staging.rb.erb", "config/deploy/#{stage}.rb"      
+    end
+    say "Please edit manually configuration of the multi-staging files:"
+    @stages.map { |x| say "./confg/deploy/#{x}.rb\n"}
+  end
+
+  private 
+  
+  # 
+
+
+
+
+  # set :application
+  def application
+    ask ("Application name : ") {  |x| x.default =  File.basename %x{pwd}.chomp }
+  end
+
+
+
+  # For passthrough scm use also 
+  def scm
+    @scm = menu_with_default "Which SCM to use for deployment",
+    [:git,:passthrough ], :git
+
+    case @scm
+    when :passthrough
+      %W{ capistrano-deploy-scm-passthrough capistrano-improved-rsync-with-remote-cache}.each do |g|
+        append_to_file "Gemfile", "gem '#{g}', :group => :development\n"
+      end
+    end
+    @scm
+  end
+
+  ##
+  # Try find name of the GIT repo from git remote
+  def git_remote
+    repos = begin
+              %x{git remote --verbose 2>/dev/null}.split("\n").map(&:split).map {|x| [x[0],x[1]] }.uniq
+            rescue
+              []
+            end
+    default = repos.find { |x| x.first == 'origin'}
+    items = repos.map { |x| x.last }
+
+    menu_with_default "Select repository ", items.compact, default
+  end
+
+
+  # Select version for :rvm_ruby_string
+  def ruby_version
+    default = %x{ rvm current}.strip
+    items = %x{ rvm ls strings }.split.compact
+
+    ruby = menu_with_default "RVM Ruby version to use for deployment:", items,default
+    ruby = ask "Enter alternative RVM Ruby string: " if ruby =~ /Other/
+    ruby
+  end
+
+  ## 
+  # List of the stages for multistage extension and default stage
+  #
+  def multistage
+    @stages = %w(development production staging)
+    catch :exit do 
+      loop do 
+        choose do |menu|
+          menu.header = "List stages for multistage deployments"
+          menu.prompt = "Type number to delete, 1 to add new, Enter - complete."
+          menu.choice '*** Add ***' do 
+            @stages << ask("New stage: ")
+          end
+          menu.hidden("") {  throw :exit }
+
+          menu.choices(*@stages) { |x| @stages.delete x }
+        end
+      end
+    end
+
+    @stages2 = @stages.dup
+    { 
+      stages: @stages,
+      default: menu_with_default("Default stage:", @stages2, "production")
+    }
+  end
+
+  ##
+  # Try to detect DB from confing file and add necessary components.
+  def database
+    default = begin
+                YAML.load_file("config/database.yml")['production']['adapter'].strip
+              rescue
+                nil
+              end
+    menu_with_default "Select a database for production:", ["postgres", "mysql", "sqlite3"], default
+  end
+
+  def comment_block text
+    say text
+    text
+  end
+end

data/lib/generators/capistrano_deploy/config.rb

@@ -0,0 +1,8 @@
+class CapistranoDeployGenerator < Rails::Generators::NamedBase  
+  
+  SUBMODULES = {  
+    recipes: "git@github.com:dmytro/capistrano-recipes.git",
+    :"chef-solo" => "git@github.com:dmytro/chef-solo.git"
+  }
+
+end

data/lib/generators/capistrano_deploy/lib/core_extensions.rb

@@ -0,0 +1,8 @@
+class String
+  def to_bool
+    return true if self =~ (/^(yes|y)$/i)
+    return false if self =~ (/^(no|n)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+end
+

data/lib/generators/capistrano_deploy/lib/helpers.rb

@@ -0,0 +1,43 @@
+require 'highline/import'
+
+class CapistranoDeployGenerator < Rails::Generators::NamedBase  
+  private
+
+  # See http://stackoverflow.com/questions/2903200/watir-changes-highlines-ask-method
+  def ask(*p, &b)
+    HighLine.new.ask(*p, &b)
+  end
+
+  def ask_default propmt, default, &b
+    ask(propmt) { |q| q.default = default; q.readline = true }
+  end
+
+  def agree_default quest, default=nil
+    agree(quest) {  |q| q.default = default }
+  end
+
+  ##
+  # Menu with default element and add own item.
+  def menu_with_default header, items, default
+
+    idx = items.index default
+    items[idx] = "=> [ #{default} ]" if idx
+
+    choose do |menu|
+      menu.header = header
+      menu.prompt =%Q{
+> Type 1 to add, number or name or Enter to accept default. 
+> Default is specified by '=>' mark.
+: }
+
+      menu.choice  ('*** Other ***') { return ask "Enter new item: " }
+      menu.choices *(items)
+      menu.readline = true
+      menu.hidden("") { puts default; return default }  if default
+    end
+  end
+
+  def recipe file
+    "load File.expand_path(\"deploy/recipes/#{file}.rb\")"
+  end
+end

data/lib/generators/capistrano_deploy/templates/Capfile

@@ -0,0 +1,4 @@
+load 'deploy'
+# Uncomment if you are using Rails' asset pipeline
+    # load 'deploy/assets'
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/lib/generators/capistrano_deploy/templates/deploy.rb.erb

@@ -0,0 +1,138 @@
+<%= recipe 'base' %>
+<%= recipe 'chef_solo' %>
+<%= recipe 'application_yml_file' %>
+
+<%= comment_block %Q{
+# --------------------------------------------
+# Rails application name
+# --------------------------------------------
+
+}%>
+set :application,         '<%=  ask_default "Application name : ", File.basename(%x{pwd}.chomp) %>'
+
+# For precompiling assets rails_env should be set to production
+set :rails_env,            'production'
+<%= comment_block %Q{
+
+# --------------------------------------------
+# Remote user and application location
+# --------------------------------------------
+
+}-%>
+set :user,                '<%= ask_default "User to deploy as: ", 'ubuntu' %>'
+set :use_sudo,            <%= agree_default "Use sudo for deployment? " , :yes %>
+set :deploy_to,           "<%= ask_default "Deploy directory: ", '/home/#{user}/#{application}' %>"
+set :keep_releases,       <%= ask("Number of rollback releases : ", Integer) { |q| q.in = 1..30; q.default = 5 } %>
+
+set :web_domain,          "#{application}.com"
+
+<%= comment_block %Q{
+# --------------------------------------------
+# Ruby, RVM Configuration
+# --------------------------------------------
+
+}-%>
+require 'rvm/capistrano'
+require 'bundler/capistrano'
+set :rvm_ruby_string,     '<%= ruby_version %>'
+set :rvm_path,            "/usr/local/rvm"
+set :rvm_type,            :system
+
+<%= comment_block %Q{
+# --------------------------------------------
+# Multistage extension configuraion
+# --------------------------------------------
+
+}-%>
+
+require 'capistrano/ext/multistage'
+<% x = multistage %>
+set :stages,              <%= x[:stages].to_s %>
+set :default_stage,       '<%= x[:default] %>'
+
+<%= comment_block %Q{
+
+# --------------------------------------------
+# Source code management
+# --------------------------------------------
+
+}-%>
+<% @scm = scm -%>
+<%= File.read "#{source_paths.first}/#{@scm}.tpl" -%>
+<% if @scm =~ /git/ -%>
+set :repository,          "<%= git_remote %>"
+<% end -%>
+
+
+<%= comment_block %Q{
+
+# --------------------------------------------
+# Production database configuration
+# --------------------------------------------
+
+}-%>
+set :create_database_yaml,        true
+<% db = database -%>
+
+<%= recipe 'database' %>
+set :database_adapter,            '<%= db %>'
+<% case db -%>
+<% when 'postgres' -%>
+<%= recipe 'posgresql' %>
+<%= recipe 'posgresql_backup' %>
+<% when 'sqlite3' -%>
+set :production_password,         ""
+<% end -%>
+
+<%= comment_block %Q{
+
+# --------------------------------------------
+# Web server configuration
+# --------------------------------------------
+
+}-%>
+
+<%
+case menu_with_default "Production uses Unicorn server. Which webserver to use with it?", 
+['nginx', 'apache'],
+'nginx'
+
+when 'nginx'
+%>
+<%=  recipe 'nginx' %>
+<% when 'apache' -%>
+<%=  recipe 'apache_unicorn' %>
+<% end -%>
+<%= recipe 'unicorn' %>
+set :unicorn_workers, <%= ask("Number of Unicorn workers : ", Integer) { |q| q.in = 1..30; q.default = 10  } %>
+<%= comment_block %Q{
+# --------------------------------------------
+# Load additional capistrano recipes
+# --------------------------------------------
+}-%>
+<%= recipe 'logs' %>
+
+
+<%= comment_block %Q{
+# --------------------------------------------
+# Common tasks
+# --------------------------------------------
+}-%>
+task :setup do
+  top.deploy.setup
+  top.unicorn.setup
+end
+  
+after "deploy", "deploy:migrate"
+after "deploy", "deploy:reload"
+after "deploy", "deploy:cleanup"
+
+namespace :deploy do  
+  task :reload do 
+    top.unicorn.restart
+  end
+
+  task :migrate do
+    run "cd #{current_path} && RAILS_ENV=production bundle exec rake --TRACE db:migrate"
+  end
+end

data/lib/generators/capistrano_deploy/templates/git.tpl

@@ -0,0 +1,3 @@
+set :scm,                   :git
+set :deploy_via,            :copy
+set :git_enable_submodules, true

data/lib/generators/capistrano_deploy/templates/passthrough.tpl

@@ -0,0 +1,5 @@
+set :scm,                 :passthrough
+set :repository,          '.'
+set :deploy_via,          :improved_rsync_with_remote_cache
+set :rsync_options,       '-azF --delete --delete-excluded'
+set :local_cache,         '.'

data/lib/generators/capistrano_deploy/templates/staging.rb.erb

@@ -0,0 +1,22 @@
+#
+# Add you deployment keys here
+#
+ssh_options[:keys] =  ["~/.ssh/id_dsa"]
+
+# Use one of the application server configuration blocks: single
+# server or multiple server roles.
+
+server "127.0.0.1" , :web, :app, :db, primary: true
+
+# role :web, "your web-server here"                          # Your HTTP server, Apache/etc
+# role :app, "your app-server here"                          # This may be the same as your `Web` server
+# role :db,  "your primary db-server here", :primary => true # This is where Rails migrations will run
+# role :db,  "your slave db-server here"
+
+before "deploy", "setup"
+
+set :branch, 'master'
+
+
+# if you want to clean up old releases on each deploy uncomment this:
+# after "deploy:restart", "deploy:cleanup"

data/lib/generators/capistrano_deploy/version.rb

@@ -0,0 +1,4 @@
+require 'rails/generators'
+class CapistranoDeployGenerator < Rails::Generators::NamedBase  
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_deploy_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmytro Kovalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create config/deploy.rb file and config/deploy directory subtree with
+  required componenets for capistrano. Install support Git repositories as submodules.
+email:
+- dmytro.kovalov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano_deploy_generator.gemspec
+- lib/generators/capistrano_deploy/USAGE
+- lib/generators/capistrano_deploy/capistrano_deploy_generator.rb
+- lib/generators/capistrano_deploy/config.rb
+- lib/generators/capistrano_deploy/lib/core_extensions.rb
+- lib/generators/capistrano_deploy/lib/helpers.rb
+- lib/generators/capistrano_deploy/templates/Capfile
+- lib/generators/capistrano_deploy/templates/deploy.rb.erb
+- lib/generators/capistrano_deploy/templates/git.tpl
+- lib/generators/capistrano_deploy/templates/passthrough.tpl
+- lib/generators/capistrano_deploy/templates/staging.rb.erb
+- lib/generators/capistrano_deploy/version.rb
+homepage: http://dmytro.github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Generate deployment configuration to be used with Capistrano.
+test_files: []
+has_rdoc: