File Coverage

blib/lib/SPVM/Builder/Resource.pm

Criterion	Covered	Total	%
statement	43	48	89.5
branch	8	10	80.0
condition	1	3	33.3
subroutine	14	14	100.0
pod	6	6	100.0
total	72	81	88.8

package SPVM::Builder::Resource;

use strict;
use warnings;
use Config;
use Carp 'confess';
use File::Basename 'dirname';

use overload bool => sub {1}, '""' => sub { shift->to_string }, fallback => 1;

# Fields
sub class_name {
  my $self = shift;
  if (@_) {
    $self->{class_name} = $_[0];
    return $self;
  }
  else {
    return $self->{class_name};
  }
}

sub mode {
  my $self = shift;
  if (@_) {
    $self->{mode} = $_[0];
    return $self;
  }
  else {
    return $self->{mode};
  }
}

sub argv {
  my $self = shift;
  if (@_) {
    $self->{argv} = $_[0];
    return $self;
  }
  else {
    return $self->{argv};
  }
}

sub config {
  my $self = shift;
  if (@_) {
    $self->{config} = $_[0];
    return $self;
  }
  else {
    return $self->{config};
  }
}

# Methods
sub new {
  my $class = shift;

  my $self = {@_};

  bless $self, ref $class || $class;

  unless ($self->argv) {
    $self->argv([]);
  }

  return $self;
}

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

  return $self->class_name;
}

1;

=head1 Name

SPVM::Builder::Resource - Resource

=head1 Description

The SPVM::Builder::Resource class has methods to manipulate a resource.

=head1 Usage

  my $resource = SPVM::Builder::Resource->new(
    class_name => 'Resource::Zlib',
    mode => 'high_performance',
    argv => ['foo', 'bar'],
  );

=head1 Fields

=head2 class_name

  my $basic_type_name = $resource->class_name;
  $resource->class_name($basic_type_name);

Gets and sets the C field.

This field is a class name of a resource.

=head2 mode

  my $mode = $resource->mode;
  $resource->mode($mode);

Gets and sets the C field.

This field is a mode of a config file of a resource.

=head2 argv

  my $argv = $resource->argv;
  $resource->argv($argv);

Gets and sets the C field.

This field is an array reference that contains command line arguments C<@ARGV> of a config file of a resource.

=head2 config

  my $config = $resource->config;
  $resource->config($config);

Gets and sets the C field.

This field is a a L object for a resource.

=head1 Class Methods

=head2 new

  my $resource = SPVM::Builder::Resource->new(%fields);

Creates a L object with L.

Default Field Values:

If a field is not defined, the field is set to the following default value.

=over 2

=item * L

undef

=item * L

undef

=item * L

[]

=item * L

undef

=back

=head1 Instance Methods

=head2 to_string

  my $string = $resource->to_string;

Returns the L field.

=head1 Operators

Overloads the following operators.

=head2 bool

  my $bool = !!$resource;

Always true.

=head2 stringify

  my $basic_type_name = "$resource";

The alias for the L method.

=head1 Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License