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;

=cut

sub required {
        my ( $self ) = @_;
        $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;

        warn "## required = ",dump( map { $_->name } @required ), " for ", $self->class if @required && $self->debug;
        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->{$_} } map { $_->name } @{ $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;
        if ( ! @required ) {
                warn "all params available ", dump( $self->params ), " not creating form" if $self->debug;
                return (undef,$self->params) if wantarray;
                return;
        } else {
                warn $self->class, " required params ", map { $_->dump(2) } @required if $self->debug;
        }

        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;

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

                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
                        );
                        $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 );
                $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;

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

                label {
                        text-align: right;
                        width: ${label_width}ex;
                        padding-right: 20px;
                }

                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 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
47			=cut
48
49			sub required {
50			my ( $self ) = @_;
51			$self->load_class( $self->class );
52	dpavlin	731
53	dpavlin	369	my @required =
54	dpavlin	435	grep {
55	dpavlin	469	defined $_ && $_->can('name') &&
56			! defined( $self->params->{ $_->name } ) &&
57			! $_->is_lazy
58	dpavlin	435	}
59	dpavlin	430	map {
60	dpavlin	435	my $attr = $self->class->meta->get_attribute($_);
61	dpavlin	440	blessed $attr && $attr->is_required && $attr;
62	dpavlin	369	} $self->class->meta->get_attribute_list;
63
64	dpavlin	386	warn "## required = ",dump( map { $_->name } @required ), " for ", $self->class if @required && $self->debug;
65	dpavlin	369	return @required if wantarray;
66			return \@required;
67			}
68
69			=head2 attributes
70
71			Generated from attributes specified in code (extracted using L<Frey::PPI>)
72			and required atributes
73
74			my @class_attributes = $self->attributes;
75			my @class_attributes = $self->attributes;
76
77			=cut
78
79			sub attributes {
80			my ( $self ) = @_;
81			my $a;
82			my @attrs = @{ $self->attribute_order };
83			@attrs = map { $a->{$_}++; $_ } @attrs;
84			push @attrs, $_ foreach grep { ! $a->{$_} } map { $_->name } @{ $self->required };
85	dpavlin	386	warn "# attributes = ",dump( @attrs ) if $self->debug;
86	dpavlin	369	return @attrs if wantarray;
87			return \@attrs;
88			}
89
90			=head2 params_form
91
92	dpavlin	386	my $html = $self->params_form;
93			my ($html,$default_params) = $self->params_form;
94	dpavlin	369
95			=cut
96
97			sub params_form {
98			my ( $self ) = @_;
99			my @required = $self->required;
100			if ( ! @required ) {
101	dpavlin	414	warn "all params available ", dump( $self->params ), " not creating form" if $self->debug;
102	dpavlin	386	return (undef,$self->params) if wantarray;
103	dpavlin	369	return;
104			} else {
105	dpavlin	390	warn $self->class, " required params ", map { $_->dump(2) } @required if $self->debug;
106	dpavlin	369	}
107
108			my $class = $self->class;
109
110			$self->load_class( $class );
111
112	dpavlin	386	my $default = clone $self->params; # XXX we really don't want to modify params!
113	dpavlin	369
114	dpavlin	731	my $params_config = {};
115			$params_config = $self->config($class);
116			warn "# $class config = ",dump( $params_config ) if $self->debug;
117	dpavlin	369
118	dpavlin	386	my $form;
119
120	dpavlin	504	sub select_values {
121			my ( $name, $attr_type, $values ) = @_;
122	dpavlin	734
123	dpavlin	782	my $max_value_len = 0;
124			my @values;
125			my $html = '';
126
127			foreach ( @$values ) {
128			my $v = ref($_) eq 'HASH' ? $_->{$name} : $_;
129			warn "## value '$v'";
130			push @values, $v;
131			$max_value_len = length($v) if length($v) > $max_value_len;
132			}
133
134			warn "# max_value_len: $max_value_len";
135	dpavlin	940	my $render = eval $class . '->render_' . $name;
136			warn "## render $@";
137	dpavlin	782
138	dpavlin	940	if ( $#values > 3 && $render !~ m{radio} ) {
139	dpavlin	734	my $options = join("\n",
140			map {
141	dpavlin	782	qq\|<option value="$_">$_</option>\|;
142			} @values
143	dpavlin	734	);
144	dpavlin	782	# onchange="alert(this.options[this.selectedIndex].value);"
145			$html = qq\|
146			<select title="$attr_type" name="$name">
147			$options
148			</select>
149			\| if $options;
150	dpavlin	734	} else {
151	dpavlin	782	my $delimiter = $max_value_len > $self->input_step_size ? qq\|<br>\| : '';
152			my $radio =
153			# $delimiter .
154			join("\n",
155			map { strip(qq\|
156			<span title="$attr_type">
157			<input type="radio" name="$name" value="$_">
158			$_
159			</span>
160			$delimiter
161			\|) } @values
162	dpavlin	734	);
163	dpavlin	782	$html = qq\|<div style="display: block;">$radio</div>\|;
164	dpavlin	734	}
165	dpavlin	782
166			return
167			# qq\|<input type="text" name="$name">\| .
168			$html
169	dpavlin	504	}
170
171	dpavlin	645	foreach my $checkbox ( split(/\s+/, $default->{'frey-checkboxes'} ) ) {
172			next if defined $default->{ $checkbox };
173
174			$default->{ $checkbox } = 0;
175			$self->params->{ $checkbox } = 0;
176			warn "# checkbox $checkbox not ticked";
177			}
178
179			my @checkboxes;
180
181	dpavlin	731	my $label_width = 1; # minimum
182
183	dpavlin	645	foreach my $name (
184			grep {
185	dpavlin	940	die "$_ doesn't have meta" unless $class->can('meta');
186	dpavlin	645	! $class->meta->get_attribute($_)->is_lazy
187			&& ! defined $default->{$_}
188	dpavlin	715	&& ! m{^_} # skip _private
189	dpavlin	645	} $self->attributes
190			) {
191	dpavlin	414	my $attr_type = '';
192	dpavlin	369	my $type = $name =~ m/^pass/ ? 'password' : 'text';
193	dpavlin	372	my $label = $name;
194			my $label_title = '';
195	dpavlin	369	my $value_html = '';
196	dpavlin	504
197			my $attr = $class->meta->get_attribute( $name );
198			$attr_type = $attr->type_constraint->name if $attr->has_type_constraint;
199
200	dpavlin	645	my $value =
201			defined $default->{$name} ? $default->{$name} :
202			$attr->has_default ? $attr->default( $name ) :
203			'';
204	dpavlin	510
205	dpavlin	783	if ( ref($params_config) eq 'HASH' && defined $params_config->{$name} ) {
206	dpavlin	731	$value = $params_config->{$name};
207			} elsif ( ref($params_config) eq 'ARRAY' ) {
208			$value_html = select_values( $name, $attr_type, $params_config );
209			$default->{$name} = $params_config->[0]->{$name};
210	dpavlin	504	} elsif ( $attr->has_type_constraint && $attr->type_constraint->can('values') ) {
211	dpavlin	731	$value_html = select_values( $name, $attr_type, $attr->type_constraint->values );
212	dpavlin	640	} elsif ( $attr_type =~ m{^Bool} ) {
213	dpavlin	731	my $suffix = '';
214			$suffix = ' checked' if $value;
215			$value_html = qq\|<input type="checkbox" name="$name" title="$attr_type" value="$value"$suffix>\|;
216			push @checkboxes, $name;
217			} elsif ( ! defined $value ) {
218			$value_html = qq\|<tt id="$name">undef</tt><!-- $name = undef -->\|; # FIXME if $self->debug
219	dpavlin	832	} elsif ( $attr_type !~ m{^(Str\|Int)$} \|\| $value =~ $Frey::Web::re_html \|\| $name =~ m{text} ) {
220	dpavlin	731	$value_html = qq\|<textarea name="$name" title="$attr_type">$value</textarea>\|;
221	dpavlin	369	}
222	dpavlin	731
223	dpavlin	504	$label_title = qq\| title="\| . $attr->documentation . qq\|"\| if $attr->has_documentation;
224	dpavlin	372
225	dpavlin	469	$default->{$name} = $value unless defined $default->{$name};
226
227	dpavlin	782	my $size = ( int( length($value) / $self->input_step_size ) + 1 ) * $self->input_step_size;
228	dpavlin	780	$value_html = qq\|<input type="$type" name="$name" title="$attr_type" value="$value" size="$size">\| unless $value_html;
229	dpavlin	372
230	dpavlin	369	# warn "# required $name ", $class->meta->get_attribute( $name )->dump( 2 );
231	dpavlin	731	$form .= qq\|<label for="$name"$label_title>$label</label>$value_html<br>\|;
232			my $ll = length($label);
233			$label_width = $ll if $ll > $label_width;
234	dpavlin	369	}
235	dpavlin	645	$form .= qq\|<input type="hidden" name="frey-checkboxes" value="\| . join(' ', @checkboxes) . qq\|">\| if @checkboxes;
236
237	dpavlin	731	$self->add_css(qq\|
238			label,input {
239			display: block;
240			float: left;
241			margin-bottom: 10px;
242			}
243
244			label {
245			text-align: right;
246			width: ${label_width}ex;
247			padding-right: 20px;
248			}
249
250			br {
251			clear: left;
252			}
253			\|);
254
255	dpavlin	645	my $html;
256
257	dpavlin	734	# http://www.quirksmode.org/oddsandends/forms.html
258			# $form =~ s{<([^>]+)(name=")([^"]+)(")([^>]*)>}{<$1$2$3$4 id="$3" $5}gs;
259	dpavlin	731
260	dpavlin	645	$html = qq\|
261			<h1>$class params</h1>
262			<form method="post">
263			$form
264			<input type="submit" value="Run $class">
265			</form>
266			\| if $form;
267
268	dpavlin	507	$self->add_status({
269	dpavlin	595	$self->class => {
270	dpavlin	469	params => $self->params,
271	dpavlin	731	params_config => $params_config,
272			default => $default,
273	dpavlin	390	},
274	dpavlin	507	});
275	dpavlin	369
276	dpavlin	386	return ($html,$default) if wantarray;
277	dpavlin	369	return $html;
278			}
279
280	dpavlin	731	=head1 SEE ALSO
281
282			L<http://www.quirksmode.org/css/forms.html> for info on CSS2 forms
283
284			=cut
285
286	dpavlin	369	1;