capistrano3-env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 524b3c098df722042a4254e332e1e580a14f9afa
+  data.tar.gz: 4a33aedb2d3bec236f04d56e49a23747fdff036c
+SHA512:
+  metadata.gz: b8abba5f21ff0fba8616ef595a3189ff2b7c7f58f70a690d8cb0231f48250940f50ad90062e61dffc69c70eab08b121dd03a0f35bf09d423c331776ade0e76ce
+  data.tar.gz: 175e55a0cc994bd71856e2e78e75d3ec155816fb0ad338f6024f50a76bdfe3bbcec0d93466f053ff54949d6b83b150ed5dd59be0589a645a47a26c8ab096ac07

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License (MIT)
+
+Copyright (c) 2013, Miguel Palhas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Capistrano 3 Configuration Management
+
+## Installation
+
+Add the gem to your Gemfile
+
+    gem 'capistrano-doenv', '~> 0.1.0'
+
+Run `bundle` to update your `Gemfile.lock`
+Add the following to your `Capfile`:
+
+    require 'capistrano/env'
+
+## Usage
+
+Rake (which is used by Capistrano) has a not so pratical way of specifying task
+arguments. To alleviate that issue, a small custom executable was made:
+
+    bundle exec cap-config [stage] [operation] [KEY] [VALUE]
+
+The possible use cases are the following:
+
+    cap-env production get               # shows the current env file for
+    production
+    cap-env production set APP_ID 123456 # sets KEY=value
+    cap-env production get APP_ID        # shows the current value of KEY
+    cap-env production delete APP_ID     # deletes the given KEY
+
+Alternatively, you can use the underlying Capistrano tasks directly with `cap
+production TASK`, where `TASK` is one of the following:
+
+    env:get            # shows the current env file
+    env:get[KEY]       # KEY # shows the current value of KEY from the env file
+    env:set[KEY,value] # sets KEY=value in the env file
+    env:delete[KEY]    # deletes the given KEY
+
+
+## Configuration
+
+The following configurations are available to you in config/deploy.rb (default
+values are shown here, no need to set them)
+
+    set :config_backend, :dotenv # currently this is the only supported backend
+    set :config_file,    '.env'  # you might want to use .env.production instead
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/cap-env

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+stage, cmd, key, value = ARGV
+
+args = case cmd
+  when /create/     then nil
+  when /get|delete/ then key
+  when /set/        then "#{key},#{value}"
+end
+
+args = "[#{args}]" if args
+task = "env:#{cmd}#{args}"
+
+require 'capistrano/all'
+ARGV.clear
+ARGV << stage
+ARGV << task
+Capistrano::Application.new.run

data/capistrano3-env.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano3-env"
+  gem.version       = '0.1.0'
+  gem.authors       = ["Miguel Palhas"]
+  gem.email         = ["mpalhas@gmail.com"]
+  gem.description   = %q{Environment variables management for Capistrano 3}
+  gem.summary       = %q{Environment variables management for Capistrano 3}
+  gem.homepage      = "https://github.com/naps62/capistrano-env"
+  gem.licenses      = ['MIT']
+  gem.executables   << 'cap-env'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '~> 3.1'
+end

data/lib/capistrano/env.rb

@@ -0,0 +1,2 @@
+load File.expand_path('../tasks/env.rake', __FILE__)
+

data/lib/capistrano/tasks/env.rake

@@ -0,0 +1,89 @@
+namespace :env do
+
+  task :create do
+    on roles :app do
+      backend.create
+    end
+  end
+
+  desc 'Shows the current dotenv configuration (optional argument specifies a single key to show)'
+  task :get, [:key] do |task, args|
+    on roles :app do
+     config = backend.read
+     if args[:key]
+       config = { args[:key] => config[args[:key]] }
+     end
+     config.each do |key, val|
+       puts "#{key}: #{val}"
+     end
+    end
+  end
+
+  desc 'Sets a dotenv key to a value'
+  task :set, [:key, :val] do |task, args|
+    on roles :app do
+      config = backend.read
+      config[args[:key]] = args[:val]
+      backend.write(config)
+    end
+  end
+
+  desc 'Deletes a key from the dotenv file'
+  task :delete, [:key] do |task, args|
+    on roles :app do
+      config = backend.read
+      config.delete args[:key] if args[:key]
+      backend.write(config)
+    end
+  end
+
+  def backend
+    # TODO make this generic
+    Capistrano::Env::Backend::Dotenv.new(self)
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :config_backend, :dotenv
+    set :config_file, '.env'
+  end
+end
+
+module Capistrano
+  module Env
+    module Backend
+      class Dotenv
+        def initialize(context)
+          @context = context
+        end
+
+        def create
+          @context.execute :touch, filename
+        end
+
+        def read
+          hashify(@context.capture :cat, filename)
+        end
+
+        def write(values)
+          @context.execute :echo, "\"#{stringify(values)}\"", '>', filename
+        end
+
+        private
+
+        def filename
+          Pathname(shared_path).join(fetch(:config_file))
+        end
+
+        def hashify(string)
+          Hash[string.split("\n").map {|val| val.split(/:|\n/).map(&:strip) }]
+        end
+
+        def stringify(values)
+          values.map { |key, val| "#{key}: #{val}" }.join("\n")
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3-env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Palhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Environment variables management for Capistrano 3
+email:
+- mpalhas@gmail.com
+executables:
+- cap-env
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cap-env
+- capistrano3-env.gemspec
+- lib/capistrano/env.rb
+- lib/capistrano/tasks/env.rake
+- lib/capistrano3-env.rb
+homepage: https://github.com/naps62/capistrano-env
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Environment variables management for Capistrano 3
+test_files: []
+has_rdoc: