dotenv-rails 1.0.2 → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9b8a2f36a1e82b0bbb76f969ed18daefaa0f53d
-  data.tar.gz: bb950985d9d6dedd2f49f5921abea128c66042ad
+  metadata.gz: ddc13d30ca15fc74ab46b07b46d17887af3714c1
+  data.tar.gz: 232c81c2c8ceef4e04e0b6f742eacc78be9adc3a
 SHA512:
-  metadata.gz: 54fc237f8118410e5c35dc24ec52efd1153d034e1c6f01e8b61e3b4776e0e08ddf58bd4b4e8066099459bbac9610cbc08fae5f8cb8cd5530a6c4bac217ae654a
-  data.tar.gz: e81f9732b8e9a8a7000dbefd5f0358d1ea2a6e50c26a3d9c1e3516b6b0ad979876d469f944fab28ec099c6b66cab9229265374cf2bac33b1179b46e9fd898290
+  metadata.gz: 85f66b0ff491376129ae227305be458b826097425b987f8f9b60b8af5136a916f078ac2649ecf5328616b94ab341d8409ad13288fd9d2b3059d50abdba42d6a9
+  data.tar.gz: beedfaa2f1877e714f7198179530c48fe7e148168f3e09994894840c245d70a69e384e45712e185348bd94f019adf3ace0cd8d07485d2cf56209644b7ae66a19

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brandon Keepers
+
+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,126 @@
+# dotenv [![Build Status](https://secure.travis-ci.org/bkeepers/dotenv.png?branch=master)](https://travis-ci.org/bkeepers/dotenv)
+
+Shim to load environment variables from `.env` into `ENV` in *development*.
+
+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 loads variables from a `.env` file into `ENV` when the environment is bootstrapped.
+
+## Installation
+
+### Rails
+
+Add this line to the top of your application's Gemfile:
+
+```ruby
+gem 'dotenv-rails', :groups => [:development, :test]
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+#### Note on load order
+
+dotenv is initialized in your Rails app during the `before_configuration` callback, which is fired when the `Application` constant is defined in `config/application.rb` with `class Application < Rails::Application`. If you need it to be initialized sooner, you can manually call `Dotenv::Railtie.load`.
+
+```ruby
+# config/application.rb
+Bundler.require(*Rails.groups)
+
+Dotenv::Railtie.load
+
+HOSTNAME = ENV['HOSTNAME']
+```
+
+If you use gems that require environment variables to be set before they are loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and require `dotenv/rails-now`.
+
+```ruby
+gem 'dotenv-rails', :require => 'dotenv/rails-now'
+gem 'gem-that-requires-env-variables'
+```
+
+### Sinatra or Plain ol' Ruby
+
+Install the gem:
+
+```shell
+$ gem install dotenv
+```
+
+As early as possible in your application bootstrap process, load `.env`:
+
+```ruby
+require 'dotenv'
+Dotenv.load
+```
+
+Alternatively, you can use the `dotenv` executable to launch your application:
+
+```shell
+$ dotenv ./script.py
+```
+
+To ensure `.env` is loaded in rake, load the tasks:
+
+```ruby
+require 'dotenv/tasks'
+
+task :mytask => :dotenv do
+    # things that require .env
+end
+```
+
+## Usage
+
+Add your application configuration to your `.env` file in the root of your project:
+
+```shell
+S3_BUCKET=YOURS3BUCKET
+SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+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:
+
+```shell
+export S3_BUCKET=YOURS3BUCKET
+export SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+Whenever your application loads, these variables will be available in `ENV`:
+
+```ruby
+config.fog_directory  = ENV['S3_BUCKET']
+```
+
+## Multiple Rails Environments
+
+dotenv was originally created to load configuration variables into `ENV` in *development*. There are typically better ways to manage configuration in production environments environments—such as `/etc/environment` managed by [Puppet](https://github.com/puppetlabs/puppet) or [Chef](https://github.com/opscode/chef), `heroku config`, etc.
+
+However, some find dotenv to be a convenient way to configure Rails applications in staging and production environments, and you can do that by defining environment-specific files like `.env.production` or `.env.test`.
+
+You can also `.env.local` for local overrides.
+
+## Should I commit my .env file?
+
+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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/dotenv/rails.rb

@@ -1,6 +1,14 @@
 require 'dotenv'
+
+Dotenv.instrumenter = ActiveSupport::Notifications
+
+# Watch all loaded env files with Spring
 begin
   require 'spring/watcher'
+  ActiveSupport::Notifications.subscribe(/^dotenv/) do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    Spring.watch event.payload[:env].filename if Rails.application
+  end
 rescue LoadError
   # Spring is not available
 end
@@ -14,8 +22,18 @@ module Dotenv
     # This will get called during the `before_configuration` callback, but you
     # can manually call `Dotenv::Railtie.load` if you needed it sooner.
     def load
-      Dotenv.load Rails.root.join('.env')
-      Spring.watch Rails.root.join('.env') if defined?(Spring)
+      Dotenv.load(
+        root.join(".env.local"),
+        root.join(".env.#{Rails.env}"),
+        root.join('.env')
+      )
+    end
+
+    # Internal: `Rails.root` is nil in Rails 4.1 before the application is
+    # initialized, so this falls back to the `RAILS_ROOT` environment variable,
+    # or the current workding directory.
+    def root
+      Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
     end
 
     # Rails uses `#method_missing` to delegate all class methods to the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0.beta
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 2.0.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 2.0.0.beta
 - !ruby/object:Gem::Dependency
   name: spring
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 description: Autoload dotenv in Rails.
 email:
 - brandon@opensoul.org
@@ -59,11 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- dotenv-rails.gemspec
+- LICENSE
+- README.md
 - lib/dotenv-rails.rb
 - lib/dotenv/rails-now.rb
 - lib/dotenv/rails.rb
-- spec/dotenv/rails_spec.rb
 homepage: https://github.com/bkeepers/dotenv
 licenses:
 - MIT
@@ -79,14 +79,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Autoload dotenv in Rails.
-test_files:
-- spec/dotenv/rails_spec.rb
+test_files: []

data/dotenv-rails.gemspec

@@ -1,22 +0,0 @@
-# -*- 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.license       = 'MIT'
-
-  gem.files         = `git ls-files | grep rails`.split($\)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "dotenv-rails"
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency 'dotenv', Dotenv::VERSION
-
-  gem.add_development_dependency 'spring'
-  gem.add_development_dependency 'railties'
-end

data/spec/dotenv/rails_spec.rb

@@ -1,41 +0,0 @@
-require 'spec_helper'
-require 'rails'
-require 'dotenv/rails'
-
-describe Dotenv::Railtie do
-  # Fake watcher for Spring
-  class SpecWatcher < Struct.new(:items)
-    def initialize
-      @items = Set.new
-    end
-
-    def add(*items)
-      @items.merge items
-    end
-  end
-
-  before do
-    allow(Rails).to receive(:root).and_return Pathname.new(File.expand_path('../../../', __FILE__))
-    allow(Spring).to receive(:application_root_path).and_return(Rails.root)
-    Spring.watcher = SpecWatcher.new
-  end
-
-  context 'before_configuration' do
-    it 'calls #load' do
-      expect(Dotenv::Railtie.instance).to receive(:load)
-      ActiveSupport.run_load_hooks(:before_configuration)
-    end
-  end
-
-  context 'load' do
-    before { Dotenv::Railtie.load }
-
-    it 'watches .env with Spring' do
-      Spring.watcher.include? Rails.root.join('.env')
-    end
-
-    it 'loads .env' do
-      expect(ENV).to have_key('DOTENV')
-    end
-  end
-end