Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
dartling_skeleton is a Dart Editor project template for a new Dartling project.
Dart
Tree: a410d33a94

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc/git
lib
test/dartling/skeleton
web
.gitignore
.project
LICENSE.md
README.md
pubspec.lock
pubspec.yaml

README.md

Dartling

Dartling is a domain model framework for web application prototypes. Its open source license is the 3-clause BSD license -- "New BSD License" or "Modified BSD License".

Dartling model consists of concepts, concept attributes and concept neighbors. Two neighbors make a relationship between two concepts. A relationship has two directions, each direction going from one concept to another neighbor concept. When both concepts are the same, the relationship is reflexive. When there are two relationships between the same but different concepts, the relationships are twins.

A graphical model designed in Magic Boxes is transformed into JSON representation, imported to Dartling and converted to the meta model. Then, the model may be used without almost any additional programming for quick prototypes.

What Can You Do with Dartling?

  • design a domain model in Magic Boxes
  • transform the model into a JSON representation
  • prepare your dartling project based on the [dartling_skeleto (https://github.com/dzenanr/dartling_skeleton) project
  • copy the JSON representation of the model to your project
  • generate the code for your project from your project
  • test your model with some data
  • init your model with some data
  • add some specific code if you wish
  • run the prototype application that uses the model and Dartling web components

Dartling API

Dartling repository may have several domains. A domain may have several models. A model has entry points that are entities. From an entity in one of entry entities, child entities may be obtained. Data navigation is done by following parent or child neighbors.

You can add, remove, update, find, select and order data. Actions or transactions may be used to support unrestricted undos and redos in a domain session. A transaction is an action that contains other actions. The domain allows any object to react to actions in its models.

To understand what else you can do with Dartling examine its API defined in abstract classes with Api at the end of their names. The two most important ones are EntitiesApi and EntityApi.

Example

The Link model has the most commonly used patterns: optional relationship (0..N -- 0..1), id dependent relationship (0..N -- 1..1 id), and many-to-many relationship (represented as two one-to-many id dependent relationships).

The JSON text is generated in Magic Boxes and used in Dartling to create its meta model. The meta model is used in almost all methods of the Dartling’s API.

Dartling Project Structure

The Dartling project has three folders: lib, test and web. The lib folder has the gen subfolder where the code is generated from a domain model and regenerated if the model changes. A programmer should not change anything in the gen folder.

The domain (your domain name) folder has the model (your model name) folder that contains the json folder with JSON representations of the model and its data. The model.dart file in the model folder contains a model from Magic Boxes. The data.dart file in the json folder contains data of the model.

More details

Dartling Code Generation Guide

Dartling Skeleton is a Dart Editor project template for a new Dartling project.

Your Dartling Project

Design a model in Magic Boxes

  • do not use special characters in any names
  • do not use - (minus) or space in any names
  • do not use plural for box (concept) names
  • start a box name with a capital letter
  • do not use composite box names (no: CarBrand; yes: Brand); if you must use a composite box name, then use CamelCase
  • some boxes must be entry
  • do not use oid and code to name an item
  • start an item name with a small letter
  • do not repeat the concept name within the attribute name
  • item names may be composite
  • for composite item names use camelCase (first letter lower)
  • all items must be typed
  • all lines must have parent and child names (neighbor names)
  • start a neighbor name with a lower letter
  • neighbor names may be composite
  • for composite neighbor names use camelCase (first letter lower)
  • click on From JSON to obtain the JSON text for the model
  • pretty format JSON

Copy the dartling_skeleton project

  • do not use special characters in any names
  • do not use - (minus) or space in any names
  • do not use plural for domain and model names
  • start a domain name or a model name with a capital letter
  • do not use composite names for domains and models (no: DartlingDomain; yes: Dartling); if you must use a composite name, then use CamelCase
  • when domain, model or concept names are used in folder and file names, they must be all in lower letters
  • when domain, model or concept names are used in folder and file names, if they are used together, they must be separated by _ (underscore): domain_model
  • when domain, model or concept names are used in folder and file names, if they are composite, their components must be separated by _ : my_domain
  • open the dartling_skeleton folder in Dart Editor but without pub
  • copy the dartling_skeleton folder and rename it to your domain_name_model_name
  • rename name in pubspec.yaml
  • delete the copied .git folder in the new project
  • Open Folder... in Dart Editor without pub
  • select the root folder and choose in the pop-up menu Don’t Analyze
  • in the web/img and web/dartling/skeleton/img folders replace the png file with your model’s png file
  • rename folders, files in the lib, test and web folders that have dartling and skeleton names
  • rename dartling with your domain_name
  • rename skeleton with your model_name
  • do not rename the model.dart file in lib/dartling/skeleton/json
  • do not rename the models.dart file in lib/gen/dartling
  • update sources in the library files, lib/dartling_skeleton.dart and lib/dartling_skeleton_app.dart, to reflect your domain and model names
  • do not rename #import("package:dartling/dartling.dart"); and #import("package:dartling/dartling_app.dart");
  • in lib/dartling/skeleton/json/data.dart, rename the dartlingSkeletonDataJson var name: change dartling to yourDomainName change Skeleton to YourModelName
  • in lib/dartling/skeleton/json/model.dart, rename the dartlingSkeletonModelJson var name: change dartling to yourDomainName; change Skeleton to YourModelName; do not change model or Model
  • in test/dartling/skeleton/dartling_skeleton_gen.dart, rename #import("package:dartling_skeleton/dartling_skeleton.dart"): rename dartling to yourDomainName; change "Dartling" to "YourDomainName"; rename Skeleton to YourModelName; change "Skeleton" to "YourModelName"
  • copy the pretty format of the JSON text of the model to lib/dartling/skeleton/json/model.dart between var and '''
  • Dart Editor must know where you have installed git; on Windows add something like C:\Program Files (x86)\Git\bin; to the Path system variable
  • Close and then open the project folder with pub
  • select the root folder and choose in the pop-up menu Analyze
  • Run dartling_skeleton_gen.dart to generate code
  • copy the generated code into indicated files (including dartling_skeleton_gen) and save; if there is no indicated file, File/New File in its folder
  • if red color, close and open the project folder to potentially get rid of some red color
  • if there are still errors, check your model in Magic Boxes (read again the recommendations)
  • change the model and put the code with red color in comments
  • update at least src of the script tag in dartling_skeleton_web.html file
  • init model with some data in lib/dartling/skeleton/init.dart
  • Run dartling_skeleton_gen.dart to init
  • Run in Dartium web/dartling/skeleton/dartling_skeleton_web.html to see the model alive
  • add some tests in the test folder, in dartling_skeleton_test.dart file
  • Run dartling_skeleton_test.dart file to test
Something went wrong with that request. Please try again.