@bennerinformatics/ember-fw-table 2.0.16 → 2.0.18

package/addon/components/fw-pagination-wrapper.js

@@ -1,470 +1,470 @@
-import Component from '@ember/component';
-import {computed} from '@ember/object';
-import {empty, filterBy} from '@ember/object/computed';
-import {inject} from '@ember/service';
-import {isEmpty, isNone} from '@ember/utils';
-import {handleAjaxError} from '@bennerinformatics/ember-fw/utils/error';
-import exportTable from '@bennerinformatics/ember-fw-table/utils/export';
-import Table from 'ember-light-table';
-import RSVP from 'rsvp';
-import layout from '../templates/components/fw-pagination-wrapper';
-
-export default Component.extend({
-    layout,
-    ajax: inject(),
-    config: inject(),
-    media: inject(),
-    notifications: inject(),
-    store: inject(),
-    tagName: '',
-
-    /*
-     * Parameters
-     */
-
-    /**
-     * Name of the model in search
-     * @type {String}
-     * @prop modelName
-     */
-
-    /**
-     * Default sort order for the table
-     * @type {String}
-     */
-    defaultSortKey: null,
-
-    /**
-     * Number of entries per page
-     * @type {Number}
-     */
-    entriesPerPage: 100,
-
-    /**
-     * Gets the title of this table at the given time
-     * @return {String} Title of this table
-     */
-    getTitle() {
-        return 'Table';
-    },
-
-    /**
-     * Gets a list of table columns for exporting
-     * @return {Array} Array of table columns
-     */
-    getExportColumns() {},
-
-    /**
-     * Called when the table search button is pressed
-     */
-    onSearch() {},
-
-    /**
-     * Called to delete the full page of entries
-     * Should be passed in with a function
-     */
-    deletePage: undefined,
-
-    /**
-     * Determines permission for deleteTablePermission for fw-table-sortable
-     */
-    deletePagePermission: true,
-    /**
-     * Makes a query object based on the search fields
-     * @param  {Boolean} count  If true, counting
-     * @param  {Number}  page   If defined, page number for a page search
-     * @param  {Boolean} export If true, exporting
-     * @return {Object}         Query object
-     */
-    makeQuery(/* {count, page, export} */) {
-        return {};
-    },
-
-    /* Table generation properties */
-
-    /**
-     * Gets a list of table columns for the results. If null, yields for table
-     * @return {Array} Array of table columns
-     */
-    getTableColumns() {
-        return null;
-    },
-
-    /**
-     * Text to show for empty tables. If null, hides on empty
-     * @type {String}
-     */
-    emptyText: null,
-
-    /**
-     * Actions to pass into the table
-     * @type {Object}
-     */
-    tableActions: null,
-
-    /**
-     * Class names for the wrapper around the loading spinner and the table
-     * @type {String}
-     */
-    tableWrapperClass: '',
-
-    /*
-     * Search properties
-     */
-
-    /**
-     * Table title at this time
-     * @type {String}
-     */
-    currentTitle: null,
-
-    /**
-     * If true, currently doing the main search
-     * @type {Boolean}
-     */
-    searchingTable: false,
-
-    /**
-     * If true, show export page button
-     * @type {Boolean}
-     */
-    showExport: true,
-    /**
-     * Number of pages being searched
-     * @type {Number}
-     */
-    pagesSearching: 0,
-
-    /**
-      * Array of entries, indexes are the pages
-      * @type {Array}
-      */
-    pageEntries: null,
-
-    /**
-     * Currently selected page
-     * @type {Number}
-     */
-    page: 1,
-
-    /**
-     * Total number of entries
-     * @type {Number}
-     */
-    count: null,
-
-    /**
-     * Query last time createQuery was called
-     * @type {[type]}
-     */
-    lastQuery: null,
-
-    /**
-     * Current sort order for the table
-     * @type {String}
-     * @prop currentSortKey
-     */
-    currentSortKey: null,
-
-    /*
-     * Computed properties
-     */
-
-    /**
-     * Array index for the selected page
-     * @type {Number}
-     */
-    index: computed('page', function() {
-        return this.get('page') - 1;
-    }),
-
-    /**
-     * Array of entries at the current page
-     * @type {Array}
-     */
-    currentEntries: computed('pageEntries.[]', 'index', function() {
-        let entries = this.get('pageEntries');
-        if (isNone(entries)) {
-            return [];
-        }
-        return entries.objectAt(this.get('index'));
-    }),
-
-    /**
-     * Filtered entries, removing deleted entries
-     * @type {Array}
-     */
-    filteredEntries: filterBy('currentEntries', 'isDeleted', false),
-
-    /**
-     * Current table sort key based on given properties
-     * @type {String}
-     */
-    tableSortKey: computed('defaultSortKey', 'currentSortKey', function() {
-        let current = this.get('currentSortKey');
-        if (isEmpty(current)) {
-            return `${this.get('defaultSortKey')}:desc`;
-        }
-        return current;
-    }),
-
-    /**
-     * Number of pages available
-     * @type {Number}
-     */
-    totalPages: computed('count', 'entriesPerPage', function() {
-        let count = this.get('count');
-        if (isNone(count)) {
-            return 0;
-        }
-
-        return Math.ceil(count / this.get('entriesPerPage'));
-    }),
-
-    /**
-     * True if we have multiple pages
-     * @type {Boolean}
-     */
-    showPages: computed('totalPages', function() {
-        return this.get('totalPages') > 1;
-    }),
-
-    /**
-     * Maximum number of pages to show in the pagination component
-     * @type {Number}
-     */
-    maxPageButtons: computed('media.{isMobile,isTablet}', function() {
-        let media = this.get('media');
-        if (media.get('isMobile')) {
-            return 3;
-        }
-        if (media.get('isTablet')) {
-            return 5;
-        }
-
-        return 7;
-    }),
-
-    /**
-     * Gets the serverside route to use for this model name
-     * @type {String}
-     */
-    routeName: computed('modelName', function() {
-        let name = this.get('modelName');
-        return this.get('store').adapterFor(name).pathForType(name);
-    }),
-
-    /**
-     * Final piece of title for table
-     * @type {String}
-     */
-    tableSuffix: computed('count', 'currentEntries', 'index', function() {
-        let count = this.get('count');
-        let entries = this.get('currentEntries');
-        if (isEmpty(entries)) {
-            return `${count} entries`;
-        }
-        return `${entries.get('length')} of ${count} entries`;
-    }),
-
-    /**
-     * Title for the table
-     * @type {String}
-     */
-    fullTableTitle: computed('currentTitle', 'tableSuffix', function() {
-        return `${this.get('currentTitle')} - ${this.get('tableSuffix')}`;
-    }),
-
-    /** If true, hide the table when empty */
-    hideEmpty: empty('emptyText'),
-
-    /* Functions */
-
-    /**
-     * Queries the serverside to get the total record count
-     * @return {Promise} Promise that resolves to a number
-     */
-    queryCount() {
-        // fetch standard query
-        let query = this.makeQuery({count: true});
-        query.count = true;
-
-        // make request
-        let url = this.get('config').formUrl(this.get('routeName'));
-        return this.get('ajax').request(url, {data: query}).then((({count}) => count)).catch(handleAjaxError.bind(this));
-    },
-
-    /**
-     * Query for settign a new sort order
-     * @param  {Number}  page      Page number to start
-     * @param  {String}  sortKey   New sort order
-     * @param  {Boolean} ascending If true, sorts ascending, false descending
-     * @return {Promise}           Promise that resolves to a entry array
-     */
-    querySort(page, sortKey, ascending) {
-        let query = this.get('lastQuery');
-
-        // set sort key stuff if present
-        if (!isNone(ascending)) {
-            query.ascending = ascending;
-        }
-        if (!isEmpty(sortKey)) {
-            query.sortKey = sortKey;
-        }
-
-        // set limits on query
-        let entriesPerPage = this.get('entriesPerPage');
-        query.limit = entriesPerPage;
-        query.offset = (page - 1) * entriesPerPage;
-
-        // make promise
-        return RSVP.resolve(this.get('store').query(this.get('modelName'), query)).catch(handleAjaxError.bind(this));
-    },
-
-    /**
-     * Fetches the entries for the given page number
-     * @param  {Number}  page Page to fetch
-     * @return {Promise}      Promise that resolves to an entry array
-     */
-    queryPage(page) {
-        // same as sort, but handles the entries
-        return this.querySort(page).then((entries) => {
-            this.get('pageEntries')[page - 1] = entries;
-            return entries;
-        });
-    },
-
-    /**
-     * Gets all entries for the given query
-     * @return {Promise} Promise that resolves to entries
-     */
-    queryAll() {
-        let query = this.makeQuery({export: true});
-        return RSVP.resolve(this.get('store').query(this.get('modelName'), query)).catch(handleAjaxError.bind(this));
-    },
-
-    actions: {
-        /* Search buttons */
-
-        /**
-         * Called when the search button is pressed
-         * @return {Promise} Promise that resolves after searching
-         */
-        search() {
-            // TODO: canSearch?
-            // else a title getter
-
-            // start search and clean up old data
-            this.setProperties({
-                currentTitle: this.getTitle(),
-                // search data
-                lastQuery: this.makeQuery({page: 1}),
-                pageEntries: [],
-                page: 1,
-                // searching keys
-                searchingTable: true,
-                pagesSearching: 0,
-                tableColumns: this.getTableColumns()
-            });
-
-            // search callback
-            this.onSearch();
-
-            // make two requests: one for the total count and one for the first 100 entries
-            return RSVP.hash({
-                count: this.queryCount(),
-                entries: this.queryPage(1)
-            }).then(({count}) => {
-                // entries already set as part of queryPage
-                this.setProperties({
-                    count,
-                    searchingTable: false
-                });
-            }).catch(() => {
-                // request failed, clean up data
-                this.setProperties({
-                    // search data
-                    pageEntries: null,
-                    count: 0,
-                    // searching keys
-                    searchingTable: false
-                });
-            });
-        },
-
-        /**
-         * Called when the export button is clicked to export all data
-         * @return {Promise} Promise that resolves after exporting the table
-         */
-        export() {
-            // TODO: canSearch?
-
-            // build table for export
-            let table = new Table(this.getExportColumns());
-            return this.queryAll().then((entries) => {
-                table.setRows(entries.sortBy(this.get('defaultSortKey')).reverse());
-                exportTable(table, `${this.getTitle()} - All Entries`);
-            }).catch(handleAjaxError.bind(this));
-        },
-
-        /* Pagination */
-
-        /**
-         * Called when a page button is clicked to switch pages
-         * @param {Number} page New page number to set
-         */
-        setPage(page) {
-            // clamp page number
-            let max = this.get('totalPages');
-            if (page < 1) {
-                page = 1;
-            } else if (page > max) {
-                page = max;
-            }
-
-            // if we havve entries at the page number, use those
-            // if missing, query them
-            if (isNone(this.get('pageEntries').objectAt(page - 1))) {
-                this.incrementProperty('pagesSearching');
-                this.set('page', page);
-                this.queryPage(page).then(() => {
-                    // entries set in promise logic
-                    this.decrementProperty('pagesSearching');
-                });
-            } else {
-                this.set('page', page);
-            }
-        },
-
-        /* Sorting */
-
-        /**
-         * Resorts the entry by the given column
-         * @param  {Column} column  Column to use for sorting
-         * @param  {String} sortKey String to use for sorting in the column
-         * @return {Promise}        Promise that resolves to entries
-         */
-        sortColumn(column, sortKey) {
-            // if the sort key is unchanged, do nothing
-            if (sortKey === this.get('tableSortKey')) {
-                return RSVP.resolve();
-            }
-
-            // mark that we are sorting, column properties do not add desc
-            column.set('sorting', true);
-
-            // search for data
-            let page = this.get('page');
-            return this.querySort(page, column.searchKey || column.valuePath, column.ascending).then((entries) => {
-                // set entries to new list
-                let pageEntries = [];
-                pageEntries[page - 1] = entries;
-                this.setProperties({pageEntries, currentSortKey: sortKey});
-
-                // mark that we are done sorting
-                column.set('sorting', false);
-                return entries;
-            });
-        }
-    }
-});
+import Component from '@ember/component';
+import {computed} from '@ember/object';
+import {empty, filterBy} from '@ember/object/computed';
+import {inject} from '@ember/service';
+import {isEmpty, isNone} from '@ember/utils';
+import {handleAjaxError} from '@bennerinformatics/ember-fw/utils/error';
+import exportTable from '@bennerinformatics/ember-fw-table/utils/export';
+import Table from 'ember-light-table';
+import RSVP from 'rsvp';
+import layout from '../templates/components/fw-pagination-wrapper';
+
+export default Component.extend({
+    layout,
+    ajax: inject(),
+    config: inject(),
+    media: inject(),
+    notifications: inject(),
+    store: inject(),
+    tagName: '',
+
+    /*
+     * Parameters
+     */
+
+    /**
+     * Name of the model in search
+     * @type {String}
+     * @prop modelName
+     */
+
+    /**
+     * Default sort order for the table
+     * @type {String}
+     */
+    defaultSortKey: null,
+
+    /**
+     * Number of entries per page
+     * @type {Number}
+     */
+    entriesPerPage: 100,
+
+    /**
+     * Gets the title of this table at the given time
+     * @return {String} Title of this table
+     */
+    getTitle() {
+        return 'Table';
+    },
+
+    /**
+     * Gets a list of table columns for exporting
+     * @return {Array} Array of table columns
+     */
+    getExportColumns() {},
+
+    /**
+     * Called when the table search button is pressed
+     */
+    onSearch() {},
+
+    /**
+     * Called to delete the full page of entries
+     * Should be passed in with a function
+     */
+    deletePage: undefined,
+
+    /**
+     * Determines permission for deleteTablePermission for fw-table-sortable
+     */
+    deletePagePermission: true,
+    /**
+     * Makes a query object based on the search fields
+     * @param  {Boolean} count  If true, counting
+     * @param  {Number}  page   If defined, page number for a page search
+     * @param  {Boolean} export If true, exporting
+     * @return {Object}         Query object
+     */
+    makeQuery(/* {count, page, export} */) {
+        return {};
+    },
+
+    /* Table generation properties */
+
+    /**
+     * Gets a list of table columns for the results. If null, yields for table
+     * @return {Array} Array of table columns
+     */
+    getTableColumns() {
+        return null;
+    },
+
+    /**
+     * Text to show for empty tables. If null, hides on empty
+     * @type {String}
+     */
+    emptyText: null,
+
+    /**
+     * Actions to pass into the table
+     * @type {Object}
+     */
+    tableActions: null,
+
+    /**
+     * Class names for the wrapper around the loading spinner and the table
+     * @type {String}
+     */
+    tableWrapperClass: '',
+
+    /*
+     * Search properties
+     */
+
+    /**
+     * Table title at this time
+     * @type {String}
+     */
+    currentTitle: null,
+
+    /**
+     * If true, currently doing the main search
+     * @type {Boolean}
+     */
+    searchingTable: false,
+
+    /**
+     * If true, show export page button
+     * @type {Boolean}
+     */
+    showExport: true,
+    /**
+     * Number of pages being searched
+     * @type {Number}
+     */
+    pagesSearching: 0,
+
+    /**
+      * Array of entries, indexes are the pages
+      * @type {Array}
+      */
+    pageEntries: null,
+
+    /**
+     * Currently selected page
+     * @type {Number}
+     */
+    page: 1,
+
+    /**
+     * Total number of entries
+     * @type {Number}
+     */
+    count: null,
+
+    /**
+     * Query last time createQuery was called
+     * @type {[type]}
+     */
+    lastQuery: null,
+
+    /**
+     * Current sort order for the table
+     * @type {String}
+     * @prop currentSortKey
+     */
+    currentSortKey: null,
+
+    /*
+     * Computed properties
+     */
+
+    /**
+     * Array index for the selected page
+     * @type {Number}
+     */
+    index: computed('page', function() {
+        return this.get('page') - 1;
+    }),
+
+    /**
+     * Array of entries at the current page
+     * @type {Array}
+     */
+    currentEntries: computed('pageEntries.[]', 'index', function() {
+        let entries = this.get('pageEntries');
+        if (isNone(entries)) {
+            return [];
+        }
+        return entries.objectAt(this.get('index'));
+    }),
+
+    /**
+     * Filtered entries, removing deleted entries
+     * @type {Array}
+     */
+    filteredEntries: filterBy('currentEntries', 'isDeleted', false),
+
+    /**
+     * Current table sort key based on given properties
+     * @type {String}
+     */
+    tableSortKey: computed('defaultSortKey', 'currentSortKey', function() {
+        let current = this.get('currentSortKey');
+        if (isEmpty(current)) {
+            return `${this.get('defaultSortKey')}:desc`;
+        }
+        return current;
+    }),
+
+    /**
+     * Number of pages available
+     * @type {Number}
+     */
+    totalPages: computed('count', 'entriesPerPage', function() {
+        let count = this.get('count');
+        if (isNone(count)) {
+            return 0;
+        }
+
+        return Math.ceil(count / this.get('entriesPerPage'));
+    }),
+
+    /**
+     * True if we have multiple pages
+     * @type {Boolean}
+     */
+    showPages: computed('totalPages', function() {
+        return this.get('totalPages') > 1;
+    }),
+
+    /**
+     * Maximum number of pages to show in the pagination component
+     * @type {Number}
+     */
+    maxPageButtons: computed('media.{isMobile,isTablet}', function() {
+        let media = this.get('media');
+        if (media.get('isMobile')) {
+            return 3;
+        }
+        if (media.get('isTablet')) {
+            return 5;
+        }
+
+        return 7;
+    }),
+
+    /**
+     * Gets the serverside route to use for this model name
+     * @type {String}
+     */
+    routeName: computed('modelName', function() {
+        let name = this.get('modelName');
+        return this.get('store').adapterFor(name).pathForType(name);
+    }),
+
+    /**
+     * Final piece of title for table
+     * @type {String}
+     */
+    tableSuffix: computed('count', 'currentEntries', 'index', function() {
+        let count = this.get('count');
+        let entries = this.get('currentEntries');
+        if (isEmpty(entries)) {
+            return `${count} entries`;
+        }
+        return `${entries.get('length')} of ${count} entries`;
+    }),
+
+    /**
+     * Title for the table
+     * @type {String}
+     */
+    fullTableTitle: computed('currentTitle', 'tableSuffix', function() {
+        return `${this.get('currentTitle')} - ${this.get('tableSuffix')}`;
+    }),
+
+    /** If true, hide the table when empty */
+    hideEmpty: empty('emptyText'),
+
+    /* Functions */
+
+    /**
+     * Queries the serverside to get the total record count
+     * @return {Promise} Promise that resolves to a number
+     */
+    queryCount() {
+        // fetch standard query
+        let query = this.makeQuery({count: true});
+        query.count = true;
+
+        // make request
+        let url = this.get('config').formUrl(this.get('routeName'));
+        return this.get('ajax').request(url, {data: query}).then((({count}) => count)).catch(handleAjaxError.bind(this));
+    },
+
+    /**
+     * Query for settign a new sort order
+     * @param  {Number}  page      Page number to start
+     * @param  {String}  sortKey   New sort order
+     * @param  {Boolean} ascending If true, sorts ascending, false descending
+     * @return {Promise}           Promise that resolves to a entry array
+     */
+    querySort(page, sortKey, ascending) {
+        let query = this.get('lastQuery');
+
+        // set sort key stuff if present
+        if (!isNone(ascending)) {
+            query.ascending = ascending;
+        }
+        if (!isEmpty(sortKey)) {
+            query.sortKey = sortKey;
+        }
+
+        // set limits on query
+        let entriesPerPage = this.get('entriesPerPage');
+        query.limit = entriesPerPage;
+        query.offset = (page - 1) * entriesPerPage;
+
+        // make promise
+        return RSVP.resolve(this.get('store').query(this.get('modelName'), query)).catch(handleAjaxError.bind(this));
+    },
+
+    /**
+     * Fetches the entries for the given page number
+     * @param  {Number}  page Page to fetch
+     * @return {Promise}      Promise that resolves to an entry array
+     */
+    queryPage(page) {
+        // same as sort, but handles the entries
+        return this.querySort(page).then((entries) => {
+            this.get('pageEntries')[page - 1] = entries;
+            return entries;
+        });
+    },
+
+    /**
+     * Gets all entries for the given query
+     * @return {Promise} Promise that resolves to entries
+     */
+    queryAll() {
+        let query = this.makeQuery({export: true});
+        return RSVP.resolve(this.get('store').query(this.get('modelName'), query)).catch(handleAjaxError.bind(this));
+    },
+
+    actions: {
+        /* Search buttons */
+
+        /**
+         * Called when the search button is pressed
+         * @return {Promise} Promise that resolves after searching
+         */
+        search() {
+            // TODO: canSearch?
+            // else a title getter
+
+            // start search and clean up old data
+            this.setProperties({
+                currentTitle: this.getTitle(),
+                // search data
+                lastQuery: this.makeQuery({page: 1}),
+                pageEntries: [],
+                page: 1,
+                // searching keys
+                searchingTable: true,
+                pagesSearching: 0,
+                tableColumns: this.getTableColumns()
+            });
+
+            // search callback
+            this.onSearch();
+
+            // make two requests: one for the total count and one for the first 100 entries
+            return RSVP.hash({
+                count: this.queryCount(),
+                entries: this.queryPage(1)
+            }).then(({count}) => {
+                // entries already set as part of queryPage
+                this.setProperties({
+                    count,
+                    searchingTable: false
+                });
+            }).catch(() => {
+                // request failed, clean up data
+                this.setProperties({
+                    // search data
+                    pageEntries: null,
+                    count: 0,
+                    // searching keys
+                    searchingTable: false
+                });
+            });
+        },
+
+        /**
+         * Called when the export button is clicked to export all data
+         * @return {Promise} Promise that resolves after exporting the table
+         */
+        export() {
+            // TODO: canSearch?
+
+            // build table for export
+            let table = new Table(this.getExportColumns());
+            return this.queryAll().then((entries) => {
+                table.setRows(entries.sortBy(this.get('defaultSortKey')).reverse());
+                exportTable(table, `${this.getTitle()} - All Entries`);
+            }).catch(handleAjaxError.bind(this));
+        },
+
+        /* Pagination */
+
+        /**
+         * Called when a page button is clicked to switch pages
+         * @param {Number} page New page number to set
+         */
+        setPage(page) {
+            // clamp page number
+            let max = this.get('totalPages');
+            if (page < 1) {
+                page = 1;
+            } else if (page > max) {
+                page = max;
+            }
+
+            // if we havve entries at the page number, use those
+            // if missing, query them
+            if (isNone(this.get('pageEntries').objectAt(page - 1))) {
+                this.incrementProperty('pagesSearching');
+                this.set('page', page);
+                this.queryPage(page).then(() => {
+                    // entries set in promise logic
+                    this.decrementProperty('pagesSearching');
+                });
+            } else {
+                this.set('page', page);
+            }
+        },
+
+        /* Sorting */
+
+        /**
+         * Resorts the entry by the given column
+         * @param  {Column} column  Column to use for sorting
+         * @param  {String} sortKey String to use for sorting in the column
+         * @return {Promise}        Promise that resolves to entries
+         */
+        sortColumn(column, sortKey) {
+            // if the sort key is unchanged, do nothing
+            if (sortKey === this.get('tableSortKey')) {
+                return RSVP.resolve();
+            }
+
+            // mark that we are sorting, column properties do not add desc
+            column.set('sorting', true);
+
+            // search for data
+            let page = this.get('page');
+            return this.querySort(page, column.searchKey || column.valuePath, column.ascending).then((entries) => {
+                // set entries to new list
+                let pageEntries = [];
+                pageEntries[page - 1] = entries;
+                this.setProperties({pageEntries, currentSortKey: sortKey});
+
+                // mark that we are done sorting
+                column.set('sorting', false);
+                return entries;
+            });
+        }
+    }
+});