Merge pull request #1 from chaoss/muggle

Signed-off-by: Sourabh Saraswat 191939 <[email protected]>

Author: SourabhSaraswat-191939

CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing to GrimoireLab Sorting Hat
+
+These are some general guidelines and information related to how we contribute to 
+GrimoireLab. You can read about it from the [CONTRIBUTING.md](https://github.com/chaoss/grimoirelab/blob/master/CONTRIBUTING.md).
+
+## Changelog Entries
+
+Some of your contributions will require a changelog entry which explains 
+the motivation of the change. These entries would be included in the 
+release notes to explain users and developers about the new features 
+or bugs fixed in the software. This is an example of changelog entry:
+
+```
+title: 'Fix bug casting spells on magicians'
+category: fixed
+author: John Smith <[email protected]>
+issue: 666
+notes: >
+    The bug was making impossible to cast a spell on
+    a magician.
+```
+
+Changelog entries will be written to explain *what* was changed and *why*, 
+not *how*. Take into account not everybody is a developer and they are 
+meant to reach a wider audience.
+
+### What warrants a changelog entry
+
+Changelog entries are **required** for:
+- Code changes that directly affects the GrimoireLab users.
+- Bug fixes.
+- New updates.
+- Performance improvements.
+
+Changelog entries are **not required** for
+- Docs-only (e.g., README.md) changes.
+- Developer-facing change (e.g., test suite changes).
+- Code refactoring.
+
+### Writing changelog entries
+
+These changelog entries should be written to the `releases/unreleased/` 
+directory. The file is expected to be a [YAML](https://yaml.org/) file 
+in the following format: 
+
+```
+title: 'Fix bug casting spells on magicians'
+category: fixed
+author: John Smith <[email protected]>
+issue: 666
+notes: >
+    The bug was making impossible to cast a spell on
+    a magician.
+```
+
+The `title` field has the name of the change. This is a mandatory field.
+
+The `category` field maps the category of the change, valid options are: 
+added, fixed, changed, deprecated, removed, security, performance, other. 
+This field is mandatory.
+
+The `author` key (format: `Your Name <[email protected]>`) is used to 
+give attribution to community contributors. This is an optional field but 
+the Community contributors are encouraged to add their names.
+
+The `issue` value is a reference to the issue, if any, that is targeted 
+with this change. This is an optional field.
+
+The `notes` field should have a description explaining the changes in the 
+code. Remember you can write blocks of text using the `>` character at the 
+beginning of each block. See the above given example.
+
+Contributors can use the interactive [changelog](https://github.com/Bitergia/release-tools#changelog)
+tool for this purpose which generates the changelog entry file automatically.
+
+### Tips for writing good changelog entries
+
+A good changelog entry should be descriptive and concise. It should explain 
+the change to a reader who has *zero context* about the change. If you have 
+trouble making it both concise and descriptive, err on the side of descriptive.
+
+Use your best judgment and try to put yourself in the mindset of someone 
+reading the compiled changelog. Does this entry add value? Does it offer 
+context about *what* and *why* the change was made?
+
+#### Examples
+
+- **Bad:** Go to a project order.
+- **Good:** Show a user’s starred projects at the top of the “Go to project” dropdown. 
+
+The first example provides no context of where the change was made, or why, or 
+how it benefits the user. 
+
+- **Bad:** Copy (some text) to clipboard.
+- **Good:** Update the “Copy to clipboard” tooltip to indicate what’s being copied. 
+
+Again, the first example is too vague and provides no context.
+
+- **Bad:** Fixes and Improves CSS and HTML problems in mini pipeline graph and builds dropdown.
+- **Good:** Fix tooltips and hover states in mini pipeline graph and builds dropdown. 
+
+The first example is too focused on implementation details. The user doesn’t care 
+that we changed CSS and HTML, they care about the result of those changes.
+
+- **Bad:** Strip out `nil`s in the Array of Commit objects returned from `find_commits_by_message_with_elastic`
+- **Good:** Fix 500 errors caused by Elasticsearch results referencing garbage-collected commits 
+
+The first example focuses on *how* we fixed something, not on *what* it fixes. 
+The rewritten version clearly describes the *end benefit* to the user 
+(fewer 500 errors), and *when* (searching commits with Elasticsearch).

docs/database.md

@@ -0,0 +1,5 @@
+## Database
+
+The conceptual schema of the SortingHat database is shown below. Individuals are the first-class citizens. They have a profile, which summarizes the member data, and can be linked to more than one identity and organization, which are automatically extracted from the software development tools of your project. Note that organizations or identities can be easily excluded from SortingHat by registering their names/emails/usernames to a _matching blacklist_. The filter associated to the blacklist is executed every time an identity is inserted to the database or modified.
+
+![sh-database-diagram](sh-database-diagram.svg)

docs/sh-database-diagram.svg

@@ -187,6 +187,8 @@ def recommend_matches(ctx, source_uuids, target_uuids, criteria, verbose=False):
     :returns: a dictionary with which individuals are recommended to be
         merged to which individual or which identities.
     """
+    check_criteria(criteria)
+
     job = rq.get_current_job()
 
     logger.info(f"Running job {job.id} 'recommend matches'; criteria='{criteria}'; ...")
@@ -329,6 +331,8 @@ def _group_recommendations(recs):
                 groups.append(g_uuids)
         return groups
 
+    check_criteria(criteria)
+
     job = rq.get_current_job()
 
     logger.info(f"Running job {job.id} 'unify'; criteria='{criteria}'; ...")
@@ -475,3 +479,16 @@ def _iter_split(iterator, size=None):
             yield itertools.chain([peek], slice_iter)
     except StopIteration:
         return
+
+
+def check_criteria(criteria):
+    """ Check if all given criteria are valid.
+
+    Raises an error if a criterion is not in the valid criteria list
+    (`email`, `name` and/or `username`).
+
+    :param criteria: list of criteria to check
+    """
+    valid_criteria = ['name', 'email', 'username']
+    if any(criterion not in valid_criteria for criterion in criteria):
+        raise ValueError(f"Invalid criteria {criteria}. Valid values are: {valid_criteria}")

sortinghat/core/jobs.py

@@ -176,7 +176,7 @@ class Individual(EntityBase):
 
     class Meta:
         db_table = 'individuals'
-        ordering = ('last_modified', 'created_at',)
+        ordering = ('last_modified', 'created_at', 'profile__name',)
 
     def __str__(self):
         return self.mk

sortinghat/core/models.py

@@ -2538,6 +2538,43 @@ def test_order_by_created_at(self):
         indv = individuals[2]
         self.assertEqual(indv['mk'], indv1.mk)
 
+    def test_order_by_profile_name(self):
+        """Check whether it returns the individuals ordered by their name"""
+
+        indv1 = Individual.objects.create(mk='a9b403e150dd4af8953a52a4bb841051e4b705d9')
+        indv2 = Individual.objects.create(mk='185c4b709e5446d250b4fde0e34b78a2b4fde0e3')
+        indv3 = Individual.objects.create(mk='c6d2504fde0e34b78a185c4b709e5442d045451c')
+        Profile.objects.create(name='AA', individual=indv1)
+        Profile.objects.create(name='ZZ', individual=indv2)
+        Profile.objects.create(name='MM', individual=indv3)
+
+        # Test ascending order
+        client = graphene.test.Client(schema)
+        executed = client.execute(SH_INDIVIDUALS_ORDER_BY % 'profile__name',
+                                  context_value=self.context_value)
+
+        individuals = executed['data']['individuals']['entities']
+
+        indv = individuals[0]
+        self.assertEqual(indv['mk'], indv1.mk)
+        indv = individuals[1]
+        self.assertEqual(indv['mk'], indv3.mk)
+        indv = individuals[2]
+        self.assertEqual(indv['mk'], indv2.mk)
+
+        # Test descending order
+        executed = client.execute(SH_INDIVIDUALS_ORDER_BY % '-profile__name',
+                                  context_value=self.context_value)
+
+        individuals = executed['data']['individuals']['entities']
+
+        indv = individuals[0]
+        self.assertEqual(indv['mk'], indv2.mk)
+        indv = individuals[1]
+        self.assertEqual(indv['mk'], indv3.mk)
+        indv = individuals[2]
+        self.assertEqual(indv['mk'], indv1.mk)
+
     def test_pagination(self):
         """Check whether it returns the individuals searched when using pagination"""
 

tests/test_schema.py

@@ -0,0 +1,59 @@
+import DateInput from "./DateInput.vue";
+
+export default {
+  title: "DateInput",
+  excludeStories: /.*Data$/
+};
+
+const DateInputTemplate = `
+  <div class="ma-5 col-3">
+    <date-input v-model="date" label="Label" :filled="filled" :outlined="outlined" />
+  </div>`;
+
+export const Default = () => ({
+  components: { DateInput },
+  template: DateInputTemplate,
+  data() {
+    return {
+      date: null,
+      filled: false,
+      outlined: false
+    }
+  }
+});
+
+export const Filled = () => ({
+  components: { DateInput },
+  template: DateInputTemplate,
+  data() {
+    return {
+      date: null,
+      filled: true,
+      outlined: false
+    }
+  }
+});
+
+export const Outlined = () => ({
+  components: { DateInput },
+  template: DateInputTemplate,
+  data() {
+    return {
+      date: null,
+      filled: false,
+      outlined: true
+    }
+  }
+});
+
+export const Error = () => ({
+  components: { DateInput },
+  template: DateInputTemplate,
+  data() {
+    return {
+      date: "abc",
+      filled: false,
+      outlined: true
+    }
+  }
+});

ui/src/components/DateInput.stories.js

@@ -0,0 +1,111 @@
+<template>
+  <v-menu
+    v-model="openPicker"
+    :close-on-content-click="false"
+    transition="scale-transition"
+    min-width="290px"
+    nudge-bottom="40"
+    right
+  >
+    <template v-slot:activator="{ on }">
+      <v-text-field
+        v-model="inputDate"
+        :label="label"
+        :filled="filled"
+        :dense="outlined"
+        :outlined="outlined"
+        :single-line="outlined"
+        :error-messages="error"
+        height="30"
+        clearable
+        hide-details="auto"
+        v-on="on"
+        @change="setInputDate($event)"
+      ></v-text-field>
+    </template>
+    <v-date-picker v-model="date" :min="min" :max="max" no-title scrollable>
+    </v-date-picker>
+  </v-menu>
+</template>
+
+<script>
+export default {
+  name: "DateInput",
+  props: {
+    value: {
+      type: [String, Date]
+    },
+    label: {
+      type: String,
+      required: true
+    },
+    min: {
+      type: [String, Date],
+      required: false
+    },
+    max: {
+      type: [String, Date],
+      required: false
+    },
+    filled: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    outlined: {
+      type: Boolean,
+      required: false,
+      default: false
+    }
+  },
+  data() {
+    return {
+      openPicker: false,
+      error: null,
+      inputDate: this.value
+    };
+  },
+  computed: {
+    date: {
+      get() {
+        try {
+          const ISODate = this.value
+            ? new Date(this.value).toISOString()
+            : null;
+          this.setInputDate(ISODate);
+          return ISODate;
+        } catch {
+          this.setError("Invalid date");
+          return null;
+        }
+      },
+      set(value) {
+        const ISODate = new Date(value).toISOString();
+        this.$emit("input", ISODate);
+        this.openPicker = false;
+        this.setInputDate(ISODate);
+        this.setError(null);
+      }
+    }
+  },
+  methods: {
+    setError(error) {
+      this.error = error;
+    },
+    setInputDate(date) {
+      if (!date) {
+        return;
+      }
+      try {
+        const ISODate = date ? new Date(date).toISOString() : null;
+        this.$emit("input", ISODate);
+        this.setError(null);
+        this.openPicker = false;
+        this.inputDate = ISODate.substring(0, 10);
+      } catch {
+        this.setError("Invalid date");
+      }
+    }
+  }
+};
+</script>