Add support for full year display in isocalendar (lowlighter#10)

* fix(inst): base=0 flag combined with other base.part flags is now correctly handled

* ref(plugins): Space adjustements in plugins code

* feat(plugins/isocalendar): Add support for full year

* feat(repo): Update package.json

* fix(plugins/isocalendar): Isocalendar first row sometimes displayed 6 days instead of 7

Author: lowlighter

action.yml

@@ -194,6 +194,12 @@ inputs:
     description: Display an isometric view of your commits calendar, along with a few additional stats
     default: no
 
+  # Duration shown by isometric calendar plugin
+  # Supported values are "half-year" and "full-year"
+  plugin_isocalendar_duration:
+    description: Set isometric calendar duration
+    default: half-year
+
   # Gists plugins
   # Display gists metrics
   plugin_gists:

action/dist/index.js

@@ -110,6 +110,11 @@
             console.log(`Posts provider      | ${q["posts.provider"]}`)
             console.log(`Posts limit         | ${q["posts.limit"]}`)
           }
+        //Isocalendar
+          if (plugins.isocalendar.enabled) {
+            q["isocalendar.duration"] = core.getInput("plugin_isocalendar_duration") ?? "half-year"
+            console.log(`Isocalendar duration| ${q["isocalendar.duration"]}`)
+          }
 
       //Repositories to use
         const repositories = Number(core.getInput("repositories")) || 100

action/index.mjs

@@ -1,6 +1,6 @@
 {
   "name": "metrics",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Generate an user's GitHub metrics as SVG image format to embed somewhere else",
   "main": "index.mjs",
   "scripts": {
@@ -29,11 +29,11 @@
     "compression": "^1.7.4",
     "ejs": "^3.1.5",
     "express": "^4.17.1",
-    "express-rate-limit": "^5.1.3",
+    "express-rate-limit": "^5.2.3",
     "image-to-base64": "^2.1.1",
     "memory-cache": "^0.2.0",
     "prismjs": "^1.22.0",
-    "puppeteer": "^5.4.1",
+    "puppeteer": "^5.5.0",
     "svgo": "^1.3.2",
     "vue": "^2.6.12",
     "vue-prism-component": "^1.2.0"

package-lock.json

@@ -27,9 +27,9 @@
 
         //Base parts
           if (("base" in q)&&(!q.base))
-            conf.settings.plugins.base.parts.map(part => q[`base.${part}`] = false)
+            conf.settings.plugins.base.parts.map(part => !(`base.${part}` in q) ? q[`base.${part}`] = false : false)
           for (const part of conf.settings.plugins.base.parts)
-            data.base[part] = (`base.${part}` in q) ? !!q[`base.${part}`] : true
+            data.base[part] = !!q[`base.${part}`]
 
         //Placeholder
           if (login === "placeholder")

package.json

@@ -5,7 +5,6 @@
         //Check if plugin is enabled and requirements are met
           if ((!enabled)||(!q.gists))
             return null
-
         //Retrieve contribution calendar from graphql api
           const {user:{gists}} = await graphql(`
               query Gists {
@@ -27,7 +26,6 @@
               }
             `
           )
-
         //Iterate through gists
           let stargazers = 0, forks = 0, comments = 0
           for (const gist of gists.nodes) {
@@ -39,7 +37,6 @@
               forks += gist.forks.totalCount
               comments += gist.comments.totalCount
           }
-
         //Results
           return {totalCount:gists.totalCount, stargazers, forks, comments}
       }

src/metrics.mjs

@@ -5,11 +5,14 @@
         //Check if plugin is enabled and requirements are met
           if ((!enabled)||(!q.isocalendar))
             return null
-        //Compute start day (need to start on monday to ensure last row is complete)
-          const from = new Date(Date.now()-180*24*60*60*1000)
-          const day = from.getDay()||7
-          if (day !== 1)
-            from.setHours(-24*(day-1))
+        //Parameters override
+          let {"isocalendar.duration":duration = "half-year"} = q
+        //Duration in days
+          const leap = (new Date(new Date().getYear(), 1, 29).getDate() === 29)
+          const days = {"half-year":180, "full-year":365 + leap}[duration] ?? 180
+        //Compute start day (to ensure last row is complete, we'll retrieve one more week that we'll shift later)
+          const from = new Date(Date.now()-days*24*60*60*1000)
+          from.setHours(-24*7)
         //Retrieve contribution calendar from graphql api
           const {user:{calendar:{contributionCalendar:calendar}}} = await graphql(`
               query Calendar {
@@ -29,6 +32,7 @@
               }
             `
           )
+          calendar.weeks.shift()
         //Compute the highest contributions in a day, streaks and average commits per day
           let max = 0, streak = {max:0, current:0}, values = [], average = 0
           for (const week of calendar.weeks) {
@@ -44,7 +48,7 @@
           const size = 6
           let i = 0, j = 0
           let svg = `
-            <svg version="1.1" xmlns="http://www.w3.org/2000/svg" style="margin-top: -52px;" viewBox="0,0 480,170">
+            <svg version="1.1" xmlns="http://www.w3.org/2000/svg" style="margin-top: -52px;" viewBox="0,0 480,${duration === "full-year" ? 270 : 170}">
               ${[1, 2].map(k => `
                 <filter id="brightness${k}">
                   <feComponentTransfer>
@@ -73,7 +77,7 @@
             }
           svg += `</g></svg>`
         //Results
-          return {streak, max, average, svg}
+          return {streak, max, average, svg, duration}
       }
     //Handle errors
       catch (error) {

src/plugins/gists/index.mjs

@@ -23,14 +23,12 @@
         //Check if plugin is enabled and requirements are met
           if ((!enabled)||(!q.music))
             return null
-
         //Initialization
           const raw = {
             get provider() { return providers[provider]?.name ?? "" },
             get mode() { return modes[mode] ?? "Unconfigured music plugin"},
           }
           let tracks = null
-
         //Parameters override
           let {"music.provider":provider = "", "music.mode":mode = "", "music.playlist":playlist = null, "music.limit":limit = 4} = q
           //Auto-guess parameters
@@ -57,7 +55,6 @@
             }
           //Limit
             limit = Math.max(1, Math.min(100, Number(limit)))
-
         //Handle mode
           switch (mode) {
             //Playlist mode

src/plugins/isocalendar/index.mjs

@@ -5,13 +5,11 @@
         //Check if plugin is enabled and requirements are met
           if ((!enabled)||(!q.posts))
             return null
-
         //Parameters override
           const login = data.user.login
           let {"posts.source":source = "", "posts.limit":limit = 4} = q
           //Limit
             limit = Math.max(1, Math.min(30, Number(limit)))
-
         //Retrieve posts
           let posts = null
           switch (source) {