marley 0.1.0

data/README.rdoc

@@ -0,0 +1,51 @@
+=Marley
+
+Marley is a project consisting of several parts:
+
+* A server side micro-framework for returning data from ORM models (currently only Sequel) and other objects (Ruby, based on rack with thin as the default web server)
+* A framework for adding reusable content to the framework ("Joints")
+* A JSON data format ("Reggae") 
+* A simple JS client ("Jamaica") which renders Reggae as HTML.
+
+The point of the whole thing is to create as many useful default behaviors as possible, while making it easy to override any or all of them.
+
+Please see the examples/forum.rb to get a basic idea of what a Marley application looks like.
+
+-----
+
+More about each part:
+
+==Marley
+
+* Marley resources are constants in the Marley::Resources namespace.
+  * A resource must respond either to a #controller method or to one or more of #rest_get, #rest_post, #rest_put, or #rest_delete. 
+  * Resources implementing a #controller method should return an object that responds to one or more REST verbs from that method
+  * REST verb methods should return an object which responds to #to_json by returning a string to be sent to the client
+
+* Marley provides 2 plugins for the Sequel ORM.
+  * RestConvenience - Adds a default controller for standard rest routes to a model
+  * RestAuthorization - Adds default authorization to a model
+
+I use Sequel exclusively, so I've only written these plugins for it.  I imagine it would be pretty trivial to port them to other ORMs.
+
+==Joints
+
+"Joints" are pre-packaged resource sets that can be included in a Marley application.  The joints API is very much a work in progress.
+
+For now, there are 3 joints included in the Marley distribution:
+
+* Basic User
+* Basic Messaging
+* Tagging
+
+With a bit of configuration and a few menus, these comprise the example forum application, which is in turn the targt for the test suite.
+
+==Reggae
+
+The server and client use a JSON based data representation I developed for this project and tentatively named "Reggae."  It is documented roughly in Reggae.ebnf.  I am considering some structural changes, which are reflected in Reggae2.ebnf.  I'd love some comments on this.
+
+==Jamaica
+
+The default Marley client is "Jamaica", which consists of JS/CSS for browsers.  It sucks right now and I'm hoping somebody takes it over as a sub-project, but it does work - at least on FF.
+
+

data/TODO

@@ -0,0 +1,17 @@
+
+
+- improve testing coverage
+- improve documentation - esp API
+
+- ditch Sequel dependency
+
+- automate sequel plugin loading in options
+
+- better logging
+
+- hints for resources/columns
+- better filtering options for posts
+
+??? expose validation reflections to views
+??? caching protocol for autocompleters/validation options
+

data/examples/forum.css

