capistrano-env_config 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dec343550dfd2b3654978a89e53149fa139ca27
-  data.tar.gz: 26058a4ef80721f3c3cdbdfc5b57b306140abed8
+  metadata.gz: 454e578c8df69f1d96d4a40af745ff98851cb0d3
+  data.tar.gz: 20b0f51bc9b841657a427f486d4fd547bb187bc2
 SHA512:
-  metadata.gz: af3c204fb185a1bbb94918962f6643e67c999e6788f2920c32c0d34986fcd4f949d4ff3e4f37ce28b47bd9e8938a4088e7e04e534ecdf27fda5a362a24574b57
-  data.tar.gz: ca1260e663d042e711b692901367768ab880e601b2d2907d06dc98fff0f1ecbba4173a3f3e69990721556680b662c8d758e0186f55c3ccf0def392f36f546c52
+  metadata.gz: 8d818244b23cf883f33832537bbeffdb485e64cd1bc652953754c6846be0a3c926c0c1ad4e3f32155c83143c07ecd54fa668fa2db1b51cf8a1e53428b13341b4
+  data.tar.gz: 90d158945825fd34a1f4612f6594b937279449994015b12e18bf2837e3d36ef8497f4a454b2db4b4f8ddcb6eafdb1d6ea90bfa5c90289560647dc312d4ec8450

data/CHANGELOG.md

@@ -7,7 +7,8 @@ v0.0.2
     environment variables from.
 * Added an argument for specifically setting roles when using the `Environment`
     class programatically.
-
+* Note: Implemented using the potentially unstable and subject to change
+    `Capistrano::Plugin` API.
 
 v0.0.1
 ------

data/README.md

@@ -11,9 +11,9 @@ Usage
 -----
 
 * `cap env:list` – To list current environment configuration
-* `cap env:get[VARIABLE_NAME]` – To get the value of specific variable
-* `cap env:unset[VARIABLE_NAME]` – To delete an environment variable
-* `cap env:set[VARIABLE_NAME=VALUE]` – To set an environment variable
+* `cap env:get[VARIABLE_NAME,VARIABLE_NAME]` – To get the value of specific variable
+* `cap env:unset[VARIABLE_NAME,VARIABLE_NAME]` – To delete an environment variable
+* `cap env:set[VARIABLE_NAME=VALUE,VARIABLE_NAME=VALUE]` – To set an environment variable
 * `cap env:sync` – To synchronise the environment configuration across servers
 
 If you need to programatically manipulate the environment you can use the
@@ -22,25 +22,46 @@ If you need to programatically manipulate the environment you can use the
 ```ruby
 require 'capistrano/env_config/environment'
 
-environment = Capistrano::EnvConfig::Environment.new
-environment.list
-environment.get( 'VARIABLE' )
-environment.set( 'VARIABLE', 'VALUE' )
-environment.delete( 'VARIABLE' )
-environment.sync
+environment = Capistrano::EnvConfig::Environment.new # Reads and loads /etc/environment from all servers
+environment.list # Returns a hash of all environment variables
+environment.get( 'VARIABLE' ) # Gets a variable by name
+environment.set( 'VARIABLE', 'VALUE' ) # Sets a variable
+environment.delete( 'VARIABLE' ) # Deletes a variable
+environment.sync # Uploads current confifuration to all servers
+```
+
+By default capistrano sets and reads the `/etc/environment` of all roles. This
+behaviour can be changed by setting:
+
+```ruby
+set :env_config_roles, [ :web, :app ]
+```
+
+The `new` and `sync` methods also accept an optional argument for specifying
+roles explicitly (overriding the value set in `:env_config_roles`):
+
+```ruby
+environment.list( :app )
+environment.sync( [ :web, :app ] )
 ```
 
 Installation
 ------------
 
-Add the gem to your Gemfile:
+Add the gem to your `Gemfile`:
 
-```gemfile
+```ruby
 group :development do
   gem 'capistrano-env_config'
 end
 ```
 
+And the following line to your `Capfile`:
+
+```ruby
+require 'capistrano/env_config'
+```
+
 In your server provisioning script, make sure the deploy user has write access
 to the `/etc/environment` file, which is used to store the configured variables.
 
@@ -57,4 +78,4 @@ License
 Copyright Itay Grudev (c) 2017.
 
 This gem and all associated documentation is distributed under the terms of the
-GNU GPL v3 license.
+GNU GPL v3 license.

data/capistrano-env_config.gemspec

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'capistrano/env_config/version'
+require_relative 'lib/capistrano/env_config/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'capistrano-env_config'
@@ -28,4 +28,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'simplecov', '~> 0.14'
-end
+end

data/lib/capistrano-env_config.rb

@@ -1,2 +1,2 @@
-require 'capistrano/env_config/version'
-require 'capistrano/env_config/environment'
+require_relative 'capistrano/env_config/version'
+require_relative 'capistrano/env_config/environment'

data/lib/capistrano/env_config.rb

@@ -15,5 +15,5 @@ end
 
 install_plugin Capistrano::EnvConfig
 
-require 'capistrano/env_config/environment'
-require 'capistrano/env_config/version'
+require_relative 'env_config/environment'
+require_relative 'env_config/version'

data/lib/capistrano/env_config/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   class EnvConfig
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/capistrano/tasks/env_config.rake

@@ -1,4 +1,5 @@
-require 'capistrano/env_config/environment'
+require 'byebug'
+require_relative '../env_config/environment'
 
 namespace :env do
   desc 'Lists the environment variables set across servers'
@@ -16,33 +17,39 @@ namespace :env do
   end
 
   desc 'Sets an environment variable'
-  task :set, :variable do |task, args|
-    abort 'No key-value pair specified.' if args[:variable].nil?
-    key, value = args[:variable].split( '=', 2 )
+  task :set do |task, args|
+    abort 'No key-value pair specified.' if args.extras.empty?
     environment = Capistrano::EnvConfig::Environment.new
-    environment.set( key, value )
+    args.extras.each do |variable|
+      key, value = variable.split( '=', 2 )
+      environment.set( key, value )
+    end
     environment.sync
   end
 
   desc 'Prints an environment variable'
-  task :get, :variable do |task, args|
+  task :get do |task, args|
     environment = Capistrano::EnvConfig::Environment.new
-    variable = environment.get( args[:variable] )
-    if variable.nil?
-      abort "No such variable: #{args[:variable].upcase}"
-    else
-      puts "#{args[:variable].upcase}=#{variable}"
+    args.extras.each do |variable|
+      value = environment.get( variable )
+      if value.nil?
+        STDERR.puts "No such variable: #{variable.upcase}"
+      else
+        puts "#{variable.upcase}=#{value}"
+      end
     end
   end
 
   desc 'Removes a environment variable'
-  task :unset, :variable do |task, args|
+  task :unset do |task, args|
     environment = Capistrano::EnvConfig::Environment.new
-    if environment.get( args[:variable].upcase ).nil?
-      abort "No such variable: #{args[:variable].upcase}"
-    else
-      environment.delete( args[:variable].upcase )
-      environment.sync
+    args.extras.each do |variable|
+      if environment.get( variable.upcase ).nil?
+        abort "No such variable: #{variable.upcase}"
+      else
+        environment.delete( variable.upcase )
+      end
     end
+    environment.sync
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-env_config
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Itay Grudev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano