DBIx/Class/UTF8Columns.pm

filter: Statementstmt 100% 35 / 35 Branchbran 90.0% 9 / 10 Conditioncond 65.3% 17 / 26 MC/DCmcdc 30.7% 4 / 13 Subroutinesub 100% 8 / 8 Podpod 100% 4 / 4 totaltotal 80.2% 77 / 96 CC 17 SCAR 14.7
CC
17
Cov
86%
get_columns
6.6
store_column
5.0
get_column
4.1
CRAP 4.3
« DBIx/Class/Storage.pm ↑ Summary DBIx/Class/Storage/DBI/ADO/MS_Jet.pm »
1 package DBIx::Class::UTF8Columns;
2 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 4 ▶use base qw/DBIx::Class/;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 4 __PACKAGE__->mk_classdata( '_utf8_columns' );
7  
8 =head1 NAME
9  
10 DBIx::Class::UTF8Columns - Force UTF8 (Unicode) flag on columns (DEPRECATED)
11  
12 =head1 SYNOPSIS
13  
14 package Artist;
15 use base 'DBIx::Class::Core';
16  
17 __PACKAGE__->load_components(qw/UTF8Columns/);
18 __PACKAGE__->utf8_columns(qw/name description/);
19  
20 # then belows return strings with utf8 flag
21 $artist->name;
22 $artist->get_column('description');
23  
24 =head1 DESCRIPTION
25  
26 This module allows you to get and store utf8 (unicode) column data
27 in a database that does not natively support unicode. It ensures
28 that column data is correctly serialised as a byte stream when
29 stored and de-serialised to unicode strings on retrieval.
30  
31 THE USE OF THIS MODULE (AND ITS COUSIN DBIx::Class::ForceUTF8) IS VERY
32 STRONGLY DISCOURAGED, PLEASE READ THE WARNINGS BELOW FOR AN EXPLANATION.
33  
34 If you want to continue using this module and do not want to receive
35 further warnings set the environment variable C<DBIC_UTF8COLUMNS_OK>
36 to a true value.
37  
38 =head2 Warning - Module does not function properly on create/insert
39  
40 Recently (April 2010) a bug was found deep in the core of L<DBIx::Class>
41 which affects any component attempting to perform encoding/decoding by
42 overloading L<store_column|DBIx::Class::Row/store_column> and
43 L<get_columns|DBIx::Class::Row/get_columns>. As a result of this problem
44 L<create|DBIx::Class::ResultSet/create> sends the original column values
45 to the database, while L<update|DBIx::Class::ResultSet/update> sends the
46 encoded values. L<DBIx::Class::UTF8Columns> and L<DBIx::Class::ForceUTF8>
47 are both affected by this bug.
48  
49 It is unclear how this bug went undetected for so long (it was
50 introduced in March 2006), No attempts to fix it will be made while the
51 implications of changing such a fundamental behavior of DBIx::Class are
52 being evaluated. However in this day and age you should not be using
53 this module anyway as Unicode is properly supported by all major
54 database engines, as explained below.
55  
56 If you have specific questions about the integrity of your data in light
57 of this development - please
58 L<join us on IRC or the mailing list|DBIx::Class/GETTING HELP/SUPPORT>
59 to further discuss your concerns with the team.
60  
61 =head2 Warning - Native Database Unicode Support
62  
63 If your database natively supports Unicode (as does SQLite with the
64 C<sqlite_unicode> connect flag, MySQL with C<mysql_enable_utf8>
65 connect flag or Postgres with the C<pg_enable_utf8> connect flag),
66 then this component should B<not> be used, and will corrupt unicode
67 data in a subtle and unexpected manner.
68  
69 It is far better to do Unicode support within the database if
70 possible rather than converting data to and from raw bytes on every
71 database round trip.
72  
73 =head2 Warning - Component Overloading
74  
75 Note that this module overloads L<DBIx::Class::Row/store_column> in a way
76 that may prevent other components overloading the same method from working
77 correctly. This component must be the last one before L<DBIx::Class::Row>
78 (which is provided by L<DBIx::Class::Core>). DBIx::Class will detect such
79 incorrect component order and issue an appropriate warning, advising which
80 components need to be loaded differently.
81  
82 =head1 SEE ALSO
83  
84 L<Template::Stash::ForceUTF8>, L<DBIx::Class::UUIDColumns>.
85  
86 =head1 METHODS
87  
88 =head2 utf8_columns
89  
90 =cut
91  
92 32 ▶sub utf8_columns {
Subroutine utf8_columns: called CC=4 SCAR=13.9
Pod documented
93 32 my $self = shift;
94 32 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 1 31 32
95 1 foreach my $col (@_) {
96 1 ▶ $self->throw_exception("column $col doesn't exist")
Branch: 1 branch
BranchTrueFalseTotal
unless $self->has_column($col) 0 1 1
97 unless $self->has_column($col);
98 }
99 1 return $self->_utf8_columns({ map { $_ => 1 } @_ });
100 } else {
101 31 return $self->_utf8_columns;
102 }
103 }
104  
105 =head1 EXTENDED METHODS
106  
107 =head2 get_column
108  
109 =cut
110  
111 19 ▶sub get_column {
Subroutine get_column: called CC=4 SCAR=14.0
Pod documented
112 19 my ( $self, $column ) = @_;
113 19 my $value = $self->next::method($column);
114  
115 19 ▶ utf8::decode($value) if (
Branch: 1 branch
BranchTrueFalseTotal
if defined $value and $self->_is_utf8_column($column) and not utf8::is_utf8($value) 9 10 19
Condition66%4/6
defined $value and $self->_is_utf8_column($column) and not utf8::is_utf8($value)
!ll&&!rl&&r
1009
defined $value and $self->_is_utf8_column($column)
!ll&&!rl&&r
0109
MC/DC33%1/3
defined $value and $self->_is_utf8_column($column) and not utf8::is_utf8($value)
defined $value $self->_is_utf8_column($column) not utf8::is_utf8($value)
Truth table50%2/4
A and B and not(C)
A= defined $valueB= $self->_is_utf8_column($column)C= not utf8::is_utf8($value)
ABCresult
0XX0
10X0
1100
1111
116 defined $value and $self->_is_utf8_column($column) and ! utf8::is_utf8($value)
117 );
118  
119 19 return $value;
120 }
121  
122 =head2 get_columns
123  
124 =cut
125  
126 1 ▶sub get_columns {
Subroutine get_columns: called CC=6 SCAR=18.8
Pod documented
127 1 my $self = shift;
128 1 my %data = $self->next::method(@_);
129  
130 1 foreach my $col (keys %data) {
131 utf8::decode($data{$col}) if (
132 3 ▶ exists $data{$col} and defined $data{$col} and $self->_is_utf8_column($col) and ! utf8::is_utf8($data{$col})
Branch: 1 branch
BranchTrueFalseTotal
if exists $data{$col} and defined $data{$col} and $self->_is_utf8_column($col) and not utf8::is_utf8($data{$col}) 1 2 3
Condition55%5/9
exists $data{$col} and defined $data{$col} and $self->_is_utf8_column($col) and not utf8::is_utf8($data{$col})
!ll&&!rl&&r
201
exists $data{$col} and defined $data{$col} and $self->_is_utf8_column($col)
!ll&&!rl&&r
021
exists $data{$col} and defined $data{$col}
!ll&&!rl&&r
003
MC/DC25%1/4
exists $data{$col} and defined $data{$col} and $self->_is_utf8_column($col) and not utf8::is_utf8($data{$col})
exists $data{$col} defined $data{$col} $self->_is_utf8_column($col) not utf8::is_utf8($data{$col})
Truth table40%2/5
A and B and C and not(D)
A= exists $data{$col}B= defined $data{$col}C= $self->_is_utf8_column($col)D= not utf8::is_utf8($data{$col})
ABCDresult
0XXX0
10XX0
110X0
11100
11111
133 );
134 }
135  
136 1 return %data;
137 }
138  
139 =head2 store_column
140  
141 =cut
142  
143 9 ▶sub store_column {
Subroutine store_column: called CC=5 SCAR=16.2
Pod documented
144 9 my ( $self, $column, $value ) = @_;
145  
146 # the dirtiness comparison must happen on the non-encoded value
147 9 my $copy;
148  
149 9 ▶ if ( defined $value and $self->_is_utf8_column($column) and utf8::is_utf8($value) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value and $self->_is_utf8_column($column) and utf8::is_utf8($value)) 4 5 9
Condition83%5/6
defined $value and $self->_is_utf8_column($column) and utf8::is_utf8($value)
!ll&&!rl&&r
324
defined $value and $self->_is_utf8_column($column)
!ll&&!rl&&r
036
MC/DC66%2/3
defined $value and $self->_is_utf8_column($column) and utf8::is_utf8($value)
defined $value $self->_is_utf8_column($column) utf8::is_utf8($value)
Truth table75%3/4
A and B and C
A= defined $valueB= $self->_is_utf8_column($column)C= utf8::is_utf8($value)
ABCresult
0XX0
10X0
1100
1111
150 4 $copy = $value;
151 4 utf8::encode($value);
152 }
153  
154 9 $self->next::method( $column, $value );
155  
156 9 ▶ return $copy || $value;
Condition66%2/3
$copy || $value
l!l&&r!l&&!r
450
MC/DC0%0/2
$copy || $value
$copy $value
Truth table66%2/3
A || B
A= $copyB= $value
ABresult
1X1
011
000
157 }
158  
159 # override this if you want to force everything to be encoded/decoded
160 31 ▶sub _is_utf8_column {
Subroutine _is_utf8_column: called CC=2 SCAR=7.6
161 # my ($self, $col) = @_;
162 31 ▶ return ($_[0]->utf8_columns || {})->{$_[1]};
Condition50%1/2
$_[0]->utf8_columns || {}
l!l
310
MC/DC0%0/1
$_[0]->utf8_columns || {}
$_[0]->utf8_columns
Truth table50%1/2
A
A= $_[0]->utf8_columns
Aresult
11
00
163 }
164  
165 =head1 FURTHER QUESTIONS?
166  
167 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
168  
169 =head1 COPYRIGHT AND LICENSE
170  
171 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
172 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
173 redistribute it and/or modify it under the same terms as the
174 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
175  
176 =cut
177  
178 4 1;
« DBIx/Class/Storage.pm ↑ Summary DBIx/Class/Storage/DBI/ADO/MS_Jet.pm »