Emit warnings if we use shortDate or shortDateTime filters

refs #1474
openhealthcare · Nov 1, 2018 · 0617ec2 · 0617ec2
1 parent 39d55b4
commit 0617ec2
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 7 deletions.
diff --git a/opal/static/js/opal/filters.js b/opal/static/js/opal/filters.js
@@ -60,8 +60,9 @@ filters.filter('fromNow', function(toMomentFilter){
 		};
 });
 
-filters.filter('shortDate', function(toMomentFilter){
+filters.filter('shortDate', function(toMomentFilter, $log){
     return function(input){
+      $log.warn('shortDate will be removed in Opal 0.14.0')
         if(!input){
             return
         }
@@ -83,9 +84,10 @@ filters.filter('shortDate', function(toMomentFilter){
     }
 });
 
-filters.filter('shortDateTime', function(shortDateFilter, hhmmFilter){
+filters.filter('shortDateTime', function(shortDateFilter, hhmmFilter, $log){
 		return function(input){
-				var datePart = shortDateFilter(input);
+          $log.warn('shortDateTime will be removed in Opal 0.14.0')
+		  var datePart = shortDateFilter(input);
 				var timePart = hhmmFilter(input);
 
 				if(datePart && timePart){
@@ -95,9 +97,10 @@ filters.filter('shortDateTime', function(shortDateFilter, hhmmFilter){
 });
 
 
-filters.filter('shortTime', function(shortDateFilter, hhmmFilter){
+filters.filter('shortTime', function(shortDateFilter, hhmmFilter, $log){
 	return function(input){
-		var toChange;
+      $log.warn('shortTime will be removed in Opal 0.14.0')
+	  var toChange;
 		if(_.isDate(input)){
 			toChange = moment(input);
 		}

diff --git a/opal/static/js/test/filters.test.js b/opal/static/js/test/filters.test.js
@@ -154,6 +154,22 @@ describe('filters', function() {
   });
 
   describe('shortDate', function() {
+    var log;
+
+    beforeEach(function(){
+      inject(function($injector){
+        log  = $injector.get('$log');
+      });
+
+      spyOn(log, 'warn');
+    });
+
+    it('should log a warning message', function() {
+       inject(function(shortDateFilter) {
+         shortDateFilter();
+         expect(log.warn).toHaveBeenCalledWith('shortDate will be removed in Opal 0.14.0');
+       });
+    });
 
     it('should return undefined for no input',
        inject(function(shortDateFilter) {
@@ -177,12 +193,20 @@ describe('filters', function() {
   });
 
   describe('shortTime', function(){
-    var shortTime;
+    var shortTime, log;
 
     beforeEach(function(){
       inject(function($injector){
         shortTime  = $injector.get('shortTimeFilter');
+        log  = $injector.get('$log');
       });
+
+      spyOn(log, 'warn');
+    });
+
+    it('should log a warning message', function() {
+      shortTime()
+      expect(log.warn).toHaveBeenCalledWith('shortTime will be removed in Opal 0.14.0')
     });
 
     it('should display the time as hh:mm from string', function(){
@@ -295,14 +319,22 @@ describe('filters', function() {
   });
 
   describe('shortDateTime', function(){
-    var shortDateTime;
+    var shortDateTime, log;
 
     beforeEach(function(){
       inject(function($injector){
         shortDateTime = $injector.get('shortDateTimeFilter');
+        log  = $injector.get('$log');
       });
+      spyOn(log, 'warn');
     });
 
+    it('should log a warning message', function() {
+      shortDateTime()
+      expect(log.warn).toHaveBeenCalledWith('shortDateTime will be removed in Opal 0.14.0')
+    });
+
+
     it('should return undefined if no input', function(){
       expect(shortDateTime(null)).toBe(undefined);
     });