File Coverage

lib/Clearcase/Views.pm

Criterion	Covered	Total	%
statement	9	49	18.3
branch	0	26	0.0
condition	0	8	0.0
subroutine	3	10	30.0
pod	6	7	85.7
total	18	100	18.0

=pod

=head1 NAME Views.pm

Object oriented interface to Clearcase Views

=head1 VERSION

=over

=item Author

Andrew DeFaria

=item Revision

$Revision: 1.12 $

=item Created

Dec 29 12:07:59 PST 2005

=item Modified

$Date: 2011/11/16 19:46:13 $

=back

=head1 SYNOPSIS

Provides access to information about Clearcase Views.

 my $views = new Clearcase::Views;

 my $nbr_views	= $views->views;
 my @view_list	= $views->views;

 print "Clearcase Views\n";

 print "Number of views:\t\t"	. $nbr_views . "\n";
 print "View list:\n";

 print "\t$_\n" foreach (@view_list);

=head1 DESCRIPTION

This module implements an object oriented interface to Clearcase
views.

=head1 ROUTINES

The following routines are exported:

=cut

package Clearcase::Views;

use strict;
use warnings;

use Clearcase;

sub new (;$) {
  my ($class, $region) = @_;

=pod

=head2 new

Construct a new Clearcase Views object.

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item Clearcase Views object

=back

=for html

=cut

  $region ||= $Clearcase::CC->region || '';

  my ($status, @output) =
    $Clearcase::CC->execute ("lsview -short -region $region");

  $class = bless {views => \@output,}, $class;    # bless

  return $class;
}    # new

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

=pod

=head2 views

Return a list of view tags in an array context or the number of views in
a scalar context.

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item List of views or number of views

Array of view tags in an array context or the number of views in a scalar context.

=back

=for html

=cut

  if (wantarray) {
    return $self->{views} ? sort @{$self->{views}} : ();
  } else {
    return $self->{views} ? scalar @{$self->{views}} : 0;
  }    #if
}    # views

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

=pod

=head2 dynamic

Return the number of dynamic views

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item number of dynamic views

Returns the number of dynamic views in the region

=back

=for html

=cut

  $self->updateViewInfo if !defined $self->{dynamic};
  return $self->{dynamic};
}    # dynamic

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

=pod

=head2 ucm

Return the number of ucm views

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item number of ucm views

Returns the number of ucm views in the region

=back

=for html

=cut

  $self->updateViewInfo if !defined $self->{ucm};
  return $self->{ucm};
}    # ucm

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

=pod

=head2 snapshot

Return the number of snapshot views

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item number of snapshot views

Returns the number of snapshot views in the region

=back

=for html

=cut

  $self->updateViewInfo if !defined $self->{snapshot};
  return $self->{snapshot};
}    # snapshot

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

=pod

=head2 web

Return the number of web views

Parameters:

=for html

=over

=item none

=back

=for html

Returns:

=for html

=over

=item number of web views

Returns the number of web views in the region

=back

=for html

=cut

  $self->updateViewInfo if !defined $self->{web};
  return $self->{web};
}    # web

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

  my ($dynamic, $web, $ucm, $snapshot) = (0, 0, 0, 0);

  foreach ($self->views) {
    my ($status, @lsview_out) =
      $Clearcase::CC->execute ("lsview -properties -full $_");

    next
      if $status;

    foreach (@lsview_out) {
      if (/Properties/) {
        $dynamic++
          if /dynamic/;
        $snapshot++
          if /snapshot/ and not /webview/;
        $ucm++
          if /ucmview/;
        $web++
          if /webview/;
        last;
      }    # if
    }    # foreach

    $self->{dynamic}  = $dynamic;
    $self->{web}      = $web;
    $self->{ucm}      = $ucm;
    $self->{snapshot} = $snapshot;
  }    # foreach

  return;
}    # updateViewInfo

1;

=head1 DEPENDENCIES

=head2 Modules

=over

=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