diff --git a/README.md b/README.md index 518ebac..7afb129 100644 --- a/README.md +++ b/README.md @@ -100,13 +100,13 @@ starChannel.publish( { topic: "Changed", data: { typ starSubscription.unsubscribe(); ``` -### Applying ignoreDuplicates to a subscription +### Applying distinctUntilChanged to a subscription ```javascript var dupChannel = postal.channel( { topic: "WeepingAngel.*" } ), dupSubscription = dupChannel.subscribe( function( data ) { $( '
  • ' + data.value + '
    • ' ).appendTo( "#example4" ); - }).ignoreDuplicates(); + }).distinctUntilChanged(); // demonstrating multiple channels per topic being used // You can do it this way if you like, but the example above has nicer syntax (and *much* less overhead) postal.channel( { topic: "WeepingAngel.DontBlink" } ) @@ -117,6 +117,10 @@ postal.channel( { topic: "WeepingAngel.DontEvenBlink" } ) .publish( { value:"Don't Even Blink" } ); postal.channel( { topic: "WeepingAngel.DontBlink" } ) .publish( { value:"Don't Close Your Eyes" } ); +postal.channel( { topic: "WeepingAngel.DontBlink" } ) + .publish( { value:"Don't Blink" } ); +postal.channel( { topic: "WeepingAngel.DontBlink" } ) + .publish( { value:"Don't Blink" } ); dupSubscription.unsubscribe(); ``` diff --git a/example/amd/index.html b/example/amd/index.html index 6b750a2..0474260 100644 --- a/example/amd/index.html +++ b/example/amd/index.html @@ -23,7 +23,7 @@
    - Example 4 - using ignoreDuplicates() + Example 4 - using distinctUntilChanged()
    diff --git a/example/amd/js/examples.js b/example/amd/js/examples.js index 28ada81..8e9fc13 100644 --- a/example/amd/js/examples.js +++ b/example/amd/js/examples.js @@ -48,12 +48,12 @@ define( ['postal', 'postaldiags'], function ( postal, diags ) { .publish( { type : "Useless", value : "This won't trigger any subscriptions either" } ); starSubscription.unsubscribe(); - // Applying ignoreDuplicates to a subscription + // Applying distinctUntilChanged to a subscription var dupChannel = postal.channel( "WeepingAngel.*" ), dupSubscription = dupChannel.subscribe( function ( data ) { $( '
  • ' + data.value + '
    • ' ).appendTo( "#example4" ); - } ).ignoreDuplicates(); + } ).distinctUntilChanged(); postal.channel( "WeepingAngel.DontBlink" ) .publish( { value : "Don't Blink" } ); postal.channel( "WeepingAngel.DontBlink" ) @@ -62,6 +62,10 @@ define( ['postal', 'postaldiags'], function ( postal, diags ) { .publish( { value : "Don't Even Blink" } ); postal.channel( "WeepingAngel.DontBlink" ) .publish( { value : "Don't Close Your Eyes" } ); + postal.channel( "WeepingAngel.DontBlink" ) + .publish( { value : "Don't Blink" } ); + postal.channel( "WeepingAngel.DontBlink" ) + .publish( { value : "Don't Blink" } ); dupSubscription.unsubscribe(); // Using disposeAfter(X) to remove subscription automagically after X number of receives diff --git a/example/amd/js/libs/postal/postal.js b/example/amd/js/libs/postal/postal.js index e2399b7..736beab 100644 --- a/example/amd/js/libs/postal/postal.js +++ b/example/amd/js/libs/postal/postal.js @@ -152,7 +152,7 @@ SubscriptionDefinition.prototype = { return this; }, - ignoreDuplicates : function () { + distinctUntilChanged : function () { this.withConstraint( new ConsecutiveDistinctPredicate() ); return this; }, diff --git a/example/amd/js/libs/postal/postal.min.js b/example/amd/js/libs/postal/postal.min.js index b9b14d9..ef6e038 100644 --- a/example/amd/js/libs/postal/postal.min.js +++ b/example/amd/js/libs/postal/postal.min.js @@ -1 +1 @@ -define(["underscore"],function(a,b){var c="/",d=50,e=0,f="postal",g=function(){},h=function(){var b=[];return function(c){var d=!a.any(b,function(b){return a.isObject(c)||a.isArray(c)?a.isEqual(c,b):c===b});return d&&b.push(c),d}},i=function(){var b;return function(c){var d=!1;return a.isString(c)?(d=c===b,b=c):(d=a.isEqual(c,b),b=a.clone(c)),!d}},j=function(a,b){this.channel=a||c,this._topic=b||""};j.prototype={subscribe:function(){var a=arguments.length;if(a===1)return new k(this.channel,this._topic,arguments[0]);if(a===2)return new k(this.channel,arguments[0],arguments[1])},publish:function(a){var b=a||{},c={channel:this.channel,topic:this._topic,data:b};return b.topic&&b.data&&(c=b,c.channel=c.channel||this.channel),c.timeStamp=new Date,q.configuration.bus.publish(c),c},topic:function(a){return a===this._topic?this:new j(this.channel,a)}};var k=function(a,b,c){this.channel=a,this.topic=b,this.callback=c,this.priority=d,this.constraints=new Array(0),this.maxCalls=e,this.onHandled=g,this.context=null,q.configuration.bus.publish({channel:f,topic:"subscription.created",timeStamp:new Date,data:{event:"subscription.created",channel:a,topic:b}}),q.configuration.bus.subscribe(this)};k.prototype={unsubscribe:function(){q.configuration.bus.unsubscribe(this),q.configuration.bus.publish({channel:f,topic:"subscription.removed",timeStamp:new Date,data:{event:"subscription.removed",channel:this.channel,topic:this.topic}})},defer:function(){var a=this.callback;return this.callback=function(b){setTimeout(a,0,b)},this},disposeAfter:function(b){if(a.isNaN(b)||b<=0)throw"The value provided to disposeAfter (maxCalls) must be a number greater than zero.";var c=this.onHandled,d=a.after(b,a.bind(function(){this.unsubscribe(this)},this));return this.onHandled=function(){c.apply(this.context,arguments),d()},this},ignoreDuplicates:function(){return this.withConstraint(new i),this},distinct:function(){return this.withConstraint(new h),this},withConstraint:function(b){if(!a.isFunction(b))throw"Predicate constraint must be a function";return this.constraints.push(b),this},withConstraints:function(b){var c=this;return a.isArray(b)&&a.each(b,function(a){c.withConstraint(a)}),c},withContext:function(a){return this.context=a,this},withDebounce:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=a.debounce(c,b),this},withDelay:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=function(a){setTimeout(function(){c(a)},b)},this},withPriority:function(b){if(a.isNaN(b))throw"Priority must be a number";return this.priority=b,q.configuration.bus.changePriority(this),this},withThrottle:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=a.throttle(c,b),this},subscribe:function(a){return this.callback=a,this}};var l={cache:{},compare:function(a,b){if(this.cache[b]&&this.cache[b][a])return!0;var c=new RegExp("^"+a.replace(/\./g,"\\.").replace(/\*/g,".*").replace(/#/g,"[A-Z,a-z,0-9]*")+"$"),d=c.test(b);return d&&(this.cache[b]||(this.cache[b]={}),this.cache[b][a]=!0),d},reset:function(){this.cache={}}},m={addWireTap:function(a){var b=this;return b.wireTaps.push(a),function(){var c=b.wireTaps.indexOf(a);c!==-1&&b.wireTaps.splice(c,1)}},changePriority:function(b){var c,d;if(this.subscriptions[b.channel]&&this.subscriptions[b.channel][b.topic]){this.subscriptions[b.channel][b.topic]=a.without(this.subscriptions[b.channel][b.topic],b),c=this.subscriptions[b.channel][b.topic].length-1;for(;c>=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){q.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){q.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c
    - Example 4 - using ignoreDuplicates() + Example 4 - using distinctUntilChanged()
      diff --git a/example/standard/js/main.js b/example/standard/js/main.js index d1f2404..b0462fb 100644 --- a/example/standard/js/main.js +++ b/example/standard/js/main.js @@ -47,12 +47,12 @@ $( function () { .publish( { type : "Useless", value : "This won't trigger any subscriptions either" } ); starSubscription.unsubscribe(); - // Applying ignoreDuplicates to a subscription + // Applying distinctUntilChanged to a subscription var dupChannel = postal.channel( "WeepingAngel.*" ), dupSubscription = dupChannel.subscribe( function ( data ) { $( '
    • ' + data.value + '
      • ' ).appendTo( "#example4" ); - } ).ignoreDuplicates(); + } ).distinctUntilChanged(); postal.channel( "WeepingAngel.DontBlink" ) .publish( { value : "Don't Blink" } ); postal.channel( "WeepingAngel.DontBlink" ) @@ -61,6 +61,10 @@ $( function () { .publish( { value : "Don't Even Blink" } ); postal.channel( "WeepingAngel.DontBlink" ) .publish( { value : "Don't Close Your Eyes" } ); + postal.channel( "WeepingAngel.DontBlink" ) + .publish( { value : "Don't Blink" } ); + postal.channel( "WeepingAngel.DontBlink" ) + .publish( { value : "Don't Blink" } ); dupSubscription.unsubscribe(); // Using disposeAfter(X) to remove subscription automagically after X number of receives diff --git a/example/standard/js/postal.js b/example/standard/js/postal.js index d99094e..001e8cb 100644 --- a/example/standard/js/postal.js +++ b/example/standard/js/postal.js @@ -152,7 +152,7 @@ SubscriptionDefinition.prototype = { return this; }, - ignoreDuplicates : function () { + distinctUntilChanged : function () { this.withConstraint( new ConsecutiveDistinctPredicate() ); return this; }, diff --git a/example/standard/js/postal.min.js b/example/standard/js/postal.min.js index 475a3bc..62a214c 100644 --- a/example/standard/js/postal.min.js +++ b/example/standard/js/postal.min.js @@ -1 +1 @@ -(function(a,b,c){var d="/",e=50,f=0,g="postal",h=function(){},i=function(){var b;return function(c){var d=!1;return a.isString(c)?(d=c===b,b=c):(d=a.isEqual(c,b),b=a.clone(c)),!d}},j=function(){var b=[];return function(c){var d=!a.any(b,function(b){return a.isObject(c)||a.isArray(c)?a.isEqual(c,b):c===b});return d&&b.push(c),d}},k=function(a,b){this.channel=a||d,this._topic=b||""};k.prototype={subscribe:function(){var a=arguments.length;if(a===1)return new l(this.channel,this._topic,arguments[0]);if(a===2)return new l(this.channel,arguments[0],arguments[1])},publish:function(a){var b=a||{},c={channel:this.channel,topic:this._topic,data:b};return b.topic&&b.data&&(c=b,c.channel=c.channel||this.channel),c.timeStamp=new Date,r.configuration.bus.publish(c),c},topic:function(a){return a===this._topic?this:new k(this.channel,a)}};var l=function(a,b,c){this.channel=a,this.topic=b,this.callback=c,this.priority=e,this.constraints=new Array(0),this.maxCalls=f,this.onHandled=h,this.context=null,r.configuration.bus.publish({channel:g,topic:"subscription.created",timeStamp:new Date,data:{event:"subscription.created",channel:a,topic:b}}),r.configuration.bus.subscribe(this)};l.prototype={unsubscribe:function(){r.configuration.bus.unsubscribe(this),r.configuration.bus.publish({channel:g,topic:"subscription.removed",timeStamp:new Date,data:{event:"subscription.removed",channel:this.channel,topic:this.topic}})},defer:function(){var a=this.callback;return this.callback=function(b){setTimeout(a,0,b)},this},disposeAfter:function(b){if(a.isNaN(b)||b<=0)throw"The value provided to disposeAfter (maxCalls) must be a number greater than zero.";var c=this.onHandled,d=a.after(b,a.bind(function(){this.unsubscribe(this)},this));return this.onHandled=function(){c.apply(this.context,arguments),d()},this},ignoreDuplicates:function(){return this.withConstraint(new i),this},distinct:function(){return this.withConstraint(new j),this},withConstraint:function(b){if(!a.isFunction(b))throw"Predicate constraint must be a function";return this.constraints.push(b),this},withConstraints:function(b){var c=this;return a.isArray(b)&&a.each(b,function(a){c.withConstraint(a)}),c},withContext:function(a){return this.context=a,this},withDebounce:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=a.debounce(c,b),this},withDelay:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=function(a){setTimeout(function(){c(a)},b)},this},withPriority:function(b){if(a.isNaN(b))throw"Priority must be a number";return this.priority=b,r.configuration.bus.changePriority(this),this},withThrottle:function(b){if(a.isNaN(b))throw"Milliseconds must be a number";var c=this.callback;return this.callback=a.throttle(c,b),this},subscribe:function(a){return this.callback=a,this}};var m={cache:{},compare:function(a,b){if(this.cache[b]&&this.cache[b][a])return!0;var c=new RegExp("^"+a.replace(/\./g,"\\.").replace(/\*/g,".*").replace(/#/g,"[A-Z,a-z,0-9]*")+"$"),d=c.test(b);return d&&(this.cache[b]||(this.cache[b]={}),this.cache[b][a]=!0),d},reset:function(){this.cache={}}},n={addWireTap:function(a){var b=this;return b.wireTaps.push(a),function(){var c=b.wireTaps.indexOf(a);c!==-1&&b.wireTaps.splice(c,1)}},changePriority:function(b){var c,d;if(this.subscriptions[b.channel]&&this.subscriptions[b.channel][b.topic]){this.subscriptions[b.channel][b.topic]=a.without(this.subscriptions[b.channel][b.topic],b),c=this.subscriptions[b.channel][b.topic].length-1;for(;c>=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){r.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){r.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){q.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){q.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){r.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c=0;c--)if(this.subscriptions[b.channel][b.topic][c].priority<=b.priority){this.subscriptions[b.channel][b.topic].splice(c+1,0,b),d=!0;break}d||this.subscriptions[b.channel][b.topic].unshift(b)}},publish:function(b){a.each(this.wireTaps,function(a){a(b.data,b)}),a.each(this.subscriptions[b.channel],function(c){a.each(a.clone(c),function(c){r.configuration.resolver.compare(c.topic,b.topic)&&a.all(c.constraints,function(a){return a(b.data,b)})&&typeof c.callback=="function"&&(c.callback.apply(c.context,[b.data,b]),c.onHandled())})})},reset:function(){this.subscriptions&&(a.each(this.subscriptions,function(b){a.each(b,function(a){while(a.length)a.pop().unsubscribe()})}),this.subscriptions={})},subscribe:function(a){var b,c,d,e=this.subscriptions[a.channel],f;return e||(e=this.subscriptions[a.channel]={}),f=this.subscriptions[a.channel][a.topic],f||(f=this.subscriptions[a.channel][a.topic]=new Array(0)),f.push(a),a},subscriptions:{},wireTaps:new Array(0),unsubscribe:function(a){if(this.subscriptions[a.channel][a.topic]){var b=this.subscriptions[a.channel][a.topic].length,c=0;for(;c