Changed default file to .yml extension, instead of .yaml to better match common practices.

Author: Jochem

README.md

@@ -1,15 +1,15 @@
 Maatwebsite\Yamlenv
 ==========
 
-Reads env.yaml and makes a validated list of variables available as environment variables. 
+Reads env.yml and makes a validated list of variables available as environment variables. 
 
 This is package is based on [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv).
 
 [![Build Status](https://travis-ci.org/Maatwebsite/yamlenv.svg?branch=master)](https://travis-ci.org/Maatwebsite/yamlenv.svg?branch=master)
 
-Why choose Yaml over env.yaml?
+Why choose Yaml over env.yml?
 ---------
-The benefits of using a env.yaml file or similar has been proven a long time ago. 
+The benefits of using a env.yml file or similar has been proven a long time ago. 
 The popularity of [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv) and 
 similar packages is a testament of this. 
 There is no reason why you shouldn't use a package like that in your projects, 
@@ -19,7 +19,7 @@ In case of larger, enterprise scale, applications, the amount of environment
 settings might very quickly become unmanageable. If it's a multi tenant system een more so. And if you're supporting different versions of the application with it's own list of required environment settings, it soon becomes a necessity to automate this process. 
 
 These are largely the reasons we decided to move towards Yaml. It provides 
-a few simple advantages over env.yaml files:
+a few simple advantages over env.yml files:
 * It allows nesting, to allow grouping of certain settings ( like database 
 connection credentials ).
 * It is easily readable by human as well as multiple automated deployment 
@@ -46,30 +46,30 @@ great base to work from!
 
 Of course there are a few things unique to Yamlenv, and that has been added as well. 
 
-The `env.yaml` file is generally kept out of version control since it can contain
-sensitive API keys and passwords. A separate `env.yaml.dist` file can be created
+The `env.yml` file is generally kept out of version control since it can contain
+sensitive API keys and passwords. A separate `env.yml.dist` file can be created
 with all the required environment variables defined except for the sensitive
 ones, which are either user-supplied for their own development environments or
 are communicated elsewhere to project collaborators. The project collaborators
-then independently copy the `env.yaml.dist` file to a local `env.yaml` and ensure
+then independently copy the `env.yml.dist` file to a local `env.yml` and ensure
 all the settings are correct for their local environment, filling in the secret
-keys or providing their own values when necessary. In this usage, the `env.yaml`
+keys or providing their own values when necessary. In this usage, the `env.yml`
 file should be added to the project's `.gitignore` file so that it will never
 be committed by collaborators.  This usage ensures that no sensitive passwords
 or API keys will ever be in the version control history so there is less risk
 of a security breach, and production values will never have to be shared with
 all project collaborators.
 
-Add your application configuration to a `env.yaml` file in the root of your
-project. **Make sure the `env.yaml` file is added to your `.gitignore` so it is not
+Add your application configuration to a `env.yml` file in the root of your
+project. **Make sure the `env.yml` file is added to your `.gitignore` so it is not
 checked-in the code**
 
 ```shell
 S3_BUCKET: "yamlenv"
 SECRET_KEY: "secret_key"
 ```
 
-Now create a file named `env.yaml.dist` and check this into the project. This
+Now create a file named `env.yml.dist` and check this into the project. This
 should have the ENV variables you need to have set, but the values should
 either be blank or filled with dummy data. The idea is to let people know what
 variables are required, but not give them the sensitive production values.
@@ -79,14 +79,14 @@ S3_BUCKET: "devbucket"
 SECRET_KEY: "abc123"
 ```
 
-You can then load `env.yaml` in your application with:
+You can then load `env.yml` in your application with:
 
 ```php
 $yamlenv = new Yamlenv\Yamlenv(__DIR__);
 $yamlenv->load();
 ```
 
-Optionally you can pass in a filename as the second parameter, if you would like to use something other than `env.yaml`
+Optionally you can pass in a filename as the second parameter, if you would like to use something other than `env.yml`
 
 ```php
 $yamlenv = new Yamlenv\Yamlenv(__DIR__, 'myconfig');
@@ -122,7 +122,7 @@ s3_bucket: "will_be_uppercase"
 ```
 
 ```php
-$yamlenv = new Yamlenv\Yamlenv(__DIR__, 'emv.yaml', true);
+$yamlenv = new Yamlenv\Yamlenv(__DIR__, 'emv.yml', true);
 $yamlenv->load();
 ```
 
@@ -253,7 +253,7 @@ allowed value
 
 ### Comments
 
-You can comment your `env.yaml` file using the `#` character. E.g.
+You can comment your `env.yml` file using the `#` character. E.g.
 This follows the normal Yaml syntax rules
 
 ```shell
@@ -281,18 +281,12 @@ Usage Notes
 -----------
 
 When a new developer clones your codebase, they will have an additional
-**one-time step** to manually copy the `env.yaml.dist` file to `env.yaml` and fill-in
+**one-time step** to manually copy the `env.yml.dist` file to `env.yml` and fill-in
 their own values (or get any sensitive values from a project co-worker).
 
 Yamlenv is made for development environments, and generally should not be
 used in production. In production, the actual environment variables should be
-set so that there is no overhead of loading the `env.yaml` file on each request.
+set so that there is no overhead of loading the `env.yml` file on each request.
 This can be achieved via an automated deployment process with tools like
 Vagrant, chef, or Puppet, or can be set manually with cloud hosts like
 Pagodabox and Heroku.
-
-### Command Line Scripts
-
-If you need to use environment variables that you have set in your `env.yaml` file
-in a command line script that doesn't use the Yamlenv library, you can `source`
-it into your local shell session:

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "maatwebsite/yamlenv",
-    "description": "Reads `env.yaml` and makes a validated list of variables available as environment variables",
+    "description": "Reads `env.yml` and makes a validated list of variables available as environment variables",
     "keywords": ["env", "yaml", "environment"],
     "license" : "LGPL",
     "authors" : [

src/Yamlenv.php

@@ -32,7 +32,7 @@ class Yamlenv
      * @param string $file
      * @param bool   $castToUpper
      */
-    public function __construct($path, $file = 'env.yaml', $castToUpper = false)
+    public function __construct($path, $file = 'env.yml', $castToUpper = false)
     {
         $this->filePath    = $this->getFilePath($path, $file);
         $this->castToUpper = $castToUpper;
@@ -100,7 +100,7 @@ public function getLoader()
     protected function getFilePath($path, $file)
     {
         if (!is_string($file)) {
-            $file = 'env.yaml';
+            $file = 'env.yml';
         }
 
         $filePath = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $file;

tests/Yamlenv/LoaderTest.php

@@ -48,7 +48,7 @@ function apache_setenv($string) {
 
     public function setUp()
     {
-        $this->folder = dirname(__DIR__) . '/fixtures/valid/env.yaml';
+        $this->folder = dirname(__DIR__) . '/fixtures/valid/env.yml';
 
         // Generate a new, random keyVal.
         $this->keyVal(true);
@@ -138,7 +138,7 @@ public function testFlattenNestedValuesThrowsExceptionWithDuplication()
     {
         $this->clearEnv();
 
-        $immutableLoader = new Loader(dirname(__DIR__) . '/fixtures/valid/duplicates_nested.yaml', true);
+        $immutableLoader = new Loader(dirname(__DIR__) . '/fixtures/valid/duplicates_nested.yml', true);
         $immutableLoader->load();
     }
 

tests/Yamlenv/YamlenvTest.php

@@ -42,7 +42,7 @@ public function testCommentedYamlenvLoadsEnvironmentVars()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'commented.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'commented.yml');
         $yamlenv->load();
         $this->assertSame('bar', getenv('CFOO'));
         $this->assertFalse(getenv('CBAR'));
@@ -57,7 +57,7 @@ public function testQuotedYamlenvLoadsEnvironmentVars()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'quoted.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'quoted.yml');
         $yamlenv->load();
         $this->assertSame('bar', getenv('QFOO'));
         $this->assertSame('baz', getenv('QBAR'));
@@ -73,7 +73,7 @@ public function testQuotedYamlenvLoadsEnvironmentVars()
      */
     public function testSpacedValuesWithoutQuotesThrowsException()
     {
-        $yamlenv = new Yamlenv(dirname(__DIR__) . '/fixtures/invalid', 'invalid.yaml');
+        $yamlenv = new Yamlenv(dirname(__DIR__) . '/fixtures/invalid', 'invalid.yml');
         $yamlenv->load();
     }
 
@@ -155,7 +155,7 @@ public function testYamlenvNestedEnvironmentVars()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'nested.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'nested.yml');
         $yamlenv->load();
 
         $this->assertSame('Hello', $_ENV['NVAR1']);
@@ -230,7 +230,7 @@ public function testYamlenvTrimmedKeys()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'quoted.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'quoted.yml');
         $yamlenv->load();
         $this->assertSame('no space', getenv('QWHITESPACE'));
     }
@@ -240,7 +240,7 @@ public function testYamlenvLoadDoesNotOverwriteEnv()
         $this->clearEnv();
 
         putenv('IMMUTABLE=true');
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yml');
         $yamlenv->load();
 
         $this->assertSame('true', getenv('IMMUTABLE'));
@@ -251,7 +251,7 @@ public function testYamlenvLoadAfterOverload()
         $this->clearEnv();
 
         putenv('IMMUTABLE=true');
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yml');
         $yamlenv->overload();
         $this->assertSame('false', getenv('IMMUTABLE'));
 
@@ -265,7 +265,7 @@ public function testYamlenvOverloadAfterLoad()
         $this->clearEnv();
 
         putenv('IMMUTABLE=true');
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'immutable.yml');
         $yamlenv->load();
         $this->assertSame('true', getenv('IMMUTABLE'));
 
@@ -278,7 +278,7 @@ public function testYamlenvOverloadDoesOverwriteEnv()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'mutable.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'mutable.yml');
         $yamlenv->overload();
         $this->assertSame('true', getenv('MUTABLE'));
     }
@@ -287,7 +287,7 @@ public function testYamlenvAllowsSpecialCharacters()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'specialchars.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'specialchars.yml');
         $yamlenv->load();
         $this->assertSame('$a6^C7k%zs+e^.jvjXk', getenv('SPVAR1'));
         $this->assertSame('?BUty3koaV3%GA*hMAwH}B', getenv('SPVAR2'));
@@ -300,7 +300,7 @@ public function testYamlenvConvertsToUppercase()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'lowercase.yaml', true);
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'lowercase.yml', true);
         $yamlenv->load();
 
         $validator = $yamlenv->required([
@@ -320,7 +320,7 @@ public function testYamlenvFailsIfNotConvertedToUppercase()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'lowercase.yaml', false);
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'lowercase.yml', false);
         $yamlenv->load();
 
         $yamlenv->required([
@@ -334,7 +334,7 @@ public function testYamlenvAssertions()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yml');
         $yamlenv->load();
         $this->assertSame('val1', getenv('ASSERTVAR1'));
         $this->assertEmpty(getenv('ASSERTVAR2'));
@@ -373,7 +373,7 @@ public function testYamlenvEmptyThrowsRuntimeException()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yml');
         $yamlenv->load();
         $this->assertEmpty(getenv('ASSERTVAR2'));
 
@@ -388,7 +388,7 @@ public function testYamlenvStringOfSpacesConsideredEmpty()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yml');
         $yamlenv->load();
         $this->assertEmpty(getenv('ASSERTVAR3'));
 
@@ -403,7 +403,7 @@ public function testYamlenvHitsLastChain()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yml');
         $yamlenv->load();
         $yamlenv->required('ASSERTVAR3')->notEmpty();
     }
@@ -416,7 +416,7 @@ public function testYamlenvValidateRequiredWithoutLoading()
     {
         $this->clearEnv();
 
-        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yaml');
+        $yamlenv = new Yamlenv($this->fixturesFolder, 'assertions.yml');
         $yamlenv->required('foo');
     }