lib/Data/MultiValued/Ranges.pm


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

package Data::MultiValued::Ranges; 
BEGIN {
  $Data::MultiValued::Ranges::VERSION = '0.0.1';
}
BEGIN {
  $Data::MultiValued::Ranges::DIST = 'Data-MultiValued';
}
use Moose;
use MooseX::Params::Validate;
use Moose::Util::TypeConstraints;
use MooseX::Types::Moose qw(Num Str Undef Any);
use Data::MultiValued::Exceptions;
use Data::MultiValued::RangeContainer;
 
# ABSTRACT: Handle values with validity ranges 
 
 
has _storage => (
    is => 'rw',
    isa => class_type('Data::MultiValued::RangeContainer'),
    init_arg => undef,
    lazy_build => 1,
);
 
sub _build__storage {
    Data::MultiValued::RangeContainer->new();
}
 
sub _rebless_storage {
    my ($self) = @_;
 
    bless $self->{_storage},'Data::MultiValued::RangeContainer';
}
 
sub _as_hash {
    my ($self) = @_;
 
    my %ret = %{$self->_storage};
    return {_storage=>\%ret};
}
 
 
sub set {
    my ($self,%args) = validated_hash(
        \@_,
        from => { isa => Num|Undef, optional => 1, },
        to => { isa => Num|Undef, optional => 1, },
        value => { isa => Any, },
    );
 
    $self->_storage->set_or_create(\%args)
         ->{value} = $args{value};
}
 
 
sub get {
    my ($self,%args) = validated_hash(
        \@_,
        at => { isa => Num|Undef, optional => 1, },
    );
 
    $self->_storage->get(\%args)
         ->{value};
}
 
 
sub clear {
    my ($self,%args) = validated_hash(
        \@_,
        from => { isa => Num|Undef, optional => 1, },
        to => { isa => Num|Undef, optional => 1, },
    );
 
    $self->_storage->clear(\%args);
}
 
1;
 
__END__
=pod
 
=head1 NAME
 
Data::MultiValued::Ranges - Handle values with validity ranges
 
=head1 VERSION
 
version 0.0.1
 
=head1 SYNOPSIS
 
  use Data::MultiValued::Ranges;
 
  my $obj = Data::MultiValued::Ranges->new();
  $obj->set({
    from => 10,
    to => 20,
    value => 'foo',
  });
  say $obj->get({at => 15}); # prints 'foo'
  say $obj->get({at => 35}); # dies
 
=head1 METHODS
 
=head2 C<set>
 
  $obj->set({ from => $min, to => $max, value => $the_value });
 
Stores the given value for the given range. Does not throw exceptions.
 
The range is defined as C<< Num $x : $min <= $x < $max >>.
 
If the given range intersects existing ranges, these are spliced to
avoid overlaps. In other words:
 
  $obj->set({
    from => 10,
    to => 20,
    value => 'foo',
  });
  $obj->set({
    from => 15,
    to => 25,
    value => 'bar',
  });
  say $obj->get({at => 12}); # prints 'foo'
  say $obj->get({at => 15}); # prints 'bar'
  say $obj->get({at => 25}); # dies
 
No cloning is done: if you pass in a reference, the reference is
just stored.
 
=head2 C<get>
 
  my $value = $obj->get({ at => $point });
 
Retrieves the value for the given point. Throws a
L<Data::MultiValued::Exceptions::RangeNotFound> exception if no ranges
exist in this object that include the point (remember that a range
does not include its C<to> point).
 
No cloning is done: if a reference was stored, you get it back
untouched.
 
=head2 C<clear>
 
  $obj->clear({ from => $min, to => $max });
 
Deletes all values for the given range. Does not throw exceptions.
 
If the given range intersects existing ranges, these are spliced. In
other words:
 
  $obj->set({
    from => 10,
    to => 20,
    value => 'foo',
  });
  $obj->clear({
    from => 15,
    to => 25,
  });
  say $obj->get({at => 12}); # prints 'foo'
  say $obj->get({at => 15}); # dies
 
=head1 AUTHOR
 
Gianni Ceccarelli <dakkar@thenautilus.net>
 
=head1 COPYRIGHT AND LICENSE
 
This software is copyright (c) 2011 by Net-a-porter.com.
 
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
 
=cut