capistrano-dotenv 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 96946aa2407b74c6dcaef0287f3ed24e1229eadf
-  data.tar.gz: 58813f8093d3a73cf866f461b51b924cf8cd76e7
+SHA256:
+  metadata.gz: dced089659d848dc1a8e6d81bd63d2c8b3f2439086cd474555b4cd18bb40eac2
+  data.tar.gz: dfa4aad24ef71a2d267a28e930a906e05eebc991f0fc6f4f709fe18d48c8bc27
 SHA512:
-  metadata.gz: 00ef981dda708890a2fb99b9579d7c9a1562ca6c4855944fab17208d2bf1fdfc0505c7b3b4372bbf305a3627b40ce10d6967812b81fbf33309d4711859a8691b
-  data.tar.gz: d2fccdfffc9d85cf485c4df364e70f81a447c6f7226fd0496c71c27fc8bd95131fc2c010b9759cc5c50ef8ed81fc7bcdfec284b55d3bf98a6239bdb605fdd657
+  metadata.gz: 99a062d875d6de56a95d469d6278b08e21c1177b304c9ebd5ffd806aed4bf8388d5e0d7720c2aed5cb9ff9ea32580feec9893213e61ebcc9353f105ec99a3bb2
+  data.tar.gz: cdef63a1d40118e2c737e5c1a94dee3b5a8a594e73fe7fe545e51726a514b8cbb9c37acd549414808c70d88505f6e0ad15409cc674ef60c12b6587368d25df88

data/README.md

@@ -26,18 +26,35 @@ Or install it yourself as:
 
 ## Usage
 
-You should ensure there is a `rails` binstub in the `current/bin` directory on the server otherwise
-this gem won't work (because rails itself won't work).
-If you experience any problems please verify that manually running `rails console` on the server does work.
-If it doesn't you are deploying your rails application wrong (check [#18](https://github.com/ydkn/capistrano-rails-console/issues/18) or [#26](https://github.com/ydkn/capistrano-rails-console/issues/26) for details)!
-
 Require in `Capfile`:
 
 ```ruby
 require 'capistrano/dotenv'
 ```
 
-TODO: adds examples how to use
+To check and ensure that deploy contains invoke both `dotenv:read` and `dotenv:check` tasks before to invoke `dotenv:setup`
+
+```ruby
+invoke 'dotenv:read'
+invoke 'dotenv:check'
+invoke 'dotenv:setup'
+```
+
+If you do not want to check, invoke only `dotenv:read` and `dotenv:setup` to just read and upload the env vars
+
+```ruby
+invoke 'dotenv:read'
+invoke 'dotenv:setup'
+```
+
+If you want to auto prefix `dotenv` to yout `bundle`/`ruby`/`gem`/`rake` commands, add `dotenv:hook` to your invokes.
+
+```ruby
+invoke 'dotenv:read'
+invoke 'dotenv:check'
+invoke 'dotenv:setup'
+invoke 'dotenv:hook'
+```
 
 ## Options
 
@@ -55,6 +72,12 @@ Or use the same file for every environment(default)
 set :env_file, '.env'
 ```
 
+If you use [dotgpg](https://github.com/ConradIrwin/dotgpg) to secure your env vars on git, just set the env_file passing the gpg file, and it will ask your gpg password and read it from gpg file correctly. For example:
+
+```ruby
+set :env_file, ".env_#{stage}.gpg"
+```
+
 ### Optional env vars
 
 There are env vars that you want to set only in some enviroments or you will use a default value if it is not defined, so it is not required to be set a value for them. To be able to run check without fail the deployment if those env vars do not have a value set, just set it as optional
@@ -79,6 +102,20 @@ By default, the setup task will upload generated .env file to all roles(:all), b
 set :dotenv_roles, :app
 ```
 
+### Hook
+
+By default, `dotenv:hook` will work on `bundle`, `ruby`, `gem` and `rake`. You can change this setting `dotenv_hook_commands`.
+
+```ruby
+set :dotenv_hook_commands, %w(bundle ruby gem rake my_custom_command)
+```
+
+By default, `dotenv:hook` will add the `dotenv` prefix before the commands. You can change this setting `dotenv_hook_prefix`.
+
+```ruby
+set :dotenv_hook_prefix, 'dotenv -f ".my_custom_env_file"'
+```
+
 
 ## Contributing
 

data/lib/capistrano/dotenv/tasks.cap

@@ -34,15 +34,22 @@ namespace :dotenv do
   task :setup do
     dotenv_contents = fetch(:dotenv_contents)
 
-    dotenv = StringIO.new
-    dotenv << dotenv_contents
-    dotenv.rewind
-
     on roles(fetch(:dotenv_roles, :all)) do
+      dotenv = StringIO.new(dotenv_contents)
+
       upload! dotenv, File.join(shared_path, '.env')
     end
   end
 
+  task :hook do
+    commands = fetch(:dotenv_hook_commands, %w{gem rake ruby bundle})
+    hook_prefix = fetch(:dotenv_hook_prefix, 'dotenv')
+
+    commands.each do |command|
+      SSHKit.config.command_map.prefix[command.to_sym].append(hook_prefix)
+    end
+  end
+
   task :read do
     env_file = fetch(:env_file, '.env')
     dotenv_contents = ''

data/lib/capistrano/dotenv/version.rb

@@ -3,6 +3,6 @@ module Capistrano
   # Dotenv
   module Dotenv
     # Gem version
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-dotenv
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - João Paulo Lethier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -94,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Dotenv tasks for capistrano deployment