capistrano-env_config 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d9ecd854065ec9fa3cc2d99fe6f3d0cd1be82b8
-  data.tar.gz: 17d48b6067c3795bd28f21e2a31091a4e24607fc
+  metadata.gz: 2dec343550dfd2b3654978a89e53149fa139ca27
+  data.tar.gz: 26058a4ef80721f3c3cdbdfc5b57b306140abed8
 SHA512:
-  metadata.gz: b2d0978e01919ac08ddd9591da3987249ae420d14c87872f36a302e7358c1283a0c6aaffdcc1724f5b1e98df9a492dbf129eb54d7d60470bfb909c99a536a499
-  data.tar.gz: 8b48884c0e9c11757d3e1155b75abf53e3cc2881221fba45faa051bf811a40fa230a35fce9a86ed52d56cb3da925b15b248452f146979584ad9efa9d63536ac1
+  metadata.gz: af3c204fb185a1bbb94918962f6643e67c999e6788f2920c32c0d34986fcd4f949d4ff3e4f37ce28b47bd9e8938a4088e7e04e534ecdf27fda5a362a24574b57
+  data.tar.gz: ca1260e663d042e711b692901367768ab880e601b2d2907d06dc98fff0f1ecbba4173a3f3e69990721556680b662c8d758e0186f55c3ccf0def392f36f546c52

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+v0.0.2
+------
+
+* Removed development dependency on `gem 'rake'`
+* Improved gem description. Added documentation about programatic use.
+* Added configuration option for roles that env_config sets/reads the
+    environment variables from.
+* Added an argument for specifically setting roles when using the `Environment`
+    class programatically.
+
+
+v0.0.1
+------
+
+* Initial version.

data/README.md

@@ -1,7 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/capistrano-env_config.svg)](https://badge.fury.io/rb/capistrano-env_config)
+
 capistrano-env_config
 =====================
 
-A tool for managing your environment variables across your cluster.
+A tool for managing your environment variables across your cluster. The library
+manipulates the system-wide environment variables by modifying the
+`/etc/environment` file.
 
 Usage
 -----
@@ -12,9 +16,31 @@ Usage
 * `cap env:set[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
+`Capistrano::EnvConfig::Environment` class like so:
+
+```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
+```
+
 Installation
 ------------
 
+Add the gem to your Gemfile:
+
+```gemfile
+group :development do
+  gem 'capistrano-env_config'
+end
+```
+
 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.
 
@@ -23,4 +49,12 @@ The simplest way to do that would be to:
 ```bash
 chown :deploy /etc/environment
 chmod g+w /etc/environment
-```
+```
+
+License
+-------
+
+Copyright Itay Grudev (c) 2017.
+
+This gem and all associated documentation is distributed under the terms of the
+GNU GPL v3 license.

data/capistrano-env_config.gemspec

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-lib = File.expand_path( '../lib', __FILE__ )
-$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
-
 require 'capistrano/env_config/version'
 
 Gem::Specification.new do |spec|
@@ -11,12 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors     = [ 'Itay Grudev' ]
   spec.email       = [ 'itay+capistrano-env_config+github.com[]grudev.com' ]
   spec.homepage    = 'https://github.com/itay-grudev/capistrano-env_config'
+  spec.license     = 'GPL-3.0'
   spec.summary     = 'A tool for managing your environment variables across your cluster.'
-  spec.description = <<-EOF
+  spec.description = <<-EOF.gsub(/^\s+/, '')
     EnvConfig is a tool for setting and syncing environment variables across
-    your the servers in your cluster with a few simple Capistrano tasks.}
+    your the servers in your cluster with a few simple Capistrano tasks. The
+    library manipulates the system-wide environment variables by modifying the
+    `/etc/environment` file.
   EOF
-  spec.license     = 'GPL-3.0'
 
   spec.rubyforge_project = 'capistrano-env_config'
 
@@ -24,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = [ 'lib' ]
 
   spec.required_ruby_version = '>= 1.9.3'
-  spec.add_dependency 'capistrano', '~> 3.1'
+
+  spec.add_dependency 'capistrano', '~> 3.7'
 
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'simplecov', '~> 0.14'
-  spec.add_development_dependency 'rake'
 end

data/lib/capistrano/env_config.rb

