foam-framework / foam2

FOAM: Feature-Oriented Active Modeller, Version 2

FOAM

Build fully featured high performance apps in less time using FOAM.

• Application Speed
• Application Size
• Developer Efficiency

"Fast apps Fast"

http://foamdev.com

Feature Oriented Active Modeller

FOAM is a modeling tool and class based object system. To use FOAM, you create a model of your class by describing the properties, methods, event topics, listeners, and dependencies of your class. FOAM takes this model and generates a usable JavaScript class along with several companion features such as database support and network marshaling.

While FOAM is written in JavaScript, it can be used to generate code for any language or platform, including Android Java and iOS Swift.

Development

Building Java

cd src; ./gen.sh; cd ../build; cp ../tools/pom.xml .; mvn compile; mvn package

Or you may build and run using

make run

And to clean the project, you may use

make clean

Installing Dependencies

FOAM has no runtime dependencies, but uses a number of third party tools for unit tests, code coverage, and linting. You can install all required tools by doing the following.

• Install nodejs.

• Run 'npm install' in the root of the FOAM repository, where package.json is found.

Running Application Controller

The FOAM Application Controller allows you to access components of your foam app by using the browser & displaying it as a GUI. To access, run the following in the parent directory of foam2:

• Build java (see above)

• Run foam2/./tools/nanos.sh

• Visit http://localhost:8080/src/foam/nanos/controller/index.html

Style Guide

All code should follow the style guide.

Testing

• npm test runs standard unit tests.

• npm run testDebug runs the unit tests with a debugger.

• npm run coverage runs code coverage and creates an html report in /coverage.

For in-browser testing, run your favorite web server at the root of the FOAM repository. In a browser, navigate to http://localhost:8000/test/browser/SpecRunner.html to run the unit tests.

Documentation

Contributing

Before contributing code to FOAM, you must complete the Google Individual Contributor License Agreement.

foam2's Issues

foam.core.Property.model_.describe() throws exceptions

Because the initial foam.context doest not define log()/warn()/error(), only assert, and objects created before Window.js do not have their context upgraded to the window context.

@kgrgreer

Remove E() Shortcut when no longer needed

Port Circles Benchmark to FOAM

FOAM seems slower than raw canvas for drawing a lot of circles.
http://codepen.io/kgr/pen/QEXdpr

foam.u2.ChoiceView does not appear to work with a dao of choices

The select call is incorrect, using Map.create({ f: .... });

It probably needs to be Map.create({ arg1: this.objToChoice, delegate: some_sort_of_sink });

Additionally, the postSet for DAO does not call .onDAOUpdate(), so even if the dao was set it never updates the choices.

Create custom toE() on FObject Demo

Create demo/example to show how an object can create it's own custom detail view.

Have Boot methods appear in describe()

Currently they don't.

EasyDAO Guide

Or just inline with the jsdoc? Either way, to be linked from DAO Guide

FlightBooker missing Validation

Because FOAM2 doesn't implement that feature yet.

EasyDAO Component Unit Tests

Tests for each of the DAOs that EasyDAO uses.

Don't output default values, nulls, or empty arrays in JSON Output

Implement EnumView

When Enums have labels.

Cells Demo can't edit cells

Ability to work with nested Slots in Expressions

Add listen() and pipe() support back to DAO's

Need to add logic to topics?

CircleDrawer doesn't resize circles

Don't print Element's in describe()

describe()'ing an object will print out the innerHTML of Element properties. A shorter description should be used instead.

Add 'label' to Enum values

For use with EnumView.

Convert show()/hide() in Element to a Property

So that the status can be more easily used as a Slot.

toString Enum values

Keyboard Action shortcuts

Port Uses of ViewFactory to ViewSpec

@shepheb

Port/Document/Test EasyDAO and all DAO decorators that it uses.

Finish porting EasyDAO to FOAM2 as well as all of the DAO decorators that it uses.
Create unit tests.
Create a DAO programming guide (for users of DAOs, not for implementers of new types of DAO)
Create sub-issues as necessary.

EasyClientDAO

Implement EasyClientDAO, use in EasyDAO

Support 'inner' Concept in Element

Designate a specific element as the inner or content area so that add()'s get added there instead of to the top-level Element.

Ability to work with DAO's in Expressions

Port TODOMVC to FOAM2/U2

JSDoc template: fix title output in guides

Title output in guides is disabled because the title it picks is bad. But the styling of the title inside the guide text has a bad margin (or fixing it breaks the margin in generated class doc pages). Resolve tutorial/guide title output, fix H1 margin styling.

Merge redundant CheckBox implementations

There's one in foam.u2 and one in foam.u2.tag.
@mcarcaso @adamvy

Convert Cells Parser to infix notation

Fix in-browser tests failing due to missing exceptions

5 Browser tests fail due to not throwing an exception on assert. Replace assert() for these tests with a version that throws (already implemented for some other tests):

Function rejects non functions
StringArray setting an array to a number throws an exception
StringArray setting an array to an object throws an exception
Enum tests Basic enum
Enum tests Basic enum

Document EasyDAO components

Docs for EasyDAO and the DAOs it uses

Test foamdev.com on iPhone

Developer Guide for using DAOs

Guide for users of DAOs

Port mLang partialEval()

Mock Sinks

Implement Mock sinks for DAO testing, combinations of optional promise returns on put/remove, errors through throw, reject, and flow control

Create/Port Label CView

QuickSink

Create a QuickSink with put/remove/error/eof/reset as function properties to allow inline sinks that still extend AbstractSink

Relay Inner-Object Property Change Events

Model all Sinks

And no longer support missing sink methods.

Create or Port FloatView with 'precision Support

Add an AllViews model

Port Olympic demo (FilterController)

This is partly done, just adding this here for tracking purposes.

Clean up warnings from EasyDAO creation.

EasyDAO passes a lot of parameters to different DAOs that are not actually properties of the targets.

Such as "property" to MDAO and others. Would be nice to scrub this so that EasyDAO creation doesn't pollute the console.

Add virtual Element style/attribute mappings.

To make it easier to bind boolean values without having to know the one-off rules for converting boolean values to specific DOM values. Maybe could also be used to add 'data' support.

Remove trailing '-' from CSS Names

When not used as a separator.

Parse/Sanitize HTML for HTMLElement

Parse into an Element, and then let ElementValidator handle validation.

FOAMByExample #118 is broken

Need to update it to export myLogger

Cleared Properties not reflected in UI

Consider the sevenguis CRUD example.
The person detailView shows the values of person .name and .surname.
If I call person.name$.clear(), or person$.clear() the detailView is not updated.
Is this expected behaviour?

If I run:

this.person.name$.clear();
undefined
this.person.name;
undefined

I see that it is clearing the person's name property, but the UI isn't updating, so there must be a bug in the property/UI binding when it comes to 'undefined'. I'll fix.

Create/Port index.html

Port from FOAM1 to allow for dynamic model/class loading and viewing without having to create custom .html files.

Polish existing set of Guide Docs

Fix or add links
Check example code consistency
Export to GitHub pages