Test::AutoBuild::Group - Simple grouping of modules

Test-AutoBuild documentation Contained in the Test-AutoBuild distribution.

Index

Code Index:

NAME

Top

Test::AutoBuild::Group - Simple grouping of modules

SYNOPSIS

Top

  use Test::AutoBuild::Group

  my $group = Test::AutoBuild::Group->new(name => $name,
					  label => $label,
					  modules => \@modules,
					  options => \%options);

  my $name = $group->name([$newname]);
  my $label = $group->label([$newlabel]);
  my $admin = $group->admin([$newadmin]);
  my \@modules = $group->modules([\@modules]);
  my $value = $group->option($name[, $newvalue]);

DESCRIPTION

Top

The Test::AutoBuild::Group module provides for simple grouping of modules. Its primary purpose is to allow the list of modules in HTML status pages to be split up into groups for easy browsing.

CONFIGURATION

Top

The valid configuration options for the groups block are

METHODS

Top

my $group = Test::AutoBuild::Group->new(name => $name, label => $label, [modules => \@modules,] [admin => $admin,] [options => \%options]);

Creates a new group object. modules is an array ref of Test::AutoBUild::Module objects representing the members of the group. name is a short alphanumeric token for the name of the group. label is a free text title for the group. admin is the name/contact details of the group administrator. options is a hash ref of arbitrary options for the group.

my $name = $group->name([$newname]);

Gets the name of the group. The name is a short alphanumeric token. If the newname parameter is supplied then the name is updated.

my $label = $group->label([$newlabel]);

Gets the label of the group. The label is a free text title for the group. If the newlabel parameter is supplied then the label is updated.

my $admin = $group->admin([$newadmin]);

Gets the admin of the group. The admin property is free text representing the group admin name and contact details. If the newadmin parameter is supplied then the admin property is updated.

my \@modules = $group->modules([\@newmodules]);

Gets an array ref representing the members of the group. Each element in the array is an instance of the Test::AutoBuild::Module class. If the newmodules array ref is supplied, then the members of the group are updated.

my $value = $group->option($name, [$newvalue]);

Gets the value corresponding to the option name. If the second newvalue parameter is specified then the value for the option is updated.

AUTHORS

Top

Daniel Berrange <dan@berrange.com>

COPYRIGHT

Top

Copyright (C) 2002-2004 Daniel Berrange <dan@berrange.com>

SEE ALSO

Top

perl(1)

Test-AutoBuild documentation Contained in the Test-AutoBuild distribution. 
# -*- perl -*-
#
# Test::AutoBuild::Group by Daniel Berrange <dan@berrange.com>
#
# Copyright (C) 2002-2004 Daniel Berrange <dan@berrange.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# $Id: Group.pm,v 1.7 2007/12/08 21:03:02 danpb Exp $


package Test::AutoBuild::Group;

use strict;
use warnings;
use Carp qw(confess);
use Class::MethodMaker
    get_set => [qw( name label modules admin enabled )];
use Digest::MD5;


sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = {};
    my %params = @_;

    $self->{name} = exists $params{name} ? $params{name} : confess "name parameter is required";
    $self->{label} = exists $params{label} ? $params{label} : confess "label parameter is required";
    $self->{admin} = exists $params{admin} ? $params{admin} : undef;
    $self->{enabled} = exists $params{enabled} ? $params{enabled} : 1;
    $self->{modules} = exists $params{modules} ? $params{modules} : [];
    $self->{options} = exists $params{options} ? $params{options} : {};

    bless $self, $class;

    return $self;
}



sub option {
   my $self = shift;
   my $name = shift;

   $self->{options}->{$name} = shift if @_;

   return $self->{options}->{$name};
}


1 # So that the require or use succeeds.

__END__