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.

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

Various social embed fixes #557

Merged
merged 7 commits into from
Sep 12, 2024
2 changes: 1 addition & 1 deletion src/content/dependencies/generateAlbumSocialEmbed.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default {

if (data.hasHeading) {
const firstGroup = album.groups[0];
data.headingGroupName = firstGroup.directory;
data.headingGroupName = firstGroup.name;
data.headingGroupDirectory = firstGroup.directory;
}

Expand Down
77 changes: 35 additions & 42 deletions src/content/dependencies/generateAlbumSocialEmbedDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,39 @@ import {accumulateSum} from '#sugar';
export default {
extraDependencies: ['language'],

data(album) {
const data = {};

const duration = accumulateSum(album.tracks, track => track.duration);

data.hasDuration = duration > 0;
data.hasTracks = album.tracks.length > 0;
data.hasDate = !!album.date;
data.hasAny = (data.hasDuration || data.hasTracks || data.hasDuration);

if (!data.hasAny)
return data;

if (data.hasDuration)
data.duration = duration;

if (data.hasTracks)
data.tracks = album.tracks.length;

if (data.hasDate)
data.date = album.date;

return data;
},

generate(data, {language}) {
return language.formatString(
'albumPage.socialEmbed.body' + [
data.hasDuration && '.withDuration',
data.hasTracks && '.withTracks',
data.hasDate && '.withReleaseDate',
].filter(Boolean).join(''),

Object.fromEntries([
data.hasDuration &&
['duration', language.formatDuration(data.duration)],
data.hasTracks &&
['tracks', language.countTracks(data.tracks, {unit: true})],
data.hasDate &&
['date', language.formatDate(data.date)],
].filter(Boolean)));
},
data: (album) => ({
duration:
accumulateSum(album.tracks, track => track.duration),

tracks:
album.tracks.length,

date:
album.date,
}),

generate: (data, {language}) =>
language.encapsulate('albumPage.socialEmbed.body', workingCapsule => {
const workingOptions = {};

if (data.duration > 0) {
workingCapsule += '.withDuration';
workingOptions.duration =
language.formatDuration(data.duration);
}

if (data.tracks > 0) {
workingCapsule += '.withTracks';
workingOptions.tracks =
language.countTracks(data.tracks, {unit: true});
}

if (data.date) {
workingCapsule += '.withReleaseDate';
workingOptions.date =
language.formatDate(data.date);
}

return language.$(workingCapsule, workingOptions);
}),
};
41 changes: 27 additions & 14 deletions src/content/dependencies/generatePageLayout.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,24 @@ export default {
'html',
'language',
'pagePath',
'pagePathStringFromRoot',
'to',
'wikiData',
],

sprawl({wikiInfo}) {
return {
enableSearch: wikiInfo.enableSearch,
footerContent: wikiInfo.footerContent,
wikiColor: wikiInfo.color,
wikiName: wikiInfo.nameShort,
};
},
sprawl: ({wikiInfo}) => ({
enableSearch: wikiInfo.enableSearch,
footerContent: wikiInfo.footerContent,
wikiColor: wikiInfo.color,
wikiName: wikiInfo.nameShort,
canonicalBase: wikiInfo.canonicalBase,
}),

data({wikiColor, wikiName}) {
return {
wikiColor,
wikiName,
};
},
data: (sprawl) => ({
wikiColor: sprawl.wikiColor,
wikiName: sprawl.wikiName,
canonicalBase: sprawl.canonicalBase,
}),

relations(relation, sprawl) {
const relations = {};
Expand Down Expand Up @@ -228,6 +227,7 @@ export default {
html,
language,
pagePath,
pagePathStringFromRoot,
to,
}) {
const colors = getColors(slots.color ?? data.wikiColor);
Expand All @@ -241,6 +241,13 @@ export default {
const mainContentHTML = html.tags([slots.mainContent]).toString();
const hasID = id => mainContentHTML.includes(`id="${id}"`);

const oEmbedJSONHref =
(hasSocialEmbed && data.canonicalBase
? data.canonicalBase +
pagePathStringFromRoot +
'oembed.json'
: null);

const titleContentsHTML =
(html.isBlank(slots.title)
? null
Expand Down Expand Up @@ -649,6 +656,12 @@ export default {
.clone()
.slot('mode', 'html'),

oEmbedJSONHref &&
html.tag('link', {
type: 'application/json+oembed',
href: oEmbedJSONHref,
}),

html.tag('link', {
rel: 'stylesheet',
href: to('staticCSS.path', 'site.css'),
Expand Down
10 changes: 6 additions & 4 deletions src/content/dependencies/generateSocialEmbed.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,12 @@ export default {
return JSON.stringify({
author_name:
(slots.headingContent
? language.$('misc.socialEmbed.heading', {
wikiName: data.shortWikiName,
heading: slots.headingContent,
})
? html.resolve(
language.$('misc.socialEmbed.heading', {
wikiName: data.shortWikiName,
heading: slots.headingContent,
}),
{normalize: 'string'})
: undefined),

author_url:
Expand Down
18 changes: 3 additions & 15 deletions src/content/dependencies/generateTrackSocialEmbed.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ export default {
track: data.trackName,
}),

description:
relations.description,

headingContent:
language.$(embedCapsule, 'heading', {
album: data.albumName,
Expand All @@ -69,18 +72,3 @@ export default {
: null),
})),
};

/*
socialEmbed: {
heading: language.$('trackPage.socialEmbed.heading', {
album: track.album.name,
}),
headingLink: absoluteTo('localized.album', album.directory),
title: language.$('trackPage.socialEmbed.title', {
track: track.name,
}),
description: getSocialEmbedDescription({getArtistString, language}),
image: '/' + getTrackCover(track, {to: urls.from('shared.root').to}),
color: track.color,
},
*/
73 changes: 37 additions & 36 deletions src/content/dependencies/generateTrackSocialEmbedDescription.js
Original file line number Diff line number Diff line change
@@ -1,38 +1,39 @@
import {empty} from '#sugar';

export default {
generate() {
},
};
extraDependencies: ['html', 'language'],

data: (track) => ({
artistNames:
track.artistContribs
.map(contrib => contrib.artist.name),

coverArtistNames:
track.coverArtistContribs
.map(contrib => contrib.artist.name),
}),

/*
const getSocialEmbedDescription = ({
getArtistString: _getArtistString,
language,
}) => {
const hasArtists = !empty(track.artistContribs);
const hasCoverArtists = !empty(track.coverArtistContribs);
const getArtistString = (contribs) =>
_getArtistString(contribs, {
// We don't want to put actual HTML tags in social embeds (sadly
// they don't get parsed and displayed, generally speaking), so
// override the link argument so that artist "links" just show
// their names.
link: {artist: (artist) => artist.name},
});
if (!hasArtists && !hasCoverArtists) return '';
return language.formatString(
'trackPage.socialEmbed.body' +
[hasArtists && '.withArtists', hasCoverArtists && '.withCoverArtists']
.filter(Boolean)
.join(''),
Object.fromEntries(
[
hasArtists && ['artists', getArtistString(track.artistContribs)],
hasCoverArtists && [
'coverArtists',
getArtistString(track.coverArtistContribs),
],
].filter(Boolean)
)
);
};
*/
generate: (data, {html, language}) =>
language.encapsulate('trackPage.socialEmbed.body', baseCapsule =>
language.encapsulate(baseCapsule, workingCapsule => {
const workingOptions = {};

if (!empty(data.artistNames)) {
workingCapsule += '.withArtists';
workingOptions.artists =
language.formatConjunctionList(data.artistNames);
}

if (!empty(data.coverArtistNames)) {
workingCapsule += '.withCoverArtists';
workingOptions.coverArtists =
language.formatConjunctionList(data.coverArtistNames);
}

if (workingCapsule === baseCapsule) {
return html.blank();
} else {
return language.$(workingCapsule, workingOptions);
}
})),
};
6 changes: 6 additions & 0 deletions src/data/things/wiki-info.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ export class WikiInfo extends Thing {
canonicalBase: {
flags: {update: true, expose: true},
update: {validate: isURL},
expose: {
transform: (value) =>
(value.endsWith('/')
? value
: value + '/'),
},
},

divideTrackListsByGroups: referenceList({
Expand Down
2 changes: 2 additions & 0 deletions src/write/bind-utilities.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export function bindUtilities({
languages,
missingImagePaths,
pagePath,
pagePathStringFromRoot,
thumbsCache,
to,
urls,
Expand All @@ -44,6 +45,7 @@ export function bindUtilities({
languages,
missingImagePaths,
pagePath,
pagePathStringFromRoot,
thumb,
to,
urls,
Expand Down
1 change: 1 addition & 0 deletions src/write/build-modes/live-dev-server.js
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ export async function go({
languages,
missingImagePaths,
pagePath: servePath,
pagePathStringFromRoot: pathname.replace(/^\//, ''),
thumbsCache,
to,
urls,
Expand Down
1 change: 1 addition & 0 deletions src/write/build-modes/static-build.js
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,7 @@ export async function go({
languages,
missingImagePaths,
pagePath,
pagePathStringFromRoot: pathname,
thumbsCache,
to,
urls,
Expand Down