picatrix 0.5.0 → 0.5.5

data/lib/picatrix/templates/mason.rb

@@ -0,0 +1,114 @@
+module Picatrix
+  module Mason
+    def mason_up(type)
+      if type.to_s.pluralize == type
+        proc do |path, params|
+          {
+            up: Mason::Up.new(
+              {
+                href: "http://localhost:9292/#{<%= @root_path %>}"
+              }
+            ).to_hash
+          }
+        end
+      else
+        proc do |path, params|
+          {
+            up: Mason::Up.new(
+              {
+                href: "http://localhost:9292/#{path.pluralize}"
+              }
+            ).to_hash
+          }
+        end
+      end
+    end
+    def mason_self(item)
+      proc do |path, params|
+        if params[:item_id]
+          {
+            self: Mason::Self.new(
+              {
+                href: "http://localhost:9292/#{path}/#{params[:item_id]}"
+              }
+            ).to_hash
+          }
+        else
+          {
+            self: Mason::Self.new(
+              {
+                href: "http://localhost:9292/#{path}"
+              }
+            ).to_hash
+          }
+        end
+      end
+    end
+    def edit(item)
+      proc do |path, params|
+        {
+          "<%= @prefix %>edit": Mason::Edit.new(
+            {
+              href: "http://localhost:9292/#{path}/#{params[:item_id]}",
+              method: Mason::HTTPVerb::PATCH
+            }
+          ).to_hash
+        }
+      end
+    end
+    def remove(item)
+      proc do |path, params|
+        {
+          "<%= @prefix %>remove": Mason::Remove.new(
+            {
+              href: "http://localhost:9292/#{path}/#{params[:item_id]}",
+              method: Mason::HTTPVerb::DELETE
+            }
+          ).to_hash
+        }
+      end
+    end
+    def create(collection)
+      proc do |path, params|
+        collection_name = collection.to_s.camelize
+        {
+          "<%= @prefix %>create": Mason::Create.new(
+            {
+              href: "http://localhost:9292/#{path}",
+              method: Mason::HTTPVerb::POST,
+              title: "Create a new #{collection_name}",
+              create_template: "#{collection_name}CreateTemplate".constantize.new({})
+            }
+          )
+        }
+      end
+    end
+    def filter(collection)
+      proc do |path, params|
+        if params[:newest]
+          {
+            "<%= @prefix %>filter": Mason::Filter.new(
+              {
+                href: "http://localhost:9292/#{path}?filter=newest",
+                isHrefTemplate: true,
+                method: Mason::HTTPVerb::GET,
+                title: "Show the newest additions to #{collection}"
+              }
+            ).to_hash
+          }
+        else
+          {
+            "<%= @prefix %>filter": Mason::Filter.new(
+              {
+                href: "http://localhost:9292/#{path}?$select&{field1}={value1}&{field2}={value2}",
+                isHrefTemplate: true,
+                method: Mason::HTTPVerb::GET,
+                title: "Filter using $select on schema fields"
+              }
+            ).to_hash
+          }
+        end
+      end
+    end
+  end
+end

data/lib/picatrix/templates/namespaces.json

@@ -0,0 +1,7 @@
+{
+  "@namespaces": {
+      "<%= @prefix %>": {
+            "name": "<%= @host %>rels#"
+          }
+    }
+}

data/lib/picatrix/templates/type.rb

@@ -30,12 +30,15 @@ class <%= @resource_name %>Resource
     }
     <%= @resource_name %>.new(collection: collection)
   end
-
+  def self.as_hashes
+    self.all.collection.map(&:to_hash)
+  end
+  # this makes no sense on this class
   def self.minimal_controls_for(item_id)
     host = "http://localhost:9292"
     {
-      self: Mason::Self.new(href: "#{host}/<%= @resource_name.singularize.underscore %>/#{item_id}"),
-      up: Mason::Up.new(href: "#{host}/<%= @resource_name.underscore %>")
+      self: ::Picatrix::Mason::Self.new(href: "#{host}/<%= @resource_name.underscore %>/#{item_id}"),
+      up: ::Picatrix::Mason::Up.new(href: "#{host}/<%= @resource_name.underscore %>")
     }
   end
 end

