Introduction to Jifty and Building QublogMini App

Introduction to Jifty
Sterling Hanenkamp, PPW 2008

I Work for a Living

• Contract work / Billable Hours: How do I track them?

I Work for a Living


• Weekly Status Reports: What did I do?

I Work for a Living



• Reliable Memory: Did I do that? How? When? Why?

I Work for a Living



• Reliable Memory: Did I do that? How? When? Why?

• Task Lists: What should I do next?

Existing Solutions

Time Sheet

Existing Solutions

Planner

Existing Solutions

Scratch Paper

Existing Solutions

Things
Sunbird
Day Planner

Hiveminder
Entourage

Stikkit
iCal/Apple Mail
Lightning
OmniFocus

Qublog

• I don’t want to store this information in four places

Qublog


• I have a habit of writing down what I’m doing to focus

Qublog



• I needed something else to do with my lack of spare time

Qublog




• I built Qublog (originally MyToDo and Kiln for a short while)

Qublog





• It’s written using Jifty

Qublog





• It’s written using Jifty

• We’re going to look at how I did it to explain Jifty

Qublog

• Provides a Journal for keeping thoughts

Qublog


• Provides a To Do List for organizing tasks

Qublog



• Journal Comments are grouped into Timers that keep track of time spent

Qublog




• Timers are grouped into Entries to sum up work for reporting

Qublog




• Timers are grouped into Entries to sum up work for reporting

• Comments also connect with Tasks to keep track of what’s next

This is a talk about Jifty

• Not Qublog

• Okay, so let’s see if we can build QublogMini in the time remaining...

Install Jifty

As with “that-other-framework,”
the worst part is over when you
ﬁnish the install.

Install Jifty

• Method 1: Shipwright

Install Jifty

svn co http://code.bestpractical.com/shipwright/jifty/ jifty-builder
cd jifty-builder
./bin/shipwright-builder # optionally --skip perl --skip-test
cp -rvp /tmp/jifty-$random/jifty /usr/local/jifty
ln -s /usr/local/jifty/bin/jifty /usr/local/bin/jifty

Install Jifty

cd jifty-builder

• Method 2: CPAN

Install Jifty

cd jifty-builder

• Method 2: CPAN
perl -MCPAN -eshell # or just cpan
cpan> notest install Jifty

Install Jifty

cd jifty-builder
“notest” saves ~60 minutes according to Audrey
• Method 2: CPAN

Install Jifty

cd jifty-builder
“notest” saves ~60 minutes according to Audrey
• Method 2: CPAN

“notest” will get you no support according to Jesse

Install Jifty

cd jifty-builder

• Method 2: CPAN

• ActiveState installation on Windows: http://jifty.org/view/DownloadJifty

Install Jifty

cd jifty-builder

• Method 2: CPAN

• ActiveState installation on Windows: http://jifty.org/view/DownloadJifty
• Jifty is in Debian unstable

% jifty app --name QublogMini
Creating new application QublogMini
Creating directory QublogMini/lib
Creating directory QublogMini/lib/QublogMini
Creating directory QublogMini/bin
Creating directory QublogMini/etc
Creating directory QublogMini/doc
Creating directory QublogMini/log
Creating directory QublogMini/var
Creating directory QublogMini/var/mason
Creating directory QublogMini/share
Creating directory QublogMini/share/po
Creating directory QublogMini/share/web
Creating directory QublogMini/share/web/templates
Creating directory QublogMini/share/web/static
Creating directory QublogMini/lib/QublogMini/Model
Creating directory QublogMini/lib/QublogMini/Action
Creating directory QublogMini/t
Creating configuration file QublogMini/etc/config.yml

% cd QublogMini
% find . -type f

% cd QublogMini
% find . -type f
./bin/jifty
./etc/config.yml
./Makefile.PL

