❤
npm
Sign UpSign In

mixin-interface-api

0.1.32 • Public • Published

mixin-interface-api

A lightweight interface class API in Javascript es6 (ECMAScript 2015). It is implementated with mixins, Type checking and inheritance are supported.

Release 0.1.32 changelog

This release brings a much better and modern implementation of the Log feature with the sink metaphor.

This idea is neither new nor mine but I thought that it would be very nice to have. You're welcome to read this article and take a look at the Serilog library.

Now the Log client sends a trace request (MxI.$Log.write()), then the trace message is eventually processed by being sent to a specific target (e.g. Console, File, Server, Database, etc...). The sink(s) must be explicitly declared (MxI.$Log.addSink()) else the trace request is not processed.

Notice that sink classes must implement MxI.$ILogSink but they are no more singletons.

  • Major refactoring of Log API: step 1/2 - move some classes from mixin-interface to mixin-interface-api
    • MxI.$ILogger interface moved and renamed to MxI.$ILogSink.
    • MxI.$DefaultLogger implementation moved and renamed to MxI.$ConsoleLogSink.
    • Implementation of Log feature moved from MxI.$System class to MxI.$Log class. Please notice that the previous API (e.g. MxI.$System.log()) is still supported but is now deprecated.

  • Major refactoring of Log API: step 2/2 - New implementation classes in mixin-interface-api
    • MxI.$Log is the new implementation of the Log feature in which trace requests are processed by sink(s). A sink redirects traces (MxI.$Log.write() calls) to specific target (e.g. $ConsoleLogSink redirects to the console).
    • MxI.$FileLogSink is a sink which redirects traces (MxI.$Log.write() calls) to a file (e.g. log.txt).

Release 0.1.6 changelog

  • Documentation upgrade 1/2: UML model diagram for the implementation sample
  • Documentation upgrade 2/2: Paragraphs reordering ( Sample UML Model, "howtos" i.e How to Define an Interface class and Core API Reference are now before Installation and Usage and How to run the Unit Test)

Sample UML Model

alt text

Please find below the explanations with wich you may implement this model with the Core API privided by mixin-interface-api

How to Define an Interface class

