akretion / aktooor

forms to edit Odoo entities in your Ruby web app (based on simple_form)

Aktooor: OpenERP forms (via_simple_form) for your Ruby web app

Aktooor makes it straightforward to develop forms for OpenERP. You can achieve the same kinds of forms as in OpenERP itself (same complexity) but with more freedom as Rails allows you. And mostly these are forms that you can embed in your Ruby web project, be it Rails or any other Rack framework (Sinatra etc..)

To do that, Aktooor extends simple_form with form builder methods that properly introspect OpenERP meta-data (via Ooor) to make the right default decisions.

So first it's a good idea to learn simple_form . In a word, simple_form extends Rails form_for builder to support a higher level form modeling abstractions. Also, simple_form integrates automatically with Twitter Bootstrap 3 and other CSS frameworks.

Aktooor works on Ooor objects, so you you should learn Ooor too. Ooor objects are proxies to your OpenERP objects that use the OpenERP JSON API just like you would talk JSON with say MongoDB. But with Ooor you also probably want to leave most of the business logic inside the OpenERP Python runtime and just call it with the JSON API through Ooor. Eventually, you can still implement some business logic in Ruby, that allows you to leave it unaffacted by the OpenER viral AGPL license, just like when you interract with AGPL MongoDB again.

Aktooor can work both on OpenERP mono-connection objects (like the ProductProduct constant) or multi-sessions objects that can map OpenERP credentials to the specific web-app credentials of the user (TODO document that better). It integrates smoothly with the Ooorest actionpack layer to alliviate you from all this session mapping plumping.

So Aktooor extends simple_form further and provides an ooor_form_for helper instead. Inside, fields that map to fields of an OpenERP Ooor::Base proxy object will need to use ooor_input instead of just input.

Aktooor also goes further by automatically generating proper dynamic association widgets using the select2 JQuery plugin.

Aktooor also supports nested forms (like a sale order and its order lines) using the cocoon framework.

You may think that Aktooor can be made to look like the OpenERP web client. There is a wiki page talking about the similarities and differences with the OpenERP web client https://github.com/akretion/aktooor/wiki/similarities-and-difference-between-Aktooor-and-OpenERP-web-client .

This project uses MIT-LICENSE.

aktooor's Issues

consider twine for readonly / visibility bindings

See:
http://shopify.github.io/twine/
https://github.com/Shopify/twine

make default_get in cocoon new_object happen in Ajax

with o2m widgets. cocoon will eagerly prepare a new object to create, that will make a default_get call to OpenERP. Eventually we want this to happen lazily in Ajax instead.

find a way to pre-fetch the fields of a form

sequential call to read for every field of the form works but is needlessly slower than pre-fetching all fields at the start

use kaminari bootstrap pagination

see https://github.com/matenia/bootstrap-kaminari-views or equivalent

in XSTL transfo re-number tabs instead of trying to escape their names via regexp (to make valid XSLT ids)

this is just for the XSLT demo and doesn't affect general Aktooor usage.

XSLT: inject real inline or default tree view in o2m widgets

instead of just displaying to name today to show something