@bennerinformatics/ember-fw-table 2.0.20 → 2.1.0

package/addon/utils/export.js

@@ -1,76 +1,78 @@
-import EmberObject from '@ember/object';
-import {isEmpty, isNone} from '@ember/utils';
-import Papa from 'papaparse';
-/**
- * Used internally only. DESCRIPTION NEEDED
- * @class Export
- * @module Utils
- */
-/**
- * Creates a CSV file from a data array and a title
- * @param  {Array} data        Array of table cells
- * @param  {Title} [name=null] Name to export
- */
-export function createCSV(data, name = null) {
-    // first step, we need to extra the cells into "Cell","Cell 2" format, use JSON.stringify as it makes most escapes
-    // regex removes the brackets, as its an array we are calling stringify on
-    let rows = Papa.unparse(data);
-
-    // next, join that using newlines and export as data CSV
-    let encodedUri = `data:text/csv;charset=utf-8,${encodeURIComponent(rows)}`;
-
-    // downloading is a bit weird. We create a link element with the name and URL then click the element
-    let link = document.createElement('a');
-    link.setAttribute('href', encodedUri);
-    link.setAttribute('download', `${name || 'Export'}.csv`);
-    document.body.appendChild(link); // Required for FF
-    link.click(); // This will download the data file
-}
-
-/**
- * Exports an Ember Light Table to CSV
- * @param  {Table} table             Table class, just needs to include rows and columns
- * @param  {String} [title='Export'] Title to use for exporting
- */
-export default function exportTable(table, title = 'Export') {
-    // start by filtering out columns which opted out of exporting. Examples include action buttons and the row toggle
-    let columns = table.get('columns').filter(({canExport}) => {
-        // if canExport is defined, require it to be true
-        return isNone(canExport) || canExport;
-    });
-
-    // ensure we have columns and data
-    if (isEmpty(columns)) {
-        return;
-    }
-
-    // start the data with just the labels from the columns
-    let data = [columns.map(({exportLabel, label}) => exportLabel || label)];
-
-    // next, populate data by iterating through the current rows
-    table.get('rows').forEach((row) => {
-        // in each row, iterate through the columns
-        let rowData = columns.map((column) => {
-            let {valuePath, format} = column;
-            // flat value pulled from the model
-            let rawValue = valuePath ? row.get(valuePath) : '';
-            let value = rawValue;
-            // if we have a format function and a value, run the function
-            if (format && typeof format === 'function') {
-                // so, typically there is a cell object which contains data as the functions "this"
-                // but we are in a action so simulate it by passing in the data we expect the function to have
-                // while we are here, might as well pass in an export parameter so they can modify behavior for export if desired
-                value = format.call(EmberObject.create({column, row, table, rawValue, export: true}), rawValue);
-            }
-
-            // return the value, though convert null/undefined into a string
-            return isNone(value) ? '' : value;
-        });
-
-        // add that data into the main array
-        data.pushObject(rowData);
-    });
-
-    // finally, pass our 2 dimensional array to the function to convert to a file download
-    createCSV(data, title);
-}
+import EmberObject from '@ember/object';
+import {isEmpty, isNone} from '@ember/utils';
+import Papa from 'papaparse';
+/**
+ * An internal util that is used in ember-fw-table for the export functionality, both in the `FwTableSortable` and `FwPaginationWrapper`.
+ * @class Export
+ * @module Utils
+ */
+/**
+ * Creates a CSV file from a data array and a title
+ * @method createCSV
+ * @param  {Array} data        Array of table cells
+ * @param  {Title} [name=null] Name to export
+ */
+export function createCSV(data, name = null) {
+    // first step, we need to extra the cells into "Cell","Cell 2" format, use JSON.stringify as it makes most escapes
+    // regex removes the brackets, as its an array we are calling stringify on
+    let rows = Papa.unparse(data);
+
+    // next, join that using newlines and export as data CSV
+    let encodedUri = `data:text/csv;charset=utf-8,${encodeURIComponent(rows)}`;
+
+    // downloading is a bit weird. We create a link element with the name and URL then click the element
+    let link = document.createElement('a');
+    link.setAttribute('href', encodedUri);
+    link.setAttribute('download', `${name || 'Export'}.csv`);
+    document.body.appendChild(link); // Required for FF
+    link.click(); // This will download the data file
+}
+
+/**
+ * Exports an Ember Light Table to CSV
+ * @method exportTable
+ * @param  {Table} table             Table class, just needs to include rows and columns
+ * @param  {String} [title='Export'] Title to use for exporting
+ */
+export default function exportTable(table, title = 'Export') {
+    // start by filtering out columns which opted out of exporting. Examples include action buttons and the row toggle
+    let columns = table.get('columns').filter(({canExport}) => {
+        // if canExport is defined, require it to be true
+        return isNone(canExport) || canExport;
+    });
+
+    // ensure we have columns and data
+    if (isEmpty(columns)) {
+        return;
+    }
+
+    // start the data with just the labels from the columns
+    let data = [columns.map(({exportLabel, label}) => exportLabel || label)];
+
+    // next, populate data by iterating through the current rows
+    table.get('rows').forEach((row) => {
+        // in each row, iterate through the columns
+        let rowData = columns.map((column) => {
+            let {valuePath, format} = column;
+            // flat value pulled from the model
+            let rawValue = valuePath ? row.get(valuePath) : '';
+            let value = rawValue;
+            // if we have a format function and a value, run the function
+            if (format && typeof format === 'function') {
+                // so, typically there is a cell object which contains data as the functions "this"
+                // but we are in a action so simulate it by passing in the data we expect the function to have
+                // while we are here, might as well pass in an export parameter so they can modify behavior for export if desired
+                value = format.call(EmberObject.create({column, row, table, rawValue, export: true}), rawValue);
+            }
+
+            // return the value, though convert null/undefined into a string
+            return isNone(value) ? '' : value;
+        });
+
+        // add that data into the main array
+        data.pushObject(rowData);
+    });
+
+    // finally, pass our 2 dimensional array to the function to convert to a file download
+    createCSV(data, title);
+}

