NAME

Gentoo::Overlay::Category - A singular category in a repository;

VERSION

version 0.01000020

SYNOPSIS

Still limited functionality, more to come.

my $category = ::Overlay::Category->new(
    name => 'dev-perl',
    overlay => '/usr/portage' ,
);

my $category = ::Overlay::Category->new(
    name => 'dev-perl',
    overlay => $overlay_object ,
);

$category->exists()  # is the category there, is it a directory?

$category->is_backlisted() # is the category something dumb like '..' or 'metadata'

$category->pretty_name()  #  dev-perl/::gentoo

$category->path()  # /usr/portage/dev-perl

::Overlay::Category->_scan_blacklist() # the blacklist

::Overlay::Category->_scan_blacklisted('..') # is '..' a blacklisted category

METHODS

exists

Does the category exist, and is it a directory?

$category->exists();

is_blacklisted

Does the category name appear on a blacklist meaning auto-scan should ignore this?

::Category->new( name => '..', overlay => $overlay )->is_blacklisted  # true

pretty_name

A pretty form of the name.

$category->pretty_name  # dev-perl/::gentoo

ATTRIBUTES

name

The classes short name

isa => Str, required, ro

MooseX::Types::Moose

overlay

The overlay it is in.

isa => Gentoo__Overlay_Overlay, required, coerce

"Gentoo__Overlay_Overlay" in Gentoo::Overlay::Types

path

The full path to the category

isa => Dir, lazy_build, ro

"Dir" in MooseX::Types::Path::Class

PRIVATE CLASS ATTRIBUTES

_scan_blacklist

Class-Wide list of blacklisted directory names.

isa => HashRef[ Str ], ro, lazy_build,

accessors => _scan_blacklisted

"_scan_blacklisted"

MooseX::Types::Moose

PRIVATE CLASS ATTRIBUTE ACCESSORS

_scan_blacklisted

is $arg blacklisted in the Class Wide Blacklist?

::Category->_scan_blacklisted( $arg )
   ->
exists ::Category->_scan_blacklist->{$arg}

"_scan_blacklist"

PRIVATE METHODS

_build_path

Generates the path by asking the overlay what the path should be for the category.

$category->_build_path();
  ->
$overlay->default_path('category', $category->name );

PRIVATE CLASS METHODS

_build__scan_blacklist

Generates the default list of blacklisted items for the class-wide record.

::Category->_build__scan_blacklist()

AUTHOR

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Kent Fredric <kentnl@cpan.org>.

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