picatrix 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e2e397e99116fa0b237db3f59a35ab0c7521f4e
-  data.tar.gz: 835f2a685518c5448ad260577949244cf1feca77
+  metadata.gz: c1526c5c727bb983c60d9c3240984054c96187de
+  data.tar.gz: 6af84973981466c805aa680fad9ca915353418f8
 SHA512:
-  metadata.gz: 0cbd222ea637fe500cc864a89dcb244e743405d83b31cadbb1e6b891637c50a8a898a83e9f39b5426d514fb955f3d36be5823d89d9087c5b08150a485bf6c9f8
-  data.tar.gz: a36dc255cf23bc5305af1edaf7299bd65db0a6a9b4259e138fa1ecbbbf0d322c9d8beff005812a4fdbbcecdf6aca9db81c128d46208961284e9c990396a18e3a
+  metadata.gz: b3feed7709d09d6b5bd06d3d88cc09de6a054bee63d24dd9cf62c01f80f356fbb0cdb20f6530c9b950f8c2fc8320273020ebeaae6892fbfc2ad7e51362c021d6
+  data.tar.gz: 7f399c285ac1dde603ca580a3fdc2fe2fca415bc17dd24ef3a75f4ea2cfe5cd5b31c56175edc1840817349fc41c51e4ebce3ddbd16559ba09d340a3360ee7b94

data/README.md

@@ -10,7 +10,16 @@
 An opinionated hypermedia API generator.
 
 Requires:
-- valid `.dot` file (with some specific styles)
+- valid `.dot` file with the following additional style guidelines
+  - edge style defaults to `arrowhead="odiamond"` to signify default requests are `GET`
+  - the first node listed should be the root, and is signified by `xlabel=` and `shape=point`
+  - collection nodes should be given `shape=folder` and pluralized
+  - the item node belonging to the collection node should be its singularized version and `shape=rectangle`
+  - forms (often called templates in the code, because they are a template for a valid request to the server) are given a `_template` suffix and `shape=note`
+  - `style=dotted` means the related object will be represented inline (embedded)
+  - `style=bold` and `arrowhead=normal` means `POST`
+  - `arrowhead=normal` alone means `PATCH`
+  - `color=red fontcolor=red` means `DELETE`
 
 Outputs:
 - Sinatra style routes
@@ -21,7 +30,7 @@ Outputs:
 
 ## About
 