% ./bin/jifty server
WARN - Application schema has no version in the database.
WARN - Automatically creating your database.
INFO - Generating SQL for application QublogMini...
INFO - Using Jifty::Model::Session, as it appears to be new.
INFO - Using Jifty::Model::Metadata, as it appears to be new.
INFO - Set up version v0.0.1, jifty version 0.804080
INFO - You can connect to your server at http://localhost:8888/

Not a very interesting journaling app... let’s ﬁx it.

% ./bin/jifty model --name Comment

Writing file t/00-model-Comment.t
Writing file lib/QublogMini/Model/Comment.pm

Writing file t/00-model-Comment.t
Writing file lib/QublogMini/Model/Comment.pm

% vim lib/QublogMini/Model/Comment.pm

package QublogMini::Model::Comment;
use Jifty::DBI::Schema;

use QublogMini::Record schema {

};


column commented_on =>
type is 'datetime',
label is 'Commented on',
filters are qw(
Jifty::DBI::Filter::DateTime
);

column name =>
type is 'text',
label is 'Name',
render as 'textarea';
};

% bin/jifty server
WARN - Application schema has no version in the database.
WARN - Automatically creating your database.
INFO - Generating SQL for application QublogMini...
INFO - Using QublogMini::Model::Comment, as it appears to be
new.
INFO - Using Jifty::Model::Session, as it appears to be new.
INFO - Using Jifty::Model::Metadata, as it appears to be new.
INFO - Set up version v0.0.1, jifty version 0.804080
INFO - You can connect to your server at http://localhost:
8888/

% bin/jifty model --name Timer

Writing file lib/QublogMini/Model/Timer.pm
Writing file t/00-model-Timer.t

Writing file lib/QublogMini/Model/Timer.pm
Writing file t/00-model-Timer.t

% vim lib/QublogMini/Model/Timer.pm

package QublogMini::Model::Timer;


};


column started_on =>
label is 'Started on',
filters are qw( Jifty::DBI::Filter::DateTime );

column stopped_on =>
label is 'Stopped on',
filters are qw( Jifty::DBI::Filter::DateTime );

column comments =>
references QublogMini::Model::CommentCollection
by 'timer';

};

sub since { '0.0.2' }


type is 'datetime',
filters are qw( Jifty::DBI::Filter::DateTime ),
;

column name =>
type is 'text',
label is 'Name',
render as 'textarea',
;

};


type is 'datetime',
filters are qw( Jifty::DBI::Filter::DateTime ),
;

column name =>
type is 'text',
label is 'Name',
render as 'textarea',
;

column timer =>
label is 'Timer',
since '0.0.2',
references QublogMini::Model::Timer;
};

% bin/jifty server
WARN - Application schema version in database (v0.0.1) doesn't match
application schema version (0.0.2)
WARN - Automatically upgrading your database to match the current
application schema.
Jifty version 0.809130 up to date.
Jifty::Plugin::LetMe version v0.0.1 up to date.
Jifty::Plugin::SkeletonApp version v0.0.1 up to date.
Jifty::Plugin::REST version v0.0.1 up to date.
Jifty::Plugin::Halo version v0.0.1 up to date.
Jifty::Plugin::ErrorTemplates version v0.0.1 up to date.
Jifty::Plugin::OnlineDocs version v0.0.1 up to date.
Jifty::Plugin::CompressedCSSandJS version v0.0.1 up to date.
Jifty::Plugin::AdminUI version v0.0.1 up to date.
INFO - Generating SQL to upgrade QublogMini v0.0.1 database to v0.0.2
INFO - Upgrading through 0.0.2
INFO - Running upgrade script
INFO - Upgraded to version v0.0.2


# ...

sub name {
my $self = shift;
$self->started_on . ' to ' . $self->stopped_on
}

% bin/jifty model --name Entry

Writing file t/00-model-Entry.t
Writing file lib/QublogMini/Model/Entry.pm

Writing file t/00-model-Entry.t
Writing file lib/QublogMini/Model/Entry.pm

