dotenv 0.11.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf9866ef73646311708f02f7d64078d51a9a4f05
-  data.tar.gz: afc12c3ed7128cfce0bb88575baac73aa44d1dc7
+  metadata.gz: db917b64277779cd86a42c05633d8df2fdbfba8f
+  data.tar.gz: d7227f87369b787997dcf0136f468c9a5d333c7f
 SHA512:
-  metadata.gz: 6c4b8a013ca7501d115b730473de3aac56d9f6064e29f8ccb85827c18a98e6daa0ff57a829a83ab66ca26784c233069525ad2297dbf2fd23500f92e20f1833be
-  data.tar.gz: d100aa93a038cf2266e18e14bcbc7ec2bd4fc0d7811b22246c949e450ead0de281e7d5980855b39c323b44bf5f4750bcf5f20aa7d4153b1dec66bb6f8a4c36b9
+  metadata.gz: ce97b5659a92e99839daa9a40f725af09c48eead2a4b03c482099f9d34f7f6b90474245b88b6d1641ee1a1eb8c4765ab11a6153d49dd6ab58e56bc1302f3a18c
+  data.tar.gz: 066064f298e0579f0cfe7e1739b836f26d27226f5358ca1cee49eb33e692b67cf14638186ec03439865990c5a37a69acede5a5da79149e4085747cd6a4500017

data/.travis.yml

@@ -5,6 +5,5 @@ rvm:
   - 1.9.3
   - 1.8.7
   - ree
-  - jruby-19mode
-  - rbx
-bundler_args: --without=guard
+  - rbx-2
+bundler_args: --without=guard

data/Changelog.md

@@ -1,9 +1,25 @@
 # Changelog
 
