[#2170] Add Blurbs for Repos

build.gradle

@@ -38,6 +38,8 @@ dependencies {
     implementation  group: 'org.apache.ant', name: 'ant', version: '1.10.12'
     implementation  group: 'org.apache.commons', name: 'commons-csv', version: '1.9.0'
     implementation  group: 'org.fusesource.jansi', name: 'jansi', version: '2.4.0'
+    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.17.0'
+    implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.17.0'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion

config/blurbs.md

@@ -0,0 +1,2 @@
+https://github.com/reposense/testrepo-Alpha/tree/master
+Master branch of testrepo-Alpha

frontend/cypress/config/blurbs.md

@@ -0,0 +1,5 @@
+https://github.com/reposense/RepoSense/tree/cypress
+first blurb
+<!--repo-->------------------------------------
+https://gitlab.com/reposense/testrepo-gitlab/-/tree/main
+unseen blurb

frontend/cypress/tests/chartView/chartView_blurbs.cy.js

@@ -0,0 +1,12 @@
+describe('blurbs', () => {
+  it('shows blurbs', () => {
+    cy.get('.markdown.blurb')
+      .first()
+      .should('contain', 'first blurb');
+  });
+
+  it('has the correct number of valid blurbs', () => {
+    cy.get('.markdown.blurb')
+      .should('have.length', 1);
+  });
+});

frontend/src/app.vue

@@ -122,6 +122,7 @@ const app = defineComponent({
           reportGenerationTime,
           errorMessages,
           names,
+          blurbMap,
         } = summary;
         this.creationDate = creationDate;
         this.reportGenerationTime = reportGenerationTime;
@@ -134,6 +135,7 @@ const app = defineComponent({
         this.getUsers();
         this.renderTabHash();
         this.userUpdated = true;
+        this.$store.commit('setBlurbMap', blurbMap);
       } catch (error) {
         window.alert(error);
       } finally {

frontend/src/components/c-markdown-chunk.vue

@@ -0,0 +1,30 @@
+<template lang="pug">
+.markdown(v-html="parsedHtml", v-if="markdownText != ''")
+</template>
+
+<script lang="ts">
+import { defineComponent } from 'vue';
+import MarkdownIt from 'markdown-it';
+
+export default defineComponent({
+  props: {
+    markdownText: {
+      type: String,
+      required: true,
+    },
+  },
+  computed: {
+    parsedHtml() {
+      const md = new MarkdownIt({ html: true });
+      return md.render(this.markdownText);
+    },
+  },
+});
+</script>
+
+<style lang="scss" scoped>
+.markdown {
+  overflow-x: auto;
+  padding: 0 1.5rem;
+}
+</style>

frontend/src/components/c-summary-charts.vue

@@ -141,9 +141,8 @@
         )
           font-awesome-icon.icon-button(icon="clipboard")
           span.tooltip-text(v-bind:ref="`summary-charts-${i}-copy-iframe`") Click to copy iframe link for group
-
       .tooltip.summary-chart__title--percentile(
-          v-if="sortGroupSelection.includes('totalCommits')"
+        v-if="sortGroupSelection.includes('totalCommits')"
         ) {{ getPercentile(i) }} %&nbsp
         span.tooltip-text.right-aligned {{ getPercentileExplanation(i) }}
       .summary-charts__title--tags(
@@ -158,6 +157,14 @@
         )
           font-awesome-icon(icon="tags")
           span  {{ tag }}
+
+    .blurbWrapper(
+      v-if="filterGroupSelection === 'groupByRepos'",
+    )
+      c-markdown-chunk.blurb(
+        v-bind:markdown-text="getBlurb(repo[0])"
+      )
+
     .summary-charts__fileType--breakdown(v-if="filterBreakdown")
       template(v-if="filterGroupSelection !== 'groupByNone'")
         .summary-charts__fileType--breakdown__legend(
@@ -337,6 +344,7 @@ import brokenLinkDisabler from '../mixin/brokenLinkMixin';
 import tooltipPositioner from '../mixin/dynamicTooltipMixin';
 import cRamp from './c-ramp.vue';
 import cStackedBarChart from './c-stacked-bar-chart.vue';
+import cMarkdownChunk from './c-markdown-chunk.vue';
 import { Bar, Repo, User } from '../types/types';
 import { FilterGroupSelection, FilterTimeFrame, SortGroupSelection } from '../types/summary';
 import { StoreState, ZoomInfo } from '../types/vuex.d';
@@ -347,6 +355,7 @@ export default defineComponent({
   components: {
     cRamp,
     cStackedBarChart,
+    cMarkdownChunk,
   },
   mixins: [brokenLinkDisabler, tooltipPositioner],
   props: {
@@ -984,10 +993,34 @@ export default defineComponent({
       return [...new Set(repo.flatMap((r) => r.commits).flatMap((c) => c.commitResults).flatMap((r) => r.tags))]
         .filter(Boolean) as Array<string>;
     },
+
+    getBlurb(repo: User): string {
+      const link = this.getRepoLink(repo);
+      if (!link) {
+        return '';
+      }
+      const blurb: string | undefined = this.$store.state.blurbMap[link];
+      if (!blurb) {
+        return '';
+      }
+      return blurb;
+    },
   },
 });
 </script>
 
 <style lang="scss" scoped>
 @import '../styles/tags.scss';
+@import '../styles/_colors.scss';
+
+.blurbWrapper {
+  padding-bottom: 5px;
+
+  .blurb {
+    background-color: #fafafa;
+    overflow-y: hidden;
+    // This is needed because the parent summary-wrapper center aligns everything
+    text-align: initial;
+  }
+}
 </style>

frontend/src/store/store.ts

@@ -18,6 +18,7 @@ export default createStore<StoreState>({
     loadingOverlayCount: 0,
     loadingOverlayMessage: '',
     isTabActive: true,
+    blurbMap: {},
   } as StoreState,
   mutations: {
     updateTabZoomInfo(state: StoreState, info: ZoomInfo) {
@@ -82,6 +83,9 @@ export default createStore<StoreState>({
         file.wasCodeLoaded = file.wasCodeLoaded || file.active;
       });
     },
+    setBlurbMap(state: StoreState, blurbMap: { [key: string]: string }) {
+      state.blurbMap = blurbMap;
+    },
   },
   actions: {
     // Actions are called with dispatch

frontend/src/types/vuex.d.ts

@@ -47,6 +47,7 @@ interface StoreState {
   loadingOverlayCount: number;
   loadingOverlayMessage: string;
   isTabActive: boolean;
+  blurbMap: { [key: string]: string };
 }
 
 declare module '@vue/runtime-core' {

frontend/src/types/window.ts

@@ -24,6 +24,7 @@ interface Api {
     reportGenerationTime: string;
     errorMessages: { [key: string]: ErrorMessage };
     names: string[];
+    blurbMap: { [key: string]: string };
   } | null>;
   loadCommits: (repoName: string) => Promise<User[]>;
   loadAuthorship: (repoName: string) => Promise<AuthorshipSchema>;

frontend/src/types/zod/summary-type.ts

@@ -45,6 +45,9 @@ export const summarySchema = z.object({
   isUntilDateProvided: z.boolean(),
   isAuthorshipAnalyzed: z.boolean().default(false), // for backwards compatability
   supportedDomainUrlMap: supportedDomainUrlMapSchema,
+  blurbs: z.object({
+    urlBlurbMap: z.record(z.string(), z.string()),
+  }),
 });
 
 // Export typescript types

frontend/src/utils/api.ts

@@ -233,11 +233,14 @@ window.api = {
       window.REPOS[repoName] = repo;
       names.push(repoName);
     });
+
+    const blurbMap: { [key: string]: string } = data.blurbs.urlBlurbMap;
     return {
       creationDate: reportGeneratedTime,
       reportGenerationTime,
       errorMessages,
       names,
+      blurbMap,
     };
   },
 

src/main/java/reposense/RepoSense.java

@@ -10,13 +10,15 @@
 
 import net.sourceforge.argparse4j.helper.HelpScreenException;
 import reposense.git.GitConfig;
+import reposense.model.BlurbMap;
 import reposense.model.CliArguments;
 import reposense.model.RepoConfiguration;
 import reposense.model.ReportConfiguration;
 import reposense.model.RunConfigurationDecider;
 import reposense.parser.ArgsParser;
 import reposense.parser.exceptions.InvalidCsvException;
 import reposense.parser.exceptions.InvalidHeaderException;
+import reposense.parser.exceptions.InvalidMarkdownException;
 import reposense.parser.exceptions.ParseException;
 import reposense.report.ReportGenerator;
 import reposense.system.LogsManager;
@@ -43,6 +45,7 @@ public static void main(String[] args) {
             CliArguments cliArguments = ArgsParser.parse(args);
             List<RepoConfiguration> configs = null;
             ReportConfiguration reportConfig = new ReportConfiguration();
+            BlurbMap blurbMap = new BlurbMap();
 
             if (cliArguments.isViewModeOnly()) {
                 ReportServer.startServer(SERVER_PORT_NUMBER, cliArguments.getReportDirectoryPath().toAbsolutePath());
@@ -51,6 +54,7 @@ public static void main(String[] args) {
 
             configs = RunConfigurationDecider.getRunConfiguration(cliArguments).getRepoConfigurations();
             reportConfig = cliArguments.getReportConfiguration();
+            blurbMap = cliArguments.getBlurbMap();
 
             RepoConfiguration.setFormatsToRepoConfigs(configs, cliArguments.getFormats());
             RepoConfiguration.setDatesToRepoConfigs(configs, cliArguments.getSinceDate(), cliArguments.getUntilDate());
@@ -80,7 +84,9 @@ public static void main(String[] args) {
                     cliArguments.isSinceDateProvided(), cliArguments.isUntilDateProvided(),
                     cliArguments.getNumCloningThreads(), cliArguments.getNumAnalysisThreads(),
                     TimeUtil::getElapsedTime, cliArguments.getZoneId(), cliArguments.isFreshClonePerformed(),
-                    cliArguments.isAuthorshipAnalyzed(), cliArguments.getOriginalityThreshold());
+                    cliArguments.isAuthorshipAnalyzed(), cliArguments.getOriginalityThreshold(),
+                    blurbMap
+            );
 
             FileUtil.zipFoldersAndFiles(reportFoldersAndFiles, cliArguments.getOutputFilePath().toAbsolutePath(),
                     ".json");
@@ -97,6 +103,8 @@ public static void main(String[] args) {
             logger.log(Level.WARNING, e.getMessage(), e);
         } catch (HelpScreenException e) {
             // help message was printed by the ArgumentParser; it is safe to exit.
+        } catch (InvalidMarkdownException ex) {
+            logger.log(Level.SEVERE, ex.getMessage(), ex);
         }
 
         LogsManager.moveLogFileToOutputFolder();

src/main/java/reposense/model/BlurbMap.java

@@ -0,0 +1,67 @@
+package reposense.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Represents the mapping between the repo URL to the associated blurb.
+ */
+public class BlurbMap {
+    @JsonProperty("urlBlurbMap")
+    private final Map<String, String> urlBlurbMap;
+
+    public BlurbMap() {
+        this.urlBlurbMap = new HashMap<>();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj == this) {
+            return true;
+        }
+
+        if (obj instanceof BlurbMap) {
+            BlurbMap bm = (BlurbMap) obj;
+            return bm.urlBlurbMap.equals(this.urlBlurbMap);
+        }
+
+        return false;
+    }
+
+    /**
+     * Builder class to help in the building of a {@code BlurbMap}.
+     */
+    public static final class Builder {
+        private BlurbMap blurbMap;
+
+        public Builder() {
+            blurbMap = new BlurbMap();
+        }
+
+
+        /**
+         * Adds a key-value record into the {@code BlurbMap}.
+         *
+         * @param key Key value.
+         * @param value Blurb value.
+         * @return This {@code Builder}.
+         */
+        public Builder withRecord(String key, String value) {
+            blurbMap.urlBlurbMap.put(key, value);
+            return this;
+        }
+
+        /**
+         * Returns a built instance of {@code BlurbMap}.
+         *
+         * @return Built {@code BlurbMap}.
+         */
+        public BlurbMap build() {
+            BlurbMap built = this.blurbMap;
+            this.blurbMap = new BlurbMap();
+            return built;
+        }
+    }
+}

src/main/java/reposense/model/CliArguments.java

@@ -51,6 +51,7 @@ public class CliArguments {
     private Path groupConfigFilePath;
     private Path reportConfigFilePath;
     private ReportConfiguration reportConfiguration;
+    private BlurbMap blurbMap;
 
     /**
      * Constructs a {@code CliArguments} object without any parameters.
@@ -161,6 +162,10 @@ public ReportConfiguration getReportConfiguration() {
         return reportConfiguration;
     }
 
+    public BlurbMap getBlurbMap() {
+        return blurbMap;
+    }
+
     public boolean isViewModeOnly() {
         return isViewModeOnly;
     }
@@ -211,6 +216,7 @@ public boolean equals(Object other) {
                 && Objects.equals(this.authorConfigFilePath, otherCliArguments.authorConfigFilePath)
                 && Objects.equals(this.groupConfigFilePath, otherCliArguments.groupConfigFilePath)
                 && Objects.equals(this.reportConfigFilePath, otherCliArguments.reportConfigFilePath)
+                && Objects.equals(this.blurbMap, otherCliArguments.blurbMap)
                 && this.isAuthorshipAnalyzed == otherCliArguments.isAuthorshipAnalyzed
                 && Objects.equals(this.originalityThreshold, otherCliArguments.originalityThreshold);
     }
@@ -487,6 +493,16 @@ public Builder originalityThreshold(double originalityThreshold) {
             return this;
         }
 
+        /**
+         * Adds the {@code blurbMap} to CliArguments.
+         *
+         * @param blurbMap The blurb map.
+         */
+        public Builder blurbMap(BlurbMap blurbMap) {
+            this.cliArguments.blurbMap = blurbMap;
+            return this;
+        }
+
         /**
          * Builds CliArguments.
          *