ConciseKit 技术文档

1. 安装指南

ConciseKit 的安装非常简单，您可以选择以下任一方式：

使用 CocoaPods

在您的 Podfile 中添加以下依赖：

dependency 'ConciseKit', '~> 0.1.2'

然后执行 pod install 命令。

手动安装

1. 将 src/ 目录下的文件复制到您的项目中。
2. 在您的代码中导入 ConciseKit：

#import "ConciseKit.h"

2. 项目使用说明

ConciseKit 提供了一系列 Objective-C 的扩展和宏，帮助您更快地编写代码。以下是一些主要功能的使用说明：

方法交换 (Method Swizzling)

[$ swizzleMethod:@selector(foo) with:@selector(bar) in:[Foo class]]
[$ swizzleMethod:@selector(foo) in:[Foo class] with:@selector(bar) in:[Bar class]]
[$ swizzleClassMethod:@selector(foo) with:@selector(bar) in:[Foo class]]
[$ swizzleClassMethod:@selector(foo) in:[Foo class] with:@selector(bar) in:[Bar class]]

路径获取

[$ homePath]     // 获取用户主目录路径
[$ desktopPath]  // 获取用户桌面路径
[$ documentPath] // 获取用户文档路径
[$ appPath]      // 获取应用目录路径
[$ resourcePath] // 获取应用资源目录路径

等待条件 (waitUntil)

用于异步任务测试。

[$ waitUntil:^{ return (BOOL)(someConditionIsMet == YES) }]
[$ waitUntil:^{ return (BOOL)(someConditionIsMet == YES) } timeOut:10.0]
[$ waitUntil:^{ return (BOOL)(someConditionIsMet == YES) } timeOut:10.0 interval:0.1]

单例模式 (Singleton)

创建单例

在您的类接口中添加以下方法，并在实现中使用 $singleton 宏：

@interface Foo
- (id)initSingleton;
+ (Foo *)sharedFoo;
@end

@implementation Foo
$singleton(Foo);

- (id)initSingleton {
    // 初始化代码
    return self;
}
@end

使用单例

$shared(Foo) // 或 [Foo sharedFoo]

宏 (Macros)

ConciseKit 提供了一系列便捷的宏，用于简化代码编写。

$eql(foo, bar)  // 判断两个对象是否相等
$bool(YES)      // 转换为 NSNumber
<int>(123)      // 转换为 NSNumber
<float>(123.4)  // 转换为 NSNumber

3. 项目 API 使用文档

以下是 ConciseKit 的一些常用 API 使用方法：

NSArray

[array $first]   // 获取第一个元素
[array $last]    // 获取最后一个元素
[array $at:1]    // 获取指定索引的元素
[array $each:...] // 遍历数组
[array $map:...]  // 转换数组元素
[array $reduce:...] // 数组元素聚合
[array $select:...] // 过滤数组元素
[array $detect:...] // 查找符合条件的第一个元素
[array $join]       // 连接数组元素
[array $join:@","]  // 使用指定分隔符连接数组元素

NSMutableArray

[array $push:foo]    // 添加元素到数组末尾
[array $pop]         // 移除数组末尾元素
[array $unshift:foo] // 添加元素到数组开头
[array $shift]       // 移除数组开头元素

NSDictionary

[dict $for:@"key"]  // 获取指定键的值
[dict $keys]        // 获取所有键
[dict $values]      // 获取所有值
[dict $each:...]    // 遍历字典
[dict $eachWithStop:...] // 遍历字典，支持中断

NSMutableDictionary

[dict $obj:@"value" for:@"key"] // 设置键值对

NSString

[string $append:@"suffix"]  // 添加字符串后缀
[string $prepend:@"prefix"] // 添加字符串前缀
[string $split:@","]       // 使用逗号分隔字符串
[string $split]            // 使用空白字符分隔字符串

NSMutableString

[string $append_:@"suffix"]     // 添加字符串后缀
[string $prepend_:@"prefix"]    // 添加字符串前缀
[string $insert:@"insert" at:1] // 在指定位置插入字符串
[string $set:@"newString"]      // 设置新字符串

4. 项目安装方式

请参考上文“安装指南”中的说明进行项目安装。