Skip to content

Commit

Permalink
Migrating tests into new namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
@srtfisher
srtfisher committed Jan 9, 2024
1 parent ae699fe commit 06d3d75
Show file tree
Hide file tree
Showing 11 changed files with 395 additions and 345 deletions.
272 changes: 49 additions & 223 deletions asset-manager.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,243 +12,69 @@
Plugin URI: https://github.com/alleyinteractive/wp-asset-manager
Description: Add more robust functionality to enqueuing static assets
Author: Alley Interactive
Version: 1.3.6
Version: 1.4.0
License: GPLv2 or later
Author URI: https://www.alleyinteractive.com/
*/

namespace Alley\WP\Asset_Manager;

/**
* Filesystem path to AssetManager.
*/
defined( 'AM_BASE_DIR' ) || define( 'AM_BASE_DIR', __DIR__ );

if ( ! function_exists( 'am_validate_path' ) ) {
/**
* Helper function to validate a path before doing something with it.
*
* @param string $path The path to validate.
*
* @return bool True if the path is valid, false otherwise.
*/
function am_validate_path( string $path ): bool {
return in_array( validate_file( $path ), [ 0, 2 ], true ) && file_exists( $path );
}
}

// Setup the aliases to the legacy Asset Manager classes.
class_alias( 'Asset_Manager_Scripts', Scripts::class );
class_alias( 'Asset_Manager_Styles', Styles::class );
class_alias( 'Asset_Manager_Preload', Preload::class );
class_alias( 'Asset_Manager_SVG_Sprite', SVG_Sprite::class );

if ( ! function_exists( 'am_enqueue_script' ) ) :

/**
* Load an external script. Options can be passed in as an array or individual parameters.
*
* @param string $handle Handle for script.
* @param string $src URI to script.
* @param array $deps This script's dependencies.
* @param string $condition Corresponds to a configured loading condition that, if matches,
* will allow the script to load.
* 'global' is assumed if no condition is declared.
* @param string $load_method How to load this asset.
* @param string $version Version of the script.
* @param string $load_hook Hook on which to load this asset.
*/
function am_enqueue_script( $handle, $src = false, $deps = [], $condition = 'global', $load_method = 'sync', $version = '1.0.0', $load_hook = 'wp_head' ) {
$defaults = compact( 'handle', 'src', 'deps', 'condition', 'load_method', 'version', 'load_hook' );
$args = is_array( $handle ) ? array_merge( $defaults, $handle ) : $defaults;
Asset_Manager_Scripts::instance()->add_asset( $args );
}

endif;

if ( ! function_exists( 'am_modify_load_method' ) ) :

/**
* Modify the load method of an already-enqueued script
*
* @param string $handle Handle for script.
* @param string $load_method How to load this asset.
*/
function am_modify_load_method( $handle, $load_method = 'sync' ) {
Asset_Manager_Scripts::instance()->modify_load_method( $handle, $load_method );
}

endif;

add_action( 'after_setup_theme', [ 'Asset_Manager_Scripts', 'instance' ], 10 );

if ( ! function_exists( 'am_enqueue_style' ) ) :

