dotenv 0.10.0 → 2.8.0

data/lib/dotenv/substitutions/variable.rb

@@ -1,35 +1,43 @@
+require "English"
+
 module Dotenv
   module Substitutions
+    # Substitute variables in a value.
+    #
+    #   HOST=example.com
+    #   URL="https://$HOST"
+    #
     module Variable
       class << self
-
         VARIABLE = /
-          (\\)?
-          (\$)
-          (              # collect braces with var for sub
-            \{?          # allow brace wrapping
-            ([A-Z0-9_]+) # match the variable
-            \}?          # closing brace
-          )
+          (\\)?         # 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)
-          # Process embedded variables
-          value.scan(VARIABLE).each do |parts|
-            if parts.first == '\\'
-              replace = parts[1...-1].join('')
-            else
-              replace = env.fetch(parts.last) { ENV[parts.last] }
-            end
-
-            value = value.sub(parts[0...-1].join(''), replace || '')
+        def call(value, env, is_load)
+          combined_env = is_load ? env.merge(ENV) : ENV.to_h.merge(env)
+          value.gsub(VARIABLE) do |variable|
+            match = $LAST_MATCH_INFO
+            substitute(match, variable, combined_env)
           end
+        end
 
-          value
+        private
+
+        def substitute(match, variable, env)
+          if match[1] == "\\"
+            variable[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,26 @@
+module Dotenv
+  EXPORT_COMMAND = "export ".freeze
+  # 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|
+            env_template.puts template_line(line)
+          end
+        end
+      end
+    end
+
+    def template_line(line)
+      var, value = line.split("=")
+      template = var.gsub(EXPORT_COMMAND, "")
+      is_a_comment = var.strip[0].eql?("#")
+      value.nil? || is_a_comment ? line : "#{var}=#{template}"
+    end
+  end
+end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = '0.10.0'
+  VERSION = "2.8.0".freeze
 end

data/lib/dotenv.rb

@@ -1,33 +1,86 @@
-require 'dotenv/environment'
+require "dotenv/parser"
+require "dotenv/environment"
+require "dotenv/missing_keys"
 
+# The top level Dotenv module. The entrypoint for the application logic.
 module Dotenv
-  def self.load(*filenames)
-    default_if_empty(filenames).inject({}) do |hash, filename|
-      filename = File.expand_path filename
-      hash.merge(File.exists?(filename) ? Environment.new(filename).apply : {})
+  class << self
+    attr_accessor :instrumenter
+  end
+
+  module_function
+
+  def load(*filenames)
+    with(*filenames) do |f|
+      ignoring_nonexistent_files do
+        env = Environment.new(f, true)
+        instrument("dotenv.load", env: env) { env.apply }
+      end
+    end
+  end
+
+  # same as `load`, but raises Errno::ENOENT if any files don't exist
+  def load!(*filenames)
+    with(*filenames) do |f|
+      env = Environment.new(f, true)
+      instrument("dotenv.load", env: env) { env.apply }
     end
   end
 
   # same as `load`, but will override existing values in `ENV`
-  def self.overload(*filenames)
-    default_if_empty(filenames).inject({}) do |hash, filename|
-      filename = File.expand_path filename
-      hash.merge(File.exists?(filename) ? Environment.new(filename).apply! : {})
+  def overload(*filenames)
+    with(*filenames) do |f|
+      ignoring_nonexistent_files do
+        env = Environment.new(f, false)
+        instrument("dotenv.overload", env: env) { env.apply! }
+      end
     end
   end
 
-  # 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|
-        filename = File.expand_path filename
-        raise(Errno::ENOENT.new(filename)) unless File.exists?(filename)
+  # same as `overload`, but raises Errno::ENOENT if any files don't exist
+  def overload!(*filenames)
+    with(*filenames) do |f|
+      env = Environment.new(f, false)
+      instrument("dotenv.overload", env: env) { env.apply! }
+    end
+  end
+
+  # returns a hash of parsed key/value pairs but does not modify ENV
+  def parse(*filenames)
+    with(*filenames) do |f|
+      ignoring_nonexistent_files do
+        Environment.new(f, false)
       end
-    )
+    end
+  end
+
+  # Internal: Helper to expand list of filenames.
+  #
+  # Returns a hash of all the loaded environment variables.
+  def with(*filenames)
+    filenames << ".env" if filenames.empty?
+
+    filenames.reduce({}) do |hash, filename|
+      hash.merge!(yield(File.expand_path(filename)) || {})
+    end
+  end
+
+  def instrument(name, payload = {}, &block)
+    if instrumenter
+      instrumenter.instrument(name, payload, &block)
+    else
+      yield
+    end
+  end
+
+  def require_keys(*keys)
+    missing_keys = keys.flatten - ::ENV.keys
+    return if missing_keys.empty?
+    raise MissingKeys, missing_keys
   end
 
