File Coverage

lib/Clearcase/UCM/Project.pm

Criterion	Covered	Total	%
statement	6	26	23.0
branch	0	4	0.0
condition	0	4	0.0
subroutine	2	9	22.2
pod	7	7	100.0
total	15	50	30.0

=pod

=head1 NAME Project.pm

Object oriented interface to UCM Projects

=head1 VERSION

=over

=item Author

Andrew DeFaria

=item Revision

$Revision: 1.8 $

=item Created

Fri May 14 18:16:16 PDT 2010

=item Modified

$Date: 2011/11/15 02:00:58 $

=back

=head1 SYNOPSIS

Provides access to information about Clearcase UCM Projects.

  my $project = new Clearcase::UCM::Project ($name, $folder, $pvob);

=head1 DESCRIPTION

This module implements a UCM Project object

=head1 ROUTINES

The following routines are exported:

=cut

package Clearcase::UCM::Project;

use strict;
use warnings;

sub new ($$) {
  my ($class, $name, $folder, $pvob) = @_;

=pod

=head2 new

Construct a new Clearcase Project object.

Parameters:

=for html

=over

=item project

Name of project

=item folder

Folder object

=item pvob

Associated Pvob

=back

=for html

Returns:

=for html

=over

=item Clearcase Project object

=back

=for html

=cut

  $folder = Clearcase::UCM::Folder->new ('RootFolder', $pvob) unless $folder;

  $class = bless {
    name   => $name,
    folder => $folder,
    pvob   => $pvob,
    },
    $class;    # bless

  return $class;
}    # new

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

=pod

=head2 name

Returns the name of the project

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item project's name

=back

=for html

=cut

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

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

=pod

=head2 pvob

Returns the pvob of the project

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item project's pvob

=back

=for html

=cut

  return $self->{pvob};
}    # pvob

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

=pod

=head2 create

Creates a new UCM Project Object

Parameters:

=for html

=over

=item opts

Optional parameters for cleartool mkproject command

=back

=for html

Returns:

=for html

=over

=item $status

Status from cleartool

=item @output

Ouput from cleartool

=back

=for html

=cut

  return (0, ()) if $self->exists;

  $opts ||= '';

  return $Clearcase::CC->execute ("mkproject $opts -in "
      . $self->{folder}->name . '@'
      . $self->{pvob}->tag . ' '
      . $self->{name} . '@'
      . $self->{pvob}->tag);
}    # create

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

=pod

=head2 remove

Removes UCM Project

Parameters:

=for html

=over

=for html

Returns:

=for html

=over

=item $status

Status from cleartool

=item @output

Ouput from cleartool

=back

=for html

=cut

  return $Clearcase::CC->execute (
    'rmproject -f ' . $self->{name} . "\@" . $self->{pvob}->tag);
}    # remove

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

=pod

=head2 change

Changes UCM Project

Parameters:

=for html

=over

=item opts

Options

=for html

Returns:

=for html

=over

=item $status

Status from cleartool

=item @output

Ouput from cleartool

=back

=for html

=cut

  $opts ||= '';

  return $Clearcase::CC->execute (
    "chproject $opts " . $self->{name} . "\@" . $self->{pvob}->name);
}    # change

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

=pod

=head3 exists

Returns true if the project exists - false otherwise

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item boolean

=back

=for html

=cut

  my ($status, @output) = $Clearcase::CC->execute (
    'lsproject ' . $self->{name} . '@' . $self->{pvob}->name);

  return !$status;
}    # exists

1;

=head1 DEPENDENCIES

=head2 Modules

=over

=item L

=item L

=back

=head1 INCOMPATABILITIES

None

=head1 BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Andrew DeFaria .

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2020 by [e-mail]

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.38.0 or,
at your option, any later version of Perl 5 you may have available.

=cut