Add new plugin stars (lowlighter#36)

Author: lowlighter

README.md

@@ -147,16 +147,20 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
     </td>
   </tr>
   <tr>
+    <th><a href="https://github.com/lowlighter/metrics#-stars">🌟 Recently starred repositories</a></th>
     <th><a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">🗃️ Header special features</a></th>
-    <th></th>
   </tr>
   <tr>
+    <td>
+      <a href="https://github.com/lowlighter/metrics#-stars">
+        <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg" alt="" width="400">
+      </a>
+    </td>
     <td>
       <a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">
         <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.header.svg" alt="" width="400">
       </a>
     </td>
-    <td></td>
   </tr>
   <tr>
     <td colspan="2" align="center">
@@ -511,6 +515,7 @@ Used template defaults to the `classic` one.
     <th><span title="Posts">✒️</span></th>
     <th><span title="Habits">💡</span></th>
     <th><span title="Gists">🎫</span></th>
+    <th><span title="Stars">🌟</span></th>
   </tr>
   <tr>
     <th>Classic</th>
@@ -528,6 +533,7 @@ Used template defaults to the `classic` one.
     <td>✔️</td>
     <td>✔️</td>
     <td>✔️</td>
+    <td><span title="Available on master">✔️<sup>M</sup></span></td>
   </tr>
   <tr>
     <th>Terminal</th>
@@ -545,6 +551,7 @@ Used template defaults to the `classic` one.
     <td>❌</td>
     <td>❌</td>
     <td>✔️</td>
+    <td>❌</td>
   </tr>
   <tr>
     <th>Repository<sup>R</sup></th>
@@ -562,6 +569,7 @@ Used template defaults to the `classic` one.
     <td>❌</td>
     <td>❌</td>
     <td>❌</td>
+    <td>❌</td>
   </tr>
 </table>
 
@@ -1249,6 +1257,30 @@ Add the following to your workflow :
 
 </details>
 
+### 🌟 Stars
+
+    🚧 This feature is available on @master
+
+The *stars* plugin displays your recently starred repositories.
+
+![Stars plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg)
+
+<details>
+<summary>💬 About</summary>
+
+It will consume an additional GitHub request.
+
+Add the following to your workflow :
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    # ... other options
+    plugin_stars: yes
+    plugin_stars_limit: 4
+```
+
+</details>
+
 ### 🔧 Other options
 
 A few additional options are available.

action.yml

@@ -347,6 +347,16 @@ inputs:
     description: Number of tweets to display
     default: 2
 
+  # Display recently starred repositories
+  plugin_stars:
+    description: Display recently starred repositories
+    default: no
+
+  # Number of recently starred repositories to display
+  plugin_stars_limit:
+    description: Number of recently starred repositories to display
+    default: 4
+
   # ====================================================================================
   # Options below are mostly used for testing
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "metrics",
-  "version": "3.0.0",
+  "version": "3.1.0-beta",
   "description": "An image generator with 20+ metrics about your GitHub account such as activity, community, repositories, coding habits, website performances, music played, starred topics, etc. that you can put on your profile or elsewhere !",
   "main": "index.mjs",
   "scripts": {

settings.example.json

@@ -56,8 +56,11 @@
       "enabled":false,            "//":"Enable or disable personal projects display"
     },
     "tweets":{                    "//":"Tweets plugin",
-      "enabled":false,             "//":"Enable or disable recent tweets display",
+      "enabled":false,            "//":"Enable or disable recent tweets display",
       "token":null,               "//":"Twitter token (required when enabled)"
+    },
+    "stars":{                     "//":"Stars plugin",
+      "enabled":true,             "//":"Enable or disable recently starred repositories display"
     }
   }
 }

source/app/action/index.mjs

@@ -139,6 +139,7 @@
           topics:{enabled:input.bool("plugin_topics")},
           projects:{enabled:input.bool("plugin_projects")},
           tweets:{enabled:input.bool("plugin_tweets")},
+          stars:{enabled:input.bool("plugin_stars")},
         }
         let q = Object.fromEntries(Object.entries(plugins).filter(([key, plugin]) => plugin.enabled).map(([key]) => [key, true]))
         info("Plugins enabled", Object.entries(plugins).filter(([key, plugin]) => plugin.enabled).map(([key]) => key))
@@ -208,6 +209,11 @@
             for (const option of ["limit"])
               info(`Tweets ${option}`, q[`tweets.${option}`] = input.number(`plugin_tweets_${option}`))
           }
+        //Stars
+          if (plugins.posts.enabled) {
+            for (const option of ["limit"])
+              info(`Stars ${option}`, q[`stars.${option}`] = input.number(`plugin_stars_${option}`))
+          }
 
       //Repositories to use
         const repositories = input.number("repositories")

source/app/mocks.mjs

@@ -259,6 +259,43 @@
                   }
                 })
               }
+            //Starred repositories query
+              if (/^query Starred /.test(query)) {
+                console.debug(`metrics/compute/mocks > mocking graphql api result > Starred`)
+                return ({
+                  user:{
+                    starredRepositories:{
+                      edges:[
+                        {
+                          starredAt:"2020-10-16T18:53:16Z",
+                          node:{
+                            description:"📊 An image generator with 20+ metrics about your GitHub account such as activity, community, repositories, coding habits, website performances, music played, starred topics, etc. that you can put on your profile or elsewhere !",
+                            forkCount:12,
+                            isFork:false,
+                            issues:{
+                              totalCount: 12
+                            },
+                            nameWithOwner:"lowlighter/metrics",
+                            openGraphImageUrl:"https://repository-images.githubusercontent.com/293860197/7fd72080-496d-11eb-8fe0-238b38a0746a",
+                            pullRequests:{
+                              totalCount:23
+                            },
+                            stargazerCount:120,
+                            licenseInfo:{
+                              nickname:null,
+                              name:"MIT License"
+                            },
+                            primaryLanguage:{
+                              color:"#f1e05a",
+                              name:"JavaScript"
+                            }
+                          }
+                        },
+                      ]
+                    }
+                  }
+                })
+              }
             //Unmocked call
               return target(...args)
           }

source/app/web/statics/app.js

@@ -45,6 +45,7 @@
               topics:"Starred topics",
               projects:"Projects",
               tweets:"Latest tweets",
+              stars:"Recently starred repositories",
               "base.header":"Header",
               "base.activity":"Account activity",
               "base.community":"Community stats",
@@ -71,6 +72,7 @@
               "topics.sort":"stars",
               "topics.limit":12,
               "tweets.limit":2,
+              "stars.limit":4,
             },
           },
           templates:{

source/plugins/stars/index.mjs

@@ -0,0 +1,36 @@
+//Setup
+  export default async function ({login, graphql, q, queries, imports}, {enabled = false} = {}) {
+    //Plugin execution
+      try {
+        //Check if plugin is enabled and requirements are met
+          if ((!enabled)||(!q.stars))
+            return null
+        //Parameters override
+          let {"stars.limit":limit = 4} = q
+          //Limit
+            limit = Math.max(1, Math.min(100, Number(limit)))
+        //Retrieve user stars from graphql api
+          console.debug(`metrics/compute/${login}/plugins > stars > querying api`)
+          const {user:{starredRepositories:{edges:repositories}}} = await graphql(queries.starred({login, limit}))
+        //Format starred repositories
+          for (const edge of repositories) {
+            //Formats values
+              edge.node.stargazers = imports.format(edge.node.stargazerCount)
+              edge.node.forks = imports.format(edge.node.forkCount)
+            //Format date
+              const time = (Date.now()-new Date(edge.starredAt).getTime())/(24*60*60*1000)
+              let updated = new Date(edge.starredAt).toDateString().substring(4)
+              if (time < 1)
+                updated = `${Math.ceil(time*24)} hour${Math.ceil(time*24) >= 2 ? "s" : ""} ago`
+              else if (time < 30)
+                updated = `${Math.floor(time)} day${time >= 2 ? "s" : ""} ago`
+              edge.starred = updated
+          }
+        //Results
+          return {repositories}
+      }
+    //Handle errors
+      catch (error) {
+        throw {error:{message:"An error occured", instance:error}}
+      }
+  }

source/queries/starred.graphql

@@ -0,0 +1,31 @@
+query Starred {
+  user(login: "$login") {
+    starredRepositories(first: $limit, orderBy: {field: STARRED_AT, direction: DESC}) {
+      edges {
+        starredAt
+        node {
+          description
+          forkCount
+          isFork
+          issues {
+            totalCount
+          }
+          nameWithOwner
+          openGraphImageUrl
+          licenseInfo {
+            nickname
+            name
+          }
+          pullRequests {
+            totalCount
+          }
+          stargazerCount
+          primaryLanguage {
+            color
+            name
+          }
+        }
+      }
+    }
+  }
+}