deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-06 16:02:39 +02:00
Code Issues Releases Wiki Activity

Merge pull request #175 from koalyptus/issue-43-persistence

Browse source 
Issue 43 persistence
This commit is contained in:
koalyptus 2016-04-08 18:36:33 +02:00
parent 135af7bfda 2eae85d950
commit 6d92ea3979
21 changed files with 542 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
dist/starter.html vendored
View file

@ -1,10 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>tablefilter v0.2.8 - Starter</title>
<title>tablefilter v0.2.9 - Starter</title>
</head>
<body>
<h1>tablefilter v0.2.8</h1>
<h1>tablefilter v0.2.9</h1>

4
dist/tablefilter/style/colsVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
span.colVisSpan{text-align:left;}span.colVisSpan a.colVis{display:inline-block;padding:7px 5px 0;font-size:inherit;font-weight:inherit;vertical-align:top}div.colVisCont{position:relative;background:#fff;-webkit-box-shadow:3px 3px 2px #888;-moz-box-shadow:3px 3px 2px #888;box-shadow:3px 3px 2px #888;position:absolute;display:none;border:1px solid #ccc;height:auto;width:250px;background-color:#fff;margin:35px 0 0 -100px;z-index:10000;padding:10px 10px 10px 10px;text-align:left;font-size:12px;}div.colVisCont:after,div.colVisCont:before{bottom:100%;left:50%;border:solid transparent;content:" ";height:0;width:0;position:absolute;pointer-events:none}div.colVisCont:after{border-color:rgba(255,255,255,0);border-bottom-color:#fff;border-width:10px;margin-left:-10px}div.colVisCont:before{border-color:rgba(255,255,255,0);border-bottom-color:#ccc;border-width:12px;margin-left:-12px}div.colVisCont p{margin:6px auto 6px auto}div.colVisCont a.colVis{display:initial;font-weight:inherit}ul.cols_checklist{padding:0;margin:0;list-style:none;}ul.cols_checklist label{display:block}ul.cols_checklist input{vertical-align:middle;margin:2px 5px 2px 1px}li.cols_checklist_item{padding:4px;margin:0;}li.cols_checklist_item:hover{background-color:#335ea8;color:#fff}.cols_checklist_slc_item{background-color:#335ea8;color:#fff}

4
dist/tablefilter/style/filtersVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
span.expClpFlt a.btnExpClpFlt{width:35px;height:35px;display:inline-block;}span.expClpFlt a.btnExpClpFlt:hover{background-color:#f4f4f4}span.expClpFlt img{padding:8px 11px 11px 11px}

4
dist/tablefilter/style/tablefilter.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
.activeHeader{background-color:#66afe9 !important;color:#fff !important}

4
dist/tablefilter/style/themes/default/default.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
table.TF{border-left:1px solid #ccc;border-top:none;border-right:none;border-bottom:none;}table.TF th{background:#ebecee url("images/bg_th.jpg") left top repeat-x;border-bottom:1px solid #d0d0d0;border-right:1px solid #d0d0d0;border-left:1px solid #fff;border-top:1px solid #fff;color:#333}table.TF td{border-bottom:1px dotted #999;padding:5px}.fltrow{background-color:#ebecee !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #666 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #999 !important}input.flt{width:99% !important}.inf{height:$min-height;background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important}input.reset{background:transparent url("images/btn_eraser.gif") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;}.nextPage:hover{background:transparent url("images/btn_over_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important;}.previousPage:hover{background:transparent url("images/btn_over_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;}.firstPage:hover{background:transparent url("images/btn_over_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;}.lastPage:hover{background:transparent url("images/btn_over_last_page.gif") center center no-repeat !important}div.grd_Cont{background-color:#ebecee !important;border:1px solid #ccc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#d5d5d5}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important;}div.grd_headTblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#ebecee url("images/bg_th.jpg") left top repeat-x !important;border-bottom:1px solid #d0d0d0 !important;border-right:1px solid #d0d0d0 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #999 !important}.grd_inf{background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important;border-top:1px solid #d0d0d0 !important}.loader{border:1px solid #999}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#fff}.odd{background-color:#d5d5d5}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#999 !important}

4
dist/tablefilter/style/themes/mytheme/mytheme.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
table.TF{border-left:1px dotted #81963b;border-top:none;border-right:0;border-bottom:none;}table.TF th{background:#39424b url("images/bg_headers.jpg") left top repeat-x;border-bottom:0;border-right:1px dotted #d0d0d0;border-left:0;border-top:0;color:#fff}table.TF td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b;padding:5px}.fltrow{background-color:#81963b !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #687830 !important}input.flt{width:99% !important}.inf{background:#d8d8d8;height:$min-height}input.reset{width:53px;background:transparent url("images/btn_filter.png") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important}div.grd_Cont{background:#81963b url("images/bg_headers.jpg") left top repeat-x !important;border:1px solid #ccc !important;padding:0 1px 1px 1px !important;}div.grd_Cont .even{background-color:#bccd83}div.grd_Cont .odd{background-color:#fff}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important;}div.grd_tblCont table td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b}div.grd_tblCont table th,div.grd_headTblCont table th{background:transparent url("images/bg_headers.jpg") 0 0 repeat-x !important;border-bottom:0 !important;border-right:1px dotted #d0d0d0 !important;border-left:0 !important;border-top:0 !important;padding:0 4px 0 4px !important;color:#fff !important;height:35px !important}div.grd_headTblCont table td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;background-color:#81963b !important;padding:1px 3px 1px 3px !important}.grd_inf{background-color:#d8d8d8;border-top:1px solid #d0d0d0 !important}.loader{border:0 !important;background:#81963b !important}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#bccd83}.odd{background-color:#fff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#81963b !important}

4
dist/tablefilter/style/themes/skyblue/skyblue.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.8 by Max Guglielmi
* build date: 2016-04-06T06:46:57.114Z
* tablefilter v0.2.9 by Max Guglielmi
* build date: 2016-04-08T16:16:27.440Z
* MIT License
*/
table.TF{padding:0;color:#000;border-right:1px solid #a4bed4;border-top:1px solid #a4bed4;border-left:1px solid #a4bed4;border-bottom:0;}table.TF th{margin:0;color:inherit;background:#d1e5fe url("images/bg_skyblue.gif") 0 0 repeat-x;border-color:#fdfdfd #a4bed4 #a4bed4 #fdfdfd;border-width:1px;border-style:solid}table.TF td{margin:0;padding:5px;color:inherit;border-bottom:1px solid #a4bed4;border-left:0;border-top:0;border-right:0}.fltrow{background-color:#d1e5fe !important;}.fltrow th,.fltrow td{padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #a4bed4 !important}input.flt{width:99% !important}.inf{background-color:#e3efff !important;border:1px solid #a4bed4;height:$min-height;color:#004a6f}div.tot,div.status{border-right:0 !important}.helpBtn:hover{background-color:transparent}input.reset{background:transparent url("images/icn_clear_filters.png") center center no-repeat !important}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.nextPage:hover{background:#ffe4ab url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.previousPage{background:transparent url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.previousPage:hover{background:#ffe4ab url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.firstPage:hover{background:#ffe4ab url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.lastPage:hover{background:#ffe4ab url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.activeHeader{background:#ffe4ab !important;border:1px solid #ffb552 !important;color:inherit !important}div.grd_Cont{background-color:#d9eaed !important;border:1px solid #9cc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#e3efff}div.grd_headTblCont{background-color:#d9eaed !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#d9eaed url("images/bg_skyblue.gif") left top repeat-x;border-bottom:1px solid #a4bed4;border-right:1px solid #a4bed4 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #a4bed4 !important;border-right:0 !important;border-left:0 !important;border-top:0 !important}.grd_inf{background-color:#cce2fe;color:#004a6f;border-top:1px solid #9cc !important;}.grd_inf a{text-decoration:none;font-weight:bold}.loader{background-color:#2d8eef;border:1px solid #cce2fe;border-radius:5px}.even{background-color:#fff}.odd{background-color:#e3efff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.ezActiveRow{background-color:#ffdc61 !important;color:inherit}.ezSelectedRow{background-color:#ffe4ab !important;color:inherit}.ezActiveCell{background-color:#fff !important;color:#000 !important;font-weight:bold}.ezETSelectedCell{background-color:#fff !important;font-weight:bold;color:#000 !important}

12
dist/tablefilter/tablefilter.js vendored
View file

File diff suppressed because one or more lines are too long

6
dist/tablefilter/tf-1.js vendored
View file

File diff suppressed because one or more lines are too long

2
package.json
View file

@ -1,6 +1,6 @@
{
"name": "tablefilter",
"version": "0.2.8",
"version": "0.2.9",
"description": "A Javascript library making HTML tables filterable and a bit more",
"license": "MIT",
"author": {

14
src/modules/hash.js
View file

@ -81,20 +81,12 @@ export class Hash {
if (!state) {
return;
}
// To prevent state to react to features changes, state is temporarily
// disabled
this.state.disable();
// State is overriden with hash state object
this.state.override(state);
// New hash state is applied to features
this.state.sync();
// State is re-enabled
this.state.enable();
// override current state with persisted one and sync features
this.state.overrideAndSync(state);
}
/**
* Destroy Hash instance
* Release Hash event subscriptions and clear fields
*/
destroy() {
this.emitter.off(['state-changed'], (tf, state) => this.update(state));

38
src/modules/state.js
View file

@ -1,5 +1,6 @@
import {Feature} from './feature';
import {Hash} from './hash';
import {Storage} from './storage';
import Str from '../string';
import Types from '../types';
@ -23,12 +24,17 @@ export class State extends Feature {
let cfg = this.config.state;
// hash enabled by default if state setting is simply set true
this.enableHash = (cfg.types && cfg.types.indexOf('hash') !== -1) ||
tf.state === true;
this.enableHash = cfg === true ||
(Types.isObj(cfg.types) && cfg.types.indexOf('hash') !== -1);
this.enableLocalStorage = Types.isObj(cfg.types) &&
cfg.types.indexOf('local_storage') !== -1;
this.enableCookie = Types.isObj(cfg.types) &&
cfg.types.indexOf('cookie') !== -1;
this.persistFilters = cfg.filters === false ? false : true;
this.persistPageNumber = Boolean(cfg.page_number);
this.persistPageLength = Boolean(cfg.page_length);
this.cookieDuration = !isNaN(cfg.cookie_duration) ?
parseInt(cfg.cookie_duration, 10) : 87600;
this.hash = null;
this.pageNb = null;
@ -58,6 +64,10 @@ export class State extends Feature {
this.hash = new Hash(this);
this.hash.init();
}
if (this.enableLocalStorage || this.enableCookie) {
this.storage = new Storage(this);
this.storage.init();
}
this.initialized = true;
}
@ -167,6 +177,23 @@ export class State extends Feature {
}
}
/**
* Override current state with passed one and sync features
*
* @param state State object
*/
overrideAndSync(state) {
// To prevent state to react to features changes, state is temporarily
// disabled
this.disable();
// State is overriden with passed state object
this.override(state);
// New hash state is applied to features
this.sync();
// State is re-enabled
this.enable();
}
/**
* Destroy State instance
*/
@ -188,6 +215,11 @@ export class State extends Feature {
this.hash = null;
}
if (this.enableLocalStorage || this.enableCookie) {
this.storage.destroy();
this.storage = null;
}
this.initialized = false;
}
}

123
src/modules/storage.js Normal file
View file

@ -0,0 +1,123 @@
import Cookie from '../cookie';
const global = window;
const JSON = global.JSON;
const localStorage = global.localStorage;
const location = global.location;
export const hasStorage = () => {
return 'Storage' in global;
};
/**
* Stores the features state in browser's local storage or cookie
*
* @export
* @class Storage
*/
export class Storage {
/**
* Creates an instance of Storage
*
* @param {State} state Instance of State
*/
constructor(state) {
this.state = state;
this.tf = state.tf;
this.enableLocalStorage = state.enableLocalStorage && hasStorage();
this.enableCookie = state.enableCookie && !this.enableLocalStorage;
this.emitter = state.emitter;
this.duration = state.cookieDuration;
}
/**
* Initializes the Storage object
*/
init() {
this.emitter.on(['state-changed'], (tf, state) => this.save(state));
this.emitter.on(['initialized'], () => this.sync());
}
/**
* Persists the features state on state changes
*
* @param {State} state Instance of State
*/
save(state) {
if (this.enableLocalStorage) {
localStorage[this.getKey()] = JSON.stringify(state);
} else {
Cookie.write(this.getKey(), JSON.stringify(state), this.duration);
}
}
/**
* Turns stored string into a State JSON object
*
* @returns {Object} JSON object
*/
retrieve() {
let state = null;
if (this.enableLocalStorage) {
state = localStorage[this.getKey()];
} else {
state = Cookie.read(this.getKey());
}
if (!state) {
return null;
}
return JSON.parse(state);
}
/**
* Removes persisted state from storage
*/
remove() {
if (this.enableLocalStorage) {
localStorage.removeItem(this.getKey());
} else {
Cookie.remove(this.getKey());
}
}
/**
* Applies persisted state to features
*/
sync() {
let state = this.retrieve();
if (!state) {
return;
}
// override current state with persisted one and sync features
this.state.overrideAndSync(state);
}
/**
* Returns the storage key
*
* @returns {String} Key
*/
getKey() {
return JSON.stringify({
key: `${this.tf.prfxTf}_${this.tf.id}`,
path: location.pathname
});
}
/**
* Release Storage event subscriptions and clear fields
*/
destroy() {
this.emitter.off(['state-changed'], (tf, state) => this.save(state));
this.emitter.off(['initialized'], () => this.sync());
this.remove();
this.state = null;
this.emitter = null;
}
}

17
src/tablefilter.js
View file

@ -1634,7 +1634,7 @@ export class TableFilter {
}
/**
* Return the ID of the filter of a specified column
* Return the ID of a specified column's filter
* @param {Number} index Column's index
* @return {String} ID of the filter element
*/
@ -2064,6 +2064,17 @@ export class TableFilter {
return parseInt(idx, 10);
}
/**
* Make specified column's filter active
* @param colIndex Index of a column
*/
activateFilter(colIndex){
if(Types.isUndef(colIndex)){
return;
}
this.setActiveFilterId(this.getFilterId(colIndex));
}
/**
* Refresh the filters subject to linking ('select', 'multiple',
* 'checklist' type)
@ -2079,10 +2090,10 @@ export class TableFilter {
slcIndex = slcIndex.concat(slcA3);
let activeIdx = this.getColumnIndexFromFilterId(this.activeFilterId);
let slcSelectedValue;
for(let i=0, len=slcIndex.length; i<len; i++){
let curSlc = Dom.id(this.fltIds[slcIndex[i]]);
slcSelectedValue = this.getFilterValue(slcIndex[i]);
let slcSelectedValue = this.getFilterValue(slcIndex[i]);
// Welcome to cyclomatic complexity hell :)
// TODO: simplify/refactor if statement

11
test/test-api.js
View file

@ -108,6 +108,17 @@
deepEqual(colIndex, 3, 'Column index');
});
test('Activate filter for a specified column', function() {
//set
var filterId = 'flt3_demo';
//act
tf.activateFilter(3);
//assert
deepEqual(tf.getActiveFilterId(), filterId, 'Filter active');
});
test('Clear filters', function() {
tf.clearFilters();
deepEqual(tf.nbVisibleRows, 7, 'Filtered rows number');

2
test/test-hash.js
View file

@ -2,7 +2,7 @@
var tf = new TableFilter('demo', {
base_path: '../dist/tablefilter/',
state: {
type: ['hash'],
types: ['hash'],
filters: true,
page_number: true,
page_length: true

13
test/test-state.js
View file

@ -66,6 +66,19 @@ test('Can override state', function() {
'State field overriden');
});
test('Can override and sync state', function() {
// setup
state.state = {};
// act
state.overrideAndSync({ 'col_2': { 'flt': '1412' } });
// assert
deepEqual(state.state, { 'col_2': { 'flt': '1412' } },
'State field overriden');
deepEqual(tf.getValidRows(), [2], 'Table filters are synced');
});
test('Can update page number', function() {
// setup
state.persistPageNumber = true;

78
test/test-storage-cookie.html Normal file
View file

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>TableFilter cookie storage persistence</title>
<link rel="stylesheet" href="libs/qunit/qunit.css">
<script src="libs/qunit/qunit.js"></script>
<script src="libs/polyfill.js"></script>
</head>
<body>
<table id="demo" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<th>From</th>
<th>Destination</th>
<th>Road Distance (km)</th>
<th>By Air (hrs)</th>
<th>By Rail (hrs)</th>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Adelaide</td>
<td>1412</td>
<td>1.4</td>
<td>25.3</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Brisbane</td>
<td>982</td>
<td>1.5</td>
<td>16</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Canberra</td>
<td>286</td>
<td>.6</td>
<td>4.3</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Melbourne</td>
<td>872</td>
<td>1.1</td>
<td>10.5</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Perth</td>
<td>2781</td>
<td>3.1</td>
<td>38</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Alice Springs</td>
<td>1533</td>
<td>2</td>
<td>20.25</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Brisbane</td>
<td>2045</td>
<td>2.15</td>
<td>40</td>
</tr>
</tbody>
</table>
<script src="../dist/tablefilter/tablefilter.js"></script>
<script src="test-storage-cookie.js"></script>
<div id="qunit"></div>
<div id="qunit-fixture"></div>
</body>
</html>

81
test/test-storage-cookie.js Normal file
View file

@ -0,0 +1,81 @@
var tf = new TableFilter('demo', {
base_path: '../dist/tablefilter/',
state: {
types: ['cookie'],
filters: true,
page_number: true,
page_length: true
},
paging: true,
results_per_page: ['Records: ', [2, 4, 6]],
});
tf.init();
var state = tf.feature('state');
var storage = state.storage;
module('Sanity checks');
test('State instance', function() {
deepEqual(typeof storage, 'object', 'Storage is instantiated');
deepEqual(storage.enableCookie, true, 'Cookies enabled');
deepEqual(storage.enableLocalStorage, false, 'Local storage disabled');
deepEqual(storage.state, state, 'State instance');
deepEqual(storage.emitter, state.emitter, 'Emitter instance');
});
module('Behaviour');
test('Can save and retrieve state', function() {
// setup
var stateObj = {
'page': 2,
'page_length': 4,
'col_2': {'flt': '>500'}
};
// act
state.emitter.emit('state-changed', tf, stateObj);
// assert
deepEqual(storage.retrieve(), stateObj, 'State saved');
});
test('Can sync state', function() {
// setup
storage.save({'page':2,'page_length':4,'col_2':{'flt':'>500'}});
// act
storage.sync();
// assert
deepEqual(tf.getValidRows(), [2,3,5,6,7,8], 'Table filters are synced');
});
test('Can remove state', function() {
// setup
storage.save({'page':2,'page_length':4,'col_2':{'flt':'>500'}});
// act
storage.remove();
// assert
deepEqual(storage.retrieve(), null, 'State removed from storage');
});
test('Can get storage key', function() {
// assert
deepEqual(storage.getKey(),
'{"key":"TF_demo","path":"/test/test-storage-cookie.html"}',
'Storage key returned'
);
});
module('Tear-down');
test('Can destroy', function() {
// act
storage.destroy();
// assert
deepEqual(storage.state, null, 'State instance is null');
deepEqual(storage.emitter, null, 'Emitter instance is null');
deepEqual(storage.retrieve(), null, 'Persisted state cleared');
});

78
test/test-storage-local.html Normal file
View file

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>TableFilter local storage persistence</title>
<link rel="stylesheet" href="libs/qunit/qunit.css">
<script src="libs/qunit/qunit.js"></script>
<script src="libs/polyfill.js"></script>
</head>
<body>
<table id="demo" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<th>From</th>
<th>Destination</th>
<th>Road Distance (km)</th>
<th>By Air (hrs)</th>
<th>By Rail (hrs)</th>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Adelaide</td>
<td>1412</td>
<td>1.4</td>
<td>25.3</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Brisbane</td>
<td>982</td>
<td>1.5</td>
<td>16</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Canberra</td>
<td>286</td>
<td>.6</td>
<td>4.3</td>
</tr>
<tr>
<td><strong>Sydney</strong></td>
<td>Melbourne</td>
<td>872</td>
<td>1.1</td>
<td>10.5</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Perth</td>
<td>2781</td>
<td>3.1</td>
<td>38</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Alice Springs</td>
<td>1533</td>
<td>2</td>
<td>20.25</td>
</tr>
<tr>
<td><strong>Adelaide</strong></td>
<td>Brisbane</td>
<td>2045</td>
<td>2.15</td>
<td>40</td>
</tr>
</tbody>
</table>
<script src="../dist/tablefilter/tablefilter.js"></script>
<script src="test-storage-local.js"></script>
<div id="qunit"></div>
<div id="qunit-fixture"></div>
</body>
</html>

81
test/test-storage-local.js Normal file
View file

@ -0,0 +1,81 @@
var tf = new TableFilter('demo', {
base_path: '../dist/tablefilter/',
state: {
types: ['local_storage'],
filters: true,
page_number: true,
page_length: true
},
paging: true,
results_per_page: ['Records: ', [2, 4, 6]],
});
tf.init();
var state = tf.feature('state');
var storage = state.storage;
module('Sanity checks');
test('State instance', function() {
deepEqual(typeof storage, 'object', 'Storage is instantiated');
deepEqual(storage.enableLocalStorage, true, 'Local storage enabled');
deepEqual(storage.enableCookie, false, 'Cookies disabled');
deepEqual(storage.state, state, 'State instance');
deepEqual(storage.emitter, state.emitter, 'Emitter instance');
});
module('Behaviour');
test('Can save and retrieve state', function() {
// setup
var stateObj = {
'page': 2,
'page_length': 4,
'col_2': {'flt': '>500'}
};
// act
state.emitter.emit('state-changed', tf, stateObj);
// assert
deepEqual(storage.retrieve(), stateObj, 'State saved');
});
test('Can sync state', function() {
// setup
storage.save({'page':2,'page_length':4,'col_2':{'flt':'>500'}});
// act
storage.sync();
// assert
deepEqual(tf.getValidRows(), [2,3,5,6,7,8], 'Table filters are synced');
});
test('Can remove state', function() {
// setup
storage.save({'page':2,'page_length':4,'col_2':{'flt':'>500'}});
// act
storage.remove();
// assert
deepEqual(storage.retrieve(), null, 'State removed from storage');
});
test('Can get storage key', function() {
// assert
deepEqual(storage.getKey(),
'{"key":"TF_demo","path":"/test/test-storage-local.html"}',
'Storage key returned'
);
});
module('Tear-down');
test('Can destroy', function() {
// act
storage.destroy();
// assert
deepEqual(storage.state, null, 'State instance is null');
deepEqual(storage.emitter, null, 'Emitter instance is null');
deepEqual(storage.retrieve(), null, 'Persisted state cleared');
});