« get me outta code hell

common.js « common - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/common/common.js
blob: 165e0f6d081fdab28625ea963e736d9ff31ed559 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// This file's shared 8y 8oth the client and the static file 8uilder (i.e,
// upd8.js). It's got common constants and a few utility functions!

const C = {
    // Code that's common 8etween the 8uild code (i.e. upd8.js) and gener8ted
    // site code should 8e put here. Which, uh, only really means this one
    // file. 8ut rather than hard code it, anything in this directory can 8e
    // shared across 8oth ends of the code8ase.
    // (This gets symlinked into the --data directory.)
    COMMON_DIRECTORY: 'common',

    // Code that's used only in the static site! CSS, cilent JS, etc.
    // (This gets symlinked into the --data directory.)
    STATIC_DIRECTORY: 'static',

    // Su8directory under DATA_DIRECTORY for al8um files.
    DATA_ALBUM_DIRECTORY: 'album',

    // Media files! This is symlinked into the --data directory from the
    // also user-provided --media directory.
    MEDIA_DIRECTORY: 'media',

    // Contains a folder for each al8um, within which is the al8um cover art
    // as well as any track art. Structure itself looks somethin' like this:
    // * album-art/<album.directory>/cover.jpg
    // * album-art/<album.directory>/<track1.directory>.jpg
    // * album-art/<album.directory>/<track2.directory>.jpg
    MEDIA_ALBUM_ART_DIRECTORY: 'album-art',

    // Just one folder, with a single image for each flash, matching its output
    // directory like al8um and track art. (Just keep in mind the directory of
    // a flash is just its page num8er most of the time.)
    MEDIA_FLASH_ART_DIRECTORY: 'flash-art',

    // Again, a single folder, with one image for each artist, matching their
    // output directory (which is usually their name in ke8a8-case). Although,
    // unlike other art directories, you don't to specify an image for *every*
    // artist - and present files will 8e automatically added!
    MEDIA_ARTIST_AVATAR_DIRECTORY: 'artist-avatar',

    // Miscellaneous stuff! This is pretty much only referenced in commentary
    // fields.
    MEDIA_MISC_DIRECOTRY: 'misc',

    // The folder you stick your random downloads in is called "Downloads",
    // yeah? (Unless you sort all your downloads into manual, organized
    // locations. Good for you.) It might just 8e me, 8ut I've always said "the
    // downloads folder." And yet here I say "the al8um directory!" It's like
    // we've gotten "Downloads" as a name so ingrained into our heads that we
    // use it like an adjective too, even though it doesn't make any
    // grammatical sense to do so. Anyway, also for contrast, note that this
    // folder is called "album" and not "albums". To 8e clear, that IS against
    // how I normally name folders - 8ut here, I'm doing it to match 8andcamp's
    // URL schema: "/album/genesis-frog" instead of "/albums/genesis-frog."
    // That seems to kind of 8e a standard for a lot of sites? 8ut only KIND OF.
    // Twitter has the weird schema of "/<user>/status/<id>" (not "statuses")...
    // 8ut it also has "/<user>/likes", so I really have no idea how people
    // decide to make their URL schemas consistent. Luckily I don't have to
    // worry a8out any of that, 8ecause I'm just stealing 8andcamp.
    //
    // Upd8 03/11/2020: Oh my god this was a pain to re-align (copying from
    // udp8.js over to shared.js).
    //
    // Upd8 03/10/2021 (wow, almost exactly a year later): This code comment
    // from literally the first day of wiki development is finally no longer
    // necessary! It was commenting constnats like "ALBUM_DIRECTORY" 8efore.
    // 8ut we don't have those constants anymore, 'cuz urlSpec in upd8.js
    // covers all that!

    UNRELEASED_TRACKS_DIRECTORY: 'unreleased-tracks',
    OFFICIAL_GROUP_DIRECTORY: 'official',
    FANDOM_GROUP_DIRECTORY: 'fandom',

    // This function was originally made to sort just al8um data, 8ut its exact
    // code works fine for sorting tracks too, so I made the varia8les and names
    // more general.
    sortByDate: data => {
        // Just to 8e clear: sort is a mutating function! I only return the array
        // 8ecause then you don't have to define it as a separate varia8le 8efore
        // passing it into this function.
        return data.sort((a, b) => a.date - b.date);
    },

    // Same details as the sortByDate, 8ut for covers~
    sortByArtDate: data => {
        return data.sort((a, b) => (a.coverArtDate || a.date) - (b.coverArtDate || b.date));
    },

    // This gets all the track o8jects defined in every al8um, and sorts them 8y
    // date released. Generally, albumData will pro8a8ly already 8e sorted 8efore
    // you pass it to this function, 8ut individual tracks can have their own
    // original release d8, distinct from the al8um's d8. I allowed that 8ecause
    // in Homestuck, the first four Vol.'s were com8ined into one al8um really
    // early in the history of the 8andcamp, and I still want to use that as the
    // al8um listing (not the original four al8um listings), 8ut if I only did
    // that, all the tracks would 8e sorted as though they were released at the
    // same time as the compilation al8um - i.e, after some other al8ums (including
    // Vol.'s 5 and 6!) were released. That would mess with chronological listings
    // including tracks from multiple al8ums, like artist pages. So, to fix that,
    // I gave tracks an Original Date field, defaulting to the release date of the
    // al8um if not specified. Pretty reasona8le, I think! Oh, and this feature can
    // 8e used for other projects too, like if you wanted to have an al8um listing
    // compiling a 8unch of songs with radically different & interspersed release
    // d8s, 8ut still keep the al8um listing in a specific order, since that isn't
    // sorted 8y date.
    getAllTracks: albumData => C.sortByDate(albumData.reduce((acc, album) => acc.concat(album.tracks), [])),

    getKebabCase: name => name.split(' ').join('-').replace(/&/g, 'and').replace(/[^a-zA-Z0-9\-]/g, '').replace(/-{2,}/g, '-').replace(/^-+|-+$/g, '').toLowerCase(),

    // Terri8le hack: since artists aren't really o8jects and don't have proper
    // "directories", we just reformat the artist's name.
    getArtistDirectory: artistName => C.getKebabCase(artistName),

    getArtistNumContributions: artist => (
        artist.tracks.asAny.length +
        artist.albums.asCoverArtist.length +
        (artist.flashes ? artist.flashes.asContributor.length : 0)
    ),

    getArtistCommentary: (artist, {justEverythingMan}) => justEverythingMan.filter(thing => thing.commentary && thing.commentary.replace(/<\/?b>/g, '').includes('<i>' + artist.name + ':</i>')),

    // Graciously stolen from https://stackoverflow.com/a/54071699! ::::)
    // in: r,g,b in [0,1], out: h in [0,360) and s,l in [0,1]
    rgb2hsl: (r,g,b) => {
        let a=Math.max(r,g,b), n=a-Math.min(r,g,b), f=(1-Math.abs(a+a-n-1));
        let h= n && ((a==r) ? (g-b)/n : ((a==g) ? 2+(b-r)/n : 4+(r-g)/n));
        return [60*(h<0?h+6:h), f ? n/f : 0, (a+a-n)/2];
    },

    getColors: primary => {
        const [ r, g, b ] = primary.slice(1)
            .match(/[0-9a-fA-F]{2,2}/g)
            .slice(0, 3)
            .map(val => parseInt(val, 16) / 255);
        const [ h, s, l ] = C.rgb2hsl(r, g, b);
        const dim = `hsl(${Math.round(h)}deg, ${Math.round(s * 50)}%, ${Math.round(l * 80)}%)`;

        return {primary, dim};
    }
};

if (typeof module === 'object') {
    module.exports = C;
} else if (typeof window === 'object') {
    window.C = C;
}