support .env

README.md

@@ -5,6 +5,12 @@
 # Capistrano::Env
 Capistrano with Env via file
 
+## Notice!
+
+`ruby_formatter` will deprecated at `0.2.x` and it will be removed at next version (`>= 0.3`).
+Now `dotenv_formatter` is avaiable, it create `.env` file instead of `capenv.rb` file,
+and use `dotenv` or `dotenv-rails` gem to read `.env` file.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,6 +38,7 @@ capenv.use do |env|
   end
   env.add 'UNICORN_PROCESSES'
   env.add 'HOGE', 'hage'
+  env.formatter = :dotenv #=> default is :ruby, but it is deprecated now.
 end
 ```
 
@@ -41,8 +48,8 @@ end
 bundle exec cap production deploy
 ```
 
-- automaticaly create #{current_path}/capenv.rb
-- automaticaly load #{current_path}/capenv.rb in rails boot
+- automaticaly create #{current_path}/.env
+- automaticaly load #{current_path}/.env if you use dotenv-rails
   - you should load manualy in other framework
 - you can use ENV['ENV_NAME'] in application
 

capistrano-env.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   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.post_install_message = 'formatter :ruby is deprecated! use :dotenv instead of :ruby.'
   spec.add_dependency 'rails', '>= 3.0', '< 5.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'

lib/capistrano/env.rb

@@ -3,6 +3,11 @@
 module Capistrano
   module Env
     module Formatter
+      class Base
+        def self.filename
+          "capenv.#{extname}"
+        end
+      end
     end
   end
 end

lib/capistrano/env/config.rb

@@ -4,11 +4,20 @@ class Config
       attr_accessor :formatter
 
       def initialize
-        @formatter = :ruby
         @values = {}
         @keys = []
       end
 
+      def formatter
+        self.formatter = :ruby unless @formatter
+        @formatter
+      end
+
+      def formatter=(value)
+        warn 'formatter :ruby is deprecated! use :dotenv with dotenv(-rails).gem' if value == :ruby
+        @formatter = value
+      end
+
       def add(name_or_regexp, val = nil, &block)
         if val && name_or_regexp.is_a?(String)
           @values[name_or_regexp] = val
@@ -19,7 +28,7 @@ def add(name_or_regexp, val = nil, &block)
 
       def formatter_class
         @formatter_class ||= begin
-                               require "capistrano/env/formatter/#{@formatter}_formatter"
+                               require "capistrano/env/formatter/#{formatter}_formatter"
                                Capistrano::Env::Formatter.const_get "#{formatter.capitalize}Formatter"
                              end
       end
@@ -35,7 +44,7 @@ def envs
       end
 
       def capenv_file
-        "capenv.#{formatter_class.file_ext}"
+        formatter_class.filename
       end
 
       def capenv_content

lib/capistrano/env/formatter/dotenv_formatter.rb

@@ -0,0 +1,15 @@
+module Capistrano
+  module Env
+    module Formatter
+      class DotenvFormatter
+        def self.filename
+          '.env'
+        end
+
+        def self.format(envs)
+          envs.map { |k, v| "#{k}=\"#{v}\"\n" }.join
+        end
+      end
+    end
+  end
+end

lib/capistrano/env/formatter/ruby_formatter.rb

@@ -1,8 +1,8 @@
 module Capistrano
   module Env
     module Formatter
-      class RubyFormatter
-        def self.file_ext
+      class RubyFormatter < Base
+        def self.extname
           'rb'
         end
 

lib/capistrano/env/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Env
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

spec/capistrano/env/formatter/dotenv_formatter_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'capistrano/env/formatter/dotenv_formatter'
+
+describe Capistrano::Env::Formatter::DotenvFormatter do
+  let(:envs) { { 'HELLO' => 'WORLD', 'HOGE' => '1,2,3' } }
+  expect_string = <<EOF
+HELLO="WORLD"
+HOGE="1,2,3"
+EOF
+  it { expect(described_class.format(envs)).to eq expect_string }
+  it { expect(described_class.filename).to eq '.env' }
+end

spec/capistrano/env/formatter/ruby_formatter_spec.rb

@@ -8,4 +8,5 @@
 ENV["HOGE"] = "1,2,3"
 EOF
   it { expect(described_class.format(envs)).to eq expect_string }
+  it { expect(described_class.filename).to eq 'capenv.rb' }
 end