File Coverage

blib/lib/HTML/FormFu/Element.pm

Criterion	Covered	Total	%
statement	110	119	92.4
branch	30	32	93.7
condition	14	15	93.3
subroutine	34	41	82.9
pod	4	26	15.3
total	192	233	82.4

use strict;

package HTML::FormFu::Element;
$HTML::FormFu::Element::VERSION = '2.07';
# ABSTRACT: Element Base Class

use Moose;
use MooseX::Attribute::Chained;

with 'HTML::FormFu::Role::Render',
    'HTML::FormFu::Role::FormAndElementMethods',
    'HTML::FormFu::Role::HasParent',
    'HTML::FormFu::Role::CustomRoles',
    'HTML::FormFu::Role::Populate';

use HTML::FormFu::Attribute qw(
    mk_attrs
    mk_attr_accessors
    mk_output_accessors
    mk_inherited_accessors
    mk_inherited_merging_accessors
);
use HTML::FormFu::ObjectUtil qw(
    load_config_file
    load_config_filestem
    form
    stash
    parent
    get_parent
);
use HTML::FormFu::Util
    qw( require_class xml_escape process_attrs _merge_hashes );
use Clone ();
use Scalar::Util qw( weaken );
use Carp qw( croak );

use overload (
    'eq'     => '_string_equals',
    '=='     => '_object_equals',
    '""'     => sub { return shift->render },
    bool     => sub {1},
    fallback => 1
);

__PACKAGE__->mk_attr_accessors(qw( id ));

has type          => ( is => 'rw', traits => ['Chained'] );
has filename      => ( is => 'rw', traits => ['Chained'] );
has is_field      => ( is => 'rw', traits => ['Chained'] );
has is_block      => ( is => 'rw', traits => ['Chained'] );
has is_repeatable => ( is => 'rw', traits => ['Chained'] );

after BUILD => sub {
    my ( $self, $args ) = @_;

    # TODO move to attribute 'default'
    $self->attributes( {} );
    $self->stash(      {} );

    return;
};

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

    if ( @_ > 1 ) {

        if ( $name =~ /[\.\[\]]/ ) {
            croak <<'ERROR_MESSAGE';
element names may not contain periods or square brackets
see documentation on nested_names() for details
ERROR_MESSAGE
        }

        $self->{name} = $name;

        return $self;
    }

    return $self->{name};
}

sub setup { }

sub get_elements { [] }

sub get_element { }

sub get_all_elements { [] }

sub get_all_element { }

sub get_fields { [] }

sub get_field { }

sub get_deflators { [] }

sub get_filters { [] }

sub get_constraints { [] }

sub get_inflators { [] }

sub get_validators { [] }

sub get_transformers { [] }

sub get_errors { [] }

sub clear_errors { }

sub pre_process { }

sub process { }

sub post_process { }

sub prepare_id { }

sub prepare_attrs { }

sub get_output_processors {
    my $self = shift;

    return $self->form->get_output_processors(@_);
}

sub get_output_processor {
    my $self = shift;

    return $self->form->get_output_processor(@_);
}

sub _match_default_args {
    my ( $self, $defaults ) = @_;

    return {} if !$defaults || !%$defaults;

   # apply any starting with 'Block', 'Field', 'Input' first, each longest first
    my @block = sort { length $a <=> length $b }
        grep { $_ =~ /^Block/ } keys %$defaults;
    my @field = sort { length $a <=> length $b }
        grep { $_ =~ /^Field/ } keys %$defaults;
    my @input = sort { length $a <=> length $b }
        grep { $_ =~ /^Input/ } keys %$defaults;

    my %others = map { $_ => 1 } keys %$defaults;
    map { delete $others{$_} } @block, @field, @input;

    # apply remaining keys, longest first
    my $arg = {};

KEY:
    for my $key ( @block, @field, @input,
        sort { length $a <=> length $b } keys %others )
    {
        my @type = split qr{\|}, $key;
        my $match;

    TYPE:
        for my $type (@type) {
            my $not_in;
            my $is_in;
            if ( $type =~ s/^-// ) {
                $not_in = 1;
            }
            elsif ( $type =~ s/^\+// ) {
                $is_in = 1;
            }

            my $check_parents = $not_in || $is_in;

            if ( $self->_match_default_args_type( $type, $check_parents ) ) {
                if ($not_in) {
                    next KEY;
                }
                else {
                    $match = 1;
                    next TYPE;
                }
            }
        }

        if ($match) {
            $arg = _merge_hashes( $arg, $defaults->{$key} );
        }
    }

    return $arg;
}

