Merge pull request #16 from Gaurav0/rename_back

Add tests, extend functionality and composability

Author: btecu

.eslintignore

@@ -8,9 +8,11 @@
 
 # dependencies
 /bower_components/
+/node_modules/
 
 # misc
 /coverage/
+!.*
 
 # ember-try
 /.node_modules.ember-try/

.eslintrc.js

@@ -15,5 +15,38 @@ module.exports = {
     browser: true
   },
   rules: {
-  }
+  },
+  overrides: [
+    // node files
+    {
+      files: [
+        '.eslintrc.js',
+        '.template-lintrc.js',
+        'ember-cli-build.js',
+        'index.js',
+        'testem.js',
+        'blueprints/*/index.js',
+        'config/**/*.js',
+        'tests/dummy/config/**/*.js'
+      ],
+      excludedFiles: [
+        'addon/**',
+        'addon-test-support/**',
+        'app/**',
+        'tests/dummy/app/**'
+      ],
+      parserOptions: {
+        sourceType: 'script',
+        ecmaVersion: 2015
+      },
+      env: {
+        browser: false,
+        node: true
+      },
+      plugins: ['node'],
+      rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
+        // add your custom rules and overrides for node files here
+      })
+    }
+  ]
 };

.gitignore

@@ -9,6 +9,7 @@
 /node_modules/
 
 # misc
+/.env*
 /.sass-cache
 /connect.lock
 /coverage/

.npmignore

@@ -9,13 +9,16 @@
 /.bowerrc
 /.editorconfig
 /.ember-cli
+/.env*
 /.eslintignore
 /.eslintrc.js
 /.gitignore
-/.watchmanconfig
+/.template-lintrc.js
 /.travis.yml
+/.watchmanconfig
 /bower.json
 /config/ember-try.js
+/CONTRIBUTING.md
 /ember-cli-build.js
 /testem.js
 /tests/

.travis.yml

@@ -19,6 +19,12 @@ env:
     # See https://git.io/vdao3 for details.
     - JOBS=1
 
+branches:
+  only:
+    - master
+    # npm version tags
+    - /^v\d+\.\d+\.\d+/
+
 jobs:
   fail_fast: true
   allow_failures:
@@ -44,7 +50,8 @@ jobs:
     # as well as latest stable release (bonus points to beta/canary)
     - stage: "Additional Tests"
       env: EMBER_TRY_SCENARIO=ember-lts-2.16
-    - env: EMBER_TRY_SCENARIO=ember-lts-2.18
+      env: EMBER_TRY_SCENARIO=ember-lts-2.18
+    - env: EMBER_TRY_SCENARIO=ember-lts-3.4
     - env: EMBER_TRY_SCENARIO=ember-release
     - env: EMBER_TRY_SCENARIO=ember-beta
     - env: EMBER_TRY_SCENARIO=ember-canary

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How To Contribute
+
+## Installation
+
+* `git clone https://github.com/btecu/ember-simple-tree`
+* `cd my-addon`
+* `npm install`
+
+## Linting
+
+* `npm run lint:hbs`
+* `npm run lint:js`
+* `npm run lint:js -- --fix`
+
+## Running tests
+
+* `ember test` – Runs the test suite on the current Ember version
+* `ember test --server` – Runs the test suite in "watch mode"
+* `ember try:each` – Runs the test suite against multiple Ember versions
+
+## Running the dummy application
+
+* `ember serve`
+* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
+
+For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018
+Copyright (c) 2019
 
 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:
 

README.md

@@ -1,6 +1,15 @@
 # ember-simple-tree
 
-Simple tree component for Ember without any dependency.
+Lightweight, composable tree component for Ember without any dependency.
+
+## Compatibility
+
+* Ember.js v2.16 or above
+* Ember CLI v2.13 or above
+
+If you are using 0.5.x and would like to upgrade to 0.6.0, please note there
+are BREAKING CHANGES. For details, see (Upgrading)[UPGRADING.md].
+
 
 ## Installation
 
@@ -17,6 +26,19 @@ Basic example:
 {{x-tree model=tree}}
 ```
 
+Standard example:
+
+```handlebars
+{{#x-tree
+  model=tree
+  checkable=true
+  as |node|
+}}
+  {{node.toggle}}
+  {{node.checkbox}}
+  {{node.model.name}}
+{{/x-tree}}
+```
 
 ### Available actions
 
@@ -115,21 +137,53 @@ Accepts: `boolean`
 When enabled, checking a box will also check children's boxes as well. Also enables indeterminate state for checkboxes.
 Has no effect if `checkable` is not enabled.
 
+#### expandedIcon
+
+Default: `x-tree-expanded-icon`,
+
+Accepts: `string` or `Component`
+
+```handlebars
+{{x-tree model=tree expandedIcon=(component "my-expanded-icon-component")}}
+```
+or
+```handlebars
+{{x-tree model=tree expandedIcon="my-expanded-icon-component"}}
+```
+
+Component to use for expanded icon
+
+#### collapsedIcon
+
+Default: `x-tree-collapsed-icon`,
+
+Accepts: `string`
+
+```handlebars
+{{x-tree model=tree collapsedIcon=(component "my-collapsed-icon-component")}}
+```
+or
+```handlebars
+{{x-tree model=tree collapsedIcon="my-collapsed-icon-component"}}
+```
+
+Component to use for collapsed icon
+
 ### Blocks
 
 You may optionally pass a block to the `x-tree` component to render each node area with custom HTML.
-The node area is the area directly to the right of each arrow (and possibly checkbox) in the tree.
-The Node yields back the model for each area so that you can use attributes dynamically.
 
 ```handlebars
 {{#x-tree
   chosenId=selectedNode
   checkable=isCheckable
   expandDepth=2
   onSelect=(action 'selectNode')
-  model=model as |node|}}
-    <i class="fa text-muted {{if node.isExpanded 'fa-folder-open' 'fa-folder'}}">&zwnj;</i>
-    {{node.name}}
+  model=model
+  as |node|
+}}
+  <i class="fa text-muted {{if node.isExpanded 'fa-folder-open' 'fa-folder'}}">&zwnj;</i>
+  {{node.model.name}}
 {{/x-tree}}
 ```
 

UPGRADING.md

@@ -0,0 +1,35 @@
+# Upgrading
+
+## from 0.5.x to 0.6.0
+
+If you are using the block form of the {{x-tree}} component,
+the expand/collapse toggle and the checkbox are no longer
+included in the custom HTML. Furthermore, the value yielded
+is no longer the model for the node, but an object containing
+the model and the components that are included.
+
+To upgrade, convert:
+
+```
+{{#x-tree
+  model=tree
+  checkable=true
+  as |node|
+}}
+  {{node.name}}
+{{/x-tree}}
+```
+
+to
+
+```
+{{#x-tree
+  model=tree
+  checkable=true
+  as |node|
+}}
+  {{node.toggle}}
+  {{node.checkbox}}
+  {{node.model.name}}
+{{/x-tree}}
+```

addon/components/x-tree-checkbox.js

@@ -0,0 +1,8 @@
+import Component from '@ember/component';
+import layout from '../templates/components/x-tree-checkbox';
+
+export default Component.extend({
+  layout,
+  tagName: 'span',
+  classNames: ['tree-checkbox']
+});