% vim lib/QublogMini/Model/Entry.pm

package QublogMini::Model::Entry;


};


column name =>
type is 'text',
label is 'Name',
is mandatory;

column url =>
type is 'text',
label is 'Name';

column timers =>
references QublogMini::Model::TimerCollection
by 'entry';
};

sub since { '0.0.3' }


# ...

column entry =>
label is 'Entry',
since '0.0.3',
references QublogMini::Model::Entry;

# ...
};

sub name {
my $self = shift;
my $name = '';
$name .= $self->entry->name . ': ' if $self->entry->id;
$name .= $self->started_on . ' to ' . $self->stopped_on
return $name;
}

---
framework:
AdminMode: 1
ApplicationClass: QublogMini
ApplicationName: QublogMini
ApplicationUUID: 1198420A-95A9-11DD-8ED4-3E4643B9151E
ConfigFileVersion: 4
Database:
AutoUpgrade: 1
CheckSchema: 1
Database: qublogmini
Driver: SQLite
Host: localhost
Password: ''
RecordBaseClass: Jifty::DBI::Record::Cachable
User: ''
Version: 0.0.2

---
framework:
AdminMode: 1
ApplicationClass: QublogMini
ApplicationName: QublogMini
ApplicationUUID: 1198420A-95A9-11DD-8ED4-3E4643B9151E
ConfigFileVersion: 4
Database:
AutoUpgrade: 1
CheckSchema: 1
Database: qublogmini
Driver: SQLite
Host: localhost
Password: ''
RecordBaseClass: Jifty::DBI::Record::Cachable
User: ''
Version: 0.0.3

% bin/jifty server
WARN - Application schema version in database (v0.0.2) doesn't match
application schema version (0.0.3)
WARN - Automatically upgrading your database to match the current
application schema.
Jifty version 0.809130 up to date.
Jifty::Plugin::LetMe version v0.0.1 up to date.
Jifty::Plugin::SkeletonApp version v0.0.1 up to date.
Jifty::Plugin::REST version v0.0.1 up to date.
Jifty::Plugin::Halo version v0.0.1 up to date.
Jifty::Plugin::ErrorTemplates version v0.0.1 up to date.
Jifty::Plugin::OnlineDocs version v0.0.1 up to date.
Jifty::Plugin::CompressedCSSandJS version v0.0.1 up to date.
Jifty::Plugin::AdminUI version v0.0.1 up to date.
INFO - Generating SQL to upgrade QublogMini v0.0.2 database to v0.0.3
INFO - Upgrading through 0.0.3
INFO - Running upgrade script
INFO - Upgraded to version v0.0.3

Ponies are But where’s the UI?
great!

# Dispatcher maps URLs to Views
% vim lib/QublogMini/Dispatcher.pm

package QublogMini::Dispatcher;
use Jifty::Dispatcher -base;


on '/' => dispatch '/today';


on '/' => dispatch '/today';
on '/today' => run {
my $entries = QublogMini::Model::EntryCollection->new;
my $timer_alias = $entries->join(
column1 => 'id',
table2 => QublogMini::Model::Timer->table,
column2 => 'entry',
);
$entries->limit(
alias => $timer_alias,
column => 'started_on',
operator => '>=',
value => DateTime->today,
entry_aggregator => 'AND',
);
$entries->limit(
operator => '<',
value => DateTime->today->add( days => 1 ),
);
set entries => $entries;
show '/today';
};

package QublogMini::View;
use Jifty::View::Declare -base;

template '/today' => page {
{ title is quot;Today's Journalquot; }

my $entries = get 'entries';
while (my $entry = $entries->next) {
h2 { $entry->name };

p {
hyperlink
label => $entry->url,
url => $entry->url
};
}
};



p {
hyperlink
url => $entry->url
};

show '/timers', $entry;
}
};

