aktion_cap 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# v0.1.1
+
+* Remove harded stages in config/deploy.rb
+* Improvements to interactive configuration
+* Make ssh user configurable, defaults to deployer
+
+# v0.1.0
+
+Released *rake capify* task. Provides an interactive version of capify.
+
+# v0.0.1
+
+Initial release.
+
+* Provides capistrano, multistage capistrano and rvm capistrano gems
+

data/README.md

@@ -1,16 +1,16 @@
 # AktionCap
 
-TODO: Write a gem description
+A metagem for use with capistrano. It includes capistrano with multistage extension, rvm integration and rake tasks to make capistrano management simpler.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'aktion_cap'
+    gem 'aktion_cap', '~> 0.1.0'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -18,7 +18,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### capify
+
+The `rake capify` command acts as a replacement for `capify`. When run it will prompt a series of questions about the deployment and output files
+fully configured for deployment. The prompts will attempt to supply defaults based on the application.
 
 ## Contributing
 

data/lib/aktion_cap/tasks.rb

@@ -19,11 +19,13 @@ module AktionCap
           q.default = `git config --local remote.origin.url`.strip
         end
       end
+      options[:ssh_user] = ask("Enter the ssh username to deploy with: ") {|q| q.default = 'deployer'}
       options[:stages] = ask("Enter the deployment stages(separate with commas): ") {|q| q.default = 'production'}.split(',').map(&:to_sym)
       options[:stages].each do |stage|
+        say("\nConfigure #{stage.to_s}:")
         options[stage] = {}
-        options[stage][:server_hostname] = ask("Enter the server hostname or IP: ") {|q| q.default = 'localhost'}
-        options[stage][:server_port] = ask("Enter the ssh port to connect to: ", Integer) do |q|
+        options[stage][:server_hostname] = ask("  Enter the server hostname or IP: ") {|q| q.default = 'localhost'}
+        options[stage][:server_port] = ask("  Enter the ssh port to connect to: ", Integer) do |q|
           if options[stage][:server_hostname] == 'localhost'
             q.default = '2222'
           else
@@ -34,36 +36,31 @@ module AktionCap
       options
     end
 
-    def install
-      desc 'capify'
-      task 'capify' do
-        options = prompts_for_capify
-
-        capfile = File.join(Dir.pwd, 'Capfile')
-        File.open(capfile, 'w') do |f|
-          f << <<FILE
+    def write_capfile
+      File.open('Capfile', 'w') do |file|
+        file << <<-FILE
 load 'deploy'
 load 'config/deploy'
-FILE
-        end
-
+        FILE
+      end
+    end
 
-        config_deploy = File.join(Dir.pwd, 'config', 'deploy.rb')
-        File.open(config_deploy, 'w') do |f|
-          f << <<FILE
-set :stages %w(production staging)
+    def write_config_deploy(opts)
+      File.open('config/deploy.rb', 'w') do |file|
+        file << <<-FILE
+set :stages, %w(#{opts[:stages].map(&:to_s).join(' ')})
 
 require 'capistrano/ext/multistage'
 require 'bundler/capistrano'
 require 'rvm/capistrano'
 require './config/boot'
 
-ssh_options[:username] = 'deployer'
+ssh_options[:username] = '#{opts[:ssh_user]}'
 ssh_options[:forward_agent] = true
 
-set :application, '#{options[:application]}'
-set :repository, '#{options[:repository]}'
-set :scm, :#{options[:scm]}
+set :application, '#{opts[:application]}'
+set :repository, '#{opts[:repository]}'
+set :scm, :#{opts[:scm]}
 set :deploy_via, :remote_cache
 set :deploy_to, "/var/www/\#{application}/\#{stage}"
 set :rvm_type, :user
@@ -75,24 +72,30 @@ set :tasks_for_rake, %w(db:migrate)
 after  'deploy:update_code',    'deploy:create_shared_symlinks'
 before 'deploy:create_symlink', 'deploy:run_rake_tasks'
 after  'deploy',                'deploy:cleanup'
-FILE
-        end
-
-        deploy_dir = File.join(Dir.pwd, 'config', 'deploy')
-        Dir.mkdir(deploy_dir) unless Dir.exists?(deploy_dir)
+        FILE
+      end
+    end
 
-        options[:stages].each do |stage|
-          deploy_file = File.join(Dir.pwd, 'config', 'deploy', "#{stage.to_s}.rb")
-          File.open(deploy_file, 'w') do |f|
-            f << <<FILE
-set :port, #{options[stage][:server_port]}
-set :server_hostname, '#{options[stage][:server_hostname]}'
+    def write_stage_config_deploy(stage, opts)
+      File.open("config/deploy/#{stage.to_s}.rb", 'w') do |file|
+        file << <<-FILE
+set :port, #{opts[stage][:server_port]}
+set :server_hostname, '#{opts[stage][:server_hostname]}'
 role :app, server_hostname
 role :web, server_hostname
 role :db,  server_hostname, primary: true
-FILE
-          end
-        end
+        FILE
+      end
+    end
+
+    def install
+      desc 'capify'
+      task 'capify' do
+        opts = prompts_for_capify
+        Dir.mkdir('config/deploy') unless Dir.exists?('config/deploy')
+        write_capfile
+        write_config_deploy opts
+        opts[:stages].each{|stage| write_stage_config_deploy(stage, opts)}
       end
     end
   end

data/lib/aktion_cap/version.rb

@@ -1,3 +1,3 @@
 module AktionCap
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/capify_spec.rb

@@ -29,7 +29,7 @@ RSpec::Matchers.define :contain_content do |expected_line|
   failure_message_for_should do |file|
     file = File.open(file) if file.is_a? String
     lines = file.lines.to_a
-    best_match = [string_similarity(expected_line, lines.first)]
+    best_match = [string_similarity(expected_line, lines.first), lines.first]
     lines[1..-1].each do |l|
       score = string_similarity(expected_line, l)
       best_match = [score,l] if score > best_match[0]
@@ -64,9 +64,11 @@ describe 'capify' do
 
     describe "dummy/config/deploy.rb" do
       it { should be_a_file_that_exists }
+      it { should contain_content "set :stages, %w(production)" }
       it { should contain_content "set :application, 'dummy'" }
       it { should contain_content "set :repository, 'git@github.com:AktionLab/aktion_cap'" }
       it { should contain_content "set :scm, :git" }
+      it { should contain_content "ssh_options[:username] = 'deployer'" }
     end
 
     describe 'dummy/config/deploy/production.rb' do
@@ -83,8 +85,10 @@ describe 'capify' do
 
     describe 'dummy/config/deploy.rb' do
       it { should be_a_file_that_exists }
+      it { should contain_content "set :stages, %w(staging production)" }
       it { should contain_content "set :application, 'custom_application'" }
       it { should contain_content "set :repository, 'git@github.com:someone/custom_application'" }
+      it { should contain_content "ssh_options[:username] = 'www-data'" }
     end
 
     describe 'dummy/config/deploy/production.rb' do

data/spec/fixtures/custom_capify_responses

@@ -1,6 +1,7 @@
 custom_application
 git
 git@github.com:someone/custom_application
+www-data
 staging,production
 staging.customapp.com
 2323

data/spec/fixtures/default_capify_responses

@@ -5,3 +5,4 @@
 
 
 
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aktion_cap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -69,6 +69,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -98,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 742495597940047984
+      hash: 1872119278476282222
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 742495597940047984
+      hash: 1872119278476282222
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24