+## 1.0.0 - Oct 3, 2014
+
+* Remove deprecated features. Upgrade to 0.11.0 and fix deprecation warnings before upgrading to 1.0.0.
+
+* Watch .env for changes with Spring in Rails 4 ([#118](https://github.com/bkeepers/dotenv/pull/118))
+
+* Fix deprecation warnings for `File.exists?` ([#121](https://github.com/bkeepers/dotenv/pull/121/))
+
+* Use `Rails.root` to find `.env` ([#122](https://github.com/bkeepers/dotenv/pull/122/files))
+
+* Avoid substitutions inside single quotes ([#124](https://github.com/bkeepers/dotenv/pull/124))
+
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.11.1...v1.0.0)
+
 ## 0.11.1 - Apr 22, 2014
 
 * Depend on dotenv-deployment ~>0.0.2, which fixes issues with 0.0.1
 
+[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.11.0...v0.11.1)
+
 ## 0.11.0 - Apr 21, 2014
 
 * Extract dotenv-deployment gem. https://github.com/bkeepers/dotenv-deployment

data/README.md

@@ -8,7 +8,6 @@ But it is not always practical to set environment variables on development machi
 
 dotenv is intended to be used in development. If you would like to use it in production or other environments, see [dotenv-deployment](https://github.com/bkeepers/dotenv-deployment)
 
-
 ## Installation
 
 ### Rails
@@ -67,11 +66,17 @@ S3_BUCKET=YOURS3BUCKET
 SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
-An alternate yaml-like syntax is supported:
+If you need multiline variables, for example private keys, you can double quote strings and use the `\n` character for newlines:
+
+```shell
+PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nHkVN9…\n-----END DSA PRIVATE KEY-----\n"
+```
+
+You may also add `export` in front of each line so you can `source` the file in bash:
 
-```yaml
-S3_BUCKET: yamlstyleforyours3bucket
-SECRET_KEY: thisisalsoanokaysecret
+```shell
+export S3_BUCKET=YOURS3BUCKET
+export SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
 Whenever your application loads, these variables will be available in `ENV`:
@@ -82,10 +87,14 @@ config.fog_directory  = ENV['S3_BUCKET']
 
 ## 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.
+Credentials should only be accessible on the machines that need access to them. Never commit sensitive information to a repository that is not needed by every development machine and server.
+
+Personally, I prefer to commit the `.env` file with development-only settings. This makes it easy for other developers to get started on the project without compromising credentials for other environments. If you follow this advice, make sure that all the credentials for your development environment are different from your other deployments and that the development credentials do not have access to any confidential data.
 
 ## Contributing
 
+If you want a better idea of how dotenv works, check out the [Ruby Rogues Code Reading of dotenv](https://www.youtube.com/watch?v=lKmY_0uY86s).
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/dotenv.gemspec

@@ -16,8 +16,6 @@ Gem::Specification.new do |gem|
   gem.name          = "dotenv"
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "dotenv-deployment", "~>0.0.2"
-
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 end

data/lib/dotenv-rails.rb

@@ -1,11 +1 @@
-require 'dotenv/railtie'
-
-env_file = ".env.#{Rails.env}"
-if File.exists?(env_file) && !defined?(Dotenv::Deployment)
-  warn "Auto-loading of `#{env_file}` will be removed in 1.0. See " +
-    "https://github.com/bkeepers/dotenv-deployment if you would like to " +
-    "continue using this feature."
-  Dotenv.load ".env.#{Rails.env}"
-end
-
-Dotenv.load '.env'
+require "dotenv/railtie"

data/lib/dotenv.rb

@@ -3,7 +3,7 @@ require 'dotenv/environment'
 
 module Dotenv
   def self.load(*filenames)
-    with(*filenames) { |f| Environment.new(f).apply if File.exists?(f) }
+    with(*filenames) { |f| Environment.new(f).apply if File.exist?(f) }
   end
 
   # same as `load`, but raises Errno::ENOENT if any files don't exist
@@ -13,17 +13,19 @@ module Dotenv
 
   # same as `load`, but will override existing values in `ENV`
   def self.overload(*filenames)
-    with(*filenames) { |f| Environment.new(f).apply! if File.exists?(f) }
+    with(*filenames) { |f| Environment.new(f).apply! if File.exist?(f) }
   end
 
-protected
-
+  # Internal: Helper to expand list of filenames.
+  #
+  # Returns a hash of all the loaded environment variables.
   def self.with(*filenames, &block)
     filenames << '.env' if filenames.empty?
 
-    filenames.inject({}) do |hash, filename|
-      filename = File.expand_path filename
-      hash.merge(block.call(filename) || {})
+    {}.tap do |hash|
+      filenames.each do |filename|
+        hash.merge! block.call(File.expand_path(filename)) || {}
+      end
     end
   end
 end

data/lib/dotenv/parser.rb

@@ -48,8 +48,10 @@ module Dotenv
             value = value.gsub(/\\([^$])/, '\1')
           end
 
-          @@substitutions.each do |proc|
-            value = proc.call(value, hash)
+          if $1 != "'"
+            @@substitutions.each do |proc|
+              value = proc.call(value, hash)
+            end
           end
 
           hash[key] = value

data/lib/dotenv/railtie.rb

@@ -2,11 +2,9 @@ require 'dotenv'
 
 module Dotenv
   class Railtie < Rails::Railtie
-    rake_tasks do
-      task :dotenv do
-        # If the dotenv task is defined, then dotenv has already been loaded.
-        warn "The `dotenv` task is no longer needed and will be removed in 1.0."
-      end
+    config.before_configuration do
+      Dotenv.load Rails.root.join('.env')
+      Spring.watch Rails.root.join('.env') if defined?(Spring)
     end
   end
 end

data/lib/dotenv/substitutions/command.rb

@@ -1,11 +1,15 @@
 module Dotenv
   module Substitutions
+    # Substitute shell commands in a value.
+    #
+    #   SHA=$(git rev-parse HEAD)
+    #
     module Command
       class << self
 
         INTERPOLATED_SHELL_COMMAND = /
-          (?<backslash>\\)?
-          \$
+          (?<backslash>\\)?   # is it escaped with a backslash?
+          \$                  # literal $
           (?<cmd>             # collect command content for eval
             \(                # require opening paren
             ([^()]|\g<cmd>)+  # allow any number of non-parens, or balanced parens (by nesting the <cmd> expression recursively)
@@ -16,11 +20,14 @@ module Dotenv
         def call(value, env)
           # Process interpolated shell commands
           value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|
-            command = $~[:cmd][1..-2] # Eliminate opening and closing parentheses
+            # Eliminate opening and closing parentheses
+            command = $~[:cmd][1..-2]
 
             if $~[:backslash]
+              # Command is escaped, don't replace it.
               $~[0][1..-1]
             else
+              # Execute the command and return the value
               `#{command}`.chomp
             end
           end

data/lib/dotenv/substitutions/variable.rb

@@ -1,11 +1,16 @@
 module Dotenv
   module Substitutions
+    # Substitute variables in a value.
+    #
+    #   HOST=example.com
+    #   URL="https://$HOST"
+    #
     module Variable
       class << self
 
         VARIABLE = /
-          (\\)?
-          (\$)
+          (\\)?          # is it escaped with a backslash?
+          (\$)           # literal $
           (              # collect braces with var for sub
             \{?          # allow brace wrapping
             ([A-Z0-9_]+) # match the variable
@@ -17,8 +22,10 @@ module Dotenv
           # Process embedded variables
           value.scan(VARIABLE).each do |parts|
             if parts.first == '\\'
+              # Variable is escaped, don't replace it.
               replace = parts[1...-1].join('')
             else
+              # Replace it with the value from the environment
               replace = env.fetch(parts.last) { ENV[parts.last] }
             end
 

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = '0.11.1'
+  VERSION = '1.0.0'
 end

data/spec/dotenv/environment_spec.rb

@@ -31,7 +31,7 @@ describe Dotenv::Environment do
 
   describe 'apply!' do
     it 'sets variables in the ENV' do
-      subject.apply
+      subject.apply!
       expect(ENV['OPTION_A']).to eq('1')
     end
 

data/spec/dotenv/parser_spec.rb

@@ -47,8 +47,12 @@ describe Dotenv::Parser do
     expect(env('BAR=$FOO')).to eql('BAR' => '')
   end
 
-  it 'expands variables in quoted strings' do
-    expect(env("FOO=test\nBAR='quote $FOO'")).to eql('FOO' => 'test', 'BAR' => 'quote test')
+  it 'expands variables in double quoted strings' do
+    expect(env("FOO=test\nBAR=\"quote $FOO\"")).to eql('FOO' => 'test', 'BAR' => 'quote test')
+  end
+
+  it 'does not expand variables in single quoted strings' do
+    expect(env("BAR='quote $FOO'")).to eql('BAR' => 'quote $FOO')
   end
 
   it 'does not expand escaped variables' do

data/spec/dotenv_spec.rb

@@ -17,7 +17,7 @@ describe Dotenv do
 
       it 'expands the path' do
         expected = expand("~/.env")
-        allow(File).to receive(:exists?){ |arg| arg == expected }
+        allow(File).to receive(:exist?){ |arg| arg == expected }
         expect(Dotenv::Environment).to receive(:new).with(expected).
           and_return(double(:apply => {}, :apply! => {}))
         subject

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv-deployment
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.2
 - !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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: Loads environment variables from `.env`.
@@ -60,9 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .env
-- .gitignore
-- .travis.yml
+- ".env"
+- ".gitignore"
+- ".travis.yml"
 - Changelog.md
 - Gemfile
 - Guardfile
@@ -74,7 +60,6 @@ files:
 - dotenv.gemspec
 - lib/dotenv-rails.rb
 - lib/dotenv.rb
-- lib/dotenv/capistrano.rb
 - lib/dotenv/environment.rb
 - lib/dotenv/parser.rb
 - lib/dotenv/railtie.rb
@@ -100,17 +85,17 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Loads environment variables from `.env`.
@@ -123,4 +108,3 @@ test_files:
 - spec/fixtures/quoted.env
 - spec/fixtures/yaml.env
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/dotenv/capistrano.rb

@@ -1,6 +0,0 @@
-warn "Capistrano support has been moved to the dotenv-deployment gem. Add it " +
-  "to your Gemfile and change the require to 'dotenv/deployment/capistrano'. " +
-  "See https://github.com/bkeepers/dotenv-deployment#capistrano."
-
-# This will be removed in 1.0
-require 'dotenv/deployment/capistrano'