@cityads/ember-data-change-tracker 0.11.4 → 0.12.0-beta.1

package/README.md

@@ -10,13 +10,13 @@
         attributes. But if you don't have object types it works fine.  
 
 This addon aims to fill in the gaps in the change tracking / rollback that ember data does now.
- 
+
  - Currently ember-data 
     - tracks changes for numbers/strings/date/boolean attributes
     - has a ```changedAttributes()``` method to see what changed => [ last, current ]
     - has a ```rollbackAttributes()``` method to rollback attributes
     - has a ```hasDirtyAttributes``` computed property 
-  
+
  - This addon:
     - tracks modifications in attributes that are object/json/custom type
     - tracks replacement of belongsTo associations
@@ -31,7 +31,7 @@ This addon aims to fill in the gaps in the change tracking / rollback that ember
     - Can be used in two modes 
       - auto track mode
       - manual track mode ( the default )
-       
+
 ## Installation
 
 * `ember install @cityads/ember-data-change-tracker`
@@ -42,22 +42,36 @@ This addon aims to fill in the gaps in the change tracking / rollback that ember
 
 ```javascript
   export default Model.extend({
-       name: attr('string'),  // ember-data tracks this already
-       info: attr('object'),  // ember-data does not track modifications
-       json: attr(),          // ember-data does not track modifications if this is object
-       company: belongsTo('company', { async: false, polymorphic: true }),  // ember-data does not track replacement
-       profile: belongsTo('profile', { async: true }), // ember-data does not track replacement
-       projects: hasMany('project', { async: false }), // ember-data does not track additions/deletions
-       pets: hasMany('pet', { async: true, polymorphic: true }) // ember-data does not track additions/deletions
-   });
+    name: attr('string'),  // ember-data tracks this already
+    info: attr('object'),  // ember-data does not track modifications
+    json: attr(),          // ember-data does not track modifications if this is object
+    company: belongsTo('company', { async: false, polymorphic: true }),  // ember-data does not track replacement
+    profile: belongsTo('profile', { async: true }), // ember-data does not track replacement
+    projects: hasMany('project', { async: false }), // ember-data does not track additions/deletions
+    pets: hasMany('pet', { async: true, polymorphic: true }) // ember-data does not track additions/deletions
+  });
 ```
 
   You can not currently rollback the info, json if they are modified 
     or company, profile, projects and pets if they change.
-  
-  
+
+
+### setting up tracking
+
+  This addon exports a mixin you should add to the models you want to track:
+
+```javascript
+  import ChangeTracker from '@cityads/ember-data-change-tracker/mixins/change-tracker';
+
+  export default Model.extend(ChangeTracker, {
+    name: attr('string'),
+    ...
+    pets: hasMany('pet', { async: true, polymorphic: true })
+  });
+```
+
 ### model changes
-  
+
   - The method ```modelChanges()``` is added to model
   - Shows you any changes in an object attribute type
     - whether modified or replacing the value
@@ -73,7 +87,7 @@ This addon aims to fill in the gaps in the change tracking / rollback that ember
 Example: ( remove from a hasMany )
 ```javascript
   user.get('projects').removeObject(firstProject); // remove project1
-  user.modelChanges() //=> {projects: true }
+  user.modelChanges() //=> { projects: true }
 ```
 
 
@@ -103,9 +117,9 @@ Usage:
 
     // manual tracking model means you have to explicitly call => startTrack
     // to save the current state of things before you edit
-    user.startTrack();   
+    user.startTrack();
 
