Poka Ijo is my Inventory

• Table of Contents
• Building
• Developing in a REPL and a Babel doc
• Footnotes

This project is a repository of Org Mode formatted documents which describe and implement a web service written in Elixir using the Phoenix Framework. Rather than directly editing the source code, these documents are edited instead – source code, justification and the links between disparate modules and data-flows expressed in text as well as code.

poka ijo means "nearby things" in Toki Pona. Poka Ijo is a fairly simple tool:

• a way for me to catalog the physical objects I possess,

• to better organize what I possess,

• to understand what I don't need or want,

• to give those things an outlet, for others to put them to use.

Table of Contents

• Project Configuration, Mix, etc

• Poka Ijo Domain Logic

• Poka Ijo Phoenix Frontend

• The Visual Identity of poka_ijo

• Controller for static PokaIjoWeb pages

• Poka Ijo Test Support

I expect a few components to come together for this Project:

• A Data Model for Poka Ijo Things

  • attributes: name, id, URL, monetary value

  • attributes: file attachments, tags

  • "walk" the tree of objects

  • search for an object by name or metadata

• Photo Uploads in Poka Ijo

• a management frontend which allows me to:

  • Poka Ijo Thing CRUD to quickly add new items, floating or contained in another.

  • quickly attach photos and metadata to objects

  • some sort of score interface, "hot or not" but for my shit.

  • some sort of organization suggester based on object similarities

• a public site which allows others to:

  • see what I am willing to part ways with

  • request an email or text message conversation over an item

Building

There is a Makefile to make it easier to tangle the files. You will need Emacs and Org-mode installed for this to work. Some day all of this will be in Mix tasks that can contain the whole set of dependencies.

make tangle will tangle any org document which is newer than a handle left in _build. It's important to keep your tangled documents up to date with the file system, but for development it's likely that you're sending the Elixir code to a running IEx session, there will be an org-mode documentation providing for this at some point soon.

make init will tangle, download dependencies, and compile them.

Developing in a REPL and a Babel doc

Poka Ijo development requires a postgres database with a database called poka_ijo_dev. run shell:mix ecto.setup (or click on that link!)

Executing this code will allow you to send the org-babel block under point to the REPL. I don't know how that handles noweb, blocks but it kinda works. (it doesn't even tangle them before sending to REPL, i've been relying on the phoenix dev server file watch)

(use-package eval-in-repl
  :config
  (require 'eval-in-repl-ielm)
  
  ; i disable transient mark mode
  (defun eir-eval-in-iex ()
    "Provides eval-in-repl for Elixir."
    (interactive)
    ;; Define local variables
    (let* ()
      (eir-repl-start "\\*Alchemist-IEx\\*" #'alchemist-iex-run t)
      (eir-send-to-iex (buffer-substring-no-properties (point) (mark)))))

  (setq eir-repl-placement 'left)
  (setq eir-jump-after-eval nil)
  (setq eir-ielm-eval-in-current-buffer t))

(use-package org-babel-eval-in-repl
  :after ob
  :config
  (add-to-list 'ober-org-babel-type-list '("elixir" . (eval-in-repl-iex eir-eval-in-iex)))
  (evil-define-key 'normal 'org-mode-map (kbd "C-<return>") #'ober-eval-in-repl)
  (evil-define-key 'normal 'org-mode-map (kbd "M-<return>") #'ober-eval-block-in-repl))

Alchemist runs an IEx shell:

(use-package alchemist)
(alchemist-iex-run " -S mix phx.server")

Run this with Alt-Return to disable colors and see the IEx shell in action. You can run any¹ source block in this fashion.

alias PokaIjo.{Repo,Thing,Photo}
IEx.configure(colors: [enabled: false])

To run tests use mix test.watch">mix test.watch.

Footnotes

---

¹

Some restrictions apply, segments that are part of a noweb block will need to be run in the module-level block…