sub _match_default_args_type {
    my ( $self, $type, $check_parents ) = @_;

    my @target;
    if ($check_parents) {
        my $self = $self;
        while ( defined( my $parent = $self->parent ) ) {
            last if !$parent->isa('HTML::FormFu::Element');
            push @target, $parent;
            $self = $parent;
        }
    }
    else {
        @target = ($self);
    }

    for my $target (@target) {

        # handle Block default_args
        if ( 'Block' eq $type
            && $target->isa('HTML::FormFu::Element::Block') )
        {
            return 1;
        }

        # handle Field default_args
        if ( 'Field' eq $type
            && $target->does('HTML::FormFu::Role::Element::Field') )
        {
            return 1;
        }

        # handle Input default_args
        if ( 'Input' eq $type
            && $target->does('HTML::FormFu::Role::Element::Input') )
        {
            return 1;
        }

        # handle explicit default_args
        if ( $type eq $target->type ) {
            return 1;
        }
    }
}

sub clone {
    my ($self) = @_;

    my %new = %$self;

    $new{tt_args} = Clone::clone( $self->{tt_args} )
        if $self->{tt_args};

    $new{attributes}   = Clone::clone( $self->attributes );
    $new{model_config} = Clone::clone( $self->model_config );

    return bless \%new, ref $self;
}

sub render_data {
    return shift->render_data_non_recursive(@_);
}

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

    my %render = (
        name       => xml_escape( $self->name ),
        attributes => xml_escape( $self->attributes ),
        type       => $self->type,
        filename   => $self->filename,
        is_field   => $self->is_field,
        stash      => $self->stash,
        parent     => $self->parent,
        form   => sub { return shift->{parent}->form },
        object => $self,
        $args ? %$args : (),
    );

    weaken( $render{parent} );

    $self->prepare_id( \%render );

    $self->prepare_attrs( \%render );

    return \%render;
}

__PACKAGE__->meta->make_immutable;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

HTML::FormFu::Element - Element Base Class

=head1 VERSION

version 2.07

=head1 SYNOPSIS

    ---
    elements:
      - type: Text
        name: username
        constraints:
          - type: Required

      - type: Password
        name: password
        constraints:
          - type: Required
          - type: Equal
            others: repeat-password

      - type: Password
        name: repeat-password

      - type: Submit

=head1 DESCRIPTION

Elements are the basic building block of all forms. Elements may be logical
form-fields, blocks such as C<div>s and C<fieldset>s, non-blocks such as
C<hr>s and other special elements such as tables.

For simple, automatic handling of fieldsets see the
L<HTML::FormFu/auto_fieldset> setting.

See L<HTML::FormFu/deflators> for details of
L<Deflators|HTML::FormFu::Deflator>.

See L<HTML::FormFu/FORM LOGIC AND VALIDATION> for details of
L<Filters|HTML::FormFu::Filter>,
L<Constraints|HTML::FormFu::Constraint>,
L<Inflators|HTML::FormFu::Inflator>,
L<Validators|HTML::FormFu::Validator> and
L<Transformers|HTML::FormFu::Transformer>.

=head1 METHODS

=head2 name

For L<field|HTML::FormFu::Role::Element::Field> element, this value is used as
the C<name> attribute which the field's value is associated with.

For all elements, the L</name> value can be useful for identifying and
retrieving specific elements.

=head2 is_field

Return Value: boolean

Returns C<true> or C<false> depending on whether the element is a logical
form-field.

This is used by L<HTML::FormFu/get_fields>.

=head1 BUILDING AN ELEMENT

=head2 load_config_file

Arguments: $filename

Arguments: \@filenames

Populate an element using a config file:

    ---
    elements:
      - type: Block
        load_config_file: 'elements.yml'

See L<HTML::FormFu/load_config_file> for further details.

=head2 load_config_filestem

Arguments: $filestem

Arguments: \@filestems

Like L</load_config_file>, but you shouldn't include the file extension
in the passed string. This allows you to change your config-file type,
without having to change the code that loads the files.

=head2 config_file_path

Arguments: $directory_name

L</config_file_path> defines where configuration files will be
searched for, if an absolute path is not given to
L</load_config_file>.

Default Value: not defined

This method is a special 'inherited accessor', which means it can be set on
the form, a block element or a single element. When the value is read, if
no value is defined it automatically traverses the element's hierarchy of
parents, through any block elements and up to the form, searching for a
defined value.

=head2 config_callback

See L<HTML::FormFu/config_callback> for details.

=head2 populate

See L<HTML::FormFu/populate> for details.

=head2 stash

See L<HTML::FormFu/stash> for details.

=head2 type

Returns the C<type> argument originally used to create the element.

=head1 CHANGING DEFAULT BEHAVIOUR

=head2 render_processed_value

See L<HTML::FormFu/render_processed_value> for details.

=head2 force_errors

See L<HTML::FormFu/force_errors> for details.

=head1 ELEMENT ATTRIBUTES

See specific element types for which tag attributes are added to.

=head2 attributes

=head2 attrs

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See L<HTML::FormFu/attributes> for details.

L</attrs> is an alias for L</attributes>.

