Fix #80 and also add associated unit tests for limiter.

Update some package versions etc.

Author: jabbany

.npmrc

@@ -0,0 +1 @@
+package-lock = false

dist/CommentCoreLibrary.js

@@ -990,12 +990,12 @@ var CommentManager = (function() {
                 opacity:1,
                 scale:1
             },
-            limit: 0
+            limit: 0,
+            seekTrigger: 2000
         };
         this.timeline = [];
         this.runline = [];
         this.position = 0;
-        this.limiter = 0;
 
         this.factory = null;
         this.filter = null;
@@ -1111,7 +1111,9 @@ var CommentManager = (function() {
 
     CommentManager.prototype.time = function (time) {
         time = time - 1;
-        if (this.position >= this.timeline.length || Math.abs(this._lastPosition - time) >= 2000) {
+        if (this.position >= this.timeline.length ||
+          Math.abs(this._lastPosition - time) >= this.options.seekTrigger) {
+
             this.seek(time);
             this._lastPosition = time;
             if (this.timeline.length <= this.position) {
@@ -1122,7 +1124,7 @@ var CommentManager = (function() {
         }
         for (;this.position < this.timeline.length;this.position++) {
             if (this.timeline[this.position]['stime']<=time) {
-                if (this.options.limit > 0 && this.runline.length > this.limiter) {
+                if (this.options.limit > 0 && this.runline.length >= this.options.limit) {
                     continue; // Skip comments but still move the position pointer
                 } else if (this.validate(this.timeline[this.position])) {
                     this.send(this.timeline[this.position]);
@@ -1229,15 +1231,15 @@ var CommentManager = (function() {
 
 })();
 
-/** 
+/**
  * Comment Filters Module Simplified
  * @license MIT
  * @author Jim Chen
  */
 var CommentFilter = (function () {
 
     /**
-     * Matches a rule against an input that could be the full or a subset of 
+     * Matches a rule against an input that could be the full or a subset of
      * the comment data.
      *
      * @param rule - rule object to match
@@ -1275,19 +1277,22 @@ var CommentFilter = (function () {
             case '=':
             case 'eq':
                 return rule.value ===
-                    ((typeof extracted === 'number') ? 
+                    ((typeof extracted === 'number') ?
                         extracted : extracted.toString());
-            case 'NOT':
+            case '!':
+            case 'not':
                 return !_match(rule.value, extracted);
-            case 'AND':
+            case '&&':
+            case 'and':
                 if (Array.isArray(rule.value)) {
                     return rule.value.every(function (r) {
                         return _match(r, extracted);
                     });
                 } else {
                     return false;
                 }
-            case 'OR':
+            case '||':
+            case 'or':
                 if (Array.isArray(rule.value)) {
                     return rule.value.some(function (r) {
                         return _match(r, extracted);
@@ -1352,7 +1357,10 @@ var CommentFilter = (function () {
      * @return boolean indicator of whether this commentData should be shown
      */
     CommentFilter.prototype.doValidate = function (cmtData) {
-        if ((!this.allowUnknownTypes || 
+        if (!cmtData.hasOwnProperty('mode')) {
+            return false;
+        }
+        if ((!this.allowUnknownTypes ||
                 cmtData.mode.toString() in this.allowTypes) &&
             !this.allowTypes[cmtData.mode.toString()]) {
             return false;

dist/CommentCoreLibrary.min.js

@@ -26,15 +26,15 @@
 
 - Subject: (Subject) 规则绑定的对象
     比如 `subject=""` 时，则匹配整个 ICommentData 对象而 `subject="text"` 则匹配
-    弹幕文字。可以通过 `.` 来进入子属性，比如 `subject="text.length"` 则会匹配 
+    弹幕文字。可以通过 `.` 来进入子属性，比如 `subject="text.length"` 则会匹配
     `cmtData.text.length` (`cmtData` 为 ICommentData对象)。
 - Op: (Operator) 规则使用的匹配方式
     - `<`/`>`: 数字匹配 (value为number)
     - `~` 或 `regexp`: 正则匹配 (value为正则表达式对象)
     - `=` 或 `eq`: 全等匹配 (value为任何对象)
-    - `NOT`: 取反反规则，以前判定true则会返回false (value为 `rule`)
-    - `AND`: 合并规则，只有列表中所有规则都匹配才匹配 (value为 `rule[]`)
-    - `OR`: 或合并规则，只要列表中有一个匹配则匹配 (value为 `rule[]`)
+    - `!` 或 `not`: 取反反规则，以前判定true则会返回false (value为 `rule`)
+    - `&&` 或 `and`: 合并规则，只有列表中所有规则都匹配才匹配 (value为 `rule[]`)
+    - `||` 或 `or`: 或合并规则，只要列表中有一个匹配则匹配 (value为 `rule[]`)
 - Value: (Target value) 规则目标参考值
     根据 OP 的取值，可能代表不同含义
 - Mode: (Rule mode) 规则类型

docs/CommentFilter.md

@@ -13,7 +13,8 @@
 * `scroll`
   * `opacity` 透明度
   * `scale` 生命时间加成（TTL Scale）
-* `limit` 最大显示弹幕数量，0或以下表示不限制同屏弹幕数量
+* `limit` 最大显示弹幕数量，`0` 或以下表示不限制同屏弹幕数量，默认 `0`
+* `seekTrigger` 在 `time()` 调用时间数值跳跃大于这个数值（ms）时，并不输出从上一个时间到这个时间的弹幕，而是直接更新上次弹幕时间。这个数值用于避免在手动移动时间轴时导致弹幕一起输出。数值设置太大可能导致搓时间轴时大量弹幕输出，设置太小则可能导致敏感度不足而不输出弹幕。默认 `2000`
 
 ### isRunning <Bool>
 管理器的弹幕是否在运行。`false`表示没有在运行，`true`表示在运行。可以通过 start/stop 控制。这
@@ -36,11 +37,11 @@
 rendererType 决定了渲染引擎类型，默认为CSS3渲染:
 - `css`: CSS3 transition
 - `svg`: SVG Animation
-- `canvas`: Canvas 
-- `legacy`: DOM + Timer 
+- `canvas`: Canvas
+- `legacy`: DOM + Timer
 
 ### start()
-启动弹幕老化进程。调用后 `send()` 发送到运行列表（runline）的弹幕会开始移动。用于在刚刚 
+启动弹幕老化进程。调用后 `send()` 发送到运行列表（runline）的弹幕会开始移动。用于在刚刚
 `init()` 之后进入播放状态，或者在暂停弹幕后重新开始移动弹幕。播放时调用无作用。
 
 注意：在播放状态未非播放时，调用 `send()`发送的弹幕会加入 runline，在start之后一并开始移动。
@@ -77,12 +78,12 @@ runline（运行列表）里，至于这些弹幕是否在移动，则要根据
 删除只会从时间轴中删除，如果被删除的弹幕正再播放，不会导致正在播放的弹幕消失。
 
 ### remove(filterFunction:Function)
-从弹幕列表中删除弹幕。filterFunction会在每个弹幕对象上被调用。当filterFunction返回 true 
+从弹幕列表中删除弹幕。filterFunction会在每个弹幕对象上被调用。当filterFunction返回 true
 时（严格），删除相应弹幕。
 
 ### send(data:ICommentData)
 把一个抽象弹幕数据对象变成一个 IComment 并放入运行列表中。当 data 对象不符合 filter 规则或者
-时发送不会实现。代码弹幕也要通过send发送，只不过它们会进一步被派发到代码弹幕引擎。同一个 
+时发送不会实现。代码弹幕也要通过send发送，只不过它们会进一步被派发到代码弹幕引擎。同一个
 ICommentData 实例如果多次用于调用这个方法会产生多个不同的弹幕实例 IComment。
 
 注意：send可以发送不在时间轴里的弹幕。这个功能尤其利于实时弹幕的实现，因为对于直播实时弹幕，基本不

docs/CommentManager.md

@@ -11,7 +11,7 @@
     "url": "https://github.com/jabbany/CommentCoreLibrary.git"
   },
   "author": "Jim Chen <knh.jabbany@gmail.com>",
-  "license":"MIT",
+  "license": "MIT",
   "keywords": [
     "danmaku",
     "video",
@@ -30,18 +30,18 @@
     "grunt-contrib-coffee": "^1.0.0",
     "grunt-contrib-concat": "^1.0.1",
     "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-cssmin": "^2.0.0",
+    "grunt-contrib-cssmin": "^2.2.1",
     "grunt-contrib-jasmine": "^1.0.3",
     "grunt-contrib-jshint": "^1.0.0",
     "grunt-contrib-uglify": "^2.3.0",
     "grunt-contrib-watch": "^1.0.0",
     "grunt-template-jasmine-istanbul": "^0.5.0",
     "grunt-ts": "^5.5.1",
-    "jquery": "^3.1.1",
     "jasmine-jquery": "^2.0.0",
-    "sinon": "^2.1.0",
     "jasmine-sinon": "^0.4.0",
+    "jquery": "^3.1.1",
+    "load-grunt-tasks": "^3.5.2",
     "promise-polyfill": "^6.0.2",
-    "load-grunt-tasks": "^3.5.2"
+    "sinon": "^2.4.1"
   }
 }

package.json

@@ -5,18 +5,26 @@ describe 'CommentManager', ->
 
   describe 'instance API', ->
     beforeEach ->
-      c1 = stime: 1
-      c2 = stime: 2, date: '2014-07-12T04:35:55.624Z'
+      c1 =
+        stime: 1
+        mode: 1
+      c2 =
+        stime: 2
+        mode: 1
+        date: '2014-07-12T04:35:55.624Z'
       c3 =
         stime: 2
+        mode: 1
         date: '2014-07-12T04:35:55.626Z'
         dbid: '53c0bb2b6465625061b40698'
       c4 =
         stime: 2
+        mode: 1
         date: '2014-07-12T04:35:55.626Z'
         dbid: '53c0bb2b6465625061b40700'
       c5 =
         stime: 2
+        mode: 1
         date: '2014-07-12T04:35:55.626Z'
         dbid: '53c0bb2b6465625061b40700'
       cmt =
@@ -66,6 +74,27 @@ describe 'CommentManager', ->
         manager.send cmt
         expect(manager.runline.length).toBe 1
 
+    describe '.time', ->
+      it 'allocates comments to the runline', ->
+        spy = sinon.spy manager, 'send'
+        manager.load [ c3, c4, c5 ]
+        manager.time 3
+        expect(spy).toHaveBeenCalledThrice()
+
+      it 'limits based on limiter', ->
+        spy = sinon.spy manager, 'send'
+        manager.load [ c3, c4, c5 ]
+        manager.options.limit = 2
+        manager.time 3
+        expect(spy).toHaveBeenCalledTwice()
+
+      it 'seeks if seek threshold is passed', ->
+        manager.load [ c1 ]
+        manager.options.seekTrigger = 100
+        manager.time 0
+        manager.time 200
+        expect(manager.runline.length).toBe 0
+
     describe '.start', ->
       it 'starts the timer', ->
         spy = sinon.spy window, 'setInterval'
@@ -93,7 +122,7 @@ describe 'CommentManager', ->
         expect(manager.timeline).toEqual [c3, c4 , c5]
 
     describe '.setBounds', ->
-      beforeEach -> 
+      beforeEach ->
         manager.stage.style.width = '640px'
         manager.stage.style.width = '480px'
 

spec/CommentCoreLibrary_spec.coffee

@@ -15,9 +15,12 @@ describe 'CommentFilter', ->
     'date': 2000
     'size': 50
     'color': 0xff0000
+  commentNoMode =
+    'stime': 1
+    'text': 'This comment has no mode'
 
   ruleAccept =
-    'mode': 'accept' 
+    'mode': 'accept'
     'subject': 'size'
     'op': '<'
     'value': 50
@@ -29,15 +32,15 @@ describe 'CommentFilter', ->
   ruleNot =
     'mode': 'accept'
     'subject': ''
-    'op': 'NOT'
+    'op': 'not'
     'value':
       'subject': 'text.length'
       'op': '<'
       'value': 15
   ruleOr =
     'mode': 'accept'
     'subject': ''
-    'op': 'OR'
+    'op': 'or'
     'value': [
       {
         'subject': 'date'
@@ -55,7 +58,7 @@ describe 'CommentFilter', ->
     beforeEach ->
       filter = new CommentFilter()
 
-    'doModify beforeSend doValidate addRule 
+    'doModify beforeSend doValidate addRule
     addModifier'.split(/\s/).forEach (method)->
 
       it "has method: '#{method}'", ->
@@ -102,9 +105,12 @@ describe 'CommentFilter', ->
         filter.allowTypes['1'] = false
         expect(filter.doValidate comment).toBe false
 
+      it 'fails validation on no-mode comments', ->
+        expect(filter.doValidate commentNoMode).toBe false
+
       it 'passes validation unknown mode', ->
         expect(filter.doValidate alienModeComment).toBe true
-      
+
       it 'fails validation if allowUnknownTypes false', ->
         filter.allowUnknownTypes = false
         expect(filter.doValidate alienModeComment).toBe false
@@ -113,7 +119,7 @@ describe 'CommentFilter', ->
         filter.addRule ruleAccept
         expect(filter.doValidate comment).toBe true
         expect(filter.doValidate commentAlt).toBe false
-      
+
       it 'executes reject rules', ->
         filter.addRule ruleReject
         expect(filter.rules.length).toBe 1
@@ -149,9 +155,9 @@ describe 'CommentFilter', ->
         expect(filter.rules[0]).toBe rule
 
       it 'rejects adding invalid rule', ->
-        expect( => 
+        expect( =>
           filter.addRule
-            'mode': '???').toThrow()          
+            'mode': '???').toThrow()
 
     describe '.addModifier', ->
       modifier = (cmt) ->
@@ -165,4 +171,3 @@ describe 'CommentFilter', ->
 
       it 'rejects invalid modifier', ->
         expect( => filter.addModifier 'Boo').toThrow()
-

spec/filter/CommentFilter_spec.coffee

@@ -46,12 +46,12 @@ var CommentManager = (function() {
                 opacity:1,
                 scale:1
             },
-            limit: 0
+            limit: 0,
+            seekTrigger: 2000
         };
         this.timeline = [];
         this.runline = [];
         this.position = 0;
-        this.limiter = 0;
 
         this.factory = null;
         this.filter = null;
@@ -167,7 +167,9 @@ var CommentManager = (function() {
 
     CommentManager.prototype.time = function (time) {
         time = time - 1;
-        if (this.position >= this.timeline.length || Math.abs(this._lastPosition - time) >= 2000) {
+        if (this.position >= this.timeline.length ||
+          Math.abs(this._lastPosition - time) >= this.options.seekTrigger) {
+
             this.seek(time);
             this._lastPosition = time;
             if (this.timeline.length <= this.position) {
@@ -178,7 +180,7 @@ var CommentManager = (function() {
         }
         for (;this.position < this.timeline.length;this.position++) {
             if (this.timeline[this.position]['stime']<=time) {
-                if (this.options.limit > 0 && this.runline.length > this.limiter) {
+                if (this.options.limit > 0 && this.runline.length >= this.options.limit) {
                     continue; // Skip comments but still move the position pointer
                 } else if (this.validate(this.timeline[this.position])) {
                     this.send(this.timeline[this.position]);