webflow_cap 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854e7a35c956f8165e72f5ef1bc004536f285771
-  data.tar.gz: 8dc01728439291374479851e173d88b08fa328f2
+  metadata.gz: 74f2868530b5363dab7ed43334cce69098d502af
+  data.tar.gz: e122a0647df6f6aa6fe009fb8eb8d930595529f3
 SHA512:
-  metadata.gz: 8ba10479822cbea1e5cb2f48c192360368e9cb3df49ba5226d2742f722a4e0f1695b964fe85f7415b19c5b2f36465ac89d9590b58d7382d8257ade81ac6abad9
-  data.tar.gz: 0a92b7684df93aae77f26ce59e0e201e308a65a4c7cb4a27d46c182a91870597218b180497a9473648fb940e00fab95263691e906c60fc9e02c9e4aa33840a29
+  metadata.gz: 2b50e2682615ac7da485e18743865a2818c12a5f24ba7565ecb077043ef5b117ba1df84b29f88740348a08c2fba609435bbffbab4dee811bbe0883d6829822f9
+  data.tar.gz: 624812568eea5011dab37f02ecc5c08dae00a80d15326a4ce012ae1edfdf9447efb0997415083cbe6549361c94615be8e3f5876b1cd869bac419e859a9f096ea

data/README.md

@@ -1,5 +1,30 @@
 # webflow_cap
