dotenv 0.5.0 → 0.7.0

data/.gitignore

@@ -4,3 +4,4 @@
 .config
 .yardoc
 Gemfile.lock
+tmp

data/Changelog.md

@@ -1,17 +1,51 @@
 # Changelog
 
+## 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
+
+## 0.6.0 - Mar 22, 2013
+
+* Add dotenv-rails gem for autoloading in a Rails app
+
+* Deprecated autoloading with plain dotenv gem
+
+* Support for double quotes
+
+        A="some value"
+        B="with \"escaped\" quotes"
+        C="and newline\n expansion"
+
+* Support for pow-style variables prefixed with export
+
+        export VARIABLE="some value"
+
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.5.0...v0.6.0)
+
 ## 0.5.0 - Jan 25, 2013
 
 * Load immediately on require in Rails instead of waiting for initialization
+
 * Add YAML-style variables
-    VARIABLE: some value
+
+        VARIABLE: some value
+
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.4.0...v0.5.0)
 
 ## 0.4.0 - Nov 13, 2012
 
 * Add support for quoted options, e.g.:
-    VARIABLE='some value'
+
+        VARIABLE='some value'
+
 * Fix rake deprecation warnings
 
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.3.0...v0.4.0)
+
 ## 0.3.0 - Oct 25, 2012
 
 * Avoid overriding existing ENV variables so values set before loading the app are maintained.
+
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.2.0...v0.3.0)

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
-gemspec
+gemspec :name => 'dotenv'
+
+gem 'guard-rspec'
+gem 'guard-bundler'
+gem 'rb-fsevent'

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'rspec', :cli => '--color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/spec_helper.rb$})    { "spec" }
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -11,7 +11,7 @@ Read more about the [motivation for dotenv at opensoul.org](http://opensoul.org/
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dotenv', :groups => [:development, :test]
+gem 'dotenv-rails', :groups => [:development, :test]
 ```
 
 And then execute:
@@ -43,25 +43,26 @@ end
 
 ## Usage
 
-Add your application configuration to `.env`.
+Add your application configuration to your `.env` file in the root of
+your project:
 
 ```shell
-S3_BUCKET=dotenv
-SECRET_KEY=sssshhh!
+S3_BUCKET=YOURS3BUCKET
+SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
 You can also create files per environment, such as `.env.test`:
 
 ```shell
-S3_BUCKET=test
-SECRET_KEY=test
+S3_BUCKET=tests3bucket
+SECRET_KEY=testsecretkey
 ```
 
 An alternate yaml-like syntax is supported:
 
 ```yaml
-S3_BUCKET: dotenv
-SECRET_KEY: 'sesame, open'
+S3_BUCKET: yamlstyleforyours3bucket
+SECRET_KEY: thisisalsoanokaysecret
 ```
 
 Whenever your application loads, these variables will be available in `ENV`:

data/Rakefile

@@ -1,5 +1,24 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+
+require 'bundler/gem_helper'
+
+namespace 'dotenv' do
+  Bundler::GemHelper.install_tasks :name => 'dotenv'
+end
+
+namespace 'dotenv-rails' do
+  class DotenvRailsGemHelper < Bundler::GemHelper
+    def guard_already_tagged; end # noop
+    def tag_version; end # noop
+  end
+
+  DotenvRailsGemHelper.install_tasks :name => 'dotenv-rails'
+end
+
+task :build => ["dotenv:build", 'dotenv-rails:build']
+task :install => ["dotenv:install", 'dotenv-rails:install']
+task :release => ["dotenv:release", 'dotenv-rails:release']
+
 require 'rspec/core/rake_task'
 
 desc "Run all specs"
@@ -8,5 +27,4 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
-
-task :default => :spec
+task :default => :spec

data/dotenv-rails.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dotenv/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.version       = Dotenv::VERSION
+  gem.authors       = ["Brandon Keepers"]
+  gem.email         = ["brandon@opensoul.org"]
+  gem.description   = %q{Autoload dotenv in Rails.}
+  gem.summary       = %q{Autoload dotenv in Rails.}
+  gem.homepage      = "https://github.com/bkeepers/dotenv"
+
+  gem.files         = ["lib/dotenv-rails.rb"]
+  gem.name          = "dotenv-rails"
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'dotenv', Dotenv::VERSION
+end

data/dotenv.gemspec

@@ -1,7 +1,8 @@
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dotenv/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.version       = '0.5.0'
+  gem.version       = Dotenv::VERSION
   gem.authors       = ["Brandon Keepers"]
   gem.email         = ["brandon@opensoul.org"]
   gem.description   = %q{Loads environment variables from `.env`.}

data/lib/dotenv/environment.rb

@@ -2,12 +2,21 @@ module Dotenv
   class Environment < Hash
     def initialize(filename)
       @filename = filename
-      load if File.exists? @filename
+      load
     end
 
     def load
       read.each do |line|
-        self[$1] = $2 || $3 if line =~ /\A(\w+)(?:=|: ?)(?:'([^']*)'|([^']*))\z/
+        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
+        end
       end
     end
 

