Merge pull request #906 from UCLALibrary/remove-dead-utils-functions

remove dead functions from utils/utils.js, …

js/src/utils/utils.js

@@ -56,14 +56,6 @@
     return thumbnailUrl;
   };
 
-  $.getImagesListByManifest = function(manifest) {
-    return manifest.sequences[0].canvases;
-  };
-
-  $.getCollectionTitle = function(metadata) {
-    return metadata.details.label || '';
-  };
-
   /* 
      miscellaneous utilities
      */
@@ -153,30 +145,6 @@
     };
   };
 
-  $.parseRegion  = function(url) {
-    url = new URI(url);
-    var regionString = url.hash();
-    regionArray = regionString.split('=')[1].split(',');
-    return regionArray;
-  };
-
-  $.getOsdFrame = function(region, currentImg) {
-    var imgWidth = currentImg.width,
-    imgHeight = currentImg.height,
-    canvasWidth = currentImg.canvasWidth,
-    canvasHeight = currentImg.canvasHeight,
-    widthNormaliser = imgWidth/canvasWidth,
-    heightNormaliser = imgHeight/canvasHeight,
-    rectX = (region[0]*widthNormaliser)/imgWidth,
-    rectY = (region[1]*heightNormaliser)/imgWidth,
-    rectW = (region[2]*widthNormaliser)/imgWidth,
-    rectH = (region[3]*heightNormaliser)/imgWidth;
-
-    var osdFrame = new OpenSeadragon.Rect(rectX,rectY,rectW,rectH);
-
-    return osdFrame;
-  };
-
   // http://upshots.org/javascript/jquery-test-if-element-is-in-viewport-visible-on-screen
   $.isOnScreen = function(elem, outsideViewportFactor) {
     var factor = 1;
@@ -238,23 +206,6 @@
     return layoutDescription;
   };
 
-  $.generateRange = function(start, stop, step) {
-    if (arguments.length <= 1) {
-      stop = start || 0;
-      start = 0;
-    }
-    step = step || 1;
-
-    var length = Math.max(Math.ceil((stop - start) / step), 0);
-    var range = Array(length);
-
-    for (var idx = 0; idx < length; idx++, start += step) {
-      range[idx] = start;
-    }
-
-    return range;
-  };
-
   // Configurable Promises
   $.createImagePromise = function(imageUrl) {
     var img = new Image(),

spec/utils/iiif.test.js

@@ -1,4 +1,4 @@
-describe('iiif', function () {
+describe('Iiif', function () {
   xit('getImageUrl', function () {
   });
 

spec/utils/jsonBlobApi.test.js

@@ -1,6 +1,6 @@
-describe('util/jsonBlobApi', function () {
+describe('JsonBlobApi', function () {
   xit('readSync', function () {
   });
   xit('save', function () {
   });
-});
+});

spec/utils/jsonLd.test.js

@@ -1,4 +1,4 @@
-describe('utils/jsonLd', function () {
+describe('JsonLd', function () {
   xit('getTextValue', function () {
   });
 });

spec/utils/openSeadragon.test.js

@@ -1,4 +1,4 @@
-describe('utils/openSeadragon', function () {
+describe('OpenSeadragon', function () {
   xit('Construction', function () {
   });
 });

spec/utils/saveController.test.js

@@ -1,4 +1,4 @@
-describe('saveController', function () {
+describe('SaveController', function () {
 
   beforeEach(function() {
     this.config = {

spec/utils/utils.test.js

@@ -1,26 +1,26 @@
 describe('Utils', function() {
   beforeEach(function() {
     this.utils = Mirador;
-    var imagesList = [{
-      'id':     1,
+    this.imagesList = [{
+      '@id':     '1',
       'title':  '1r',
       'height': 10,
       'width':  20
     }, {
-      'id':     2,
+      '@id':     '2',
       'title':  '1v',
       'height': 15,
       'width':  25
-    }],
+    }];
 
-    imageTitlesAndIds = [{
-      'id':     1,
+    this.imageTitlesAndIds = [{
+      '@id':     '1',
       'title': '1r'
     }, {
-      'id':     2,
+      '@id':     '2',
       'title': '1v'
     }];
-    manifests = {
+    this.manifests = {
       "manifest-1234": {
         "uri":"http://xyz.edu/data/Manifest.json",
         "metadata": {
@@ -29,7 +29,7 @@ describe('Utils', function() {
           }
         },
         "sequences": [{
-          "imagesList": imagesList
+          "imagesList": this.imagesList
         }]
       }
     };
@@ -39,12 +39,6 @@ describe('Utils', function() {
     expect(this.utils.trimString('  abc ')).toEqual('abc');
   });
 
-  it('should return a collection title for a given metadata', function() {
-    expect(this.utils.getCollectionTitle({ 'details': { 'label': 'abc' } })).toEqual('abc');
-    expect(this.utils.getCollectionTitle({ 'details': { } })).toEqual('');
-  });
-
-
   describe('XHR utils', function() {
     beforeEach(function() {
       this.server = sinon.fakeServer.create();
@@ -111,4 +105,19 @@ describe('Utils', function() {
       });
     });
   });
+
+  describe('getImageIndexById', function() {
+    it('should return index of the image with the given id', function() {
+      expect(this.utils.getImageIndexById(this.imagesList, '1')).toBe(0);
+      expect(this.utils.getImageIndexById(this.imagesList, '2')).toBe(1);
+      // TODO: should expect -1 or throw exception instead
+      expect(this.utils.getImageIndexById(this.imagesList, '0')).toBe(0);
+    });
+  });
+
+  describe('getThumbnailForCanvas', function() {
+    xit('should get the proper thumbnail for a canvas', function () {
+
+    });
+  });
 });

spec/viewer/mainMenu.js

@@ -1,4 +1,4 @@
-describe('MainMenu Class', function () {
+describe('MainMenu', function () {
 
   describe('default configuration', function() {
     beforeEach(function() {

spec/viewer/manifestListItem.test.js

@@ -1,4 +1,4 @@
-describe('viewer/manifestListItem', function () {
+describe('ManifestListItem', function () {
   xit('fetchTplData', function () {
   });
   xit('render', function () {
@@ -13,4 +13,4 @@ describe('viewer/manifestListItem', function () {
   });
   xit('show', function () {
   });
-});
+});

spec/viewer/manifestsPanel.test.js

@@ -1,4 +1,4 @@
-describe('viewer/manifestsPanel', function() {
+describe('ManifestsPanel', function() {
   beforeEach(function() {
     jasmine.getJSONFixtures().fixturesPath = 'spec/fixtures';
     this.dummyManifestContent = getJSONFixture('dummyManifest.json');
@@ -114,4 +114,4 @@ describe('viewer/manifestsPanel', function() {
     expect(this.panel.manifestListItems.length).toBe(1);
   });
 
-});
+});

spec/widgets/annotationsLayer.test.js

@@ -1,4 +1,4 @@
-describe('AnnotatinsLayer', function() {
+describe('AnnotationsLayer', function() {
 
   beforeEach(function() {
 

spec/workspaces/slot.test.js

@@ -1,4 +1,4 @@
-describe('workspaces/slot', function () {
+describe('Slot', function () {
   xit('listenForActions', function () {
   });
   xit('bindEvents', function () {
@@ -11,4 +11,4 @@ describe('workspaces/slot', function () {
   });
   xit('addItem', function () {
   });
-});
+});