Mode/Single.pm

filter: Statementstmt 95.2% 20 / 21 Branchbran 50.0% 2 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 90.0% 9 / 10 Podpod 100% 6 / 6 totaltotal 90.2% 37 / 41 CC 3 SCAR 3.6
CC
3
Cov
88%
new
2.1
as_string
2.1
__ANON__
2.0
CRAP 1.4
« Toolkit/Role/CaseMap.pm ↑ Summary Toolkit/CTCP.pm »
1 package IRC::Mode::Single;
2 2 $IRC::Mode::Single::VERSION = '0.092002';
3 2 ▶use strictures 2;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 =pod
7  
8 =for Pod::Coverage FLAG MODE PARAM
9  
10 =cut
11  
12 sub FLAG () { 0 }
13 sub MODE () { 1 }
14 sub PARAM () { 2 }
15  
16 use overload
17 0 ▶ bool => sub { 1 },
Subroutine BEGIN: called CC=1 SCAR=0.2
Subroutine __ANON__: not called CC=1 SCAR=6.9
18 2 '""' => 'as_string',
19 2 fallback => 1;
20  
21  
22 6 ▶sub new {
Subroutine new: called CC=2 SCAR=7.2
Pod documented
23 6 ▶ confess "Expected at least a flag and mode" unless @_ >= 3;
Branch: 1 branch
BranchTrueFalseTotal
unless @_ >= 3 0 6 6
24 6 bless [ @_[1 .. $#_] ], $_[0]
25 }
26  
27 1 ▶sub flag { $_[0]->[FLAG] }
Subroutine flag: called CC=1 SCAR=0.0
Pod documented
28 1 ▶sub char { $_[0]->[MODE] }
Subroutine char: called CC=1 SCAR=0.0
Pod documented
29 1 ▶sub param { $_[0]->[PARAM] }
Subroutine param: called CC=1 SCAR=0.0
Pod documented
30  
31 2 ▶sub as_string {
Subroutine as_string: called CC=2 SCAR=7.2
Pod documented
32 2 my ($self) = @_;
33 2 ▶ $self->[FLAG] . $self->[MODE]
Branch: 1 branch
BranchTrueFalseTotal
defined $self->[2] ? : 2 0 2
34 . (defined $self->[PARAM] ? ' '.$self->[PARAM] : '')
35 }
36  
37 1 ▶sub export { [ @{$_[0]} ] }
Subroutine export: called CC=1 SCAR=0.0
Pod documented
38  
39 2 1;
40  
41 =pod
42  
43 =head1 NAME
44  
45 IRC::Mode::Single - A single IRC mode change
46  
47 =head1 SYNOPSIS
48  
49 my $mode = IRC::Mode::Single->new(
50 '+', 'o', 'avenj'
51 );
52  
53 my $flag = $mode->flag;
54 my $mode = $mode->char;
55 my $arg = $mode->param;
56  
57 =head1 DESCRIPTION
58  
59 A simple ARRAY-type object representing a single mode change.
60 These objects stringify into an IRC mode string.
61  
62 Can be used to turn L<IRC::Toolkit::Modes/mode_to_array> mode ARRAYs
63 into objects:
64  
65 for my $mset (@$mode_array) {
66 my $this_mode = IRC::Mode::Single->new( @$mset );
67 . . .
68 }
69  
70 Also see L<IRC::Mode::Set>
71  
72 =head2 new
73  
74 Constructs a new mode change; expects at least a flag and mode.
75  
76 =head2 char
77  
78 The mode character.
79  
80 =head2 flag
81  
82 The '-' or '+' flag for this mode change.
83  
84 =head2 param
85  
86 The parameter attached to the mode, if any.
87  
88 =head2 as_string
89  
90 Produces a mode string (with params attached) for this single mode change.
91  
92 =head2 export
93  
94 Retrieve the backing ARRAY without bless/overload magic.
95  
96 =head1 AUTHOR
97  
98 Jon Portnoy <avenj@cobaltirc.org>
99  
100 =cut
« Toolkit/Role/CaseMap.pm ↑ Summary Toolkit/CTCP.pm »