Template Language for Data Generator – BA14_meea_3 – Einleitung

Einleitung

• Ausgangslage
• Anforderungen

Kaden & Partner AG

Ausgangslage

• kleines Team von Entwicklern
• RIA- , GIS-Anwendungen

Voodoo

Ausgangslage

• entwickelt von KP 2010
• php-script
• teil von GAIA

Voodoo

Ausgangslage

• - schwer erweiterbar
• - abhängig von GAIA
• - Scafolding
• - Verwaltung

Anforderungen

• Generieren von Sourcefiles
• Daten aus DB-Schema
• einfache Konfiguration
• erweiterbar, strukturiert, getestet

Theoretische Grundlagen

Nodejs

• JavaScript Runtime basierend auf V8
• Modularisiert
• Packagemanager

Callbacks

doSomething(function(error) {
    if (error) {
        //...
    } else {
        doSomethingElse(function(error) {
            if (error) {
                //...
            } else {
                doSomethingElse2(function(error) {
                    if (error) {
                        //...
                    } else {
                        //...
                    }
                });
            }
        });
    }
});

Promises Zustände

• pending: noch nicht abgearbeitet -> Weiterverarbeitung des Resultats warten
• fulfilled: Die Verarbeitung erfolgreich. Auf dem Promise Objekt wird nun die then Funktion mit dem übergebenen Resultat ausgeführt.
• rejected:Fehler -> die fail Funktion mit dem erhaltenen Fehler wird aufgerufen.

Promises

function doSomething() { ... }
    .then(doSomethingElse)
    .then(doSomethingElse2)
    .fail(onFail);

• Statt Resultat gibt jede Funktion eine Promise zurück
• then Funktion gibt Promise zurück -> chaining
• Bestrebung Promises als Firstclass Objekte in den nächsten Standard von JavaScript (ES6) zu implementieren
• Unsere Module sind Promise based
• Kommunikation innerhalb der Module ebenfalls mit Promises

Vorgehen

Planung

• User Stories
• kurze Sprints, kleine Releases, 2 Wochen
• Rollen
  • Product Owner
  • Scrummaster

Management

GitHub

Burn Down Chart

Design

• Template Engine
  • Eigener Code
  • JavaScript
  • Delimiter
  • Integration
• Konfiguration
  • Yeoman
  • Grunt
  • npm
  • bower

Programmierung

• Collective Code Ownership
• Pair Programming
• TDD

Continuous Integration

Open Source

• auf GitHub, public
• Organisation
• MIT Lizenz

Resultate

Architektur

Template

class <%= className %> {
  <% _.each(attributes, function(attribute) { %>
  public <%= attribute.type %> <%= attribute.name %>;
  <% }) %>
}

{
    "className": "Person",
    "attributes": [{
      "name": "name",
      "type": "string"
    }, {
      "name": "age",
      "type": "int"
    }]
}

class Person {
  public string name;
  public int age;
}

Konfiguration

• .heinzelrc

{
    "domains": {
    },
    "generators": {
    },
    "templates": {
    },
    "customScript": "./templates/customScripts/index.js"
}

Domains

Konfiguration

• .heinzelrc

"domains": {
        "data": {
            "version": "1.0.1"
        },
        "generator": {
        },
        "extjs": {
            "model": {
            }
        },
        "backend": {
            "entity": {
                "template": "./templates/backend/Entity.php.tpl",
                "output": "./webroot/backend/Entity/<%= modelName %>.php"
            },
            "controller": {
            }
        }
    },
}

CLI

$ heinzel
[?] What would you like me to do today? (Use arrow keys)
❯ create domains
  initialize the .heinzelrc
  list domains, templates and generators
  explain datastructure returned by generator
  install templates and generators
  uninstall templates and generators
  update templates and generators
  search templates and generators in the npm registry

$ heinzel create backend.entity --override

Ausblick

Einsatz bei Kaden & Partner AG

• Allgemein verwendbare Templates
• Postgresql (code first)
• Workshop
• Scaffolding für neue Anwendung

Geplante Features

• Post Actions
• Daten von Generator speichern (json)
• weitere Generatoren (xml, json, ...)
• Webauftritt

Backup

Promises erzeugen

function doSomethingAsPromise() {
    var q = Q.defer(),
        result;
    ...
    q.resolve(result);
    return q.promise;
}

doSomethingAsPromise().then(function calledWhenResolved(result) {
    console.log(result);
});

Sprints

MIT License

Unittest

describe('Template', function() {
    describe('#process', function() {
        it('should process the template', function() {
            var template = '<%= heinzel %>',
                data = {
                    heinzel: 'Berti'
                };

            return heinzelTemplate.process(template, data).should.become('Berti');
        });
    });
});