@@ -0,0 +1,3 @@
+a.expandCollapse, a.expandCollapseAll{background-color:#398235;color:#fff;text-decoration:none;margin:.5em;font-weight:bold;}
+.collapsed > .instance > .colContainer,.collapsed > .instance > .instanceActions{display:none;}
+.collapsed > .instance > .post__titleColContainer,.collapsed > .instance > .private_message__titleColContainer{display:block;}

data/examples/forum.js

@@ -0,0 +1,23 @@
+$(function(){
+  $("body").ajaxComplete(function(){
+    $(".postInstance,.private_messageInstance").parent().not('.collapsible').prepend(["a",{"href":"#","class":"expandCollapse"},"collapse"].toDom()).prepend(["a",{"href":"#","class":"expandCollapseAll"},"collapse from here"].toDom());
+    $(".postInstance,.private_messageInstance").parent().not('.collapsible').addClass('collapsible');
+  });
+  $(".expandCollapse").live('click',collapseExpand);
+  $(".expandCollapseAll").live('click',collapseExpandAll);
+});
+
+function collapseExpand() {
+  $(this).closest('.collapsible').toggleClass('collapsed').toggleClass('expanded');
+  $(this).html($(this).html()=='collapse' ? 'expand' : 'collapse');
+  return false;
+}
+function collapseExpandAll() {
+  var affected=$(this).closest('.collapsible').find('.collapsible').andSelf();
+  if ($(this).html().match(/collapse/)){
+    affected.addClass('collapsed').removeClass('expanded').find('.expandCollapse,.expandCollapseAll').each(function(){$(this).html($(this).html().replace(/collapse/,'expand'))});
+  } else {
+    affected.removeClass('collapsed').addClass('expanded').find('.expandCollapse,.expandCollapseAll').each(function(){$(this).html($(this).html().replace(/expand/,'collapse'))});
+  }
+  return false;
+}

data/examples/forum.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'sequel'
+require 'digest/sha1'
+
+$: << "#{File.dirname(__FILE__)}/../lib/"
+
+APP_DIR=File.dirname(__FILE__)
+require "marley"
+require "client/jamaica"
+#need to automate the following somehow but can't think of anything that isn't ugly ATM
+DB=Sequel.sqlite("#{APP_DIR}/forum#{ENV["MARLEY_TESTING"] ? '_test' : ''}.sqlite3")#,:loggers => [Logger.new($stdout)])
+
+RESERVED_PM_TAGS=['inbox','sent']
+RESERVED_POST_TAGS=['announcement']
+
+Marley.config({:app_name => 'The Forum',:client => Marley::Client.new({:app_name => 'The Forum'})})
+
+
+Marley.joint 'tagged_messaging'
+Marley.joint 'basic_menu_system'

data/examples/forum.sql

@@ -0,0 +1,42 @@
+CREATE TABLE tags (id integer PRIMARY KEY,user_id integer, tag text);
+CREATE INDEX tag_user_id on tags(user_id);
+CREATE INDEX tag_tag on tags(tag);
+CREATE UNIQUE INDEX tag_tag_user_id on tags(user_id,tag);
+
+CREATE TABLE messages_tags ( id integer PRIMARY KEY, message_id integer, tag_id integer);
+CREATE INDEX msg_tag_id on messages_tags(tag_id);
+CREATE INDEX tag_msg_id on messages_tags(message_id);
+
+CREATE TABLE messages (
+    id integer PRIMARY KEY,
+    message_type text,
+    author_id integer,
+    recipients text, 
+    thread_id integer,
+    parent_id integer,
+    date_created datetime,
+    date_updated datetime,
+    title text,
+    message clob
+);
+CREATE INDEX message on messages(message);
+CREATE INDEX message_author on messages(author_id);
+CREATE INDEX message_parent on messages(parent_id);
+CREATE INDEX message_thread on messages(thread_id);
+CREATE INDEX message_title on messages(title);
+CREATE INDEX message_type on messages(message_type);
+CREATE INDEX thread on messages(thread_id);
+
+CREATE TABLE users (
+  id INTEGER PRIMARY KEY,
+  user_type TEXT,
+  date_created datetime,
+  name TEXT,
+  email TEXT,
+  pw_hash TEXT,
+  active boolean default true,
+  description clob);
+CREATE INDEX users_active on users(active);
+CREATE UNIQUE INDEX users_email on users(email);
+CREATE UNIQUE INDEX users_name on users(name);
+CREATE INDEX users_user_type on users(user_type);

data/examples/run.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# directory of the marley base directory
+MARLEY_DIR=..
+
+# directory of the marley libs
+MARLEY_LIB=$MARLEY_DIR/lib
+
+# ruby interpreter to use (1.8, 1.9)
+RUBY=ruby
+#RUBY=/opt/local/bin/ruby1.9
+
+RUBYLIB=$MARLEY_LIB $RUBY ./simple_forum.rb run
+

data/lib/client/jamaica.css

@@ -0,0 +1,270 @@
+html, body, div, span, h1, p, strong, ul, li, form, label {margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent;}
+input {vertical-align:middle;}
+h1 {font-weight: bold;}
+body {background: #C9DE96; color: #000; font:13px/1.231 sans-serif; *font-size:small;}
+input, textarea {font:sans-serif;}
+textarea {overflow: auto;}
+input[type=submit] {cursor: pointer;}
+input, textarea {margin: 0;}
+body {height: 100%; min-height: 100%;}
+.hidden {display: none;}
+.editable {
+	border: 1px dotted #398235;
+	cursor: pointer;
+	padding: 2px 5px;
+}
+.editable:after {
+	content: "\270E";
+	font-size: 125%;
+	padding: 0 0 0 3px;
+}
+#signup__section,
+#main__section {
+	background: #fff;
+	border: 1px solid #398235;
+	-moz-border-radius: 8px;
+	border-radius: 8px;
+	-moz-box-shadow: 0 0 10px rgba(51,51,51,0.5);
+	box-shadow: 0 0 10px rgba(51,51,51,0.5);
+	margin: 20px auto;
+	width: 960px;
+}
+#signup__section {
+	height: 350px;	
+	left: 50%;
+	margin: -175px 0 0 -480px;
+	position: absolute;
+	top: 50%;
+}
+	#signup__section h1,
+	#main__section > h1 {
+		background: #398235;
+		border-bottom: 1px solid #398235;
+		-moz-border-radius-topright: 8px;
+		-moz-border-radius-topleft: 8px;
+		border-top-right-radius: 8px;
+		border-top-left-radius: 8px;
+		color: #fff;
+		font: bold 167%/150% "Rockwell STD", Rockwell, serif;
+		margin: 0 0 1em;
+		text-align: center;
+		text-transform: capitalize;
+	}
+	#signup__section .sectionDescription {font-weight: bold;}
+	#signup__section .sectionDescription,
+	#main__section > .sectionDescription,
+	#signup_section {margin: 0 20px 20px;}
+		#signup_section li {
+			display: inline-block;
+			vertical-align: top;
+			width: 440px;
+		}
+		#signup_section li:first-child {margin: 0 40px 0 0;}
+			#signup_navigation li > div {
+				border: 1px solid #398235;
+				-moz-border-radius: 8px;
+				border-radius: 8px;
+				overflow: hidden;
+			}
+			#signup_navigation li .form_description {
+				background: #398235;
+				border-bottom: 1px solid #398235;
+				-moz-border-radius-topright: 8px;
+				-moz-border-radius-topleft: 8px;
+				border-top-right-radius: 8px;
+				border-top-left-radius: 8px;
+				color: #fff;
+				font-size: 85%;
+				font-weight: bold;
+				line-height: 200%;
+				margin: 0 0 1.5em;
+				text-align: center;
+			}
+			#signup_section .colContainer {margin: 0 20px 1em;}
+			#signup_section input {width: 240px;}
+			#signup_section input[type=submit] {
+				margin: 0 20px 20px 0;
+				width: auto;
+			}
+		#signup_section label {width: 150px;}
+label {
+	color: #398235;
+	display: inline-block;
+	font: bold 85%/1.5em sans-serif;
+	width: 150px;
+}
+input,
+textarea {
+	border: 1px solid #398235;
+	line-height: 1.5em;
+}
+textarea {
+	height: 150px;
+	line-height: 1.25em;
+	margin: 0 0 1em;
+	width: 100%;
+}
+input[type=submit],
+#main__section .navigation li a,
+.instanceActions a {
+	background: -moz-linear-gradient(top, #c9de96 0%, #398235 100%);
+	background: linear-gradient(top, #c9de96 0%,#398235 100%);
+	border: 1px solid #398235;
+	-moz-border-radius: 8px;
+	border-radius: 8px;
+	color: #fff;
+	font: bold 93% sans-serif;
+	margin: 0 0 0 150px;
+	padding: 5px 10px;
+	text-decoration: none;
+	text-transform: uppercase;
+	width: auto;
+}
+input[type=submit]:hover,
+#main__section .navigation li a:hover,
+.instanceActions a:hover {
+	background: -moz-linear-gradient(top, #398235 0%, #c9de96 100%);
+	background: linear-gradient(top, #398235 0%,#c9de96 100%);
+	color: #fff;
+	cursor: pointer;
+	font-weight: bold;
+}
+#main__section #main_navigation {
+	border-bottom: 1px solid #398235;
+	margin: 0 20px 20px;
+	padding: 0 0 20px;
+	text-align: center;
+}
+#main__section #main_navigation li {
+	display: inline-block;
+	margin: 0 10px;
+}
+	#main__section > #main_navigation li a,
+	#main__section > .content > .section > .navigation li a {margin: 0;}
+#main__section > .content {margin: 20px;}
+	#main__section > .content > .section {
+		overflow: hidden;
+		padding: 0 0 0 225px;
+	}
+		#main__section > .content h1,
+		#main__section > .content .sectionDescription,
+		#main__section > .content .navigation {
+			clear: left;
+			float: left;
+			margin: 0 0 0 -225px;
+			width: 200px;
+		}
+		#main__section > .content h1 {
+			color: #398235;
+			font: bold 167%/150% "Rockwell STD", Rockwell, serif;
+			text-transform: capitalize;
+		}
+		#main__section .navigation li {
+			display: block;
+			margin: 0 0 0.25em;
+		}
+		#main__section .content .navigation li a {
+			display: block;
+			font-size: 77%;
+			text-transform: none;
+		}
+		#main__section > .content > .section > .content {
+			float: left;
+			width: 695px;
+		}
+		#main__section > .content > .section > .content > .instanceContainer {
+			border: 1px solid #398235;
+			-moz-border-radius: 8px;
+			border-radius: 8px;
+			margin: 0 0 2em;
+		}
+		#main__section > .content > .section > .content .instanceContainer .instanceContainer {
+			border: 1px solid #398235;
+			border-width: 1px 0 0 1px;
+			margin: 0 0 0 5em;
+		}
+		#main__section > .content > .section > .content .instance {
+			overflow: hidden;
+			padding: 42px 10px 10px 145px;
+			position: relative;
+		}
+		#main__section > .content > .section > .content .private_messageInstance {padding: 10px;}
+		.post__titleColContainer {
+			background: #398235;
+			border-bottom: 1px solid #398235;
+			color: #fff;
+			height: 32px;
+			left: 0;
+			line-height: 32px;
+			margin: 0;
+			overflow: hidden;
+			position: absolute;
+			top: 0;
+			width: 100%;
+		}
+		.colContainer label {
+			font-size: 75%;
+			padding: 0 5px 0 0;
+			width: auto;
+		}
+		.colContainer div {
+			display: inline-block;
+			font-size: 75%;
+		}
+		#main__section .content > .instanceContainer > .instance > .post__titleColContainer {
+			-moz-border-radius-topright: 8px;
+			-moz-border-radius-topleft: 8px;
+			border-top-right-radius: 8px;
+			border-top-left-radius: 8px;
+		}
+			.instance .post__titleColContainer label {
+				color: #fff;
+				font: bold 85%/32px sans-serif;
+				padding: 0 10px;
+			}
+			.instance .post__titleColContainer div {font-size: 93%;}
+		.post__idColContainer,
+		.post__author_idColContainer,
+		.post__thread_idColContainer,
+		.post__date_createdColContainer,
+		.post__date_updatedColContainer {
+			clear: left;
+			float: left;
+			margin: 0 0 0.25em -135px;
+			width: 125px;
+		}
+		.post__messageColContainer {font-size: 125%;}
+			.post__messageColContainer label {display: none;}
+			.post__messageColContainer p {margin: 0 0 1.5em;}
+		.post__tagsColContainer {margin: 0 0 0.75em;}
+			.post__tagsColContainer .col {
+				overflow: hidden;
+				vertical-align: middle;
+			}
+			.post__tagsColContainer input[type=text] {width: 120px;}
+			.post__tagsColContainer input[type=submit] {
+				float: right;
+				margin: 0 0 0 10px;
+				padding: 0 5px;
+			}
+		.instanceActions {overflow: hidden;}
+			.instanceActions a,
+			.instance input[type=submit] {
+				float: right;
+				margin: 0;
+				width: auto;
+			}
+			.editing input[type=text] {
+					background: #DCFCBD;
+					padding: 1px 5px;
+				}
+			.editing input[type=submit] {
+				float: none;
+				margin: 0 0 0 5px;
+			}
+		#main__section > .content > .section > .content .private_messageInstance label {width: 100px;}
+.errorCol {background: #febebe;}
+.errorMsg {
+	color: #EA8989;
+	font: bold italic 77% sans-serif;
+}