-    // edit things  
+    // edit things
     user.setProperties({
       'info.foo': 3,
       company: smallCompany,
@@ -144,15 +158,15 @@ Usage:
 
     let user = make('user', { company: bigCompany, pets });
 
-    user.startTrack();   
+    user.startTrack();
 
-    // edit things  
+    // edit things
     user.set('name', "new name");
     user.get('isDirty'); //=> true
-    
+
     user.rollback();
     user.get('isDirty'); //=> false
-    
+
     user.set('company', smallCompany);
     user.get('hasDirtyRelations'); //=> true
     user.get('isDirty'); //=> true
@@ -163,18 +177,18 @@ Usage:
     user.set('pets', [cat, cat2]);
     user.get('hasDirtyRelations'); //=> true
     user.get('isDirty'); //=> true
-    
+
     user.rollback();
     user.get('isDirty'); //=> false
 
-    // things that don't work      
-    user.set('info.foo', 3); 
+    // things that don't work
+    user.set('info.foo', 3);
     user.get('isDirty'); //=> false ( object/array attributes don't work for computed isDirty )
 
 ```
 
 ### Configuration
-  
+
   - Global configuration 
     - By default the global settings are: 
       - { **trackHasMany**: *true*, **auto**: *false*, **enableIsDirty**: *false* }
@@ -305,4 +319,4 @@ moduleForModel('project', 'Unit | Model | project', {
   }
 });
 
-```                                   
+``` 

package/addon/index.js

@@ -1,4 +1,5 @@
-import {initializer} from './initializer';
+import changeTracker from './mixins/change-tracker';
 import keepOnlyChanged from './mixins/keep-only-changed';
+import Model from './model';
 
-export {keepOnlyChanged, initializer};
+export { changeTracker, keepOnlyChanged, Model };

package/addon/{model-ext.js → mixins/change-tracker.js}

@@ -1,10 +1,8 @@
 import Ember from 'ember';
-import Model from 'ember-data/model';
-import Tracker from './tracker';
+import Mixin from '@ember/object/mixin';
+import Tracker from '../tracker';
 
-const assign = Object.assign || Ember.assign || Ember.merge;
-
-Model.reopen({
+export default Mixin.create({
 
   init(){
     this._super(...arguments);
@@ -42,7 +40,7 @@ Model.reopen({
    * @returns {*}
    */
   modelChanges() {
-    let changed = assign({}, this.changedAttributes());
+    let changed = { ...this.changedAttributes() };
     let trackerInfo = Tracker.metaInfo(this);
     for (let key in trackerInfo) {
       if (!changed[key] && trackerInfo.hasOwnProperty(key)) {

package/addon/mixins/keep-only-changed.js

@@ -1,7 +1,7 @@
-import Ember from 'ember';
+import Mixin from '@ember/object/mixin';
 
 // EmberData does not serialize hasMany relationships by default
-export default Ember.Mixin.create({
+export default Mixin.create({
   keepValue(record, key) {
     return record.get('isNew') || record.didChange(key);
   },

package/addon/model.js

@@ -0,0 +1,4 @@
+import Model from 'ember-data/model';
+import changeTracker from './mixins/change-tracker';
+
+export default Model.extend(changeTracker);

package/addon/tracker.js

@@ -1,7 +1,6 @@
 import Ember from 'ember';
 import { didModelChange, didModelsChange, relationShipTransform, relationshipKnownState } from './utilities';
 
-const assign = Object.assign || Ember.assign || Ember.merge;
 export const ModelTrackerKey = '-change-tracker';
 export const RelationshipsKnownTrackerKey = '-change-tracker-relationships-known';
 const alreadyTrackedRegex = /^-mf-|string|boolean|date|^number$/,
@@ -165,7 +164,7 @@ export default class Tracker {
   static options(model) {
     let envConfig = this.envConfig(model);
     let modelConfig = this.modelConfig(model);
-    let opts = assign({}, defaultOpts, envConfig, modelConfig);
+    let opts = { ...defaultOpts, ...envConfig, ...modelConfig };
 
     let unknownOpts = Object.keys(opts).filter((v) => !knownTrackerOpts.includes(v));
     Ember.assert(`[ember-data-change-tracker] changeTracker options can have

package/addon/transforms/object.js

@@ -1,19 +1,19 @@
-import DS from 'ember-data';
-import Ember from 'ember';
+import Transform from 'ember-data/transform';
+import { isEmpty, typeOf } from '@ember/utils';
 
-export default DS.Transform.extend({
+export default Transform.extend({
   serialize: function(value) {
     return value && JSON.stringify(value);
   },
   
   deserialize: function(value) {
-    if (Ember.isEmpty(value)) {
+    if (isEmpty(value)) {
       return {};
     }
-    if (Ember.typeOf(value) === "object") {
+    if (typeOf(value) === 'object') {
       return value;
     }
-    if (Ember.typeOf(value) === 'string') {
+    if (typeOf(value) === 'string') {
       return JSON.parse(value);
     }
   }

package/app/mixins/change-tracker.js

@@ -0,0 +1 @@
+export { default } from '@cityads/ember-data-change-tracker/mixins/change-tracker';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityads/ember-data-change-tracker",
-  "version": "0.11.4",
+  "version": "0.12.0-beta.1",
   "description": "Track changes and rollback object attributes and relationships. Ember data 2.5+",
   "keywords": [
     "ember-addon",
@@ -32,7 +32,7 @@
     "@ember/optional-features": "^0.7.0",
     "broccoli-asset-rev": "^2.7.0",
     "ember-fetch": "^6.5.1",
-    "ember-cli": "3.8",
+    "ember-cli": "~4.8.1",
     "ember-cli-app-version": "^2.0.0",
     "ember-cli-dependency-checker": "^3.2.0",
     "ember-cli-eslint": "^4.2.3",
@@ -43,7 +43,7 @@
     "ember-cli-release": "^0.2.9",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-uglify": "^1.2.0",
-    "ember-data": "3.8",
+    "ember-data": "~4.7.3",
     "ember-data-factory-guy": "3.9.4",
     "ember-data-model-fragments": "4.0.0",
     "ember-disable-prototype-extensions": "^1.1.0",
@@ -51,7 +51,7 @@
     "ember-load-initializers": "^2.0.0",
     "ember-resolver": "5.0.1",
     "ember-sinon": "4.0.0",
-    "ember-source": "3.8",
+    "ember-source": "~4.8.0",
     "ember-source-channel-url": "^1.1.0",
     "ember-try": "^0.2.23",
     "loader.js": "4.7.0"

package/addon/initializer.js

@@ -1,4 +0,0 @@
-/* global require */
-export function initializer() {
-  require('@cityads/ember-data-change-tracker/model-ext');
-}

package/app/initializers/ember-data-change-tracker.js

@@ -1,7 +0,0 @@
-import {initializer as initialize} from '@cityads/ember-data-change-tracker';
-
-export default {
-  name: 'ember-data-change-tracker',
-  after: 'ember-data',
-  initialize
-};