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.

=cut

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

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

=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 $options = join("\n",
                        map {
                                my $v = ref($_) eq 'HASH' ? $_->{$name} : $_;
                                qq|<option value="$v">$v</option>| if $v;
                        } @$values
                );
                qq|<select title="$attr_type" name="$name">$options</select>| if $options;
        }

        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 $skip_prefix;
        if ( $self->class->can('action') ) {
                my $action = eval $self->class . '->action';
                $skip_prefix->{$_}++ foreach eval $self->class .'->action_order';
                warn "# skip_prefix = ", $self->dump( $skip_prefix );
        }

        my $label_width = 1; # minimum

        foreach my $name (
                grep {
                        ! $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' ) {
                        $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 ) {
                        $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};

                $value_html = qq|<input type="$type" name="$name" title="$attr_type" value="$value">| 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;

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

        $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			=cut
16
17			has 'class' => (
18			is => 'rw',
19			isa => 'Str',
20			required => 1,
21			);
22
23			has 'params' => (
24			is => 'rw',
25			isa => 'HashRef',
26			default => sub { {} },
27			);
28
29			=head2 required
30
31			my @required_attributes = $self->required;
32			my $required_attributes = $self->required;
33
34			=cut
35
36			sub required {
37			my ( $self ) = @_;
38			$self->load_class( $self->class );
39	dpavlin	731
40	dpavlin	369	my @required =
41	dpavlin	435	grep {
42	dpavlin	469	defined $_ && $_->can('name') &&
43			! defined( $self->params->{ $_->name } ) &&
44			! $_->is_lazy
45	dpavlin	435	}
46	dpavlin	430	map {
47	dpavlin	435	my $attr = $self->class->meta->get_attribute($_);
48	dpavlin	440	blessed $attr && $attr->is_required && $attr;
49	dpavlin	369	} $self->class->meta->get_attribute_list;
50
51	dpavlin	386	warn "## required = ",dump( map { $_->name } @required ), " for ", $self->class if @required && $self->debug;
52	dpavlin	369	return @required if wantarray;
53			return \@required;
54			}
55
56			=head2 attributes
57
58			Generated from attributes specified in code (extracted using L<Frey::PPI>)
59			and required atributes
60
61			my @class_attributes = $self->attributes;
62			my @class_attributes = $self->attributes;
63
64			=cut
65
66			sub attributes {
67			my ( $self ) = @_;
68			my $a;
69			my @attrs = @{ $self->attribute_order };
70			@attrs = map { $a->{$_}++; $_ } @attrs;
71			push @attrs, $_ foreach grep { ! $a->{$_} } map { $_->name } @{ $self->required };
72	dpavlin	386	warn "# attributes = ",dump( @attrs ) if $self->debug;
73	dpavlin	369	return @attrs if wantarray;
74			return \@attrs;
75			}
76
77			=head2 params_form
78
79	dpavlin	386	my $html = $self->params_form;
80			my ($html,$default_params) = $self->params_form;
81	dpavlin	369
82			=cut
83
84			sub params_form {
85			my ( $self ) = @_;
86			my @required = $self->required;
87			if ( ! @required ) {
88	dpavlin	414	warn "all params available ", dump( $self->params ), " not creating form" if $self->debug;
89	dpavlin	386	return (undef,$self->params) if wantarray;
90	dpavlin	369	return;
91			} else {
92	dpavlin	390	warn $self->class, " required params ", map { $_->dump(2) } @required if $self->debug;
93	dpavlin	369	}
94
95			my $class = $self->class;
96
97			$self->load_class( $class );
98
99	dpavlin	386	my $default = clone $self->params; # XXX we really don't want to modify params!
100	dpavlin	369
101	dpavlin	731	my $params_config = {};
102			$params_config = $self->config($class);
103			warn "# $class config = ",dump( $params_config ) if $self->debug;
104	dpavlin	369
105	dpavlin	386	my $form;
106
107	dpavlin	504	sub select_values {
108			my ( $name, $attr_type, $values ) = @_;
109			my $options = join("\n",
110			map {
111			my $v = ref($_) eq 'HASH' ? $_->{$name} : $_;
112			qq\|<option value="$v">$v</option>\| if $v;
113			} @$values
114			);
115			qq\|<select title="$attr_type" name="$name">$options</select>\| if $options;
116			}
117
118	dpavlin	645	foreach my $checkbox ( split(/\s+/, $default->{'frey-checkboxes'} ) ) {
119			next if defined $default->{ $checkbox };
120
121			$default->{ $checkbox } = 0;
122			$self->params->{ $checkbox } = 0;
123			warn "# checkbox $checkbox not ticked";
124			}
125
126			my @checkboxes;
127
128	dpavlin	731	my $skip_prefix;
129			if ( $self->class->can('action') ) {
130			my $action = eval $self->class . '->action';
131			$skip_prefix->{$_}++ foreach eval $self->class .'->action_order';
132			warn "# skip_prefix = ", $self->dump( $skip_prefix );
133			}
134
135			my $label_width = 1; # minimum
136
137	dpavlin	645	foreach my $name (
138			grep {
139			! $class->meta->get_attribute($_)->is_lazy
140			&& ! defined $default->{$_}
141	dpavlin	715	&& ! m{^_} # skip _private
142	dpavlin	645	} $self->attributes
143			) {
144	dpavlin	414	my $attr_type = '';
145	dpavlin	369	my $type = $name =~ m/^pass/ ? 'password' : 'text';
146	dpavlin	372	my $label = $name;
147			my $label_title = '';
148	dpavlin	369	my $value_html = '';
149	dpavlin	504
150			my $attr = $class->meta->get_attribute( $name );
151			$attr_type = $attr->type_constraint->name if $attr->has_type_constraint;
152
153	dpavlin	645	my $value =
154			defined $default->{$name} ? $default->{$name} :
155			$attr->has_default ? $attr->default( $name ) :
156			'';
157	dpavlin	510
158	dpavlin	731	if ( ref($params_config) eq 'HASH' ) {
159			$value = $params_config->{$name};
160			} elsif ( ref($params_config) eq 'ARRAY' ) {
161			$value_html = select_values( $name, $attr_type, $params_config );
162			$default->{$name} = $params_config->[0]->{$name};
163	dpavlin	504	} elsif ( $attr->has_type_constraint && $attr->type_constraint->can('values') ) {
164	dpavlin	731	$value_html = select_values( $name, $attr_type, $attr->type_constraint->values );
165	dpavlin	640	} elsif ( $attr_type =~ m{^Bool} ) {
166	dpavlin	731	my $suffix = '';
167			$suffix = ' checked' if $value;
168			$value_html = qq\|<input type="checkbox" name="$name" title="$attr_type" value="$value"$suffix>\|;
169			push @checkboxes, $name;
170			} elsif ( ! defined $value ) {
171			$value_html = qq\|<tt id="$name">undef</tt><!-- $name = undef -->\|; # FIXME if $self->debug
172	dpavlin	708	} elsif ( $attr_type !~ m{^(Str\|Int)$} \|\| $value =~ $Frey::Web::re_html ) {
173	dpavlin	731	$value_html = qq\|<textarea name="$name" title="$attr_type">$value</textarea>\|;
174	dpavlin	369	}
175	dpavlin	731
176	dpavlin	504	$label_title = qq\| title="\| . $attr->documentation . qq\|"\| if $attr->has_documentation;
177	dpavlin	372
178	dpavlin	469	$default->{$name} = $value unless defined $default->{$name};
179
180	dpavlin	640	$value_html = qq\|<input type="$type" name="$name" title="$attr_type" value="$value">\| unless $value_html;
181	dpavlin	372
182	dpavlin	369	# warn "# required $name ", $class->meta->get_attribute( $name )->dump( 2 );
183	dpavlin	731	$form .= qq\|<label for="$name"$label_title>$label</label>$value_html<br>\|;
184			my $ll = length($label);
185			$label_width = $ll if $ll > $label_width;
186	dpavlin	369	}
187	dpavlin	645	$form .= qq\|<input type="hidden" name="frey-checkboxes" value="\| . join(' ', @checkboxes) . qq\|">\| if @checkboxes;
188
189	dpavlin	731	$self->add_css(qq\|
190			label,input {
191			display: block;
192			float: left;
193			margin-bottom: 10px;
194			}
195
196			label {
197			text-align: right;
198			width: ${label_width}ex;
199			padding-right: 20px;
200			}
201
202			br {
203			clear: left;
204			}
205			\|);
206
207	dpavlin	645	my $html;
208
209	dpavlin	731	$form =~ s{<([^>]+)(name=")([^"]+)(")([^>]*)>}
210			{<$1$2$3$4 id="$3" $5}gs; # http://www.quirksmode.org/oddsandends/forms.html
211
212	dpavlin	645	$html = qq\|
213			<h1>$class params</h1>
214			<form method="post">
215			$form
216			<input type="submit" value="Run $class">
217			</form>
218			\| if $form;
219
220	dpavlin	507	$self->add_status({
221	dpavlin	595	$self->class => {
222	dpavlin	469	params => $self->params,
223	dpavlin	731	params_config => $params_config,
224			default => $default,
225	dpavlin	390	},
226	dpavlin	507	});
227	dpavlin	369
228	dpavlin	386	return ($html,$default) if wantarray;
229	dpavlin	369	return $html;
230			}
231
232	dpavlin	731	=head1 SEE ALSO
233
234			L<http://www.quirksmode.org/css/forms.html> for info on CSS2 forms
235
236			=cut
237
238	dpavlin	369	1;