capistrano-twelvefactor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 529815d75094ffa658929d940e6d679da3d62ce9
-  data.tar.gz: 46aa25ab59f10700d44158c996ba79e0a257fac5
+  metadata.gz: fda67dfc4bcf35763b354696413cb6574f8dcf0d
+  data.tar.gz: 7610e9eb9826473fd33110830fee6576d7ad6983
 SHA512:
-  metadata.gz: e4405f835a45debf9a90e11155f7f1af838d02bf77209d5fe9932f6381fe67e3f3101baa6292959866fa1ecfc69053e93b255236b3f998ea1283a8357f1b9847
-  data.tar.gz: 3953623382a18cb80f7872c59f6db997c9561b98cc36ad09809ae6aae38e82c2490ee763811301ea3a5383ba686688aceac6b9d19780e7ff5e263ddf00eef990
+  metadata.gz: fd6b1f6a28e2d7cf8b9a14522044887d88b4a8e354be4555c3346584c70e1ee8103792d864602ed957803222f9b8c352a77ea56c503953dadd32bfcadb167b59
+  data.tar.gz: 43a8e4481d98e50a662c75f04fc013b6beebf43e5ca105ef7ff2e13f4bd8d534deb51efd243df129f0c0555dfca652e676090514c91f0ad02472f4458805438e

data/README.md

@@ -18,14 +18,20 @@ Or install it yourself as:
 
 ## Usage
 
+### In your Capfile
+
+```ruby
+require 'capistrano/twelvefactor'
+```
+
 ### In your $stage.rb
 
 Set the file you want to be written to, in order to change environment
-variables. Usually this would be `.bashrc`, `/etc/environment` or something
-similar, depending on your linux OS. The default is `.bashrc`.
+variables. Usually this would be `.env`, `.bashrc`, `/etc/environment` or something
+similar, depending on your OS and app setup. The default is `.env`.
 
 ```ruby
-set :environment_file, '.bashrc'
+set :environment_file, '.custom_file'
 ```
 
 ### On your command line
@@ -33,13 +39,33 @@ set :environment_file, '.bashrc'
 #### Setting a value
 
 ```bash
-$ cap production config:set FOO=bar
+$ cap production config:set[FOO=bar]
+```
+
+**Note**: If your run zsh, you have to use quotes since square brackets are used
+for some shell features:
+
+
+```bash
+$ cap production "config:set[FOO=bar]"
 ```
 
 #### Removing a value
 
 ```bash
-$ cap production config:unset FOO
+$ cap production config:unset[FOO]
+```
+
+Same zsh workaround applies here.
+
+### Restarting your app
+
+Sometimes a change in the environment file requires a restart of your
+application. Add this to your `deploy.rb` to do so:
+
+```ruby
+after 'config:set', 'deploy:restart'
+after 'config:unset', 'deploy:restart'
 ```
 
 ## Contributing

data/lib/capistrano/twelvefactor/defaults.rb

@@ -1 +1,2 @@
-set :environment_file, '.bashrc'
+# Default value for capistrano
+set :environment_file, '.env'

data/lib/capistrano/twelvefactor/tasks/capistrano-twelvefactor.rake

@@ -4,27 +4,35 @@ namespace :config do
   end
 
   desc 'Set config value by key'
-  task :set do
-    config = Hash[[:key, :value].zip(ARGV.last.split('='))]
+  task :set, :options do |task, args|
+    config = Hash[[:key, :value].zip(args[:options].split('='))]
     cmd = Capistrano::Twelvefactor::Command.new(file_name, config)
 
     on release_roles :all do
-      execute cmd.set_command
+      if fetch(:use_sudo)
+        sudo cmd.set_command
+      else
+        execute cmd.set_command
+      end
     end
   end
 
   desc 'Remove config by key'
-  task :unset do
-    cmd = Capistrano::Twelvefactor::Command.new(file_name, key: ARGV.last)
+  task :unset, :options do |task, args|
+    cmd = Capistrano::Twelvefactor::Command.new(file_name, key: args[:options])
 
     on release_roles :all do
       begin
-        execute cmd.unset_command
-        exit 0
+        if fetch(:use_sudo)
+          sudo cmd.unset_command
+        else
+          execute cmd.unset_command
+        end
       rescue => e
-        exit 0 if e.message =~ /Nothing written/
-        error e
-        exit 1
+        unless e.message =~ /Nothing written/
+          error e
+          exit 1
+        end
       end
     end
   end

data/lib/capistrano/twelvefactor/version.rb

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

data/lib/capistrano/twelvefactor.rb

@@ -4,38 +4,64 @@ load File.expand_path('../twelvefactor/tasks/capistrano-twelvefactor.rake', __FI
 
 module Capistrano
   module Twelvefactor
+    # Wrapper for remote shell commands
     class Command
+      # Initialize new command
+      #
+      # @param [String] file filename to write config to
+      # @param [Hash] config config in the form `key: :value`
       def initialize(file, config)
         @file = file
         @config = config
       end
 
+      # Returns command to replace or append configuration
+      #
+      # @return [String]
       def set_command
         [grep_cmd, '&&', replace_cmd, '||', append_cmd].join(' ')
       end
 
+      # Returns command to remove line from configuration
+      #
+      # @return [String]
       def unset_command
         [grep_cmd, '&&', unset_cmd].join(' ')
       end
 
     private
 
+      # Returns command to grep config file for assignment
+      #
+      # @return [String]
       def grep_cmd
         sprintf 'grep -Fq "%s" %s', key_set_string, @file
       end
 
+      # Returns key assignment
+      #
+      # @return [String]
       def key_set_string
         @config[:key] + '='
       end
 
+      # Returns command to replace assignment
+      #
+      # @return [String]
       def replace_cmd
         sprintf 'sed -i "s/%s.*/%s%s/" %s', key_set_string, key_set_string, @config[:value], @file
       end
 
+      # Returns command to append assignment to config file
+      #
+      # @return [String]
       def append_cmd
         sprintf 'echo "%s%s" >> %s', key_set_string, @config[:value], @file
       end
 
+      # Returns command to remove assignment from config file
+      #
+      # @return [String]
       def unset_cmd
         sprintf 'sed -i /%s/d %s', key_set_string, @file
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-twelvefactor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mario Behrendt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler