capistrano-generals 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c68ee2a15f115648399481fd7698d389e983d70e
-  data.tar.gz: a2a3d4ae62f947ddbc3b52a18ab05b5b55ab8582
+  metadata.gz: fdebc6315f89ed9b6e0c9a4a4d14e7e73a3e6244
+  data.tar.gz: 5d313806553a1fc320e9a1eb46db7c6e627d4830
 SHA512:
-  metadata.gz: 4d614b6144a875004c3f79de1c54c1f8dc6fde5aa27e5b78c5adbf307d86da3f63fec87def74aa627056132fe3a096550b7101cda4372de97e152c0fe6b87b01
-  data.tar.gz: 40db883ff86977e42a6f60085de0a47b80fcab6a9a37408a2974e78f8420567c3c5e7cf0e110496bb94f26eea0f379b13139403810197c3a79718b49d9728e06
+  metadata.gz: 7502b3c0524e108402761ba462da56afc8510a61013e790f7c766543c1a28141bf61b91c6762c24bcae983a8b8d77865271444b0ccd8ec5886d1e9c5ea8367d9
+  data.tar.gz: 9410356ba56ad748d5444695a12573b313ebe1a81836e57d535112290397f15d66dac42038ff71d3dc7e37fa62a1bf433812d5f5884bf40dccad6963210817b1

data/README.md

@@ -1,26 +1,55 @@
 # Capistrano::Generals
 