Here is an example of an interface class (see ./src/test_classes/i_life_form.js. Here we define a single service: live()

  • Inherit from MxI.$IBaseInterface (or any other super_interface if applicable) by using MxI.$Interface() just after the es6 extends keyword to define both that it is an interface class and that its super_interface is MxI.$IBaseInterface.
  • Use MxI.$raiseNotImplementedError() in order to guarantee that the service is provided by the implementation. This should be put in the Fallback implementation of each service defined by the interface.

This will raise an Error if an implementation which declares it implements this interface misses one or more service implemention(s) (see paragraph on MxI.$raiseNotImplementedError API service at the end of this document).

  • Add the MxI.$setAsInterface().$asChildOf() idiom after the class definition to define that this is an interface_class and what is its superclass.

Note: To remind that a class is an interface class, it is strongly advised to use the 'I prefix' naming convention as a reminder. This is a reminiscence of Hungarian notation , a fairly old identifier naming convention (e.g. see Microsoft COM)

const MxI = require('../mixin_interface_api.js').MxI;
//==================== 'ILifeForm' interface class ====================
class ILifeForm extends MxI.$Interface(MxI.$IBaseInterface) {  
  // Fallback implementation of 'live' service
  live() {
    MxI.$raiseNotImplementedError(ILifeForm, this);
  } // ILifeForm.live()
} // 'ILifeForm' class
MxI.$setAsInterface(ILifeForm).$asChildOf(MxI.$IBaseInterface);
exports.ILifeForm = ILifeForm;

Note: Each interface class must have a superclass (MxI.$IBaseInterface if no other interface class applies). In the previous case MxI.$setAsInterface() may be used without appending .$asChildOf(super_interface) idiom because MxI.$IBaseInterface will be the default superclass. However it is both cleaner, safer, more consistent and strongly advised to always use the full idiom (MxI.$setAsInterface().$asChildOf())

How to subclass an Interface class

Here is an example of a subclass of an interface class (see ./src/test_classes/i_animal.js). Here we want to define IAnimal as a subclass of the ILifeForm interface class.

  • Use this syntax: class IAnimal extends $Interface() to define that IAnimal is a subclass of ILifeForm.
  • Add the MxI.$setAsInterface().$asChildOf() idiom just after the class definition.

This is required so that MxI.$isInstanceOf() works properly to identify an object both as an being an instance of an implementation class (and its superclasses) as well being an instance of an interface class (and its superclasses).

  • We then define a new service: run(). It will be a regular method of a javascript es6 class.
  • Use MxI.$raiseNotImplementedError() in order to guarantee that the service is provided by the implementation class. This should be put in the Fallback implementation of each service defined by the interface.

This will raise an error if the implementation class does'nt provide (directly or via inheritance) one of the service(s) defined by the interface class(es) (see paragraph on MxI.$raiseNotImplementedError API service at the end of this document).

const MxI       = require('../mixin_interface_api.js').MxI;
const ILifeForm = require('./i_life_form.js').ILifeForm;
//==================== 'IAnimal' interface class ====================
class IAnimal extends MxI.$Interface(ILifeForm)  {
  // Fallback implementation of 'run' service
  run() {
    MxI.$raiseNotImplementedError(IAnimal, this);
  } // IAnimal.run
} // 'IAnimal' class
MxI.$setAsInterface(IAnimal).$asChildOf(ILifeForm);
exports.IAnimal = IAnimal;

How to code an Implementation class

Here is an example of an implementation class (see ./src/test_classes/animal.js). An implementation may implement one or more interface classes. To implement the services (i.e. defined by the interface class(es) that are declared as implemented by this class) we must:

  • Inherit from MxI.$Object (or any of its subclasses) by using the MxI.$Implementation().$with() idiom just after the es6 extends keyword to define both a subclass and the interface class(es) that it implements (IAnimal here).

Inheriting from MxI.$Object also provides the automatic instance naming feature (this feature is provided by the name attribute on each instance of MxI.$Object or any of its subclasses. Each instance name is generated from its class name and its instance count. Instances are named with SerpentCase pattern (e.g. flying_fish_0)

  • Put MxI.$setClass(Animal).$asImplementationOf(ILifeForm, IAnimal) idiom just after the class definition.

This is syntactically redundant but nevertheless required in order that MxI.$isInstanceOf() works correctly (see paragraph on MxI.$isInstanceOf API service at the end of this document).

  • Provide implementation of all services (e.g. live(), run(), ...) defined in each interface as well as their parent interfaces.

If a service is not provided it may be inherited from the parent implementation class.

const MxI        = require('../mixin_interface_api.js').MxI;
const IAnimal    = require('./i_animal.js').IAnimal;
const ILifeForm  = require('./i_life_form.js').ILifeForm;
//==================== 'Animal' implementation class ====================
class Animal extends MxI.$Implementation(MxI.$Object).$with(IAnimal) {
  constructor() {
    super();
  } // 'Animal' constructor
 
  run() {
    MxI.$Log.write("--> Animal.run: '%d'", this);
  } // IAnimal.run()
 
  live() {
    MxI.$Log.write("--> Animal.live: '%d'", this);
  } // ILifeForm.live()
} // 'Animal' class
MxI.$setClass(Animal).$asImplementationOf(IAnimal, ILifeForm);

How to subclass an Implementation class

Here is an example of how to subclass an implementation class (see ./src/test_classes/cat.js). Here we want to both to subclass Animal and implement the IMammal interface class, this is how to do it:

  • Inherit from Animal by using the MxI.Implementation().$with() idiom just after extends to define both a subclass and the interfaces that it implements.
  • Provide implementation of the service defined by IMammal (suckle()). If a service from the parent interfaces is not provided then it may be inherited from the parent implementation class.

Notice this is the case in the following sample: for run() an live(), as they are disabled by the __ prefix then it is the implementation from the parent class which is inherited instead.

  • Add the MxI.$setClass(Cat).$asImplementationOf(IMammal) idiom just after the class definition.

This is required so that MxI.$isInstanceOf() works properly to identify an object both as being an instance of an implementatio class (and its superclass(es)) as well being an instance of an interface class (and its superclass(es)).

const MxI     = require('../mixin_interface_api.js').MxI;
const Animal  = require('./animal.js').Animal;
const IMammal = require('./i_mammal.js').IMammal;
//==================== 'Cat' implementation class ====================
class Cat extends MxI.$Implementation(Animal).$with(IMammal) {
  constructor() {
    super();
  } // 'Cat' constructor
 
  suckle() {
    MxI.$Log.write("--> Cat.suckle: '%d'", this);
  } // IMammal.suckle()
 
  __run() {
    MxI.$Log.write("--> Cat.run: '%d'", this);
  } // IAnimal.run()
 
  __live() {
    MxI.$Log.write("--> Cat.live: '%d'", this);
  } // ILifeForm.live()
} // 'Cat' class
MxI.$setClass(Cat).$asImplementationOf(IMammal);

Notice that IAnimal.run() and ILifeForm.live() services are not provided, so they are inherited from the parent implementation class (Animal).

API Reference - Foreword

Please note the following keywords and their meaning:

API service: function provided by 'mixin-interface' (e.g. Mxi.$isInstanceOf())
MxI: namespace for all the mixin-interface API services
object: _instance of an implementation class
service: function defined by an interface class (e.g. IAnimal.run())
type: either an implementation class (e.g. Animal) or an interface class (e.g. IAnimal)
interface: interface class
super_interface: superclass of the interface class
implementation: implementation class
super_implementation: superclass of the implementation class
...interfaces: list of implemented interfaces. The list is provided as interface class(es) separated by a comma (e.g. ILifeForm and IAnimal, ILifeForm are valid ...interfaces arguments)

Core API reference

  • MxI.$isInstanceOf(): replacement for javascript instanceof operator

  • MxI.$isInterface(): checks if a type is an interface class or not

  • MxI.$implements(): checks if a type implements an interface class or not

  • MxI.$getSuperclass(): get the superclass of a a _type

  • MxI.$Interface(): defines an interface class and its super_interface

  • MxI.$setAsInterface().$asChildOf(): defines that a class is an interface class and its super_implementation

This is syntactically redundant but nevertheless required in order that MxI.$isInstanceOf() works correctly

  • MxI.$Implementation().$with(): defines an implementation class and its superclass (Mxi.$Object if no other class applies)

  • MxI.$setClass().$asImplementationOf(): defines the interface class(es) implemented by an implementation class

  • MxI.$raiseNotImplementedError(): error handling when a service (defined by of an interface class) is not implemented

  • MxI.$Object.init(): Delayed Initialization feature

  • MxI.$Object.isInitialized(): checks if an object has been initialized

  • MxI.$ISingleton: interface class for the Singleton (i.e. Unique instance) design pattern (see design-patterns-api)

  • MxI.$Singleton: Default implementation for MxI.$ISingleton interface

  • MxI.$isSingleton(): Checks if an object is a Singleton

  • MxI.$setAsSingleton(): Required to define that an implementation is a Singleton

  • MxI.$INullObject: interface class for the Null Object design pattern (see design-patterns-api)

  • MxI.$NullObject: Default implementation for MxI.$INullObject interface

  • MxI.$Null: Singleton of MxI.$NullObject

  • MxI.$isNull(): Returns true in 2 cases. The first is when the input value is an object which is both a Null Object an a Singleton (typically the 'default Null Object' which is MxI.$Null). The second case is when the input value is undefined

  • Log Feature

This feature was previously provided as an extension (MxI.$System, provided by mixin-interface). MxI.$System still supports the previous implementation but is now deprecated.

  • MxI.$ILogSink: interface class for a sink (implementation of the Log feature, previously called Logger).
  • MxI.$Log.write(): new implementation of trace requests (previously MxI.$System.log()).
  • MxI.$Log.banner(): outputs a message within a banner.
  • MxI.$Log.addSink(): declares a sink object (which must implement $ILogSink).
  • MxI.$Log.getSinkCount(): returns the number of sinks.
  • MxI.$Log.clearSinks(): deletes all the sinks.
  • MxI.$ConsoleLogSink: default sink implementation class (sends trace messages to the console).
  • MxI.$FileLogSink: default sink implementation class (sends trace messages to a file - e.g. ./log.txt).

Check if an object is an instance of a Type

MxI.$isInstanceOf(type, object)

This service provides type-checking for an object (see ./test.js for a unit test of this feature). The type argument is either an implementation class or an interface class. This API service allows to identify an object as being both an instance of an interface class (and its superclass(es)), as well as an instance of an implementation class (and its superclass(es)

This service is a replacement for javascript instanceof operator

var a_cat = new Cat();
MxI.$Log.write(a_cat.name + " is a 'IMammal': " + MxI.$isInstanceOf(IMammal, a_cat));

Check if a type is an Interface class

MxI.$isInterface(type)

This service checks if type is an interface class (see ./test.js for a unit test of this feature). The type argument is either an implementation class or an interface class.

MxI.$Log.write("'IAnimal' is an interface ? " + MxI.$isInterface(IAnimal));

Check if an implementation implements an interface class

MxI.$implements(implementation, interface)

Get the superclass of a type

MxI.$getSuperclass(type)

Definition of an Interface class

MxI.$Interface(super_interface)
MxI.$setAsInterface(interface).$asChildOf(super_interface) 

These services allow to define an interface class:

  • Use MxI.$Interface() after the extends clause of the es6 javascript class definition
  • After the class definition, use the MxI.$setAsInterface().$asChildOf() idiom

Example (see ./src/test_classes/i_animal.js for a full sample):

class IAnimal extends MxI.$Interface(ILifeForm)  {
  ...
} // 'IAnimal' class
MxI.$setAsInterface(IAnimal).$asChildOf(ILifeForm);

This code means that IAnimal is an interface class which is a subclass of ILifeForm

Implementation of Interface class(es)

MxI.$Implementation(super_implementation).$with(...interfaces)
MxI.$setClass(implementation).$asImplementationOf(...interfaces)

These services allow to define an implementation class:

  • Use MxI.$Implementation() after the extends clause of the es6 javascript class definition
  • After the class definition, use the MxI.$setClass().$asImplementationOf() idiom

Example (see ./src/test_classes/animal.js for a full sample):

class Animal extends MxI.$Implementation(MxI.$Object).$with(IAnimal) {
  ...
} // 'Animal' class
MxI.$setClass(Animal).$asImplementationOf(IAnimal, ILifeForm);

This code means:

  • Animal is an implementation class which is a subclass of MxI.$Object
  • Animal implements both IAnimal and ILifeForm interface classes

Error Handling: 'service not implemented'

MxI.$raiseNotImplementedError(_interface_, this)

This service provides Error Handling when a service of an interface class is not provided by an implementation class. It should be used in the Fallback implementation for each service defined by the interface class. Here is an example of how to use this API service (see ./src/test_classes/i_life_form.js:

class ILifeForm extends MxI.$Interface(MxI.$IBaseInterface) {  
  // Fallback implementation of 'live' service
  live() {
    MxI.$raiseNotImplementedError(ILifeForm, this);
  } // ILifeForm.live()
} // 'ILifeForm' class
MxI.$setAsInterface(ILifeForm).$asChildOf(MxI.$IBaseInterface);

Let's see what happens if the Animal implementation doesn't provide an implementation for the run() service §defined by IAnimal interface class). If you want to test this use case, just rename run() to __run() in ./src/test_classes/animal.js ), then restart the Unit Test with node test.js in the command shell. An exception should be raised an you would get the following output:

    throw new Error(error_msg);
    ^

Error: ** mixin-interface-api **
   Error code:  SERVICE_NOT_IMPLEMENTED
   Description: 'IAnimal.run' not found on 'animal_0'

    at throwErrorMessage (D:\_Dev\NodeJS\github\mixin-interface-api\src\mixin_interface_api.js:31:11)
    at Object.$raiseNotImplementedError (D:\_Dev\NodeJS\github\mixin-interface-api\src\mixin_interface_api.js:45:9)
    at Animal.run (D:\_Dev\NodeJS\github\mixin-interface-api\src\test_classes\i_animal.js:16:9)
    at Object.<anonymous> (D:\_Dev\NodeJS\github\mixin-interface-api\test.js:34:13)
    ...
...

Delayed Object Initialization

MxI.$Object().init(...args_init)
MxI.$Object().isInitialized()

These services provide the Delayed Initialization feature.

Once init() service is called, if args_init is provided it is accessible to all instances of implementation class(es) via this._$args_init.

An object may be initialized only once: this._$args_init cannot then be set or changed.

Short explanation on Delayed Initialization: a typical example in GUI programming is when you need a widget (e.g. PushButton) but its container (e.g. CommandBar) is not yet created or known at instanciation time, so you may use later init() service so that the PushButton can set its container (e.g. by calling setContainer() in the PushButton's implementation of init() service).

'Singleton' feature

MxI.$ISingleton
MxI.$Singleton
MxI.$isSingleton(object) 
MxI.$setAsSingleton(implementation)

Please find below a code sample from ./test_.js which uses MxI.$isSingleton():

MxI.$Log.write("isSingleton(%s):  %s", MxI.$Null, MxI.$isSingleton(MxI.$Null));

Please find below a code sample from ./src/mixin_interface_api.js which uses MxI.$setAsSingleton():

class $NullObject extends $Implementation($Singleton).$with($ISingleton, $INullObject) { 
    constructor(...args) {
        super();
        this._$name = MXI_NULL;
    } // '$NullObject' constructor
} // '$NullObject' implementation class
$setClass($NullObject).$asImplementationOf($INullObject, $ISingleton);
$setAsSingleton($NullObject);

'Null Object' feature

MxI.$INullObject
MxI.$NullObject
MxI.$Null
MxI.$isNull(object)

Example: a default implementation of MxI.$INullObject interface

class $NullObject extends $Implementation($Singleton).$with($ISingleton, $INullObject) { 
    constructor(...args) {
        super();
        this._$name = MXI_NULL;
    } // '$NullObject' constructor
} // '$NullObject' implementation class
$setClass($NullObject).$asImplementationOf($INullObject, $ISingleton);
$setAsSingleton($NullObject);

Please find below a code sample which both logs MxI.$Null singleton and calls MxI.$isNull()

MxI.$Log.write("MxI.$isNull(%s):   %s", MxI.$Null, MxI.$isNull(MxI.$Null));

MxI.$isNull() Returns true in 2 cases. The first is when the input value is an object which is both a Null Object an a Singleton (typically the 'default Null Object' which is MxI.$Null). The second case is when the input value is undefined

Installation and Usage

npm install mixin-interface-api -S

How to run the Unit Test

Step 1: Install Prerequisite Tools

Install NodeJS and Git

Step 2: Clone the 'mixin-interface-api' repository locally

Open a command shell then enter the following commands:

git clone git://github.com/Echopraxium/mixin-interface-api
cd mixin-interface-api
npm update

Step 3: Run the Unit Test

Now enter the following command:

node test.js

You should get this kind of output (please find here the full output):

=============================================================
======== Unit Test for 'mixin-interface-api' package ========
=============================================================
1.Instance of 'Animal' created: animal_0
'animal_0' is a 'MxI.$Object' ?    true
'animal_0' is a 'ILifeForm' ?      true
'animal_0' is a 'IAnimal' ?        true
'animal_0' is a 'Animal' ?         true
'animal_0' is a 'IMammal' ?        false
--> Animal.run
--> Animal.live
----------
2. Instance of 'Cat' created: cat_0
'cat_0' is a 'MxI.$Object' ? true
'cat_0' is a 'Animal' ?      true
'cat_0' is a 'Cat' ?         true
'cat_0' is a 'ILifeForm' ?   true
'cat_0' is a 'IAnimal' ?     true
'cat_0' is a 'IMammal' ?     true
--> Animal.run
--> Cat.suckle
--> Animal.live
...

Please notice in the previous output that an implementation class may inherit functions (i.e implementation of services from interface classes) from its parent class (e.g. FlyingFish inherits IAnimal.run() and IAnimal.live() implementations from Animal) but it is also possible to override these default implementations them as well.

References

Readme

Keywords

Package Sidebar

Install

npm i mixin-interface-api

Repository

github.com/Echopraxium/mixin-interface-api

Homepage

github.com/Echopraxium/mixin-interface-api#readme

Weekly Downloads

1

Version

0.1.32

License

MIT

Last publish

Collaborators

  • echopraxium
Try on RunKit
Report malware