typisttech/imposter

Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plugins.

0.6.1 2020-12-06 22:57 UTC

Requires

• php: ^7.3 || ^8.0
• ext-json: *

Requires (Dev)

• codeception/codeception: ^4.1
• codeception/mockery-module: ^0.4.0
• codeception/module-asserts: ^1.3
• codeception/module-filesystem: ^1.0
• squizlabs/php_codesniffer: ^3.5

Suggests

• typisttech/imposter-plugin: Composer plugin to integrate composer and imposter

MIT

• Typist Tech
• Tang Rufus

• dependency
• composer
• wordpress
• namespace
• monkey-patching

README

Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plugins.

Built with ♥ by Typist Tech

Imposter is an open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:

Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plugins.

Why?

Because of the lack of dependency management in WordPress, if two plugins bundled conflicting versions of the same package, hard-to-reproduce bugs arise. Monkey patching composer vendor packages, wrapping them inside your own namespace is a less-than-ideal solution to avoid such conflicts.

See:

• A Narrative of Using Composer in a WordPress Plugin
• A Warning About Using Composer With WordPress
• Plugin Dependencies (Yet Another Plugin Dependencies Ticket)

Install

If you want to hook Imposter into composer command events, install Imposter Plugin instead. See: How can I integrate Imposter with composer?

Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/.

composer require typisttech/imposter

Config

In your composer.json:

"extra": {
    "imposter": {
        "namespace": "My\\App\\Vendor",
        "excludes": [
            "dummy/dummy-excluded"
        ]
    }
}

extra.imposter.namespace

Required String

This is the namespace prefix to be added to vendor packages.

extra.imposter.excludes

Optional Array of strings

Vendor packages which needs to be excluded from namespace prefixing. All composer-made packages are excluded by default. Besides, anything under the Composer namespace will be excluded.

Usage

After every $ composer install and $ composer update:

<?php

use TypistTech\Imposter\ImposterFactory;

$imposter = ImposterFactory::forProject('/path/to/project/root');
$imposter->run();

The above snippet:

1. Look for /path/to/project/root/composer.json
2. Find out vendor-dir
3. Find out all required packages, including those required by dependencies
4. Find out all autoload paths for all required packages
5. Prefix all namespaces with the imposter namespace defined in your composer.json

Before:

<?php

namespace Dummy\File;

use AnotherDummy\{
    SubAnotherDummy, SubOtherDummy
};
use Composer;
use Composer\Plugin\PluginInterface;
use Dummy\SubOtherDummy;
use OtherDummy\SubOtherDummy;
use RuntimeException;
use \UnexpectedValueException;
use function OtherVendor\myFunc;
use const OtherVendor\MY_MAGIC_NUMBER;

$closure = function () use ($aaa) {
    // Just testing.
};

class DummyClass
{
    public function useClosure()
    {
        array_map(function () use ($xxx) {
            // Just testing.
        }, []);
    }
}

function dummyFunction(string $namespace = null, string $use = null): array
{
    if (! is_null($namespace) && $namespace === 'dummy string' && $use === 'dummy string') {
        // Just testing.
    }

    return [];
}

foreach ([] as $namespace => $prefix) {
    $aaaa = '{' . $namespace . '}' . $prefix;
}

/** Just a comment for testing $namespace transformation */

After:

<?php

namespace MyPlugin\Vendor\Dummy\File;

use MyPlugin\Vendor\AnotherDummy\{
    SubAnotherDummy, SubOtherDummy
};
use Composer;
use Composer\Plugin\PluginInterface;
use MyPlugin\Vendor\Dummy\SubOtherDummy;
use MyPlugin\Vendor\OtherDummy\SubOtherDummy;
use RuntimeException;
use \UnexpectedValueException;
use function MyPlugin\Vendor\OtherVendor\myFunc;
use const MyPlugin\Vendor\OtherVendor\MY_MAGIC_NUMBER;

$closure = function () use ($aaa) {
    // Just testing.
};

class DummyClass
{
    public function useClosure()
    {
        array_map(function () use ($xxx) {
            // Just testing.
        }, []);
    }
}

function dummyFunction(string $namespace = null, string $use = null): array
{
    if (! is_null($namespace) && $namespace === 'dummy string' && $use === 'dummy string') {
        // Just testing.
    }

    return [];
}

foreach ([] as $namespace => $prefix) {
    $aaaa = '{' . $namespace . '}' . $prefix;
}

/** Just a comment for testing $namespace transformation */

Typist Tech is ready to build your next awesome WordPress site. Hire us!

Known Issues

Help Wanted. Pull requests are welcomed.

1. Traits are not transformed
2. Virtual packages are not supported

Frequently Asked Questions

How can I integrate imposter with composer?

Use Imposter Plugin instead. It hooks imposter into composer command events.

Does imposter support PSR4, PSR0, Classmap and Files?

Yes for all. PSR-4 and PSR-0 autoloading, classmap generation and files includes are supported.

Can I exclude some of the packages from imposter?

Yes, see extra.imposter.excludes. All composer made packages are excluded by default.

How about require-dev packages?

Imposter do nothing on require-dev packages because imposter is intended for avoiding production environment., not for development environment.

How about PHP built-in classes?

Imposter skips classes that on global namespace, for example: \ArrayObject, \RuntimeException

How about packages that don't use namespaces?

Not for now. Tell me your idea by opening an issue.

How about packages that use fully qualified name?

Not for now. We need a better regex(or something better than regex) in the Transformer class. Tell me your idea by opening an issue

The whole imposter situation is horrible. What can we do about it?

Until WordPress core comes up with a solution on dependency managment, keep clam and carry on.

In the meantime, checkout these tools to make WordPress suck less modernizing WordPress development:

• bring OOP into WordPress
• leveraging development practices from other languages and ecosystems, and applying them to WordPress

Which composer versions are supported?

Both v1 and v2.

Will you add support for older PHP versions?

Never! This plugin will only work on actively supported PHP versions.

Don't use it on end of life or security fixes only PHP versions.

It looks awesome. Where can I find some more goodies like this

• Articles on Typist Tech's blog
• Tang Rufus' WordPress plugins on wp.org
• More projects on Typist Tech's GitHub profile
• Stay tuned on Typist Tech's newsletter
• Follow Tang Rufus' Twitter account
• Hire Tang Rufus to build your next awesome site

Where can I give 5-star reviews?

Thanks! Glad you like it. It's important to let me knows somebody is using this project. Please consider:

• tweet something good with mentioning @TangRufus
• ★ star the Github repo
• 👀 watch the Github repo
• write tutorials and blog posts
• hire Typist Tech

Testing

composer test
composer style:check

Alternatives

Here is a list of alternatives that I found. However, none of these satisfied my requirements.

If you know other similar projects, feel free to edit this section!

• Mozart by Coen Jacobs

  • Works with PSR0 and PSR4
  • Dependency packages store in a different directory

• PHP Scoper

  • Prefixes all PHP namespaces in a file/directory to isolate the code bundled in PHARs

Feedback

Please provide feedback! We want to make this project as useful as possible. Please submit an issue and point out what you do and don't like, or fork the project and send pull requests. No issue is too small.

Security Vulnerabilities

If you discover a security vulnerability within this project, please email us at [e-mail]. All security vulnerabilities will be promptly addressed.

Credits

Imposter is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.

Full list of contributors can be found here.

License

Imposter is released under the MIT License.