dotenv 0.9.0 → 2.7.6

data/lib/dotenv/environment.rb

@@ -1,76 +1,28 @@
-require 'dotenv/format_error'
-
 module Dotenv
+  # This class inherits from Hash and represents the environment into which
+  # Dotenv will load key value pairs from a file.
   class Environment < Hash
-    LINE = /
-      \A
-      (?:export\s+)?    # optional export
-      ([\w\.]+)         # key
-      (?:\s*=\s*|:\s+?) # separator
-      (                 # optional value begin
-        '(?:\'|[^'])*'  #   single quoted value
-        |               #   or
-        "(?:\"|[^"])*"  #   double quoted value
-        |               #   or
-        [^#\n]+         #   unquoted value
-      )?                # value end
-      (?:\s*\#.*)?      # optional comment
-      \z
-    /x
-    VARIABLE = /
-      (\\)?
-      (\$)
-      (              # collect braces with var for sub
-        \{?          # allow brace wrapping
-        ([A-Z0-9_]+) # match the variable
-        \}?          # closing brace
-      )
-    /xi
+    attr_reader :filename
 
-    def initialize(filename)
+    def initialize(filename, is_load = false)
       @filename = filename
-      load
+      load(is_load)
     end
 
-    def load
-      read.each do |line|
-        if match = line.match(LINE)
-          key, value = match.captures
-
-          value ||= ''
-          # Remove surrounding quotes
-          value = value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
-
-          if $1 == '"'
-            value = value.gsub('\n', "\n")
-            # Unescape all characters except $ so variables can be escaped properly
-            value = value.gsub(/\\([^$])/, '\1')
-          end
-
-          # Process embedded variables
-          value.scan(VARIABLE).each do |parts|
-            if parts.first == '\\'
-              replace = parts[1...-1].join('')
-            else
-              replace = self.fetch(parts.last) { ENV[parts.last] }
-            end
-
-            value = value.sub(parts[0...-1].join(''), replace || '')
-          end
-
-          self[key] = value
-        elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
-          raise FormatError, "Line #{line.inspect} doesn't match format"
-        end
-      end
+    def load(is_load = false)
+      update Parser.call(read, is_load)
     end
 
     def read
-      File.read(@filename).split("\n")
+      File.open(@filename, "rb:bom|utf-8", &:read)
     end
 
     def apply
-      each { |k,v| ENV[k] ||= v }
+      each { |k, v| ENV[k] ||= v }
+    end
+
+    def apply!
+      each { |k, v| ENV[k] = v }
     end
   end
 end

data/lib/dotenv/load.rb

@@ -0,0 +1,2 @@
+require "dotenv"
+Dotenv.load

data/lib/dotenv/missing_keys.rb

@@ -0,0 +1,10 @@
+module Dotenv
+  class Error < StandardError; end
+
+  class MissingKeys < Error # :nodoc:
+    def initialize(keys)
+      key_word = "key#{keys.size > 1 ? 's' : ''}"
+      super("Missing required configuration #{key_word}: #{keys.inspect}")
+    end
+  end
+end

data/lib/dotenv/parser.rb

@@ -0,0 +1,98 @@
+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 =
+      [Dotenv::Substitutions::Variable, Dotenv::Substitutions::Command]
+
+    LINE = /
+      (?:^|\A)              # beginning of line
+      \s*                   # leading whitespace
+      (?:export\s+)?        # optional export
+      ([\w\.]+)             # key
+      (?:\s*=\s*?|:\s+?)    # separator
+      (                     # optional value begin
+        \s*'(?:\\'|[^'])*'  #   single quoted value
+        |                   #   or
+        \s*"(?:\\"|[^"])*"  #   double quoted value
+        |                   #   or
+        [^\#\r\n]+          #   unquoted value
+      )?                    # value end
+      \s*                   # trailing whitespace
+      (?:\#.*)?             # optional comment
+      (?:$|\z)              # end of line
+    /x
+
+    class << self
+      attr_reader :substitutions
+
+      def call(string, is_load = false)
+        new(string, is_load).call
+      end
+    end
+
+    def initialize(string, is_load = false)
+      @string = string
+      @hash = {}
+      @is_load = is_load
+    end
+
+    def call
+      # Convert line breaks to same format
+      lines = @string.gsub(/\r\n?/, "\n")
+      # Process matches
+      lines.scan(LINE).each do |key, value|
+        @hash[key] = parse_value(value || "")
+      end
+      # Process non-matches
+      lines.gsub(LINE, "").split(/[\n\r]+/).each do |line|
+        parse_line(line)
+      end
+      @hash
+    end
+
+    private
+
+    def parse_line(line)
+      if line.split.first == "export"
+        if variable_not_set?(line)
+          raise FormatError, "Line #{line.inspect} has an unset variable"
+        end
+      end
+    end
+
+    def parse_value(value)
+      # Remove surrounding quotes
+      value = value.strip.sub(/\A(['"])(.*)\1\z/m, '\2')
+
+      if Regexp.last_match(1) == '"'
+        value = unescape_characters(expand_newlines(value))
+      end
+
+      if Regexp.last_match(1) != "'"
+        self.class.substitutions.each do |proc|
+          value = proc.call(value, @hash, @is_load)
+        end
+      end
+      value
+    end
+
+    def unescape_characters(value)
+      value.gsub(/\\([^$])/, '\1')
+    end
+
+    def expand_newlines(value)
+      value.gsub('\n', "\n").gsub('\r', "\r")
+    end
+
+    def variable_not_set?(line)
+      !line.split[1..-1].all? { |var| @hash.member?(var) }
+    end
+  end
+end

data/lib/dotenv/substitutions/command.rb

@@ -0,0 +1,41 @@
+require "English"
+
+module Dotenv
+  module Substitutions
+    # Substitute shell commands in a value.
+    #
+    #   SHA=$(git rev-parse HEAD)
+    #
+    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)
+            \)                # require closing paren
+          )
+        /x
+
+        def call(value, _env, _is_load)
+          # Process interpolated shell commands
+          value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|
+            # Eliminate opening and closing parentheses
+            command = $LAST_MATCH_INFO[:cmd][1..-2]
+
+            if $LAST_MATCH_INFO[:backslash]
+              # Command is escaped, don't replace it.
+              $LAST_MATCH_INFO[0][1..-1]
+            else
+              # Execute the command and return the value
+              `#{command}`.chomp
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotenv/substitutions/variable.rb

@@ -0,0 +1,47 @@
+require "English"
+
+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 $
+          (?!\()        # shouldnt be followed by paranthesis
+          \{?           # allow brace wrapping
+          ([A-Z0-9_]+)? # optional alpha nums
+          \}?           # closing brace
+        /xi
+
+        def call(value, env, is_load)
+          combined_env = if is_load
+                           env.merge(ENV)
+                         else
+                           ENV.to_h.merge(env)
+                         end
+          value.gsub(VARIABLE) do |variable|
+            match = $LAST_MATCH_INFO
+            substitute(match, variable, combined_env)
+          end
+        end
+
+        private
+
+        def substitute(match, variable, env)
+          if match[1] == '\\'
+            variable[1..-1]
+          elsif match[3]
+            env.fetch(match[3], "")
+          else
+            variable
+          end
+        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/template.rb

@@ -0,0 +1,21 @@
+module Dotenv
+  # Class for creating a template from a env file
+  class EnvTemplate
+    def initialize(env_file)
+      @env_file = env_file
+    end
+
+    def create_template
+      File.open(@env_file, "r") do |env_file|
+        File.open("#{@env_file}.template", "w") do |env_template|
+          env_file.each do |line|
+            var, value = line.split("=")
+            is_a_comment = var.strip[0].eql?("#")
+            line_transform = value.nil? || is_a_comment ? line : "#{var}=#{var}"
+            env_template.puts line_transform
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = '0.9.0'
+  VERSION = "2.7.6".freeze
 end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 0.9.0
-  prerelease: 
+  version: 2.7.6
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
 description: Loads environment variables from `.env`.
 email:
 - brandon@opensoul.org
@@ -51,63 +60,41 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .env
-- .gitignore
-- .travis.yml
-- Changelog.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/dotenv
-- dotenv-rails.gemspec
-- dotenv.gemspec
-- lib/dotenv-rails.rb
 - lib/dotenv.rb
-- lib/dotenv/capistrano.rb
-- lib/dotenv/capistrano/recipes.rb
+- lib/dotenv/cli.rb
 - lib/dotenv/environment.rb
-- lib/dotenv/format_error.rb
-- lib/dotenv/railtie.rb
+- lib/dotenv/load.rb
+- lib/dotenv/missing_keys.rb
+- lib/dotenv/parser.rb
+- lib/dotenv/substitutions/command.rb
+- lib/dotenv/substitutions/variable.rb
 - lib/dotenv/tasks.rb
+- lib/dotenv/template.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
-- spec/spec_helper.rb
 homepage: https://github.com/bkeepers/dotenv
-licenses: []
+licenses:
+- MIT
+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: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 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
-- spec/spec_helper.rb
+test_files: []