Skip to content

Commit cd5719c

Browse files
mpsonntagmpsonntag
committed
[Matlab] Refactor SourcesMixIn function names
- Refactors all SourcesMixIn function names to CamelCase. - Refactors all affected tests.
1 parent e26f3cb commit cd5719c

File tree

7 files changed

+236
-232
lines changed

7 files changed

+236
-232
lines changed

‎+nix/SourcesMixIn.m‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,38 @@
1919
nix.Dynamic.add_dyn_relation(obj, 'sources', @nix.Source);
2020
end
2121

22-
function r = source_count(obj)
22+
function r = sourceCount(obj)
2323
r = nix.Utils.fetchEntityCount(obj, 'sourceCount');
2424
end
2525

26-
% has_source supports only check by id, not by name
27-
function r = has_source(obj, id_or_entity)
28-
has = nix.Utils.parseEntityId(id_or_entity, 'nix.Source');
26+
% hasSource supports only check by id, not by name
27+
function r = hasSource(obj, idEntity)
28+
has = nix.Utils.parseEntityId(idEntity, 'nix.Source');
2929
r = nix.Utils.fetchHasEntity(obj, 'hasSource', has);
3030
end
3131

32-
function [] = add_source(obj, add_this)
33-
nix.Utils.add_entity(obj, 'addSource', add_this, 'nix.Source');
32+
function [] = addSource(obj, entity)
33+
nix.Utils.add_entity(obj, 'addSource', entity, 'nix.Source');
3434
end
3535

36-
function [] = add_sources(obj, add_cell_array)
37-
nix.Utils.add_entity_array(obj, 'addSources', add_cell_array, 'nix.Source');
36+
function [] = addSources(obj, entityArray)
37+
nix.Utils.add_entity_array(obj, 'addSources', entityArray, 'nix.Source');
3838
end
3939

40-
function r = remove_source(obj, del)
40+
function r = removeSource(obj, del)
4141
r = nix.Utils.delete_entity(obj, 'removeSource', del, 'nix.Source');
4242
end
4343

44-
function r = open_source(obj, id_or_name)
45-
r = nix.Utils.open_entity(obj, 'openSource', id_or_name, @nix.Source);
44+
function r = openSource(obj, idName)
45+
r = nix.Utils.open_entity(obj, 'openSource', idName, @nix.Source);
4646
end
4747

48-
function r = open_source_idx(obj, index)
48+
function r = openSourceIdx(obj, index)
4949
idx = nix.Utils.handle_index(index);
5050
r = nix.Utils.open_entity(obj, 'openSourceIdx', idx, @nix.Source);
5151
end
5252

53-
function r = filter_sources(obj, filter, val)
53+
function r = filterSources(obj, filter, val)
5454
r = nix.Utils.filter(obj, 'sourcesFiltered', filter, val, @nix.Source);
5555
end
5656
end

‎tests/TestBlock.m‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
% LICENSE file in the root of the Project.
88

99
function funcs = TestBlock
10-
%TESTFILE Tests for the nix.Block object
11-
% Detailed explanation goes here
10+
% TESTBLOCK Tests for the nix.Block object
1211

1312
funcs = {};
1413
funcs{end+1} = @testAttributes;
@@ -887,7 +886,7 @@
887886
mainEntity = b.createGroup(mainName, 'nixGroup');
888887
subName = 'testSubSource1';
889888
s = b.createSource(subName, 'nixSource');
890-
mainEntity.add_source(s);
889+
mainEntity.addSource(s);
891890
subID = s.id;
892891

893892
% filter works only for ID, not for name
@@ -952,7 +951,7 @@
952951
mainEntity = b.createTag(mainName, 'nixTag', [12 3]);
953952
subName = 'testSubSource1';
954953
s = b.createSource(subName, 'nixSource');
955-
mainEntity.add_source(s);
954+
mainEntity.addSource(s);
956955
subID = s.id;
957956

958957
% filter works only for ID, not for name
@@ -1018,7 +1017,7 @@
10181017
mainEntity = b.createMultiTag(mainName, 'nixMultiTag', d);
10191018
subName = 'testSubSource1';
10201019
s = b.createSource(subName, 'nixSource');
1021-
mainEntity.add_source(s);
1020+
mainEntity.addSource(s);
10221021
subID = s.id;
10231022

10241023
% filter works only for ID, not for name
@@ -1089,7 +1088,7 @@
10891088
mainEntity = b.createDataArray(mainName, 'nixDataArray', nix.DataType.Bool, [2 9]);
10901089
subName = 'testSubSource1';
10911090
s = b.createSource(subName, 'nixSource');
1092-
mainEntity.add_source(s);
1091+
mainEntity.addSource(s);
10931092
subID = s.id;
10941093

10951094
% filter works only for ID, not for name

‎tests/TestDataArray.m‎

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
% LICENSE file in the root of the Project.
88

99
function funcs = TestDataArray
10-
%TESTDATAARRAY tests for DataArray
11-
% Detailed explanation goes here
10+
% TESTDATAARRAY tests for DataArray
1211