package/addon/utils/formats.js

@@ -1,46 +1,93 @@
-/* global moment */
-import {htmlSafe} from '@ember/string';
-import {isNone} from '@ember/utils';
-/**
- * DESCRIPTION NEEDED
- * @class Format
- * @module Utils
- */
-/**
- * Format function which replaces the value with a basic Yes/No format for if its true or false
- * @param  {Any} value Value to test
- * @return {String}    "Yes" if the value is truthy, "No" otherwise
- */
-export function formatBoolean(value) {
-    return value ? 'Yes' : 'No';
-}
-
-/**
- * Generates a format function which returns the value or an italic default text
- * @param  {String} [nullText='None'] Text if the value is null
- * @return {Function}                 Function to pass into the column format
- */
-export function formatNullable(nullText = 'None') {
-    return function(value) {
-        if (isNone(value)) {
-            return this.get('export') ? '' : htmlSafe(`<i>${nullText}</i>`);
-        }
-        return value;
-    };
-}
-
-/**
- * Generates a function which formats a moment based on the specified format
- * @param  {String} format       moment format
- * @param  {String} exportFormat moment format used on exporting
- * @return {Function}      Function to pass into a column which formats by a moment
- */
-export function formatMoment(format, exportFormat = null) {
-    return function(date) {
-        if (moment.isMoment(date)) {
-            // if we are exporting and have an export format, use that
-            let useFormat = exportFormat && this.get('export') ? exportFormat : format;
-            return date.format(useFormat);
-        }
-    };
-}
+/* global moment */
+import {htmlSafe} from '@ember/string';
+import {isNone} from '@ember/utils';
+/**
+ * These utils are designed for helping you be able to easily format a column by passing this function into the `format` attribute of the column. To use these functions, all you need to do
+ * is import them at the top of the Javascript file, with the following import:
+ * ```js
+ * import {functionName} from '@bennerinformatics/ember-fw-table/utils/formats';
+ * ```
+ * Then you use it in the column array to format it appropriately. Each function gives you an example of how to use it.
+ * @class Format
+ * @module Utils
+ */
+/**
+ * Format function which replaces the value with a basic Yes/No format for if its true or false. Designed to be used in the following way with a boolean column (after importing `formatBoolean` in the way described above):
+ * ```js
+ * column: [{
+ *   label: 'My Boolean',
+ *   valuePath: 'myBoolean',
+ *   format: formatBoolean
+ *   ...
+ * }...],
+ * @method formatBoolean
+ * @param  {Any} value Value to test
+ * @return {String}    "Yes" if the value is truthy, "No" otherwise
+ */
+export function formatBoolean(value) {
+    return value ? 'Yes' : 'No';
+}
+
+/**
+ * Generates a format function which returns the value or an italic default text if the value is null. Designed to be used in the following way with a column that may have a null value (after importing `formatNullable` in the way described above):
+ * ```js
+ * column: [
+ *  //if null, will display the default "None" in italics
+ *   {
+ *      label: 'Some Column',
+ *      valuePath: 'someColumn',
+ *      format: formatNullable
+ *      ...
+ *   },
+ *   //if null, will display "No Value" instead of "None" in italics
+ *   {
+ *      label: 'Some Column',
+ *      valueText: 'someColumn',
+ *      format: formatNullable('No Value')
+ *  }
+ * ...],
+ * @method formatNullable
+ * @param  {String} [nullText='None'] Text if the value is null
+ * @return {Function}                 Function to pass into the column format
+ */
+export function formatNullable(nullText = 'None') {
+    return function(value) {
+        if (isNone(value)) {
+            return this['export'] ? '' : htmlSafe(`<i>${nullText}</i>`);
+        }
+        return value;
+    };
+}
+
+/**
+ * Generates a function which formats a moment based on the specified format. Designed to be used in the following way with a column displaying a date (after importing `formatMoment` in the way described above):
+ * ```js
+ * column: [
+ *   //will display date as 1970-01-01
+ *   {
+ *      label: 'Some Column',
+ *      valuePath: 'someColumn',
+ *      format: formatMoment('YYYY-MM-DD')
+ *      ...
+ *   },
+ *   //will display date in the table as 1970-01-01, but when exporting display 01-01-1970
+ *   {
+ *      label: 'Some Column',
+ *      valueText: 'someColumn',
+ *      format: formatMoment('YYYY-MM-DD', 'MM-DD-YYYY')
+ *  }
+ * ...],
+ * @method formatMoment
+ * @param  {String} format       moment format. For a list of valid strings, see [Moment docs](https://momentjs.com/docs/#/displaying/format/)
+ * @param  {String} exportFormat moment format used on exporting
+ * @return {Function}      Function to pass into a column which formats by a moment
+ */
+export function formatMoment(format, exportFormat = null) {
+    return function(date) {
+        if (moment.isMoment(date)) {
+            // if we are exporting and have an export format, use that
+            let useFormat = exportFormat && this['export'] ? exportFormat : format;
+            return date.format(useFormat);
+        }
+    };
+}

