Show top & fav databases and "other" databases in separate lists

controllers/UserDataController.js

@@ -131,10 +131,12 @@ module.exports = class UserDataController {
     let subjectListWithLiaisons = liaisonList.concat(subjectList);
     let uniqueSubjectList = _.uniq(subjectListWithLiaisons);
 
-    let userLibGuides = new UserLibGuidesData(
+    let userLibGuidesObject = new UserLibGuidesData(
       uniqueSubjectList,
       this.user.favorites
     );
+    userLibGuidesObject.getSubjectFiles();
+    let userLibGuides = userLibGuidesObject.subjectData;
 
     let finishedUserData = {
       person: this.userLoginInfo,

models/libGuides/LibAppsDataFilter.js

@@ -78,19 +78,28 @@ module.exports = class LibAppsDataFilter {
     });
   }
 
-  filterBySubject(resourceList, subject, topOnly = false) {
+  filterBySubject(resourceList, subject, reportTopForSubject = false) {
     var results = [];
     resourceList.forEach(function (item) {
+      // if there are subjects defined for the item,
+      // find the one that matches the requested subject
+      // if there are no subjects, skip the item
       if (item.subjects !== undefined) {
-        if (topOnly) {
-          var temp = item.subjects.filter(
-            (s) => s.name === subject && s.featured === 1
-          );
-        } else {
-          var temp = item.subjects.filter((s) => s.name === subject);
-        }
+        // determine if item matches the requested subject
+        var itemMatchingSubject = item.subjects.filter(
+          (s) => s.name === subject
+        );
+
+        // if the item has subjects and matches the requested subject
+        // add it to the results
+        // if requested, also check to see if it a featured/top item for that subject
         if (item.subjects !== undefined) {
-          if (temp.length > 0) {
+          if (itemMatchingSubject.length > 0) {
+            if (reportTopForSubject) {
+              let isTopForSubject =
+                itemMatchingSubject[0].featured === 1 ? true : false;
+              item.isTopForSubject = isTopForSubject;
+            }
             results.push(item);
           }
         }
@@ -108,7 +117,7 @@ module.exports = class LibAppsDataFilter {
     return matches;
   }
 
-  getBestBySubject(resourceList, subjects, topOnly = false) {
+  getBestBySubject(resourceList, subjects, reportTopForSubject = false) {
     // expects resourceList to be an object listing database, librarians, or libguides
     // expect subjects to be an array of subject areas in order of best fit, e.g.:
     // subjects = ['English','Languages']
@@ -121,7 +130,11 @@ module.exports = class LibAppsDataFilter {
     for (var i = 0; i < subjects.length; i++) {
       if (found === false) {
         // console.log('checking', subjects[i])
-        let response = this.filterBySubject(resourceList, subjects[i], topOnly);
+        let response = this.filterBySubject(
+          resourceList,
+          subjects[i],
+          reportTopForSubject
+        );
         // console.log(response)
         if (response.length > 0) {
           var done = response;

models/libGuides/test/LibAppsDataFilter.test.js

@@ -27,19 +27,34 @@ describe('LibAppsDataFilter: databases', () => {
 });
 
 describe('LibAppsDataFilter: filterBySubject: Databases', () => {
-  english = obj.filterBySubject(databases, 'English'); // 5
-  topEnglish = obj.filterBySubject(databases, 'English', true); // 1
-  bws = obj.filterBySubject(databases, 'Black World Studies'); // 2
+  english = obj.filterBySubject(databases, 'English', true); // 5
+  bws = obj.filterBySubject(databases, 'Black World Studies', true); // 2
+
+  // re-write these tests for the top/nonTop divide
 
   it('should find five English databases', () => {
     expect(english.length).toBe(5);
   });
   it('should find two BWS databases', () => {
     expect(bws.length).toBe(2);
   });
-  it('should fine one top English database', () => {
-    expect(topEnglish.length).toBe(1);
-    expect(topEnglish[0].name).toBe('19th Century Index');
+  it('should find one top English database and 4 non-top', () => {
+    expect(english[0].name).toBe('19th Century Index');
+    expect(english[0]).toHaveProperty('isTopForSubject');
+    expect(english[0].isTopForSubject).toBe(true);
+    // expect(english[1]).toHaveProperty('isTopForSubject');
+    // expect(english[1].isTopForSubject).toBe(false);
+    // expect(english[2]).toHaveProperty('isTopForSubject');
+    // expect(english[2].isTopForSubject).toBe(false);
+    // expect(english[3]).toHaveProperty('isTopForSubject');
+    // expect(english[3].isTopForSubject).toBe(false);
+    // expect(english[4]).toHaveProperty('isTopForSubject');
+    // expect(english[4].isTopForSubject).toBe(false);
+  });
+  it('should find no top BWS databases and two non-top', () => {
+    expect(bws[0]).toHaveProperty('isTopForSubject');
+    expect(bws[0].isTopForSubject).toBe(false);
+    expect(bws[1].isTopForSubject).toBe(false);
   });
 });
 
@@ -68,6 +83,10 @@ describe('LibAppsDataFilter: filterBySubject: librarians', () => {
     expect(bizLib.length).toBe(1);
     expect(bizLib[0].last_name).toBe('Janeway');
   });
+  it('should not have isTopForSubject property', () => {
+    expect(bizLib[0]).not.toHaveProperty('isTopForSubject');
+    expect(langLib[0]).not.toHaveProperty('isTopForSubject');
+  });
 });
 
 describe('LibAppsDataFilter: guides', () => {
@@ -81,6 +100,9 @@ describe('LibAppsDataFilter: guides', () => {
   it('should find nine guides', () => {
     expect(guides.length).toBe(9);
   });
+  it('should not have isTopForSubject property', () => {
+    expect(guides[0]).not.toHaveProperty('isTopForSubject');
+  });
 });
 
 describe('LibAppsDataFilter: removeUnpublishedGuides', () => {

models/userLoginData/UserLibGuidesData.js

@@ -22,8 +22,8 @@ module.exports = class UserLibGuidesData {
     this.subjectCachePath = subjectCachePath;
     this.customPath = customPath;
     this.subjectData = [];
-    this.getSubjectFiles();
-    return this.subjectData;
+    // this.getSubjectFiles();
+    // return this.subjectData;
   }
 
   getSubjectFiles() {
@@ -35,10 +35,11 @@ module.exports = class UserLibGuidesData {
       }
       let fileContents = this.getFileContents(filename);
       fileContents = this.markFavoriteGuidesAndDatabases(fileContents);
+      fileContents = this.separateTopAndFavDatabases(fileContents);
       this.subjectData.push({
         name: subject,
         resources: fileContents,
-        kenTest: true,
+        // kenTest: true,
       });
     });
   }
@@ -94,7 +95,7 @@ module.exports = class UserLibGuidesData {
       contents.databases !== undefined
     ) {
       contents.databases.forEach((database) => {
-        database.testString = 'bogusKen';
+        // database.testString = 'bogusKen';
         database.favorite =
           this.favorites.favoriteDatabases.includes(database.id) ||
           this.favorites.favoriteDatabases.includes(database.id.toString());
@@ -103,4 +104,19 @@ module.exports = class UserLibGuidesData {
 
     return contents;
   }
+
+  separateTopAndFavDatabases(contents) {
+    const databases = contents.databases;
+    let aboveFold = databases.filter((db) => db.isTopForSubject || db.favorite);
+    let belowFold = databases.filter(
+      (db) => !db.isTopForSubject && !db.favorite
+    );
+    contents.databases = {
+      aboveFold: aboveFold,
+      belowFold: belowFold,
+      isArray: Array.isArray(databases),
+      length: databases.length,
+    };
+    return contents;
+  }
 };

models/userLoginData/test/UserLibGuidesData.test.js

@@ -0,0 +1,114 @@
+const spanish = require('./sample-data/subjectsAfterFavsAdded/Spanish.json');
+const german = require('./sample-data/subjectsAfterFavsAdded/German.json');
+
+const UserLibGuidesData = require('../UserLibGuidesData');
+
+describe('UserLibGuidesData: separateTopAndFavDatabases', () => {
+  describe('separateTopAndFavDatabases: Spanish', () => {
+    const obj = new UserLibGuidesData();
+
+    it('should get a response with databases: [aboveFold, belowFold]', () => {
+      // Note: `structuredClone` is used to avoid mutating the original data.
+      const result = obj.separateTopAndFavDatabases(structuredClone(spanish));
+      expect(result).toHaveProperty('databases');
+      expect(result.databases).toHaveProperty('aboveFold');
+      expect(result.databases).toHaveProperty('belowFold');
+    });
+
+    it('should get 5 above/3 below', () => {
+      const result = obj.separateTopAndFavDatabases(structuredClone(spanish));
+      expect(Array.isArray(result.databases.aboveFold)).toBe(true);
+      expect(Array.isArray(result.databases.belowFold)).toBe(true);
+      expect(result.databases.aboveFold.length).toBe(5);
+      expect(result.databases.belowFold.length).toBe(3);
+    });
+
+    it('should have expected databases in aboveFold and belowFold for Spanish', () => {
+      const result = obj.separateTopAndFavDatabases(structuredClone(spanish));
+      let expectedAboveFold = [
+        'Clase and Periodica',
+        'Film and Television Literature Index with Full Text',
+        'Fuente Academica',
+        'Linguistics & Language Behavior Abstracts',
+        'MLA International Bibliography',
+      ];
+      let expectedBelowFold = [
+        'Ethnic NewsWatch',
+        'Latin American Women Writers',
+        'Latino Literature',
+      ];
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[0].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[1].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[2].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[3].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[4].name)
+      ).toBe(true);
+      expect(
+        expectedBelowFold.includes(result.databases.belowFold[0].name)
+      ).toBe(true);
+      expect(
+        expectedBelowFold.includes(result.databases.belowFold[1].name)
+      ).toBe(true);
+      expect(
+        expectedBelowFold.includes(result.databases.belowFold[2].name)
+      ).toBe(true);
+    });
+  });
+
+  describe('separateTopAndFavDatabases: German', () => {
+    const obj = new UserLibGuidesData();
+
+    it('should get a response with databases: [aboveFold, belowFold]', () => {
+      const result = obj.separateTopAndFavDatabases(structuredClone(german));
+      expect(result).toHaveProperty('databases');
+      expect(result.databases).toHaveProperty('aboveFold');
+      expect(result.databases).toHaveProperty('belowFold');
+    });
+
+    it('should get 5 above/3 below', () => {
+      const result = obj.separateTopAndFavDatabases(structuredClone(german));
+      expect(Array.isArray(result.databases.aboveFold)).toBe(true);
+      expect(Array.isArray(result.databases.belowFold)).toBe(true);
+      expect(result.databases.aboveFold.length).toBe(3);
+      expect(result.databases.belowFold.length).toBe(2);
+    });
+
+    it('should have expected databases in aboveFold and belowFold for German', () => {
+      const result = obj.separateTopAndFavDatabases(structuredClone(german));
+
+      let expectedAboveFold = [
+        'Film and Television Literature Index with Full Text',
+        'MLA International Bibliography',
+        'Linguistics & Language Behavior Abstracts',
+      ];
+      let expectedBelowFold = [
+        'German Life and Letters',
+        'Oxford Bibliographies Online: Literary and Critical Theory',
+      ];
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[0].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[1].name)
+      ).toBe(true);
+      expect(
+        expectedAboveFold.includes(result.databases.aboveFold[2].name)
+      ).toBe(true);
+      expect(
+        expectedBelowFold.includes(result.databases.belowFold[0].name)
+      ).toBe(true);
+      expect(
+        expectedBelowFold.includes(result.databases.belowFold[1].name)
+      ).toBe(true);
+    });
+  });
+});