1312
funcs = {};
1413
funcs{end+1} = @testAttributes;
@@ -309,12 +308,12 @@
309308
s = b.createSource('sourceTest', 'nixSource');
310309
tmp = s.createSource('nestedSource1', 'nixSource');
311310
tmp = s.createSource('nestedSource2', 'nixSource');
312-
getDataArray = b.createDataArray('sourceTestDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
311+
d = b.createDataArray('sourceTestDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
313312

314-
assert(isempty(getDataArray.sources));
315-
getDataArray.add_source(s.sources{1}.id);
316-
getDataArray.add_source(s.sources{2});
317-
assert(size(getDataArray.sources, 1) == 2);
313+
assert(isempty(d.sources));
314+
d.addSource(s.sources{1}.id);
315+
d.addSource(s.sources{2});
316+
assert(size(d.sources, 1) == 2);
318317
end
319318

320319
%% Test: Add sources by entity cell array
@@ -330,20 +329,20 @@
330329
assert(isempty(d.sources));
331330

332331
try
333-
d.add_sources('hurra');
332+
d.addSources('hurra');
334333
catch ME
335334
assert(strcmp(ME.message, 'Expected cell array'));
336335
end;
337336
assert(isempty(d.sources));
338337

339338
try
340-
d.add_sources({12, 13});
339+
d.addSources({12, 13});
341340
catch ME
342341
assert(~isempty(strfind(ME.message, 'not a nix.Source')));
343342
end;
344343
assert(isempty(d.sources));
345344

346-
d.add_sources(b.sources());
345+
d.addSources(b.sources());
347346
assert(size(d.sources, 1) == 3);
348347

349348
clear d tmp b f;
@@ -360,16 +359,16 @@
360359
nSource = s.createSource(sourceName, 'nixSource');
361360

362361
d = b.createDataArray('sourceTest', 'nixDataArray', nix.DataType.Double, [1 2]);
363-
d.add_source(nSource);
362+
d.addSource(nSource);
364363

365364
% -- test get source by ID
366-
assert(~isempty(d.open_source(nSource.id)));
365+
assert(~isempty(d.openSource(nSource.id)));
367366

368367
% -- test get source by name
369-
assert(~isempty(d.open_source(sourceName)));
368+
assert(~isempty(d.openSource(sourceName)));
370369

371370
%-- test open non existing source
372-
assert(isempty(d.open_source('I do not exist')));
371+
assert(isempty(d.openSource('I do not exist')));
373372
end
374373

375374
function [] = testOpenSourceIdx( varargin )
@@ -380,13 +379,13 @@
380379
s1 = b.createSource('testSource1', 'nixSource');
381380
s2 = b.createSource('testSource2', 'nixSource');
382381
s3 = b.createSource('testSource3', 'nixSource');
383-
d.add_source(s1);
384-
d.add_source(s2);
385-
d.add_source(s3);
382+
d.addSource(s1);
383+
d.addSource(s2);
384+
d.addSource(s3);
386385

387-
assert(strcmp(f.blocks{1}.dataArrays{1}.open_source_idx(1).name, s1.name));
388-
assert(strcmp(f.blocks{1}.dataArrays{1}.open_source_idx(2).name, s2.name));
389-
assert(strcmp(f.blocks{1}.dataArrays{1}.open_source_idx(3).name, s3.name));
386+
assert(strcmp(f.blocks{1}.dataArrays{1}.openSourceIdx(1).name, s1.name));
387+
assert(strcmp(f.blocks{1}.dataArrays{1}.openSourceIdx(2).name, s2.name));
388+
assert(strcmp(f.blocks{1}.dataArrays{1}.openSourceIdx(3).name, s3.name));
390389
end
391390

392391
%% Test: Remove sources by entity and id
@@ -396,16 +395,16 @@
396395
s = b.createSource('sourceTest', 'nixSource');
397396
tmp = s.createSource('nestedSource1', 'nixSource');
398397
tmp = s.createSource('nestedSource2', 'nixSource');
399-
getDataArray = b.createDataArray('sourceTestDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
398+
d = b.createDataArray('sourceTestDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
400399

401-
getDataArray.add_source(s.sources{1}.id);
402-
getDataArray.add_source(s.sources{2});
400+
d.addSource(s.sources{1}.id);
401+
d.addSource(s.sources{2});
403402

404-
assert(getDataArray.remove_source(s.sources{2}));
405-
assert(getDataArray.remove_source(s.sources{1}.id));
406-
assert(isempty(getDataArray.sources));
403+
assert(d.removeSource(s.sources{2}));
404+
assert(d.removeSource(s.sources{1}.id));
405+
assert(isempty(d.sources));
407406

408-
assert(getDataArray.remove_source('I do not exist'));
407+
assert(d.removeSource('I do not exist'));
409408
assert(size(s.sources, 1) == 2);
410409
end
411410

@@ -417,14 +416,14 @@
417416
s = b.createSource('sourceTest1', 'nixSource');
418417
sID = s.id;
419418
d = b.createDataArray('sourceTestDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
420-
d.add_source(b.sources{1});
419+
d.addSource(b.sources{1});
421420

422-
assert(~d.has_source('I do not exist'));
423-
assert(d.has_source(s));
421+
assert(~d.hasSource('I do not exist'));
422+
assert(d.hasSource(s));
424423

425424
clear d s b f;
426425
f = nix.File(fullfile(pwd, 'tests', fileName), nix.FileMode.ReadOnly);
427-
assert(f.blocks{1}.dataArrays{1}.has_source(sID));
426+
assert(f.blocks{1}.dataArrays{1}.hasSource(sID));
428427
end
429428

430429
%% Test: Source count
@@ -434,14 +433,14 @@
434433
b = f.createBlock('testBlock', 'nixBlock');
435434
d = b.createDataArray('testDataArray', 'nixDataArray', nix.DataType.Double, [1 2]);
436435

437-
assert(d.source_count() == 0);
438-
d.add_source(b.createSource('testSource1', 'nixSource'));
439-
assert(d.source_count() == 1);
440-
d.add_source(b.createSource('testSource2', 'nixSource'));
436+
assert(d.sourceCount() == 0);
437+
d.addSource(b.createSource('testSource1', 'nixSource'));
438+
assert(d.sourceCount() == 1);
439+
d.addSource(b.createSource('testSource2', 'nixSource'));
441440

442441
clear d b f;
443442
f = nix.File(testFile, nix.FileMode.ReadOnly);
444-
assert(f.blocks{1}.dataArrays{1}.source_count() == 2);
443+
assert(f.blocks{1}.dataArrays{1}.sourceCount() == 2);
445444
end
446445

447446
%% Test: Dimensions
@@ -606,69 +605,69 @@
606605
b = f.createBlock('testBlock', 'nixBlock');
607606
d = b.createDataArray('testDataArray', 'nixDataArray', nix.DataType.Double, [3 2 3]);
608607
s = b.createSource(filterName, 'nixSource');
609-
d.add_source(s);
608+
d.addSource(s);
610609
filterID = s.id;
611610
s = b.createSource('testSource1', filterType);
612-
d.add_source(s);
611+
d.addSource(s);
613612
filterIDs = {filterID, s.id};
614613
s = b.createSource('testSource2', filterType);
615-
d.add_source(s);
614+
d.addSource(s);
616615

617616
% test empty id filter
618-
assert(isempty(f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.id, 'IdoNotExist')));
617+
assert(isempty(f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.id, 'IdoNotExist')));
619618

620619
% test nix.Filter.accept_all
621-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.accept_all, '');
620+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.accept_all, '');
622621
assert(size(filtered, 1) == 3);
623622

624623
% test nix.Filter.id
625-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.id, filterID);
624+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.id, filterID);
626625
assert(size(filtered, 1) == 1);
627626
assert(strcmp(filtered{1}.id, filterID));
628627