data/lib/picatrix/transform_to_hash.rb

@@ -4,7 +4,7 @@ module Picatrix
       {
         node: {
           String(node[:name]) => {
-            label: String(node[:label]),
+            label: String(node[:label]).delete('"'),
           }
         }
       }
@@ -26,7 +26,7 @@ module Picatrix
         edge: {
           String(edge[:outbound]) => {
             target: String(edge[:inbound]).delete(" {} "),
-            link_relation: String(edge[:link_relation]),
+            link_relation: String(edge[:link_relation]).delete('"'),
             method: method
           }
         }

data/lib/picatrix/version.rb

@@ -1,3 +1,3 @@
 module Picatrix
-  VERSION = "0.5.0"
+  VERSION = "0.5.5"
 end

data/notes.md

@@ -0,0 +1,34 @@
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mooreniemi/picatrix). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## About
+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.
+
+## ongoing work notes
+### TODO
+
+- CRUD+
+  - `create` should have form
+  - `filter` actions should have a app hook in routes
+  - `edit` should have form (form = template in case i forget)
+- generic filter action by schema? re-namespace it?
+
+### the end state
+
+process goes: .dot file + `prep` (1)-> proto file from nodes + user input into .proto + `proto` (2)-> ruby representation classes + user input to fixturize (3)-> `g` (4)-> `rackup generated/app.rb`
+
+1. outside in design process produced a diagram, which is written into a .dot file
+2. all nodes are representations of resources, and thus get proto objects generated for them, here is where the inputs/outputs are formed into a schema
+3. representation nodes now have ruby classes that reflect the information that will be sent back and forth in messages so we generate the app
+4. boot up the app
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: picatrix
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.5
 platform: ruby
 authors:
 - Alex Moore-Niemi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -251,28 +251,37 @@ files:
 - Rakefile
 - bin/console
 - bin/picapica
+- bin/post-receive.sh
 - bin/setup
-- definitions/app.proto
-- definitions/mason.proto
+- generated/zoo.dot
+- generated/zoo.dot.png
+- generated/zoo/resources/animals.rb
+- generated/zoo/support/mason.rb
+- generated/zoo/support/namespaces.json
+- generated/zoo/support/picatrix.mason.pb.rb
+- generated/zoo/support/zoo.pb.rb
+- generated/zoo/support/zoo.proto
+- generated/zoo/zoo.rb
 - lib/picatrix.rb
 - lib/picatrix/buffy.rb
 - lib/picatrix/cruddy.rb
 - lib/picatrix/digraph_parser.rb
-- lib/picatrix/fixtures/view_submission.rb
-- lib/picatrix/generated/app.pb.rb
-- lib/picatrix/generated/app.rb
-- lib/picatrix/generated/mason.pb.rb
-- lib/picatrix/generated/mason/namespaces.json
-- lib/picatrix/generated/view_submissions.rb
 - lib/picatrix/jenny.rb
 - lib/picatrix/link_relation_index.rb
 - lib/picatrix/pacman.rb
+- lib/picatrix/protoc.rb
+- lib/picatrix/prototyper.rb
 - lib/picatrix/routes.rb
+- lib/picatrix/support/picatrix.mason.proto
+- lib/picatrix/templates/app.proto
 - lib/picatrix/templates/app.rb
 - lib/picatrix/templates/control.rb
+- lib/picatrix/templates/mason.rb
+- lib/picatrix/templates/namespaces.json
 - lib/picatrix/templates/type.rb
 - lib/picatrix/transform_to_hash.rb
 - lib/picatrix/version.rb
+- notes.md
 - picatrix.gemspec
 homepage: https://github.com/mooreniemi/picatrix
 licenses:
@@ -299,3 +308,4 @@ signing_key:
 specification_version: 4
 summary: 'input: dot file + yml files, output: ruby api'
 test_files: []
+has_rdoc: 

data/definitions/app.proto

