2 |
|
|
3 |
This page describes how to use and develop with L<Frey> |
This page describes how to use and develop with L<Frey> |
4 |
|
|
5 |
|
=head1 Developer parts |
6 |
|
|
7 |
|
=head2 Moose classes |
8 |
|
|
9 |
|
All Moose classes have simple introspection API which use |
10 |
|
L<Frey::Introspect> to show class and it's pod (using L<Frey::Pod>). |
11 |
|
|
12 |
|
Example of valid REST URL is |
13 |
|
|
14 |
|
http://localhost:16001/Frey |
15 |
|
|
16 |
|
which will show L<Frey> class introspection. |
17 |
|
|
18 |
|
You can also add method invocation and optional parameters to C<new> |
19 |
|
constructor like this: |
20 |
|
|
21 |
|
http://localhost:16001/Frey::Pod/as_markup?class=Frey |
22 |
|
|
23 |
|
this is same using L<Frey::Pod> from perl as |
24 |
|
|
25 |
|
Frey::Pod->new( class => 'Frey' )->as_markup; |
26 |
|
|
27 |
|
Forms to enter required parameters will be generated automatically, |
28 |
|
allowing you to explore your data while you are making interface for it. |
29 |
|
|
30 |
|
=head2 Database |
31 |
|
|
32 |
|
FIXME broken if not noted in C<TODO> |
33 |
|
|
34 |
|
For database objects we support L<Fey> and when your objects are created |
35 |
|
C<< with 'Frey::Collection' >> they will have basic CRUD functionality |
36 |
|
implemented by L<Frey::ObjectBrowser>. |
37 |
|
|
38 |
|
=head1 User parts |
39 |
|
|
40 |
|
=head2 Pipes |
41 |
|
|
42 |
|
See L<Frey::Pipe> for now. |
43 |
|
|
44 |
=head1 Designing user interaction flows |
=head1 Designing user interaction flows |
45 |
|
|
46 |
Frey is all about creating Moose classes as your interaction with pages. |
Frey is all about creating Moose classes as your interaction with pages. |
47 |
Each page is instance of class with some parametars received with post or |
Each page is instance of class with some parameters received with post or |
48 |
get request. |
get request. |
49 |
|
|
50 |
If you want to access those parameters in your object, you have to define |
If you want to access those parameters in your object, you have to define |
52 |
|
|
53 |
You can also generate result in three different forms: |
You can also generate result in three different forms: |
54 |
|
|
55 |
|
|
56 |
=over 20 |
=over 20 |
57 |
|
|
58 |
=item as_markup |
=item as_markup |
71 |
|
|
72 |
=back |
=back |
73 |
|
|
74 |
|
|
75 |
|
=head2 No html templates |
76 |
|
|
77 |
Frey doesn't have html templates. Since your methods are part of REST URIs, |
Frey doesn't have html templates. Since your methods are part of REST URIs, |
78 |
it doesn't make sense to separate html from object itself, which represent |
it doesn't make sense to separate html from object itself, which represent |
79 |
web page. L<Frey::Web> provides role which has a bunch of helpful things |
web page. L<Frey::Web> provides role which has a bunch of helpful things |
86 |
which will start your L<Moose> classes, will call L<Frey::Action> |
which will start your L<Moose> classes, will call L<Frey::Action> |
87 |
for help and generate initial form for you. |
for help and generate initial form for you. |
88 |
|
|
89 |
Creating files is mess, so L<Frey::ClassCreator/create_class_source> will |
Creating files is mess, so L<Frey::Class::Create/create_class_source> will |
90 |
create class and test skeleton for you. |
create class and test skeleton for you. |
91 |
|
|
92 |
If I did it right, it should read similar to human language, like SmallTalk. |
If I did it right, it should read similar to human language, like Smalltalk. |
93 |
|
|
94 |
To make things simple, there are few convertions (with nod to Ruby on Rails) |
To make things simple, there are few conventions (with nod to Ruby on Rails) |
95 |
which will help you get started: |
which will help you get started: |
96 |
|
|
|
=head2 default parametars |
|
97 |
|
|
98 |
=head2 html markup |
=head2 html markup |
99 |
|
|
100 |
HTML markup should be enclosed in C< qq| > and C< | > quotes. There is also |
HTML markup should be enclosed in C< qq| > and C< | > quotes. There is also |
101 |
funny but very readable convention of multi line html when you have to |
funny but very readable convention of multi line html when you have to |
102 |
intermix confitions: |
intermix conditions: |
103 |
|
|
104 |
my $html |
my $html |
105 |
= qq|<h1>First</h1>| |
= qq|<h1>First</h1>| |
118 |
|
|
119 |
which is valid perl syntax but doesn't work as expected. |
which is valid perl syntax but doesn't work as expected. |
120 |
|
|
121 |
|
|
122 |
|
=head2 Smalltalk like refactoring |
123 |
|
|
124 |
|
Frey is heavily influenced by Smalltalk, up to the point of syntax. Coding |
125 |
|
Frey code should be like playing with L<Frey>. And you might end up with |
126 |
|
result which might surprise you. |
127 |
|
|
128 |
|
Refactoring tools are not new in perl. We have L<PPI>, L<App::Ack> and C<vim> |
129 |
|
so what more do we want? |
130 |
|
|
131 |
|
If you look closely into Smalltalk development work-flow, you really need |
132 |
|
ability to rename class or method without any additional effort. For that, |
133 |
|
we use L<Frey::Class::Refactor> which allows code modifications at source |
134 |
|
level with just few clicks. |
135 |
|
|
136 |
|
=head2 Default values |
137 |
|
|
138 |
|
When L<Frey::Run> tries to create instance of class (usually because of web |
139 |
|
request) it tried to read default values from C<yaml> files in C<etc/> and |
140 |
|
if it doesn't find all of required values it will invoke L<Frey::Action> to |
141 |
|
create end-user html form with missing fields. |
142 |
|
|
143 |
=head2 examples |
=head2 examples |
144 |
|
|
145 |
To help you get started, here are few implemented flows in Frey: |
To help you get started, here are few implemented flows in Frey: |
160 |
|
|
161 |
=back |
=back |
162 |
|
|
163 |
|
|
164 |
=head1 Command-line integration |
=head1 Command-line integration |
165 |
|
|
166 |
One of key points is that L<Frey> runs under your user. This means it has |
One of key points is that L<Frey> runs under your user. This means it has |
167 |
access to your termnial, and ssh keys, so beware! |
access to your terminal, and ssh keys, so beware! |
168 |
|
|
169 |
=head1 Install |
=head1 Install |
170 |
|
|
201 |
|
|
202 |
=head2 bin/dev.sh |
=head2 bin/dev.sh |
203 |
|
|
204 |
Recommeded way to start development L<Frey> server since it will restart it |
Recommended way to start development L<Frey> server since it will restart it |
205 |
automatically and kill running instance if existing. |
automatically and kill running instance if existing. |
206 |
|
|
207 |
=head2 bin/check-syntax.sh |
=head2 bin/check-syntax.sh |
210 |
|
|
211 |
=head2 bin/grep-iselect.sh |
=head2 bin/grep-iselect.sh |
212 |
|
|
213 |
Helper using C<iselect> to quickly grep, select result and jump to C<vim> |
Helper using C<iselect> to quickly grep, select result and jump to C<vim>. |
214 |
|
|
215 |
|
You can also pass grep params for context etc, like this: |
216 |
|
|
217 |
|
./bin/grep-iselect.sh something -C 3 |
218 |
|
./bin/grep-iselect.sh something -A 10 -B 3 |
219 |
|
|
220 |
=head2 bin/log.sh |
=head2 bin/log.sh |
221 |
|
|
229 |
=head2 bin/clean-var.sh |
=head2 bin/clean-var.sh |
230 |
|
|
231 |
Cleanup C<var/> directory which gets a lot of dumps. Most of useful data |
Cleanup C<var/> directory which gets a lot of dumps. Most of useful data |
232 |
is held forever because I belive that trends are most interesting way to |
is held forever because I believe that trends are most interesting way to |
233 |
look at data. |
look at data. |
234 |
|
|
235 |
=cut |
=cut |