Awesome Open Source
Awesome Open Source

Precept

A declarative programming framework

Clojars Project cljdoc Circle CI License

API Docs  |  Syntax  |  Examples  |  Issues  |  Contributing  |  Roadmap

"You need only specify what you require, not how it must be achieved."
Out of the Tar Pit

Quick start

From the command line:

lein new precept myproj
cd myproj
lein figwheel

This will start the todomvc example on localhost:3449 and a nREPL server on localhost:7002. You can interact with the code by calling (cljs) once your REPL is connected.

What it is and why

Precept is a framework for creating reactive web applications using a rules engine, declarative logic, and relational data modeling.

Large, complex applications

Many frameworks and programming languages introduce complexity that has nothing to do with the applications we are trying to build. Ideally, the only complexity we should face is that which is inherent to the problem. Programming that is truly declarative states logic directly so complex applications can be written in simple terms.

Graph data model

Precept models state as a graph. We can add new facts about the world without concerning ourselves about its location in an object. We can query data and perform derived computations on it just as easily.

How it works

There are facts and there are rules. Facts are data, and rules are declarative statements about that data. All application state is represented by facts, and all application logic is expressed with rules.

Facts have three parts: an entity id, an attribute, and a value. They model data relationally and are expressed with Clojure vectors.

Here's an example fact:

[123 :todo/title "Use Precept"]
  |         |         |
  |         |         |
  e         a         v

"Thing 123 has the attribute :todo/title, the value of which is 'Use Precept'."

Rules have two parts: the conditions and the consequences. Conditions state what facts must be true for the consequence to happen. They are expressed using pattern matching. Consequences are any valid Clojure or Clojurescript code. They have full access to all variables that were matched in the rule's condition.

Here's an example rule:

(rule todo-is-visible
  [[_ :visibility-filter :active]]
  [[?e :todo/done false]]
  =>
  (println "The todo with this entity id is visible: " ?e)

"When visibility filter is "active todos" and there's a todo that's not done, print the todo's id."

Instead of printing a message, what if we wanted to make the todo visible? The consequence of the rule could be a new fact:

...
=>
(insert! [?e :todo/visible true]))

Whenever a fact is inserted, other rules have a chance to respond to it.

Suppose you also had this rule:

(rule print-visible-titles
  [[?e :todo/visible true]]
  [[?e :todo/title ?title]]
  =>
  (println "Visible todo title: " ?title))

"When there is a visible todo, get its title, then print it."

This rule will attempt a join on entity id between a title fact and a visible fact, meaning it will try find a title whose entity id matches the entity id of a visible todo.

For our rules to do anything, we need to add some facts.

A session is a container for rules and facts. Given a session and an optional set of initial facts, Precept makes the resultant state available to your views.

(defn todo [title done]
  (let [id 123]
    [[id :todo/title title]
      id :todo/done false]]))

(defn visibility-filter [kw]
  [(uuid) :visibility-filter kw])

