Add contributors plugin (#126)

source/plugins/contributors/README.md

@@ -0,0 +1,25 @@
+### 🏅 Contributors
+
+The *contributors* plugin lets you display repositories contributors from a commit range, that can be specified through either sha, tags, branch, etc.
+
+It's especially useful to acknowledge contributors on release notes.
+
+<table>
+  <td align="center">
+    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.svg">
+    <img width="900" height="1" alt="">
+  </td>
+</table>
+
+#### ℹ️ Examples workflows
+
+[➡️ Available options for this plugin](metadata.yml)
+
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    # ... other options
+    plugin_contributors: yes
+    plugin_contributors_base: ""     # Base reference (commit, tag, branch, etc.)
+    plugin_contributors_head: master # Head reference (commit, tag, branch, etc.)
+```

source/plugins/contributors/index.mjs

@@ -0,0 +1,69 @@
+//Setup
+  export default async function({login, q, imports, data, rest, graphql, queries, account}, {enabled = false} = {}) {
+    //Plugin execution
+      try {
+        //Check if plugin is enabled and requirements are met
+          if ((!enabled)||(!q.contributors))
+            return null
+
+        //Load inputs
+          let {head, base} = imports.metadata.plugins.contributors.inputs({data, account, q})
+          const repo = {owner:data.repo.owner.login, repo:data.repo.name}
+
+        //Retrieve head and base commits
+          console.debug(`metrics/compute/${login}/plugins > contributors > querying api head and base commits`)
+          const ref = {
+            head:(await graphql(queries.contributors.commit({...repo, expression:head}))).repository.object,
+            base:(await graphql(queries.contributors.commit({...repo, expression:base}))).repository.object,
+          }
+
+        //Get commit activity
+          console.debug(`metrics/compute/${login}/plugins > contributors > querying api for commits between [${ref.base?.abbreviatedOid ?? null}] and [${ref.head?.abbreviatedOid ?? null}]`)
+          const commits = []
+          for (let page = 0; ; page++) {
+            console.debug(`metrics/compute/${login}/plugins > contributors > loading page ${page}`)
+            try {
+              const {data:loaded} = await rest.repos.listCommits({...repo, per_page:100, page})
+              if (loaded.map(({sha}) => sha).includes(ref.base?.oid)) {
+                console.debug(`metrics/compute/${login}/plugins > contributors > reached ${ref.base?.oid}`)
+                commits.push(...loaded.slice(0, loaded.map(({sha}) => sha).indexOf(ref.base.oid)))
+                break
+              }
+              if (!loaded.length) {
+                console.debug(`metrics/compute/${login}/plugins > contributors > no more page to load`)
+                break
+              }
+              commits.push(...loaded)
+            }
+            catch (error) {
+              if (/Git Repository is empty/.test(error))
+                break
+              throw error
+            }
+          }
+
+        //Remove commits after head
+          const start = Math.max(0, commits.map(({sha}) => sha).indexOf(ref.head?.oid))
+          commits.splice(0, start)
+          console.debug(`metrics/compute/${login}/plugins > contributors > ${commits.length} commits loaded (${start} removed)`)
+
+        //Compute contributors and contributions
+          let contributors = {}
+          for (const {author:{login, avatar_url:avatar}} of commits) {
+            if (!login)
+              continue
+            if (!(login in contributors))
+              contributors[login] = {avatar:avatar ? await imports.imgb64(avatar) : "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOcOnfpfwAGfgLYttYINwAAAABJRU5ErkJggg==", contributions:0}
+            else
+              contributors[login].contributions++
+          }
+          contributors = Object.fromEntries(Object.entries(contributors).sort((a, b) => b.contributions - a.contributions))
+
+        //Results
+          return {head, base, ref, list:contributors}
+      }
+    //Handle errors
+      catch (error) {
+        throw {error:{message:"An error occured", instance:error}}
+      }
+  }

source/plugins/contributors/metadata.yml

@@ -0,0 +1,23 @@
+name: "🏅 Contributors"
+cost: N/A
+supports:
+  - repository
+inputs:
+
+  # Enable or disable plugin
+  plugin_contributors:
+    description: Display repository contributors
+    type: boolean
+    default: no
+
+  # Base reference (commit, tag, branch, etc.)
+  plugin_contributors_base:
+    description: Base reference
+    type: string
+    default: ""
+
+  # Head reference (commit, tag, branch, etc.)
+  plugin_contributors_head:
+    description: Head reference
+    type: string
+    default: master

source/plugins/contributors/queries/commit.graphql

@@ -0,0 +1,12 @@
+query ContributorsCommit {
+  repository(owner: "$owner" name: "$repo") {
+    object(expression: "$expression") {
+      ... on Commit {
+        oid
+        abbreviatedOid
+        messageHeadline
+        committedDate
+      }
+    }
+  }
+}

source/plugins/contributors/tests.yml

@@ -0,0 +1,13 @@
+- name: Contributors plugin (default)
+  uses: lowlighter/metrics@latest
+  with:
+    token: MOCKED_TOKEN
+    plugin_contributors: yes
+
+- name: Contributors plugin (default)
+  uses: lowlighter/metrics@latest
+  with:
+    token: MOCKED_TOKEN
+    plugin_contributors: yes
+    plugin_contributors_head: MOCKED_SHA
+    plugin_contributors_base: MOCKED_SHA