Repository: RobLoach/component-installer
Branch: master
Commit: 738492eaf22b
Files: 29
Total size: 162.8 KB
Directory structure:
gitextract_gu99l6kr/
├── .editorconfig
├── .gitignore
├── .travis.yml
├── LICENSE.md
├── README.md
├── composer.json
├── phpunit.xml.dist
├── src/
│ ├── ComponentInstaller/
│ │ ├── ComponentInstallerPlugin.php
│ │ ├── Installer.php
│ │ ├── Process/
│ │ │ ├── BuildJsProcess.php
│ │ │ ├── CopyProcess.php
│ │ │ ├── Process.php
│ │ │ ├── ProcessInterface.php
│ │ │ ├── RequireCssProcess.php
│ │ │ └── RequireJsProcess.php
│ │ ├── Resources/
│ │ │ └── require.js
│ │ └── Util/
│ │ └── Filesystem.php
│ └── bootstrap.php
└── tests/
├── ComponentInstaller/
│ └── Test/
│ ├── InstallerTest.php
│ ├── Process/
│ │ ├── CopyProcessTest.php
│ │ ├── ProcessTest.php
│ │ ├── RequireCssProcessTest.php
│ │ └── RequireJsProcessTest.php
│ ├── Resources/
│ │ ├── test.css
│ │ ├── test.js
│ │ ├── test2.css
│ │ └── test2.js
│ └── Util/
│ └── FilesystemTest.php
└── bootstrap.php
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
; top-most EditorConfig file
root = true
; Unix-style newlines
[*]
end_of_line = LF
[*.php]
indent_style = space
indent_size = 4
================================================
FILE: .gitignore
================================================
vendor
.idea
nbproject
.project
composer.phar
composer.lock
================================================
FILE: .travis.yml
================================================
language: php
php:
- 5.6
- 7.0
- hhvm
before_script: composer install
script: composer test
notifications:
email: false
================================================
FILE: LICENSE.md
================================================
# License
Component Installer is released under the MIT License:
> Copyright (C) 2015 [Rob Loach](http://robloach.net)
>
> 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.
================================================
FILE: README.md
================================================
# DEPRECATED
Component Installer has been deprecated. Use one of the following projects instead:
- [Composer Installers Extender](https://github.com/oomphinc/composer-installers-extender)
- [Asset Packagist](https://asset-packagist.org)
- [Composer Asset Plugin](https://github.com/fxpio/composer-asset-plugin)
- [Laravel Mix](https://laravel.com/docs/5.8/mix) (Example: [eventum/eventum#801](https://github.com/eventum/eventum/pull/801) and [eventum/eventum#812](https://github.com/eventum/eventum/pull/812))
## Example
```
composer require oomphinc/composer-installers-extender
```
```
"extra": {
"installer-types": ["component"],
"installer-paths": {
"components/{$name}/": ["type:component"]
}
}
```
# Component Installer for [Composer](http://getcomposer.org) [](http://travis-ci.org/RobLoach/component-installer)
Allows installation of Components via [Composer](http://getcomposer.org).
## Install
```
composer require robloach/component-installer
```
``` json
{
"require": {
"robloach/component-installer": "*"
}
}
```
## Usage
To install a Component with Composer, add the Component to your *composer.json*
`require` key. The following will install [jQuery](http://jquery.com) and
[normalize.css](https://github.com/necolas/normalize.css):
```
composer require components/jquery
composer require components/normalize.css
```
``` json
{
"require": {
"components/jquery": "2.*",
"components/normalize.css": "3.*",
"robloach/component-installer": "*"
}
}
```
### Using the Component
The easiest approach is to use the Component statically. Just reference the
Components manually using a `script` or `link` tag:
``` html
```
For complex projects, a [RequireJS](http://requirejs.org) configuration is
available, which allows autoloading scripts only when needed. A *require.css*
file is also compiled, including all Component stylesheets:
``` html
jQuery+RequireJS Component Installer Sample Page
```
## Configuration
There are a number of ways to alter how Components are installed and used.
### Installation Directory
It is possible to switch where Components are installed by changing the
`component-dir` option in your root *composer.json*'s `config`. The following
will install jQuery to *public/jquery* rather than *components/jquery*:
``` json
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public"
}
}
```
Defaults to `components`.
### Base URL
While `component-dir` depicts where the Components will be installed,
`component-baseurl` tells RequireJS the base path that will use when attempting
to load the scripts in the web browser. It is important to make sure the
`component-baseurl` points to the `component-dir` when loaded externally. See
more about [`baseUrl`](http://requirejs.org/docs/api.html#config-baseUrl) in the
RequireJS documentation.
``` json
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public/assets",
"component-baseurl": "/assets"
}
}
```
Defaults to `components`.
### Assetic filters
``` json
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public/assets",
"component-baseurl": "/assets",
"component-scriptFilters": {
"\\Assetic\\Filter\\GoogleClosure\\CompilerApiFilter": []
},
"component-styleFilters": {
"\\Assetic\\Filter\\CssImportFilter": []
}
}
}
```
## Creating a Component
To set up a Component to be installed with Component Installer, have it
`require` the package *robloach/component-installer* and set the `type` to
*component*, but it is not necessary:
``` json
{
"name": "components/bootstrap",
"type": "component",
"require": {
"robloach/component-installer": "*"
},
"extra": {
"component": {
"scripts": [
"js/bootstrap.js"
],
"styles": [
"css/bootstrap.css"
],
"files": [
"img/*.png",
"js/bootstrap.min.js",
"css/bootstrap.min.css"
]
}
}
}
```
* `scripts` - List of all the JavaScript files that will be concatenated
together and processed when loading the Component.
* `styles` - List of all the CSS files that should be concatenated together
into the final *require.css* file.
* `files` - Any additional file assets that should be copied into the Component
directory.
### Component Name
Components can provide their own Component name. The following will install
jQuery to *components/myownjquery* rather than *components/jquery*:
``` json
{
"name": "components/jquery",
"type": "component",
"extra": {
"component": {
"name": "myownjquery"
}
}
}
```
Defaults to the package name, without the vendor.
### RequireJS Configuration
Components can alter how [RequireJS](http://requirejs.org) registers and
interacts with them by changing some of the [configuration
options](http://www.requirejs.org/docs/api.html#config):
``` json
{
"name": "components/backbone",
"type": "component",
"require": {
"components/underscore": "*"
},
"extra": {
"component": {
"shim": {
"deps": ["underscore", "jquery"],
"exports": "Backbone"
},
"config": {
"color": "blue"
}
}
},
"config": {
"component": {
"waitSeconds": 5
}
}
}
```
Current available RequireJS options for individual packages include:
* [`shim`](http://www.requirejs.org/docs/api.html#config-shim)
* [`config`](http://www.requirejs.org/docs/api.html#config-moduleconfig)
* Anything that's passed through `config.component` is sent to Require.js
### Packages Without Composer Support
Using [`repositories`](http://getcomposer.org/doc/05-repositories.md#repositories)
in *composer.json* allows use of Component Installer in packages that don't
explicitly provide their own *composer.json*. In the following example, we
define use of [html5shiv](https://github.com/aFarkas/html5shiv):
``` json
{
"require": {
"afarkas/html5shiv": "3.6.*"
},
"repositories": [
{
"type": "package",
"package": {
"name": "afarkas/html5shiv",
"type": "component",
"version": "3.6.2",
"dist": {
"url": "https://github.com/aFarkas/html5shiv/archive/3.6.2.zip",
"type": "zip"
},
"source": {
"url": "https://github.com/aFarkas/html5shiv.git",
"type": "git",
"reference": "3.6.2"
},
"extra": {
"component": {
"scripts": [
"dist/html5shiv.js"
]
}
},
"require": {
"robloach/component-installer": "*"
}
}
}
]
}
```
### Packages Without Component Support In *composer.json*
Using [`extra`](https://getcomposer.org/doc/04-schema.md#extra)
in *composer.json* allows use of Component Installer in packages that don't
explicitly provide support for component, but do ship with their own *composer.json*.
Using `extra` with packages that ship with Component Installer, will override component's settings for that package.
``` json
{
"require": {
"datatables/datatables": "~1.10"
},
"extra": {
"component": {
"datatables/datatables": {
"scripts": [
"media/js/jquery.dataTables.js"
],
"styles": [
"media/css/jquery.dataTables.css"
],
"files": [
"media/js/jquery.dataTables.min.js",
"media/css/jquery.dataTables.min.css",
"media/images/*.png"
]
}
}
}
}
```
## Not Invented Here
There are many other amazing projects from which Component Installer was
inspired. It is encouraged to take a look at some of the [other great package
management systems](http://github.com/wilmoore/frontend-packagers):
* [npm](http://npmjs.org)
* [bower](http://bower.io/)
* [component](http://github.com/component/component)
* [Jam](http://jamjs.org)
* [volo](http://volojs.org)
* [Ender](http://ender.jit.su)
* etc
## License
Component Installer is licensed under the MIT License - see LICENSE.md for
details.
================================================
FILE: composer.json
================================================
{
"name": "robloach/component-installer",
"description": "Allows installation of Components via Composer.",
"type": "composer-plugin",
"license": "MIT",
"authors": [
{
"name": "Rob Loach",
"homepage": "http://robloach.net"
}
],
"autoload": {
"psr-0": {
"ComponentInstaller": "src/"
}
},
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
},
"class": "ComponentInstaller\\ComponentInstallerPlugin"
},
"require": {
"php": ">=5.3.2",
"kriswallsmith/assetic": "1.*",
"composer-plugin-api": "^1.0"
},
"require-dev": {
"composer/composer": "~1.1.2",
"phpunit/phpunit": "~5.4.6"
},
"scripts": {
"test": "phpunit"
},
"archive": {
"exclude": [
"tests",
"phpunit.xml.dist",
".travis.yml",
".gitignore",
".editorconfig"
]
},
"abandoned": "oomphinc/composer-installers-extender"
}
================================================
FILE: phpunit.xml.dist
================================================
tests/ComponentInstallersrc/ComponentInstaller
================================================
FILE: src/ComponentInstaller/ComponentInstallerPlugin.php
================================================
getInstallationManager()->addInstaller($installer);
}
}
================================================
FILE: src/ComponentInstaller/Installer.php
================================================
composer) ? $this->composer->getPackage() : null;
if (isset($rootPackage)) {
// Ensure we get the root package rather than its alias.
while ($rootPackage instanceof AliasPackage) {
$rootPackage = $rootPackage->getAliasOf();
}
// Make sure the root package can override the available scripts.
if (method_exists($rootPackage, 'setScripts')) {
$scripts = $rootPackage->getScripts();
// Act on the "post-autoload-dump" command so that we can act on all
// the installed packages.
$scripts['post-autoload-dump']['component-installer'] = 'ComponentInstaller\\Installer::postAutoloadDump';
$rootPackage->setScripts($scripts);
}
}
// State support for "component" package types.
return $packageType == 'component';
}
/**
* Gets the destination Component directory.
*
* @param PackageInterface $package
* @return string
* The path to where the final Component should be installed.
*/
public function getComponentPath(PackageInterface $package)
{
// Parse the pretty name for the vendor and package name.
$name = $prettyName = $package->getPrettyName();
if (strpos($prettyName, '/') !== false) {
list($vendor, $name) = explode('/', $prettyName);
unset($vendor);
}
// First look for an override in root package's extra, then try the package's extra
$rootPackage = $this->composer->getPackage();
$rootExtras = $rootPackage ? $rootPackage->getExtra() : array();
$customComponents = isset($rootExtras['component']) ? $rootExtras['component'] : array();
if (isset($customComponents[$prettyName]) && is_array($customComponents[$prettyName])) {
$component = $customComponents[$prettyName];
}
else {
$extra = $package->getExtra();
$component = isset($extra['component']) ? $extra['component'] : array();
}
// Allow the component to define its own name.
if (isset($component['name'])) {
$name = $component['name'];
}
// Find where the package should be located.
return $this->getComponentDir() . DIRECTORY_SEPARATOR . $name;
}
/**
* Initialize the Component directory, as well as the vendor directory.
*/
protected function initializeVendorDir()
{
$this->componentDir = $this->getComponentDir();
$this->filesystem->ensureDirectoryExists($this->componentDir);
parent::initializeVendorDir();
}
/**
* Retrieves the Installer's provided component directory.
*/
public function getComponentDir()
{
$config = $this->composer->getConfig();
return $config->has('component-dir') ? $config->get('component-dir') : 'components';
}
/**
* Remove both the installed code and files from the Component directory.
*
* @param PackageInterface $package
*/
public function removeCode(PackageInterface $package)
{
$this->removeComponent($package);
parent::removeCode($package);
}
/**
* Remove a Component's files from the Component directory.
*
* @param PackageInterface $package
* @return bool
*/
public function removeComponent(PackageInterface $package)
{
$path = $this->getComponentPath($package);
return $this->filesystem->remove($path);
}
/**
* Before installing the Component, be sure its destination is clear first.
*
* @param PackageInterface $package
*/
public function installCode(PackageInterface $package)
{
$this->removeComponent($package);
parent::installCode($package);
}
/**
* Script callback; Acted on after the autoloader is dumped.
*
* @param Event $event
*/
public static function postAutoloadDump(Event $event)
{
// Retrieve basic information about the environment and present a
// message to the user.
$composer = $event->getComposer();
$config = $composer->getConfig();
$io = $event->getIO();
$io->write('Compiling component files');
// Set up all the processes.
$processes = $config->has('component-processes') ?
$config->get('component-processes') :
static::$defaultProcesses;
// Initialize and execute each process in sequence.
foreach ($processes as $process) {
$options = array();
if (is_array($process)) {
$options = isset($process['options']) ? $process['options'] : array();
$class = $process['class'];
}
else {
$class = $process;
}
if(!class_exists($class)){
$io->write("Process class '$class' not found, skipping this process");
continue;
}
/** @var \ComponentInstaller\Process\Process $process */
$process = new $class($composer, $io, $options);
// When an error occurs during initialization, end the process.
if (!$process->init()) {
$io->write("An error occurred while initializing the '$class' process.");
break;
}
$process->process();
}
}
}
================================================
FILE: src/ComponentInstaller/Process/BuildJsProcess.php
================================================
compile($this->packages);
}
/**
* Copy file assets from the given packages to the component directory.
*
* @param array $packages
* An array of packages.
* @return bool
*/
public function compile($packages)
{
// Set up the initial require-build.js file.
$destination = $this->componentDir.DIRECTORY_SEPARATOR.'require-built.js';
$require = $this->componentDir.DIRECTORY_SEPARATOR.'require.js';
copy($require, $destination);
// Cycle through each package and add it to the built require.js file.
foreach ($packages as $package) {
// Retrieve some information about the package
$name = isset($package['name']) ? $package['name'] : '__component__';
$extra = isset($package['extra']) ? $package['extra'] : array();
$componentName = $this->getComponentName($name, $extra);
// Find where the source file is located.
$packageDir = $this->componentDir.DIRECTORY_SEPARATOR.$componentName;
$source = $packageDir.DIRECTORY_SEPARATOR.$componentName.'-built.js';
// Make sure the source script is available.
if (file_exists($source)) {
// Build the compiled script.
$content = file_get_contents($source);
$output = $this->definePrefix($componentName) . $content . $this->definePostfix();
// Append the module definition to the destination file.
file_put_contents($destination, $output, FILE_APPEND);
}
}
return true;
}
/**
* Provide the initial definition prefix.
*
* @param string $componentName
* @return string Begin the module definition.
*/
protected function definePrefix($componentName)
{
// Define the module using the simplified CommonJS wrapper.
return "\ndefine('$componentName', function (require, exports, module) {\n";
}
/**
* Finish the module definition.
*
* @return string Close brackets to finish the module.
*/
protected function definePostfix()
{
return "\n});\n";
}
}
================================================
FILE: src/ComponentInstaller/Process/CopyProcess.php
================================================
copy($this->packages);
}
/**
* Copy file assets from the given packages to the component directory.
*
* @param array $packages
* An array of packages.
* @return bool
*/
public function copy($packages)
{
// Iterate over each package that should be processed.
foreach ($packages as $package) {
// Retrieve some information about the package.
$packageDir = $this->getVendorDir($package);
$name = isset($package['name']) ? $package['name'] : '__component__';
$extra = isset($package['extra']) ? $package['extra'] : array();
$componentName = $this->getComponentName($name, $extra);
// Cycle through each asset type.
$fileType = array('scripts', 'styles', 'files');
foreach ($fileType as $type) {
// Only act on the files if they're available.
if (isset($extra['component'][$type]) && is_array($extra['component'][$type])) {
foreach ($extra['component'][$type] as $file) {
// Make sure the file itself is available.
$source = $packageDir.DIRECTORY_SEPARATOR.$file;
// Perform a recursive glob file search on the pattern.
foreach ($this->fs->recursiveGlobFiles($source) as $filesource) {
// Find the final destination without the package directory.
$withoutPackageDir = str_replace($packageDir.DIRECTORY_SEPARATOR, '', $filesource);
// Construct the final file destination.
$destination = $this->componentDir.DIRECTORY_SEPARATOR.$componentName.DIRECTORY_SEPARATOR.$withoutPackageDir;
// Ensure the directory is available.
$this->fs->ensureDirectoryExists(dirname($destination));
// Copy the file to its destination.
copy($filesource, $destination);
}
}
}
}
}
return true;
}
}
================================================
FILE: src/ComponentInstaller/Process/Process.php
================================================
composer = isset($composer) ? $composer : new Composer();
$this->io = isset($io) ? $io : new NullIO();
$this->fs = new Filesystem();
$this->installationManager = $this->composer->getInstallationManager();
// TODO: Break compatibility and expect in interface
$args = func_get_args();
$this->options = count($args) > 2 && is_array($args[2]) ? $args[2]: array();
}
/**
* {@inheritdoc}
*/
public function init()
{
// Retrieve the configuration variables.
$this->config = $this->composer->getConfig();
if (isset($this->config)) {
if ($this->config->has('component-dir')) {
$this->componentDir = $this->config->get('component-dir');
}
}
// Get the available packages.
$allPackages = array();
/** @var \Composer\Package\Locker $locker */
$locker = $this->composer->getLocker();
if ($locker !== null && $locker->isLocked()) {
$lockData = $locker->getLockData();
$allPackages = $lockData['packages'];
// Also merge in any of the development packages.
$dev = isset($lockData['packages-dev']) ? $lockData['packages-dev'] : array();
foreach ($dev as $package) {
$allPackages[] = $package;
}
}
// Only add those packages that we can reasonably
// assume are components into our packages list
/** @var \Composer\Package\RootPackageInterface $rootPackage */
$rootPackage = $this->composer->getPackage();
$rootExtras = $rootPackage ? $rootPackage->getExtra() : array();
$customComponents = isset($rootExtras['component']) ? $rootExtras['component'] : array();
foreach ($allPackages as $package) {
$name = $package['name'];
if (isset($customComponents[$name]) && is_array($customComponents[$name])) {
$package['extra'] = array('component' => $customComponents[$name]);
$this->packages[] = $package;
}
else {
$extra = isset($package['extra']) ? $package['extra'] : array();
if (isset($extra['component']) && is_array($extra['component'])) {
$this->packages[] = $package;
}
}
}
// Add the root package to the packages list.
$root = $this->composer->getPackage();
if ($root) {
$dumper = new ArrayDumper();
$package = $dumper->dump($root);
$package['is-root'] = true;
$this->packages[] = $package;
}
return true;
}
/**
* {@inheritdoc}
*/
public function process()
{
return false;
}
/**
* Retrieves the component name for the component.
*
* @param string $prettyName
* The Composer package name.
* @param array $extra
* The extra config options sent from Composer.
*
* @return string
* The name of the component, without its vendor name.
*/
public function getComponentName($prettyName, array $extra = array())
{
// Parse the pretty name for the vendor and name.
if (strpos($prettyName, '/') !== false) {
list($vendor, $name) = explode('/', $prettyName);
unset($vendor);
} else {
// Vendor wasn't found, so default to the pretty name instead.
$name = $prettyName;
}
// Allow the component to define its own name.
$component = isset($extra['component']) ? $extra['component'] : array();
if (isset($component['name'])) {
$name = $component['name'];
}
return $name;
}
/**
* Retrieves the component directory.
*/
public function getComponentDir()
{
return $this->componentDir;
}
/**
* Sets the component directory.
* @param string $dir
* @return string
*/
public function setComponentDir($dir)
{
return $this->componentDir = $dir;
}
/**
* Retrieves the given package's vendor directory, where it's installed.
*
* @param array $package
* The package to retrieve the vendor directory for.
* @return string
*/
public function getVendorDir(array $package)
{
// The root package vendor directory is not handled by getInstallPath().
if (isset($package['is-root']) && $package['is-root'] === true) {
$path = getcwd();
if (!file_exists($path.DIRECTORY_SEPARATOR.'composer.json')) {
for ($temp = __DIR__; strlen($temp) > 3; $temp = dirname($temp)) {
if (file_exists($temp.DIRECTORY_SEPARATOR.'composer.json')) {
$path = $temp;
}
}
}
return $path;
}
if (!isset($package['version'])) {
$package['version'] = '1.0.0';
}
$loader = new ArrayLoader();
$completePackage = $loader->load($package);
return $this->installationManager->getInstallPath($completePackage);
}
}
================================================
FILE: src/ComponentInstaller/Process/ProcessInterface.php
================================================
config->has('component-styleFilters')) {
$customFilters = $this->config->get('component-styleFilters');
if (isset($customFilters) && is_array($customFilters)) {
foreach ($customFilters as $filter => $filterParams) {
$reflection = new \ReflectionClass($filter);
$filters[] = $reflection->newInstanceArgs($filterParams);
}
}
}
$filterCollection = new FilterCollection($filters);
$assets = new AssetCollection();
$styles = $this->packageStyles($this->packages);
foreach ($styles as $package => $packageStyles) {
$packageAssets = new AssetCollection();
$packagePath = $this->componentDir.'/'.$package;
foreach ($packageStyles as $style => $paths) {
foreach ($paths as $path) {
// The full path to the CSS file.
$assetPath = realpath($path);
// The root of the CSS file.
$sourceRoot = dirname($path);
// The style path to the CSS file when external.
$sourcePath = $package . '/' . $style;
//Replace glob patterns with filenames.
$filename = basename($style);
if(preg_match('~^\*(\.[^\.]+)$~', $filename, $matches)){
$sourcePath = str_replace($filename, basename($assetPath), $sourcePath);
}
// Where the final CSS will be generated.
$targetPath = $this->componentDir;
// Build the asset and add it to the collection.
$asset = new FileAsset($assetPath, $filterCollection, $sourceRoot, $sourcePath);
$asset->setTargetPath($targetPath);
$assets->add($asset);
// Add asset to package collection.
$sourcePath = preg_replace('{^.*'.preg_quote($package).'/}', '', $sourcePath);
$asset = new FileAsset($assetPath, $filterCollection, $sourceRoot, $sourcePath);
$asset->setTargetPath($packagePath);
$packageAssets->add($asset);
}
}
if (file_put_contents($packagePath.'/'.$package.'-built.css', $packageAssets->dump()) === FALSE) {
$this->io->write("Error writing $package-built.css to destination");
}
}
if (file_put_contents($this->componentDir . '/require.css', $assets->dump()) === FALSE) {
$this->io->write('Error writing require.css to destination');
return false;
}
return null;
}
/**
* Retrieves an array of styles from a collection of packages.
*
* @param array $packages
* An array of packages from the composer.lock file.
*
* @return array
* A set of package styles.
*/
public function packageStyles(array $packages)
{
$output = array();
// Construct the packages configuration.
foreach ($packages as $package) {
// Retrieve information from the extra options.
$extra = isset($package['extra']) ? $package['extra'] : array();
$name = $this->getComponentName($package['name'], $extra);
$component = isset($extra['component']) ? $extra['component'] : array();
$styles = isset($component['styles']) ? $component['styles'] : array();
$vendorDir = $this->getVendorDir($package);
// Loop through each style.
foreach ($styles as $style) {
// Find the style path from the vendor directory.
$path = strtr($vendorDir.'/'.$style, '/', DIRECTORY_SEPARATOR);
// Search for the candidate with a glob recursive file search.
$files = $this->fs->recursiveGlobFiles($path);
foreach ($files as $file) {
// Provide the package name, style and full path.
$output[$name][$style][] = $file;
}
}
}
return $output;
}
}
================================================
FILE: src/ComponentInstaller/Process/RequireJsProcess.php
================================================
config->has('component-baseurl')) {
$this->baseUrl = $this->config->get('component-baseurl');
}
return $output;
}
/**
* {@inheritdoc}
*/
public function process()
{
// Construct the require.js and stick it in the destination.
$json = $this->requireJson($this->packages, $this->config);
$requireConfig = $this->requireJs($json);
// Attempt to write the require.config.js file.
$destination = $this->componentDir . '/require.config.js';
$this->fs->ensureDirectoryExists(dirname($destination));
if (file_put_contents($destination, $requireConfig) === FALSE) {
$this->io->write('Error writing require.config.js');
return false;
}
// Read in require.js to prepare the final require.js.
if (!file_exists(dirname(__DIR__) . '/Resources/require.js')) {
$this->io->write('Error reading in require.js');
return false;
}
$assets = $this->newAssetCollection();
$assets->add(new StringAsset($requireConfig));
$assets->add(new FileAsset(dirname(__DIR__) . '/Resources/require.js'));
// Append the config to the require.js and write it.
if (file_put_contents($this->componentDir . '/require.js', $assets->dump()) === FALSE) {
$this->io->write('Error writing require.js to the components directory');
return false;
}
return null;
}
/**
* Creates a require.js configuration from an array of packages.
*
* @param $packages
* An array of packages from the composer.lock file.
*
* @return array
* The built JSON array.
*/
public function requireJson(array $packages)
{
$json = array();
// Construct the packages configuration.
foreach ($packages as $package) {
// Retrieve information from the extra options.
$extra = isset($package['extra']) ? $package['extra'] : array();
$options = isset($extra['component']) ? $extra['component'] : array();
// Construct the base details.
$name = $this->getComponentName($package['name'], $extra);
$component = array(
'name' => $name,
);
// Build the "main" directive.
$scripts = isset($options['scripts']) ? $options['scripts'] : array();
if (!empty($scripts)) {
// Put all scripts into a build.js file.
$result = $this->aggregateScripts($package, $scripts, $name.DIRECTORY_SEPARATOR.$name.'-built.js');
if ($result) {
// If the aggregation was successful, add the script to the
// packages array.
$component['main'] = $name.'-built.js';
// Add the component to the packages array.
$json['packages'][] = $component;
}
}
// Add the shim definition for the package.
$shim = isset($options['shim']) ? $options['shim'] : array();
if (!empty($shim)) {
$json['shim'][$name] = $shim;
}
// Add the config definition for the package.
$packageConfig = isset($options['config']) ? $options['config'] : array();
if (!empty($packageConfig)) {
$json['config'][$name] = $packageConfig;
}
}
// Provide the baseUrl.
$json['baseUrl'] = $this->baseUrl;
// Merge in configuration options from the root.
if ($this->config->has('component')) {
$config = $this->config->get('component');
if (isset($config) && is_array($config)) {
// Use a recursive, distict array merge.
$json = $this->arrayMergeRecursiveDistinct($json, $config);
}
}
return $json;
}
/**
* Concatenate all scripts together into one destination file.
*
* @param array $package
* @param array $scripts
* @param string $file
* @return bool
*/
public function aggregateScripts($package, array $scripts, $file)
{
$assets = $this->newAssetCollection();
foreach ($scripts as $script) {
// Collect each candidate from a glob file search.
$path = $this->getVendorDir($package).DIRECTORY_SEPARATOR.$script;
$matches = $this->fs->recursiveGlobFiles($path);
foreach ($matches as $match) {
$assets->add(new FileAsset($match));
}
}
$js = $assets->dump();
// Write the file if there are any JavaScript assets.
if (!empty($js)) {
$destination = $this->componentDir.DIRECTORY_SEPARATOR.$file;
$this->fs->ensureDirectoryExists(dirname($destination));
return file_put_contents($destination, $js);
}
return false;
}
/**
* Constructs the require.js file from the provided require.js JSON array.
*
* @param $json
* The require.js JSON configuration.
*
* @return string
* The RequireJS JavaScript configuration.
*/
public function requireJs(array $json = array())
{
// Encode the array to a JSON array.
$js = JsonFile::encode($json);
// Construct the JavaScript output.
$output = << &$value) {
if(is_numeric($key)){
$merged[] = $value;
} else {
if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
$merged[$key] = $this->arrayMergeRecursiveDistinct($merged[$key], $value);
}
else {
$merged[$key] = $value;
}
}
}
return $merged;
}
/**
* @return AssetCollection
*/
protected function newAssetCollection()
{
// Aggregate all the assets into one file.
$assets = new AssetCollection();
if ($this->config->has('component-scriptFilters')) {
$filters = $this->config->get('component-scriptFilters');
if (isset($filters) && is_array($filters)) {
foreach ($filters as $filter => $filterParams) {
$reflection = new \ReflectionClass($filter);
/** @var \Assetic\Filter\FilterInterface $filter */
$filter = $reflection->newInstanceArgs($filterParams);
$assets->ensureFilter($filter);
}
}
}
return $assets;
}
}
================================================
FILE: src/ComponentInstaller/Resources/require.js
================================================
/** vim: et:ts=4:sw=4:sts=4
* @license RequireJS 2.1.5 Copyright (c) 2010-2012, The Dojo Foundation All Rights Reserved.
* Available via the MIT or new BSD license.
* see: http://github.com/jrburke/requirejs for details
*/
//Not using strict: uneven strict support in browsers, #392, and causes
//problems with requirejs.exec()/transpiler plugins that may not be strict.
/*jslint regexp: true, nomen: true, sloppy: true */
/*global window, navigator, document, importScripts, setTimeout, opera */
var requirejs, require, define;
(function (global) {
var req, s, head, baseElement, dataMain, src,
interactiveScript, currentlyAddingScript, mainScript, subPath,
version = '2.1.5',
commentRegExp = /(\/\*([\s\S]*?)\*\/|([^:]|^)\/\/(.*)$)/mg,
cjsRequireRegExp = /[^.]\s*require\s*\(\s*["']([^'"\s]+)["']\s*\)/g,
jsSuffixRegExp = /\.js$/,
currDirRegExp = /^\.\//,
op = Object.prototype,
ostring = op.toString,
hasOwn = op.hasOwnProperty,
ap = Array.prototype,
apsp = ap.splice,
isBrowser = !!(typeof window !== 'undefined' && navigator && document),
isWebWorker = !isBrowser && typeof importScripts !== 'undefined',
//PS3 indicates loaded and complete, but need to wait for complete
//specifically. Sequence is 'loading', 'loaded', execution,
// then 'complete'. The UA check is unfortunate, but not sure how
//to feature test w/o causing perf issues.
readyRegExp = isBrowser && navigator.platform === 'PLAYSTATION 3' ?
/^complete$/ : /^(complete|loaded)$/,
defContextName = '_',
//Oh the tragedy, detecting opera. See the usage of isOpera for reason.
isOpera = typeof opera !== 'undefined' && opera.toString() === '[object Opera]',
contexts = {},
cfg = {},
globalDefQueue = [],
useInteractive = false;
function isFunction(it) {
return ostring.call(it) === '[object Function]';
}
function isArray(it) {
return ostring.call(it) === '[object Array]';
}
/**
* Helper function for iterating over an array. If the func returns
* a true value, it will break out of the loop.
*/
function each(ary, func) {
if (ary) {
var i;
for (i = 0; i < ary.length; i += 1) {
if (ary[i] && func(ary[i], i, ary)) {
break;
}
}
}
}
/**
* Helper function for iterating over an array backwards. If the func
* returns a true value, it will break out of the loop.
*/
function eachReverse(ary, func) {
if (ary) {
var i;
for (i = ary.length - 1; i > -1; i -= 1) {
if (ary[i] && func(ary[i], i, ary)) {
break;
}
}
}
}
function hasProp(obj, prop) {
return hasOwn.call(obj, prop);
}
function getOwn(obj, prop) {
return hasProp(obj, prop) && obj[prop];
}
/**
* Cycles over properties in an object and calls a function for each
* property value. If the function returns a truthy value, then the
* iteration is stopped.
*/
function eachProp(obj, func) {
var prop;
for (prop in obj) {
if (hasProp(obj, prop)) {
if (func(obj[prop], prop)) {
break;
}
}
}
}
/**
* Simple function to mix in properties from source into target,
* but only if target does not already have a property of the same name.
*/
function mixin(target, source, force, deepStringMixin) {
if (source) {
eachProp(source, function (value, prop) {
if (force || !hasProp(target, prop)) {
if (deepStringMixin && typeof value !== 'string') {
if (!target[prop]) {
target[prop] = {};
}
mixin(target[prop], value, force, deepStringMixin);
} else {
target[prop] = value;
}
}
});
}
return target;
}
//Similar to Function.prototype.bind, but the 'this' object is specified
//first, since it is easier to read/figure out what 'this' will be.
function bind(obj, fn) {
return function () {
return fn.apply(obj, arguments);
};
}
function scripts() {
return document.getElementsByTagName('script');
}
//Allow getting a global that expressed in
//dot notation, like 'a.b.c'.
function getGlobal(value) {
if (!value) {
return value;
}
var g = global;
each(value.split('.'), function (part) {
g = g[part];
});
return g;
}
/**
* Constructs an error with a pointer to an URL with more information.
* @param {String} id the error ID that maps to an ID on a web page.
* @param {String} message human readable error.
* @param {Error} [err] the original error, if there is one.
*
* @returns {Error}
*/
function makeError(id, msg, err, requireModules) {
var e = new Error(msg + '\nhttp://requirejs.org/docs/errors.html#' + id);
e.requireType = id;
e.requireModules = requireModules;
if (err) {
e.originalError = err;
}
return e;
}
if (typeof define !== 'undefined') {
//If a define is already in play via another AMD loader,
//do not overwrite.
return;
}
if (typeof requirejs !== 'undefined') {
if (isFunction(requirejs)) {
//Do not overwrite and existing requirejs instance.
return;
}
cfg = requirejs;
requirejs = undefined;
}
//Allow for a require config object
if (typeof require !== 'undefined' && !isFunction(require)) {
//assume it is a config object.
cfg = require;
require = undefined;
}
function newContext(contextName) {
var inCheckLoaded, Module, context, handlers,
checkLoadedTimeoutId,
config = {
//Defaults. Do not set a default for map
//config to speed up normalize(), which
//will run faster if there is no default.
waitSeconds: 7,
baseUrl: './',
paths: {},
pkgs: {},
shim: {},
config: {}
},
registry = {},
//registry of just enabled modules, to speed
//cycle breaking code when lots of modules
//are registered, but not activated.
enabledRegistry = {},
undefEvents = {},
defQueue = [],
defined = {},
urlFetched = {},
requireCounter = 1,
unnormalizedCounter = 1;
/**
* Trims the . and .. from an array of path segments.
* It will keep a leading path segment if a .. will become
* the first path segment, to help with module name lookups,
* which act like paths, but can be remapped. But the end result,
* all paths that use this function should look normalized.
* NOTE: this method MODIFIES the input array.
* @param {Array} ary the array of path segments.
*/
function trimDots(ary) {
var i, part;
for (i = 0; ary[i]; i += 1) {
part = ary[i];
if (part === '.') {
ary.splice(i, 1);
i -= 1;
} else if (part === '..') {
if (i === 1 && (ary[2] === '..' || ary[0] === '..')) {
//End of the line. Keep at least one non-dot
//path segment at the front so it can be mapped
//correctly to disk. Otherwise, there is likely
//no path mapping for a path starting with '..'.
//This can still fail, but catches the most reasonable
//uses of ..
break;
} else if (i > 0) {
ary.splice(i - 1, 2);
i -= 2;
}
}
}
}
/**
* Given a relative module name, like ./something, normalize it to
* a real name that can be mapped to a path.
* @param {String} name the relative name
* @param {String} baseName a real name that the name arg is relative
* to.
* @param {Boolean} applyMap apply the map config to the value. Should
* only be done if this normalization is for a dependency ID.
* @returns {String} normalized name
*/
function normalize(name, baseName, applyMap) {
var pkgName, pkgConfig, mapValue, nameParts, i, j, nameSegment,
foundMap, foundI, foundStarMap, starI,
baseParts = baseName && baseName.split('/'),
normalizedBaseParts = baseParts,
map = config.map,
starMap = map && map['*'];
//Adjust any relative paths.
if (name && name.charAt(0) === '.') {
//If have a base name, try to normalize against it,
//otherwise, assume it is a top-level require that will
//be relative to baseUrl in the end.
if (baseName) {
if (getOwn(config.pkgs, baseName)) {
//If the baseName is a package name, then just treat it as one
//name to concat the name with.
normalizedBaseParts = baseParts = [baseName];
} else {
//Convert baseName to array, and lop off the last part,
//so that . matches that 'directory' and not name of the baseName's
//module. For instance, baseName of 'one/two/three', maps to
//'one/two/three.js', but we want the directory, 'one/two' for
//this normalization.
normalizedBaseParts = baseParts.slice(0, baseParts.length - 1);
}
name = normalizedBaseParts.concat(name.split('/'));
trimDots(name);
//Some use of packages may use a . path to reference the
//'main' module name, so normalize for that.
pkgConfig = getOwn(config.pkgs, (pkgName = name[0]));
name = name.join('/');
if (pkgConfig && name === pkgName + '/' + pkgConfig.main) {
name = pkgName;
}
} else if (name.indexOf('./') === 0) {
// No baseName, so this is ID is resolved relative
// to baseUrl, pull off the leading dot.
name = name.substring(2);
}
}
//Apply map config if available.
if (applyMap && map && (baseParts || starMap)) {
nameParts = name.split('/');
for (i = nameParts.length; i > 0; i -= 1) {
nameSegment = nameParts.slice(0, i).join('/');
if (baseParts) {
//Find the longest baseName segment match in the config.
//So, do joins on the biggest to smallest lengths of baseParts.
for (j = baseParts.length; j > 0; j -= 1) {
mapValue = getOwn(map, baseParts.slice(0, j).join('/'));
//baseName segment has config, find if it has one for
//this name.
if (mapValue) {
mapValue = getOwn(mapValue, nameSegment);
if (mapValue) {
//Match, update name to the new value.
foundMap = mapValue;
foundI = i;
break;
}
}
}
}
if (foundMap) {
break;
}
//Check for a star map match, but just hold on to it,
//if there is a shorter segment match later in a matching
//config, then favor over this star map.
if (!foundStarMap && starMap && getOwn(starMap, nameSegment)) {
foundStarMap = getOwn(starMap, nameSegment);
starI = i;
}
}
if (!foundMap && foundStarMap) {
foundMap = foundStarMap;
foundI = starI;
}
if (foundMap) {
nameParts.splice(0, foundI, foundMap);
name = nameParts.join('/');
}
}
return name;
}
function removeScript(name) {
if (isBrowser) {
each(scripts(), function (scriptNode) {
if (scriptNode.getAttribute('data-requiremodule') === name &&
scriptNode.getAttribute('data-requirecontext') === context.contextName) {
scriptNode.parentNode.removeChild(scriptNode);
return true;
}
});
}
}
function hasPathFallback(id) {
var pathConfig = getOwn(config.paths, id);
if (pathConfig && isArray(pathConfig) && pathConfig.length > 1) {
removeScript(id);
//Pop off the first array value, since it failed, and
//retry
pathConfig.shift();
context.require.undef(id);
context.require([id]);
return true;
}
}
//Turns a plugin!resource to [plugin, resource]
//with the plugin being undefined if the name
//did not have a plugin prefix.
function splitPrefix(name) {
var prefix,
index = name ? name.indexOf('!') : -1;
if (index > -1) {
prefix = name.substring(0, index);
name = name.substring(index + 1, name.length);
}
return [prefix, name];
}
/**
* Creates a module mapping that includes plugin prefix, module
* name, and path. If parentModuleMap is provided it will
* also normalize the name via require.normalize()
*
* @param {String} name the module name
* @param {String} [parentModuleMap] parent module map
* for the module name, used to resolve relative names.
* @param {Boolean} isNormalized: is the ID already normalized.
* This is true if this call is done for a define() module ID.
* @param {Boolean} applyMap: apply the map config to the ID.
* Should only be true if this map is for a dependency.
*
* @returns {Object}
*/
function makeModuleMap(name, parentModuleMap, isNormalized, applyMap) {
var url, pluginModule, suffix, nameParts,
prefix = null,
parentName = parentModuleMap ? parentModuleMap.name : null,
originalName = name,
isDefine = true,
normalizedName = '';
//If no name, then it means it is a require call, generate an
//internal name.
if (!name) {
isDefine = false;
name = '_@r' + (requireCounter += 1);
}
nameParts = splitPrefix(name);
prefix = nameParts[0];
name = nameParts[1];
if (prefix) {
prefix = normalize(prefix, parentName, applyMap);
pluginModule = getOwn(defined, prefix);
}
//Account for relative paths if there is a base name.
if (name) {
if (prefix) {
if (pluginModule && pluginModule.normalize) {
//Plugin is loaded, use its normalize method.
normalizedName = pluginModule.normalize(name, function (name) {
return normalize(name, parentName, applyMap);
});
} else {
normalizedName = normalize(name, parentName, applyMap);
}
} else {
//A regular module.
normalizedName = normalize(name, parentName, applyMap);
//Normalized name may be a plugin ID due to map config
//application in normalize. The map config values must
//already be normalized, so do not need to redo that part.
nameParts = splitPrefix(normalizedName);
prefix = nameParts[0];
normalizedName = nameParts[1];
isNormalized = true;
url = context.nameToUrl(normalizedName);
}
}
//If the id is a plugin id that cannot be determined if it needs
//normalization, stamp it with a unique ID so two matching relative
//ids that may conflict can be separate.
suffix = prefix && !pluginModule && !isNormalized ?
'_unnormalized' + (unnormalizedCounter += 1) :
'';
return {
prefix: prefix,
name: normalizedName,
parentMap: parentModuleMap,
unnormalized: !!suffix,
url: url,
originalName: originalName,
isDefine: isDefine,
id: (prefix ?
prefix + '!' + normalizedName :
normalizedName) + suffix
};
}
function getModule(depMap) {
var id = depMap.id,
mod = getOwn(registry, id);
if (!mod) {
mod = registry[id] = new context.Module(depMap);
}
return mod;
}
function on(depMap, name, fn) {
var id = depMap.id,
mod = getOwn(registry, id);
if (hasProp(defined, id) &&
(!mod || mod.defineEmitComplete)) {
if (name === 'defined') {
fn(defined[id]);
}
} else {
getModule(depMap).on(name, fn);
}
}
function onError(err, errback) {
var ids = err.requireModules,
notified = false;
if (errback) {
errback(err);
} else {
each(ids, function (id) {
var mod = getOwn(registry, id);
if (mod) {
//Set error on module, so it skips timeout checks.
mod.error = err;
if (mod.events.error) {
notified = true;
mod.emit('error', err);
}
}
});
if (!notified) {
req.onError(err);
}
}
}
/**
* Internal method to transfer globalQueue items to this context's
* defQueue.
*/
function takeGlobalQueue() {
//Push all the globalDefQueue items into the context's defQueue
if (globalDefQueue.length) {
//Array splice in the values since the context code has a
//local var ref to defQueue, so cannot just reassign the one
//on context.
apsp.apply(defQueue,
[defQueue.length - 1, 0].concat(globalDefQueue));
globalDefQueue = [];
}
}
handlers = {
'require': function (mod) {
if (mod.require) {
return mod.require;
} else {
return (mod.require = context.makeRequire(mod.map));
}
},
'exports': function (mod) {
mod.usingExports = true;
if (mod.map.isDefine) {
if (mod.exports) {
return mod.exports;
} else {
return (mod.exports = defined[mod.map.id] = {});
}
}
},
'module': function (mod) {
if (mod.module) {
return mod.module;
} else {
return (mod.module = {
id: mod.map.id,
uri: mod.map.url,
config: function () {
return (config.config && getOwn(config.config, mod.map.id)) || {};
},
exports: defined[mod.map.id]
});
}
}
};
function cleanRegistry(id) {
//Clean up machinery used for waiting modules.
delete registry[id];
delete enabledRegistry[id];
}
function breakCycle(mod, traced, processed) {
var id = mod.map.id;
if (mod.error) {
mod.emit('error', mod.error);
} else {
traced[id] = true;
each(mod.depMaps, function (depMap, i) {
var depId = depMap.id,
dep = getOwn(registry, depId);
//Only force things that have not completed
//being defined, so still in the registry,
//and only if it has not been matched up
//in the module already.
if (dep && !mod.depMatched[i] && !processed[depId]) {
if (getOwn(traced, depId)) {
mod.defineDep(i, defined[depId]);
mod.check(); //pass false?
} else {
breakCycle(dep, traced, processed);
}
}
});
processed[id] = true;
}
}
function checkLoaded() {
var map, modId, err, usingPathFallback,
waitInterval = config.waitSeconds * 1000,
//It is possible to disable the wait interval by using waitSeconds of 0.
expired = waitInterval && (context.startTime + waitInterval) < new Date().getTime(),
noLoads = [],
reqCalls = [],
stillLoading = false,
needCycleCheck = true;
//Do not bother if this call was a result of a cycle break.
if (inCheckLoaded) {
return;
}
inCheckLoaded = true;
//Figure out the state of all the modules.
eachProp(enabledRegistry, function (mod) {
map = mod.map;
modId = map.id;
//Skip things that are not enabled or in error state.
if (!mod.enabled) {
return;
}
if (!map.isDefine) {
reqCalls.push(mod);
}
if (!mod.error) {
//If the module should be executed, and it has not
//been inited and time is up, remember it.
if (!mod.inited && expired) {
if (hasPathFallback(modId)) {
usingPathFallback = true;
stillLoading = true;
} else {
noLoads.push(modId);
removeScript(modId);
}
} else if (!mod.inited && mod.fetched && map.isDefine) {
stillLoading = true;
if (!map.prefix) {
//No reason to keep looking for unfinished
//loading. If the only stillLoading is a
//plugin resource though, keep going,
//because it may be that a plugin resource
//is waiting on a non-plugin cycle.
return (needCycleCheck = false);
}
}
}
});
if (expired && noLoads.length) {
//If wait time expired, throw error of unloaded modules.
err = makeError('timeout', 'Load timeout for modules: ' + noLoads, null, noLoads);
err.contextName = context.contextName;
return onError(err);
}
//Not expired, check for a cycle.
if (needCycleCheck) {
each(reqCalls, function (mod) {
breakCycle(mod, {}, {});
});
}
//If still waiting on loads, and the waiting load is something
//other than a plugin resource, or there are still outstanding
//scripts, then just try back later.
if ((!expired || usingPathFallback) && stillLoading) {
//Something is still waiting to load. Wait for it, but only
//if a timeout is not already in effect.
if ((isBrowser || isWebWorker) && !checkLoadedTimeoutId) {
checkLoadedTimeoutId = setTimeout(function () {
checkLoadedTimeoutId = 0;
checkLoaded();
}, 50);
}
}
inCheckLoaded = false;
}
Module = function (map) {
this.events = getOwn(undefEvents, map.id) || {};
this.map = map;
this.shim = getOwn(config.shim, map.id);
this.depExports = [];
this.depMaps = [];
this.depMatched = [];
this.pluginMaps = {};
this.depCount = 0;
/* this.exports this.factory
this.depMaps = [],
this.enabled, this.fetched
*/
};
Module.prototype = {
init: function (depMaps, factory, errback, options) {
options = options || {};
//Do not do more inits if already done. Can happen if there
//are multiple define calls for the same module. That is not
//a normal, common case, but it is also not unexpected.
if (this.inited) {
return;
}
this.factory = factory;
if (errback) {
//Register for errors on this module.
this.on('error', errback);
} else if (this.events.error) {
//If no errback already, but there are error listeners
//on this module, set up an errback to pass to the deps.
errback = bind(this, function (err) {
this.emit('error', err);
});
}
//Do a copy of the dependency array, so that
//source inputs are not modified. For example
//"shim" deps are passed in here directly, and
//doing a direct modification of the depMaps array
//would affect that config.
this.depMaps = depMaps && depMaps.slice(0);
this.errback = errback;
//Indicate this module has be initialized
this.inited = true;
this.ignore = options.ignore;
//Could have option to init this module in enabled mode,
//or could have been previously marked as enabled. However,
//the dependencies are not known until init is called. So
//if enabled previously, now trigger dependencies as enabled.
if (options.enabled || this.enabled) {
//Enable this module and dependencies.
//Will call this.check()
this.enable();
} else {
this.check();
}
},
defineDep: function (i, depExports) {
//Because of cycles, defined callback for a given
//export can be called more than once.
if (!this.depMatched[i]) {
this.depMatched[i] = true;
this.depCount -= 1;
this.depExports[i] = depExports;
}
},
fetch: function () {
if (this.fetched) {
return;
}
this.fetched = true;
context.startTime = (new Date()).getTime();
var map = this.map;
//If the manager is for a plugin managed resource,
//ask the plugin to load it now.
if (this.shim) {
context.makeRequire(this.map, {
enableBuildCallback: true
})(this.shim.deps || [], bind(this, function () {
return map.prefix ? this.callPlugin() : this.load();
}));
} else {
//Regular dependency.
return map.prefix ? this.callPlugin() : this.load();
}
},
load: function () {
var url = this.map.url;
//Regular dependency.
if (!urlFetched[url]) {
urlFetched[url] = true;
context.load(this.map.id, url);
}
},
/**
* Checks if the module is ready to define itself, and if so,
* define it.
*/
check: function () {
if (!this.enabled || this.enabling) {
return;
}
var err, cjsModule,
id = this.map.id,
depExports = this.depExports,
exports = this.exports,
factory = this.factory;
if (!this.inited) {
this.fetch();
} else if (this.error) {
this.emit('error', this.error);
} else if (!this.defining) {
//The factory could trigger another require call
//that would result in checking this module to
//define itself again. If already in the process
//of doing that, skip this work.
this.defining = true;
if (this.depCount < 1 && !this.defined) {
if (isFunction(factory)) {
//If there is an error listener, favor passing
//to that instead of throwing an error.
if (this.events.error) {
try {
exports = context.execCb(id, factory, depExports, exports);
} catch (e) {
err = e;
}
} else {
exports = context.execCb(id, factory, depExports, exports);
}
if (this.map.isDefine) {
//If setting exports via 'module' is in play,
//favor that over return value and exports. After that,
//favor a non-undefined return value over exports use.
cjsModule = this.module;
if (cjsModule &&
cjsModule.exports !== undefined &&
//Make sure it is not already the exports value
cjsModule.exports !== this.exports) {
exports = cjsModule.exports;
} else if (exports === undefined && this.usingExports) {
//exports already set the defined value.
exports = this.exports;
}
}
if (err) {
err.requireMap = this.map;
err.requireModules = [this.map.id];
err.requireType = 'define';
return onError((this.error = err));
}
} else {
//Just a literal value
exports = factory;
}
this.exports = exports;
if (this.map.isDefine && !this.ignore) {
defined[id] = exports;
if (req.onResourceLoad) {
req.onResourceLoad(context, this.map, this.depMaps);
}
}
//Clean up
cleanRegistry(id);
this.defined = true;
}
//Finished the define stage. Allow calling check again
//to allow define notifications below in the case of a
//cycle.
this.defining = false;
if (this.defined && !this.defineEmitted) {
this.defineEmitted = true;
this.emit('defined', this.exports);
this.defineEmitComplete = true;
}
}
},
callPlugin: function () {
var map = this.map,
id = map.id,
//Map already normalized the prefix.
pluginMap = makeModuleMap(map.prefix);
//Mark this as a dependency for this plugin, so it
//can be traced for cycles.
this.depMaps.push(pluginMap);
on(pluginMap, 'defined', bind(this, function (plugin) {
var load, normalizedMap, normalizedMod,
name = this.map.name,
parentName = this.map.parentMap ? this.map.parentMap.name : null,
localRequire = context.makeRequire(map.parentMap, {
enableBuildCallback: true
});
//If current map is not normalized, wait for that
//normalized name to load instead of continuing.
if (this.map.unnormalized) {
//Normalize the ID if the plugin allows it.
if (plugin.normalize) {
name = plugin.normalize(name, function (name) {
return normalize(name, parentName, true);
}) || '';
}
//prefix and name should already be normalized, no need
//for applying map config again either.
normalizedMap = makeModuleMap(map.prefix + '!' + name,
this.map.parentMap);
on(normalizedMap,
'defined', bind(this, function (value) {
this.init([], function () { return value; }, null, {
enabled: true,
ignore: true
});
}));
normalizedMod = getOwn(registry, normalizedMap.id);
if (normalizedMod) {
//Mark this as a dependency for this plugin, so it
//can be traced for cycles.
this.depMaps.push(normalizedMap);
if (this.events.error) {
normalizedMod.on('error', bind(this, function (err) {
this.emit('error', err);
}));
}
normalizedMod.enable();
}
return;
}
load = bind(this, function (value) {
this.init([], function () { return value; }, null, {
enabled: true
});
});
load.error = bind(this, function (err) {
this.inited = true;
this.error = err;
err.requireModules = [id];
//Remove temp unnormalized modules for this module,
//since they will never be resolved otherwise now.
eachProp(registry, function (mod) {
if (mod.map.id.indexOf(id + '_unnormalized') === 0) {
cleanRegistry(mod.map.id);
}
});
onError(err);
});
//Allow plugins to load other code without having to know the
//context or how to 'complete' the load.
load.fromText = bind(this, function (text, textAlt) {
/*jslint evil: true */
var moduleName = map.name,
moduleMap = makeModuleMap(moduleName),
hasInteractive = useInteractive;
//As of 2.1.0, support just passing the text, to reinforce
//fromText only being called once per resource. Still
//support old style of passing moduleName but discard
//that moduleName in favor of the internal ref.
if (textAlt) {
text = textAlt;
}
//Turn off interactive script matching for IE for any define
//calls in the text, then turn it back on at the end.
if (hasInteractive) {
useInteractive = false;
}
//Prime the system by creating a module instance for
//it.
getModule(moduleMap);
//Transfer any config to this other module.
if (hasProp(config.config, id)) {
config.config[moduleName] = config.config[id];
}
try {
req.exec(text);
} catch (e) {
return onError(makeError('fromtexteval',
'fromText eval for ' + id +
' failed: ' + e,
e,
[id]));
}
if (hasInteractive) {
useInteractive = true;
}
//Mark this as a dependency for the plugin
//resource
this.depMaps.push(moduleMap);
//Support anonymous modules.
context.completeLoad(moduleName);
//Bind the value of that module to the value for this
//resource ID.
localRequire([moduleName], load);
});
//Use parentName here since the plugin's name is not reliable,
//could be some weird string with no path that actually wants to
//reference the parentName's path.
plugin.load(map.name, localRequire, load, config);
}));
context.enable(pluginMap, this);
this.pluginMaps[pluginMap.id] = pluginMap;
},
enable: function () {
enabledRegistry[this.map.id] = this;
this.enabled = true;
//Set flag mentioning that the module is enabling,
//so that immediate calls to the defined callbacks
//for dependencies do not trigger inadvertent load
//with the depCount still being zero.
this.enabling = true;
//Enable each dependency
each(this.depMaps, bind(this, function (depMap, i) {
var id, mod, handler;
if (typeof depMap === 'string') {
//Dependency needs to be converted to a depMap
//and wired up to this module.
depMap = makeModuleMap(depMap,
(this.map.isDefine ? this.map : this.map.parentMap),
false,
!this.skipMap);
this.depMaps[i] = depMap;
handler = getOwn(handlers, depMap.id);
if (handler) {
this.depExports[i] = handler(this);
return;
}
this.depCount += 1;
on(depMap, 'defined', bind(this, function (depExports) {
this.defineDep(i, depExports);
this.check();
}));
if (this.errback) {
on(depMap, 'error', this.errback);
}
}
id = depMap.id;
mod = registry[id];
//Skip special modules like 'require', 'exports', 'module'
//Also, don't call enable if it is already enabled,
//important in circular dependency cases.
if (!hasProp(handlers, id) && mod && !mod.enabled) {
context.enable(depMap, this);
}
}));
//Enable each plugin that is used in
//a dependency
eachProp(this.pluginMaps, bind(this, function (pluginMap) {
var mod = getOwn(registry, pluginMap.id);
if (mod && !mod.enabled) {
context.enable(pluginMap, this);
}
}));
this.enabling = false;
this.check();
},
on: function (name, cb) {
var cbs = this.events[name];
if (!cbs) {
cbs = this.events[name] = [];
}
cbs.push(cb);
},
emit: function (name, evt) {
each(this.events[name], function (cb) {
cb(evt);
});
if (name === 'error') {
//Now that the error handler was triggered, remove
//the listeners, since this broken Module instance
//can stay around for a while in the registry.
delete this.events[name];
}
}
};
function callGetModule(args) {
//Skip modules already defined.
if (!hasProp(defined, args[0])) {
getModule(makeModuleMap(args[0], null, true)).init(args[1], args[2]);
}
}
function removeListener(node, func, name, ieName) {
//Favor detachEvent because of IE9
//issue, see attachEvent/addEventListener comment elsewhere
//in this file.
if (node.detachEvent && !isOpera) {
//Probably IE. If not it will throw an error, which will be
//useful to know.
if (ieName) {
node.detachEvent(ieName, func);
}
} else {
node.removeEventListener(name, func, false);
}
}
/**
* Given an event from a script node, get the requirejs info from it,
* and then removes the event listeners on the node.
* @param {Event} evt
* @returns {Object}
*/
function getScriptData(evt) {
//Using currentTarget instead of target for Firefox 2.0's sake. Not
//all old browsers will be supported, but this one was easy enough
//to support and still makes sense.
var node = evt.currentTarget || evt.srcElement;
//Remove the listeners once here.
removeListener(node, context.onScriptLoad, 'load', 'onreadystatechange');
removeListener(node, context.onScriptError, 'error');
return {
node: node,
id: node && node.getAttribute('data-requiremodule')
};
}
function intakeDefines() {
var args;
//Any defined modules in the global queue, intake them now.
takeGlobalQueue();
//Make sure any remaining defQueue items get properly processed.
while (defQueue.length) {
args = defQueue.shift();
if (args[0] === null) {
return onError(makeError('mismatch', 'Mismatched anonymous define() module: ' + args[args.length - 1]));
} else {
//args are id, deps, factory. Should be normalized by the
//define() function.
callGetModule(args);
}
}
}
context = {
config: config,
contextName: contextName,
registry: registry,
defined: defined,
urlFetched: urlFetched,
defQueue: defQueue,
Module: Module,
makeModuleMap: makeModuleMap,
nextTick: req.nextTick,
onError: onError,
/**
* Set a configuration for the context.
* @param {Object} cfg config object to integrate.
*/
configure: function (cfg) {
//Make sure the baseUrl ends in a slash.
if (cfg.baseUrl) {
if (cfg.baseUrl.charAt(cfg.baseUrl.length - 1) !== '/') {
cfg.baseUrl += '/';
}
}
//Save off the paths and packages since they require special processing,
//they are additive.
var pkgs = config.pkgs,
shim = config.shim,
objs = {
paths: true,
config: true,
map: true
};
eachProp(cfg, function (value, prop) {
if (objs[prop]) {
if (prop === 'map') {
if (!config.map) {
config.map = {};
}
mixin(config[prop], value, true, true);
} else {
mixin(config[prop], value, true);
}
} else {
config[prop] = value;
}
});
//Merge shim
if (cfg.shim) {
eachProp(cfg.shim, function (value, id) {
//Normalize the structure
if (isArray(value)) {
value = {
deps: value
};
}
if ((value.exports || value.init) && !value.exportsFn) {
value.exportsFn = context.makeShimExports(value);
}
shim[id] = value;
});
config.shim = shim;
}
//Adjust packages if necessary.
if (cfg.packages) {
each(cfg.packages, function (pkgObj) {
var location;
pkgObj = typeof pkgObj === 'string' ? { name: pkgObj } : pkgObj;
location = pkgObj.location;
//Create a brand new object on pkgs, since currentPackages can
//be passed in again, and config.pkgs is the internal transformed
//state for all package configs.
pkgs[pkgObj.name] = {
name: pkgObj.name,
location: location || pkgObj.name,
//Remove leading dot in main, so main paths are normalized,
//and remove any trailing .js, since different package
//envs have different conventions: some use a module name,
//some use a file name.
main: (pkgObj.main || 'main')
.replace(currDirRegExp, '')
.replace(jsSuffixRegExp, '')
};
});
//Done with modifications, assing packages back to context config
config.pkgs = pkgs;
}
//If there are any "waiting to execute" modules in the registry,
//update the maps for them, since their info, like URLs to load,
//may have changed.
eachProp(registry, function (mod, id) {
//If module already has init called, since it is too
//late to modify them, and ignore unnormalized ones
//since they are transient.
if (!mod.inited && !mod.map.unnormalized) {
mod.map = makeModuleMap(id);
}
});
//If a deps array or a config callback is specified, then call
//require with those args. This is useful when require is defined as a
//config object before require.js is loaded.
if (cfg.deps || cfg.callback) {
context.require(cfg.deps || [], cfg.callback);
}
},
makeShimExports: function (value) {
function fn() {
var ret;
if (value.init) {
ret = value.init.apply(global, arguments);
}
return ret || (value.exports && getGlobal(value.exports));
}
return fn;
},
makeRequire: function (relMap, options) {
options = options || {};
function localRequire(deps, callback, errback) {
var id, map, requireMod;
if (options.enableBuildCallback && callback && isFunction(callback)) {
callback.__requireJsBuild = true;
}
if (typeof deps === 'string') {
if (isFunction(callback)) {
//Invalid call
return onError(makeError('requireargs', 'Invalid require call'), errback);
}
//If require|exports|module are requested, get the
//value for them from the special handlers. Caveat:
//this only works while module is being defined.
if (relMap && hasProp(handlers, deps)) {
return handlers[deps](registry[relMap.id]);
}
//Synchronous access to one module. If require.get is
//available (as in the Node adapter), prefer that.
if (req.get) {
return req.get(context, deps, relMap, localRequire);
}
//Normalize module name, if it contains . or ..
map = makeModuleMap(deps, relMap, false, true);
id = map.id;
if (!hasProp(defined, id)) {
return onError(makeError('notloaded', 'Module name "' +
id +
'" has not been loaded yet for context: ' +
contextName +
(relMap ? '' : '. Use require([])')));
}
return defined[id];
}
//Grab defines waiting in the global queue.
intakeDefines();
//Mark all the dependencies as needing to be loaded.
context.nextTick(function () {
//Some defines could have been added since the
//require call, collect them.
intakeDefines();
requireMod = getModule(makeModuleMap(null, relMap));
//Store if map config should be applied to this require
//call for dependencies.
requireMod.skipMap = options.skipMap;
requireMod.init(deps, callback, errback, {
enabled: true
});
checkLoaded();
});
return localRequire;
}
mixin(localRequire, {
isBrowser: isBrowser,
/**
* Converts a module name + .extension into an URL path.
* *Requires* the use of a module name. It does not support using
* plain URLs like nameToUrl.
*/
toUrl: function (moduleNamePlusExt) {
var ext,
index = moduleNamePlusExt.lastIndexOf('.'),
segment = moduleNamePlusExt.split('/')[0],
isRelative = segment === '.' || segment === '..';
//Have a file extension alias, and it is not the
//dots from a relative path.
if (index !== -1 && (!isRelative || index > 1)) {
ext = moduleNamePlusExt.substring(index, moduleNamePlusExt.length);
moduleNamePlusExt = moduleNamePlusExt.substring(0, index);
}
return context.nameToUrl(normalize(moduleNamePlusExt,
relMap && relMap.id, true), ext, true);
},
defined: function (id) {
return hasProp(defined, makeModuleMap(id, relMap, false, true).id);
},
specified: function (id) {
id = makeModuleMap(id, relMap, false, true).id;
return hasProp(defined, id) || hasProp(registry, id);
}
});
//Only allow undef on top level require calls
if (!relMap) {
localRequire.undef = function (id) {
//Bind any waiting define() calls to this context,
//fix for #408
takeGlobalQueue();
var map = makeModuleMap(id, relMap, true),
mod = getOwn(registry, id);
delete defined[id];
delete urlFetched[map.url];
delete undefEvents[id];
if (mod) {
//Hold on to listeners in case the
//module will be attempted to be reloaded
//using a different config.
if (mod.events.defined) {
undefEvents[id] = mod.events;
}
cleanRegistry(id);
}
};
}
return localRequire;
},
/**
* Called to enable a module if it is still in the registry
* awaiting enablement. A second arg, parent, the parent module,
* is passed in for context, when this method is overriden by
* the optimizer. Not shown here to keep code compact.
*/
enable: function (depMap) {
var mod = getOwn(registry, depMap.id);
if (mod) {
getModule(depMap).enable();
}
},
/**
* Internal method used by environment adapters to complete a load event.
* A load event could be a script load or just a load pass from a synchronous
* load call.
* @param {String} moduleName the name of the module to potentially complete.
*/
completeLoad: function (moduleName) {
var found, args, mod,
shim = getOwn(config.shim, moduleName) || {},
shExports = shim.exports;
takeGlobalQueue();
while (defQueue.length) {
args = defQueue.shift();
if (args[0] === null) {
args[0] = moduleName;
//If already found an anonymous module and bound it
//to this name, then this is some other anon module
//waiting for its completeLoad to fire.
if (found) {
break;
}
found = true;
} else if (args[0] === moduleName) {
//Found matching define call for this script!
found = true;
}
callGetModule(args);
}
//Do this after the cycle of callGetModule in case the result
//of those calls/init calls changes the registry.
mod = getOwn(registry, moduleName);
if (!found && !hasProp(defined, moduleName) && mod && !mod.inited) {
if (config.enforceDefine && (!shExports || !getGlobal(shExports))) {
if (hasPathFallback(moduleName)) {
return;
} else {
return onError(makeError('nodefine',
'No define call for ' + moduleName,
null,
[moduleName]));
}
} else {
//A script that does not call define(), so just simulate
//the call for it.
callGetModule([moduleName, (shim.deps || []), shim.exportsFn]);
}
}
checkLoaded();
},
/**
* Converts a module name to a file path. Supports cases where
* moduleName may actually be just an URL.
* Note that it **does not** call normalize on the moduleName,
* it is assumed to have already been normalized. This is an
* internal API, not a public one. Use toUrl for the public API.
*/
nameToUrl: function (moduleName, ext, skipExt) {
var paths, pkgs, pkg, pkgPath, syms, i, parentModule, url,
parentPath;
//If a colon is in the URL, it indicates a protocol is used and it is just
//an URL to a file, or if it starts with a slash, contains a query arg (i.e. ?)
//or ends with .js, then assume the user meant to use an url and not a module id.
//The slash is important for protocol-less URLs as well as full paths.
if (req.jsExtRegExp.test(moduleName)) {
//Just a plain path, not module name lookup, so just return it.
//Add extension if it is included. This is a bit wonky, only non-.js things pass
//an extension, this method probably needs to be reworked.
url = moduleName + (ext || '');
} else {
//A module that needs to be converted to a path.
paths = config.paths;
pkgs = config.pkgs;
syms = moduleName.split('/');
//For each module name segment, see if there is a path
//registered for it. Start with most specific name
//and work up from it.
for (i = syms.length; i > 0; i -= 1) {
parentModule = syms.slice(0, i).join('/');
pkg = getOwn(pkgs, parentModule);
parentPath = getOwn(paths, parentModule);
if (parentPath) {
//If an array, it means there are a few choices,
//Choose the one that is desired
if (isArray(parentPath)) {
parentPath = parentPath[0];
}
syms.splice(0, i, parentPath);
break;
} else if (pkg) {
//If module name is just the package name, then looking
//for the main module.
if (moduleName === pkg.name) {
pkgPath = pkg.location + '/' + pkg.main;
} else {
pkgPath = pkg.location;
}
syms.splice(0, i, pkgPath);
break;
}
}
//Join the path parts together, then figure out if baseUrl is needed.
url = syms.join('/');
url += (ext || (/\?/.test(url) || skipExt ? '' : '.js'));
url = (url.charAt(0) === '/' || url.match(/^[\w\+\.\-]+:/) ? '' : config.baseUrl) + url;
}
return config.urlArgs ? url +
((url.indexOf('?') === -1 ? '?' : '&') +
config.urlArgs) : url;
},
//Delegates to req.load. Broken out as a separate function to
//allow overriding in the optimizer.
load: function (id, url) {
req.load(context, id, url);
},
/**
* Executes a module callack function. Broken out as a separate function
* solely to allow the build system to sequence the files in the built
* layer in the right sequence.
*
* @private
*/
execCb: function (name, callback, args, exports) {
return callback.apply(exports, args);
},
/**
* callback for script loads, used to check status of loading.
*
* @param {Event} evt the event from the browser for the script
* that was loaded.
*/
onScriptLoad: function (evt) {
//Using currentTarget instead of target for Firefox 2.0's sake. Not
//all old browsers will be supported, but this one was easy enough
//to support and still makes sense.
if (evt.type === 'load' ||
(readyRegExp.test((evt.currentTarget || evt.srcElement).readyState))) {
//Reset interactive script so a script node is not held onto for
//to long.
interactiveScript = null;
//Pull out the name of the module and the context.
var data = getScriptData(evt);
context.completeLoad(data.id);
}
},
/**
* Callback for script errors.
*/
onScriptError: function (evt) {
var data = getScriptData(evt);
if (!hasPathFallback(data.id)) {
return onError(makeError('scripterror', 'Script error', evt, [data.id]));
}
}
};
context.require = context.makeRequire();
return context;
}
/**
* Main entry point.
*
* If the only argument to require is a string, then the module that
* is represented by that string is fetched for the appropriate context.
*
* If the first argument is an array, then it will be treated as an array
* of dependency string names to fetch. An optional function callback can
* be specified to execute when all of those dependencies are available.
*
* Make a local req variable to help Caja compliance (it assumes things
* on a require that are not standardized), and to give a short
* name for minification/local scope use.
*/
req = requirejs = function (deps, callback, errback, optional) {
//Find the right context, use default
var context, config,
contextName = defContextName;
// Determine if have config object in the call.
if (!isArray(deps) && typeof deps !== 'string') {
// deps is a config object
config = deps;
if (isArray(callback)) {
// Adjust args if there are dependencies
deps = callback;
callback = errback;
errback = optional;
} else {
deps = [];
}
}
if (config && config.context) {
contextName = config.context;
}
context = getOwn(contexts, contextName);
if (!context) {
context = contexts[contextName] = req.s.newContext(contextName);
}
if (config) {
context.configure(config);
}
return context.require(deps, callback, errback);
};
/**
* Support require.config() to make it easier to cooperate with other
* AMD loaders on globally agreed names.
*/
req.config = function (config) {
return req(config);
};
/**
* Execute something after the current tick
* of the event loop. Override for other envs
* that have a better solution than setTimeout.
* @param {Function} fn function to execute later.
*/
req.nextTick = typeof setTimeout !== 'undefined' ? function (fn) {
setTimeout(fn, 4);
} : function (fn) { fn(); };
/**
* Export require as a global, but only if it does not already exist.
*/
if (!require) {
require = req;
}
req.version = version;
//Used to filter out dependencies that are already paths.
req.jsExtRegExp = /^\/|:|\?|\.js$/;
req.isBrowser = isBrowser;
s = req.s = {
contexts: contexts,
newContext: newContext
};
//Create default context.
req({});
//Exports some context-sensitive methods on global require.
each([
'toUrl',
'undef',
'defined',
'specified'
], function (prop) {
//Reference from contexts instead of early binding to default context,
//so that during builds, the latest instance of the default context
//with its config gets used.
req[prop] = function () {
var ctx = contexts[defContextName];
return ctx.require[prop].apply(ctx, arguments);
};
});
if (isBrowser) {
head = s.head = document.getElementsByTagName('head')[0];
//If BASE tag is in play, using appendChild is a problem for IE6.
//When that browser dies, this can be removed. Details in this jQuery bug:
//http://dev.jquery.com/ticket/2709
baseElement = document.getElementsByTagName('base')[0];
if (baseElement) {
head = s.head = baseElement.parentNode;
}
}
/**
* Any errors that require explicitly generates will be passed to this
* function. Intercept/override it if you want custom error handling.
* @param {Error} err the error object.
*/
req.onError = function (err) {
throw err;
};
/**
* Does the request to load a module for the browser case.
* Make this a separate function to allow other environments
* to override it.
*
* @param {Object} context the require context to find state.
* @param {String} moduleName the name of the module.
* @param {Object} url the URL to the module.
*/
req.load = function (context, moduleName, url) {
var config = (context && context.config) || {},
node;
if (isBrowser) {
//In the browser so use a script tag
node = config.xhtml ?
document.createElementNS('http://www.w3.org/1999/xhtml', 'html:script') :
document.createElement('script');
node.type = config.scriptType || 'text/javascript';
node.charset = 'utf-8';
node.async = true;
node.setAttribute('data-requirecontext', context.contextName);
node.setAttribute('data-requiremodule', moduleName);
//Set up load listener. Test attachEvent first because IE9 has
//a subtle issue in its addEventListener and script onload firings
//that do not match the behavior of all other browsers with
//addEventListener support, which fire the onload event for a
//script right after the script execution. See:
//https://connect.microsoft.com/IE/feedback/details/648057/script-onload-event-is-not-fired-immediately-after-script-execution
//UNFORTUNATELY Opera implements attachEvent but does not follow the script
//script execution mode.
if (node.attachEvent &&
//Check if node.attachEvent is artificially added by custom script or
//natively supported by browser
//read https://github.com/jrburke/requirejs/issues/187
//if we can NOT find [native code] then it must NOT natively supported.
//in IE8, node.attachEvent does not have toString()
//Note the test for "[native code" with no closing brace, see:
//https://github.com/jrburke/requirejs/issues/273
!(node.attachEvent.toString && node.attachEvent.toString().indexOf('[native code') < 0) &&
!isOpera) {
//Probably IE. IE (at least 6-8) do not fire
//script onload right after executing the script, so
//we cannot tie the anonymous define call to a name.
//However, IE reports the script as being in 'interactive'
//readyState at the time of the define call.
useInteractive = true;
node.attachEvent('onreadystatechange', context.onScriptLoad);
//It would be great to add an error handler here to catch
//404s in IE9+. However, onreadystatechange will fire before
//the error handler, so that does not help. If addEventListener
//is used, then IE will fire error before load, but we cannot
//use that pathway given the connect.microsoft.com issue
//mentioned above about not doing the 'script execute,
//then fire the script load event listener before execute
//next script' that other browsers do.
//Best hope: IE10 fixes the issues,
//and then destroys all installs of IE 6-9.
//node.attachEvent('onerror', context.onScriptError);
} else {
node.addEventListener('load', context.onScriptLoad, false);
node.addEventListener('error', context.onScriptError, false);
}
node.src = url;
//For some cache cases in IE 6-8, the script executes before the end
//of the appendChild execution, so to tie an anonymous define
//call to the module name (which is stored on the node), hold on
//to a reference to this node, but clear after the DOM insertion.
currentlyAddingScript = node;
if (baseElement) {
head.insertBefore(node, baseElement);
} else {
head.appendChild(node);
}
currentlyAddingScript = null;
return node;
} else if (isWebWorker) {
try {
//In a web worker, use importScripts. This is not a very
//efficient use of importScripts, importScripts will block until
//its script is downloaded and evaluated. However, if web workers
//are in play, the expectation that a build has been done so that
//only one script needs to be loaded anyway. This may need to be
//reevaluated if other use cases become common.
importScripts(url);
//Account for anonymous modules
context.completeLoad(moduleName);
} catch (e) {
context.onError(makeError('importscripts',
'importScripts failed for ' +
moduleName + ' at ' + url,
e,
[moduleName]));
}
}
};
function getInteractiveScript() {
if (interactiveScript && interactiveScript.readyState === 'interactive') {
return interactiveScript;
}
eachReverse(scripts(), function (script) {
if (script.readyState === 'interactive') {
return (interactiveScript = script);
}
});
return interactiveScript;
}
//Look for a data-main script attribute, which could also adjust the baseUrl.
if (isBrowser) {
//Figure out baseUrl. Get it from the script tag with require.js in it.
eachReverse(scripts(), function (script) {
//Set the 'head' where we can append children by
//using the script's parent.
if (!head) {
head = script.parentNode;
}
//Look for a data-main attribute to set main script for the page
//to load. If it is there, the path to data main becomes the
//baseUrl, if it is not already set.
dataMain = script.getAttribute('data-main');
if (dataMain) {
//Set final baseUrl if there is not already an explicit one.
if (!cfg.baseUrl) {
//Pull off the directory of data-main for use as the
//baseUrl.
src = dataMain.split('/');
mainScript = src.pop();
subPath = src.length ? src.join('/') + '/' : './';
cfg.baseUrl = subPath;
dataMain = mainScript;
}
//Strip off any trailing .js since dataMain is now
//like a module name.
dataMain = dataMain.replace(jsSuffixRegExp, '');
//Put the data-main script in the files to load.
cfg.deps = cfg.deps ? cfg.deps.concat(dataMain) : [dataMain];
return true;
}
});
}
/**
* The function that handles definitions of modules. Differs from
* require() in that a string for the module should be the first argument,
* and the function to execute after dependencies are loaded should
* return a value to define the module corresponding to the first argument's
* name.
*/
define = function (name, deps, callback) {
var node, context;
//Allow for anonymous modules
if (typeof name !== 'string') {
//Adjust args appropriately
callback = deps;
deps = name;
name = null;
}
//This module may not have dependencies
if (!isArray(deps)) {
callback = deps;
deps = [];
}
//If no name, and callback is a function, then figure out if it a
//CommonJS thing with dependencies.
if (!deps.length && isFunction(callback)) {
//Remove comments from the callback string,
//look for require calls, and pull them into the dependencies,
//but only if there are function args.
if (callback.length) {
callback
.toString()
.replace(commentRegExp, '')
.replace(cjsRequireRegExp, function (match, dep) {
deps.push(dep);
});
//May be a CommonJS thing even without require calls, but still
//could use exports, and module. Avoid doing exports and module
//work though if it just needs require.
//REQUIRES the function to expect the CommonJS variables in the
//order listed below.
deps = (callback.length === 1 ? ['require'] : ['require', 'exports', 'module']).concat(deps);
}
}
//If in IE 6-8 and hit an anonymous define() call, do the interactive
//work.
if (useInteractive) {
node = currentlyAddingScript || getInteractiveScript();
if (node) {
if (!name) {
name = node.getAttribute('data-requiremodule');
}
context = contexts[node.getAttribute('data-requirecontext')];
}
}
//Always save off evaluating the def call until the script onload handler.
//This allows multiple modules to be in a file without prematurely
//tracing dependencies, and allows for anonymous module support,
//where the module name is not known until the script onload event
//occurs. If no context, use the global queue, and get it processed
//in the onscript load callback.
(context ? context.defQueue : globalDefQueue).push([name, deps, callback]);
};
define.amd = {
jQuery: true
};
/**
* Executes the text. Normally just uses eval, but can be modified
* to use a better, environment-specific call. Only used for transpiling
* loader plugins, not for plain JS modules.
* @param {String} text the text to execute/evaluate.
*/
req.exec = function (text) {
/*jslint evil: true */
return eval(text);
};
//Set up with config info.
req(cfg);
}(this));
================================================
FILE: src/ComponentInstaller/Util/Filesystem.php
================================================
recursiveGlob($dir.DIRECTORY_SEPARATOR.basename($pattern), $flags));
}
}
}
return $files;
}
/**
* Performs a recursive glob search for files with the given pattern.
*
* @param string $pattern
* The pattern passed to glob().
* @param int $flags
* Flags to pass into glob().
*
* @return mixed
* An array of files that match the recursive pattern given.
*/
public function recursiveGlobFiles($pattern, $flags = 0)
{
$files = $this->recursiveGlob($pattern, $flags);
return array_filter($files, 'is_file');
}
}
================================================
FILE: src/bootstrap.php
================================================
componentDir = realpath(sys_get_temp_dir()).DIRECTORY_SEPARATOR.'composer-test-component';
$this->ensureDirectoryExistsAndClear($this->componentDir);
// Merge the component-dir setting in so that it applies correctly.
$this->config->merge(array(
'config' => array(
'component-dir' => $this->componentDir,
),
));
}
/**
* {@inheritdoc}
*/
protected function tearDown()
{
$this->fs->removeDirectory($this->componentDir);
parent::tearDown();
}
/**
* Tests that the Installer doesn't create the Component directory.
*/
public function testInstallerCreationShouldNotCreateComponentDirectory()
{
$this->fs->removeDirectory($this->componentDir);
new Installer($this->io, $this->composer);
$this->assertFileNotExists($this->componentDir);
}
/**
* Test the Installer's support() function.
*
* @param $type
* The type of library.
* @param $expected
* Whether or not the given type is supported by Component Installer.
*
* @return void
*
* @dataProvider providerComponentSupports
*/
public function testComponentSupports($type, $expected)
{
$installer = new Installer($this->io, $this->composer, 'component');
$this->assertSame($expected, $installer->supports($type), sprintf('Failed to show support for %s', $type));
}
/**
* Data provider for testComponentSupports().
*
* @see testComponentSupports()
*/
public function providerComponentSupports()
{
// All package types support having Components.
$tests[] = array('component', true);
$tests[] = array('all-supported', false);
return $tests;
}
/**
* Tests the Installer's getComponentPath function.
*
* @param $expected
* The expected install path for the package.
* @param $package
* The package to test upon.
*
* @dataProvider providerGetComponentPath
*
* @see \ComponentInstaller\Installer::getComponentPath()
*/
public function testGetComponentPath($expected, $package) {
// Construct the mock objects.
$installer = new Installer($this->io, $this->composer, 'component');
$loader = new ArrayLoader();
// Test the results.
$result = $installer->getComponentPath($loader->load($package));
$this->assertEquals($this->componentDir . DIRECTORY_SEPARATOR . $expected, $result);
}
/**
* Data provider for testGetComponentPath().
*
* @see testGetComponentPath()
*/
public function providerGetComponentPath()
{
$package = array(
'name' => 'foo/bar',
'type' => 'component',
'version' => '1.0.0',
);
$tests[] = array('bar', $package);
$package = array(
'name' => 'foo/bar2',
'version' => '1.0.0',
'type' => 'component',
'extra' => array(
'component' => array(
'name' => 'foo',
),
),
);
$tests[] = array('foo', $package);
return $tests;
}
}
================================================
FILE: tests/ComponentInstaller/Test/Process/CopyProcessTest.php
================================================
process = new CopyProcess($this->composer, $this->io);
}
/**
* testCopy
*
* @dataProvider providerCopyStyles
* @param array $packages
* @param array $files
*/
public function testCopyStyles($packages, $files)
{
// Initialize the process.
$this->process->init();
$this->process->copy($packages);
foreach ($files as $file) {
$this->assertFileExists($this->componentDir.'/' . $file, sprintf('Failed to find the destination file: %s', $file));
}
}
public function providerCopyStyles()
{
// Test collecting one style.
$package = array(
'name' => 'components/package',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test.css',
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'package/tests/ComponentInstaller/Test/Resources/test.css',
));
// Test collecting two styles.
$package = array(
'name' => 'components/packagewithtwostyles',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test2.css',
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'packagewithtwostyles/tests/ComponentInstaller/Test/Resources/test.css',
'packagewithtwostyles/tests/ComponentInstaller/Test/Resources/test2.css',
));
// Test collecting a style that doesn't exist.
$package = array(
'name' => 'components/stylethatdoesnotexist',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test-not-found.css',
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'stylethatdoesnotexist/tests/ComponentInstaller/Test/Resources/test.css',
));
// Test collecting all styles, files and scripts.
$package = array(
'name' => 'components/allassets',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test.css',
),
'files' => array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
),
'scripts' => array(
'tests/ComponentInstaller/Test/Resources/test.js'
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'allassets/tests/ComponentInstaller/Test/Resources/test.css',
'allassets/tests/ComponentInstaller/Test/Resources/img.jpg',
'allassets/tests/ComponentInstaller/Test/Resources/img2.jpg',
'allassets/tests/ComponentInstaller/Test/Resources/test.js',
));
// Test copying a different component name.
$package = array(
'name' => 'components/differentcomponentname',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'name' => 'diffname',
'files' => array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'diffname/tests/ComponentInstaller/Test/Resources/img.jpg',
));
// Test two different packages.
$package = array(
'name' => 'components/twopackages1',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'files' => array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
),
),
),
);
$package2 = array(
'name' => 'components/twopackages2',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'name' => 'twopackages2-diff',
'files' => array(
'tests/ComponentInstaller/Test/Resources/img2.jpg',
),
),
),
);
$packages = array($package, $package2);
$tests[] = array($packages, array(
'twopackages1/tests/ComponentInstaller/Test/Resources/img.jpg',
'twopackages2-diff/tests/ComponentInstaller/Test/Resources/img2.jpg',
));
// Test copying an asset with a glob().
$package = array(
'name' => 'components/differentcomponentname',
'version' => '1.2.3',
'is-root' => true, // Set the root so that it knows to use the cwd.
'extra' => array(
'component' => array(
'name' => 'diffname',
'files' => array(
'tests/ComponentInstaller/Test/Resources/*.jpg',
),
),
),
);
$packages = array($package);
$tests[] = array($packages, array(
'diffname/tests/ComponentInstaller/Test/Resources/img.jpg',
'diffname/tests/ComponentInstaller/Test/Resources/img2.jpg',
));
return $tests;
}
}
================================================
FILE: tests/ComponentInstaller/Test/Process/ProcessTest.php
================================================
filesystem = new Filesystem();
$this->composer = new Composer();
$this->config = new Config();
$this->io = new NullIO();
$this->componentDir = realpath(sys_get_temp_dir()).DIRECTORY_SEPARATOR.'component-installer-componentDir';
$this->vendorDir = realpath(sys_get_temp_dir()).DIRECTORY_SEPARATOR.'component-installer-vendorDir';
$this->binDir = realpath(sys_get_temp_dir()).DIRECTORY_SEPARATOR.'component-installer-binDir';
foreach (array($this->componentDir, $this->vendorDir, $this->binDir) as $dir) {
if (is_dir($dir)) {
$this->filesystem->removeDirectory($dir);
}
$this->filesystem->ensureDirectoryExists($dir);
}
$this->config->merge(array(
'config' => array(
'vendor-dir' => $this->vendorDir,
'component-dir' => $this->componentDir,
'bin-dir' => $this->binDir,
)
));
$this->composer->setConfig($this->config);
// Set up the Installation Manager.
$this->installationManager = new InstallationManager();
$this->installationManager->addInstaller(new LibraryInstaller($this->io, $this->composer));
$this->installationManager->addInstaller(new Installer($this->io, $this->composer));
$this->composer->setInstallationManager($this->installationManager);
}
protected function tearDown()
{
foreach (array($this->componentDir, $this->vendorDir, $this->binDir) as $dir) {
$this->filesystem->removeDirectory($dir);
}
}
/**
* testGetComponentName
*
* @dataProvider providerGetComponentName
* @param string $prettyName
* @param array $extra
* @param string $expected
*/
public function testGetComponentName($prettyName, array $extra, $expected)
{
$process = new Process($this->composer, $this->io);
$result = $process->getComponentName($prettyName, array('component' => $extra));
$this->assertEquals($result, $expected, sprintf('Fail to get proper component name for %s', $prettyName));
}
/**
* Data provider for testGetComponentName.
*
* @see testGetComponentName()
*/
public function providerGetComponentName()
{
return array(
array('components/jquery', array(), 'jquery'),
array('components/jquery', array('name' => 'myownjquery'), 'myownjquery'),
array('jquery', array(), 'jquery'),
);
}
}
================================================
FILE: tests/ComponentInstaller/Test/Process/RequireCssProcessTest.php
================================================
process = new RequireCssProcess($this->composer, $this->io);
}
/**
* testPackageStyles
*
* @dataProvider providerPackageStyles
* @param array $packages
* @param array $config
* @param array $expected
*/
public function testPackageStyles(array $packages, array $config, $expected = null)
{
$this->composer->getConfig()->merge(array('config' => $config));
$this->process->init();
$result = $this->process->packageStyles($packages);
$this->assertEquals($expected, $result);
}
public function providerPackageStyles()
{
// Test collecting one style.
$package = array(
'name' => 'components/package',
'type' => 'component',
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test.css',
),
),
),
'is-root' => true,
);
$packages = array($package);
$expected = array(
'package' => array(
'tests/ComponentInstaller/Test/Resources/test.css' => array(
realpath('tests/ComponentInstaller/Test/Resources/test.css'),
),
),
);
$tests[] = array($packages, array(), $expected);
// Test collecting a style that doesn't exist.
$package2 = array(
'name' => 'components/package2',
'type' => 'component',
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test-not-found.css',
),
),
),
'is-root' => true,
);
$packages = array($package, $package2);
$expected = array(
'package' => array(
'tests/ComponentInstaller/Test/Resources/test.css' => array(
realpath('tests/ComponentInstaller/Test/Resources/test.css'),
)
)
);
$tests[] = array($packages, array(), $expected);
// Test collecting a style that doesn't exist.
$package3 = array(
'name' => 'components/package3',
'type' => 'component',
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/test2.css',
),
),
),
'is-root' => true,
);
$packages = array($package, $package3);
$expected = array(
'package' => array(
'tests/ComponentInstaller/Test/Resources/test.css' => array(
realpath('tests/ComponentInstaller/Test/Resources/test.css'),
),
),
'package3' => array(
'tests/ComponentInstaller/Test/Resources/test2.css' => array(
realpath('tests/ComponentInstaller/Test/Resources/test2.css'),
),
)
);
$tests[] = array($packages, array(), $expected);
// Test collecting a style that uses glob().
$package = array(
'name' => 'components/package4',
'type' => 'component',
'extra' => array(
'component' => array(
'styles' => array(
'tests/ComponentInstaller/Test/Resources/*.css',
),
),
),
'is-root' => true,
);
$packages = array($package);
$expected = array(
'package4' => array(
'tests/ComponentInstaller/Test/Resources/*.css' => array(
realpath('tests/ComponentInstaller/Test/Resources/test.css'),
realpath('tests/ComponentInstaller/Test/Resources/test2.css'),
)
)
);
$tests[] = array($packages, array(), $expected);
return $tests;
}
}
================================================
FILE: tests/ComponentInstaller/Test/Process/RequireJsProcessTest.php
================================================
process = new RequireJsProcess($this->composer, $this->io);
}
/**
* testRequireJs
*
* @dataProvider providerRequireJs
* @param array $json
* @param string $expected
*/
public function testRequireJs(array $json = array(), $expected = '')
{
$result = $this->process->requireJs($json);
$this->assertEquals($expected, $result);
}
public function providerRequireJs()
{
// Start with a base RequireJS configuration.
$js = << 'bar'),
sprintf($js, "{\n \"foo\": \"bar\"\n}"),
);
return $tests;
}
/**
* testRequireJson
*
* @dataProvider providerRequireJson
* @param array $packages
* @param array $config
* @param string $expected
*/
public function testRequireJson(array $packages, array $config, $expected = null)
{
$this->composer->getConfig()->merge(array('config' => $config));
$this->process->init();
$result = $this->process->requireJson($packages);
$this->assertEquals($expected, $result);
}
public function providerRequireJson()
{
// Test a package that doesn't have any extra information.
$packageWithoutExtra = array(
'name' => 'components/packagewithoutextra',
'type' => 'component',
);
$packages = array($packageWithoutExtra);
$expected = array(
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test switching the component directory.
$packages = array($packageWithoutExtra);
$expected = array(
'baseUrl' => 'components',
);
$tests[] = array($packages, array('component-dir' => 'otherdir'), $expected);
// Test switching the baseUrl.
$packages = array($packageWithoutExtra);
$expected = array(
'baseUrl' => '/another/path',
);
$tests[] = array($packages, array('component-baseurl' => '/another/path'), $expected);
// Test a package with just Scripts.
$jquery = array(
'name' => 'components/jquery',
'type' => 'component',
'extra' => array(
'component' => array(
'scripts' => array(
'jquery.js',
)
)
)
);
$packages = array($jquery);
$expected = array(
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test a pckage with just shim information.
$underscore = array(
'name' => 'components/underscore',
'type' => 'component',
'extra' => array(
'component' => array(
'shim' => array(
'exports' => '_',
),
),
),
'baseUrl' => 'components',
);
$packages = array($underscore);
$expected = array(
'shim' => array(
'underscore' => array(
'exports' => '_',
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test a package the has everything.
$backbone = array(
'name' => 'components/backbone',
'type' => 'component',
'extra' => array(
'component' => array(
'scripts' => array(
'backbone.js'
),
'shim' => array(
'exports' => 'Backbone',
'deps' => array(
'underscore',
'jquery'
),
),
),
),
);
$packages = array($backbone);
$expected = array(
'shim' => array(
'backbone' => array(
'exports' => 'Backbone',
'deps' => array(
'underscore',
'jquery'
),
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test multiple packages.
$packages = array($backbone, $jquery);
$expected = array(
'shim' => array(
'backbone' => array(
'exports' => 'Backbone',
'deps' => array(
'underscore',
'jquery'
),
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Package with a config definition.
$packageWithConfig = array(
'name' => 'components/packagewithconfig',
'type' => 'component',
'extra' => array(
'component' => array(
'config' => array(
'color' => 'blue',
),
),
),
);
$packages = array($packageWithConfig);
$expected = array(
'config' => array(
'packagewithconfig' => array(
'color' => 'blue',
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test building the JavaScript file.
$packageWithScripts = array(
'name' => 'components/foobar',
'type' => 'component',
'extra' => array(
'component' => array(
'scripts' => array(
'tests/ComponentInstaller/Test/Resources/test.js',
),
),
),
'is-root' => true,
);
$packages = array($packageWithScripts);
$expected = array(
'packages' => array(
array(
'name' => 'foobar',
'main' => 'foobar-built.js'
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test building JavaScript files with glob().
$packageWithScripts = array(
'name' => 'components/foobar2',
'extra' => array(
'component' => array(
'scripts' => array(
'tests/ComponentInstaller/Test/Resources/*.js',
),
),
),
'is-root' => true,
);
$packages = array($packageWithScripts);
$expected = array(
'packages' => array(
array(
'name' => 'foobar2',
'main' => 'foobar2-built.js'
),
),
'baseUrl' => 'components',
);
$tests[] = array($packages, array(), $expected);
// Test bringing in config options from the root package.
$package = array(
'name' => 'components/foobar3',
'extra' => array(
'component' => array(
'config' => array(
'color' => 'blue',
),
),
),
);
$packages = array($package);
$config = array(
'component' => array(
'waitSeconds' => 3,
'baseUrl' => 'public',
),
);
$expected = array(
'config' => array(
'foobar3' => array(
'color' => 'blue',
),
),
'baseUrl' => 'public',
'waitSeconds' => 3,
);
$tests[] = array($packages, $config, $expected);
// Test overriding component config from root packages.
$package = array(
'name' => 'components/foobar3',
'extra' => array(
'component' => array(
'config' => array(
'color' => 'blue',
),
),
),
);
$packages = array($package);
$config = array(
'component' => array(
'waitSeconds' => 3,
'baseUrl' => 'public',
'config' => array(
'foobar3' => array(
'color' => 'red',
),
),
),
);
$expected = array(
'config' => array(
'foobar3' => array(
'color' => 'red',
),
),
'baseUrl' => 'public',
'waitSeconds' => 3,
);
$tests[] = array($packages, $config, $expected);
return $tests;
}
}
================================================
FILE: tests/ComponentInstaller/Test/Resources/test.css
================================================
h1 {
color: red;
}
================================================
FILE: tests/ComponentInstaller/Test/Resources/test.js
================================================
/**
* This is a JavaScript test file.
*/
var foo = "bar";
================================================
FILE: tests/ComponentInstaller/Test/Resources/test2.css
================================================
h1 {
color: blue;
}
================================================
FILE: tests/ComponentInstaller/Test/Resources/test2.js
================================================
/**
* This is a JavaScript test2 file.
*/
var bar = "foo";
================================================
FILE: tests/ComponentInstaller/Test/Util/FilesystemTest.php
================================================
recursiveGlobFiles($pattern, $flags);
// Sort the arrays so that the indexes don't matter.
sort($expected);
sort($result);
$this->assertEquals($expected, $result);
}
public function providerRecursiveGlobFiles()
{
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test.js',
'tests/ComponentInstaller/Test/Resources/test2.css',
'tests/ComponentInstaller/Test/Resources/test2.js',
),
'tests/ComponentInstaller/Test/Resources/*',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test2.css',
),
'tests/ComponentInstaller/Test/Resources/*.css',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
),
'tests/ComponentInstaller/Test/Resources/*.jpg',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
),
'tests/ComponentInstaller/Test/Resources/*img*',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
),
'tests/ComponentInstaller/Test/Resources/img.jpg',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/img.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/img3.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/subdir2/img4.jpg',
),
'tests/ComponentInstaller/Test/Resources/**img*.jpg',
);
return $tests;
}
/**
* Tests the recursiveGlob function.
*
* @dataProvider providerRecursiveGlob
* @param array $expected
* @param string $pattern
* @param int $flags
*/
public function testRecursiveGlob($expected, $pattern, $flags = 0)
{
$fs = new Filesystem();
$result = $fs->recursiveGlob($pattern, $flags);
// Sort the arrays so that the indexes don't matter.
sort($expected);
sort($result);
$this->assertEquals($expected, $result);
}
public function providerRecursiveGlob()
{
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test.js',
'tests/ComponentInstaller/Test/Resources/test2.css',
'tests/ComponentInstaller/Test/Resources/test2.js',
'tests/ComponentInstaller/Test/Resources/subdir',
),
'tests/ComponentInstaller/Test/Resources/*',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/test.css',
'tests/ComponentInstaller/Test/Resources/test2.css',
),
'tests/ComponentInstaller/Test/Resources/*.css',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
'tests/ComponentInstaller/Test/Resources/img2.jpg',
),
'tests/ComponentInstaller/Test/Resources/*.jpg',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/img.jpg',
),
'tests/ComponentInstaller/Test/Resources/img.jpg',
);
$tests[] = array(
array(
'tests/ComponentInstaller/Test/Resources/subdir/img.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/img3.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/subdir2/img4.jpg',
'tests/ComponentInstaller/Test/Resources/subdir/subdir2',
),
'tests/ComponentInstaller/Test/Resources/subdir/**',
);
return $tests;
}
}
================================================
FILE: tests/bootstrap.php
================================================
add('ComponentInstaller\Test', __DIR__);
// Allow use of the Composer\Test namespace.
$path = $loader->findFile('Composer\\Composer');
$loader->add('Composer\Test', dirname(dirname(dirname($path))) . '/tests');