/**
* Load an external stylesheet. Options can be passed in as an array or individual parameters.
*
* @param string $handle Handle for stylesheet. This is necessary for dependency management.
* @param string $src URI to stylesheet.
* @param array $deps List of dependencies.
* @param string $condition Corresponds to a configured loading condition that, if matches,
* will allow the stylesheet to load.
* 'global' is assumed if no condition is declared.
* @param string $load_method How to load this asset.
* @param string $version Version of the script.
* @param string $load_hook Hook on which to load this asset.
* @param string $media Media query to restrict when this asset is loaded.
*/
function am_enqueue_style( $handle, $src = false, $deps = [], $condition = 'global', $load_method = 'sync', $version = '1.0.0', $load_hook = 'wp_head', $media = false ) {
$defaults = compact( 'handle', 'src', 'deps', 'condition', 'load_method', 'version', 'load_hook', 'media' );
$args = is_array( $handle ) ? array_merge( $defaults, $handle ) : $defaults;

/**
* Using am_enqueue_style with `load_method => preload` is no longer supported.
* This patches in a call to am_preload and updates the enqueued style's
* load_method to 'sync', which replicates the deprecated behavior.
*/
if ( 'preload' === $args['load_method'] ) {
Asset_Manager_Preload::instance()->add_asset( $args );
$args['load_method'] = 'sync';
// Load the Composer autoloader.
if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
require_once __DIR__ . '/vendor/autoload.php';
} else {
add_action(
'admin_notices',
function() {
?>
<div class="notice notice-error">
<p>
<?php
esc_html_e(
'Asset Manager is not installed. Please run `composer install` from the plugin directory.',
'asset-manager'
);
?>
</p>
</div>
<?php
}
);

Asset_Manager_Styles::instance()->add_asset( $args );
}

endif;

add_action( 'after_setup_theme', [ 'Asset_Manager_Styles', 'instance' ], 10 );

if ( ! function_exists( 'am_preload' ) ) :

/**
* Provide an asset with a `preload` resource hint for the browser to prioritize.
*
* @param string $handle Handle for asset. This is necessary for dependency management.
* @param string $src URI to asset.
* @param string $condition Corresponds to a configured loading condition that, if matches,
* will allow the asset to load.
* 'global' is assumed if no condition is declared.
* @param string $version Version of the asset.
* @param string $media Media query to restrict when this asset is loaded.
* @param string $as A hint to the browser about what type of asset this is.
* See $preload_as for valid options.
* @param boolean $crossorigin Preload this asset cross-origin.
* @param string $mime_type The MIME type for the preloaded asset.
*/
function am_preload( $handle, $src = false, $condition = 'global', $version = '1.0.0', $media = 'all', $as = false, $crossorigin = false, $mime_type = false ) {
$defaults = compact( 'handle', 'src', 'condition', 'version', 'media', 'as', 'crossorigin', 'mime_type' );
$args = is_array( $handle ) ? array_merge( $defaults, $handle ) : $defaults;
Asset_Manager_Preload::instance()->add_asset( $args );
}

endif;

add_action( 'after_setup_theme', [ 'Asset_Manager_Preload', 'instance' ], 10 );

if ( ! function_exists( 'am_register_symbol' ) ) :

/**
* Define a symbol to be added to the SVG sprite.
*
* @param string $handle Handle for asset, used to refer to the symbol in `am_use_symbol`.
* @param string $src Absolute path from the current theme root, or a relative path
* based on the current theme root. Use the `am_modify_svg_directory`
* filter to update the directory from which relative paths will be
* completed.
* @param string $condition Corresponds to a configured loading condition that, if matches,
* will allow the asset to be added to the sprite sheet.
* 'global' is assumed if no condition is declared.
* @param array $attributes An array of attribute names and values to add to the resulting <svg>
* everywhere it is printed.
*/
function am_register_symbol( $handle, $src = false, $condition = 'global', $attributes = [] ) {
$defaults = compact( 'handle', 'src', 'condition', 'attributes' );
$args = is_array( $handle ) ? array_merge( $defaults, $handle ) : $defaults;
Asset_Manager_SVG_Sprite::instance()->add_asset( $args );
}

endif;

if ( ! function_exists( 'am_deregister_symbol' ) ) :

/**
* Remove a previously-registered symbol.
*
* @param string $handle Handle for the asset to be removed.
*/
function am_deregister_symbol( $handle = '' ) {
return Asset_Manager_SVG_Sprite::instance()->remove_symbol( $handle );
}

endif;

if ( ! function_exists( 'am_get_symbol' ) ) :

/**
* Returns the SVG with `<use>` element referencing the symbol.
*
* @param string $handle The symbol name.
* @param array $attrs The attributes to add to the SVG element.
*/
function am_get_symbol( $handle, $attrs = [] ) {
return Asset_Manager_SVG_Sprite::instance()->get_symbol( $handle, $attrs );
}

endif;

if ( ! function_exists( 'am_use_symbol' ) ) :

/**
* Prints the SVG with `<use>` element referencing the symbol.
*
* @param string $handle The symbol name.
* @param array $attrs The attributes to add to the SVG element.
*/
function am_use_symbol( $handle, $attrs = [] ) {
Asset_Manager_SVG_Sprite::instance()->use_symbol( $handle, $attrs );
}

endif;

if ( ! function_exists( 'am_symbol_is_registered' ) ) :

/**
* Returns true if a symbol is registered.
*
* @param string $handle The registered SVG asset handle.
* @return bool Whether the symbol is registered.
*/
function am_symbol_is_registered( $handle ) {
if ( empty( $handle ) ) {
return false;
}

return in_array( $handle, Asset_Manager_SVG_Sprite::instance()->asset_handles, true );
}

endif;

add_action( 'after_setup_theme', [ 'Asset_Manager_SVG_Sprite', 'instance' ], 10 );
return;
}