-Directed graphs get complicated, but can be divded into simpler subgraphs. Picatrix is currently useful for only a single workflow (and barely that right now, as we're way before a real release). Integrated workflows will involve generating several route sets that will be required into a single Sinatra app. Some workflows may even be representable as DAGs/trees.
+Directed graphs get complicated, but can be divided into simpler subgraphs. Picatrix is currently useful for only a single workflow (and barely that right now, as we're way before a real release). Integrated workflows will involve generating several route sets that will be required into a single Sinatra app. Some workflows may even be representable as DAGs/trees.
 
 The ideal way to use Picatrix is to do an exercise in designing your API "outside in" where all inputs/outputs are defined, and a state diagram is drawn. This diagram can be translated to a dot file, and the inputs/outputs can be translated into hypermedia assets.
 
@@ -57,6 +66,14 @@ $ bin/picapica dg_api.dot app_name
 
 ![state diagram image of sample app](spec/support/dg_api.dot.png "simple photo viewing app")
 
+### how to interpret the graph
+
+Nodes and edges translate roughly into application and/or resource states, and state transitions.
+
+Dotted lines represent inlined relations. So, `View submissions` inlines `View submission` by `:item_id` (in this example a number).
+
+Labels on edges are link relations. Confusingly the actual _URL_ of the state transition (moving to the next state) is still the target node (essentially, think of the state transition name as the same as the name of the ideal output) _and_ its link relation to its source. So, `A (make_B_do_x)-> B` is `B/make_B_do_x`. This is still (obviously) sketchy.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/picatrix/digraph_parser.rb

@@ -13,11 +13,7 @@ module Picatrix
     rule(:default_definitions) do
       indent >>
       str("edge [") >>
-      newline >>
-      indent.repeat >>
-      str("arrowhead=\"odiamond\"") >>
-      newline >>
-      indent >>
+      (str("]").absent? >> any).repeat(0) >>
       str("]") >>
       newline
     end
@@ -34,8 +30,8 @@ module Picatrix
     end
     rule(:style) do
       str("style=dotted") |
-      str("style=bold") |
-      delete_marker
+        str("style=bold") |
+        delete_marker
     end
     rule(:post_marker) do
       str("arrowhead=normal")
@@ -45,8 +41,8 @@ module Picatrix
     end
     rule(:shape) do
       str("shape=note") |
-      str("shape=folder") |
-      str("shape=rectangle")
+        str("shape=folder") |
+        str("shape=rectangle")
     end
     rule(:label) do
       str("[") >>
@@ -77,16 +73,12 @@ module Picatrix
       space.repeat(0) >>
       str("}")
     end
-    rule(:root_label) do
-      str("[xlabel=") >>
-      (str("shape=point]").absent? >> any).repeat >>
-      str("shape=point]")
-    end
     rule(:root_line) do
       indent >>
-      snake_case_key >>
+      str("root") >>
       space >>
-      root_label
+      (newline.absent? >> any).repeat(0) >>
+      newline
     end
     rule(:digraph_open_tag) { str("digraph d {") }
     rule(:digraph_close_tag) { str("}") >> newline.repeat(0) >> eof }
@@ -100,8 +92,7 @@ module Picatrix
       root_of_api
     end
     rule(:root_of_api) do
-      root_line.as(:initial_inbound_request) >>
-      newline.repeat(1) >>
+      root_line >>
       (
         digraph_close_tag.absent? >>
         (

data/lib/picatrix/generated/app.rb

@@ -7,82 +7,92 @@ require_all("./lib/picatrix/generated/*.rb")
 class App < Sinatra::Base
   set :public_folder => "public", :static => true
 
+  get '/rels' do
+    json([{"root"=>{:target=>"view_submissions", :link_relation=>"\"newest\"", :inline=>false, :method=>:get}}, {"view_submissions"=>{:target=>"view_submission", :link_relation=>"\":item_id\"", :inline=>true, :method=>:get}}, {"view_submissions"=>{:target=>"submission_filter_template", :link_relation=>"\"filter\"", :inline=>true, :method=>:get}}, {"submission_filter_template"=>{:target=>"view_submissions", :link_relation=>"\"filter\"", :inline=>false, :method=>:get}}, {"view_submissions"=>{:target=>"submission_add_template", :link_relation=>"\"add\"", :inline=>true, :method=>:get}}, {"submission_add_template"=>{:target=>"view_submission", :link_relation=>"\"submit\"", :inline=>false, :method=>:post}}, {"view_submission"=>{:target=>"view_submissions", :link_relation=>"\"newest\"", :inline=>false, :method=>:get}}, {"view_submission"=>{:target=>"submission_delete_template", :link_relation=>"\"remove\"", :inline=>true, :method=>:get}}, {"submission_delete_template"=>{:target=>"view_submissions", :link_relation=>"\"newest\"", :inline=>false, :method=>:delete}}, {"view_submission"=>{:target=>"submission_edit_template", :link_relation=>"\"edit\"", :inline=>true, :method=>:get}}, {"submission_edit_template"=>{:target=>"view_submission", :link_relation=>"\"self\"", :inline=>false, :method=>:patch}}])
+  end
+
   get '/' do
-    status, headers, body = call env.merge("PATH_INFO" => "/welcome/newest")
+    status, headers, body = call env.merge("PATH_INFO" => "/view_submissions/newest")
     [status, headers, body]
   end
+
+
+ 
+   get "/view_submissions/newest" do
+     # get collection
+     items = ViewSubmission.all
+     # render collection into templates
+     hashed_items = items.collect do |item|
+       {"@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
+     end
+     # return that collection
+     json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/view_submissions/newest"}, "s:filter"=>{"href"=>"http://localhost:9292/view_submissions/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "s:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}}.merge({"view_submissions" => hashed_items}))
+   end
   
-  get "/welcome/newest" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}}.merge({"view_submissions" => hashed_items}))
-  end
-  
-  get "/submission_filter_template/filter" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, "category"=>"#{params[:category]}", "has_photo"=>"#{params[:has_photo]}"}.merge({"view_submissions" => hashed_items}))
-  end
-  
-  post "/submission_add_template/submit" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0}.merge({"view_submissions" => hashed_items}))
-  end
-  
-  get "/view_submission/newest" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}.merge({"view_submissions" => hashed_items}))
-  end
+
+ 
+   get "/view_submissions/filter" do
+     # get collection
+     items = ViewSubmission.all
+     # render collection into templates
+     hashed_items = items.collect do |item|
+       {"@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
+     end
+     # return that collection
+     json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/view_submissions/newest"}, "s:filter"=>{"href"=>"http://localhost:9292/view_submissions/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "s:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, "category"=>"#{params[:category]}", "has_photo"=>"#{params[:has_photo]}"}.merge({"view_submissions" => hashed_items}))
+   end
   
-  delete "/submission_delete_template/newest" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, :message=>0}.merge({"view_submissions" => hashed_items}))
-  end
+
+ 
+   post "/view_submission/submit" do
+     # create item
+     item = ViewSubmission.create(params)
+     # return new item
+     json({"@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/view_submissions/newest"}, "s:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "s:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0})
+   end
   
