dotenv 2.7.1 → 2.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0992bc73a32f12b64e16572e15cbde78e9767730ed5aae4ea2e986e8ef98d81f'
-  data.tar.gz: 3c9209567d61c87b38a6077550a9c489f3b3b5d441c247ca6563a17ac91f3923
+  metadata.gz: f9897791ad9e8b033e9bf66513f4f53bd1afb7fa2d925995bcd4f46c6edff8f7
+  data.tar.gz: 4bff08bdfbdc9f5709626ab2b46ed098d5c602ccfcb8063457f238dabf459f43
 SHA512:
-  metadata.gz: c3109086cd8ad5b552bca4d4f219fe2a6e670eb66430c034010be2e8e60bda81c177e80f0a0c32be01c13c3509252d924e4aa40c4916039a9867c6801045eb64
-  data.tar.gz: 2b59d23bde10b3d1521b681aa04cad979d127c965610c1e9995f12b3e14fa4d0bbb6e56485fbe5ff2bf3cc3eb12fc8c16b156b59ea04c38b41f95ca73881c913
+  metadata.gz: 9594d44181f64067dd47b0e4a86a534620aa09278774ad8c86f08bb6d2d35f45d27a724a16207aee9189f508e00f102686c562d85f2feffd45fe506b6451f828
+  data.tar.gz: 9352577bba48b8f713914b1688f17355fc543b4b004a918889ffc1a83dda939e60597ea49c6ef9f3aad7dfcc48fd837fefa4746dfa783088429ea96ffb7fbaed

data/README.md

@@ -62,7 +62,7 @@ Dotenv.load
 
 By default, `load` will look for a file called `.env` in the current working directory. Pass in multiple files and they will be loaded in order. The first value set for a variable will win.
 
-```
+```ruby
 require 'dotenv'
 Dotenv.load('file1.env', 'file2.env')
 ```
@@ -218,6 +218,29 @@ If you use this gem to handle env vars for multiple Rails environments (developm
 
 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.
 
+
+You can use the `-t` or `--template` flag on the dotenv cli to create a template of your `.env` file.
+```shell
+$ dotenv -t .env
+```
+A template will be created in your working directory named `{FINAME}.template`. So in the above example, it would create a `.env.template` file. 
+
+The template will contain all the environment variables in your `.env` file but with their values set to the variable names.
+
+```shell
+# .env
+S3_BUCKET=YOURS3BUCKET
+SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+Would become 
+
+```shell
+# .env.template
+S3_BUCKET=S3_BUCKET
+SECRET_KEY=SECRET_KEY
+```
+
 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.
 
 ### Why is it not overriding existing `ENV` variables?

data/lib/dotenv/cli.rb

@@ -1,17 +1,17 @@
 require "dotenv"
 require "dotenv/version"
+require "dotenv/template"
 require "optparse"
 
 module Dotenv
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    attr_reader :argv, :exec_args, :parser_args, :filenames
+    attr_reader :argv, :filenames
 
     def initialize(argv = [])
       @argv = argv.dup
       @filenames = []
-      @flag_matchers = []
     end
 
     def run
@@ -22,7 +22,7 @@ module Dotenv
       rescue Errno::ENOENT => e
         abort e.message
       else
-        exec(*@exec_args) unless @exec_args.empty?
+        exec(*@argv) unless @argv.empty?
       end
     end
 
@@ -30,56 +30,44 @@ module Dotenv
 
     def parse_argv!(argv)
       parser = create_option_parser
-      add_options(parser, @flag_matchers)
-      @parser_args, @exec_args = split_argv(argv.join(" "), @flag_matchers)
-      parser.parse! @parser_args
+      add_options(parser)
+      parser.order!(argv)
 
       @filenames
     end
 
-    def add_options(parser, flag_matchers)
-      add_files_option(parser, flag_matchers)
-      add_help_option(parser, flag_matchers)
-      add_version_option(parser, flag_matchers)
+    def add_options(parser)
+      add_files_option(parser)
+      add_help_option(parser)
+      add_version_option(parser)
+      add_template_option(parser)
     end
 
-    def add_files_option(parser, flag_matchers)
-      flag_matchers.push("-f \\S+")
+    def add_files_option(parser)
       parser.on("-f FILES", Array, "List of env files to parse") do |list|
         @filenames = list
       end
     end
 
-    def add_help_option(parser, flag_matchers)
-      flag_matchers.push("-h", "--help")
+    def add_help_option(parser)
       parser.on("-h", "--help", "Display help") do
         puts parser
         exit
       end
     end
 
-    def add_version_option(parser, flag_matchers)
-      flag_matchers.push("-v", "--version")
+    def add_version_option(parser)
       parser.on("-v", "--version", "Show version") do
         puts "dotenv #{Dotenv::VERSION}"
         exit
       end
     end
 
-    # Detect dotenv flags vs executable args so we can parse properly and still
-    # take advantage of OptionParser for dotenv flags
-    def split_argv(arg_string, matchers)
-      matcher     = /^((?:#{matchers.join("|")})\s?)?(.+)?$/
-      data        = matcher.match(arg_string)
-      dotenv_args = []
-      exec_args   = []
-
-      unless data.nil?
-        dotenv_args = (!data[1].nil? ? data[1].split(" ") : [])
-        exec_args   = (!data[2].nil? ? data[2].split(" ") : [])
+    def add_template_option(parser)
+      parser.on("-t", "--template=FILE", "Create a template env file") do |file|
+        template = Dotenv::EnvTemplate.new(file)
+        template.create_template
       end
-
-      [dotenv_args, exec_args]
     end
 
     def create_option_parser

data/lib/dotenv/parser.rb

@@ -12,21 +12,21 @@ module Dotenv
       [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
-        '(?:\\'|[^'])*'  #   single quoted value
-        |                #   or
-        "(?:\\"|[^"])*"  #   double quoted value
-        |                #   or
-        [^\#\r\n]+       #   unquoted value
-      )?                 # value end
-      \s*                # trailing whitespace
-      (?:\#.*)?          # optional comment
-      (?:$|\z)           # end of 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

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 = "2.7.1".freeze
+  VERSION = "2.7.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.7.6
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,6 +72,7 @@ files:
 - lib/dotenv/substitutions/command.rb
 - lib/dotenv/substitutions/variable.rb
 - lib/dotenv/tasks.rb
+- lib/dotenv/template.rb
 - lib/dotenv/version.rb
 homepage: https://github.com/bkeepers/dotenv
 licenses:
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Loads environment variables from `.env`.