629628
% test nix.Filter.ids
630-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.ids, filterIDs);
629+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.ids, filterIDs);
631630
assert(size(filtered, 1) == 2);
632631
assert(strcmp(filtered{1}.id, filterIDs{1}) || strcmp(filtered{1}.id, filterIDs{2}));
633632

634633
% test nix.Filter.name
635-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.name, filterName);
634+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.name, filterName);
636635
assert(size(filtered, 1) == 1);
637636
assert(strcmp(filtered{1}.name, filterName));
638637

639638
% test nix.Filter.type
640-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.type, filterType);
639+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.type, filterType);
641640
assert(size(filtered, 1) == 2);
642641

643642
% test nix.Filter.metadata
644643
mainName = 'testSubSection';
645644
mainSource = b.createSource(mainName, 'nixSource');
646-
d.add_source(mainSource);
645+
d.addSource(mainSource);
647646
subName = 'testSubSection1';
648647
s = f.createSection(subName, 'nixSection');
649648
mainSource.set_metadata(s);
650649
subID = s.id;
651650

652-
assert(isempty(f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.metadata, 'Do not exist')));
653-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.metadata, subID);
651+
assert(isempty(f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.metadata, 'Do not exist')));
652+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.metadata, subID);
654653
assert(size(filtered, 1) == 1);
655654
assert(strcmp(filtered{1}.name, mainName));
656655

657656
% test nix.Filter.source
658657
mainName = 'testSubSource';
659658
main = b.createSource(mainName, 'nixSource');
660-
d.add_source(main);
659+
d.addSource(main);
661660
mainID = main.id;
662661
subName = 'testSubSource1';
663662
s = main.createSource(subName, 'nixSource');
664663
subID = s.id;
665664

666-
assert(isempty(f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.source, 'Do not exist')));
667-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.source, subName);
665+
assert(isempty(f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.source, 'Do not exist')));
666+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.source, subName);
668667
assert(size(filtered, 1) == 1);
669668
assert(strcmp(filtered{1}.id, mainID));
670669

671-
filtered = f.blocks{1}.dataArrays{1}.filter_sources(nix.Filter.source, subID);
670+
filtered = f.blocks{1}.dataArrays{1}.filterSources(nix.Filter.source, subID);
672671
assert(size(filtered, 1) == 1);
673672
assert(strcmp(filtered{1}.name, mainName));
674673
end

0 commit comments

Comments
 (0)