File Coverage

lib/Brownie/Node.pm

Criterion	Covered	Total	%
statement	26	28	92.8
branch	2	2	100.0
condition			n/a
subroutine	14	16	87.5
pod	9	12	75.0
total	51	58	87.9

package Brownie::Node;

use strict;
use warnings;
use Sub::Install;

use Brownie::Helpers;

sub new {
    my ($class, %args) = @_;
    return bless { %args }, $class;
}

sub driver { shift->{driver} }
sub native { shift->{native} }

our @Accessor = qw(attr text tag_name id name value type);
our @Finder   = qw(find all first);
our @State    = qw(is_displayed is_not_displayed is_selected is_not_selected is_checked is_not_checked);
our @Action   = qw(click set select unselect);

sub id    { shift->attr('id')    }
sub name  { shift->attr('name')  }
sub type  { shift->attr('type')  }
sub value { shift->attr('value') }

sub find {
    my ($self, $locator) = @_;
    return $self->driver->find($locator, base => $self);
}
*first = \&find;

sub all {
    my ($self, $locator) = @_;
    my @children = $self->driver->all($locator, base => $self);
    return @children ? @children : ();
}

sub is_not_displayed { !shift->is_displayed }
sub is_not_selected  { !shift->is_selected  }
sub is_not_checked   { !shift->is_checked   }

our @Method = (@Accessor, @Finder, @State, @Action);
for (@Method) {
    next if __PACKAGE__->can($_);
    Sub::Install::install_sub({
        code => Brownie::Helpers->can('not_implemented'),
        as   => $_,
    });
}

1;

=head1 NAME

Brownie::Node - base class of Brownie::Node series

=head1 METHODS

=over 4

=item * C

Returns a new instance.

  my $node = Brownie::Node->new(%args);

C<%args> are:

=over 8

=item * C: parent Brownie::Driver instance

=item * C: native driver specific node representation instance

=back

=item * C

Returns a driver instance.

  my $driver = $node->driver;

=item * C

Returns a native node instance.

  my $native = $node->native;

=item * C

Returns an attribute value.

  my $title = $node->attr('title');

=item * C

Returns the value of element.

  my $value = $node->value;

=item * C

Returns a child node text. (= innerText)

  my $text = $node->text;

=item * C

Returns a tag name.

  my $tag_name = $node->tag_name;

=item * C, C

Whether this element is displayed, or not.

  if ($node->is_displayed) {
      print "this node is visible";
  }

  if ($node->is_not_displayed) {
      warn "this node is not visible";
  }

=item * C, C

Whether this element is checked, or not. (checkbox)

  if ($checkbox->is_checked) {
      print "marked";
  }

  if ($checkbox->is_not_checked) {
      warn "unmarked...";
  }

=item * C, C

Whether this element is selected, or not. (radio, option)

  if ($radio->is_selected) {
      print "this radio button is selcted";
  }

  if ($option->is_not_selected) {
      warn "this option element is not selected";
  }

=item * C

Sets value to this element. (input, textarea)

  $input->set($value);
  $textarea->set($text);

=item * C

Select this element (option, radio)

  $option->select;
  $radio->select;

=item * C

Unselect this element (options - multiple select)

  $option->unselect;

=item * C

Clicks this element.

  $link->click;
  $button->click;

=item * C

Finds and returns an located element under this.

  my $element = $node->find($locator); # search under $node

=item * C

Finds and returns located elements under this.

  my @elements = $node->all($locator); # search under $node

=back

=head1 AUTHOR

NAKAGAWA Masaki [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 SEE ALSO

L

=cut