data/lib/dotenv/railtie.rb

@@ -1,3 +1,5 @@
+require 'dotenv'
+
 module Dotenv
   class Railtie < Rails::Railtie
     include Rake::DSL if defined?(Rake)

data/lib/dotenv/version.rb

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

data/lib/dotenv-rails.rb

@@ -0,0 +1 @@
+require 'dotenv/railtie'

data/lib/dotenv.rb

@@ -2,11 +2,22 @@ require 'dotenv/environment'
 
 module Dotenv
   def self.load(*filenames)
-    filenames << '.env' if filenames.empty?
-    filenames.inject({}) do |hash, filename|
-      hash.merge Dotenv::Environment.new(filename).apply
+    default_if_empty(filenames).inject({}) do |hash, filename|
+      hash.merge(File.exists?(filename) ? Environment.new(filename).apply : {})
     end
   end
-end
 
-require 'dotenv/railtie' if defined?(Rails) and defined?(Rails::Railtie)
+  # same as `load`, but raises Errno::ENOENT if any files don't exist
+  def self.load!(*filenames)
+    load(
+      *default_if_empty(filenames).each do |filename|
+        raise(Errno::ENOENT.new(filename)) unless File.exists?(filename)
+      end
+    )
+  end
+
+protected
+  def self.default_if_empty(filenames)
+    filenames.empty? ? (filenames << '.env') : filenames
+  end
+end

data/spec/dotenv/environment_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Dotenv::Environment do
+  subject { env("OPTION_A=1\nOPTION_B=2") }
+
+  describe 'initialize' do
+    it 'reads the file' do
+      expect(subject['OPTION_A']).to eq('1')
+      expect(subject['OPTION_B']).to eq('2')
+    end
+
+    it 'fails if file does not exist' do
+      expect {
+        Dotenv::Environment.new('.does_not_exists')
+      }.to raise_error(Errno::ENOENT)
+    end
+  end
+
+  describe 'apply' do
+    it 'sets variables in ENV' do
+      subject.apply
+      expect(ENV['OPTION_A']).to eq('1')
+    end
+
+    it 'does not override defined variables' do
+      ENV['OPTION_A'] = 'predefined'
+      subject.apply
+      expect(ENV['OPTION_A']).to eq('predefined')
+    end
+  end
+
+  it 'parses unquoted values' do
+    expect(env('FOO=bar')).to eql({'FOO' => 'bar'})
+  end
+
+  it 'parses double quoted values' do
+    expect(env('FOO="bar"')).to eql({'FOO' => 'bar'})
+  end
+
+  it 'parses single quoted values' do
+    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'})
+  end
+
+  it 'parses yaml style options' do
+    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')
+  end
+
+  it 'expands newlines in quoted strings' do
+    expect(env('FOO="bar\nbaz"')).to eql({"FOO" => "bar\nbaz"})
+  end
+
+  require 'tempfile'
+  def env(text)
+    file = Tempfile.new('dotenv')
+    file.write text
+    file.close
+    env = Dotenv::Environment.new(file.path)
+    file.unlink
+    env
+  end
+end

data/spec/dotenv_spec.rb

@@ -1,34 +1,24 @@
 require 'spec_helper'
 
 describe Dotenv do
-  let(:env_path) { fixture_path('plain.env') }
-
-  before do
-    @env_keys = ENV.keys
-  end
-
-  after do
-    ENV.delete_if { |k,v| !@env_keys.include?(k) }
-  end
-
-  describe 'load' do
+  shared_examples 'load' do
     context 'with no args' do
+      let(:env_files) { [] }
+
       it 'defaults to .env' do
         Dotenv::Environment.should_receive(:new).with('.env').
           and_return(mock(:apply => {}))
-        Dotenv.load
+        subject
       end
     end
 
     context 'with multiple files' do
+      let(:env_files) { ['.env', fixture_path('plain.env')] }
+
       let(:expected) do
         {'OPTION_A' => '1', 'OPTION_B' => '2', 'DOTENV' => 'true'}
       end
 
-      subject do
-        Dotenv.load('.env', env_path)
-      end
-
       it 'loads all files' do
         subject
         expected.each do |key, value|
@@ -39,79 +29,43 @@ describe Dotenv do
       it 'returns hash of loaded environments' do
         expect(subject).to eq(expected)
       end
