foretspaisibles / gasoline Goto Github PK

Gasoline is an OCaml library providing application templates. Applications written with Gasoline are parametrised by the command line, environment or configuration files, they support fine-grained lightweight internationalised diagnostics and handle software component dependencies.

Home Page: http://michipili.github.io/gasoline

License: Other

Shell 1.19% CSS 0.62% Makefile 5.51% OCaml 89.16% M4 3.51%

gasoline's Introduction

Gasoline

The Gasoline project aims at implementing a Unix-ish application development framework for OCaml. The framework provides application templates factoring application components bootstrapping, configuration analyse and common application patterns, such as filter, secure tool or dæmon.

Users of Gasoline should be enabled to:

Rapidly develop applications by using application patterns such as “Unix filter”, “tabular data processor” or “compiler”.
Write large software suites whose elements offer homogeneous interfaces.
Use standardised diagnostic facilities supporting internationalisation.
Cleanly distinguish between application components and lower-level software engineering artifacts.
Easily bootstrap and shutdown applications consisting of many modules.

Current state

Gasoline is still beta-software, and many features or design elements are susceptible to change before we reach version 1.0. Current features are:

Configuration based on files, environment variables and command line arguments.
Configuration cascading rules which can be used to let system administrators enforce some settings of installed applications.
Software component management which correctly bootstraps and shutdowns the application, exception sent by the guest are caught and an emergency shutdown procedure is triggered.
A diagnostic facility similar to printf but better suited to internationalisation and having routing rules.

Applications can take advantage of a simplified interface to the Camomile library and of writer functions, allowing to produce simple SGML or HTML reports.

See the ocamldoc generated documentation of the master branch for more details.

Free software

It is written by Michael Grünewald and is distributed as a free software: copying it and redistributing it is very much welcome under conditions of the CeCILL-B licence agreement, found in the COPYING and COPYING-FR files of the distribution.

Setup guide

It is easy to install Gasoline using opam and its pinning feature. In a shell visiting the repository, say

% opam pin add gasoline .

It is also possible to install Gasoline manually. The installation procedure is based on the portable build system BSD Owl Scripts written for BSD Make.

Verify that prerequisites are installed:
- BSD Make
- BSD OWl
- OCaml
- broken
- camomile
- configuration
- getopts
- lemonade
- mixture
- GNU Autoconf
Get the source, either by cloning the repository or by exploding a distribution tarball.
Optionally run autoconf to produce a configuration script. This is only required if the script is not already present.
Run ./configure, you can choose the installation prefix with --prefix.
Run make build.
Optionally run make test to test your build.
Finally run make install.

Depending on how BSD Make is called on your system, you may need to replace make by bsdmake or bmake in steps 5, 6, and 7. The GNU Make program usually give up the ghost, croaking *** missing separator. Stop. when you mistakingly use it instead of BSD Make.

Step 7 requires that you can su - if you are not already root.

Michael Grünewald in Bonn, on October 21, 2014

gasoline's People

Contributors

Stargazers

Watchers

gasoline's Issues

Prepare a working version of the wordgen program

Port to OCaml 4.02.1

Write a minimal setup guide

Support opam pinning

As we have an opam port, it would be even more useful if it supports pinning.

Implement file backed output channels for Unixish applications

Use sensible defaults for formatting indications

Formatting indications should be optional.

Implement a standard component for Graphics

Implement a component initialising the “Graphics” library.

Run software component functionalities in an execution monad

Software component functionalities should run in an execution monad. These functionalities are not allowed to throw exceptions and report errors in the monad.

Describe the goals of the project

Command wrapper pattern

Write a command wrapper pattern, for tools similar to OCamlfind.

Implement a standard component for random numbers

Implement a standard component initialising the random numbers facility found in the standard library.

Use default value of LIBDIR for OCaml libraries

Once foretspaisibles/bsdowl#119 has been fixed, we do not need to set the value of LIBDIR ourselves.

Prepare a OPAM package

Devise and implement a configuration syntax for sinks in Unixish applications

Getopt prefix is not taken in account

The getopt prefix used by components to register long options does not work in v0.1. For instance the wordgen example fails when it is invoked as follows:

% ./wordgen -A number=5
wordgen: illegal option -- A
Usage: wordgen [-h]
Exit 64

It is instead expected that -A number=5 sets the configuration parameter Wordgen.Component_automaton.Configuration.generate_n to the value 5.

Add Travis CI

Write an installation process allowing flexible configuration of the installation directories

This should improve compatibility with opam.

Implement process backed output channels for Unixish applications

Consistently uses Unixish instead of C-style

Documentation must use “Unixish” instead of other C-ish expressions.
Modules should be renamed to “Unixish_” instead of “C_”.

https://linuxfr.org/users/elessar/journaux/esod-mumixam

Remove unit testing log files from the distribution archive

The operation make distclean should remove unit testing logfiles from the source directory.

Implement an application fingerprinting facility

An application should be able to fingerprint itself — e.g. for a bug report. A complete fingerprint should mention the list of its components together with their versions.