ampersandjs / ampersand-collection-underscore-mixin Goto Github PK

View Code? Open in Web Editor NEW

3.0 6.0 6.0 14 KB

A mixin for extending ampersand-collection with underscore methods.

License: MIT License

JavaScript 100.00%

ampersand-collection-underscore-mixin's Introduction

ampersand-collection-underscore-mixin

A mixin for extending ampersand-collection with underscore methods.

Deprecation Notice

As of v4.0.0 this is no longer mixed in to ampersand-rest-collection. Instead it uses ampersand-collection-lodash-mixin to match all other core module's move to using lodash. We no longer recommend using this module individually, and if you are we recommend converting to the lodash mixin.

install

npm install ampersand-collection-underscore-mixin

example

var Collection = require('ampersand-collection');
var underscoreMixin = require('ampersand-collection-underscore-mixin');


module.exports = Collection.extend(underscoreMixin, {
    sampleMethod: function () {
        // now we've got underscore methods 
        // we can call that are applied to models
        // in the collection.
        this.filter( ... );
        this.some( ... );
        this.each( ... )
    }
});

credits

All credit for underscore and this approach in backbone goes to Jeremy Ashkenas and the rest of the Backbone and Underscore authors.

If you like this follow @HenrikJoreteg on twitter.

license

MIT

ampersand-collection-underscore-mixin's People

Contributors

Stargazers

Watchers

Forkers

javascript-forks strml phated klaemo

ampersand-collection-underscore-mixin's Issues

Mark as deprecated with explanation

Once AmpersandJS/ampersand-rest-collection#22 is complete, we should add a deprecation notice to the readme explaining why it is no longer desirable to use this repo since we've made the switch to using lodash everywhere else.

The main reason is that it will increase the filesize by adding an extra underscore dependency that will only be used by this module.

Needs basic test suite with tape.js

this._reset() is undefined

I was going through the Human JavaScript online videos when I encountered an error during 4-5 "Creating a collection for users".

TypeError: 'undefined' is not a function (evaluating 'this._reset()')

This error is traced back to the Collection function within ampersand-collection.js

function Collection(models, options) {
  options || (options = {});
  if (options.model) this.model = options.model;
  if (options.comparator) this.comparator = options.comparator;
  if (options.parent) this.parent = options.parent;
  this._reset();
  this.initialize.apply(this, arguments);
  if (models) 
    this.reset(models, extend({
      silent: true
    }, options));
}

I think it may have something to do with the recent update to Underscore to 1.7.0, which apparently had some breaking changes. I tried rolling back the dependency to 1.6.0 but it is still breaking.

Any help would be great.

Move to lodash

I've prepared a lodash version of this repo. https://github.com/STRML/ampersand-collection-lodash-mixin

Re: ampersand#36, underscore may be removed entirely from ampersand. However a lot of people like lodash/underscore methods on their collections.

I often use some of the lodash-only syntax like collection.find({prop: 'value'}), so I forked and switched to lodash. Perhaps this could be published as another mixin.

Consider using lodash instead of underscore?

http://lodash.com has compatibility with underscore, is faster and has the option of just including the functions you want to use https://www.npmjs.org/browse/keyword/lodash-modularized