@@ -1 +1,19 @@
-load File.expand_path( '../tasks/env_config.rake', __FILE__ )
+require 'capistrano/plugin'
+
+module Capistrano
+  class EnvConfig < Capistrano::Plugin
+
+    def define_tasks
+      eval_rakefile File.expand_path( '../tasks/env_config.rake', __FILE__ )
+    end
+
+    def set_defaults
+      set_if_empty :env_config_roles, :all
+    end
+  end
+end
+
+install_plugin Capistrano::EnvConfig
+
+require 'capistrano/env_config/environment'
+require 'capistrano/env_config/version'

data/lib/capistrano/env_config/environment.rb

@@ -1,57 +1,56 @@
 module Capistrano
-  module EnvConfig
-    class Environment
-      class KeyNotSpecified < RuntimeError; end
-
-      BLANK_RE = /\A[[:space:]]*\z/
-
-      def initialize
-        variables = { }
-
-        # Acquire all configuration variables and store them in a dictionary (hash)
-        on roles( :all ) do
-          output = capture( 'cat /etc/environment' )
-          output.each_line do |line|
-            captures = line.match( /\s*([A-Z_][A-Z0-9_]*)=(.*)/ )
-            if captures&.length == 3
-              variables[ captures[1] ] = captures[2]
-            end
+  class EnvConfig::Environment
+    class KeyNotSpecified < RuntimeError; end
+
+    BLANK_RE = /\A[[:space:]]*\z/
+
+    def initialize( roles = fetch( :env_config_roles ) )
+      variables = { }
+
+      # Acquire all configuration variables and store them in a dictionary (hash)
+      on roles( roles ) do
+        output = capture( 'cat /etc/environment' )
+        output.each_line do |line|
+          captures = line.match( /\s*([A-Z_][A-Z0-9_]*)=(.*)/ )
+          if captures&.length == 3
+            variables[ captures[1] ] = captures[2]
           end
         end
-        @variables = variables
       end
 
-      def get( key )
-        raise KeyNotSpecified.new if BLANK_RE === key
-        return @variables[ key.to_s.upcase ]
-      end
+      @variables = variables
+    end
 
-      def list
-        @variables
-      end
+    def get( key )
+      raise KeyNotSpecified.new if BLANK_RE === key
+      return @variables[ key.to_s.upcase ]
+    end
 
-      def set( key, value )
-        raise KeyNotSpecified.new if BLANK_RE === key
-        @variables[ key.to_s.upcase ] = value.to_s
-      end
+    def list
+      @variables
+    end
 
-      def delete( key )
-        raise KeyNotSpecified.new if BLANK_RE === key
-        @variables.delete( key.to_s.upcase )
-      end
+    def set( key, value )
+      raise KeyNotSpecified.new if BLANK_RE === key
+      @variables[ key.to_s.upcase ] = value.to_s
+    end
 
-      def sync
-        # Concatenate all variables and output them in the appropariate format
-        environment = ''
-        @variables.each do |key, value|
-          environment += "#{key.upcase}=#{value}\n"
-        end
+    def delete( key )
+      raise KeyNotSpecified.new if BLANK_RE === key
+      @variables.delete( key.to_s.upcase )
+    end
 
-        # Upload the variables to all servers
-        on roles( :all ) do
-          contents = StringIO.new( environment, 'r' )
-          upload! contents, '/etc/environment'
-        end
+    def sync( roles = fetch( :env_config_roles ) )
+      # Concatenate all variables and output them in the appropariate format
+      environment = ''
+      @variables.each do |key, value|
+        environment += "#{key.upcase}=#{value}\n"
+      end
+
+      # Upload the variables to all servers
+      on roles( roles ) do
+        contents = StringIO.new( environment, 'r' )
+        upload! contents, '/etc/environment'
       end
     end
   end

data/lib/capistrano/env_config/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-env_config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Itay Grudev
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,23 +52,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: |2
-      EnvConfig is a tool for setting and syncing environment variables across
-      your the servers in your cluster with a few simple Capistrano tasks.}
+description: |
+  EnvConfig is a tool for setting and syncing environment variables across
+  your the servers in your cluster with a few simple Capistrano tasks. The
+  library manipulates the system-wide environment variables by modifying the
+  `/etc/environment` file.
 email:
 - itay+capistrano-env_config+github.com[]grudev.com
 executables: []
@@ -76,6 +64,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE