dotenv 0.7.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGMzMjQ2MDFjM2IyMDFiOGVmYzU3ZmJjNWZhYmRlNTFlYWU1MTVjYg==
+  data.tar.gz: !binary |-
+    MzIwNjhlMGQ3NGFlNWQxMTQzMDM1MDRiNjAwMTQ4Y2UzOTFhMDBjNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDQ1MzM1YTlhMGVmYjgyYTc3ZDY1ZDExMjY3NTRkNzhjMmNhMmY0OWViNTVj
+    YmRkMWZlNTJlMDMyOGEwMDdkNjg2OTJjZTA2MmFlMzRjMzY5ZmQ5M2QwMjdj
+    MGQ5NDdlMDNmY2M4ZWZhMGNjNGYxZDc3YmUzYTMwOWRmZWMzYzE=
+  data.tar.gz: !binary |-
+    ZDVjZGMyMWJmYmNkZmYyZDE0YWZiNTc2YzllMzc4OTcyZDk5MjM2ZDE4YWJh
+    YjhiZTZlZDJlYzAwMGEzYzMzMDhkZmMzZDMzMDkwNzNkN2E3OGEyMjMxZDE0
+    MzUzZjRjMDlmZGY0MTlhMWY5MDJmOTE3ZDVmNGI4NDJiZjI0NzA=

data/.gitignore

@@ -5,3 +5,4 @@
 .yardoc
 Gemfile.lock
 tmp
+vendor

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
-  - 1.9.2
   - 1.8.7
-  - ree
+  - ree

data/Changelog.md

@@ -1,11 +1,25 @@
 # Changelog
 
+## 0.8.0 - June 12, 2013
+
+* Added a capistrano recipe to symlink in `.env` on deploy.
+
+* Allow inline comments
+
+    VARIABLE=value # this is a comment
+
+* Raises Dotenv::FormatError when parsing fails
+
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.7.0...v0.8.0)
+
 ## 0.7.0 - April 15, 2013
 
 * Remove deprectated autoloading. Upgrade to 0.6 first and fix any warnings.
 
 * Add Dotenv.load! which raises Errno::ENOENT if the file does not exist
 
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.6.0...v0.7.0)
+
 ## 0.6.0 - Mar 22, 2013
 
 * Add dotenv-rails gem for autoloading in a Rails app

data/README.md

@@ -1,8 +1,10 @@
 # dotenv [![Build Status](https://secure.travis-ci.org/bkeepers/dotenv.png)](https://travis-ci.org/bkeepers/dotenv)
 
-Loads environment variables from `.env` into `ENV`, automagically.
+Dotenv loads environment variables from `.env` into `ENV`.
 
-Read more about the [motivation for dotenv at opensoul.org](http://opensoul.org/blog/archives/2012/07/24/dotenv/).
+Storing [configuration in the environment](http://www.12factor.net/config) is one of the tenets of a [twelve-factor app](http://www.12factor.net/). Anything that is likely to change between deployment environments–such as resource handles for databases or credentials for external services–should be extracted from the code into environment variables.
+
+But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a `.env` file into ENV when the environment is bootstrapped.
 
 ## Installation
 
@@ -43,15 +45,14 @@ end
 
 ## Usage
 
-Add your application configuration to your `.env` file in the root of
-your project:
+Add your application configuration to your `.env` file in the root of your project:
 
 ```shell
 S3_BUCKET=YOURS3BUCKET
 SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
-You can also create files per environment, such as `.env.test`:
+You can also create files per environment, such as `.env.test`.
 
 ```shell
 S3_BUCKET=tests3bucket
@@ -71,6 +72,20 @@ Whenever your application loads, these variables will be available in `ENV`:
 config.fog_directory  = ENV['S3_BUCKET']
 ```
 
+## Capistrano integration
+
+In your `config/deploy.rb` file:
+
+```ruby
+require "dotenv/capistrano"
+```
+
+It will symlink the `.env` located in `/path/to/shared` in the new release.
+
+## Should I commit my .env file?
+
+It is recommended that you store development-only settings in your `.env` file, and commit it to your repository. Make sure that all your credentials for your development environment are different from your other deployments. This makes it easy for other developers to get started on your project, without compromising your credentials for other environments.
+
 ## Contributing
 
 1. Fork it

data/lib/dotenv.rb

@@ -3,6 +3,7 @@ require 'dotenv/environment'
 module Dotenv
   def self.load(*filenames)
     default_if_empty(filenames).inject({}) do |hash, filename|
+      filename = File.expand_path filename
       hash.merge(File.exists?(filename) ? Environment.new(filename).apply : {})
     end
   end
@@ -11,6 +12,7 @@ module Dotenv
   def self.load!(*filenames)
     load(
       *default_if_empty(filenames).each do |filename|
+        filename = File.expand_path filename
         raise(Errno::ENOENT.new(filename)) unless File.exists?(filename)
       end
     )

data/lib/dotenv/capistrano.rb

@@ -0,0 +1,5 @@
+require 'dotenv/capistrano/recipes'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  before "deploy:finalize_update", "dotenv:symlink"
+end

data/lib/dotenv/capistrano/recipes.rb

@@ -0,0 +1,10 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  _cset(:dotenv_path){ "#{shared_path}/.env" }
+
+  namespace :dotenv do
+    desc "Symlink shared .env to current release"
+    task :symlink, roles: :app do
+      run "ln -nfs #{dotenv_path} #{release_path}/.env"
+    end
+  end
+end

data/lib/dotenv/environment.rb

@@ -1,5 +1,23 @@
+require 'dotenv/format_error'
+
 module Dotenv
   class Environment < Hash
+    LINE = /
+      \A
+      (?:export\s+)?    # optional export
+      ([\w\.]+)         # key
+      (?:\s*=\s*|:\s+?) # separator
+      (                 # value begin
+        '(?:\'|[^'])*'  #   single quoted value
+        |               #   or
+        "(?:\"|[^"])*"  #   double quoted value
+        |               #   or
+        [^#\n]+         #   unquoted value
+      )                 # value end
+      (?:\s*\#.*)?      # optional comment
+      \z
+    /x
+
     def initialize(filename)
       @filename = filename
       load
@@ -7,15 +25,13 @@ module Dotenv
 
     def load
       read.each do |line|
-        if line =~ /\A(?:export\s+)?(\w+)(?:=|: ?)(.*)\z/
-          key = $1
-          case val = $2
-          # Remove single quotes
-          when /\A'(.*)'\z/ then self[key] = $1
-          # Remove double quotes and unescape string preserving newline characters
-          when /\A"(.*)"\z/ then self[key] = $1.gsub('\n', "\n").gsub(/\\(.)/, '\1')
-          else self[key] = val
-          end
+        if match = line.match(LINE)
+          key, value = match.captures
+          value = value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
+          value = value.gsub('\n', "\n").gsub(/\\(.)/, '\1') if $1 == '"'
+          self[key] = value
+        elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
+          raise FormatError, "Line #{line.inspect} doesn't match format"
         end
       end
     end

data/lib/dotenv/format_error.rb

@@ -0,0 +1,4 @@
+module Dotenv
+  class FormatError < SyntaxError
+  end
+end

data/lib/dotenv/railtie.rb

@@ -2,8 +2,6 @@ require 'dotenv'
 
 module Dotenv
   class Railtie < Rails::Railtie
-    include Rake::DSL if defined?(Rake)
-
     rake_tasks do
       desc 'Load environment settings from .env'
       task :dotenv do

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/spec/dotenv/environment_spec.rb

@@ -30,31 +30,69 @@ describe Dotenv::Environment do
   end
 
   it 'parses unquoted values' do
-    expect(env('FOO=bar')).to eql({'FOO' => 'bar'})
+    expect(env('FOO=bar')).to eql('FOO' => 'bar')
+  end
+
+  it 'parses values with spaces around equal sign' do
+    expect(env("FOO =bar")).to eql('FOO' => 'bar')
+    expect(env("FOO= bar")).to eql('FOO' => 'bar')
   end
 
   it 'parses double quoted values' do
-    expect(env('FOO="bar"')).to eql({'FOO' => 'bar'})
+    expect(env('FOO="bar"')).to eql('FOO' => 'bar')
   end
 
   it 'parses single quoted values' do
-    expect(env("FOO='bar'")).to eql({'FOO' => 'bar'})
+    expect(env("FOO='bar'")).to eql('FOO' => 'bar')
   end
 
   it 'parses escaped double quotes' do
-    expect(env('FOO="escaped\"bar"')).to eql({'FOO' => 'escaped"bar'})
+    expect(env('FOO="escaped\"bar"')).to eql('FOO' => 'escaped"bar')
   end
 
   it 'parses yaml style options' do
-    expect(env("OPTION_A: 1")).to eql('OPTION_A' => '1')
+    expect(env('OPTION_A: 1')).to eql('OPTION_A' => '1')
   end
 
   it 'parses export keyword' do
-    expect(env("export OPTION_A=2")).to eql('OPTION_A' => '2')
+    expect(env('export OPTION_A=2')).to eql('OPTION_A' => '2')
   end
 
   it 'expands newlines in quoted strings' do
-    expect(env('FOO="bar\nbaz"')).to eql({"FOO" => "bar\nbaz"})
+    expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz")
+  end
+
+  it 'parses varibales with "." in the name' do
+    expect(env('FOO.BAR=foobar')).to eql('FOO.BAR' => 'foobar')
+  end
+
+  it 'strips unquoted values' do
+    expect(env('foo=bar ')).to eql('foo' => 'bar') # not 'bar '
+  end
+
+  it 'throws an error if line format is incorrect' do
+    expect{env('lol$wut')}.to raise_error(Dotenv::FormatError)
+  end
+
+  it 'ignores empty lines' do
+    expect(env("\n \t  \nfoo=bar\n \nfizz=buzz")).to eql('foo' => 'bar', 'fizz' => 'buzz')
+  end
+
+  it 'ignores inline comments' do
+    expect(env("foo=bar # this is foo")).to eql('foo' => 'bar')
+  end
+
+  it 'allows # in quoted value' do
+    expect(env('foo="bar#baz" # comment')).to eql('foo' => 'bar#baz')
+  end
+
+  it 'ignores comment lines' do
+    expect(env("\n\n\n # HERE GOES FOO \nfoo=bar")).to eql('foo' => 'bar')
+  end
+
+  it 'parses # in quoted values' do
+    expect(env('foo="ba#r"')).to eql('foo' => 'ba#r')
+    expect(env("foo='ba#r'")).to eql('foo' => 'ba#r')
   end
 
   require 'tempfile'

data/spec/dotenv_spec.rb

@@ -6,7 +6,19 @@ describe Dotenv do
       let(:env_files) { [] }
 
       it 'defaults to .env' do
-        Dotenv::Environment.should_receive(:new).with('.env').
+        Dotenv::Environment.should_receive(:new).with(expand('.env')).
+          and_return(mock(:apply => {}))
+        subject
+      end
+    end
+
+    context 'with a tilde path' do
+      let(:env_files) { ['~/.env'] }
+
+      it 'expands the path' do
+        expected = expand("~/.env")
+        File.stub(:exists?){ |arg| arg == expected }
+        Dotenv::Environment.should_receive(:new).with(expected).
           and_return(mock(:apply => {}))
         subject
       end
@@ -16,7 +28,12 @@ describe Dotenv do
       let(:env_files) { ['.env', fixture_path('plain.env')] }
 
       let(:expected) do
-        {'OPTION_A' => '1', 'OPTION_B' => '2', 'DOTENV' => 'true'}
+        { 'OPTION_A' => '1',
+          'OPTION_B' => '2',
+          'OPTION_C' => '3',
+          'OPTION_D' => '4',
+          'OPTION_E' => '5',
+          'DOTENV' => 'true' }
       end
 
       it 'loads all files' do
@@ -68,4 +85,8 @@ describe Dotenv do
   def fixture_path(name)
     File.join(File.expand_path('../fixtures', __FILE__), name)
   end
+
+  def expand(path)
+    File.expand_path path
+  end
 end

data/spec/fixtures/plain.env

@@ -1,2 +1,5 @@
 OPTION_A=1
 OPTION_B=2
+OPTION_C= 3
+OPTION_D =4
+OPTION_E = 5

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -63,7 +58,10 @@ files:
 - dotenv.gemspec
 - lib/dotenv-rails.rb
 - lib/dotenv.rb
+- lib/dotenv/capistrano.rb
+- lib/dotenv/capistrano/recipes.rb
 - lib/dotenv/environment.rb
+- lib/dotenv/format_error.rb
 - lib/dotenv/railtie.rb
 - lib/dotenv/tasks.rb
 - lib/dotenv/version.rb
@@ -76,27 +74,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bkeepers/dotenv
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Loads environment variables from `.env`.
 test_files:
 - spec/dotenv/environment_spec.rb
@@ -106,3 +103,4 @@ test_files:
 - spec/fixtures/quoted.env
 - spec/fixtures/yaml.env
 - spec/spec_helper.rb
+has_rdoc: