lib/Frey/Action.pm

package Frey::Action;
use Moose;
extends 'Frey::PPI';
with 'Frey::Web';
with 'Frey::Config';

use Clone qw/clone/;
use Data::Dump qw/dump/;

=head1 DESCRIPTION

Invoke any L<Frey> object creating html for with various default parameters
if not supplied at invocation.

You can force rendering of fields if you define C<render_attribute> sub with
desired rendering as in:

  sub render_pipe { 'radio' }

=cut

has 'class' => (
        is => 'rw',
        isa => 'Str',
        required => 1,
);

has 'params' => (
        is => 'rw',
        isa => 'HashRef',
        default => sub { {} },
);

has 'input_step_size' => (
        documentation => 'Resize input fields by this step',
        is => 'rw',
        isa => 'Int',
#       required => 1,
        default => 20,
);

=head2 required

  my @required_attributes = $self->required;
  my $required_attributes = $self->required;
  my $required_hash       = $self->required('as_hash');

=cut

sub required {
        my ($self,$param) = @_;
        $self->load_class( $self->class );

        my @required = 
                grep {
                        defined $_ && $_->can('name') &&
                        ! defined( $self->params->{ $_->name } ) &&
                        ! $_->is_lazy
                }
                map {
                        my $attr = $self->class->meta->get_attribute($_);
                        blessed $attr && $attr->is_required && $attr;
                } $self->class->meta->get_attribute_list;

        @required = map { $_->name } @required;
        warn "## required = ",dump( @required ), " for ", $self->class if @required && $self->debug;

        if ( $param eq 'as_hash' ) {
                my $hash;
                map { $hash->{$_}++ } @required;
                return $hash;
        }
        return @required if wantarray;
        return \@required;
}

=head2 attributes

Generated from attributes specified in code (extracted using L<Frey::PPI>)
and required atributes

  my @class_attributes = $self->attributes;
  my @class_attributes = $self->attributes;

=cut

sub attributes {
        my ( $self ) = @_;
        my $a;
        my @attrs = @{ $self->attribute_order };
        @attrs = map {  $a->{$_}++; $_ } @attrs;
        push @attrs, $_ foreach grep { ! $a->{$_} } @{ $self->required };
        warn "# attributes = ",dump( @attrs ) if $self->debug;
        return @attrs if wantarray;
        return \@attrs;
}

=head2 params_form

  my  $html                  = $self->params_form;
  my ($html,$default_params) = $self->params_form;

=cut