-protected
-  def self.default_if_empty(filenames)
-    filenames.empty? ? (filenames << '.env') : filenames
+  def ignoring_nonexistent_files
+    yield
+  rescue Errno::ENOENT
   end
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Brandon Keepers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !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'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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`.
@@ -46,65 +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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 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: []

data/.env

@@ -1 +0,0 @@
-DOTENV=true

data/.gitignore

@@ -1,8 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-tmp
-vendor

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - 1.8.7
-  - ree
-  - jruby-19mode
-  - rbx
-bundler_args: --without=guard

data/Changelog.md

@@ -1,95 +0,0 @@
-# Changelog
-
-## 0.10.0 - Feb 22, 2014
-
-* Add support for executing interpolated commands. (Ruby >= 1.9 only)
-
-        HEAD_SHA=$(git rev-parse HEAD)
-
-* Add `dotenv_role` option in Capistrano.
-
-        set :dotenv_role, [:app, web]
-
-* Add `Dotenv.overload` to overwrite existing environment values.
-
-## 0.9.0 - Aug 29, 2013
-
-* Add support for variable expansion.
-
-        HOST="example.com"
-        URL="http://${USER}@${HOST}"
-        ESCAPED_VARIABLE="this is \$NOT replaced"
-
-* Allow setting variables without a value.
-
-        BLANK=
-
-* Add `dotenv` executable to load `.env` for other scripts.
-
-        $ dotenv ./script.py
-
-[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.8.0...v0.9.0)
-
-## 0.8.0 - June 12, 2013
-
-* Added a capistrano recipe to symlink in `.env` on deploy.
-
-* Allow inline comments
-
-        VARIABLE=value # this is a comment
-
-* Raises Dotenv::FormatError when parsing fails
-
-[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.7.0...v0.8.0)
-
-## 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
-
-[Full Changelog](https://github.com/bkeepers/dotenv/compare/v0.6.0...v0.7.0)
-
-## 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
-
-[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'
-
-* 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,12 +0,0 @@
-source 'https://rubygems.org'
-gemspec :name => 'dotenv'
-
-group :guard do
-  gem 'guard-rspec'
-  gem 'guard-bundler'
-  gem 'rb-fsevent'
-end
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'         # if using anything in the ruby standard library
-end

data/Guardfile

@@ -1,9 +0,0 @@
-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/Rakefile

@@ -1,30 +0,0 @@
-#!/usr/bin/env rake
-
-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"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w[--color]
-  t.verbose = false
-end
-
-task :default => :spec

data/dotenv-rails.gemspec

@@ -1,18 +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         = ["lib/dotenv-rails.rb"]
-  gem.name          = "dotenv-rails"
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency 'dotenv', Dotenv::VERSION
-end

data/dotenv.gemspec

@@ -1,21 +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{Loads environment variables from `.env`.}
-  gem.summary       = %q{Loads environment variables from `.env`.}
-  gem.homepage      = "https://github.com/bkeepers/dotenv"
-  gem.license       = 'MIT'
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "dotenv"
-  gem.require_paths = ["lib"]
-
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-end

data/lib/dotenv/capistrano/recipes.rb

@@ -1,12 +0,0 @@
-Capistrano::Configuration.instance(:must_exist).load do
-  _cset(:dotenv_path){ "#{shared_path}/.env" }
-
-  symlink_args = (role = fetch(:dotenv_role, nil) ? {:roles => role} : {})
-
-  namespace :dotenv do
-    desc "Symlink shared .env to current release"
-    task :symlink, symlink_args do
-      run "ln -nfs #{dotenv_path} #{release_path}/.env"
-    end
-  end
-end

data/lib/dotenv/capistrano.rb

@@ -1,11 +0,0 @@
-require 'capistrano/version'
-
-if defined?(Capistrano::VERSION) && Capistrano::VERSION >= '3.0'
-  raise 'Please read https://github.com/bkeepers/dotenv#capistrano-integration to update your dotenv configuration for new Capistrano version'
-else
-  require 'dotenv/capistrano/recipes'
-
-  Capistrano::Configuration.instance(:must_exist).load do
-    before "deploy:finalize_update", "dotenv:symlink"
-  end
-end

data/lib/dotenv/format_error.rb

@@ -1,4 +0,0 @@
-module Dotenv
-  class FormatError < SyntaxError
-  end
-end

data/lib/dotenv/railtie.rb

@@ -1,14 +0,0 @@
-require 'dotenv'
-
-module Dotenv
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      desc 'Load environment settings from .env'
-      task :dotenv do
-        Dotenv.load ".env.#{Rails.env}", '.env'
-      end
-    end
-  end
-end
-
-Dotenv.load ".env.#{Rails.env}", '.env'

data/lib/dotenv-rails.rb

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