-  patch "/submission_edit_template/self" do
-    items = ViewSubmission.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      {"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
-    end
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0}.merge({"view_submissions" => hashed_items}))
-  end
+
+ 
+   get "/view_submissions/newest" do
+     # get collection
+     items = ViewSubmission.all
+     # render collection into templates
+     hashed_items = items.collect do |item|
+       {"@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
+     end
+     # return that collection
+     json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/view_submissions/newest"}, "s:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "s:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}.merge({"view_submissions" => hashed_items}))
+   end
   
+
+ 
+   delete "/view_submissions/newest" do
+     # get collection
+     items = ViewSubmission.all
+     # render collection into templates
+     hashed_items = items.collect do |item|
+       {"@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"}
+     end
+     # return that collection
+     json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/view_submissions/newest"}, "s:filter"=>{"href"=>"http://localhost:9292/view_submissions/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "s:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, :message=>0}.merge({"view_submissions" => hashed_items}))
+   end
   
-  get "/view_submission/:item_id" do
-    item_id = params[:item_id]
-    item = ViewSubmission.find(item_id)
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"})
-  end
+
+ 
+   patch "/view_submission/self" do
+     # create item
+     item = ViewSubmission.find(params)
+     # return new item
+     json({"@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/view_submissions/newest"}, "s:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "s:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0})
+   end
   
