File Coverage

blib/lib/Hash/DefHash.pm

Criterion	Covered	Total	%
statement	220	242	90.9
branch	97	130	74.6
condition	51	76	67.1
subroutine	30	38	78.9
pod	31	31	100.0
total	429	517	82.9

## no critic: Modules::ProhibitAutomaticExportation

package Hash::DefHash;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-07-21'; # DATE
our $DIST = 'Hash-DefHash'; # DIST
our $VERSION = '0.072'; # VERSION

use 5.010001;
use strict;
use warnings;

use Regexp::Pattern::DefHash;
use Scalar::Util qw(blessed);
use String::Trim::More qw(trim_blank_lines);

use Exporter qw(import);
our @EXPORT = qw(defhash);

our $re_prop = $Regexp::Pattern::DefHash::RE{prop}{pat};
our $re_attr = $Regexp::Pattern::DefHash::RE{attr}{pat};
our $re_attr_part = $Regexp::Pattern::DefHash::RE{attr_part}{pat};
our $re_key  = $Regexp::Pattern::DefHash::RE{key} {pat};

sub defhash {
    # avoid wrapping twice if already a defhash
    return $_[0] if blessed($_[0]) && $_[0]->isa(__PACKAGE__);

    __PACKAGE__->new(@_);
}

sub new {
    my $class = shift;

    my ($hash, %opts) = @_;
    $hash //= {};

    my $self = bless {hash=>$hash, parent=>$opts{parent}}, $class;
    if ($opts{check} // 1) {
        $self->check;
    }
    $self;
}

sub hash {
    my $self = shift;

    $self->{hash};
}

sub check {
    my $self = shift;
    my $h = $self->{hash};

    for my $k (keys %$h) {
        next if $k =~ $re_key;
        die "Invalid hash key '$k'";
    }
    1;
}

