Initial commit

Author: Roy Freij

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,6 @@
+*.swp
+.DS_Store
+vendor/
+composer.lock
+storage/
+bootstrap/

.scrutinizer.yml

@@ -0,0 +1,26 @@
+build:
+    nodes:
+        analysis:
+            project_setup:
+                override: true
+            tests:
+                override: [php-scrutinizer-run]
+
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+
+php:
+    - 7.0
+    - 7.1
+    - 7.2
+
+before_script:
+    - travis_retry composer self-update
+    - travis_retry composer install --no-interaction --prefer-source --dev
+
+script: vendor/bin/phpunit
+
+after_success:
+    - travis_retry php vendor/bin/php-coveralls

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Roy Freij
+
+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,35 @@
+# laravel-package-boilerplate
+
+Boilerplate for Laravel packages. Use it as a starting point for your own Laravel packages.
+
+Includes PHPUnit and PHPCodeSniffer configuration, as well as a known good Travis CI configuration and a couple of base test cases. Uses `orchestra/testbench` as the basis of the provided base test.
+
+Also includes my [Artisan Standalone](https://github.com/matthewbdaly/artisan-standalone) package as a development dependency. As a result, you should be able to run Artisan commands as follows:
+
+```bash
+vendor/bin/artisan make:model Example
+```
+
+How do I use it?
+----------------
+###### Step 1
+```bash
+composer create-project matthewbdaly/laravel-package-boilerplate <YOUR_NEW_PACKAGE_DIRECTORY>
+```
+
+This will generate a starting boilerplate for your app.
+
+###### Step 2
+You'll want to update your `composer.json` with your required namespace and other details - you can do this by running
+```bash
+ vendor/bin/artisan app:name InsertYourProjectNameHere
+ ```
+
+Test cases
+----------
+
+The package includes three test cases:
+
+* `TestCase` - Effectively the normal Laravel test case. Use it the same way you would your normal Laravel test case
+* `SimpleTestCase` - Extends the default PHPUnit test case, so it doesn't set up a Laravel application, making it quicker and well-suited to properly isolated unit tests
+* `BrowserKitTestCase` - Sets up BrowserKit

composer.json

@@ -0,0 +1,48 @@
+{
+    "name": "netcreaties/laravel-modulize",
+    "description": "Creating easy to use modules without having to configure them.",
+    "type": "library",
+    "keywords": ["laravel"],
+    "require": {},
+    "require-dev": {
+        "matthewbdaly/artisan-standalone": "0.0.*",
+        "mockery/mockery": "~1.0",
+        "orchestra/testbench": "^3.7",
+        "orchestra/testbench-browser-kit": "^3.7",
+        "php-coveralls/php-coveralls": "^2.1",
+        "phpstan/phpstan": "^0.10.5",
+        "phpunit/phpunit": "^7.0",
+        "psy/psysh": "^0.9.8",
+        "sebastian/phpcpd": "^4.0",
+        "squizlabs/php_codesniffer": "^3.3"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Roy Freij",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "LaravelModulize\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true,
+        "optimize-autoloader": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "LaravelModulize\\Providers\\ModulizeServiceProvider"
+            ]
+        }
+    }
+}

phpcs.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+	<description>Coding standard for Laravel package boilerplate.</description>
+	<file>src</file>
+	<arg value="np"/>
+	<rule ref="PSR2"/>
+	<rule ref="Squiz.Commenting.FunctionComment" />
+	<rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
+	<rule ref="Squiz.Commenting.ClassComment" />
+</ruleset>

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 7
+	paths: ['src/']
+	autoload_files:
+		- vendor/autoload.php

phpunit.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Tests">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="CACHE_DRIVER" value="array"/>
+        <env name="SESSION_DRIVER" value="array"/>
+        <env name="QUEUE_DRIVER" value="sync"/>
+        <env name="DB_CONNECTION" value="sqlite"/>
+        <env name="DB_DATABASE" value=":memory:"/>
+    </php>
+</phpunit>

src/Contracts/LoadsFiles.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace LaravelModulize\Contracts;
+
+use Illuminate\Support\Collection;
+
+interface LoadsFiles
+{
+    public function bootstrap(): void;
+
+    public function getFilesPath(string $module): string;
+
+    public function getFilesToLoad(string $module): Collection;
+
+    public function getNamespace(string $module): string;
+
+    public function loadFiles(string $module): void;
+}

src/Contracts/ModulizerRepositoryInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace LaravelModulize\Contracts;
+
+use Illuminate\Support\Collection;
+
+interface ModulizerRepositoryInterface
+{
+    public function getBasePath(): string;
+
+    public function hasModules(): bool;
+
+    public function getModules(): Collection;
+
+    public function getModulePath(string $module): string;
+
+    public function getFiles(string $path): Collection;
+
+    public function getRootNamespace(): string;
+
+}

src/Providers/ModulizeServiceProvider.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace LaravelModulize\Providers;
+
+use Illuminate\Filesystem\Filesystem;
+use LaravelModulize\Services\Modulizer;
+use LaravelModulize\Services\ModulizerRepository;
+use LaravelModulize\Contracts\ModulizerRepositoryInterface;
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+
+/**
+ * Service provider
+ */
+class ModulizeServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        // $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+        // $this->loadRoutesFrom(__DIR__.'/../../routes.php');
+        // $this->loadViewsFrom(__DIR__.'/../views', 'packagename');
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton(ModulizerRepository::class, function ($app) {
+            return new ModulizerRepository(new Filesystem());
+        });
+
+        $this->app->bind(
+            ModulizerRepositoryInterface::class,
+            ModulizerRepository::class
+        );
+
+        $this->app->singleton('modulizer', function ($app) {
+            return new Modulizer($app);
+        });
+
+        $this->mergeConfigFrom(
+            $this->getDefaultConfigFilePath('modulizer'), 'modulizer'
+        );
+    }
+
+
+    /**
+     * Get default configuration file path
+     *
+     * @return string
+     */
+    public function getDefaultConfigFilePath($configName)
+    {
+        return realpath(__DIR__ . "/../config/{$configName}.php");
+    }
+}

src/Services/Modulizer.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace LaravelModulize\Services;
+
+use Illuminate\Support\Collection;
+use LaravelModulize\Services\RoutesLoader;
+use Illuminate\Contracts\Foundation\Application;
+use LaravelModulize\Contracts\ModulizerRepositoryInterface;
+
+class Modulizer
+{
+    /**
+     * @var \Illuminate\Contracts\Foundation\Application
+     */
+    protected $app;
+
+    /**
+     * Repository
+     *
+     * @var \LaravelModulize\Contracts\ModulizerRepositoryInterface
+     */
+    public $repository;
+
+    protected $fileLoaders = [
+        RoutesLoader::class
+    ];
+
+    /**
+     * Modulizer constructor
+     *
+     * @param \Illuminate\Contracts\Foundation\Application $app
+     */
+    public function __construct(ModulizerRepositoryInterface $repository, Application $app)
+    {
+        $this->app = $app;
+        $this->repository = $repository;
+
+        $this->bootstrapLoaders();
+    }
+
+    public function bootstrapLoaders()
+    {
+        dump($this->repository->hasModules());
+        if ($this->repository->hasModules()) {
+            $this->getFileLoaders()->each(function ($fileLoader) {
+                $this->call($fileLoader)->bootstrap();
+            });
+        }
+    }
+
+    private function call(string $class)
+    {
+        return $this->app->make($class);
+    }
+
+    private function getFileLoaders(): Collection
+    {
+        return collect($this->fileLoaders);
+    }
+}