private template '/timers' => sub {
my ($self, $entry) = @_;

my $timers = $entry->timers;

while (my $timer = $timers->next) {
show '/show_comment', $timer->stopped_on, _('Stopped timer.')
if $timer->stopped_on;
show '/comments', $timer;
show '/show_comment', $timer->started_on, _('Started timer.');
}
};

private template '/comments' => sub {
my ($self, $timer) = @_;

my $comments = $timer->comments;

while (my $comment = $comments->next) {
show '/show_comment', $comment->commented_on, $comment->name;
}
};

private template '/show_comment' => sub {
my ($self, $time, $message) = @_;
p { { class is 'time' } $time };
p { { class is 'comment' } $message };
};

Fine. We already
knew that. Where’s the
“interface”?


form {
render_region
name => 'add_entry',
path => '/add_entry_button',
;
};


p {
hyperlink
url => $entry->url;
};

}
};

template '/add_entry_button' => sub {
form_submit
label => _('Add Entry'),
onclick => {
region => Jifty->web->current_region,
replace_with => '/add_entry_form',
},
;
};

template '/add_entry_form' => sub {
my $entry_action = new_action class => 'CreateEntry';
render_action $entry_action, [ qw( name url ) ];
form_submit
onclick => {
submit => $entry_action,
replace_with => '/add_entry_button',
},
;
};

Where’d it go?

2 Problems
We need a timer
too.

Where’d it go?

2 Problems
We need a timer
too.
We need to
redraw the journal.


use DateTime;

# ...

# Add a timer when we add an entry
sub after_create {
my ($self, $id) = @_;
return unless $$id;

my $timer = QublogMini::Model::Timer->new;
$timer->create(
entry => $$id,
started_on => DateTime->now,
);

return 1;
}

# Replace /today with a region

render_region
name => 'entries',
path => '/entries',
;
};

# Add a new entries fragment
template '/entries' => sub {
form {
render_region
name => 'add_entry',
path => '/add_entry_button',
;
};


p {
hyperlink
url => $entry->url;
};

}
};

on '/today' => run {
column1 => 'id',
column2 => 'entry',
);
$entries->limit(
operator => '>=',
);
$entries->limit(
operator => '<',
);
};

on '/entries' => run {
column1 => 'id',
column2 => 'entry',
);
$entries->limit(
operator => '>=',
);
$entries->limit(
operator => '<',
);
};

# Make our entry form update everything properly
template '/add_entry_form' => sub {
my $entry_action = new_action class => 'CreateEntry';
render_action $entry_action, [ qw( name url ) ];
form_submit
onclick => [
{
submit => $entry_action,
},
{
},
{
refresh => Jifty->web->current_region->parent,
},
],
;
};

on '/entries' => run {
column1 => 'id',
column2 => 'entry',
);

# ...

$entries->order_by({
order => 'DES',
});
};

We have entries
and timers, but what
about comments?


use DateTime;

# ...

sub before_create {
my ($self, $args) = @_;

$args->{commented_on} = DateTime->now;

return 1;
}

template '/add_entry_button' => sub {
form_submit
onclick => {
replace_with => '/add_entry_form',
},
;
form_submit
label => _('Add Comment'),
onclick => {
replace_with => '/add_comment_form',
},
;
};

template '/add_comment_form' => sub {
my $timer = QublogMini::Model::Timer->new;
$timer->load_current; # loads the latest running timer
my $comment_action = new_action class => 'CreateComment';
render_action $comment_action, [ qw( name ) ];
form_submit
label => _('Add Comment'),
onclick => [
{
submit => {
action => $comment_action,
arguments => {
timer => $timer->id,
},
},
},
{
},
{
refresh => Jifty->web->current_region->parent,
},
],
;
# ...

# ...

form_submit
label => _('Cancel'),
onclick => {
},
;
};

What about Validation

• Easy


• Easy

• Add a validate_XXX method to the model


• Easy

• Add a validate_XXX method to the model

