https://github.com/e0ipso/easy-factory

Simple base class for a consistent abstract factory pattern.
https://github.com/e0ipso/easy-factory

design factory patterns

Last synced: 6 days ago
JSON representation

Simple base class for a consistent abstract factory pattern.

• Host: GitHub
• URL: https://github.com/e0ipso/easy-factory
• Owner: e0ipso
• License: gpl-2.0
• Created: 2016-04-01T08:17:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-24T20:11:17.000Z (over 4 years ago)
• Last Synced: 2024-10-28T16:54:20.948Z (2 months ago)
• Topics: design, factory, patterns
• Language: JavaScript
• Size: 66.4 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/e0ipso/easy-factory.svg?branch=master)](https://travis-ci.org/e0ipso/easy-factory)

[![Coverage Status](https://coveralls.io/repos/github/e0ipso/easy-factory/badge.svg?branch=master)](https://coveralls.io/github/e0ipso/easy-factory?branch=master)

[![Known Vulnerabilities](https://snyk.io/test/github/e0ipso/easy-factory/badge.svg)](https://snyk.io/test/github/e0ipso/easy-factory)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

[![Greenkeeper badge](https://badges.greenkeeper.io/e0ipso/easy-factory.svg)](https://greenkeeper.io/)

[![NPM](https://nodei.co/npm/easy-factory.png)](https://nodei.co/npm/easy-factory/)

This module will help you to have consistent implementations of the [abstract

factory pattern](https://en.wikipedia.org/wiki/Abstract_factory_pattern).

Extend the Factory base class in your own factory and implement the getClass

static method with your business logic.

## Example

This is the example in the tests.

```js

'use strict';

const Factory = require('easy-factory');

/* eslint-disable global-require */

/**

 * @classdesc

 *   A factory class to get a fruit.

 *

 * @class FruitFactory

 */

class FruitFactory extends Factory {

  /**

   * Decide which fruit to instantiate based on the size and sugar.

   *

   * @param {object} context

   *   Contains the keys: 'size' and 'sugar'.

   *

   * @throws Error

   *   If no fruit could be found.

   *

   * @return {function}

   *   The fruit to instantiate.

   */

  static getClass(context) {

    if (typeof context.size === 'undefined' || typeof context.sugar === 'undefined') {

      throw new Error('Unable to find fruit.');

    }

    if (context.size >= 5) {

      // This is a big fruit.

      return context.sugar >= 5 ? require('./mango') : require('./pumpkin');

    }

    return context.sugar >= 5 ? require('./grape') : require('./almond');

  }

}

module.exports = FruitFactory;

```

Use it:

```js

const fruit = FruitFactory.create({size: 10, sugar: 10}, 'constructor argument');

console.log(fruit.name());

// Outputs 'Mango'.

```