initial commit

.bldr.yml

@@ -0,0 +1,16 @@
+api_branch : origin/master
+api_parser : ~
+api_cfgmod : clone
+api_runner : ~
+api_paths  : lib
+env_make   : ~
+env_prep   : get-composer
+env_post   : ci-coveralls,ci-codacy
+php_conf   : timezone
+php_exts   : ~
+app_prep   : dep-composer
+app_post   : ~
+app_path   : ~
+pkg_name   : augustus-file-lock-library
+pkg_desc   : "a simple file locking abstraction layer"
+pkg_bndl   : false

.coveralls.yml

@@ -0,0 +1,4 @@
+---
+
+coverage_clover : var/build/clover.xml
+json_path       : var/build/coveralls-upload.json

.editorconfig

@@ -0,0 +1,13 @@
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+
+[*.{js|css|scss|less|yml|json}]
+indent_size = 2

.gitignore

@@ -0,0 +1,67 @@
+
+#
+# This file is part of the `src-run/augustus-file-lock-library` project.
+#
+# (c) Rob Frawley 2nd <rmf@src.run>
+#
+# For the full copyright and license information, view the LICENSE.md
+# file distributed with this source code.
+#
+
+# Symfony 2
+/app/cache/*
+/app/logs/*
+!app/cache/.gitkeep
+!app/logs/.gitkeep
+
+# Symfony 3
+/var/cache/*
+/var/logs/*
+!var/cache/.gitkeep
+!var/logs/.gitkeep
+
+# Symfony/Silex/Other Parameter Files
+/app/config/parameters.yml
+/app/config/parameters.ini
+
+# Composer-created Directories
+/app/bootstrap.php.cache
+/var/bootstrap.php.cache
+/vendor/
+/composer.lock
+/composer
+/composer.phar
+
+# Generated Assets
+/web/bundles/
+/web/uploads/
+/web/css/
+/web/js/
+/web/compiled
+
+# PHPUnit (Non-Dist)
+/phpunit.xml
+
+# Build data
+/build/*
+!build/.gitkeep
+
+# IDEA Directories
+/.idea/
+
+# Scribe-Specific
+/app/config/sami.php
+/config/
+
+# libraries don't need bin, var directories
+/bin/
+/var/
+
+# Remember to Use *.md Variants
+LICENSE
+README
+
+# phpcsfixer cache
+.php_cs.cache
+
+# EOF

.gitmodules

@@ -0,0 +1,3 @@
+[submodule ".bldr"]
+	path = .bldr
+	url = https://github.com/src-run/usr-src-builder.git

.php_cs.dist

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the `src-run/augustus-file-lock-library` project.
+ *
+ * (c) Rob Frawley 2nd <rmf@src.run>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+use SLLH\StyleCIBridge\ConfigBridge;
+
+require_once __DIR__.'/vendor/autoload.php';
+
+$headerString = <<<EOF
+This file is part of the `src-run/augustus-file-lock-library` project.
+
+(c) Rob Frawley 2nd <rmf@src.run>
+
+For the full copyright and license information, please view the LICENSE.md
+file that was distributed with this source code.
+EOF;
+
+$headerConfig = [ 'header_comment' => [ 'header' => $headerString ] ];
+
+$config = ConfigBridge::create();
+$config->setRules(array_merge($config->getRules(), $headerConfig));
+
+return $config;

.styleci.yml

@@ -0,0 +1,25 @@
+---
+
+preset: symfony
+
+enabled:
+  - combine_consecutive_unsets
+  - linebreak_after_opening_tag
+  - no_short_echo_tag
+  - ordered_imports
+  - phpdoc_order
+  - php_unit_construct
+  - php_unit_dedicate_assert
+  - php_unit_strict
+  - short_array_syntax
+
+disabled:
+  - simplified_null_return
+  - long_array_syntax
+
+finder :
+  name    : [ "*.php", "*.twig" ]
+  exclude : [ "vendor", "var" ]
+  path    : [ "lib", "test" ]
+
+...

.travis.yml

@@ -0,0 +1,35 @@
+---
+
+##
+# This file is part of the `src-run/augustus-file-lock-library` project.
+#
+# (c) Rob Frawley 2nd <rmf@src.run>
+# (c) Scribe Inc      <scr@src.run>
+#
+# For the full copyright and license information, view the LICENSE.md
+# file distributed with this source code.
+##
+
+sudo     : false
+language : php
+php      : [ 5.6, 7.0 ]
+
+git:
+  depth : 3
+
+env:
+  global:
+    - secure: "DqnBUAcYsPfJWO/4ejBTpWbywGsVqEfz22FFopCSb9DC63BByww60Amisrf8rT21w3UiVZcgXErl7nS/ms7sfVnrXVEfqN03MtT8chjTEMFQfALQ1YxXpzcwPjK64t6Gf+6MRo7LqdVNAKjvUq6JvwdwyDBTZdaCjfnU5XJZNJlWopr92TFbzL6eOm2aitK85PRteszfu6XpaK2zJzJcJIcCXuSWf0yq7P6+beEdxyUFrDcISI2hU4xCmC6s3jaXmGu1VyIjVXlau2P3SEEjhDNPWioF3LpmtVPxp9nAtU5c8nnfzukl1R7imTeEAoudznfAt9+FtkF4C5oKS+mAdRtoCvYvIXAferoPxnhgNP6KCQ8sHHm1u0UDvaqylt3BwO9C/KAm1r6y/iSGP+X6Z4LJFh7chTopabNBf93JXoIyjKURCANKtMzEnHYrdGPvMBI5DOdXZj0r0VzjZFNxGk95cmRZFd39JXtG1IHKe5+Ahj59WY1fZQSCeyx6ijELuFapGavmKj6xKDJfVOcWiVNO7oRnERJparLhDuuUiLqiocf0tB8QAncYyYwp8s6ypFOv/ILvcjJVGRfSw2f2ribJkvPamYcP3gmblJdwvcMi6K6A6G8HUyNZOcoJRbQg4iWhE964tOH7ytIbbnUZxzKINd7dtqPi9x09+v2gsvs="
+
+install :
+  - bash .bldr/bldr -b up-env -q
+  - bash .bldr/bldr -b up-app -q
+
+script :
+  - bin/phpunit -vvv
+
+after_script :
+  - bash .bldr/bldr -b down-app -q
+  - bash .bldr/bldr -b down-env -q
+
+...

CONTRIBUTING.md

@@ -0,0 +1,90 @@
+
+# Contributing
+
+Made some local modifications that might benefit upstream and have a
+motivation to contribute back to this project? Great! Before opening a
+PR (pull request), though, be sure the code style requirements standards
+described in this file have been met. This will expedite your PR and
+ensure a seamless experience in pushing your code back upstream.
+
+## A. Code Style
+
+All projects must adhere to strict code style requirements. Ensuring
+your PR meets these requirements is now easier than ever thanks to 
+the excellent code styling auto-correcting CLI tool
+[PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
+
+### Get Development Deps
+
+You no longer have to download PHP CS Fixer yourself or have it pre-
+installed globally on your system. Instead, it's a composer development
+dependency. If you don't already have the development dependencies
+installed, simply run (assuming you have composer installed globally on
+your system):
+
+```bash
+composer install --dev
+```
+
+### Run PHP CS Fixer
+
+Thanks to the recently added `.styleci.yml` (a style rule-set config
+files) and `.php_cs.dist` (a php-cs-fixer bridge to read `.styleci.yml`
+for its config) you do not have to provide any configuration parameters
+to PHP CS Fixer. Simply enter the repository root and run:
+
+```bash
+bin/php-cs-fixer fix ./
+```
+
+This ensures all code style rules are implemented and auto corrects any
+inconsistencies. It also forcibly sets the PHP file-level doc-blocks,
+which may remove any attributes you set if they were in the file-level
+php doc-block. Don't fret: the next section describes acceptable 
+attribution methods (if you require such).
+
+## B. Attribution
+
+Attribution for yourself is 100% optional, but in some cases people
+prefer an explicit doc-block `@author` attribution for all classes or
+methods they wrote entirely themselves. If this is the case, the only
+acceptable places to add attribution tags is in a *class doc-block* or 
+a *method doc-block*. The below example show how to implement atribution
+for both these cases.
+
+```php
+/**
+ * ...
+ * File-level doc-block goes here automatically...
+ * ...
+ */
+
+/**
+ * A description of the purpose of this class.
+ *
+ * @author CONTRIBUTOR_NAME <CONTRIBUTOR_EMAIL>
+ */
+class ReallyCoolContributedClass
+{
+    // ...
+
+    /**
+     * A description of the purpose of this method.
+     *
+     * @author CONTRIBUTOR_NAME <CONTRIBUTOR_EMAIL>
+     */
+    public function myWonderfulMethod()
+    {
+        // ...
+    }
+
+    // ...
+}
+```
+
+## C. Submit PR
+
+After completing the above requirements (items **A.** and **B.**) your
+code is primed and ready to be accepted upstream. Go ahead and open a
+PR: we appreciate your time and contribution to this project, however
+small or large!

LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+**Copyright © 2016 Rob Frawley 2nd <[rmf at src dot run](rmf@src.run)>**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+*The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.*
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.