• Let’s try it

sub validate_url {
my ($self, $url) = @_;

if ($url !~ m[^https?://]) {
return (0, 'That does not look like a URL.');
}

return 1;
}

Canonicalization

• You can also canonicalize something

Canonicalization


• What the heck is that?

Canonicalization



• Rather than slap their hand, ﬁx it for them

Canonicalization



• Rather than slap their hand, ﬁx it for them

• For example, we could... (but won’t)...

sub canonicalize_url {

if ($url !~ m[^https?://]) {
return 'http://'.$url;
}

return $url;
}

sub canonicalize_url {

if ($url !~ m[^https?://]) {
}

return $url; Too naïve, I refuse to
}
implement it!

But it was the best I
could come up with on
sub canonicalize_url { short notice.

if ($url !~ m[^https?://]) {
}

return $url; Too naïve, I refuse to
}
implement it!

Halos

I’m the view code
for this “frame” in the
page!

Halos

View the HTML
source, Luke.

Page Info

• Click on things to view info

Page Info


• SQL Logging

Page Info


• SQL Logging

• SQL Proﬁling

Page Info


• SQL Logging

• SQL Proﬁling

• Template Proﬁling

Developer Mode

• Module::Refresh

Developer Mode

• Module::Refresh

• Tracing with Log4Perl

Developer Mode

• Module::Refresh


• Administration Console

Developer Mode

• Module::Refresh


• Administration Console

• (actually, that’s Administrator Mode)

Deployment

• Choice of web servers: FastCGI on Apache / Lighttpd, HTTP::Server::Simple,
mod_perl support (a little weak at the moment)

Deployment


• Choice of DB servers: SQLite (great for getting started/testing, but production
is possible), PostgreSQL, MySQL, and other servers supported

Deployment



• Use a fast static server to server CSS, JS, images, etc.

Deployment



• Use a fast static server to server CSS, JS, images, etc.

• Use CSS::Squish and JS::Squish to help compress and cache things

Other Goodies

• Several authentication plugins: typical email sign-up login, OpenID,
Facebook, LDAP, CAS

• Additional CRUD view helpers I haven’t demonstrated

• Built-in REST interface

• Full I18N support built-in

• Several Plugins for lots of things: Comments, Single Page Apps, Client-Side
Templating, Charting, Tab helpers

• Built-in support for Comet (server push) in addition to Ajax

Applications

• Hiveminder (http://hiveminder.com)

Applications


• Wifty (http://jifty.org)

Applications



• Qublog (http://qublog.net)

Applications




• Doxory (http://doxory.com)

Applications





• CommitBit (http://code.bestpractical.com/)

Applications





• CommitBit (http://code.bestpractical.com/)

• Ping / Chat / Clock (examples available with Jifty)

Jifty Resources

• CPAN (http://search.cpan.org/dist/Jifty/)

Jifty Resources


• Jifty Wiki (http://jifty.org)

Jifty Resources



• Jifty SVN (http://svn.jifty.org/svn/jifty.org)

Jifty Resources




• Tutorial (http://search.cpan.org/dist/Jifty/lib/Jifty/Manual/Tutorial.pod)

Jifty Resources





• Manual (http://search.cpan.org/dist/Jifty/lib/Jifty/Manual.pod)

Jifty Resources






• Mailing List: jifty‐devel@lists.jifty.org

Jifty Resources






• Mailing List: jifty‐devel@lists.jifty.org

• IRC Channel: #jifty on irc.freenode.org

Qublog

• See http://qublog.net

• Sample code for QublogMini in SVN: http://qublog.net/svn/QublogMini

Introduction to Jifty and Building QublogMini App

Recommended

Recommended

More Related Content

Similar to Introduction to Jifty and Building QublogMini App

Similar to Introduction to Jifty and Building QublogMini App (20)

Recently uploaded

Recently uploaded (20)

Introduction to Jifty and Building QublogMini App