Skip to content
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

Mark Bookmark Methods as Deprecated (From Discussions #209) #210

Merged
merged 4 commits into from
Jan 2, 2025
Merged

Mark Bookmark Methods as Deprecated (From Discussions #209) #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b490c9a
refactor (bookmark): mark bookmark functions as deprecated
c0nst4ntin Jan 2, 2025
f7879c6
test (bookmark): test public api works without bookmarks in api response
c0nst4ntin Jan 2, 2025
0040d92
refactor (tests): ensure ci passes
c0nst4ntin Jan 2, 2025
263d801
refactor (bookmark): split doc block line to pass ci max length
c0nst4ntin Jan 2, 2025
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
6 changes: 6 additions & 0 deletions src/Prismic/Api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ public function getRefFromLabel(string $label) :? Ref
* Returns the list of all bookmarks on the repository. If you're looking
* for a document from it's bookmark name, you should use the bookmark() function.
*
* @deprecated 5.4.0 This method will no longer work after the 12 February 2025,
* as bookmarks are removed from the API.
*
* @return array the array of bookmarks
*/
public function bookmarks() : array
Expand All @@ -165,6 +168,9 @@ public function bookmarks() : array
* Most starter projects embed a helper to query a document from their ID string,
* which makes this even easier.
*
* @deprecated 5.4.0 This method will no longer work after the 12 February 2025,
* as bookmarks are removed from the API.
*
* @param string $name the bookmark name to use
*
* @return string|null the ID string for a given bookmark name
Expand Down
10 changes: 8 additions & 2 deletions src/Prismic/ApiData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ class ApiData

/**
* An array of the available bookmarks
*
* @deprecated 5.4.0
*
* @var array
*/
private $bookmarks;
Expand Down Expand Up @@ -66,7 +69,7 @@ class ApiData
* A constructor to build the object when you've retrieved all the data you need.
*
* @param array $refs
* @param array $bookmarks
* @param array $bookmarks (deprecated since 5.4.0)
* @param array $types
* @param array $languages
* @param array $tags
Expand Down Expand Up @@ -131,7 +134,7 @@ function ($ref) {
},
$json->refs
),
(array)$json->bookmarks,
isset($json->bookmarks) ? (array)$json->bookmarks : [],
(array)$json->types,
array_map(
function ($language) {
Expand All @@ -158,6 +161,9 @@ public function getRefs() : array

/**
* Get the bookmarks
*
* @deprecated 5.4.0 This method will no longer work after the 12 February 2025,
* as bookmarks are removed from the API.
*/
public function getBookmarks() : array
{
Expand Down
9 changes: 9 additions & 0 deletions tests/Prismic/ApiDataTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ public function testWithJsonStringThrowsExceptionForInvalidJson()
ApiData::withJsonString('wtf?');
}

public function testApiDataWorksWithoutBookmarks()
{
$json = $this->getJsonFixture('data-without-bookmarks.json');
$data = ApiData::withJsonString($json);

$this->assertInstanceOf(ApiData::class, $data);
$this->assertEquals([], $data->getBookmarks());
}

public function testApiDataHasExpectedValues()
{
$this->assertCount(3, $this->data->getRefs());
Expand Down
20 changes: 20 additions & 0 deletions tests/Prismic/ApiTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,26 @@ public function testBookmarkReturnsCorrectDocumentId()
$this->assertNull($api->bookmark('unknown-bookmark'));
}

public function testApiWorksWithoutBookmarks()
{
// Create an ApiData object without bookmarks
$data = $this->getJsonFixture('data-without-bookmarks.json');
$apiData = ApiData::withJsonString($data);

// Cache the data
$key = 'https://whatever.prismic.io/api/v2#My-Access-Token';
$cachedData = serialize($apiData);
$this->cache->get($key)->willReturn($cachedData);
$this->httpClient->request()->shouldNotBeCalled();

$api = $this->getApi();

// Test that the bookmarks are empty
$this->assertEmpty($api->bookmarks());
$this->assertNull($api->bookmark('about'));
$this->assertNull($api->bookmark('unknown-bookmark'));
}

public function testFormsReturnsOnlyFormInstances()
{
$api = $this->getApiWithDefaultData();
Expand Down
165 changes: 165 additions & 0 deletions tests/fixtures/data-without-bookmarks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
{
"refs": [
{
"id": "master",
"ref": "UgjWQN_mqa8HvPJY",
"label": "Master",
"isMasterRef": true
},
{
"id": "UkL0hcuvzYUANCrr",
"ref": "UgjWRd_mqbYHvPJa",
"label": "San Francisco Grand opening"
},
{
"id": "SaGrandOpening2ndRef",
"ref": "SaGrandOpening2ndRef",
"label": "San Francisco Grand opening"
}
],
"types": {
"blog-post": "Blog post",
"store": "Store",
"article": "Site-level article",
"selection": "Products selection",
"job-offer": "Job offer",
"product": "Product"
},
"languages": [
{
"id": "en-us",
"name": "English - United States"
},
{
"id": "nl-nl",
"name": "Dutch - Netherlands"
},
{
"id": "es-es",
"name": "Spanish - Spain (Traditional)"
},
{
"id": "fr-fr",
"name": "French - France"
}
],
"tags": ["Cupcake", "Pie", "Featured", "Macaron"],
"forms": {
"everything": {
"method": "GET",
"enctype": "application/x-www-form-urlencoded",
"action": "http://lesbonneschoses.prismic.io/api/v2/documents/search",
"fields": {
"ref": {
"type": "String"
},
"q": {
"type": "String"
}
}
},
"blogs": {
"name": "Blog Posts",
"method": "GET",
"rel": "collection",
"enctype": "application/x-www-form-urlencoded",
"action": "https://lesbonneschoses.prismic.io/api/v2/documents/search",
"fields": {
"ref": {
"type": "String",
"multiple": false
},
"q": {
"default": "[[:d = any(document.type, [\"blog-post\"])]]",
"type": "String",
"multiple": true
},
"lang": {
"type": "String",
"multiple": false
},
"page": {
"type": "Integer",
"multiple": false,
"default": "1"
},
"pageSize": {
"type": "Integer",
"multiple": false,
"default": "20"
},
"after": {
"type": "String",
"multiple": false
},
"fetch": {
"type": "String",
"multiple": false
},
"fetchLinks": {
"type": "String",
"multiple": false
},
"graphQuery": {
"type": "String",
"multiple": false
},
"orderings": {
"type": "String",
"multiple": false
},
"referer": {
"type": "String",
"multiple": false
},
"access_token": {
"default": "a-permanent-access-token",
"type": "String",
"multiple": false
}
}
}
},
"oauth_initiate": "http://lesbonneschoses.prismic.io/auth",
"oauth_token": "http://lesbonneschoses.prismic.io/auth/token",
"experiments" : {
"draft": [
{
"id": "xxxxxxxxxxoGelsX",
"name": "Exp 2",
"variations": [
{
"id": "VDUBBawGAKoGelsZ",
"label": "Base",
"ref": "VDUBBawGALAGelsa"
},
{
"id": "VDUE-awGALAGemME",
"label": "var 1",
"ref": "VDUUmHIKAZQKk9uq"
}
]
}
],
"running": [
{
"googleId": "_UQtin7EQAOH5M34RQq6Dg",
"id": "VDUBBawGAKoGelsX",
"name": "Exp 1",
"variations": [
{
"id": "VDUBBawGAKoGelsZ",
"label": "Base",
"ref": "VDUBBawGALAGelsa"
},
{
"id": "VDUE-awGALAGemME",
"label": "var 1",
"ref": "VDUUmHIKAZQKk9uq"
}
]
}
]
}

}
Loading