-    
+
+This gem is a plugin for [capistrano 3](http://capistranorb.com/) to make deployment of rails applications to [.webflow](http://www.webflow.de) servers easy.
+
+Applications that get deployed with the capistrano tasks are automatically configured and setup to run supervised.
+The database.yml is automatically created and configured to use the right connection settings.
+An application specific database will also be created.
+
+The application server (which defaults to [passenger standalone](https://www.phusionpassenger.com/#about)) will be started and supervised by [runit](http://smarden.org/runit/).
+
+## Usage
+
+1. Add the following lines to your Gemfile:
+
+   ```ruby
+   gem 'passenger'
+   
+   group :development do
+     gem 'capistrano-rails', group: :development
+     gem 'webflow_cap'
+   end
+  ```
+2. Execute `bundle install` to install these gems.
+3. Execute `bundle exec webflow_capify` which asks you some questions and installs capistrano templates with sane defaults to your project.
+
+With these capistrano files in place all you need to do is execute `bundle exec cap production deploy` to spin up your rails application.
+
 ## License
 
 MIT; Copyright (c) 2014 Florian Aman, webflow GmbH

data/bin/webflow_capify

@@ -0,0 +1,14 @@
+#!/bin/env ruby
+require 'capistrano/all'
+
+stages = "production"
+set :stage, :production
+role :app, %w{}
+
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/webflow/install'
+
+Dir.glob('capistrano/tasks/*.rake').each { |r| import r }
+
+Capistrano::Application.invoke("webflow:install")

data/lib/capistrano/tasks/base.rake

@@ -1,7 +1,7 @@
 namespace :load do
   task :defaults do
     # variables with default values
-    set :application_server,    fetch(:application_server, "puma")
+    set :application_server,    fetch(:application_server, "passenger")
     set :branch,                fetch(:branch, "master")
     set :scm,                   fetch(:scm, :git)
     set :ruby_version,          fetch(:ruby_version, "2.1")
@@ -13,7 +13,7 @@ namespace :load do
 
     set :home,                  -> { "/docs/#{fetch :user}" }
     set :deploy_to,             -> { "/docs/#{fetch :user}/#{fetch :domain}/#{fetch :application}" }
-    set :server_port,           -> { 10000 + ((fetch :user)[3..6] + "0").to_i }
+    set :server_port,           -> { 10000 + ((fetch :user)[4..6] + "0").to_i }
     
     set :linked_files, %w{}
     
@@ -24,22 +24,26 @@ namespace :load do
 end
 
 namespace :deploy do
+  desc 'Start application'
   task :start do
     on roles :all do
       execute "sv start #{fetch :runit_service_dir}"
     end
   end
+  desc 'Stop application'
   task :stop do
     on roles :all do
       execute "sv stop #{fetch :runit_service_dir}"
     end
   end
+  desc 'Restart application'
   task :restart do
     on roles :all do
       execute "sv restart #{fetch :runit_service_dir}"
     end
   end
 
+  desc 'Show supervision status for application'
   task :status do
     on roles :all do
       execute "sv status #{fetch :runit_service_dir}"

data/lib/capistrano/tasks/rails.rake

@@ -1,11 +1,12 @@
 namespace :load do
   task :defaults do
-    set :runit_service_dir, -> {"#{fetch :home}/etc/service/rails-#{fetch :server_port}-#{fetch :domain}-#{fetch :application}"}
+    set :runit_service_dir, -> {"#{fetch :home}/etc/service/rails-#{fetch :server_port}-#{fetch :domain}-#{fetch :application}-#{fetch :stage}"}
   end
 end
 
 namespace :rails do
-  task :versions do
+  desc 'Show possible ruby versions on configured .webflow server'
+  task :ruby_versions do
     on roles :all do
       within '/opt/ruby' do
         execute(:ls)
@@ -35,7 +36,7 @@ RewriteRule ^(.*)$ http://localhost:#{fetch :server_port}/$1 [P]
 
   task :setup_application_server do
     on roles :all do
-      daemon_name = "rails-#{fetch :server_port}-#{fetch :domain}-#{fetch :application}"
+      daemon_name = "rails-#{fetch :server_port}-#{fetch :domain}-#{fetch :application}-#{fetch :stage}"
       runit_dir = "#{fetch :home}/etc/sv/#{daemon_name}"
 
       if test("[ -e #{runit_dir} ]")
@@ -43,6 +44,9 @@ RewriteRule ^(.*)$ http://localhost:#{fetch :server_port}/$1 [P]
         next
       end
 
+      application_server = fetch(:application_server)
+      application_server + ' start' if application_server == 'passenger'
+
       daemon_script = <<-EOF
 #!/bin/bash -e
 exec 2>&1
@@ -51,7 +55,7 @@ export PATH=#{fetch(:default_env)['PATH']}
 source $HOME/.bashrc
 source $HOME/#{fetch :domain}/etc/rubyrc
 cd #{fetch :deploy_to}/current
-exec bundle exec #{fetch :application_server} -p #{fetch :server_port} -e #{fetch :stage} 2>&1
+exec bundle exec #{application_server} -p #{fetch :server_port} -e #{fetch :stage} 2>&1
     EOF
     
       log_script = <<-EOF

data/lib/capistrano/tasks/webflow_install.rake

@@ -0,0 +1,67 @@
+require 'erb'
+require 'pathname'
+require 'capistrano/configuration/question.rb'
+
+namespace :webflow do
+  desc "Install webflow flavoured capistrano files"
+  task :install do
+    question = Capistrano::Configuration::Question
+
+    repository_url = if File.exists?(Dir.getwd + '/.git')
+      `git config --get remote.origin.url`.strip
+    end
+
+    set :application, ask("Application name", File.basename(Dir.getwd))
+    set :ruby_version, ask("Ruby version", "2.1.5")
+    set :repo_url, ask("Repository URL", repository_url)
+    set :user, ask("Username", "f909999")
+    set :domain, ask("Domain", "example.com")
+    set :server, -> { ask("Server", fetch(:domain)) }
+    set :server_port, -> { 10000 + ((fetch :user)[4..6] + "0").to_i }
+
+    @application = fetch(:application)
+    @ruby_version = fetch(:ruby_version)
+    @repo_url = fetch(:repo_url)
+    @user = fetch(:user)
+    @domain = fetch(:domain)
+    @server = fetch(:server)
+    @server_port = fetch(:server_port)
+          
+    envs = ENV['STAGES'] || 'staging,production'
+  
+    tasks_dir = Pathname.new('lib/capistrano/tasks')
+    config_dir = Pathname.new('config')
+    deploy_dir = config_dir.join('deploy')
+  
+    deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
+    stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
+    capfile = File.expand_path("../../templates/Capfile", __FILE__)
+
+    FileUtils.mkdir_p deploy_dir
+  
+    entries = [{template: deploy_rb, file: config_dir.join('deploy.rb')}]
+    entries += envs.split(',').map { |stage| {template: stage_rb, file: deploy_dir.join("#{stage}.rb")} }
+  
+    entries.each do |entry|
+      if File.exists?(entry[:file]) && question.new("Overwrite #{entry[:file]}?", 'y').call != 'y'
+        warn "[skip] #{entry[:file]} already exists"
+      else
+        File.open(entry[:file], 'w+') do |f|
+          f.write(ERB.new(File.read(entry[:template])).result(binding))
+          puts "create #{entry[:file]}"
+        end
+      end
+    end
+  
+    FileUtils.mkdir_p tasks_dir
+
+    if File.exists?('Capfile') && question.new("Overwrite Capfile?", 'y').call != 'y'
+      warn "[skip] Capfile already exists"
+    else
+      FileUtils.cp(capfile, 'Capfile')
+      puts 'create Capfile'
+    end    
+  
+    puts 'Capified'
+  end
+end

data/lib/capistrano/templates/deploy.rb.erb

@@ -8,4 +8,8 @@ set :application, "<%= @application %>"
 set :repo_url, "<%= @repo_url %>"
 
 # use ruby_version to set a specific ruby version
-# set :ruby_version, "<%= @ruby_version %>"
+# set :ruby_version, "<%= @ruby_version %>"
+
+#set :application_server, "passenger"
+
+#set :linked_files, %w{}

data/lib/capistrano/templates/stage.rb.erb

@@ -8,4 +8,6 @@ set :domain, "<%= @domain %>"
 # set :password_protected, true
 
 # set the servername to the servername or ipaddress from webflow e.g. server.example.com or 192.168.0.1
-server "<%= @server %>", user: fetch(:user), roles: %w(:web :app :db), primary: true
+server "<%= @server %>", user: fetch(:user), roles: %w(:web :app :db), primary: true
+
+#set :server_port, <%= @server_port %> # please only change after you talk to webflow staff

data/lib/capistrano/webflow/base.rb

@@ -1,2 +1 @@
 load File.expand_path("../../tasks/base.rake", __FILE__)
-load File.expand_path("../../tasks/webflow.rake", __FILE__)

data/lib/capistrano/webflow/install.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/webflow_install.rake", __FILE__)

data/webflow_cap.gemspec

@@ -13,10 +13,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "webflow_cap"
   gem.require_paths = ["lib"]
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.3"
   
   # dependencies
   gem.add_dependency 'capistrano',         '~>3.2'
-  gem.add_dependency 'capistrano-rails'
-  gem.add_dependency 'capistrano-bundler'
+  gem.add_dependency 'capistrano-bundler', '~>1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow_cap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Florian Aman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,38 +24,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: capistrano-rails
-  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: capistrano-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 description: Deploy Rails apps
 email:
 - fa@webflow.de
-executables: []
+executables:
+- webflow_capify
 extensions: []
 extra_rdoc_files: []
 files:
@@ -63,16 +50,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/webflow_capify
 - lib/capistrano/tasks/base.rake
 - lib/capistrano/tasks/htaccess.rake
 - lib/capistrano/tasks/mysql.rake
 - lib/capistrano/tasks/rails.rake
-- lib/capistrano/tasks/webflow.rake
+- lib/capistrano/tasks/webflow_install.rake
 - lib/capistrano/templates/Capfile
 - lib/capistrano/templates/deploy.rb.erb
 - lib/capistrano/templates/stage.rb.erb
 - lib/capistrano/webflow/base.rb
 - lib/capistrano/webflow/htaccess.rb
+- lib/capistrano/webflow/install.rb
 - lib/capistrano/webflow/mysql.rb
 - lib/capistrano/webflow/rails.rb
 - lib/webflow_cap.rb

data/lib/capistrano/tasks/webflow.rake

@@ -1,60 +0,0 @@
-require 'erb'
-require 'pathname'
-
-namespace :webflow do
-  desc "Install webflow flavoured capistrano files"
-  task :install do
-    on roles :all do
-      set :application, ask("Application name", "APP")
-      set :ruby_version, ask("Ruby version", "2.1.5")
-      set :repo_url, ask("Repository URL", nil)
-      set :user, ask("Username", "f999999")
-      set :domain, ask("Domain", "example.com")
-      set :server, ask("Server", "server.example.com")
-
-      @application = fetch(:application)
-      @ruby_version = fetch(:ruby_version)
-      @repo_url = fetch(:repo_url)
-      @user = fetch(:user)
-      @domain = fetch(:domain)
-      @server = fetch(:server)
-            
-      envs = ENV['STAGES'] || 'staging,production'
-    
-      tasks_dir = Pathname.new('lib/capistrano/tasks')
-      config_dir = Pathname.new('config')
-      deploy_dir = config_dir.join('deploy')
-    
-      deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
-      stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
-      capfile = File.expand_path("../../templates/Capfile", __FILE__)
-
-      execute "mkdir -p #{deploy_dir}"
-    
-      entries = [{template: deploy_rb, file: config_dir.join('deploy.rb')}]
-      entries += envs.split(',').map { |stage| {template: stage_rb, file: deploy_dir.join("#{stage}.rb")} }
-    
-      entries.each do |entry|
-        if File.exists?(entry[:file])
-          warn "[skip] #{entry[:file]} already exists"
-        else
-          File.open(entry[:file], 'w+') do |f|
-            f.write(ERB.new(File.read(entry[:template])).result(binding))
-            puts "create #{entry[:file]}"
-          end
-        end
-      end
-    
-      execute "mkdir -p #{tasks_dir}"
-
-      if File.exists?('Capfile')
-        warn "[skip] Capfile already exists"
-      else
-        FileUtils.cp(capfile, 'Capfile')
-        puts 'create Capfile'
-      end    
-    end
-  
-    puts 'Capified'
-  end
-end