Nocturnal Programmer's Machine
Miss any of our Open RFC calls?Watch the recordings here! »

ember-data-drupal

0.9.0 • Public • Published

ember-data-drupal

Requirements

  • Version 0.3.x targets the ALPHA 3 release of Drupal 8's JSON API module.
  • Version 0.4.x will target ALPHA 4 which has many changes and the plan is to jump to a 1.0 release the same time as the module does.

Initial docs can be found at http://boris.com.au/ember-data-drupal.

A demo Ember application is at https://github.com/boztek/ember-drupal-demo-front.

You can compare the tag before-drupal with the final result to see the changes to the models required to support a particular Drupal content model.

The demo app uses Mirage for a fake JSON API backend and can run with or without an actual Drupal server.

A demo CMS to plug in is at https://github.com/boztek/ember-drupal-demo-cms.

Installation

ember install ember-data-drupal

Usage

This addon provides an adapter and serializer that can be used application wide or on a per model basis in the usual way:

// app/adapter/application.js
import DrupalJSONAPIAdapter from 'ember-data-drupal/adapter';
export default DrupalJSONAPIAdapter.extend();

// app/serializer/application.js
import DrupalJSONAPISerializer from 'ember-data-drupal/serializer';
export default DrupalJSONAPISerializer.extend();

Configuration

Mapping of Ember data models to Drupal entities is currently done in application config:

e.g.

// config/environment.js
module.exports = function(environment) {
  var ENV = {
    drupalEntityModels: {
      // Map 'article' ember data model to Drupal entity type 'node'.
      "article": { },
      // Map 'public-event' ember data model to Drupal entity type 'node',
      // entity bundle type 'event'.
      // Also map event model fields 'location' and 'relatedArticle' to
      // 'field_location' and 'field_related_article' payload keys respectively.
      "public-event": { entity: 'node', bundle: 'event', fields: ['location', 'relatedArticle'] },
    }
  }
}

Running

Running Tests

  • npm test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

For more information on using ember-cli, visit http://ember-cli.com/.

Install

npm i ember-data-drupal

DownloadsWeekly Downloads

6

Version

0.9.0

License

MIT

Last publish

Collaborators

  • avatar