=head2 attributes_xml

=head2 attrs_xml

See L<HTML::FormFu/attributes_xml> for details.

L</attrs_xml> is an alias for L</attributes_xml>.

=head2 add_attributes

=head2 add_attrs

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See L<HTML::FormFu/add_attributes> for details.

L</add_attrs> is an alias for L</add_attributes>.

=head2 add_attributes_xml

=head2 add_attrs_xml

See L<HTML::FormFu/add_attributes_xml> for details.

L</add_attrs_xml> is an alias for L</add_attributes_xml>.

=head2 del_attributes

=head2 del_attrs

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See L<HTML::FormFu/del_attributes> for details.

L</del_attrs> is an alias for L</del_attributes>.

=head2 del_attributes_xml

=head2 del_attrs_xml

See L<HTML::FormFu/del_attributes_xml> for details.

L</del_attrs_xml> is an alias for L</del_attributes_xml>.

The following methods are shortcuts for accessing L</attributes> keys.

=head2 id

Arguments: [$id]

Return Value: $id

Get or set the element's DOM id.

Default Value: none

=head1 MODEL / DATABASE INTERACTION

See L<HTML::FormFu::Model> for further details and available models.

=head2 model_config

Arguments: \%config

=head1 RENDERING

=head2 filename

This value identifies which template file should be used by
L</render> to render the element.

=head2 prepare_id

Arguments: $render

See L<HTML::FormFu::Role::Element::Field/prepare_id> for details.

=head2 prepare_attrs

Arguments: $render

See L<HTML::FormFu::Role::Element::Field/prepare_attrs> for details.

=head2 render

Return Value: $string

=head1 INTROSPECTION

=head2 parent

Returns the L<block element|HTML::FormFu::Element::Block> or
L<form|HTML::FormFu> object that this element is attached to.

=head2 get_parent

Arguments: \%options

    my $repeatable = $field->get_parent({ type => 'Repeatable' });

Traverses the parent hierarchy, returning the first parent that matches the
supplied options.

=head2 form

Returns the L<HTML::FormFu> object that the constraint's field is attached
to.

=head2 clone

See L<HTML::FormFu/clone> for details.

=head1 ADVANCED CUSTOMISATION

=head2 tt_args

See L<HTML::FormFu/tt_args> for details.

=head2 render_method

See L<HTML::FormFu/render_method> for details.

=head1 CORE FORM FIELDS

=over

=item L<HTML::FormFu::Element::Button>

=item L<HTML::FormFu::Element::Checkbox>

=item L<HTML::FormFu::Element::Checkboxgroup>

=item L<HTML::FormFu::Element::ComboBox>

=item L<HTML::FormFu::Element::ContentButton>

=item L<HTML::FormFu::Element::Date>

=item L<HTML::FormFu::Element::Email>

=item L<HTML::FormFu::Element::File>

=item L<HTML::FormFu::Element::Hidden>

=item L<HTML::FormFu::Element::Image>

=item L<HTML::FormFu::Element::Number>

=item L<HTML::FormFu::Element::Password>

=item L<HTML::FormFu::Element::Radio>

=item L<HTML::FormFu::Element::Radiogroup>

=item L<HTML::FormFu::Element::Reset>

=item L<HTML::FormFu::Element::Select>

=item L<HTML::FormFu::Element::Submit>

=item L<HTML::FormFu::Element::Textarea>

=item L<HTML::FormFu::Element::Text>

=item L<HTML::FormFu::Element::URL>

=back

=head1 OTHER CORE ELEMENTS

=over

=item L<HTML::FormFu::Element::Blank>

=item L<HTML::FormFu::Element::Block>

=item L<HTML::FormFu::Element::Fieldset>

=item L<HTML::FormFu::Element::Hr>

=item L<HTML::FormFu::Element::Label>

=item L<HTML::FormFu::Element::Multi>

=item L<HTML::FormFu::Element::Repeatable>

=item L<HTML::FormFu::Element::SimpleTable>

=item L<HTML::FormFu::Element::Src>

=back

=head1 ELEMENT BASE CLASSES

The following are base classes for other elements, and generally needn't be
used directly.

=over

=item L<HTML::FormFu::Role::Element::Field>

=item L<HTML::FormFu::Role::Element::Group>

=item L<HTML::FormFu::Role::Element::Input>

=item L<HTML::FormFu::Element::_MultiElement>

=item L<HTML::FormFu::Element::_MultiSelect>

=item L<HTML::FormFu::Element::_MultiText>

=item L<HTML::FormFu::Role::Element::NonBlock>

=back

=head1 REMOVED METHODS

=head2 db

Has been removed; use L</default_args> instead.

=head1 AUTHOR

Carl Franks, C<[e-mail]>

=head1 LICENSE

This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.

=head1 AUTHOR

Carl Franks <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Carl Franks.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut