dotenv 2.0.0.beta → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 082cf9f284dde0511d6c31a21bd1b7f93b9804c3
-  data.tar.gz: bcacb89f7cbf92eea2a2e12764db45a64c7909b1
+  metadata.gz: 9ccf9d3a79db7a52a63cb5aeca87cec81e21e3ec
+  data.tar.gz: abb6bc7fad7f6b2e2c300ff6b6141f30ccb0bc37
 SHA512:
-  metadata.gz: 79fd1380227329afe5da7c1d2291e297106ba9f54cab22b204068e035f029bee4bec34289f424d70d3bfa92ce81f772b2632a4a5c1328b1ddd7e3e3938fcc290
-  data.tar.gz: bb84a49f6a65088eec50233de800118fea98de0eb097c63b88ada013d474375b1565548570982254866e93ac836ec25df9bf3a1884d4f866cd7355862954eb1d
+  metadata.gz: d48b1e23d0ddfac1d8342f97fe4ae862aa43316617561a0d1f702663af6d9ee21716cdef113570a263301422a2e474a572b24992b9fba2114ca3615af6768ab6
+  data.tar.gz: b2c31269eb2977d37b0707759ad1e03ba428a7ed8a46927ec4b2fa2e23a3f8ba8302c5bc03d46a590f5489b413f24d506c2381b76e6c594364f2eb86199b27dd

data/README.md

@@ -101,9 +101,19 @@ Whenever your application loads, these variables will be available in `ENV`:
 config.fog_directory  = ENV['S3_BUCKET']
 ```
 
+Comments may be added to your file as such:
+
+```shell
+# This is a comment
+SECRET_KEY=YOURSECRETKEYGOESHERE # comment
+SECRET_HASH="something-with-a-#-hash"
+```
+
+Variable names may not contain the `#` symbol. Values can use the `#` if they are enclosed in quotes.
+
 ## 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.
+dotenv was originally created to load configuration variables into `ENV` in *development*. There are typically better ways to manage configuration in production 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`.
 

data/bin/dotenv

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'dotenv/cli'
+require "dotenv/cli"
 Dotenv::CLI.new(ARGV).run

data/lib/dotenv.rb

@@ -1,16 +1,19 @@
-require 'dotenv/parser'
-require 'dotenv/environment'
+require "dotenv/parser"
+require "dotenv/environment"
 
+# The top level Dotenv module. The entrypoint for the application logic.
 module Dotenv
-  extend self
+  class << self
+    attr_accessor :instrumenter
+  end
 
-  attr_accessor :instrumenter
+  module_function
 
   def load(*filenames)
     with(*filenames) do |f|
-      if File.exist?(f)
+      ignoring_nonexistent_files do
         env = Environment.new(f)
-        instrument('dotenv.load', :env => env) { env.apply }
+        instrument("dotenv.load", :env => env) { env.apply }
       end
     end
   end
@@ -19,16 +22,16 @@ module Dotenv
   def load!(*filenames)
     with(*filenames) do |f|
       env = Environment.new(f)
-      instrument('dotenv.load', :env => env) { env.apply }
+      instrument("dotenv.load", :env => env) { env.apply }
     end
   end
 
   # same as `load`, but will override existing values in `ENV`
   def overload(*filenames)
     with(*filenames) do |f|
-      if File.exist?(f)
+      ignoring_nonexistent_files do
         env = Environment.new(f)
-        instrument('dotenv.overload', :env => env) { env.apply! }
+        instrument("dotenv.overload", :env => env) { env.apply! }
       end
     end
   end
@@ -37,12 +40,10 @@ module Dotenv
   #
   # Returns a hash of all the loaded environment variables.
   def with(*filenames, &block)
-    filenames << '.env' if filenames.empty?
+    filenames << ".env" if filenames.empty?
 
-    {}.tap do |hash|
-      filenames.each do |filename|
-        hash.merge! block.call(File.expand_path(filename)) || {}
-      end
+    filenames.reduce({}) do |hash, filename|
+      hash.merge! block.call(File.expand_path(filename)) || {}
     end
   end
 
@@ -53,4 +54,9 @@ module Dotenv
       block.call
     end
   end
+
+  def ignoring_nonexistent_files
+    yield
+  rescue Errno::ENOENT
+  end
 end

data/lib/dotenv/cli.rb

@@ -1,6 +1,8 @@
-require 'dotenv'
+require "dotenv"
 
 module Dotenv
+  # The CLI is a class responsible of handling all the command line interface
+  # logic.
   class CLI
     attr_reader :argv
 
@@ -9,23 +11,26 @@ module Dotenv
     end
 
     def run
-      filenames = if pos = argv.index('-f')
-        # drop the -f
-        argv.delete_at pos
-        # parse one or more comma-separated .env files
-        require 'csv'
-        CSV.parse_line argv.delete_at(pos)
-      else
-        []
-      end
-
+      filenames = parse_filenames || []
       begin
-        Dotenv.load! *filenames
+        Dotenv.load!(*filenames)
       rescue Errno::ENOENT => e
         abort e.message
       else
-        exec *argv unless argv.empty?
+        exec(*argv) unless argv.empty?
       end
     end
+
+    private
+
+    def parse_filenames
+      pos = argv.index("-f")
+      return nil unless pos
+      # drop the -f
+      argv.delete_at pos
+      # parse one or more comma-separated .env files
+      require "csv"
+      CSV.parse_line argv.delete_at(pos)
+    end
   end
 end

data/lib/dotenv/environment.rb

@@ -1,4 +1,6 @@
 module Dotenv
+  # This class inherits from Hash and represents the environemnt into which
+  # Dotenv will load key value pairs from a file.
   class Environment < Hash
     attr_reader :filename
 
@@ -16,11 +18,11 @@ module Dotenv
     end
 
     def apply
-      each { |k,v| ENV[k] ||= v }
+      each { |k, v| ENV[k] ||= v }
     end
 
     def apply!
-      each { |k,v| ENV[k] = v }
+      each { |k, v| ENV[k] = v }
     end
   end
 end

data/lib/dotenv/parser.rb

@@ -1,13 +1,15 @@
-require 'dotenv/substitutions/variable'
-if RUBY_VERSION > '1.8.7'
-  require 'dotenv/substitutions/command'
-end
+require "dotenv/substitutions/variable"
+require "dotenv/substitutions/command" if RUBY_VERSION > "1.8.7"
 
 module Dotenv
   class FormatError < SyntaxError; end
 
+  # This class enables parsing of a string for key value pairs to be returned
+  # and stored in the Environment. It allows for variable substitutions and
+  # exporting of variables.
   class Parser
-    @@substitutions = Substitutions.constants.map { |const| Substitutions.const_get(const) }
+    @substitutions =
+      Substitutions.constants.map { |const| Substitutions.const_get(const) }
 
     LINE = /
       \A
@@ -25,44 +27,67 @@ module Dotenv
       \z
     /x
 
-    def self.call(string)
-      new(string).call
+    class << self
+      attr_reader :substitutions
+
+      def call(string)
+        new(string).call
+      end
     end
 
     def initialize(string)
       @string = string
+      @hash = {}
     end
 
     def call
-      @string.split("\n").inject({}) do |hash, line|
-        if match = line.match(LINE)
-          key, value = match.captures
+      @string.split("\n").each do |line|
+        parse_line(line)
+      end
+      @hash
+    end
+
+    private
 
-          value ||= ''
-          # Remove surrounding quotes
-          value = value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
+    def parse_line(line)
+      if (match = line.match(LINE))
+        key, value = match.captures
+        @hash[key] = parse_value(value || "")
+      elsif line.split.first == "export"
+        if variable_not_set?(line)
+          fail FormatError, "Line #{line.inspect} has an unset variable"
+        end
+      elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
+        fail FormatError, "Line #{line.inspect} doesn't match format"
+      end
+    end
 
-          if $1 == '"'
-            value = value.gsub('\n', "\n")
-            # Unescape all characters except $ so variables can be escaped properly
-            value = value.gsub(/\\([^$])/, '\1')
-          end
+    def parse_value(value)
+      # Remove surrounding quotes
+      value = value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
 
-          if $1 != "'"
-            @@substitutions.each do |proc|
-              value = proc.call(value, hash)
-            end
-          end
+      if Regexp.last_match(1) == '"'
+        value = unescape_characters(expand_newlines(value))
+      end
 
-          hash[key] = value
-        elsif line.split.first == 'export'
-          # looks like you want to export after declaration, I guess that is ok
-          raise FormatError, "Line #{line.inspect} has a variable that is not set" unless line.split[1..-1].all?{ |var| hash.member?(var) }
-        elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
-          raise FormatError, "Line #{line.inspect} doesn't match format"
+      if Regexp.last_match(1) != "'"
+        self.class.substitutions.each do |proc|
+          value = proc.call(value, @hash)
         end
-        hash
       end
+      value
+    end
+
+    def unescape_characters(value)
+      value.gsub(/\\([^$])/, '\1')
+    end
+
+    def expand_newlines(value)
+      value.gsub('\n', "\n")
+    end
+
+    def variable_not_set?(line)
+      !line.split[1..-1].all? { |var| @hash.member?(var) }
     end
   end
 end

data/lib/dotenv/substitutions/command.rb

@@ -1,3 +1,5 @@
+require "English"
+
 module Dotenv
   module Substitutions
     # Substitute shell commands in a value.
@@ -6,26 +8,27 @@ module Dotenv
     #
     module Command
       class << self
-
         INTERPOLATED_SHELL_COMMAND = /
           (?<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)
+            ([^()]|\g<cmd>)+  # allow any number of non-parens, or balanced
+                              # parens (by nesting the <cmd> expression
+                              # recursively)
             \)                # require closing paren
           )
         /x
 
-        def call(value, env)
+        def call(value, _env)
           # Process interpolated shell commands
           value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|
             # Eliminate opening and closing parentheses
-            command = $~[:cmd][1..-2]
+            command = $LAST_MATCH_INFO[:cmd][1..-2]
 
-            if $~[:backslash]
+            if $LAST_MATCH_INFO[:backslash]
               # Command is escaped, don't replace it.
-              $~[0][1..-1]
+              $LAST_MATCH_INFO[0][1..-1]
             else
               # Execute the command and return the value
               `#{command}`.chomp
@@ -33,7 +36,6 @@ module Dotenv
           end
         end
       end
-
     end
   end
 end

data/lib/dotenv/substitutions/variable.rb

@@ -7,7 +7,6 @@ module Dotenv
     #
     module Variable
       class << self
-
         VARIABLE = /
           (\\)?          # is it escaped with a backslash?
           (\$)           # literal $
@@ -23,20 +22,18 @@ module Dotenv
           value.scan(VARIABLE).each do |parts|
             if parts.first == '\\'
               # Variable is escaped, don't replace it.
-              replace = parts[1...-1].join('')
+              replace = parts[1...-1].join("")
             else
               # Replace it with the value from the environment
               replace = env.fetch(parts.last) { ENV[parts.last] }
             end
 
-            value = value.sub(parts[0...-1].join(''), replace || '')
+            value = value.sub(parts[0...-1].join(""), replace || "")
           end
 
           value
         end
       end
-
     end
-
   end
 end

data/lib/dotenv/tasks.rb

@@ -1,7 +1,7 @@
-desc 'Load environment settings from .env'
+desc "Load environment settings from .env"
 task :dotenv do
-  require 'dotenv'
+  require "dotenv"
   Dotenv.load
 end
 
-task :environment => :dotenv
+task :environment => :dotenv

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = '2.0.0.beta'
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta
+  version: 2.0.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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`.
 email:
 - brandon@opensoul.org
@@ -72,9 +86,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2