(session my-session 'my-ns.rules)     

(start! {:session my-session :facts [(todo "Use Precept")
                                     (visibility-filter :active)]})

=> The todo with this entity id is visible: 123
=> Visible todo title: Use Precept

Subscriptions

Components subscribe to queries and rerender whenever the query result changes. Because query subscriptions are defined as rules, they enjoy the same performance benefits as rules. Namely, they are not rerun if there is no possible way their results could have changed. See Rete algorithm.

Here's a subscription definition for a visible todo:

(defsub :visible-todos
  [[?e :todo/visible true]]
  [(<- ?todo (entity ?e))]
  =>
  {:visible-todo ?todo}

Components subscribe to the keyword defined by defsub:

(defn visible-todo []
  (let [{:keys [db/id todo/title todo/done]} @(subscribe [:visible-todo])]))
    [:div title done]

Precept converts all its subscription results to maps, making the work of rendering data in the view layer the same as other frontend libraries and frameworks.

Inserting facts

Views insert new facts into the session with then. An :on-change handler that inserts a fact about a todo edit looks like this:

[:input
  {:on-change #(then [id :todo/edit (-> % .-target .-value)])}]

Precept will modify the value of :todo/edit on each keypress by retracting the previous fact and inserting the new one. This is because Precept enforces one-to-one cardinality for all facts by default (i.e., for any entity-attribute pair, one value can exist at any point in time). In this case that means there can't be more than one value for entity 123's :todo/edit.

Schema support

Precept enforces cardinality and uniqueness according to Datomic-format schemas. If we wanted entities to have multiple values for the :todo/edit attribute, we can specify a one-to-many relationship for it:

(attribute :todo/edit
  :db/cardinality :db.cardinality/one-to-many)

One-to-many attributes can then be returned to components as a list.

;; Tuple format  
[[123 :todo/edit "H"]
 [123 :todo/edit "He"]
 [123 :todo/edit "Hey"]]

;; Map format
{:db/id 123 :todo/edit ["H" "He" "Hey"]}

Unique attributes are handled using the same semantics as Datomic for :db.unique/identity and :db.unique/value. When there is a conflict, instead of throwing an error, Precept inserts facts about the error into the session so they it may be handled or resolved through rules.

Precept supports both a :db-schema and a :client-schema. This allows you to easily access to facts you want to persist, while still allowing the schema definitions for your client-side only data. Client and db schemas are both enforced the same way.

Differences from Datomic

Like Datascript, Redux, re-frame, and other front-end data stores, Precept does not attempt to maintain a history of all facts. We agree with Datomic's design with respect to this, but because Precept runs in a web browser, space is relatively limited. For our application, we see more value in that space being occupied by tens of thousands of facts that represent the current state of the world instead of e.g. 100 facts with 100 histories.

Rete algorithm

“In the ideal world, we are not concerned with performance, and our language and infrastructure provide all the general support we desire.” - Out of the Tar Pit, emphasis added

Precept wraps Clara, a ground-up implementation of the Rete algorithm in Clojure and Clojurescript.

Rule engines are not usually written with the browser in mind. Clara is perhaps the first. A declarative approach to front-end web development would not be feasible without their work: Writing declarative code requires the algorithms that underlie it to be performant.

The Rete algorithm creates a network of nodes for each rule. Nodes are indexed, may be shared, and contain memories of the values they match. Overall, Rete trades space for time, and calculates incremental changes with almost no effort. This solves the vast majority of situations on the front-end where performance becomes a consideration. Keeping a filtered list of n items does not require the entire list to be iterated through and recalculated when a new item is added.

Where we're headed

The project board contains the most up-to-date information about what features are being discussed, prioritized, and worked on. Here's a few we're excited about.

Rendering views

Using a rule engine allows us to know exactly what changes from one state to the next. This means we don't need React's diff algorithm or the concept of subscriptions. If we declare views as the consequences of rules, we can automatically point update them when the facts they care about change.

Ruleset API

We want to use general purpose rulesets the same way we use libraries. E.g. drag and drop, typeahead, etc. A Ruleset API is in the works to make it easy for the community to write pluggable sets rules that application authors can integrate seamlessly with their own.

Dev tools

Because Clara's sessions are immutable, we can store each one and cycle through them. Clara provides tools for inspecting sessions that show what rules fired and why, what facts were inserted and by what rule, which were retracted, and so on.

In addition, changes to Precept's view model can visualized and tracked just like Redux DevTools.

Update 6/7/18 You can check out the devtools alpha preview here.

General purpose algorithms

Precept aims to enable teams to build increasingly game-like UIs. This sometimes requires algorithms for path-finding, tweening, collision detection, and distance calculation. We want to write applications where talking about these things is trivial. That means never having to fall back to imperative programming, while at the same time having the performance it provides. We're working to support declarative statements like (<- ?my-trip (distance ?paris ?london)) that allow us to focus on what, not how, by calling performant, general-purpose algorithms under the covers.

Thanks


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
clojure (2,019
clojurescript (215
functional-reactive-programming (46
rules (35
logic-programming (30