sub params_form {
        my ( $self ) = @_;
        my $required = $self->required('as_hash');
        if ( $required ) {
                warn $self->class, " required params ", dump( keys %$required ) if $self->debug;
        } else {
                warn "all params available ", dump( $self->params ), " not creating form" if $self->debug;
                return (undef,$self->params) if wantarray;
                return;
        }

        my $class = $self->class;

        $self->load_class( $class );

        my $default = clone $self->params; # XXX we really don't want to modify params!

        my $params_config = {};
        $params_config = $self->config($class);
        warn "# $class config = ",dump( $params_config ) if $self->debug;

        my $form;
        my $form_id = $class;
        $form_id =~ s{\W+}{_}g;

        sub select_values {
                my ( $name, $attr_type, $values ) = @_;

                $attr_type ||= '?' and warn "$name doesn't have attr_type";

                my $max_value_len = 0;
                my @values;
                my $html = '';

                foreach ( @$values ) {
                        my $v = ref($_) eq 'HASH' ? $_->{$name} : $_;
                        warn "## value '$v'";
                        push @values, $v;
                        $max_value_len = length($v) if length($v) > $max_value_len;
                }

                warn "# max_value_len: $max_value_len";
                my $render = eval $class . '->render_' . $name;
                warn "## render $@";

                if ( $#values > 3 && $render !~ m{radio} ) {
                        my $options = join("\n",
                                map {
                                        qq|<option value="$_">$_</option>|;
                                } @values
                        );
                        # onchange="alert(this.options[this.selectedIndex].value);"
                        $html = qq|
                                <select title="$attr_type" name="$name">
                                $options
                                </select>
                        | if $options;
                } else {
                        my $delimiter = $max_value_len > $self->input_step_size ? qq|<br>| : '';
                        my $radio =
#                               $delimiter .
                                join("\n",
                                map { strip(qq|
                                                <span title="$attr_type">
                                                <input type="radio" name="$name" value="$_">
                                                $_
                                                </span>
                                                $delimiter
                                |) } @values
                        );
                        if ( $radio ) {
                                
                                my $size = int( $max_value_len / $self->input_step_size ) + 1;
                                $size = 5 if $size > 5;
                                $size *= $self->input_step_size;
                                $radio .= qq|
                                        <span>
                                        <input type="radio" name="$name" value=" " onclick="document.getElementById('new-$name').focus();" >
                                        <input type="text" name="new-$name" id="new-$name" onchange="clear_radio('$form_id','$name'); this.disable = false;" onblur="this.disable = true;" title="enter new value" size="$size">
                                        </span>
                                |;
                        }
                        $html = qq|<div style="display: block;">$radio</div>|;
                }

                return
#                       qq|<input type="text" name="$name">| .
                        $html
        }


        foreach my $checkbox ( split(/\s+/, $default->{'frey-checkboxes'} ) ) {
                next if defined $default->{ $checkbox };

                $default->{ $checkbox } = 0;
                $self->params->{ $checkbox } = 0;
                warn "# checkbox $checkbox not ticked";
        }

        my @checkboxes;

        my $label_width = 1; # minimum

        foreach my $name (
                grep {
                        die "$_ doesn't have meta" unless $class->can('meta');
                        ! $class->meta->get_attribute($_)->is_lazy
                        && ! defined $default->{$_}
                        && ! m{^_} # skip _private
                } $self->attributes
        ) {
                my $attr_type = '';
                my $type = $name =~ m/^pass/ ? 'password' : 'text';
                my $label = $name;
                my $label_title = '';
                my $value_html = '';

                my $attr = $class->meta->get_attribute( $name );
                $attr_type = $attr->type_constraint->name if $attr->has_type_constraint;

                my $value =
                        defined $default->{$name} ? $default->{$name}       :
                        $attr->has_default        ? $attr->default( $name ) :
                        '';

                if ( ref($params_config) eq 'HASH' && defined $params_config->{$name} ) {
                        $value = $params_config->{$name};
                } elsif ( ref($params_config) eq 'ARRAY' ) {
                        $value_html = select_values( $name, $attr_type, $params_config );
                        $default->{$name} = $params_config->[0]->{$name};
                } elsif ( $attr->has_type_constraint && $attr->type_constraint->can('values') ) {
                        $value_html = select_values( $name, $attr_type, $attr->type_constraint->values );
                } elsif ( $attr_type =~ m{^Bool} ) {
                        my $suffix = '';
                        $suffix = ' checked' if $value;
                        $value_html = qq|<input type="checkbox" name="$name" title="$attr_type" value="$value"$suffix>|;
                        push @checkboxes, $name;
                } elsif ( ! defined $value ) {
                        $value_html = qq|<tt id="$name">undef</tt><!-- $name = undef -->|; # FIXME if $self->debug
                } elsif ( $attr_type !~ m{^(Str|Int)$} || $value =~ $Frey::Web::re_html || $name =~ m{text} ) {
                        $value_html = qq|<textarea name="$name" title="$attr_type">$value</textarea>|;
                }

                $label_title = qq| title="| . $attr->documentation . qq|"| if $attr->has_documentation;

                $default->{$name} = $value unless defined $default->{$name};

                my $size = ( int( length($value) / $self->input_step_size ) + 1 ) * $self->input_step_size;
                $value_html = qq|<input type="$type" name="$name" title="$attr_type" value="$value" size="$size">| unless $value_html;

#               warn "# required $name ", $class->meta->get_attribute( $name )->dump( 2 );

                $label_title .= qq| class="required"| if $required->{$name};
                $label =~ s/_/ /g;

                $form .= qq|<label for="$name"$label_title>$label</label>$value_html<br>|;
                my $ll = length($label);
                $label_width = $ll if $ll > $label_width;
        }
        $form .= qq|<input type="hidden" name="frey-checkboxes" value="| . join(' ', @checkboxes) . qq|">| if @checkboxes;

        $label_width += 2; # XXX padding left+right em

        $self->add_js('static/Frey/Action.js');

        $self->add_css(qq|
                label,input {
                        display: block;
                        float: left;
                        margin-bottom: 10px;
                }

                input:focus {
                        border-color: #cc0;
                        background: #ffc;
                }

                label {
                        text-align: right;
                        width: ${label_width}ex;
                        padding-right: 1ex;
                        white-space: nowrap;
                }

                label.required {
                        font-weight: bold;
                }

                br {
                        clear: left;
                }
        |);

        my $html;

        # http://www.quirksmode.org/oddsandends/forms.html
#       $form =~ s{<([^>]+)(name=")([^"]+)(")([^>]*)>}{<$1$2$3$4 id="$3" $5}gs;

        $html = qq|
                <h1>$class params</h1>
                <form name="$form_id" id="$form_id" method="post">
                $form
                <input type="submit" value="Run $class">
                </form>
        | if $form;

        $self->add_status({
                $self->class => {
                        params  => $self->params,
                        params_config  => $params_config,
                        default => $default,
                },
        });

        return ($html,$default) if wantarray;
        return $html;
}

=head1 SEE ALSO

L<http://www.quirksmode.org/css/forms.html> for info on CSS2 forms

=cut

1;
1	dpavlin	369	package Frey::Action;
2			use Moose;
3			extends 'Frey::PPI';
4			with 'Frey::Web';
5			with 'Frey::Config';
6
7	dpavlin	386	use Clone qw/clone/;
8	dpavlin	369	use Data::Dump qw/dump/;
9
10			=head1 DESCRIPTION
11
12			Invoke any L<Frey> object creating html for with various default parameters
13			if not supplied at invocation.
14
15	dpavlin	940	You can force rendering of fields if you define C<render_attribute> sub with
16			desired rendering as in:
17
18			sub render_pipe { 'radio' }
19
20	dpavlin	369	=cut
21
22			has 'class' => (
23			is => 'rw',
24			isa => 'Str',
25			required => 1,
26			);
27
28			has 'params' => (
29			is => 'rw',
30			isa => 'HashRef',
31			default => sub { {} },
32			);
33
34	dpavlin	782	has 'input_step_size' => (
35	dpavlin	780	documentation => 'Resize input fields by this step',
36			is => 'rw',
37			isa => 'Int',
38			# required => 1,
39			default => 20,
40			);
41
42	dpavlin	369	=head2 required
43
44			my @required_attributes = $self->required;
45			my $required_attributes = $self->required;
46	dpavlin	975	my $required_hash = $self->required('as_hash');
47	dpavlin	369
48			=cut
49
50			sub required {
51	dpavlin	975	my ($self,$param) = @_;
52	dpavlin	369	$self->load_class( $self->class );
53	dpavlin	731
54	dpavlin	369	my @required =
55	dpavlin	435	grep {
56	dpavlin	469	defined $_ && $_->can('name') &&
57			! defined( $self->params->{ $_->name } ) &&
58			! $_->is_lazy
59	dpavlin	435	}
60	dpavlin	430	map {
61	dpavlin	435	my $attr = $self->class->meta->get_attribute($_);
62	dpavlin	440	blessed $attr && $attr->is_required && $attr;
63	dpavlin	369	} $self->class->meta->get_attribute_list;
64
65	dpavlin	975	@required = map { $_->name } @required;
66			warn "## required = ",dump( @required ), " for ", $self->class if @required && $self->debug;
67
68			if ( $param eq 'as_hash' ) {
69			my $hash;
70			map { $hash->{$_}++ } @required;
71			return $hash;
72			}
73	dpavlin	369	return @required if wantarray;
74			return \@required;
75			}
76
77			=head2 attributes
78
79			Generated from attributes specified in code (extracted using L<Frey::PPI>)
80			and required atributes
81
82			my @class_attributes = $self->attributes;
83			my @class_attributes = $self->attributes;
84
85			=cut
86
87			sub attributes {
88			my ( $self ) = @_;
89			my $a;
90			my @attrs = @{ $self->attribute_order };
91			@attrs = map { $a->{$_}++; $_ } @attrs;
92	dpavlin	975	push @attrs, $_ foreach grep { ! $a->{$_} } @{ $self->required };
93	dpavlin	386	warn "# attributes = ",dump( @attrs ) if $self->debug;
94	dpavlin	369	return @attrs if wantarray;
95			return \@attrs;
96			}
97
98			=head2 params_form
99
100	dpavlin	386	my $html = $self->params_form;
101			my ($html,$default_params) = $self->params_form;
102	dpavlin	369
103			=cut
104
105			sub params_form {
106			my ( $self ) = @_;
107	dpavlin	975	my $required = $self->required('as_hash');
108			if ( $required ) {
109			warn $self->class, " required params ", dump( keys %$required ) if $self->debug;
110			} else {
111	dpavlin	414	warn "all params available ", dump( $self->params ), " not creating form" if $self->debug;
112	dpavlin	386	return (undef,$self->params) if wantarray;
113	dpavlin	369	return;
114			}
115
116			my $class = $self->class;
117
118			$self->load_class( $class );
119
120	dpavlin	386	my $default = clone $self->params; # XXX we really don't want to modify params!
121	dpavlin	369
122	dpavlin	731	my $params_config = {};
123			$params_config = $self->config($class);
124			warn "# $class config = ",dump( $params_config ) if $self->debug;
125	dpavlin	369
126	dpavlin	386	my $form;
127	dpavlin	950	my $form_id = $class;
128			$form_id =~ s{\W+}{_}g;
129	dpavlin	386
130	dpavlin	504	sub select_values {
131			my ( $name, $attr_type, $values ) = @_;
132	dpavlin	734
133	dpavlin	950	$attr_type \|\|= '?' and warn "$name doesn't have attr_type";
134
135	dpavlin	782	my $max_value_len = 0;
136			my @values;
137			my $html = '';
138
139			foreach ( @$values ) {
140			my $v = ref($_) eq 'HASH' ? $_->{$name} : $_;
141			warn "## value '$v'";
142			push @values, $v;
143			$max_value_len = length($v) if length($v) > $max_value_len;
144			}
145
146			warn "# max_value_len: $max_value_len";
147	dpavlin	940	my $render = eval $class . '->render_' . $name;
148			warn "## render $@";
149	dpavlin	782
150	dpavlin	940	if ( $#values > 3 && $render !~ m{radio} ) {
151	dpavlin	734	my $options = join("\n",
152			map {
153	dpavlin	782	qq\|<option value="$_">$_</option>\|;
154			} @values
155	dpavlin	734	);
156	dpavlin	782	# onchange="alert(this.options[this.selectedIndex].value);"
157			$html = qq\|
158			<select title="$attr_type" name="$name">
159			$options
160			</select>
161			\| if $options;
162	dpavlin	734	} else {
163	dpavlin	782	my $delimiter = $max_value_len > $self->input_step_size ? qq\|<br>\| : '';
164			my $radio =
165			# $delimiter .
166			join("\n",
167			map { strip(qq\|
168			<span title="$attr_type">
169			<input type="radio" name="$name" value="$_">
170			$_
171			</span>
172			$delimiter
173			\|) } @values
174	dpavlin	734	);
175	dpavlin	950	if ( $radio ) {
176
177			my $size = int( $max_value_len / $self->input_step_size ) + 1;
178			$size = 5 if $size > 5;
179			$size *= $self->input_step_size;
180			$radio .= qq\|
181			<span>
182			<input type="radio" name="$name" value=" " onclick="document.getElementById('new-$name').focus();" >
183			<input type="text" name="new-$name" id="new-$name" onchange="clear_radio('$form_id','$name'); this.disable = false;" onblur="this.disable = true;" title="enter new value" size="$size">
184			</span>
185			\|;
186			}
187	dpavlin	782	$html = qq\|<div style="display: block;">$radio</div>\|;
188	dpavlin	734	}
189	dpavlin	782
190			return
191			# qq\|<input type="text" name="$name">\| .
192			$html
193	dpavlin	504	}
194
195	dpavlin	950
196	dpavlin	645	foreach my $checkbox ( split(/\s+/, $default->{'frey-checkboxes'} ) ) {
197			next if defined $default->{ $checkbox };
198
199			$default->{ $checkbox } = 0;
200			$self->params->{ $checkbox } = 0;
201			warn "# checkbox $checkbox not ticked";
202			}
203
204			my @checkboxes;
205
206	dpavlin	731	my $label_width = 1; # minimum
207
208	dpavlin	645	foreach my $name (
209			grep {
210	dpavlin	940	die "$_ doesn't have meta" unless $class->can('meta');
211	dpavlin	645	! $class->meta->get_attribute($_)->is_lazy
212			&& ! defined $default->{$_}
213	dpavlin	715	&& ! m{^_} # skip _private
214	dpavlin	645	} $self->attributes
215			) {
216	dpavlin	414	my $attr_type = '';
217	dpavlin	369	my $type = $name =~ m/^pass/ ? 'password' : 'text';
218	dpavlin	372	my $label = $name;
219			my $label_title = '';
220	dpavlin	369	my $value_html = '';
221	dpavlin	504
222			my $attr = $class->meta->get_attribute( $name );
223			$attr_type = $attr->type_constraint->name if $attr->has_type_constraint;
224
225	dpavlin	645	my $value =
226			defined $default->{$name} ? $default->{$name} :
227			$attr->has_default ? $attr->default( $name ) :
228			'';
229	dpavlin	510
230	dpavlin	783	if ( ref($params_config) eq 'HASH' && defined $params_config->{$name} ) {
231	dpavlin	731	$value = $params_config->{$name};
232			} elsif ( ref($params_config) eq 'ARRAY' ) {
233			$value_html = select_values( $name, $attr_type, $params_config );
234			$default->{$name} = $params_config->[0]->{$name};
235	dpavlin	504	} elsif ( $attr->has_type_constraint && $attr->type_constraint->can('values') ) {
236	dpavlin	731	$value_html = select_values( $name, $attr_type, $attr->type_constraint->values );
237	dpavlin	640	} elsif ( $attr_type =~ m{^Bool} ) {
238	dpavlin	731	my $suffix = '';
239			$suffix = ' checked' if $value;
240			$value_html = qq\|<input type="checkbox" name="$name" title="$attr_type" value="$value"$suffix>\|;
241			push @checkboxes, $name;
242			} elsif ( ! defined $value ) {
243			$value_html = qq\|<tt id="$name">undef</tt><!-- $name = undef -->\|; # FIXME if $self->debug
244	dpavlin	832	} elsif ( $attr_type !~ m{^(Str\|Int)$} \|\| $value =~ $Frey::Web::re_html \|\| $name =~ m{text} ) {
245	dpavlin	731	$value_html = qq\|<textarea name="$name" title="$attr_type">$value</textarea>\|;
246	dpavlin	369	}
247	dpavlin	731
248	dpavlin	504	$label_title = qq\| title="\| . $attr->documentation . qq\|"\| if $attr->has_documentation;
249	dpavlin	372
250	dpavlin	469	$default->{$name} = $value unless defined $default->{$name};
251
252	dpavlin	782	my $size = ( int( length($value) / $self->input_step_size ) + 1 ) * $self->input_step_size;
253	dpavlin	780	$value_html = qq\|<input type="$type" name="$name" title="$attr_type" value="$value" size="$size">\| unless $value_html;
254	dpavlin	372
255	dpavlin	369	# warn "# required $name ", $class->meta->get_attribute( $name )->dump( 2 );
256	dpavlin	975
257			$label_title .= qq\| class="required"\| if $required->{$name};
258			$label =~ s/_/ /g;
259
260	dpavlin	731	$form .= qq\|<label for="$name"$label_title>$label</label>$value_html<br>\|;
261			my $ll = length($label);
262			$label_width = $ll if $ll > $label_width;
263	dpavlin	369	}
264	dpavlin	645	$form .= qq\|<input type="hidden" name="frey-checkboxes" value="\| . join(' ', @checkboxes) . qq\|">\| if @checkboxes;
265
266	dpavlin	975	$label_width += 2; # XXX padding left+right em
267
268	dpavlin	950	$self->add_js('static/Frey/Action.js');
269
270	dpavlin	731	$self->add_css(qq\|
271			label,input {
272			display: block;
273			float: left;
274			margin-bottom: 10px;
275			}
276
277	dpavlin	950	input:focus {
278			border-color: #cc0;
279	dpavlin	975	background: #ffc;
280	dpavlin	950	}
281
282	dpavlin	731	label {
283			text-align: right;
284			width: ${label_width}ex;
285	dpavlin	975	padding-right: 1ex;
286			white-space: nowrap;
287	dpavlin	731	}
288
289	dpavlin	975	label.required {
290			font-weight: bold;
291			}
292
293	dpavlin	731	br {
294			clear: left;
295			}
296			\|);
297
298	dpavlin	645	my $html;
299
300	dpavlin	734	# http://www.quirksmode.org/oddsandends/forms.html
301			# $form =~ s{<([^>]+)(name=")([^"]+)(")([^>]*)>}{<$1$2$3$4 id="$3" $5}gs;
302	dpavlin	731
303	dpavlin	645	$html = qq\|
304			<h1>$class params</h1>
305	dpavlin	950	<form name="$form_id" id="$form_id" method="post">
306	dpavlin	645	$form
307			<input type="submit" value="Run $class">
308			</form>
309			\| if $form;
310
311	dpavlin	507	$self->add_status({
312	dpavlin	595	$self->class => {
313	dpavlin	469	params => $self->params,
314	dpavlin	731	params_config => $params_config,
315			default => $default,
316	dpavlin	390	},
317	dpavlin	507	});
318	dpavlin	369
319	dpavlin	386	return ($html,$default) if wantarray;
320	dpavlin	369	return $html;
321			}
322
323	dpavlin	731	=head1 SEE ALSO
324
325			L<http://www.quirksmode.org/css/forms.html> for info on CSS2 forms
326
327			=cut
328
329	dpavlin	369	1;