Signal-iOS/SignalServiceKit/tests/Contacts/ContactSortingTest.m
Evan Hahn 370ff654e7
Change license to AGPL
Change license to AGPL

This commit:

- Updates the `LICENSE` file

- Start every file with something like:

      // Copyright YEAR_FIRST_PUBLISHED Signal Messenger, LLC
      // SPDX-License-Identifier: AGPL-3.0-only

---

First, I removed existing license headers with this Ruby 3.1.2 script:

    require 'set'

    EXTENSIONS_TO_CHECK = Set['.h', '.hpp', '.cpp', '.m', '.mm', '.pch', '.swift']

    same = 0
    different = 0

    all_files = `git ls-files`.lines.map { |line| line.strip }
    all_files.each do |relative_path|
      if relative_path == 'Pods'
        next
      end

      unless EXTENSIONS_TO_CHECK.include? File.extname(relative_path)
        next
      end

      path = File.expand_path(relative_path)

      contents = File.read(path)
      new_contents = contents.sub(/\/\/\n\/\/  Copyright .*\n\/\/\n\n/, '')

      if contents == new_contents
        same += 1
      else
        different += 1
      end

      File.write(path, new_contents)
    end

    puts "updated #{different} file(s), left #{same} untouched"

I'm sure this script could be improved, but it worked well enough.

Then, I created `Scripts/lint/lint-license-headers` and ran it to auto-
fix a lot of files. This changed the mode of some files, but I think
that's actually desirable. For example,
`SignalServiceKit/src/Util/AppContext.m` previously had a mode of
`0755/-rwxr-xr-x`, and it's now `0644/-rw-r--r--`.

Then I fixed some stragglers and updated the precommit script.

See [a similar change in the Desktop app][0].

[0]: 8bfaf598af
2022-10-13 08:25:37 -05:00

123 lines
5.3 KiB
Objective-C

//
// Copyright 2018 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
#import "Contact.h"
#import "SSKBaseTestObjC.h"
#import <Contacts/Contacts.h>
NS_ASSUME_NONNULL_BEGIN
@interface ContactSortingTest : SSKBaseTestObjC
@end
@implementation ContactSortingTest
- (void)setUp
{
[super setUp];
srandom((unsigned int)time(NULL));
}
- (void)testSortingNamesByFirstLast
{
NSComparator comparator = [Contact comparatorSortingNamesByFirstThenLast:YES];
NSArray<Contact *>*sortedContacts = [self.class contactArrayForNames:@[@[@"Adam", @"Smith"],
@[@"Adam", @"West"],
@[@"", @"Daisy"],
@[@"Daisy", @"Chain"],
@[@"Daisy", @"Duke"],
@[@"James", @"Smith"],
@[@"James", @"Van"],
@[@"James", @"Van Der Beek"],
@[@"Kevin", @"Smith"],
@[@"Mae", @"West"],
@[@"Mary", @"Oliver"],
@[@"Mary Jo", @"Catlett"],
]];
NSUInteger numContacts = sortedContacts.count;
for (NSUInteger i = 0; i < 20; i++) {
NSArray *shuffledContacts = [self.class shuffleArray:sortedContacts];
NSArray *resortedContacts = [shuffledContacts sortedArrayUsingComparator:comparator];
for (NSUInteger j = 0; j < numContacts; j++) {
Contact *a = sortedContacts[j];
Contact *b = resortedContacts[j];
BOOL correct = ([a.firstName isEqualToString:b.firstName] && [a.lastName isEqualToString:b.lastName]);
if (!correct) {
XCTFail(@"Contacts failed to sort names by first, last");
break;
}
}
}
}
- (void)testSortingNamesByLastFirst
{
NSComparator comparator = [Contact comparatorSortingNamesByFirstThenLast:NO];
NSArray<Contact *>*sortedContacts = [self.class contactArrayForNames:@[@[@"Mary Jo", @"Catlett"],
@[@"Daisy", @"Chain"],
@[@"", @"Daisy"],
@[@"Daisy", @"Duke"],
@[@"Mary", @"Oliver"],
@[@"Adam", @"Smith"],
@[@"James", @"Smith"],
@[@"Kevin", @"Smith"],
@[@"James", @"Van"],
@[@"James", @"Van Der Beek"],
@[@"Adam", @"West"],
@[@"Mae", @"West"],
]];
NSUInteger numContacts = sortedContacts.count;
for (NSUInteger i = 0; i < 20; i++) {
NSArray *shuffledContacts = [self.class shuffleArray:sortedContacts];
NSArray *resortedContacts = [shuffledContacts sortedArrayUsingComparator:comparator];
for (NSUInteger j = 0; j < numContacts; j++) {
Contact *a = sortedContacts[j];
Contact *b = resortedContacts[j];
BOOL correct = ([a.firstName isEqualToString:b.firstName] && [a.lastName isEqualToString:b.lastName]);
if (!correct) {
XCTFail(@"Contacts failed to sort names by last, first");
break;
}
}
}
}
+ (NSArray<Contact *> *)contactArrayForNames:(NSArray<NSArray<NSString *>*>*)namePairs
{
NSMutableArray<Contact *>*contacts = [[NSMutableArray alloc] initWithCapacity:namePairs.count];
for (NSArray<NSString *>*namePair in namePairs) {
CNMutableContact *cnContact = [CNMutableContact new];
cnContact.givenName = namePair[0];
cnContact.familyName = namePair[1];
Contact *c = [[Contact alloc] initWithSystemContact:cnContact];
[contacts addObject:c];
}
return [contacts copy]; // Return an immutable for good hygiene
}
+ (NSArray*)shuffleArray:(NSArray *)array
{
NSMutableArray *shuffled = [[NSMutableArray alloc] initWithArray:array];
for(NSUInteger i = [array count]; i > 1; i--) {
NSUInteger j = arc4random_uniform((uint32_t)i);
[shuffled exchangeObjectAtIndex:(i - 1) withObjectAtIndex:j];
}
return [shuffled copy]; // Return an immutable for good hygiene
}
@end
NS_ASSUME_NONNULL_END