Add SPM compatibility and nullability annotations (mattt#4)

* add package.swift

* Add nullability annotations for swift

* add public header file

* move header file into folder

* try as dynamic framework

* add empty dependency list

* try adding stuff to an `include` folder

* Add symlink to main folder

* try with default options

* try making an alias again

* try path again

* Try importing just the headers without the module name

* get rid of sources folder and symlink

Author: designatednerd

InflectorKit/NSString+InflectorKit.m

@@ -25,11 +25,11 @@
 
 @implementation NSString (InflectorKit)
 
-- (NSString *)singularizedString {
+- (nonnull NSString *)singularizedString {
     return [[TTTStringInflector defaultInflector] singularize:self];
 }
 
-- (NSString *)pluralizedString {
+- (nonnull NSString *)pluralizedString {
     return [[TTTStringInflector defaultInflector] pluralize:self];
 }
 

InflectorKit/TTTStringInflector.m

@@ -63,7 +63,7 @@ - (id)init {
     return self;
 }
 
-+ (instancetype)defaultInflector {
++ (nonnull instancetype)defaultInflector {
     static id _defaultInflector = nil;
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{
@@ -74,7 +74,7 @@ + (instancetype)defaultInflector {
     return _defaultInflector;
 }
 
-- (NSString *)singularize:(NSString *)string {
+- (nonnull NSString *)singularize:(nonnull NSString *)string {
     if ([self.mutableUncountables containsObject:string]) {
         return string;
     }
@@ -92,7 +92,7 @@ - (NSString *)singularize:(NSString *)string {
     return mutableString;
 }
 
-- (NSString *)pluralize:(NSString *)string {
+- (nonnull NSString *)pluralize:(nonnull NSString *)string {
     if ([self.mutableUncountables containsObject:string]) {
         return string;
     }
@@ -110,31 +110,31 @@ - (NSString *)pluralize:(NSString *)string {
     return mutableString;
 }
 
-- (void)addSingularRule:(NSString *)rule
-        withReplacement:(NSString *)replacement
+- (void)addSingularRule:(nonnull NSString *)rule
+        withReplacement:(nonnull NSString *)replacement
 {
     [self.mutableUncountables removeObject:rule];
 
     [self.mutableSingularRules insertObject:[TTTStringInflectionRule ruleWithPattern:rule options:NSRegularExpressionAnchorsMatchLines | NSRegularExpressionCaseInsensitive | NSRegularExpressionUseUnicodeWordBoundaries replacement:replacement] atIndex:0];
 }
 
-- (void)addPluralRule:(NSString *)rule
-      withReplacement:(NSString *)replacement
+- (void)addPluralRule:(nonnull NSString *)rule
+      withReplacement:(nonnull NSString *)replacement
 {
     [self.mutableUncountables removeObject:rule];
     [self.mutableUncountables removeObject:replacement];
 
     [self.mutablePluralRules insertObject:[TTTStringInflectionRule ruleWithPattern:rule options:NSRegularExpressionAnchorsMatchLines | NSRegularExpressionCaseInsensitive | NSRegularExpressionUseUnicodeWordBoundaries replacement:replacement] atIndex:0];
 }
 
-- (void)addIrregularWithSingular:(NSString *)singular
-                          plural:(NSString *)plural
+- (void)addIrregularWithSingular:(nonnull NSString *)singular
+                          plural:(nonnull NSString *)plural
 {
     [self.mutableIrregularPluralsBySingular setObject:plural forKey:singular];
     [self.mutableIrregularPluralsBySingular setObject:[plural capitalizedString] forKey:[singular capitalizedString]];
 }
 
-- (void)addUncountable:(NSString *)word {
+- (void)addUncountable:(nonnull NSString *)word {
     [self.mutableUncountables addObject:word];
 }
 

InflectorKit/include/InflectorKit.h

@@ -0,0 +1,12 @@
+#import <Foundation/Foundation.h>
+
+//! Project version number for InflectorKit.
+FOUNDATION_EXPORT double InflectorKitVersionNumber;
+
+//! Project version string for InflectorKit.
+FOUNDATION_EXPORT const unsigned char InflectorKitVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <InflectorKit/PublicHeader.h>
+
+#import "NSString+InflectorKit.h"
+#import "TTTStringInflector.h"

InflectorKit/NSString+InflectorKit.h renamed to InflectorKit/include/NSString+InflectorKit.h

@@ -30,11 +30,11 @@
 /**
  
  */
-- (NSString *)singularizedString;
+- (nonnull NSString *)singularizedString;
 
 /**
  
  */
-- (NSString *)pluralizedString;
+- (nonnull NSString *)pluralizedString;
 
 @end

InflectorKit/TTTStringInflector.h renamed to InflectorKit/include/TTTStringInflector.h

@@ -30,7 +30,7 @@
 /**
  
  */
-+ (instancetype)defaultInflector;
++ (nonnull instancetype)defaultInflector;
 
 ///=========================
 /// @name Inflecting Strings
@@ -39,12 +39,12 @@
 /**
  
  */
-- (NSString *)singularize:(NSString *)string;
+- (nonnull NSString *)singularize:(nonnull NSString *)string;
 
 /**
  
  */
-- (NSString *)pluralize:(NSString *)string;
+- (nonnull NSString *)pluralize:(nonnull NSString *)string;
 
 ///===================
 /// @name Adding Rules
@@ -53,24 +53,24 @@
 /**
  
  */
-- (void)addSingularRule:(NSString *)rule
-        withReplacement:(NSString *)replacement;
+- (void)addSingularRule:(nonnull NSString *)rule
+        withReplacement:(nonnull NSString *)replacement;
 
 /**
  
  */
-- (void)addPluralRule:(NSString *)rule
-      withReplacement:(NSString *)replacement;
+- (void)addPluralRule:(nonnull NSString *)rule
+      withReplacement:(nonnull NSString *)replacement;
 
 /**
  
  */
-- (void)addIrregularWithSingular:(NSString *)singular
-                          plural:(NSString *)plural;
+- (void)addIrregularWithSingular:(nonnull NSString *)singular
+                          plural:(nonnull NSString *)plural;
 
 /**
  
  */
-- (void)addUncountable:(NSString *)word;
+- (void)addUncountable:(nonnull NSString *)word;
 
 @end

Package.swift

@@ -0,0 +1,22 @@
+// swift-tools-version:5.2
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "InflectorKit",
+    products: [
+        .library(
+          name: "InflectorKit",
+          targets: ["InflectorKit"]
+        )
+    ],
+    dependencies: [],
+    targets: [
+        .target(
+            name: "InflectorKit",
+            dependencies: [],
+            path: "InflectorKit"
+        )
+    ]
+)