-TODO: Write a gem description
+Capistrano tasks that are used quite often.
+Push your code to git, upload stage specific config files.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this to your application's `Gemfile`:
 
 ```ruby
-gem 'capistrano-generals'
+group :development do
+  gem 'capistrano', '~> 3.2.1'
+  gem 'capistrano-unicorn-nginx', '~> 3.1.0'
+end
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+And add this to the `Capfile`:
 
-    $ gem install capistrano-generals
+```ruby
+require 'capistrano/generals'
+```
 
 ## Usage
+When the generals package is added to the `Capfile`, the user can specify the required tasks.
+In your `config/deploy.rb` you can add the taks by adding them to the deploy namespace like this:
+
+```ruby
+namespace :deploy do
+  before :deploy, 'git:push'
+  before :deploy, 'deploy:symlink:upload_linked_files'
+end
+```
+
+### Git push
+This first checks if there are no local changes that has not been committed.
+If all changes are committed, they are pushed.
+
+Options:
+
+* IGNORE_DEPLOY_RB=true: This ignores changes in deploy.rb, for testing only!
+* FORCE=true: Force push changes
+
+### Upload linked files
+This uploads the linked files. It first checks for a stage specific file so for
+example you want to upload `database.yml` to the `staging` environment,
+the system first searches for `database.staging.yml` and if it cannot find that
+it will fall back to the original.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/capistrano/generals.rb

@@ -1,2 +1,6 @@
+# Include all helpers
+require 'capistrano/generals/helpers'
+include Capistrano::Generals::Helpers
+
 # Load all the rake files
 Dir[File.dirname(__FILE__) + '/tasks/**/*.rake'].each {|file| load file }

data/lib/capistrano/generals/helpers.rb

@@ -1,11 +1,20 @@
 module Capistrano
   module Generals
     module Helpers
-
       def red text
         "\033[31m#{text}\033[0m"
       end
 
+      def get_config_file config, stage
+        path = File.dirname(config)
+        extension = File.extname(config)
+        filename = File.basename(config, extension)
+        extension.sub!(/^\./, '')
+        local_file = [filename, stage].join('.')
+        local_file = [local_file, extension].join('.') unless extension.empty?
+        local_path = File.join(path, local_file)
+      end
+
     end
   end
 end

data/lib/capistrano/generals/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Generals
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/capistrano/tasks/deploy/symlink.rake

@@ -3,50 +3,68 @@ namespace :deploy do
 
     desc 'Upload the linked files from local system'
     task :upload_linked_files do
-      fetch(:linked_files).each do |filename|
+
+      # Abort if no linked files found
+      if fetch(:linked_files).nil?
+        abort red "No linked files specified. Remove the upload_linked_files task or add linked_files."
+      end
+
+      # Loop through all linked files
+      fetch(:linked_files).each do |file_name|
+
+        # Default local_file_name is stage specific.
+        local_file_name = get_config_file(file_name, fetch(:stage).to_s)
 
         # Initialize variable outsize run_locally block to make sure it can be
         # passed into the remote block
         local_cksum = nil
 
+        # Get file information
         run_locally do
-          # Check if file exists, else abort
-          unless File.exist? filename
-            abort red "Cannot find file #{filename} on local machine"
+
+          # Check if file exists, else select default file
+          # If default file does not exists abort.
+          unless File.exists? local_file_name
+            unless File.exists? file_name
+              abort red "Cannot find file #{local_file_name} or #{file_name} on local machine"
+            end
+            # The default file does exists, selecting that one
+            warn "Cannot find stage specific config file #{local_file_name} on local machine, taking default #{file_name}"
+            local_file_name = file_name
           end
 
           # Get local file info
-          local_cksum = capture :cksum, filename
+          local_cksum = capture :cksum, local_file_name
         end
+
+        # Getting local file information
         local_sum, local_size, local_path = local_cksum.split
 
         on roles :app do
           # Create directory
-          dir_path = File.join shared_path, File.dirname(filename)
+          dir_path = File.join shared_path, File.dirname(file_name)
           execute :mkdir, '-p', dir_path
 
           # Check if file already exists on remote
-          remote_file_path = File.join shared_path, filename
-          if test("[ -f #{remote_file_path} ]")
+          remote_file_name = File.join shared_path, file_name
+          if test("[ -f #{remote_file_name} ]")
             # File already exists
             # Get remote file info
-            remote_cksum = capture :cksum, remote_file_path
+            remote_cksum = capture :cksum, remote_file_name
             remote_sum, remote_size, remote_path = remote_cksum.split
 
             # Check if the file has changed
             if local_sum == remote_sum
-              info "#{filename} Already up to date."
+              info "Remote #{remote_file_name} already up to date with local #{local_file_name}."
             else
-              upload! local_path, remote_file_path
-              info "Replaced #{filename} -> #{remote_file_path}"
+              upload! local_file_name, remote_file_name
+              info "Replaced #{local_file_name} -> #{remote_file_name}"
             end
-
           else
             # File does not exists
-            upload! local_path, remote_file_path
-            info "Uploaded #{filename} -> #{remote_file_path}"
+            upload! local_file_name, remote_file_name
+            info "Uploaded #{local_file_name} -> #{remote_file_name}"
           end
-
         end
 
       end

data/lib/capistrano/tasks/git.rake

@@ -4,20 +4,21 @@ namespace :git do
   task :push do
     # Check for any local changes that haven't been committed
     # Use 'cap git:push IGNORE_DEPLOY_RB=1' to ignore changes to this file (for testing)
-    status = %x(git status --porcelain).chomp
-    if status != ""
-      if status !~ %r{^[M ][M ] config/deploy.rb$}
-        abort "Local git repository has uncommitted changes"
-      elsif !ENV["IGNORE_DEPLOY_RB"]
-        # This is used for testing changes to this script without committing them first
-        abort "Local git repository has uncommitted changes (set IGNORE_DEPLOY_RB=1 to ignore changes to deploy.rb)"
+    run_locally do
+      status = %x(git status --porcelain).chomp
+      if status != ""
+        if status !~ %r{^[M ][M ] config/deploy.rb$}
+          abort "Local git repository has uncommitted changes"
+        elsif !ENV["IGNORE_DEPLOY_RB"]
+          # This is used for testing changes to this script without committing them first
+          abort red "Local git repository has uncommitted changes (set IGNORE_DEPLOY_RB=1 to ignore changes to deploy.rb)"
+        end
       end
-    end
 
-    # Push selected branch to github
-    branch = fetch(:branch)
-    unless system "git push #{repo_url} #{branch} #{'-f' if ENV['FORCE']}"
-      abort red("Failed to push changes to #{fetch(:repo_url)} (set FORCE=true to force push to github)")
+      # Push selected branch to github
+      unless system "git push #{repo_url} #{fetch(:branch)} #{'-f' if ENV['FORCE']}"
+        abort red "Failed to push changes to #{fetch(:repo_url)} (set FORCE=true to force push to github)"
+      end
     end
   end
 

data/lib/capistrano/tasks/setup.rake

@@ -0,0 +1,13 @@
+namespace :setup do
+
+  desc "Symlinks config files for Nginx and Unicorn"
+  task :symlink_nginx_and_unicorn do
+    on roles(:app) do
+      execute "ln -nfs #{current_path}/config/nginx.conf /etc/nginx/sites-enabled/#{fetch(:application)}"
+      execute "ln -nfs #{current_path}/config/unicorn_init.sh /etc/init.d/unicorn_#{fetch(:application)}"
+      # Start unicorn at startup
+      execute "sudo update-rc.d unicorn_#{fetch(:application)} defaults"
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-generals
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stef Schenkelaars
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -65,11 +65,13 @@ files:
 - README.md
 - Rakefile
 - capistrano-generals.gemspec
+- lib/capistrano-generals.rb
 - lib/capistrano/generals.rb
 - lib/capistrano/generals/helpers.rb
 - lib/capistrano/generals/version.rb
 - lib/capistrano/tasks/deploy/symlink.rake
 - lib/capistrano/tasks/git.rake
+- lib/capistrano/tasks/setup.rake
 homepage: ''
 licenses:
 - MIT