Merge pull request #4 from euantorano/fix/3-directory-paths

Overhaul parsing and alter API surface

.env.example

@@ -1,9 +1,10 @@
-# This is an exampe `.env` file.
+# This is an example `.env` file.
 # Comments start with `#`. Values are assigned as follows:
 
-SIMPLE_VAL = test
-ANOTHER_SIMPLE_VAL = "test" # the value will just be `test`, without quotes
-MULTILINE_VAL = """This value
+SIMPLE_VAL=test
+ANOTHER_SIMPLE_VAL="test" # the value will just be `test`, without quotes
+MULTILINE_VAL="""This value
 
 will span multiple lines, just like in Nim
+
 """

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Build And Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nim-versions: ['1.6.2', '1.4.8', 'stable']
+    steps:
+      - uses: actions/checkout@v2
+      - uses: jiro4989/setup-nim-action@v1
+        with:
+          nim-version: ${{ matrix.nim-versions }}
+      - run: nimble test -y

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Euan T.
+Copyright (c) 2016, 2022, Euan Torano.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,4 +1,4 @@
-# dotenv.nim [![CircleCI](https://circleci.com/gh/euantorano/dotenv.nim/tree/master.svg?style=svg)](https://circleci.com/gh/euantorano/dotenv.nim/tree/master)
+# dotenv.nim
 
 [dotenv](https://github.com/bkeepers/dotenv) implementation for Nim. Loads environment variables from `.env`
 
@@ -17,11 +17,9 @@ Or add the following to your `.nimble` file:
 ```
 # Dependencies
 
-requires "dotenv >= 1.1.0"
+requires "dotenv >= 2.0.0"
 ```
 
-## [Documentation](https://htmlpreview.github.io/?https://github.com/euantorano/dotenv.nim/blob/master/docs/dotenv.html)
-
 ## Usage
 
 ### Create a `.env` file
@@ -53,26 +51,33 @@ You can also add comments, using the `#` symbol:
 DB_NAME=test # Or they can follow an assignment
 ```
 
+Variable values can reference other variables - either from the same `.env` file, or from the existing environment variables:
+
+```
+CONFIG_DIR=${HOME}/.config
+CONFIG_FILE=${CONFIG_DIR}/config.json
+```
+
+* Variables are referenced either using `${VARIABLE}` or as simply `$VARIABLE`.
+* Variables do not need to be defined before usage.
+* Unknown variables are replaced with empty strings.
+
 ### Loading the `.env` file
 
 You can load the `.env` file from the current working directory as follows:
 
 ```nim
 import dotenv
 
-let env = initDotEnv()
-env.load()
-
-# You can now access the variables using os.getEnv()
+load()
 ```
 
 Or, you can specify the path to the directory and/or file:
 
 ```nim
 import dotenv
 
-let env = initDotEnv("/some/directory/path", "custom_file_name.env")
-env.load()
+load("/some/directory/path", "custom_file_name.env")
 
 # You can now access the variables using os.getEnv()
 ```
@@ -82,26 +87,21 @@ By default, `dotenv` does not overwrite existing environment variables, though t
 ```nim
 import dotenv
 
-let env = initDotEnv()
-env.overload()
+overload()
 
 # You can now access the variables using os.getEnv()
 ```
 
 ### Loading from a string
 
-You can also load environment variables directly from a string without instantiating a `DotEnv` instance:
+You can also load environment variables directly from a string using `std/streams`:
 
 ```nim
-import dotenv, os
+import dotenv, std/streams
+
+load(newStringStream("""hello = world
+foo = bar
+"""))
 
-loadEnvFromString("""hello = world
-    foo = bar
-    """)
 assert getEnv("foo") == "bar"
 ```
-
-## Planned features
-
-* Allow the usage of other environment variables inside variable values.
-* Add validation of variable values, specifying variables have to be integer, or boolean, or a value from a predefined set.