sub contents {
    my $self = shift;
    my $h = $self->{hash};

    my %props;
    for my $k (keys %$h) {
        my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
            or die "Invalid hash key '$k'";
        my $v = $h->{$k};
        if (defined $p_prop) {
            next if $p_prop =~ /\A_/;
            $props{$p_prop} //= {};
            $props{$p_prop}{''} = $v;
        } else {
            next if $p_attr =~ /(?:\A|\.)_/;
            $props{$p_prop_of_attr // ""}{$p_attr} = $v;
        }
    }
    %props;
}

sub props {
    my $self = shift;
    my $h = $self->{hash};

    my %props;
    for my $k (keys %$h) {
        my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
            or die "Invalid hash key '$k'";
        next unless defined $p_prop;
        next if $p_prop =~ /\A_/;
        $props{$p_prop}++;
    }
    sort keys %props;
}

sub prop {
    my ($self, $prop, $opts) = @_;
    $opts //= {};

    my $opt_die = $opts->{die} // 1;
    my $opt_mark_different_lang = $opts->{mark_different_lang} // 0;
    my $h = $self->{hash};

    if ($opts->{alt}) {
        my %alt = %{ $opts->{alt} };
        my $default_lang = $self->default_lang;
        $alt{lang} //= $default_lang;
        my $has_v_different_lang;
        my $v_different_lang;
        my $different_lang;
      KEY:
        for my $k (keys %$h) {
            my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
                or die "Invalid hash key '$k'";
            my %prop_alt;
            if (defined $p_prop) {
                next unless $p_prop eq $prop;
                %prop_alt = (lang=>$default_lang);
            } else {
                next unless $p_prop_of_attr eq $prop;
                next unless $p_attr =~ /\Aalt\./;
                my @attr_elems = split /\./, $p_attr;
                shift @attr_elems; # the "alt"
                while (my ($k2, $v2) = splice @attr_elems, 0, 2) {
                    $prop_alt{$k2} = $v2;
                }
                $prop_alt{lang} //= $default_lang;
            }

            if ($opt_mark_different_lang) {
                for my $an (keys %alt) {
                    next if $an eq 'lang';
                    next KEY unless defined $prop_alt{$an};
                    next KEY unless $prop_alt{$an} eq $alt{$an};
                }
                if ($alt{lang} eq $prop_alt{lang}) {
                    return $h->{$k};
                } elsif (!$has_v_different_lang) {
                    $has_v_different_lang = 1;
                    $v_different_lang = $h->{$k};
                    $different_lang = $prop_alt{lang};
                }
            } else {
                for my $an (keys %alt) {
                    next KEY unless defined $prop_alt{$an};
                    next KEY unless $prop_alt{$an} eq $alt{$an};
                }
                return $h->{$k};
            }
        }

        if ($opt_mark_different_lang && $has_v_different_lang) {
            return "{$different_lang $v_different_lang}";
        } else {
            die "Property '$prop' (with requested alt ".join(".", %alt).") not found" if $opt_die;
            return undef;
        }
    } else {
        die "Property '$prop' not found" if !(exists $h->{$prop}) && $opt_die;
        return $h->{$prop};
    }
}

sub get_prop {
    my ($self, $prop, $opts) = @_;
    $opts = !defined($opts) ? {} : {%$opts};

    $opts->{die} = 0;
    $self->prop($prop, $opts);
}

sub prop_exists {
    my ($self, $prop) = @_;
    my $h = $self->{hash};

    exists $h->{$prop};
}

sub add_prop {
    my ($self, $prop, $val) = @_;
    my $h = $self->{hash};

    die "Invalid property name '$prop'" unless $prop =~ $re_prop;
    die "Property '$prop' already exists" if exists $h->{$prop};
    $h->{$prop} = $val;
}

sub set_prop {
    my ($self, $prop, $val) = @_;
    my $h = $self->{hash};

    die "Invalid property name '$prop'" unless $prop =~ $re_prop;
    if (exists $h->{$prop}) {
        my $old = $h->{$prop};
        $h->{$prop} = $val;
        return $old;
    } else {
        $h->{$prop} = $val;
        return undef;
    }
}

sub del_prop {
    my ($self, $prop, $val) = @_;
    my $h = $self->{hash};

    die "Invalid property name '$prop'" unless $prop =~ $re_prop;
    if (exists $h->{$prop}) {
        return delete $h->{$prop};
    } else {
        return undef;
    }
}

sub del_all_props {
    my ($self, $delattrs) = @_;
    my $h = $self->{hash};

    for my $k (keys %$h) {
        my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
            or die "Invalid hash key '$k'";
        next if defined $p_prop && $p_prop =~ /\A_/;
        next if defined $p_attr && $p_attr =~ /(?:\A|\.)_/;
        if (defined $p_attr) {
            delete $h->{$k} if $delattrs;
        } else {
            delete $h->{$k};
        }
    }
}

sub attrs {
    my ($self, $prop) = @_;
    $prop //= "";
    my $h = $self->{hash};

    unless ($prop eq '') {
        die "Invalid property name '$prop'" unless $prop =~ $re_prop;
    }

    my %attrs;
    for my $k (keys %$h) {
        my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
            or die "Invalid hash key '$k'";
        next if defined $p_prop;
        my $v = $h->{$k};
        $p_prop_of_attr //= "";
        next unless $p_prop_of_attr eq $prop;
        next if $p_attr =~ /(?:\A|\.)_/;
        $attrs{$p_attr} = $v;
    }
    %attrs;
}

sub attr {
    my ($self, $prop, $attr) = @_;
    $prop //= "";
    my $h = $self->{hash};

    my $k = "$prop.$attr";
    die "Attribute '$attr' for property '$prop' not found" if !exists($h->{$k});
    $h->{$k};
}

sub get_attr {
    my ($self, $prop, $attr) = @_;
    $prop //= "";
    my $h = $self->{hash};

    my $k = "$prop.$attr";
    $h->{$k};
}

sub attr_exists {
    my ($self, $prop, $attr) = @_;
    $prop //= "";
    my $h = $self->{hash};

    my $k = "$prop.$attr";
    exists $h->{$k};
}

sub add_attr {
    my ($self, $prop, $attr, $val) = @_;
    $prop //= "";
    my $h = $self->{hash};

    if ($prop ne '') {
        die "Invalid property name '$prop'"  unless $prop =~ $re_prop;
    }
    die "Invalid attribute name '$attr'" unless $attr =~ $re_attr_part;
    my $k = "$prop.$attr";
    die "Attribute '$attr' for property '$prop' already exists"
        if exists($h->{$k});
    $h->{$k} = $val;
}

sub set_attr {
    my ($self, $prop, $attr, $val) = @_;
    $prop //= "";
    my $h = $self->{hash};

    if ($prop ne '') {
        die "Invalid property name '$prop'"  unless $prop =~ $re_prop;
    }
    die "Invalid attribute name '$attr'" unless $attr =~ $re_attr_part;
    my $k = "$prop.$attr";
    if (exists($h->{$k})) {
        my $old = $h->{$k};
        $h->{$k} = $val;
        return $old;
    } else {
        $h->{$k} = $val;
        return undef;
    }
}

sub del_attr {
    my ($self, $prop, $attr) = @_;
    $prop //= "";
    my $h = $self->{hash};

    if ($prop ne '') {
        die "Invalid property name '$prop'"  unless $prop =~ $re_prop;
    }
    die "Invalid attribute name '$attr'" unless $attr =~ $re_attr_part;
    my $k = "$prop.$attr";
    if (exists($h->{$k})) {
        return delete $h->{$k};
    } else {
        return undef;
    }
}

sub del_all_attrs {
    my ($self, $prop) = @_;
    $prop //= "";
    my $h = $self->{hash};

    for my $k (keys %$h) {
        my ($p_prop, $p_prop_of_attr, $p_attr) = $k =~ $re_key
            or die "Invalid hash key '$k'";
        next if defined $p_prop;
        $p_prop_of_attr //= "";
        next if $p_attr =~ /(?:\A|\.)_/;
        next unless $p_prop_of_attr eq $prop;
        delete $h->{$k};
    }
}

sub defhash_v {
    my ($self) = @_;
    $self->get_prop('defhash_v') // 1;
}

sub v {
    my ($self) = @_;
    $self->get_prop('v') // 1;
}

sub default_lang {
    my ($self) = @_;
    my $par;
    if ($self->{parent}) {
        $par = $self->{parent}->default_lang;
    }
    my $res = $self->get_prop('default_lang') // $par // $ENV{LANG} // "en_US";
    $res = "en_US" if $res eq "C";
    $res;
}

sub name {
    my ($self) = @_;
    $self->get_prop('name');
}

sub summary {
    my ($self) = @_;
    $self->get_prop('summary');
}

sub description {
    my ($self) = @_;
    $self->get_prop('description');
}

sub tags {
    my ($self) = @_;
    $self->get_prop('tags');
}

sub get_prop_lang {
    my ($self, $prop, $lang, $opts) = @_;
    my $h = $self->{hash};
    $opts = !defined($opts) ? {} : {%$opts};

    $opts->{die} //= 0;
    $opts->{alt} //= {};
    $opts->{alt}{lang} //= $lang;
    $opts->{mark_different_lang} //= 1;
    $self->prop($prop, $opts);
}

sub get_prop_all_langs {
    die "Not yet implemented";
}

sub set_prop_lang {
    die "Not yet implemented";
}

1;
# ABSTRACT: Manipulate defhash

__END__