Merge pull request #387 from hashicorp/refactor-core-helpers

refactor: 💡 port remaining helpers and doc-link component

addons/core/README.md

@@ -83,6 +83,25 @@ update the confirmation status.
 </PendingConfirmations
 ```
 
+## App and Company Names
+
+To make use of the `app-name`, `company-name`, and `company-copyright` helpers,
+add `appName` an `companyName` keys to your Ember config
+(see admin for example).
+
+## Documentation URLs
+
+To render doc links in your application, be sure to configure the links in your
+Ember config (see admin).  Then reference doc links by keys:
+
+```html
+<DocLink @doc="account" @iconSize="large" />
+```
+
+## Loading Helper
+
+To make use of the `is-loading` helper, install `ember-loading` first.
+
 ## Yarn Commands
 
 List of available project commands.  `yarn run <command-name>`

addons/core/addon/helpers/app-name.js

@@ -1,5 +1,5 @@
 import { helper } from '@ember/component/helper';
-import config from '../config/environment';
+import config from 'ember-get-config';
 
 export default helper(function appName() {
   return config.appName;

addons/core/addon/helpers/company-copyright.js

@@ -1,5 +1,5 @@
 import { helper } from '@ember/component/helper';
-import config from '../config/environment';
+import config from 'ember-get-config';
 
 export default helper(function companyCopyright() {
   const currentYear = new Date().getFullYear();

addons/core/addon/helpers/company-name.js

@@ -1,5 +1,5 @@
 import { helper } from '@ember/component/helper';
-import config from '../config/environment';
+import config from 'ember-get-config';
 
 export default helper(function companyName() {
   return config.companyName;

addons/core/addon/helpers/doc-url.js

@@ -1,6 +1,6 @@
 import { helper } from '@ember/component/helper';
 import { assert } from '@ember/debug';
-import config from '../config/environment';
+import config from 'ember-get-config';
 
 export default helper(function docUrl(params /*, hash*/) {
   const baseURL = config.documentation.baseURL;

addons/core/app/components/doc-link.js

@@ -0,0 +1 @@
+export { default } from 'core/components/doc-link';

addons/core/app/helpers/app-name.js

@@ -0,0 +1 @@
+export { default, appName } from 'core/helpers/app-name';

addons/core/app/helpers/company-copyright.js

@@ -0,0 +1 @@
+export { default, companyCopyright } from 'core/helpers/company-copyright';

addons/core/app/helpers/company-name.js

@@ -0,0 +1 @@
+export { default, companyName } from 'core/helpers/company-name';

addons/core/app/helpers/doc-url.js

@@ -0,0 +1 @@
+export { default, docUrl } from 'core/helpers/doc-url';

addons/core/app/helpers/is-loading.js

@@ -0,0 +1 @@
+export { default, isLoading } from 'core/helpers/is-loading';

addons/core/package.json

@@ -59,7 +59,8 @@
     "loader.js": "^4.7.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.2",
-    "qunit-dom": "^1.2.0"
+    "qunit-dom": "^1.2.0",
+    "rose": "*"
   },
   "engines": {
     "node": "10.* || >= 12"

addons/core/tests/dummy/config/environment.js

@@ -21,6 +21,16 @@ module.exports = function (environment) {
       // Here you can pass flags/options to your application instance
       // when it is created
     },
+
+    appName: 'App Name',
+    companyName: 'Company Name',
+
+    documentation: {
+      baseURL: 'https://boundaryproject.io/help/admin-ui',
+      topics: {
+        account: '/accounts',
+      }
+    }
   };
 
   if (environment === "development") {

addons/core/tests/integration/helpers/app-name-test.js

@@ -9,6 +9,6 @@ module('Integration | Helper | app-name', function (hooks) {
   test('it renders', async function (assert) {
     assert.expect(1);
     await render(hbs`{{app-name}}`);
-    assert.equal(this.element.textContent.trim(), 'Boundary');
+    assert.equal(this.element.textContent.trim(), 'App Name');
   });
 });

addons/core/tests/integration/helpers/company-copyright-test.js

@@ -10,6 +10,6 @@ module('Integration | Helper | company-copyright', function (hooks) {
     assert.expect(1);
     const currentYear = new Date().getFullYear();
     await render(hbs`{{company-copyright}}`);
-    assert.equal(this.element.textContent.trim(), `© ${currentYear} HashiCorp`);
+    assert.equal(this.element.textContent.trim(), `© ${currentYear} Company Name`);
   });
 });

addons/core/tests/integration/helpers/company-name-test.js

@@ -9,6 +9,6 @@ module('Integration | Helper | company-name', function (hooks) {
   test('it renders', async function (assert) {
     assert.expect(1);
     await render(hbs`{{company-name}}`);
-    assert.equal(this.element.textContent.trim(), 'HashiCorp');
+    assert.equal(this.element.textContent.trim(), 'Company Name');
   });
 });