opentick/Record.pm

filter: Statementstmt 96.9% 95 / 98 Branchbran 73.0% 19 / 26 Conditioncond 100% 9 / 9 MC/DCmcdc 100% 4 / 4 Subroutinesub 95.6% 22 / 23 Podpod 100% 16 / 16 totaltotal 93.7% 165 / 176 CC 19 SCAR 12.4
CC
19
Cov
92%
initialize
8.0
_expand_64bit_fields
6.0
get_field_names
5.0
CRAP 3.5
« opentick/Socket.pm ↑ Summary opentick/Output.pm »
1 package POE::Component::Client::opentick::Record;
2 #
3 # opentick.com POE client
4 #
5 # Protocol message response encapsulation, corresponding with a single
6 # RECORD of data.
7 #
8 # infi/2008
9 #
10 # $Id: Record.pm 56 2009-01-08 16:51:14Z infidel $
11 #
12 # See comments at beginning of Protocol.pm for implementation
13 #
14 # Full user POD documentation after __END__
15 #
16  
17 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
18 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
19 4 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
20  
21 # Ours
22 4 ▶use POE::Component::Client::opentick::Constants;
Subroutine BEGIN: called CC=1 SCAR=0.0
23 4 ▶use POE::Component::Client::opentick::Util;
Subroutine BEGIN: called CC=1 SCAR=0.0
24  
25 4 ▶use vars qw( $VERSION $TRUE $FALSE $KEEP $DELETE );
Subroutine BEGIN: called CC=1 SCAR=0.0
26  
27 ###
28 ### Variables
29 ###
30  
31 4 ($VERSION) = q$Revision: 56 $ =~ /(\d+)/;
32 4 *TRUE = \1;
33 4 *FALSE = \0;
34 4 *KEEP = \0;
35 4 *DELETE = \1;
36  
37 # FIXME: comment out the unneeded entries when testing is complete.
38 4 my $field_names = {
39 OTConstant('OT_LOGIN') => [
40 qw( SessionID RedirectFlag RedirectHostName RedirectPortNum ),
41 ],
42 OTConstant('OT_LOGOUT') => [], # none
43 OTConstant('OT_REQUEST_TICK_STREAM') => [],
44 OTConstant('OT_REQUEST_TICK_STREAM_EX') => [],
45 OTConstant('OT_REQUEST_HIST_DATA') => [],
46 OTConstant('OT_REQUEST_HIST_TICKS') => [],
47 OTConstant('OT_REQUEST_LIST_EXCHANGES') => [
48 qw( ExchangeCode ExchangeAvail ExchangeTitle ExchanceDesc ),
49 ],
50 OTConstant('OT_REQUEST_LIST_SYMBOLS') => [
51 qw( Currency Symbol Type Company ),
52 ],
53 OTConstant('OT_REQUEST_EQUITY_INIT') => [],
54 # qw( DataType Currency InstrumentType Company
55 # PrevClosePrice PrevCloseDate AnnualHighPrice AnnualHighDate
56 # AnnualLowPrice AnnualLowDate EarningsPrice EarningsDate
57 # TotalShares AverageVolume CUSIP ISIN
58 # IsUPC11830 IsSmallCap IsTestIssue ),
59 # ],
60 OTConstant('OT_REQUEST_OPTION_CHAIN') => [],
61 OTConstant('OT_REQUEST_OPTION_CHAIN_EX') => [],
62 OTConstant('OT_REQUEST_BOOK_STREAM') => [],
63 OTConstant('OT_HEARTBEAT') => [], # none
64 OTConstant('OT_CANCEL_TICK_STREAM') => [], # none
65 OTConstant('OT_CANCEL_HIST_DATA') => [], # none
66 OTConstant('OT_CANCEL_OPTION_CHAIN') => [], # none
67 OTConstant('OT_CANCEL_BOOK_STREAM') => [], # none
68 OTConstant('OT_REQUEST_SPLITS') => [
69 qw( DataType ToFactor ForFactor
70 DeclarationDate ExecutionDate RecordDate PaymentDate ),
71 ],
72 OTConstant('OT_REQUEST_DIVIDENDS') => [
73 qw( DataType Price DeclarationDate ExecutionDate
74 RecordDate PaymentDate Flags Special ),
75 ],
76 OTConstant('OT_REQUEST_HIST_BOOKS') => [],
77 OTConstant('OT_REQUEST_BOOK_STREAM_EX') => [],
78 OTConstant('OT_REQUEST_OPTION_CHAIN_U') => [],
79 OTConstant('OT_REQUEST_OPTION_INIT') => [
80 qw( DataType UnderlyerSymbol Symbol StrikePrice
81 ContractSize ExpYear ExpMonth ExpDay
82 ExerciseStyle UnderlyerCUSIP Currency OptionMarker ),
83 ],
84 OTConstant('OT_REQUEST_LIST_SYMBOLS_EX') => [],
85 OTConstant('OT_REQUEST_TICK_SNAPSHOT') => [],
86 OTConstant('OT_REQUEST_OPTION_CHAIN_SNAPSHOT') => [],
87 };
88  
89 4 my $field_datatypes = {
90 OTConstant( 'OT_DATATYPE_QUOTE' ) => [
91 qw( Datatype Timestamp
92 BidSize AskSize BidPrice AskPrice
93 AskExchange Indicator TickIndicator ),
94 ],
95 OTConstant( 'OT_DATATYPE_MMQUOTE' ) => [
96 qw( Datatype Timestamp
97 BidSize AskSize BidPrice AskPrice
98 MMID Indicator TickExchange ),
99 ],
100 OTConstant( 'OT_DATATYPE_TRADE' ) => [
101 qw( Datatype Timestamp
102 Price Size Volume SeqNumber
103 Indicator TickIndicator Flags TickExchange ),
104 ],
105 OTConstant( 'OT_DATATYPE_BBO' ) => [
106 qw( Datatype Timestamp
107 Price Size Side ),
108 ],
109 OTConstant( 'OT_DATATYPE_OHLC' ) => [
110 qw( Datatype Timestamp
111 Open High Low Close Volume ),
112 ],
113 OTConstant( 'OT_DATATYPE_OHL_TODAY' ) => [
114 qw( Open High Low ),
115 ],
116 OTConstant( 'OT_DATATYPE_CANCEL' ) => [
117 qw( OrderRef Size ),
118 ],
119 OTConstant( 'OT_DATATYPE_CHANGE' ) => [
120 qw( OrderRef Price Size ),
121 ],
122 OTConstant( 'OT_DATATYPE_DELETE' ) => [
123 qw( OrderRef DeleteType Side ),
124 ],
125 OTConstant( 'OT_DATATYPE_EXECUTE' ) => [
126 qw( OrderRef Size MatchNumber ),
127 ],
128 OTConstant( 'OT_DATATYPE_ORDER' ) => [
129 qw( OrderRef Price Size Side Display ),
130 ],
131 OTConstant( 'OT_DATATYPE_PRICELEVEL' ) => [
132 qw( Price Size Side LevelId ),
133 ],
134 OTConstant( 'OT_DATATYPE_PURGE' ) => [
135 qw( ECNNameRoot ),
136 ],
137 OTConstant( 'OT_DATATYPE_REPLACE' ) => [
138 qw( OrderRef Price Size Side ),
139 ],
140 OTConstant( 'OT_DATATYPE_EQ_INIT' ) => [
141 qw( DataType Currency InstrumentType Company
142 PrevClosePrice PrevCloseDate AnnualHighPrice AnnualHighDate
143 AnnualLowPrice AnnualLowDate EarningsPrice EarningsDate
144 TotalShares AverageVolume CUSIP ISIN
145 IsUPC11830 IsSmallCap IsTestIssue ),
146 ],
147 OTConstant('OT_DATATYPE_OPTION_INIT') => [
148 qw( DataType UnderlyerSymbol Symbol StrikePrice
149 ContractSize ExpYear ExpMonth ExpDay
150 ExerciseStyle UnderlyerCUSIP Currency OptionMarker ),
151 ],
152 };
153  
154 # Valid arguments that can be passed to the constructor.
155 4 my $valid_args = {
156 requestid => $KEEP,
157 commandid => $KEEP,
158 datatype => $KEEP,
159 data => $KEEP,
160 };
161  
162 #######################################################################
163 ### Public methods ###
164 #######################################################################
165  
166 sub new
167 23 ▶{
Subroutine new: called CC=2 SCAR=7.0
Pod documented
168 23 my( $class, @args ) = @_;
169 23 ▶ croak( "$class requires an even number of parameters" ) if( @args & 1 );
Branch: 1 branch
BranchTrueFalseTotal
if @args & 1 0 23 23
170  
171 23 my $self = {
172 requestid => undef,
173 commandid => undef,
174 datatype => undef,
175 data => [],
176 };
177  
178 23 bless( $self, $class );
179  
180 23 $self->initialize( @args );
181  
182 23 return( $self );
183 }
184  
185 sub initialize
186 23 ▶{
Subroutine initialize: called CC=8 SCAR=20.8
Pod documented
187 23 my( $self, %args ) = @_;
188  
189 23 for( keys( %args ) )
190 {
191 86 ▶ $self->{lc $_} = $args{$_} if( exists( $valid_args->{lc $_} ) );
Branch: 1 branch
BranchTrueFalseTotal
if exists $$valid_args{lc $_} 86 0 86
192 }
193  
194 # SPECIAL CASES FOR 64-BIT SIMULATION. Really stupid.
195 # See POD documentation for details.
196 23 my @fields;
197 23 ▶ if( defined( $self->{datatype} )
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->{"datatype"} and $self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") || $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT") || $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")) 3 20 23
Condition100%9/9
defined $self->{"datatype"} and $self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") || $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT") || $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")
!ll&&!rl&&r
7133
$self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") or $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT") or $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")
l!l&&r!l&&!r
2113
$self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") or $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT")
l!l&&r!l&&!r
1114
MC/DC100%4/4
defined $self->{"datatype"} and $self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") || $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT") || $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")
defined $self->{"datatype"} $self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE") $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT") $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")
Truth table100%5/5
A and B or C or D
A= defined $self->{"datatype"}B= $self->{"datatype"} == OTConstant("OT_DATATYPE_TRADE")C= $self->{"datatype"} == OTConstant("OT_DATATYPE_EQ_INIT")D= $self->{"datatype"} == OTConstant("OT_DATATYPE_OHLC")
ABCDresult
0XXX0
10000
11XX1
101X1
10011
198 && ( $self->{datatype} == OTConstant( 'OT_DATATYPE_TRADE' )
199 || $self->{datatype} == OTConstant( 'OT_DATATYPE_EQ_INIT' )
200 || $self->{datatype} == OTConstant( 'OT_DATATYPE_OHLC' ) ) )
201 {
202 3 @fields = OT64bit( $self->{datatype} );
203 }
204 23 ▶ $self->_expand_64bit_fields( @fields ) if( @fields );
Branch: 1 branch
BranchTrueFalseTotal
if @fields 0 23 23
205 # END special case
206  
207 23 return;
208 }
209  
210 #######################################################################
211 ### Accessor methods ###
212 #######################################################################
213  
214 # Requires an arrayref (row) of data to store.
215 sub set_data
216 1 ▶{
Subroutine set_data: called CC=2 SCAR=7.0
Pod documented
217 1 my $self = shift;
218 1 ▶ my $data = ref( $_[0] ) eq 'ARRAY' ? $_[0] : [ @_ ];
Branch: 1 branch
BranchTrueFalseTotal
ref $_[0] eq 'ARRAY' ? : 1 0 1
219  
220 1 $self->{data} = $data;
221  
222 1 return( scalar( @{ $self->{data} = $data } ) );
223 }
224  
225 sub set_datatype
226 1 ▶{
Subroutine set_datatype: called CC=2 SCAR=7.1
Pod documented
227 1 my( $self, $datatype ) = @_;
228 1 ▶ return unless( $datatype =~ /^\d+$/ );
Branch: 1 branch
BranchTrueFalseTotal
unless $datatype =~ /^\d+$/ 0 1 1
229  
230 1 return( $self->{datatype} = $datatype );
231 }
232  
233 sub set_command_id
234 1 ▶{
Subroutine set_command_id: called CC=1 SCAR=0.0
Pod documented
235 1 my( $self, $cmd_id ) = @_;
236  
237 1 return( $self->{commandid} = $cmd_id );
238 }
239  
240 sub get_data
241 3 ▶{
Subroutine get_data: called CC=3 SCAR=11.0
Pod documented
242 3 my $self = shift;
243  
244 3 ▶ if( ref( $_[0] ) eq 'ARRAY' )
Branch: 2 branches
BranchTrueFalseTotal
if (ref $_[0] eq 'ARRAY') { } 1 2 3
elsif (ref $_[0] eq 'HASH') { } 1 1 2
245 {
246 1 @{$_[0]} = @{ $self->get_data_as_arrayref() };
247 1 return( @{ $_[0] } );
248 }
249 elsif( ref( $_[0] ) eq 'HASH' )
250 {
251 1 %{$_[0]} = %{ $self->get_data_as_hashref() };
252 1 return( keys( %{ $_[0] } ) );
253 }
254 else
255 {
256 1 return( @{ $self->{data} } );
257 }
258 }
259  
260 sub get_data_as_hashref
261 1 ▶{
Subroutine get_data_as_hashref: called CC=1 SCAR=0.0
Pod documented
262 1 my( $self ) = @_;
263  
264 1 my %hash;
265 1 @hash{ $self->get_field_names() } = @{ $self->{data} };
266  
267 1 return( \%hash );
268 }
269  
270 sub get_data_as_arrayref
271 1 ▶{
Subroutine get_data_as_arrayref: called CC=1 SCAR=0.0
Pod documented
272 1 return( $_[0]->get_raw_data() );
273 }
274  
275 sub get_raw_data
276 3 ▶{
Subroutine get_raw_data: called CC=1 SCAR=0.0
Pod documented
277 3 my( $self ) = @_;
278  
279 3 return( $self->{data} );
280 }
281  
282 sub as_string
283 2 ▶{
Subroutine as_string: called CC=2 SCAR=6.9
Pod documented
284 2 my( $self, $separator ) = @_;
285  
286 2 ▶ $separator = ' ' unless( defined( $separator ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $separator 1 1 2
287  
288 2 return( join( $separator, @{ $self->{data} } ) );
289 }
290  
291 sub get_field_names
292 23 ▶{
Subroutine get_field_names: called CC=5 SCAR=16.2
Pod documented
293 23 my( $self ) = @_;
294  
295 my @fields = $self->{datatype}
296 ? exists( $field_datatypes->{ $self->{datatype} } )
297 16 ▶ ? @{ $field_datatypes->{ $self->{datatype} } }
Branch: 1 branch
BranchTrueFalseTotal
exists $$field_names{$self->{'commandid'}} ? : 7 0 7
298 : ()
299 : exists( $field_names->{ $self->{commandid} } )
300 23 ▶ ? @{ $field_names->{ $self->{commandid} } }
Branch: 2 branches
BranchTrueFalseTotal
$self->{'datatype'} ? : 16 7 23
exists $$field_datatypes{$self->{'datatype'}} ? : 16 0 16
301 : ();
302 # give them only enough field names to correspond with data!
303 2 @fields = @fields[0..$#{ $self->{data} }]
304 23 ▶ if( $#{$self->{data}} < scalar( @fields ) );
Branch: 1 branch
BranchTrueFalseTotal
if $#{$$self{"data"};} < scalar @fields 2 21 23
305  
306 23 return( @fields );
307 }
308  
309 sub get_command_id
310 3 ▶{
Subroutine get_command_id: called CC=1 SCAR=0.0
Pod documented
311 3 my( $self ) = @_;
312  
313 3 return( $self->{commandid} );
314 }
315  
316 sub get_command_name
317 2 ▶{
Subroutine get_command_name: called CC=1 SCAR=0.0
Pod documented
318 2 my( $self ) = @_;
319  
320 2 return( OTCommand( $self->{commandid} ) );
321 }
322  
323 sub get_request_id
324 3 ▶{
Subroutine get_request_id: called CC=1 SCAR=0.0
Pod documented
325 3 my( $self ) = @_;
326  
327 3 return( $self->{requestid} );
328 }
329  
330 sub get_datatype
331 1 ▶{
Subroutine get_datatype: called CC=1 SCAR=0.0
Pod documented
332 1 my( $self ) = @_;
333  
334 1 return( $self->{datatype} );
335 }
336  
337 # is this an EOD record?
338 sub is_eod
339 2 ▶{
Subroutine is_eod: called CC=1 SCAR=0.0
Pod documented
340 2 my( $self ) = @_;
341  
342 2 return( OTeod( $self->{datatype} ) );
343 }
344  
345 ###
346 ### Private methods
347 ###
348  
349 sub _expand_64bit_fields
350 0 ▶{
Subroutine _expand_64bit_fields: not called CC=2 SCAR=17.9
351 0 my( $self, @fields ) = @_;
352  
353 0 $self->{data}->[$_] = asc2longlong( $self->{data}->[$_] ) for( @fields );
354  
355 0 return;
356 }
357  
358 4 1;
359  
360 __END__
« opentick/Socket.pm ↑ Summary opentick/Output.pm »