lib/SGN/Feature.pm

   1 package SGN::Feature;
   2 use Moose;
   3
   4 use namespace::autoclean;
   5 use File::Spec;
   6
   7 # our context object
   8 has 'context' => (
   9     documentation => 'our context class',
  10
  11     is => 'ro',
  12     does => 'SGN::Role::Site::SiteFeatures',
  13     required => 1,
  14     weak_ref => 1,
  15    );
  16 has 'enabled' => (
  17     documentation => 'boolean flag, whether this feature is enabled',
  18
  19     is => 'ro',
  20     isa => 'Bool',
  21     default => 0,
  22 );
  23
  24 sub feature_name {
  25     my $self = shift;
  26     my $name = ref( $self ) || $self;
  27     $name =~ s/.+:://;
  28     return lc $name;
  29 }
  30
  31 has 'description' => (
  32     documentation => <<'',
  33 short plaintext description of the feature, user-visible.  May be used in default views for crossreferences and so forth.
  34
  35     is => 'ro',
  36     isa => 'Str',
  37     default => sub { ucfirst shift->feature_name },
  38    );
  39
  40 has 'feature_dir' => (
  41     is => 'ro',
  42     isa => 'Path::Class::Dir',
  43     coerce => 1,
  44     lazy_build => 1,
  45    ); sub _build_feature_dir {
  46        my $self = shift;
  47        return $self->context->path_to( 'features', $self->feature_name )->stringify;
  48    }
  49
  50 sub path_to {
  51     my $self = shift;
  52     return File::Spec->catfile( $self->feature_dir, @_ );
  53 }
  54
  55 sub tmpdir {
  56     my $self = shift;
  57     return $self->context->tempfiles_base->subdir( 'features', $self->feature_name );
  58 }
  59
  60 # called on application restart
  61 sub setup {
  62 }
  63
  64 # return one or more SGN::SiteFeature::CrossReference objects for the
  65 # given input (input can be anything) or nothing if the query is not
  66 # handled by this Feature.  note that a CrossReference object should
  67 # always be returned, it just might be empty
  68 sub xrefs {
  69 }
  70
  71 sub apache_conf {
  72     return ''
  73 }
  74
  75 __PACKAGE__->meta->make_immutable;
  76 1;