[#944] Implement authorship analysis

build.gradle

@@ -196,7 +196,7 @@ def serveTestReportInBackground = tasks.register('serveTestReportInBackground',
     workingDir = 'build/serveTestReport'
     main = mainClassName
     classpath = sourceSets.main.runtimeClasspath
-    args = ['--config', './exampleconfig', '--since', 'd1', '--view']
+    args = ['--config', './exampleconfig', '--since', 'd1', '--view', '-A']
     String versionJvmArgs = '-Dversion=' + getRepoSenseVersion()
     jvmArgs = [ versionJvmArgs ]
     killDescendants = false // Kills descendants of started process using methods only found in Java 9 and beyond.

docs/ug/cli.md

@@ -16,16 +16,36 @@ The command `java -jar RepoSense.jar` takes several flags.
 **Examples**:
 
 An example of a command using most parameters:<br>
-`java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors`
+`java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors --analyze-authorship --originality-threshold 0.66`
 
 Same command as above but using most parameters in alias format:<br>
-`java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F`
+`java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F -A -ot 0.66`
 </box>
 
 The section below provides explanations for each of the flags.
 
 <!-- --------------------------◘---------------------------------------------------------------------------- -->
 
+### `--analyze-authorship`, `-A`
+
+**`--analyze-authorship`**: Performs further analysis to distinguish between partial and full credit attribution for
+lines of code assigned to the author.
+
+* Default: this feature is turned ***off*** by default and the author will receive partial credits for all lines of
+  code, as the code lines are at least partial credit but may not qualify for full credit.
+* Alias: `-A` (upper case)
+* Example: `--analyze-authorship` or `-A`
+
+<box type="info" seamless>
+
+A darker background colour represents full credit, while a lighter background colour represents partial credit.
+
+If the code is attributed to a different author by the user via `@@author` tag, then the new author will be given
+partial credit.
+</box>
+
+<!-- ------------------------------------------------------------------------------------------------------ -->
+
 ### `--assets`, `-a`
 
 <div id="section-assets">
@@ -148,6 +168,26 @@ This flag overrides the `Ignore file size limit` field in the CSV config file.
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 
+### `--originality-threshold`, `-ot`
+
+**`--originality-threshold [VALUE]`**: Specifies the cut-off point for partial and full credit
+in `--analyze-authorship`. Author will be given full credit if their contribution exceeds this threshold, else partial
+credit is given.
+
+* Parameter: `VALUE` Optional. Acceptable range: [0.0, 1.0].<br>
+  Default: `0.51`
+* Alias: `-ot`
+* Example: `--originality-threshold 0.66` or `-ot 0.66`
+
+<box type="info" seamless>
+
+* Requires `--analyze-authorship` flag.
+* An author's contribution, or `originality score`, is calculated using Levenshtein Distance (Edit Distance) algorithm.
+  We compare the difference between current code line and its previous versions, obtained via various git commands.
+</box>
+
+<!-- ------------------------------------------------------------------------------------------------------ -->
+
 ### `--output`, `-o`
 
 **`--output OUTPUT_DIRECTORY`**: Indicates where to save the report generated.

frontend/cypress/tests/codeView/codeView_creditBackgroundColour.cy.js

@@ -0,0 +1,54 @@
+describe('credit background colour', () => {
+  it('check if background colour match the credit information for Eugene', () => {
+    // open the code panel
+    cy.get('.icon-button.fa-code')
+      .should('exist')
+      .first()
+      .click();
+
+    // src/main/java/reposense/model/Author.java
+    // line 9: full credit - #BFF6CF
+    cy.get(':nth-child(1) > .file-content > .segment-collection > :nth-child(2) > .java > .code')
+      .should('have.css', 'background-color')
+      .and('eq', 'rgb(191, 246, 207)');
+
+    // src/main/java/reposense/model/Author.java
+    // line 15: partial credit - #E6FFED
+    cy.get(':nth-child(1) > .file-content > .segment-collection > :nth-child(4) > .java > .code')
+      .should('have.css', 'background-color')
+      .and('eq', 'rgb(230, 255, 237)');
+  });
+
+  it('check if background colour match the credit information when group is merged', () => {
+    // check merge group checkbox
+    cy.get('#summary label.merge-group > input')
+      .should('be.visible')
+      .check()
+      .should('be.checked');
+
+    // open the code panel
+    cy.get('.icon-button.fa-code')
+      .should('exist')
+      .click();
+
+    // frontend/src/styles/_colors.scss
+    // line 35: full credit - #F0808050
+    cy.get(':nth-child(7) > .scss > :nth-child(1)')
+      .should('have.css', 'background-color')
+      .and('eq', 'rgba(240, 128, 128, 0.314)');
+
+    // FileInfoExtractor.java is too far away to be loaded, use filter to go to it directly
+    cy.get('#search')
+      .click()
+      .type('FileInfoExtractor.java');
+
+    cy.get('#submit-button')
+      .click();
+
+    // src/main/java/reposense/authorship/FileInfoExtractor.java
+    // line 23: partial credit - #1E90FF20
+    cy.get(':nth-child(10) > .java > :nth-child(1)')
+      .should('have.css', 'background-color')
+      .and('eq', 'rgba(30, 144, 255, 0.125)');
+  });
+});

frontend/src/components/c-segment.vue

@@ -1,8 +1,8 @@
 <template lang="pug">
 .segment(
-  v-bind:class="{ untouched: !segment.knownAuthor, active: isOpen }",
+  v-bind:class="{ untouched: !segment.knownAuthor, active: isOpen, isNotFullCredit: !segment.isFullCredit }",
   v-bind:style="{ 'border-left': `0.25rem solid ${authorColors[segment.knownAuthor]}` }",
-  v-bind:title="`Author: ${segment.knownAuthor || \"Unknown\"}`"
+  v-bind:title="`${segment.isFullCredit ? 'Author' : 'Co-author'}: ${segment.knownAuthor || \"Unknown\"}`"
 )
   .closer(v-if="canOpen",
     v-on:click="toggleCode", ref="topButton")
@@ -17,6 +17,7 @@
       v-bind:title="'Click to hide code'"
     )
   div(v-if="isOpen", v-hljs="path")
+    //- author color is applied only when the author color exists, else it takes the default mui color value
     .code(
       v-for="(line, index) in segment.lines", v-bind:key="index",
       v-bind:style="{ 'background-color': `${authorColors[segment.knownAuthor]}${transparencyValue}` }"
@@ -53,7 +54,7 @@ export default defineComponent({
     return {
       isOpen: (this.segment.knownAuthor !== null) || this.segment.lines.length < 5 as boolean,
       canOpen: (this.segment.knownAuthor === null) && this.segment.lines.length > 4 as boolean,
-      transparencyValue: '30' as string,
+      transparencyValue: (this.segment.isFullCredit ? '50' : '20') as string,
     };
   },
   computed: {
@@ -77,7 +78,7 @@ export default defineComponent({
   border-left: .25rem solid mui-color('green');
 
   .code {
-    background-color: mui-color('github', 'authored-code-background');
+    background-color: mui-color('github', 'full-authored-code-background');
     padding-left: 1rem;
   }
 
@@ -110,6 +111,12 @@ export default defineComponent({
     word-break: break-word;
   }
 
+  &.isNotFullCredit {
+    .code {
+      background-color: mui-color('github', 'partial-authored-code-background');
+    }
+  }
+
   &.untouched {
     $grey: mui-color('grey', '400');
     border-left: .25rem solid $grey;

frontend/src/styles/_colors.scss

@@ -303,7 +303,8 @@ $mui-colors: (
   'github': (
     'title-background': #FAFBFC,
     'border': #E1E4E8,
-    'authored-code-background': #E6FFED,
+    'full-authored-code-background': #BFF6CF,
+    'partial-authored-code-background': #E6FFED,
   ),
   'grey': (
     '50': #FAFAFA,

frontend/src/styles/hightlight-js-style.css

@@ -34,7 +34,7 @@
 
 .hljs-section,
 .hljs-name {
-    color: #63a35c;
+    color: #468C5A;
 }
 
 .hljs-tag {

frontend/src/types/types.ts

@@ -61,6 +61,7 @@ export interface Repo extends RepoRaw {
 
 export interface AuthorshipFileSegment {
   knownAuthor: string | null;
+  isFullCredit: boolean;
   lineNumbers: number[];
   lines: string[];
 }
@@ -83,3 +84,9 @@ export interface Bar {
   color?: string;
   tooltipText?: string;
 }
+
+export interface SegmentState {
+  id: number;
+  author: string | null;
+  isFullCredit: boolean;
+}

frontend/src/types/window.ts

@@ -68,6 +68,7 @@ declare global {
     repoSenseVersion: string;
     isSinceDateProvided: boolean;
     isUntilDateProvided: boolean;
+    isAuthorshipAnalyzed: boolean;
     DOMAIN_URL_MAP: DomainUrlMap;
     // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     app: any;

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

@@ -4,6 +4,7 @@ const lineSchema = z.object({
   lineNumber: z.number(),
   author: z.object({ gitId: z.string() }),
   content: z.string(),
+  isFullCredit: z.boolean(),
 });
 
 const fileResult = z.object({

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

@@ -44,6 +44,7 @@ export const summarySchema = z.object({
   untilDate: z.string(),
   isSinceDateProvided: z.boolean(),
   isUntilDateProvided: z.boolean(),
+  isAuthorshipAnalyzed: z.boolean(),
   supportedDomainUrlMap: supportedDomainUrlMapSchema,
 });
 

frontend/src/utils/api.ts

@@ -217,6 +217,7 @@ window.api = {
     window.repoSenseVersion = data.repoSenseVersion;
     window.isSinceDateProvided = data.isSinceDateProvided;
     window.isUntilDateProvided = data.isUntilDateProvided;
+    window.isAuthorshipAnalyzed = data.isAuthorshipAnalyzed;
     document.title = data.reportTitle || document.title;
 
     const errorMessages: { [key: string]: ErrorMessage } = {};

frontend/src/views/c-authorship.vue

@@ -97,6 +97,14 @@
             )
               span {{ ignoredFilesCount }} ignored file(s)
 
+  .background-color-legend(v-if="isAuthorshipAnalyzed")
+    .bold Legend:
+    .color-circle.full-credit-color(v-bind:class="{'isMergeGroup': info.isMergeGroup}")
+    span [darker shades] Mostly contributed by author.
+    .bold(style='margin-left : 5px;') |
+    .color-circle.partial-credit-color(v-bind:class="{'isMergeGroup': info.isMergeGroup}")
+    span [lighter shades] Contributed by author, with non-trivial contribution from others.
+
   .files(v-if="isLoaded")
     .empty(v-if="info.files.length === 0") nothing to see here :(
     template(v-for="(file, index) in selectedFiles", v-bind:key="file.path")
@@ -115,7 +123,7 @@ import cAuthorshipFile from '../components/c-authorship-file.vue';
 import getNonRepeatingColor from '../utils/random-color-generator';
 import { StoreState } from '../types/vuex.d';
 import { FileResult, Line } from '../types/zod/authorship-type';
-import { AuthorshipFile, AuthorshipFileSegment } from '../types/types';
+import { AuthorshipFile, AuthorshipFileSegment, SegmentState } from '../types/types';
 import { FilesSortType, FilterType } from '../types/authorship';
 
 const filesSortDict = {
@@ -249,6 +257,10 @@ export default defineComponent({
       info: (state: unknown) => (state as StoreState).tabAuthorshipInfo,
       authorColors: (state: unknown) => (state as StoreState).tabAuthorColors,
     }),
+
+    isAuthorshipAnalyzed(): boolean {
+      return window.isAuthorshipAnalyzed;
+    },
   },
 
   watch: {
@@ -410,8 +422,7 @@ export default defineComponent({
 
     splitSegments(lines: Array<Line>): { segments: Array<AuthorshipFileSegment>; blankLineCount: number; } {
       // split into segments separated by knownAuthor
-      let lastState: string | null;
-      let lastId = -1;
+      const lastState : SegmentState = { id: -1, author: null, isFullCredit: true };
       const segments: Array<AuthorshipFileSegment> = [];
       let blankLineCount = 0;
 
@@ -420,22 +431,25 @@ export default defineComponent({
           ? !this.isUnknownAuthor(line.author.gitId)
           : line.author.gitId === this.info.author;
         const knownAuthor = (line.author && isAuthorMatched) ? line.author.gitId : null;
+        const isFullCredit = line.isFullCredit;
 
-        if (knownAuthor !== lastState || lastId === -1) {
+        if (lastState.id === -1 || lastState.author !== knownAuthor
+            || (knownAuthor && lastState.isFullCredit !== isFullCredit)) {
           segments.push({
             knownAuthor,
+            isFullCredit,
             lineNumbers: [],
             lines: [],
           });
 
-          lastId += 1;
-          lastState = knownAuthor;
+          lastState.id += 1;
+          lastState.author = knownAuthor;
+          lastState.isFullCredit = isFullCredit;
         }
 
         const content = line.content || ' ';
-        segments[lastId].lines.push(content);
-
-        segments[lastId].lineNumbers.push(lineCount + 1);
+        segments[lastState.id].lines.push(content);
+        segments[lastState.id].lineNumbers.push(lineCount + 1);
 
         if (line.content === '' && knownAuthor) {
           blankLineCount += 1;
@@ -698,5 +712,38 @@ export default defineComponent({
   .empty {
     text-align: center;
   }
+
+  .background-color-legend {
+    align-items: center;
+    display: flex;
+    flex-direction: row;
+
+    .bold {
+      font-weight: bold;
+    }
+
+    .color-circle {
+      border: 1px solid lightgrey;
+      border-radius: 50%;
+      margin-left: 5px;
+      margin-right: 5px;
+      min-height: 15px;
+      min-width: 15px;
+    }
+
+    .full-credit-color {
+      background-color: mui-color('github', 'full-authored-code-background');
+      &.isMergeGroup {
+        background-color: mui-color('grey', '400');
+      }
+    }
+
+    .partial-credit-color {
+      background-color: mui-color('github', 'partial-authored-code-background');
+      &.isMergeGroup {
+        background-color: mui-color('grey', '200');
+      }
+    }
+  }
 }
 </style>

src/main/java/reposense/RepoSense.java

@@ -79,7 +79,8 @@ public static void main(String[] args) {
                     cliArguments.getSinceDate(), cliArguments.getUntilDate(),
                     cliArguments.isSinceDateProvided(), cliArguments.isUntilDateProvided(),
                     cliArguments.getNumCloningThreads(), cliArguments.getNumAnalysisThreads(),
-                    TimeUtil::getElapsedTime, cliArguments.getZoneId(), cliArguments.isFreshClonePerformed());
+                    TimeUtil::getElapsedTime, cliArguments.getZoneId(), cliArguments.isFreshClonePerformed(),
+                    cliArguments.isAuthorshipAnalyzed(), cliArguments.getOriginalityThreshold());
 
             FileUtil.zipFoldersAndFiles(reportFoldersAndFiles, cliArguments.getOutputFilePath().toAbsolutePath(),
                     ".json");