+
+
+
+   get "/view_submission/:item_id" do
+     item_id = params[:item_id]
+     item = ViewSubmission.find(item_id)
+     json({"@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}, "@controls"=>{"self"=>{"title"=>"submission #{item.id}", "href"=>"http://localhost:9292/view_submission/#{item.id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/view_submissions/newest"}, "s:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "s:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item.id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"})
+   end
+
 end

data/lib/picatrix/generated/view_submission.rb

@@ -7,6 +7,9 @@ class ViewSubmission
       id: item_id
     )
   end
+  def self.create(params)
+    self.find(rand(10))
+  end
   def self.all
     [
       OpenStruct.new(

data/lib/picatrix/jenny.rb

@@ -5,35 +5,39 @@ module Picatrix
   class Jenny
     include Thor::Base
     include Thor::Actions
-    attr_accessor :edges, :nodes, :app_name, :routes, :root,
-      :destination_stack, :options, :root_node_name,
-      :default_response, :assets, :addressable_items,
-      :generated
+
+    attr_accessor :app_name, :routes, :root_path, :rels,
+      :destination_stack, :options,
+      :default_response, :assets, :generated,
+      :addressable_items, :collectable_items
 
     argument :name
     source_root File.dirname(__FILE__)
 
     def initialize(array = [], options = {}, app_name = "app")
-      @app_name = app_name
+      # thor related
       @options = options
       @destination_stack = [self.class.source_root]
-      @default_response = { message: 0 }
 
       hash = array.group_by {|e| e.keys.first}
       @nodes = hash[:node].flat_map {|e| e[:node]}.reduce({}, :merge)
       @edges = hash[:edge].flat_map {|e| e[:edge]}
-      # TODO need to adjust parser down below so i dont need to traverse this nonsense
-      @root_node_name = hash[:root].first.values.flatten.first.split("[").first.delete(" ")
+
+      @app_name = app_name
+      @rels = @edges
+      @default_response = { message: 0 }
 
       @generated = []
-      # TODO for performance combine loops
       @assets = assets
+      # items must come before collectable_items
       @addressable_items = addressable_items
+      @collectable_items = collectable_items
       @routes = routes
     end
 
     def just_do_it
       @generated.each do |node_name|
+        # bring in defined objects
         require "./lib/picatrix/generated/#{node_name}.rb"
       end
       generate_app_file
@@ -47,16 +51,12 @@ module Picatrix
       )
     end
     def assets
-      @edges.collect do | edge|
+      @assets ||= @edges.collect do | edge|
         source = edge.keys.first
         properties = edge[source]
         # if you dont have an inline asset, ignore
         next unless properties[:inline]
 
-        # TODO ?
-        #link_relation = properties[:link_relation]
-        #path = "#{source}/#{link_relation.delete('"')}"
-
         mason_path = "lib/picatrix/templates/mason/#{properties[:target]}.json"
 
         if File.exist?(mason_path)
@@ -74,14 +74,20 @@ module Picatrix
       end.compact.reduce({}, :merge)
     end
     def routes
-      @edges.collect do |edge|
+      @routes ||= @edges.collect do |edge|
         source = edge.keys.first
+        target = edge.values.first[:target]
         properties = edge[source]
+
         # we dont need a route if it is inline represented
         next if properties[:inline]
 
         link_relation = properties[:link_relation]
-        path = "#{source}/#{link_relation.delete('"')}"
+        path = "#{target}/#{link_relation.delete('"')}"
+
+        if source == "root"
+          @root_path = path
+        end
 
         mason_path = "lib/picatrix/templates/mason/#{edge[source][:target]}.json"
 
@@ -95,36 +101,21 @@ module Picatrix
           body = default_response
         end
 
-        if source == root_node_name
-          @root = path
-        end
-
         if (asset = assets[source]) && body.is_a?(Hash)
           body.merge!(asset)
         end
 
-        collections = @addressable_items.inject({}) do |memo, item|
-          memo["#{path}"] = {
-              name: "#{item[:type].pluralize}",
-              resource_name: "#{item[:type].camelcase}",
-              template: JSON.parse(
-                File.read("lib/picatrix/templates/mason/#{item[:type]}_min.json")
-              )
-          }
-          memo
-        end
-
         {
           path: path,
           method: properties[:method],
           # danger danger danger will robinson we are unescaping here!
           body: body.to_s.delete("\\"),
-          collection: collections["#{path}"]
+          collection: (collectable_items[target.singularize] || [])
         }
       end.compact!
     end
     def addressable_items
-      @nodes.collect do |node|
+      @addressable_items ||= @nodes.collect do |node|
         node_name = node.first
         node_properties = node.last
 
@@ -160,7 +151,6 @@ module Picatrix
           else
             schema = {}
           end
-
           {
             path: item_path,
             type: node_name,
@@ -171,5 +161,31 @@ module Picatrix
         end
       end.compact!
     end
+    def collectable_items
+      @collectable_items ||= @addressable_items.inject({}) do |memo, item|
+        memo[item[:type]] = {
+          name: "#{item[:type].pluralize}",
+          resource_name: "#{item[:type].camelcase}",
+          template: JSON.parse(
+            File.read("lib/picatrix/templates/mason/#{item[:type]}_min.json")
+          )
+        }
+        memo
+      end
+    end
+    def return_mapping_of(method)
+      {
+        post: :single_return,
+        get: :collection_return,
+        patch: :single_return,
+        delete: :collection_return
+      }[method]
+    end
+    def send_method_for(method)
+      {
+        post: :create,
+        patch: :find
+      }[method]
+    end
   end
 end

data/lib/picatrix/pacman.rb

@@ -4,9 +4,11 @@ module Picatrix
     attr_accessor :graph, :hash
 
     def initialize(file_name)
-      @graph = GraphViz.parse(file_name, :path => "/usr/local/bin")
+      @graph = GraphViz.parse(
+        file_name, :path => "/usr/local/bin"
+      )
       @hash = TransformToHash.new.apply(
-        DigraphParser.new.parse(
+        DigraphParser.new.parse_with_debug(
           File.read(file_name)
         )
       ).flat_map(&:entries).

data/lib/picatrix/templates/app.rb

@@ -7,27 +7,42 @@ require_all("./lib/picatrix/generated/*.rb")
 class <%= @app_name.camelize %> < Sinatra::Base
   set :public_folder => "public", :static => true
 
+  get '/rels' do
+    json(<%= @rels %>)
+  end
+
   get '/' do
-    status, headers, body = call env.merge("PATH_INFO" => "/<%= @root %>")
+    status, headers, body = call env.merge("PATH_INFO" => "/<%= @root_path %>")
     [status, headers, body]
   end
-  <% @routes.each do |route| %>
-  <%= route[:method] %> "/<%= route[:path] %>" do
-    items = <%= route[:collection][:resource_name].constantize %>.all
-    hashed_items = items.collect do |item|
-      item_id = item.id
-      category = item.category
-      photo = item.photo
-      <%= route[:collection][:template].to_s.delete("\\") %>
-    end
-    json(<%= route[:body] %>.merge({"<%= route[:collection][:name] %>" => hashed_items}))
-  end
-  <% end %>
-  <% @addressable_items.each do |item| %>
-  get "/<%= item[:path] %>" do
-    item_id = params[:item_id]
-    item = <%= item[:type].camelcase.constantize %>.find(item_id)
-    json(<%= item[:body] %>)
-  end
+
+<% @routes.uniq.each do |route| %>
+ <% if return_mapping_of(route[:method]) == :collection_return %>
+   <%= route[:method] %> "/<%= route[:path] %>" do
+     # get collection
+     items = <%= route[:collection][:resource_name].constantize %>.all
+     # render collection into templates
+     hashed_items = items.collect do |item|
+       <%= route[:collection][:template].to_s.delete("\\") %>
+     end
+     # return that collection
+     json(<%= route[:body] %>.merge({"<%= route[:collection][:name] %>" => hashed_items}))
+   end
+  <% else %>
+   <%= route[:method] %> "/<%= route[:path] %>" do
+     # create item
+     item = <%= route[:collection][:resource_name].constantize %>.<%= send_method_for(route[:method]).to_s %>(params)
+     # return new item
+     json(<%= route[:body] %>)
+   end
   <% end %>
+<% end %>
+
+<% @addressable_items.each do |item| %>
+   get "/<%= item[:path] %>" do
+     item_id = params[:item_id]
+     item = <%= item[:type].camelcase.constantize %>.find(item_id)
+     json(<%= item[:body] %>)
+   end
+<% end %>
 end

data/lib/picatrix/templates/mason/view_submission.json

@@ -1,26 +1,31 @@
 {
+  "@namespaces": {
+    "s": {
+      "name": "http://localhost:9292/rels#"
+    }
+  },
   "@controls": {
     "self": {
-      "title": "submission #{item_id}",
-      "href": "http://localhost:9292/view_submission/#{item_id}"
+      "title": "submission #{item.id}",
+      "href": "http://localhost:9292/view_submission/#{item.id}"
     },
     "up": {
       "title": "View submissions",
-      "href": "http://localhost:9292/welcome/newest"
+      "href": "http://localhost:9292/view_submissions/newest"
     },
-    "is:edit": {
+    "s:edit": {
       "title": "update category or photo url",
       "encoding": "json",
-      "href": "http://localhost:9292/view_submission/#{item_id}",
+      "href": "http://localhost:9292/view_submission/#{item.id}",
       "method": "PATCH",
       "template": {
         "photo": "{new_url}",
         "category": "{new_category}"
       }
     },
-    "is:remove": {
+    "s:remove": {
       "title": "remove submission",
-      "href": "http://localhost:9292/view_submission/#{item_id}",
+      "href": "http://localhost:9292/view_submission/#{item.id}",
       "method": "DELETE"
     }
   },

data/lib/picatrix/templates/mason/view_submission_min.json

@@ -1,8 +1,8 @@
 {
   "@controls": {
     "self": {
-      "title": "submission #{item_id}",
-      "href": "http://localhost:9292/view_submission/#{item_id}"
+      "title": "submission #{item.id}",
+      "href": "http://localhost:9292/view_submission/#{item.id}"
     }
   },
   "id": "#{item.id}",

data/lib/picatrix/templates/mason/view_submissions.json

@@ -5,18 +5,22 @@
     "@title": "Submissions",
     "@description": "This resource represents submissions."
   },
-
+  "@namespaces": {
+    "s": {
+      "name": "http://localhost:9292/rels#"
+    }
+  },
   "@controls": {
     "self": {
-      "href": "http://localhost:9292/welcome/newest"
+      "href": "http://localhost:9292/view_submissions/newest"
     },
-    "is:filter": {
-      "href": "http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}",
+    "s:filter": {
+      "href": "http://localhost:9292/view_submissions/filter?category={category}&has_photo={has_photo}",
       "isHrefTemplate": true,
       "title": "filter submissions by category",
       "description": "in addition to category, you can ensure the submission has a photo"
     },
-    "is:add": {
+    "s:add": {
       "title": "add new submission",
       "encoding": "json",
       "href": "http://localhost:9292/submission_add_template/submit",

data/lib/picatrix/templates/type.rb

@@ -7,6 +7,9 @@ class <%= @node_name.camelize %>
       id: item_id
     )
   end
+  def self.create(params)
+    self.find(rand(10))
+  end
   def self.all
     [
       OpenStruct.new(

data/lib/picatrix/transform_to_hash.rb

@@ -1,10 +1,5 @@
 module Picatrix
   class TransformToHash < Parslet::Transform
-    rule(:initial_inbound_request => simple(:x)) do
-      {
-        root: String(x)
-      }
-    end
     rule(:node => subtree(:node)) do
       types = {
         note: "template",

data/lib/picatrix/version.rb

@@ -1,3 +1,3 @@
 module Picatrix
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: picatrix
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Moore-Niemi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -226,7 +226,6 @@ files:
 - bin/setup
 - lib/picatrix.rb
 - lib/picatrix/digraph_parser.rb
-- lib/picatrix/generated/.rb
 - lib/picatrix/generated/app.rb
 - lib/picatrix/generated/view_submission.rb
 - lib/picatrix/jenny.rb

data/lib/picatrix/generated/.rb

@@ -1,46 +0,0 @@
-require 'sinatra'
-require 'sinatra/json'
-require 'require_all'
-
-require_all("./lib/picatrix/generated/*.rb")
-
-class App < Sinatra::Base
-  set :public_folder => "public", :static => true
-
-  get '/' do
-    status, headers, body = call env.merge("PATH_INFO" => "/welcome/newest")
-    [status, headers, body]
-  end
-  
-  get "/welcome/newest" do
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, "submissions"=>[{"@controls"=>{"self"=>{"title"=>"submission 1", "href"=>"http://localhost:9292/view_submission/1"}}, "id"=>1, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/tntOCGkgt98/maxresdefault.jpg"}, {"@controls"=>{"self"=>{"title"=>"submission 2", "href"=>"http://localhost:9292/view_submission/2"}}, "id"=>2, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/icqDxNab3Do/maxresdefault.jpg"}]})
-  end
-  
-  get "/submission_filter_template/filter" do
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, "submissions"=>[{"@controls"=>{"self"=>{"title"=>"submission 1", "href"=>"http://localhost:9292/view_submission/1"}}, "id"=>1, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/tntOCGkgt98/maxresdefault.jpg"}, {"@controls"=>{"self"=>{"title"=>"submission 2", "href"=>"http://localhost:9292/view_submission/2"}}, "id"=>2, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/icqDxNab3Do/maxresdefault.jpg"}], "category"=>"#{params[:category]}", "has_photo"=>"#{params[:has_photo]}"})
-  end
-  
-  post "/submission_add_template/submit" do
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0})
-  end
-  
-  get "/view_submission/newest" do
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "submissions"=>[{"@controls"=>{"self"=>{"title"=>"submission 1", "href"=>"http://localhost:9292/view_submission/1"}}, "id"=>1, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/tntOCGkgt98/maxresdefault.jpg"}, {"@controls"=>{"self"=>{"title"=>"submission 2", "href"=>"http://localhost:9292/view_submission/2"}}, "id"=>2, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/icqDxNab3Do/maxresdefault.jpg"}], "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"})
-  end
-  
-  delete "/submission_delete_template/newest" do
-    json({"title"=>"View submissions", "description"=>"idk yet", "@meta"=>{"@title"=>"Submissions", "@description"=>"This resource represents submissions."}, "@controls"=>{"self"=>{"href"=>"http://localhost:9292/welcome/newest"}, "is:filter"=>{"href"=>"http://localhost:9292/submission_filter_template/filter?category={category}&has_photo={has_photo}", "isHrefTemplate"=>true, "title"=>"filter submissions by category", "description"=>"in addition to category, you can ensure the submission has a photo"}, "is:add"=>{"title"=>"add new submission", "encoding"=>"json", "href"=>"http://localhost:9292/submission_add_template/submit", "method"=>"POST", "template"=>{"title"=>"default title", "category"=>"cats", "photo_url"=>"http://cats.com"}}}, "submissions"=>[{"@controls"=>{"self"=>{"title"=>"submission 1", "href"=>"http://localhost:9292/view_submission/1"}}, "id"=>1, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/tntOCGkgt98/maxresdefault.jpg"}, {"@controls"=>{"self"=>{"title"=>"submission 2", "href"=>"http://localhost:9292/view_submission/2"}}, "id"=>2, "category"=>"cats", "photo"=>"https://i.ytimg.com/vi/icqDxNab3Do/maxresdefault.jpg"}], :message=>0})
-  end
-  
-  patch "/submission_edit_template/self" do
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}", :message=>0})
-  end
-  
-  
-  get "/view_submission/:item_id" do
-    item_id = params[:item_id]
-    item = ViewSubmission.find(item_id)
-    json({"@controls"=>{"self"=>{"title"=>"submission #{item_id}", "href"=>"http://localhost:9292/view_submission/#{item_id}"}, "up"=>{"title"=>"View submissions", "href"=>"http://localhost:9292/welcome/newest"}, "is:edit"=>{"title"=>"update category or photo url", "encoding"=>"json", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"PATCH", "template"=>{"photo"=>"{new_url}", "category"=>"{new_category}"}}, "is:remove"=>{"title"=>"remove submission", "href"=>"http://localhost:9292/view_submission/#{item_id}", "method"=>"DELETE"}}, "id"=>"#{item.id}", "category"=>"#{item.category}", "photo"=>"#{item.photo}"})
-  end
-  
-end