vegas-js-data

VEGAS JS

Vegas JS SYSTEM/DATA - version 1.0.11 is an Opensource Library based on ECMAScript for develop crossplatform Rich Internet Applications and Games.

The {@link system.data} library provides a framework unified for representing and manipulating collections, enabling them to be manipulated independently of the details of their representation. It reduces programming effort while increasing performance. It enables interoperability among unrelated APIs, reduces effort in designing and learning new APIs, and fosters software reuse.

The framework is based on a serie of interfaces. It includes implementations of these interfaces and algorithms to manipulate them.

An abstract data type (ADT) is a model for a certain class of data structures that have similar behavior; or for certain data types of one or more programming languages that have similar semantics. The collections framework is a unified architecture for representing and manipulating collections, allowing them to be manipulated independently of the details of their representation. It reduces programming effort while increasing performance.

Originaly the {@link system.data} collection framework is loosely inspired on the JAVA Collections Framework and the Jakarta Collections Framework but with the new ES6 standard we change the basic implementation of the new VEGAS JS framework in the JS version of the library.

This framework is inspired on interfaces to defines the different types of collections : * Map * Bag * Collections * Iterator * Set * Queue & Stack...

About

• Author : Marc ALCARAZ (aka eKameleon) - Creative Technologist and Digital Architect
• Mail : ekameleon[at]gmail.com
• LinkedIn : https://www.linkedin.com/in/ekameleon/

License

Under tree opensource licenses :

• License MPL 2.0
• License GPL 2.0+
• License LGPL 2.1+

Resources

⌜ Download

Download on Bitbucket the latest code, report an issue, ask a question or contribute :

• https://bitbucket.org/ekameleon/vegas-js-data

⌜ Documentation

Get started with the the Vegas JS API :

• https://vegasjs.ooopener.com/

⌜ Slack Community

Send us your email to join the VEGAS community on Slack !

Install

⌜ YARN / NPM

You can install VEGAS JS with NPM or Yarn.

$ yarn add vegas-js-data --dev

or

$ npm install vegas-js-data --save-dev

Building and test the libraries

VEGAS JS SYSTEM DATA library use Yarn with a serie of powerful packages (Babel, Mocha, etc.) to compile and build this library.

⌜ Simple Build

1 - The first time, initialize the project and run yarn :

$ yarn

2 - Test + compile all the libraries :

$ yarn build

⌜ VEGAS (only) Build

1 - Build the ./dist/vegas.data.js : not minified + no comments + sourcemap.

$ yarn dev

2 - Build the ./dist/vegas.data.js and watch the changing into the ./src folder.

$ yarn watch

3 - Build the ./dist/vegas.data.min.js : minified + no comments.

$ yarn prod

4 - Build the ./dist/vegas.data.min.js and the ./dist/vegas-core.js libraries only.

$ yarn start

⌜ Examples

To launch the HTML examples, use the command :

$ yarn example ./examples/system/data/maps/index.html

This command launch with the BrowserSync tool the html page of the example in your browser.

⌜ Unit tests

We use the Mocha and the Chai (http://chaijs.com/) tools to run the unit tests of the VEGAS JS libraries.

1 - Run all unit tests

$ yarn test

2 - Run a specific library, use one of this command :

The --match option trigger the unit test engine (based on Mocha) to only run tests matching the given pattern which is internally compiled to a RegExp, for examples :

$ yarn test -g system.data

Run all the core.maths package unit tests.

$ yarn test -g system.data.Attribute

Run only the core.colors.distance unit tests or the core.arrays.contains module unit tests.

The --reporter option define the unit test result rendering in the terminal with the values : 'spec', 'dot', 'landing', 'dot', 'nyan', 'list', 'mochawesome'. By default the 'spec' value is used.

$ yarn test --reporter nyan

⌜ Generates the documentation

The documentation of the framework is based on JSDoc.

Run the documentation build with gulp :

$ yarn doc

The documentation is generated in the folder : ./docs/bin

History

• 1998 : Flash
• 2000 : First framework concept and first libraries (components, tools, design patterns)
• 2004 : First official SVN repository
• 2007 : Fusion with the Maashaack framework (eden, etc.)
• 2015 : Google Code must die - VEGAS move from an old Google Code SVN repository to this Bitbucket GIT repository and REBOOT this source code.
• 2016 : Begin the new JS architecture of the VEGAS JS library based on ES6
• 2018 : Cut the JS packages of VEGAS in a set of independent libraries.