@@ -1,47 +0,0 @@
-import "mason.proto";
-
-// objects
-message ViewSubmission {
-  optional int32 id = 1;
-  optional string category = 2;
-  optional string photo = 3;
-
-  // items probably want a minimal representation
-  // of available controls when in collection view
-  message Controls {
-    optional mason.Self self = 2;
-  }
-
-  message Attachment {
-    optional int32 id = 1;
-  }
-
-  optional Controls controls = 4;
-  repeated Attachment attachments = 5;
-}
-
-message ViewSubmissions {
-  repeated ViewSubmission collection = 1;
-}
-
-// controls
-message EditViewSubmission {
-  // someday gen this from schema?
-  optional mason.Edit form = 3;
-  message Template {
-    optional string category = 1;
-    optional string has_photo = 2;
-  }
-  optional Template template = 4;
-}
-
-message CreateViewSubmission {
-  // someday gen this from schema?
-  optional mason.Create form = 3;
-  message Template {
-    optional string category = 1;
-    optional string has_photo = 2;
-  }
-  optional Template template = 4;
-}
-

data/lib/picatrix/fixtures/view_submission.rb

@@ -1,19 +0,0 @@
-class ViewSubmissionFixture
-  # real object has more properties
-  def self.attributes
-    {
-      category: random_category,
-      photo: random_photo,
-      secret_data: "that won't be shared",
-      pci_data: "really won't appear"
-    }
-  end
-
-  def self.random_category
-    %w{ cats }.sample
-  end
-
-  def self.random_photo
-    %w{ http://imgur.com/r/cats/myEqIZx }.sample
-  end
-end

data/lib/picatrix/generated/app.pb.rb

@@ -1,79 +0,0 @@
-# encoding: utf-8
-
-##
-# This file is auto-generated. DO NOT EDIT!
-#
-require 'protobuf/message'
-
-
-##
-# Imports
-#
-require_relative 'mason.pb.rb'
-
-
-##
-# Message Classes
-#
-class ViewSubmission < ::Protobuf::Message
-  class Controls < ::Protobuf::Message; end
-  class Attachment < ::Protobuf::Message; end
-
-end
-
-class ViewSubmissions < ::Protobuf::Message; end
-class EditViewSubmission < ::Protobuf::Message
-  class Template < ::Protobuf::Message; end
-
-end
-
-class CreateViewSubmission < ::Protobuf::Message
-  class Template < ::Protobuf::Message; end
-
-end
-
-
-
-##
-# Message Fields
-#
-class ViewSubmission
-  class Controls
-    optional ::Mason::Self, :self, 2
-  end
-
-  class Attachment
-    optional :int32, :id, 1
-  end
-
-  optional :int32, :id, 1
-  optional :string, :category, 2
-  optional :string, :photo, 3
-  optional ::ViewSubmission::Controls, :controls, 4
-  repeated ::ViewSubmission::Attachment, :attachments, 5
-end
-
-class ViewSubmissions
-  repeated ::ViewSubmission, :collection, 1
-end
-
-class EditViewSubmission
-  class Template
-    optional :string, :category, 1
-    optional :string, :has_photo, 2
-  end
-
-  optional ::Mason::Edit, :form, 3
-  optional ::EditViewSubmission::Template, :template, 4
-end
-
-class CreateViewSubmission
-  class Template
-    optional :string, :category, 1
-    optional :string, :has_photo, 2
-  end
-
-  optional ::Mason::Create, :form, 3
-  optional ::CreateViewSubmission::Template, :template, 4
-end
-

data/lib/picatrix/generated/app.rb

@@ -1,209 +0,0 @@
-require 'sinatra'
-require 'sinatra/json'
-require 'protobuf'
-require 'require_all'
-
-require_all("./lib/picatrix/generated/*.rb")
-
-class App < Sinatra::Base
-  set :public_folder => "public", :static => true
-
-  get '/rels' do
-    json({:@controls=>{:up=>"http://localhost:9292/", :self=>"http://localhost:9292/rels"}, :link_relations=>{:newest=>["root -(GET)-> view_submissions", "view_submission -(GET)-> view_submissions", "view_submissions -(DELETE)-> view_submissions"], :":item_id"=>["view_submissions -(GET)-> view_submission"], :filter=>["view_submissions -(GET)-> view_submissions"], :submit=>["view_submissions -(POST)-> view_submission"], :edit=>["view_submission -(PATCH)-> view_submission"]}})
-  end
-
-  get '/' do
-    status, headers, body = call env.merge("PATH_INFO" => "/view_submissions")
-    [status, headers, body]
-  end
-
-  def json(hash = {})
-    # anything set here will be sent in all responses
-    super({"@namespaces"=>{"s"=>{"name"=>"http://localhost:9292/rels#"}}}.merge!(hash))
-  end
-
-
-
-   get "/view_submissions" do
-     items = ViewSubmissionsResource.all.collection.collect do |r|
-       r.to_hash
-     end
-
-     
-     controls = send(:filter, ViewSubmissions).call("view_submissions", params)
-     
-
-     json(
-       {:@controls => controls}.
-        merge!({"view_submissions" => items})
-     )
-   end
-  
-
-
-   get "/view_submission/:item_id" do
-     item = ViewSubmissionsResource.find(params[:item_id])
-
-     
-     controls = send(:mason_self, ViewSubmission).call("view_submission", params)
-     
-
-     json(
-       {:@controls => controls}.
-        merge!(item.to_hash.except(:controls))
-     )
-   end
-  
-
-
-   post "/view_submission/:item_id" do
-     item = ViewSubmissionsResource.create(params[:item_id])
-
-     
-     controls = {}
-     
-
-     json(
-       {:@controls => controls}.
-        merge!(item.to_hash.except(:controls))
-     )
-   end
-  
-
-
-   delete "/view_submissions" do
-     items = ViewSubmissionsResource.all.collection.collect do |r|
-       r.to_hash
-     end
-
-     
-     controls = {}
-     
-
-     json(
-       {:@controls => controls}.
-        merge!({"view_submissions" => items})
-     )
-   end
-  
-
-
-   patch "/view_submission/:item_id" do
-     item = ViewSubmissionsResource.find(params[:item_id])
-
-     
-     controls = send(:edit, ViewSubmission).call("view_submission", params)
-     
-
-     json(
-       {:@controls => controls}.
-        merge!(item.to_hash.except(:controls))
-     )
-   end
-  
-
-
-  def mason_up(type)
-    if type == collection
-      proc do |path, params|
-        {
-          up: Mason::Up.new(
-            {
-              href: "http://localhost:9292/#{view_submissions}"
-            }
-          ).to_hash
-        }
-      end
-    else
-      proc do |path, params|
-        {
-          up: Mason::Up.new(
-            {
-              href: "http://localhost:9292/#{path}"
-            }
-          ).to_hash
-        }
-      end
-    end
-  end
-  def mason_self(item)
-      proc do |path, params|
-        if params[:item_id]
-          {
-            self: Mason::Self.new(
-              {
-                href: "http://localhost:9292/#{path}/#{params[:item_id]}"
-              }
-            ).to_hash
-          }
-        else
-          {
-            self: Mason::Self.new(
-              {
-                href: "http://localhost:9292/#{path}"
-              }
-            ).to_hash
-          }
-        end
-      end
-  end
-  def edit(item)
-      proc do |path, params|
-        {
-          edit: ("Edit" + item.to_s.singularize.camelize).constantize.new(
-            {
-              form: Mason::Edit.new(
-                href: "http://localhost:9292/#{path}/#{params[:item_id]}"
-              )
-            }
-          ).to_hash
-        }
-      end
-  end
-  def remove(item)
-      proc do |path, params|
-        {
-          remove: Mason::Remove.new(
-            {
-              href: "http://localhost:9292/#{path}/#{params[:item_id]}"
-            }
-          ).to_hash
-        }
-      end
-  end
-  def create(item)
-      proc do |path, params|
-        {
-          create: ("Create" + item.to_s.singularize.camelize).constantize.new(
-            {
-              form: Mason::Create.new(
-                href: ""
-              )
-            }
-          )
-        }
-      end
-  end
-  def filter(collection)
-    # TODO this prob cant really work here
-      proc do |path, params|
-        if params[:item_id]
-          {
-            "s:filter": Mason::Filter.new(
-              {
-                href: "http://localhost:9292/#{path}/#{params[:item_id]}"
-              }
-            ).to_hash
-          }
-        else
-          {
-            "s:filter": Mason::Filter.new(
-              {
-                href: "http://localhost:9292/#{path}"
-              }
-            ).to_hash
-          }
-      end
-    end
-  end
-end