package/addon/utils/table.js

@@ -1,35 +1,36 @@
-import {isEmpty} from '@ember/utils';
-/**
- * Used internal only DESCRIPTION NEEDED
- * @class TableUtil
- * @module Utils
- */
-/**
- * Checks if a row should be show in expanded view given the context
- * @param  {Table}  table  Table class instance
- * @param  {Row}    row    Row class instance
- * @param  {Column} column Column class instance
- * @return {boolean}       True if it is shown in this context, false otherwise
- */
-export function showExpanded(table, row, column) {
-    // if show expanded is defined, use that
-    let showExpanded = column.get('showExpanded');
-    let showExpandedType = typeof showExpanded;
-    // flat boolean? just return
-    if (showExpandedType === 'boolean') {
-        return showExpanded;
-    }
-    // key? fetch from the row
-    if (showExpandedType === 'string') {
-        return row.get(showExpanded);
-    }
-
-    // no value path? show it
-    let valuePath = column.get('valuePath');
-    if (isEmpty(valuePath)) {
-        return true;
-    }
-
-    // hides undefined, null, and empty arrays, but not false and 0
-    return !isEmpty(row.get(valuePath));
-}
+import {isEmpty} from '@ember/utils';
+/**
+ * This is an internal util that is used to help with the logic for expanded rows.
+ * @class TableUtil
+ * @module Utils
+ */
+/**
+ * Checks if a row should be show in expanded view given the context
+ * @method showExpanded
+ * @param  {Table}  table  Table class instance
+ * @param  {Row}    row    Row class instance
+ * @param  {Column} column Column class instance
+ * @return {boolean}       True if it is shown in this context, false otherwise
+ */
+export function showExpanded(table, row, column) {
+    // if show expanded is defined, use that
+    let showExpanded = column.get('showExpanded');
+    let showExpandedType = typeof showExpanded;
+    // flat boolean? just return
+    if (showExpandedType === 'boolean') {
+        return showExpanded;
+    }
+    // key? fetch from the row
+    if (showExpandedType === 'string') {
+        return row.get(showExpanded);
+    }
+
+    // no value path? show it
+    let valuePath = column.get('valuePath');
+    if (isEmpty(valuePath)) {
+        return true;
+    }
+
+    // hides undefined, null, and empty arrays, but not false and 0
+    return !isEmpty(row.get(valuePath));
+}

