Skip to content

Commit 16601b5

Browse files
refactor: ♻️ CryptoFieldをOptionalCryptoFieldに名称変更
1 parent d9c1273 commit 16601b5

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

Sources/CryptoCodable/CryptoConfigContainer.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import Foundation
33

44
/// 暗号鍵等の設定を保持するための名前空間
55
public struct CryptoConfigContainer: Sendable {
6-
/// CryptoFieldのエンコード/デコード時に使用する暗号鍵
6+
/// OptionalCryptoFieldのエンコード/デコード時に使用する暗号鍵
77
///
88
/// 暗号化・復号時に事前にセットする必要がある
99
///
@@ -25,12 +25,12 @@ public struct CryptoConfigContainer: Sendable {
2525
/// ```
2626
@TaskLocal public static var key: SymmetricKey?
2727

28-
/// CryptoFieldのエンコード/デコード時に使用するJSONEncoder
28+
/// OptionalCryptoFieldのエンコード/デコード時に使用するJSONEncoder
2929
///
3030
/// カスタマイズしたい場合のみ設定が必要
3131
@TaskLocal public static var encoder: JSONEncoder = .init()
3232

33-
/// CryptoFieldのエンコード/デコード時に使用するJSONDecoder
33+
/// OptionalCryptoFieldのエンコード/デコード時に使用するJSONDecoder
3434
///
3535
/// カスタマイズしたい場合のみ設定が必要
3636
@TaskLocal public static var decoder: JSONDecoder = .init()

Sources/CryptoCodable/CryptoField.swift renamed to Sources/CryptoCodable/OptionalCryptoField.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ import Foundation
55
///
66
/// ## 使用方法
77
///
8-
/// 1. CryptoFieldプロパティラッパーを使ったCodableな型を定義する
8+
/// 1. OptionalCryptoFieldプロパティラッパーを使ったCodableな型を定義する
99
///
1010
/// ```swift
1111
/// import CryptoCodable
1212
/// import Foundation
1313
///
1414
/// struct Event: Hashable, Codable, Sendable {
1515
/// var id: UUID
16-
/// @CryptoField var 個人情報: Self.個人情報?
16+
/// @OptionalCryptoField var 個人情報: Self.個人情報?
1717
/// struct 個人情報: Hashable, Codable, Sendable {
1818
/// var 氏名: String
1919
/// var 誕生日: Date
@@ -58,7 +58,7 @@ import Foundation
5858
/// - throws: `DecryptFailure` 暗号鍵が異なる場合
5959
///
6060
@propertyWrapper
61-
public struct CryptoField<T>: Codable, Sendable, Hashable where T: Sendable & Codable & Hashable {
61+
public struct OptionalCryptoField<T>: Codable, Sendable, Hashable where T: Sendable & Codable & Hashable {
6262
public var wrappedValue: T?
6363

6464
public init(wrappedValue: T?) {
@@ -92,7 +92,7 @@ public struct CryptoField<T>: Codable, Sendable, Hashable where T: Sendable & Co
9292
get throws {
9393
let json = try CryptoConfigContainer.encoder.encode(wrappedValue)
9494
guard let key = CryptoConfigContainer.key else {
95-
fatalError("暗号鍵が設定されていません。CryptoFieldKey.keyに暗号鍵を設定してください。")
95+
fatalError("暗号鍵が設定されていません。OptionalCryptoFieldKey.keyに暗号鍵を設定してください。")
9696
}
9797
let sealedBox = try AES.GCM.seal(json, using: key)
9898
guard let combined = sealedBox.combined else {
@@ -108,7 +108,7 @@ public struct CryptoField<T>: Codable, Sendable, Hashable where T: Sendable & Co
108108
/// 基本的に投げられることはないため、エラー処理は不要
109109
public struct EncryptIllegalSizeNounceError: Error, Hashable, Codable, Sendable {}
110110

111-
/// デコード(復号)時にCryptoFieldプロパティが復号に失敗した際に投げられるエラー
111+
/// デコード(復号)時にOptionalCryptoFieldプロパティが復号に失敗した際に投げられるエラー
112112
///
113113
/// 暗号鍵が誤っている場合に投げられる
114114
public struct DecryptFailure: Error, Hashable, Codable, Sendable {}

Tests/CryptoCodableTests/CryptoFieldTests.swift renamed to Tests/CryptoCodableTests/OptionalCryptoFieldTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import CryptoCodable
33
import Foundation
44
import Testing
55

6-
@Suite struct CryptoFieldTests {
6+
@Suite struct OptionalCryptoFieldTests {
77
struct Event: Hashable, Codable, Sendable {
88
var id: UUID
99
var 職業: String
10-
@CryptoField var 個人情報: Self.個人情報?
10+
@OptionalCryptoField var 個人情報: Self.個人情報?
1111
struct 個人情報: Hashable, Codable, Sendable {
1212
var 氏名: String
1313
var 誕生日: Date

Tests/CryptoCodableTests/SymmetricKeyDataTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import Testing
55

66
@Suite struct SymmetricKeyDataTests {
77
struct Content: Hashable, Codable, Sendable {
8-
@CryptoField var value: String?
8+
@OptionalCryptoField var value: String?
99
}
1010

1111
@Test func Dataに一度変換したもので復号可能() throws {

0 commit comments

Comments
 (0)