if ( ! function_exists( 'am_map_meta_caps' ) ) :
// Setup the aliases to the legacy Asset Manager classes (pre-1.4.0).
class_alias( \Alley\WP\Asset_Manager\Scripts::class, 'Asset_Manager_Scripts' );
class_alias( \Alley\WP\Asset_Manager\Styles::class, 'Asset_Manager_Styles' );
class_alias( \Alley\WP\Asset_Manager\Preload::class, 'Asset_Manager_Preload' );
class_alias( \Alley\WP\Asset_Manager\SVG_Sprite::class, 'Asset_Manager_SVG_Sprite' );

/**
* Map plugin meta capabilities.
*
* @param string[] $caps Primitive capabilities required of the user.
* @param string $cap Capability being checked.
* @return string[] Updated primitive capabilities.
*/
function am_map_meta_caps( $caps, $cap ) {
// By default, require the 'manage_options' capability to view asset errors.
if ( 'am_view_asset_error' === $cap ) {
$caps = [ 'manage_options' ];
}
// Require the helpers that are used to interact with the plugin.
require_once __DIR__ . '/inc/helpers.php';

return $caps;
/**
* Map plugin meta capabilities.
*
* @param string[] $caps Primitive capabilities required of the user.
* @param string $cap Capability being checked.
* @return string[] Updated primitive capabilities.
*/
function am_map_meta_caps( $caps, $cap ) {
// By default, require the 'manage_options' capability to view asset errors.
if ( 'am_view_asset_error' === $cap ) {
$caps = [ 'manage_options' ];
}

endif;

return $caps;
}
add_filter( 'map_meta_cap', 'am_map_meta_caps', 10, 2 );

// Setup the plugin's main classes after the theme has been setup.
add_action( 'after_setup_theme', [ \Alley\WP\Asset_Manager\Preload::class, 'instance' ], 10 );
add_action( 'after_setup_theme', [ \Alley\WP\Asset_Manager\Scripts::class, 'instance' ], 10 );
add_action( 'after_setup_theme', [ \Alley\WP\Asset_Manager\Styles::class, 'instance' ], 10 );
add_action( 'after_setup_theme', [ \Alley\WP\Asset_Manager\SVG_Sprite::class, 'instance' ], 10 );
4 changes: 2 additions & 2 deletions composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
"extra": {
"wordpress-autoloader": {
"autoload": {
"Asset_Manager\\": "inc/"
"Alley\\WP\\Asset_Manager\\": "inc/"
},
"autoload-dev": {
"Asset_Manager_Tests\\": "tests/"
"Alley\\WP\\Asset_Manager\\Tests\\": "tests/"
}
}
},
Expand Down
3 changes: 3 additions & 0 deletions inc/class-svg-sprite.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

namespace Alley\WP\Asset_Manager;

use DOMDocument;


/**
* Asset_Manager_SVG_Sprite class.
*/
Expand Down
2 changes: 2 additions & 0 deletions inc/concerns/trait-asset-error.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

namespace Alley\WP\Asset_Manager\Concerns;

use WP_Error;

/**
* Trait for generating and formatting asset errors.
*/
Expand Down
Loading

0 comments on commit 06d3d75

Please sign in to comment.