keechma / entitydb

EntityDB library

Keechma

Keechma is a micro framework for Reagent written in ClojureScript. It gives you a set of utilities that allow you to build applications that have the following properties:

• Deterministic and predictable behavior
  • Based on the route, you can determine what the application's state will be
  • UI never "requests" data it's always provided to it
• Unidirectional data flow
  1. Route params are derived from the URL
  2. Application state is derived from the route params
  3. UI is derived from the application state
• Loose coupling between components
  • Communication is performed through core.async channels
• Automatic synchronization of entities' states
  • An entity is any data loaded into the app that has an identity (e.g. :id column)
  • Entities are stored in the EntityDB
  • EntityDB propagates entity state to every place where that entity is displayed in the UI
• Enforced lifecycle (and memory safety)
  • Automatically load data on route change
  • Automatically clean up stale data on route change
  • Automatically set up event listeners on route change (e.g. listener on the WebSocket)
  • Automatically tear down event listeners on route change
• Applications are first-class citizens
  • Applications can be started and stopped
  • Applications can be passed around
  • Applications can mount sub-applicationsns
• UI components are decoupled and reusable
  • UI components can declare it's dependencies
  • Dependencies are injected when the application is started
  • Each component has own context
• No shared globals
  • Router is bound to the application context
  • App state is bound to the application context
  • Multiple apps can run at the same time, each with own state

Documentation

Read the guides or the API docs to find out more about Keechma.

Name

Kičma (lat. columna vertebralis) is a Croatian word for backbone / spine.

Yes, it’s a nod to BackboneJS and SpineJS.

License

Copyright © 2016 Mihael Konjevic.

Distributed under the MIT License.

entitydb's Issues

Formalize adding of a belongs to items

Formalize the following:

1. User loads the list of news, each of the news has a list of comments
2. User adds a new comment to the news

Adding of the comment to the news should be formalized. EntityDB should provide a way to get the name of a collection that holds has-many or has-one references

'insert-collection' with empty collection

insert-collectionstarts with the following condition:

(if (and (nil? item) (nil? meta))
  db
  ...)

This means that it won't work to change an existing collection to an empty one. I don't think I can use remove-collection in this case since it'll remove any metadata attached to the collection.

My workaround here is adding an empty map as the meta parameter to insert-collection but still I'm very interested in your thoughts on this.

Loading empty relation collections is retaining old data in edb.

↑

Add reverse relations

If post has a relation to a user, we should be able to collect all user's posts from the user's side even if the relation is defined through the :user attribute on the post item

Adding an item that has relations (with function getters) is not working