package/app/breakpoints.js

@@ -1 +1 @@
-export {default} from '@bennerinformatics/ember-fw-table/breakpoints';
+export {default} from '@bennerinformatics/ember-fw-table/breakpoints';

package/app/components/fw-cell-permission-icon.js

@@ -1 +1 @@
-export {default} from '@bennerinformatics/ember-fw-table/components/fw-cell-permission-icon';
+export {default} from '@bennerinformatics/ember-fw-table/components/fw-cell-permission-icon';

package/app/initializers/responsive.js

@@ -1 +1 @@
-export {default} from '@bennerinformatics/ember-fw-table/initializers/responsive';
+export {default} from '@bennerinformatics/ember-fw-table/initializers/responsive';

package/codemods.log

@@ -0,0 +1,16 @@
+2024-07-08T21:10:22.429Z [warn] WARNING: {{fw-fullscreen-modal}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-delete-modal.hbs
+2024-07-08T21:10:22.475Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-pagination-wrapper.hbs
+2024-07-08T21:10:22.478Z [warn] WARNING: {{fw-table-sortable}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-pagination-wrapper.hbs
+2024-07-08T21:10:22.478Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-pagination-wrapper.hbs
+2024-07-08T21:10:22.600Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-resort.hbs
+2024-07-08T21:10:22.633Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-08T21:10:22.633Z [warn] WARNING: {{or}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-08T21:10:22.634Z [warn] WARNING: {{light-table}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-08T21:10:22.637Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-09T14:00:38.763Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-pagination-wrapper.hbs
+2024-07-09T14:00:38.767Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-pagination-wrapper.hbs
+2024-07-09T14:00:38.954Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-resort.hbs
+2024-07-09T14:00:38.988Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-09T14:00:38.988Z [warn] WARNING: {{or}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-09T14:00:38.988Z [warn] WARNING: {{light-table}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs
+2024-07-09T14:00:38.989Z [warn] WARNING: {{yield}} was not converted as it has positional parameters which can't be automatically converted. Source: addon/templates/components/fw-table-sortable.hbs

package/index.js

@@ -1,9 +1,10 @@
-/* eslint-env node */
-'use strict';
-
-module.exports = {
-    name: '@bennerinformatics/ember-fw-table',
-    included() {
-        this._super.included.apply(this, arguments);
-    }
-};
+/* eslint-env node */
+'use strict';
+
+module.exports = {
+    name: '@bennerinformatics/ember-fw-table',
+    included() {
+        this._super.included.apply(this, arguments);
+    },
+    isDevelopingAddon: () => true
+};

package/package.json

@@ -1,67 +1,65 @@
-{
-  "name": "@bennerinformatics/ember-fw-table",
-  "version": "2.0.20",
-  "description": "Additional resources related to tables for the Ember FW App System.",
-  "keywords": [
-    "ember-addon",
-    "fw"
-  ],
-  "license": "MIT",
-  "author": "David Burnett <djburnett@olivet.edu>",
-  "directories": {
-    "doc": "doc",
-    "test": "tests"
-  },
-  "repository": "",
-  "scripts": {
-    "build": "ember build",
-    "start": "ember server",
-    "test": "npm run lint && ember try:each",
-    "lint": "ember test --launch phantomjs --filter=\"ESLint\""
-  },
-  "dependencies": {
-    "ember-cli-babel": "~7.10.0",
-    "ember-cli-htmlbars": "^3.1.0",
-    "ember-light-table": "^1.13.2",
-    "ember-papaparse": "^1.0.0",
-    "ember-truth-helpers": "^2.1.0",
-    "node-sass": "^4.12.0",
-    "papaparse": "^5.0.2"
-  },
-  "devDependencies": {
-    "@bennerinformatics/ember-fw": "^2.0.24",
-    "broccoli-asset-rev": "^3.0.0",
-    "ember-ajax": "^5.0.0",
-    "ember-cli": "~3.10.0",
-    "ember-cli-addon-docs-yuidoc": "^1.0.0",
-    "ember-cli-app-version": "^3.2.0",
-    "ember-cli-dependency-checker": "^3.2.0",
-    "ember-cli-eslint": "^5.1.0",
-    "ember-cli-htmlbars-inline-precompile": "^2.1.0",
-    "ember-cli-inject-live-reload": "^2.0.1",
-    "ember-cli-qunit": "^4.4.0",
-    "ember-cli-shims": "^1.2.0",
-    "ember-cli-sri": "^2.1.0",
-    "ember-cli-uglify": "^3.0.0",
-    "ember-cli-yuidoc": "^0.8.8",
-    "ember-disable-prototype-extensions": "^1.1.3",
-    "ember-export-application-global": "^2.0.0",
-    "ember-load-initializers": "^2.0.0",
-    "ember-resolver": "^5.2.1",
-    "ember-responsive": "^3.0.5",
-    "ember-sortable": "1.12.9",
-    "ember-source": "~3.10.0",
-    "eslint-plugin-ember": "^6.9.1",
-    "eslint-plugin-ember-suave": "^1.0.0",
-    "loader.js": "^4.7.0",
-    "moment": "^2.24.0",
-    "yuidoc-ember-theme": "^2.0.1"
-
-  },
-  "engines": {
-    "node": ">= 0.10.0"
-  },
-  "ember-addon": {
-    "configPath": "tests/dummy/config"
-  }
-}
+{
+  "name": "@bennerinformatics/ember-fw-table",
+  "version": "2.1.0",
+  "description": "Additional resources related to tables for the Ember FW App System.",
+  "keywords": [
+    "ember-addon",
+    "fw"
+  ],
+  "license": "MIT",
+  "author": "David Burnett <djburnett@olivet.edu>",
+  "directories": {
+    "doc": "doc",
+    "test": "tests"
+  },
+  "repository": "",
+  "scripts": {
+    "build": "ember build",
+    "start": "ember server",
+    "test": "npm run lint && ember try:each",
+    "lint": "ember test --launch phantomjs --filter=\"ESLint\""
+  },
+  "dependencies": {
+    "ember-cli-babel": "7.13.2",
+    "ember-cli-htmlbars": "^3.1.0",
+    "ember-light-table": "2.0.0-beta.5",
+    "ember-papaparse": "^1.0.0",
+    "ember-truth-helpers": "^2.1.0",
+    "node-sass": "^4.12.0",
+    "papaparse": "^5.0.2"
+  },
+  "devDependencies": {
+    "@bennerinformatics/ember-fw": "^2.0.29",
+    "broccoli-asset-rev": "^3.0.0",
+    "ember-ajax": "^5.0.0",
+    "ember-cli": "~3.10.0",
+    "ember-cli-addon-docs-yuidoc": "^1.0.0",
+    "ember-cli-app-version": "^3.2.0",
+    "ember-cli-dependency-checker": "^3.2.0",
+    "ember-cli-eslint": "^5.1.0",
+    "ember-cli-htmlbars-inline-precompile": "^2.1.0",
+    "ember-cli-inject-live-reload": "^2.0.1",
+    "ember-cli-qunit": "^4.4.0",
+    "ember-cli-shims": "^1.2.0",
+    "ember-cli-sri": "^2.1.0",
+    "ember-cli-uglify": "^3.0.0",
+    "ember-cli-yuidoc": "^0.8.8",
+    "ember-disable-prototype-extensions": "^1.1.3",
+    "ember-export-application-global": "^2.0.0",
+    "ember-load-initializers": "^2.0.0",
+    "ember-resolver": "^5.2.1",
+    "ember-responsive": "^3.0.5",
+    "ember-sortable": "1.12.9",
+    "ember-source": "~3.10.0",
+    "eslint-plugin-ember": "^6.9.1",
+    "eslint-plugin-ember-suave": "^1.0.0",
+    "loader.js": "^4.7.0",
+    "moment": "^2.24.0"
+  },
+  "engines": {
+    "node": ">= 0.10.0"
+  },
+  "ember-addon": {
+    "configPath": "tests/dummy/config"
+  }
+}

package/yuidoc-ember-theme/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kevin Lakotko, Tony Barone, Brian Reavis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.