capistrano-dotenv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11fe5a7213474a84d17cab3ae2adb6a6bd564b9a
+  data.tar.gz: 042e5d9f370e6f54e588e1501dcfc1dc6d519131
+SHA512:
+  metadata.gz: 02719c7430315ce14de5db4669daafb5980497cfaa72189ad815abb7fcaeea45140f5f703539fe9bb66a4ad3a1bb86d11340517cfe26dfed431cd9f783659057
+  data.tar.gz: 863dbfcf1543797eec8bc954f1e4fb79b48aad2a1fd18ad393c25d29aee20da8decbf2e0e5a7253ccfd0630090fc82a0793182df21c39bee4cdbc4ca46af4b55

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-dotenv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 João Paulo Lethier
+
+MIT License
+
+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,82 @@
+[![Gem Version](https://img.shields.io/gem/v/capistrano-dotenv.svg)](https://rubygems.org/gems/capistrano-dotenv)
+[![Dependencies](https://img.shields.io/gemnasium/jplethier/capistrano-dotenv.svg)](https://gemnasium.com/jplethier/capistrano-dotenv)
+[![Code Climate](https://img.shields.io/codeclimate/github/jplethier/capistrano-dotenv.svg)](https://codeclimate.com/github/jplethier/capistrano-dotenv)
+
+
+# Capistrano::Dotenv
+
+Capitranos tasks to setup and check env vars using dotenv
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-dotenv', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-dotenv
+
+
+## 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
+
+## Options
+
+### Env file
+
+Use differents env files for each environment
+
+```ruby
+set :env_file, ".env_#{stage}"
+```
+
+Or use the same file for every environment(default)
+
+```ruby
+set :env_file, '.env'
+```
+
+### 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
+
+```ruby
+set :optional_env_vars, %w(OPTIONAL_VAR1 OPTIONAL_VAR2)
+```
+
+### Ignored env vars
+
+There are project env vars needed only for test or development environment, so those vars need to be ignored when you are deploying the project
+
+```ruby
+set :ignored_env_vars, %w(IGNORED_VAR1 IGNORED_VAR2)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jplethier/capistrano-dotenv.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/capistrano-dotenv.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/dotenv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-dotenv'
+  spec.version       = Capistrano::Dotenv::VERSION
+  spec.authors       = ['João Paulo Lethier']
+  spec.email         = ['jplethier@gmail.com']
+  spec.description   = %q{Dotenv tasks for capistrano deployment}
+  spec.summary       = %q{Dotenv tasks for capistrano deployment}
+  spec.homepage      = 'https://github.com/jplethier/capistrano-dotenv'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano',         '>= 3.5.0', '< 4.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/dotenv/env_extractor.rb

@@ -0,0 +1,34 @@
+class EnvExtractor
+  def extensions
+    %w(ru thor rake rb yml ruby yaml erb builder markerb haml)
+  end
+
+  def extract_env_vars(globs = '*')
+    results = Hash.new { |hash, key| hash[key] = [] }
+
+    Array(globs).each do |glob|
+      Dir.glob(glob).each do |item|
+        next if File.basename(item)[0] == ?.
+
+        if File.directory?(item)
+          results.merge!(extract_env_vars("#{item}/*"))
+        else
+          next unless extensions.detect {|ext| File.extname(item)[ext] }
+          File.readlines(item).each_with_index do |line, ix|
+            capture_variables(line).each do |variable|
+              results[variable] << { :path => item, :line => ix.succ }
+            end
+          end
+        end
+      end
+    end
+
+    results
+  end
+
+  private
+
+  def capture_variables(line)
+    line.scan(/ENV(?:\[|\.fetch\()['"]([^'"]+)['"]/).flatten
+  end
+end

data/lib/capistrano/dotenv/tasks.cap

@@ -0,0 +1,68 @@
+require 'env_extractor'
+
+namespace :dotenv do
+  task :check do
+    env_vars = fetch(:env_vars)
+
+    OPTIONAL_VARS = fetch(:optional_env_vars, [])#%w(SEGMENT_KEY GTM_CODE RAILS_SERVE_STATIC_FILES ASSETS_VERSION)
+    IGNORED_VARS = fetch(:ignored_env_vars, [])#%w(BUNDLE_GEMFILE DB_REAPING_FREQUENCY CI CIRCLE_ARTIFACTS COVERAGE FB_SECRET)
+
+    missing_vars = []
+    optional_vars = []
+    EnvExtractor.extract_env_vars.each do |ocurrence|
+      next if env_vars.include?(ocurrence[0])
+      next if IGNORED_VARS.include?(ocurrence[0])
+
+      if OPTIONAL_VARS.include?(ocurrence[0])
+        optional_vars << ocurrence[0]
+      else
+        missing_vars << ocurrence[0]
+      end
+    end
+
+    fail "You must set a value for env vars:\n#{missing_vars.join("\n")}" if missing_vars.size > 0
+
+    if optional_vars.size > 0
+      puts "You have optional env vars that is not defined:\n#{optional_vars.join("\n")}"
+      ask(:continue, "Continue?(Yn)")
+      continue = fetch(:continue)
+
+      fail 'User abort for missing env vars value' if continue.downcase == 'n'
+    end
+  end
+
+  task :setup do
+    dotenv_contents = fetch(:dotenv_contents)
+
+    dotenv = StringIO.new
+    dotenv << dotenv_contents
+    dotenv.rewind
+
+    upload! dotenv, File.join(shared_path, '.env')
+  end
+
+  task :read do
+    env_file = fetch(:env_file, '.env')
+    dotenv_contents = ''
+
+    run_locally do
+      fail "You must have a #{env_file} file on your project " \
+           'to be able to deploy it' unless File.exist?(env_file)
+
+      if env_file.match(/\.gpg$/)
+        dotenv_contents = `bundle exec dotgpg cat #{env_file}`
+      else
+        dotenv_contents = `cat #{env_file}`
+      end
+    end
+
+    set :env_vars, dotenv_contents.split("\n").map { |var| var.split('=')[0] }
+    set :dotenv_contents, dotenv_contents
+  end
+
+  task :config do
+    set :optional_vars, ENV.fetch('OPTIONAL_VARS', [])
+    set :ignored_vars, ENV.fetch('IGNORED_VARS', [])
+    set :extensions, -> { ENV.fetch('OPTIONAL_VARS', []) }
+  end
+end

data/lib/capistrano/dotenv/version.rb

@@ -0,0 +1,8 @@
+# Capistrano
+module Capistrano
+  # Dotenv
+  module Dotenv
+    # Gem version
+    VERSION = '0.0.1'
+  end
+end

data/lib/capistrano/dotenv.rb

@@ -0,0 +1,3 @@
+require 'capistrano/dotenv/version'
+
+load File.expand_path('../dotenv/tasks.cap', __FILE__)

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-dotenv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- João Paulo Lethier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: Dotenv tasks for capistrano deployment
+email:
+- jplethier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- capistrano-dotenv.gemspec
+- lib/capistrano-dotenv.rb
+- lib/capistrano/dotenv.rb
+- lib/capistrano/dotenv/env_extractor.rb
+- lib/capistrano/dotenv/tasks.cap
+- lib/capistrano/dotenv/version.rb
+homepage: https://github.com/jplethier/capistrano-dotenv
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Dotenv tasks for capistrano deployment
+test_files: []