mediawiki-extensions-Echo/tests/qunit/model/test_mw.echo.dm.CrossWikiNotificationItem.js

( function ( mw, $ ) {
	var defaults = {
		getModelName: 'xwiki',
		getSourceNames: [],
		getCount: 0,
		hasUnseen: false,
		getItems: [],
		isEmpty: true
	};

	QUnit.module( 'ext.echo.dm - mw.echo.dm.CrossWikiNotificationItem' );

	QUnit.test( 'Constructing the model', function ( assert ) {
		var i, method, model,
			cases = [
				{
					params: {
						id: -1,
						config: {}
					},
					expected: defaults,
					msg: 'Default values'
				},
				{
					params: {
						id: -1,
						config: { modelName: 'foo' }
					},
					expected: $.extend( true, {}, defaults, {
						getModelName: 'foo'
					} ),
					msg: 'Overriding model name'
				},
				{
					params: {
						id: -1,
						config: { count: 10 }
					},
					expected: $.extend( true, {}, defaults, {
						getCount: 10
					} ),
					msg: 'Overriding model count'
				}
			];

		for ( i = 0; i < cases.length; i++ ) {
			model = new mw.echo.dm.CrossWikiNotificationItem(
				cases[ i ].params.id,
				cases[ i ].params.config
			);

			for ( method in defaults ) {
				assert.deepEqual(
					// Method
					model[ method ](),
					// Expected value
					cases[ i ].expected[ method ],
					cases[ i ].msg + ' (' + method + ')'
				);
			}
		}
	} );

	QUnit.test( 'Managing notification lists', function ( assert ) {
		var i, j,
			model = new mw.echo.dm.CrossWikiNotificationItem( 1 ),
			groupDefinitions = [
				{
					name: 'foo',
					sourceData: {
						title: 'Foo Wiki',
						base: 'http://foo.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 0, { source: 'foo', read: false, seen: false, timestamp: '201601010100' } ),
						new mw.echo.dm.NotificationItem( 1, { source: 'foo', read: false, seen: false, timestamp: '201601010200' } ),
						new mw.echo.dm.NotificationItem( 2, { source: 'foo', read: false, seen: false, timestamp: '201601010300' } )
					]
				},
				{
					name: 'bar',
					sourceData: {
						title: 'Bar Wiki',
						base: 'http://bar.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 3, { source: 'bar', read: false, seen: false, timestamp: '201601020000' } ),
						new mw.echo.dm.NotificationItem( 4, { source: 'bar', read: false, seen: false, timestamp: '201601020100' } ),
						new mw.echo.dm.NotificationItem( 5, { source: 'bar', read: false, seen: false, timestamp: '201601020200' } ),
						new mw.echo.dm.NotificationItem( 6, { source: 'bar', read: false, seen: false, timestamp: '201601020300' } )
					]
				},
				{
					name: 'baz',
					sourceData: {
						title: 'Baz Wiki',
						base: 'http://baz.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 7, { source: 'baz', timestamp: '201601050100' } )
					]
				}
			];

		// Add groups to model
		for ( i = 0; i < groupDefinitions.length; i++ ) {
			model.getList().addGroup(
				groupDefinitions[ i ].name,
				groupDefinitions[ i ].sourceData,
				groupDefinitions[ i ].items
			);
		}

		assert.deepEqual(
			model.getSourceNames(),
			[ 'baz', 'bar', 'foo' ],
			'Model source names exist in order'
		);
		assert.equal(
			model.hasUnseen(),
			true,
			'hasUnseen is true if there are unseen items in any group'
		);

		// Mark all items as seen except one
		for ( i = 0; i < groupDefinitions.length; i++ ) {
			for ( j = 0; j < groupDefinitions[ i ].items.length; j++ ) {
				groupDefinitions[ i ].items[ j ].toggleSeen( true );
			}
		}
		groupDefinitions[ 0 ].items[ 0 ].toggleSeen( false );
		assert.equal(
			model.hasUnseen(),
			true,
			'hasUnseen is true even if only one item in one group is unseen'
		);

		groupDefinitions[ 0 ].items[ 0 ].toggleSeen( true );
		assert.equal(
			model.hasUnseen(),
			false,
			'hasUnseen is false if there are no unseen items in any of the groups'
		);

		// Discard group
		model.getList().removeGroup( 'foo' );
		assert.deepEqual(
			model.getSourceNames(),
			[ 'baz', 'bar' ],
			'Group discarded successfully'
		);
	} );

	QUnit.test( 'Update seen state', function ( assert ) {
		var i, numUnseenItems, numAllItems,
			model = new mw.echo.dm.CrossWikiNotificationItem( 1 ),
			groupDefinitions = [
				{
					name: 'foo',
					sourceData: {
						title: 'Foo Wiki',
						base: 'http://foo.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 0, { source: 'foo', read: false, seen: false, timestamp: '201601010100' } ),
						new mw.echo.dm.NotificationItem( 1, { source: 'foo', read: false, seen: false, timestamp: '201601010200' } ),
						new mw.echo.dm.NotificationItem( 2, { source: 'foo', read: false, seen: false, timestamp: '201601010300' } )
					]
				},
				{
					name: 'bar',
					sourceData: {
						title: 'Bar Wiki',
						base: 'http://bar.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 3, { source: 'bar', read: false, seen: false, timestamp: '201601020000' } ),
						new mw.echo.dm.NotificationItem( 4, { source: 'bar', read: false, seen: false, timestamp: '201601020100' } ),
						new mw.echo.dm.NotificationItem( 5, { source: 'bar', read: false, seen: false, timestamp: '201601020200' } ),
						new mw.echo.dm.NotificationItem( 6, { source: 'bar', read: false, seen: false, timestamp: '201601020300' } )
					]
				},
				{
					name: 'baz',
					sourceData: {
						title: 'Baz Wiki',
						base: 'http://baz.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 7, { source: 'baz', timestamp: '201601050100' } )
					]
				}
			];

		// Count all actual items
		numAllItems = groupDefinitions.reduce( function ( prev, curr ) {
			return prev + curr.items.length;
		}, 0 );

		// Add groups to model
		for ( i = 0; i < groupDefinitions.length; i++ ) {
			model.getList().addGroup(
				groupDefinitions[ i ].name,
				groupDefinitions[ i ].sourceData,
				groupDefinitions[ i ].items
			);
		}

		numUnseenItems = model.getItems().filter( function ( item ) {
			return !item.isSeen();
		} ).length;
		assert.equal(
			numUnseenItems,
			numAllItems,
			'Starting state: all items are unseen'
		);

		// Update seen time to be bigger than 'foo' but smaller than the other groups
		model.updateSeenState( '201601010400' );

		numUnseenItems = model.getItems().filter( function ( item ) {
			return !item.isSeen();
		} ).length;
		assert.equal(
			numUnseenItems,
			numAllItems - groupDefinitions[ 0 ].items.length,
			'Only some items are seen'
		);

		// Update seen time to be bigger than all
		model.updateSeenState( '201701010000' );

		numUnseenItems = model.getItems().filter( function ( item ) {
			return !item.isSeen();
		} ).length;
		assert.equal(
			numUnseenItems,
			0,
			'All items are seen'
		);
	} );

	QUnit.test( 'Emit discard event', function ( assert ) {
		var i,
			results = [],
			model = new mw.echo.dm.CrossWikiNotificationItem( -1 ),
			groupDefinitions = [
				{
					name: 'foo',
					sourceData: {
						title: 'Foo Wiki',
						base: 'http://foo.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 0, { source: 'foo', read: false, seen: false, timestamp: '201601010100' } ),
						new mw.echo.dm.NotificationItem( 1, { source: 'foo', read: false, seen: false, timestamp: '201601010200' } ),
						new mw.echo.dm.NotificationItem( 2, { source: 'foo', read: false, seen: false, timestamp: '201601010300' } )
					]
				},
				{
					name: 'bar',
					sourceData: {
						title: 'Bar Wiki',
						base: 'http://bar.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 3, { source: 'bar', read: false, seen: false, timestamp: '201601020000' } ),
						new mw.echo.dm.NotificationItem( 4, { source: 'bar', read: false, seen: false, timestamp: '201601020100' } ),
						new mw.echo.dm.NotificationItem( 5, { source: 'bar', read: false, seen: false, timestamp: '201601020200' } ),
						new mw.echo.dm.NotificationItem( 6, { source: 'bar', read: false, seen: false, timestamp: '201601020300' } )
					]
				},
				{
					name: 'baz',
					sourceData: {
						title: 'Baz Wiki',
						base: 'http://baz.wiki.sample/$1'
					},
					items: [
						new mw.echo.dm.NotificationItem( 7, { source: 'baz', timestamp: '201601050100' } )
					]
				}
			];

		// Add groups to model
		for ( i = 0; i < groupDefinitions.length; i++ ) {
			model.getList().addGroup(
				groupDefinitions[ i ].name,
				groupDefinitions[ i ].sourceData,
				groupDefinitions[ i ].items
			);
		}

		// Listen to event
		model.on( 'discard', function ( name ) {
			results.push( name );
		} );

		// Trigger
		model.getList().removeGroup( 'foo' ); // [ 'foo' ]
		// Empty a list
		model.getList().getGroupByName( 'baz' ).discardItems( groupDefinitions[ 2 ].items ); // [ 'foo', 'baz' ]

		assert.deepEqual(
			results,
			[ 'foo', 'baz' ],
			'Discard event emitted'
		);
	} );

}( mediaWiki, jQuery ) );