File Coverage

blib/lib/License/SPDX.pm

Criterion	Covered	Total	%
statement	88	88	100.0
branch	28	28	100.0
condition			n/a
subroutine	23	23	100.0
pod	9	9	100.0
total	148	148	100.0

package License::SPDX;

use strict;
use warnings;

use Class::Utils qw(set_params);
use Cpanel::JSON::XS;
use Error::Pure qw(err);
use File::Share ':all';
use List::Util qw(first);
use Perl6::Slurp qw(slurp);

our $VERSION = 0.07;

# Constructor.
sub new {
	my ($class, @params) = @_;

	# Create object.
	my $self = bless {}, $class;

	# Process parameters.
	set_params($self, @params);

	# Load all SPDX licenses.
	open my $data_fh, '<', dist_dir('License-SPDX').'/licenses.json';
	my $data = slurp($data_fh);
	$self->{'licenses'} = Cpanel::JSON::XS->new->ascii->pretty->allow_nonref->decode($data);

	# Load all SPDX exceptions.
	open my $data_exc_fh, '<', dist_dir('License-SPDX').'/exceptions.json';
	my $data_exc = slurp($data_exc_fh);
	$self->{'exceptions'} = Cpanel::JSON::XS->new->ascii->pretty->allow_nonref->decode($data_exc);

	return $self;
}

sub check_exception {
	my ($self, $check_string, $opts_hr) = @_;

	if (! defined $opts_hr) {
		$opts_hr = {};
	}
	if (! exists $opts_hr->{'check_type'}) {
		$opts_hr->{'check_type'} = 'id';
	}

	my $check_cb = sub {
		my $exception_hr = shift;
		if ($opts_hr->{'check_type'} eq 'id') {
			if ($check_string eq $exception_hr->{'licenseExceptionId'}) {
				return 1;
			}
		} elsif ($opts_hr->{'check_type'} eq 'name') {
			if ($check_string eq $exception_hr->{'name'}) {
				return 1;
			}
		} else {
			err "Check type '$opts_hr->{'check_type'}' doesn't supported.";
		}
	};

	if (first { $check_cb->($_); } @{$self->{'exceptions'}->{'exceptions'}}) {
		return 1;
	} else {
		return 0;
	}
}

sub check_license {
	my ($self, $check_string, $opts_hr) = @_;

	if (! defined $opts_hr) {
		$opts_hr = {};
	}
	if (! exists $opts_hr->{'check_type'}) {
		$opts_hr->{'check_type'} = 'id';
	}

	my $check_cb = sub {
		my $license_hr = shift;
		if ($opts_hr->{'check_type'} eq 'id') {
			if ($check_string eq $license_hr->{'licenseId'}) {
				return 1;
			}
		} elsif ($opts_hr->{'check_type'} eq 'name') {
			if ($check_string eq $license_hr->{'name'}) {
				return 1;
			}
		} else {
			err "Check type '$opts_hr->{'check_type'}' doesn't supported.";
		}
	};

	if (first { $check_cb->($_); } @{$self->{'licenses'}->{'licenses'}}) {
		return 1;
	} else {
		return 0;
	}
}

sub exception {
	my ($self, $exception_id) = @_;

	return first { $_->{'licenseExceptionId'} eq $exception_id } @{$self->{'exceptions'}->{'exceptions'}};
}

sub exceptions {
	my $self = shift;

	return @{$self->{'exceptions'}->{'exceptions'}};
}

sub license {
	my ($self, $license_id) = @_;

	return first { $_->{'licenseId'} eq $license_id } @{$self->{'licenses'}->{'licenses'}};
}

sub licenses {
	my $self = shift;

	return @{$self->{'licenses'}->{'licenses'}};
}

sub spdx_release_date {
	my $self = shift;

	return $self->{'licenses'}->{'releaseDate'};
}

sub spdx_version {
	my $self = shift;

	return $self->{'licenses'}->{'licenseListVersion'};
}

1;

__END__