Operate with DOM elements like they're ActiveRecord models.
Pull request Compare This branch is 12 commits ahead of gijs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
lib
test
Readme.md
grunt.js

Readme.md

Jewel

Operate with DOM elements like they're ActiveRecord models.

Features

  • DOM elements as models
  • CRUD methods you are already used to
  • Validation (built-in rules + ability to set custom ones)
  • No additional dependencies (except of jQuery, which, I guess you already have)

Getting Started

Dependencies

  • jQuery

Compatability

  • Safari
  • Google Chrome
  • Firefox
  • Opera
  • IE - not tested

Include Jewel (2.3kb minified and gzipped):

<!-- jQuery must be included before that -->
<script src="jewel.min.js"></script>

Usage

Let's say we have such HTML:

<div id="posts">
	<div class="post">
		<h1>First title</h1>
		<p>First body</p>
	</div>
	<div class="post">
		<h1>Second title</h1>
		<p>Second body</p>
	</div>
	<p class="not-found">
		No posts here, sorry.
	</p>
</div>

Now, we need to define Post model:

var Post = Jewel.define('#posts', { // selector for a wrapper element
	keys: {
		title: 'h1', // selector for title, h1 in our case. Will be used as #posts .post h1
		body: 'p', // selector for body. Will be used as #posts .post p
	},
	validation: {
		title: ['required', 'min(10)'],
		body: ['required']
	},
	emptyView: 'p.not-found', // selector for view, that shows up only when there is no posts
	template: function(fields){ // function that returns HTML for new posts, you can use custom templating engine here.
		return "<div class=\"post\"><h1>" + fields.title + "</h1><p>" + fields.body + "</p></div>"
	}
});

That's it! We can start doing cool stuff:

// Finding all posts
var posts = Post.all;

// Finding first post
var post = Post.find({ limit: 1 })[0];

// Finding second post

post = Post.find({ skip: 1 })[0];
post.title; // "Second title"

// Updating post

post.title = 'Last post';
post.save();

// Removing post

post.remove();

// Removing all posts

Post.remove();

// Creating new one

post = new Post;
post.title = 'Latest post';
post.body = 'Latest content';
post.save(); // will be prepended to #posts

Validation

You don't need to call any additional methods to validate your data, Jewel will do it for you:

var post = new Post;
post.save(); // return false, because title and body fields are required

You can also define your own validation rules. Let's make one, which ensures that title starts with an uppercase or downcase letter:

// Before declaring model

Jewel.Validation.define({
	rule: 'startsWith', // name of your rule
	message: ':name should start with :param', // error message, :name is the name of the field, :param is the value of param(uppercase or downcase)
	validator: function(value, param) { // validator itself
		if (param === 'uppercase') {
	    	return String.fromCharCode(value.charCodeAt(0) + 32) === value[0].toLowerCase();
	    }
		
	    if (param === 'downcase') {
	    	return String.fromCharCode(value.charCodeAt(0) - 32) === value[0].toUpperCase();
	    }
		
	    return false;
	}
});

// Now, let's apply this rule to some model

var Post = Jewel.define('div.posts', {
	keys: {
		title: 'h1',
		body: 'p'
	},
	validation: {
		title: ['required', 'startsWith(uppercase)'] // uppercase is a param
	},
	template: function(fields){ // function that returns HTML for new posts, you can use custom templating engine here.
		return "<div class=\"post\"><h1>" + fields.title + "</h1><p>" + fields.body + "</p></div>"
	}
});

post = new Post;
post.title = 'post title';
post.save(); // false, because p is not a capital letter
post.errorMessages[0]; // "Title should start with uppercase"
post.errors[0]; // "title"

post = new Post;
post.title = 'Post title';
post.save(); // true, DOM node inserted, all validations passed

Events

You can listen to events which are emitted by all instances of the model:

Post.on('create', function(post){
	post.title == 'Post title'; // true
});

var post = new Post;
post.title = 'Post title';
post.body = 'Post body';
post.save();

Available events: create, update, remove and save (fires on create and update events too).

Hooks

Jewel offers ability to define hooks to listen to events on per-model basis:

var Post = Jewel.Model.define('div.posts', {
	keys: {
		title: 'h1',
		body: 'p'
	},
	template: function(fields){
		"<div class=\"post\"><h1>" + fields.title + "</h1><p>" + fields.body + "</p></div>"
	},
	hooks: {
		beforeSave: function(){
			this.title; // Value of model's "title" field
		}
	}
});

Available hooks (for save, create, update and remove): before, around, after. For example, beforeSave, aroundRemove or afterUpdate.

CoffeeScript

If you are fan of CoffeeScript, you will like the ability to define Jewel models just like you expect, using native CoffeeScript methods:

class Post extends Jewel.Model
	selector: 'div.posts'
	keys:
		title: 'h1'
		body: 'p'
	validation:
		title: ['required', 'min(5)']
		body: 'required'
	emptyView: 'p.not-found'
	template: (fields) ->
		"<div class=\"post\"><h1>#{ fields.title }</h1><p>#{ fields.body }</p></div>"
	
	beforeSave: -> # notice, that you specify hooks like class methods, not in hooks object
		@title

Post = Jewel.Model.setup Post # you should let Jewel prepare the model for its correct functioning

After this, you can use all functionality you've seen before.

Tests

Run tests by opening test/test.html in browser.

Contributing

  • Fork
  • Write code, build using grunt
  • Write tests for the code
  • Commit & push
  • Send pull request

Roadmap

  • Sync with server

License

(The MIT License)

Copyright (c) 2011 Vadim Demedes sbioko@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.