Skip to content

Adds sources information to the attachment media details of the REST response #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 16, 2022
Merged

Adds sources information to the attachment media details of the REST response #224

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c42adf4
Add a blank hook for the rest_prepare_attachment filter.
eugene-manuilov Mar 9, 2022
ed14544
Add sources information to the attachment response.
eugene-manuilov Mar 9, 2022
f1b8979
Fix formatting issues.
eugene-manuilov Mar 9, 2022
26dc80a
Add phpunit tests.
eugene-manuilov Mar 9, 2022
2b5683e
Apply suggestions from code review
eugene-manuilov Mar 10, 2022
8bc9a86
Update modules/images/webp-uploads/load.php
eugene-manuilov Mar 10, 2022
feb24fe
Merge remote-tracking branch 'origin/trunk' into feature/167-source-url
eugene-manuilov Mar 10, 2022
5e67d15
Fix formatting issues.
eugene-manuilov Mar 10, 2022
14cfdc1
Remove the unnecessary check.
eugene-manuilov Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge remote-tracking branch 'origin/trunk' into feature/167-source-url
  • Loading branch information
@eugene-manuilov
eugene-manuilov committed Mar 10, 2022
commit feb24fe2b87709b51ff515fff00e0ca9b1cd1122
104 changes: 104 additions & 0 deletions tests/modules/images/webp-uploads/webp-uploads-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,4 +662,108 @@ public function it_should_add_sources_to_rest_response() {
}
}
}

/**
* Return an error when creating an additional image source with invalid parameters
*
* @dataProvider data_provider_invalid_arguments_for_webp_uploads_generate_additional_image_source
*
* @test
*/
public function it_should_return_an_error_when_creating_an_additional_image_source_with_invalid_parameters( $attachment_id, $size_data, $mime, $destination_file = null ) {
$this->assertInstanceOf( WP_Error::class, webp_uploads_generate_additional_image_source( $attachment_id, $size_data, $mime, $destination_file ) );
}

public function data_provider_invalid_arguments_for_webp_uploads_generate_additional_image_source() {
yield 'when trying to use an attachment ID that does not exists' => array(
PHP_INT_MAX,
array(),
'image/webp',
);

add_filter( 'wp_image_editors', '__return_empty_array' );
yield 'when no editor is present' => array(
$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
array(),
'image/avif',
);

remove_filter( 'wp_image_editors', '__return_empty_array' );
yield 'when using a mime that is not supported' => array(
$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
array(),
'image/avif',
);

yield 'when no dimension is provided' => array(
$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
array(),
'image/webp',
);

yield 'when both dimensions are negative numbers' => array(
$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
array(
'width' => -10,
'height' => -20,
),
'image/webp',
);

yield 'when both dimensions are zero' => array(
$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
array(
'width' => 0,
'height' => 0,
),
'image/webp',
);
}

/**
* Create an image with the default suffix in the same location when no destination is specified
*
* @test
*/
public function it_should_create_an_image_with_the_default_suffix_in_the_same_location_when_no_destination_is_specified() {
$attachment_id = $this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' );
$size_data = array(
'width' => 300,
'height' => 300,
'crop' => true,
);

$result = webp_uploads_generate_additional_image_source( $attachment_id, $size_data, 'image/webp' );
$file = get_attached_file( $attachment_id );
$directory = trailingslashit( pathinfo( $file, PATHINFO_DIRNAME ) );
$name = pathinfo( $file, PATHINFO_FILENAME );

$this->assertIsArray( $result );
$this->assertArrayHasKey( 'filesize', $result );
$this->assertArrayHasKey( 'file', $result );
$this->assertStringEndsWith( '300x300.webp', $result['file'] );
$this->assertFileExists( "{$directory}{$name}-300x300.webp" );
}

/**
* Create a file in the specified location with the specified name
*
* @test
*/
public function it_should_create_a_file_in_the_specified_location_with_the_specified_name() {
$attachment_id = $this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' );
$size_data = array(
'width' => 300,
'height' => 300,
'crop' => true,
);

$result = webp_uploads_generate_additional_image_source( $attachment_id, $size_data, 'image/webp', '/tmp/image.jpg' );

$this->assertIsArray( $result );
$this->assertArrayHasKey( 'filesize', $result );
$this->assertArrayHasKey( 'file', $result );
$this->assertStringEndsWith( 'image.webp', $result['file'] );
$this->assertFileExists( '/tmp/image.webp' );
}
}
You are viewing a condensed version of this merge commit. You can view the full changes here.