-
-      context 'with quoted file' do
-        let(:expected) do
-          {'OPTION_A' => '1', 'OPTION_B' => '2', 'OPTION_C' => '', 'OPTION_D' => '\n', 'DOTENV' => 'true'}
-        end
-        let(:env_path) { fixture_path('quoted.env') }
-
-        it 'returns hash of loaded environments' do
-          expect(subject).to eq(expected)
-        end
-
-      end
-
-      context 'with yaml file' do
-        let(:expected) do
-          {'OPTION_A' => '1', 'OPTION_B' => '2', 'OPTION_C' => '', 'OPTION_D' => '\n', 'DOTENV' => 'true'}
-        end
-        let(:env_path) { fixture_path('yaml.env') }
-
-        it 'returns hash of loaded environments' do
-          expect(subject).to eq(expected)
-        end
-
-      end
     end
   end
 
-  describe Dotenv::Environment do
-    subject { Dotenv::Environment.new(env_path) }
-
-    context 'with a plain env file' do
+  describe 'load' do
+    subject { Dotenv.load(*env_files) }
 
-      describe 'initialize' do
-        it 'reads environment config' do
-          expect(subject['OPTION_A']).to eq('1')
-          expect(subject['OPTION_B']).to eq('2')
-        end
-      end
+    it_behaves_like 'load'
 
-      describe 'apply' do
-        it 'sets variables in ENV' do
-          subject.apply
-          expect(ENV['OPTION_A']).to eq('1')
-        end
+    context 'when the file does not exist' do
+      let(:env_files) { ['.env_does_not_exist'] }
 
-        it 'does not override defined variables' do
-          ENV['OPTION_A'] = 'predefined'
-          subject.apply
-          expect(ENV['OPTION_A']).to eq('predefined')
-        end
+      it 'fails silently' do
+        expect { subject }.not_to raise_error
+        expect(ENV.keys).to eq(@env_keys)
       end
     end
+  end
 
-    context 'when the file does not exist' do
-      let(:env_path) { fixture_path('.env_does_not_exist') }
+  describe 'load!' do
+    subject { Dotenv.load!(*env_files) }
 
-      describe 'initialize' do
-        it 'fails silently' do
-          expect { Dotenv::Environment.new('.env_does_not_exist') }.not_to raise_error
-        end
-      end
+    it_behaves_like 'load'
 
-      describe 'apply' do
-        it 'does not effect env' do
-          subject.apply
-          expect(ENV.keys).to eq(@env_keys)
-        end
+    context 'when one file exists and one does not' do
+      let(:env_files) { ['.env', '.env_does_not_exist'] }
+
+      it 'raises an Errno::ENOENT error and does not load any files' do
+        expect do
+          expect do
+            subject
+          end.to raise_error(Errno::ENOENT)
+        end.to_not change { ENV.keys }
       end
     end
-
   end
 
   def fixture_path(name)
     File.join(File.expand_path('../fixtures', __FILE__), name)
   end
-end
+end

data/spec/fixtures/exported.env

@@ -0,0 +1,2 @@
+export OPTION_A=2
+export OPTION_B='\n'

data/spec/fixtures/quoted.env

@@ -2,3 +2,7 @@ OPTION_A='1'
 OPTION_B='2'
 OPTION_C=''
 OPTION_D='\n'
+OPTION_E="1"
+OPTION_F="2"
+OPTION_G=""
+OPTION_H="\n"

data/spec/spec_helper.rb

@@ -1 +1,7 @@
-require 'dotenv'
+require 'dotenv'
+
+RSpec.configure do |config|
+  # Restore the state of ENV after each spec
+  config.before { @env_keys = ENV.keys }
+  config.after  { ENV.delete_if { |k,v| !@env_keys.include?(k) } }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,15 +55,21 @@ files:
 - .travis.yml
 - Changelog.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- dotenv-rails.gemspec
 - dotenv.gemspec
+- lib/dotenv-rails.rb
 - lib/dotenv.rb
 - lib/dotenv/environment.rb
 - lib/dotenv/railtie.rb
 - lib/dotenv/tasks.rb
+- lib/dotenv/version.rb
+- spec/dotenv/environment_spec.rb
 - spec/dotenv_spec.rb
+- spec/fixtures/exported.env
 - spec/fixtures/plain.env
 - spec/fixtures/quoted.env
 - spec/fixtures/yaml.env
@@ -80,18 +86,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3615033000965864371
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3615033000965864371
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -99,7 +99,9 @@ signing_key:
 specification_version: 3
 summary: Loads environment variables from `.env`.
 test_files:
+- spec/dotenv/environment_spec.rb
 - spec/dotenv_spec.rb
+- spec/fixtures/exported.env
 - spec/fixtures/plain.env
 - spec/fixtures/quoted.env
 - spec/fixtures/yaml.env