Initial Commit

- Added php-inc utility and docs

Signed-off-by: RJ Garcia <[email protected]>

Author: ragboyjr

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+/composer.lock
+/playground.php

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bighead Technology
+
+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.

README.md

@@ -0,0 +1,25 @@
+# Php Inc
+
+Php inc is a utility for generating a single include file of all the files that won't be auto loaded by a Psr compliant autoloader.
+
+Any files that hold functions or constants that don't belong in classes will need to be included manually, but managing all of the `require_once` declarations can be quite a pain.
+
+## Installation
+
+Install via composer at `krak/php-inc`
+
+## Usage
+
+### CLI
+
+The main interface is the `bin/php-inc` command which allows you to run generate a php source file with all of your project's require's.
+
+```
+./bin/php-inc {path-to-source} > src/inc.php
+```
+
+You may want to make sure your `inc.php` file (or whatever you decide to name it) is ignored by version control, and then generate the file when you build your project.
+
+### Integrating in your own Console Application
+
+If you are using Symfony or Laravel console application, you can just add the command to your own application with `Krak\PhpInc\Command\GenerateCommand`.

bin/php-inc

@@ -0,0 +1,17 @@
+#!/usr/bin/env php
+<?php
+
+$autoload_files = [
+    __DIR__ . '/../vendor/autoload.php',
+    __DIR__ . '/../../../autoload.php',
+];
+
+foreach ($autoload_files as $file) {
+    if (file_exists($file)) {
+        require_once $file;
+    }
+}
+
+$app = new Symfony\Component\Console\Application();
+$app->add(new Krak\PhpInc\Command\GenerateCommand());
+$app->run();

composer.json

@@ -0,0 +1,12 @@
+{
+    "autoload": {
+        "psr-4": {
+            "Krak\\PhpInc\\": "src"
+        },
+        "files": ["src/php-inc.php"]
+    },
+    "require": {
+        "nikic/iter": "^1.4",
+        "symfony/console": "^3.2"
+    }
+}

src/Command/GenerateCommand.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Krak\PhpInc\Command;
+
+use Krak\PhpInc,
+    Symfony\Component\Console;
+
+class GenerateCommand extends Console\Command\Command
+{
+    protected function configure() {
+        $this->setName('php-inc:generate')
+            ->setDescription('Generate a php inc file for source files')
+            ->addArgument(
+                'path',
+                Console\Input\InputArgument::REQUIRED,
+                'The path of the source files to scan for'
+            );
+    }
+
+    protected function execute(Console\Input\InputInterface $input, Console\Output\OutputInterface $output) {
+        $match = PhpInc\andMatch([
+            PhpInc\extMatch(['php']),
+            PhpInc\lowerCaseMatch(),
+            PhpInc\excludePathMatch('/.*\/Resources\/.*/'),
+        ]);
+        $scan = PhpInc\scanSrc($match);
+        $gen = PhpInc\genIncFile();
+        $phpinc = PhpInc\phpInc($scan, $gen);
+        $output->write($phpinc($input->getArgument('path')));
+    }
+}

src/php-inc.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Krak\PhpInc;
+
+use function iter\reduce,
+    iter\filter;
+
+/** only match lower case filenames */
+function lowerCaseMatch() {
+    return function($finfo) {
+        $first = $finfo->getFilename()[0];
+        return ctype_lower($first);
+    };
+}
+
+function extMatch($ext) {
+    if (!is_array($ext)) {
+        $ext = [$ext];
+    }
+
+    return function($finfo) use ($ext) {
+        return in_array($finfo->getExtension(), $ext);
+    };
+}
+
+/** exclude certain paths, if the path matches the re, it will be excluded */
+function excludePathMatch($path_re) {
+    return function($finfo) use ($path_re) {
+        $res = preg_match($path_re, $finfo->getPathname());
+        return !boolval($res);
+    };
+}
+
+function orMatch($matches) {
+    return function($finfo) use ($matches) {
+        foreach ($matches as $match) {
+            if ($match($finfo)) {
+                return true;
+            }
+        }
+
+        return false;
+    };
+}
+
+function andMatch($matches) {
+    return function($finfo) use ($matches) {
+        foreach ($matches as $match) {
+            if (!$match($finfo)) {
+                return false;
+            }
+        }
+
+        return true;
+    };
+}
+
+function scanSrc($match) {
+    return function($path) use ($match) {
+        $files = new \RecursiveDirectoryIterator($path);
+        $files = new \RecursiveIteratorIterator($files);
+        $files = filter(function($finfo) {
+            return $finfo->isFile();
+        }, $files);
+        $files = filter(function($file) use ($match) {
+            return $match($file);
+        }, $files);
+        return $files;
+    };
+}
+
+function genIncFile() {
+    return function($base, $files) {
+        $include_php = reduce(function($acc, $file) use ($base) {
+            return $acc . sprintf(
+                "require_once __DIR__ . '%s';\n",
+                str_replace($base, '', $file->getPathname())
+            );
+        }, $files, '');
+
+        return sprintf("<?php\n\n%s", $include_php);
+    };
+}
+
+function phpInc($scan, $gen) {
+    return function($path) use ($scan, $gen) {
+        $path = realpath($path);
+        return $gen($path, $scan($path));
+    };
+}