signalapp/Mantle
signalapp/Mantle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: signalapp:master
Branches Tags
signalapp:master
signalapp:signal-master
signalapp:watchos-target
signalapp:1.x-maintenance
signalapp:mtlmanagedobject
signalapp:bump-xcconfigs
signalapp:bump-config
signalapp:github-reversible-transformer
signalapp:2.1.0
signalapp:2.0.7
signalapp:1.5.8
signalapp:1.5.7
signalapp:1.5.6
signalapp:2.0.5
signalapp:2.0.4
signalapp:1.5.5
signalapp:2.0.3
signalapp:2.0.2
signalapp:2.0.1
signalapp:2.0
signalapp:2.0-beta.1
signalapp:1.5.4
signalapp:1.5.3
signalapp:1.5.2
signalapp:1.5.1
signalapp:1.5
signalapp:1.4.1
signalapp:1.4
signalapp:1.3.1
signalapp:1.3
signalapp:1.2
signalapp:1.1.2
signalapp:1.1.1
signalapp:1.1
signalapp:1.0.1
signalapp:1.0
signalapp:0.4.1
signalapp:0.4
signalapp:0.3.1
signalapp:0.3
signalapp:0.2.3
signalapp:0.2.2
signalapp:0.2.1
signalapp:0.2
signalapp:0.1
..
compare: signalapp:github-reversible-transformer
Branches Tags
signalapp:signal-master
signalapp:master
signalapp:watchos-target
signalapp:1.x-maintenance
signalapp:mtlmanagedobject
signalapp:bump-xcconfigs
signalapp:bump-config
signalapp:github-reversible-transformer
signalapp:2.1.0
signalapp:2.0.7
signalapp:1.5.8
signalapp:1.5.7
signalapp:1.5.6
signalapp:2.0.5
signalapp:2.0.4
signalapp:1.5.5
signalapp:2.0.3
signalapp:2.0.2
signalapp:2.0.1
signalapp:2.0
signalapp:2.0-beta.1
signalapp:1.5.4
signalapp:1.5.3
signalapp:1.5.2
signalapp:1.5.1
signalapp:1.5
signalapp:1.4.1
signalapp:1.4
signalapp:1.3.1
signalapp:1.3
signalapp:1.2
signalapp:1.1.2
signalapp:1.1.1
signalapp:1.1
signalapp:1.0.1
signalapp:1.0
signalapp:0.4.1
signalapp:0.4
signalapp:0.3.1
signalapp:0.3
signalapp:0.2.3
signalapp:0.2.2
signalapp:0.2.1
signalapp:0.2
signalapp:0.1

1 Commits
master ... github-rev

Author SHA1 Message Date
Josh Vera
4687fb32c6 Expose reversible transformer interface to make it easier to subclass 2013-08-30 11:02:41 -07:00
84 changed files with 2828 additions and 6022 deletions
Show Stats Expand all files Collapse all files

4
.gitignore vendored
View File

@ -13,9 +13,5 @@ build/*
xcuserdata
profile
*.moved-aside
# AppCode etc.
.idea/
# Desktop Servies
.DS_Store
Carthage/Build

20
.gitmodules vendored
View File

@ -1,13 +1,9 @@
[submodule "Carthage.checkout/Nimble"]
path = Carthage/Checkouts/Nimble
url = https://github.com/Quick/Nimble.git
[submodule "Carthage.checkout/Quick"]
path = Carthage/Checkouts/Quick
url = https://github.com/Quick/Quick.git
[submodule "Carthage.checkout/xcconfigs"]
path = Carthage/Checkouts/xcconfigs
[submodule "MantleTests/expecta"]
path = MantleTests/expecta
url = git://github.com/github/expecta.git
[submodule "MantleTests/specta"]
path = MantleTests/specta
url = git://github.com/github/specta.git
[submodule "Configuration"]
path = Configuration
url = https://github.com/jspahrsummers/xcconfigs.git
[submodule "Carthage/Checkouts/Nimble"]
url = https://github.com/Quick/Nimble.git
[submodule "Carthage/Checkouts/Quick"]
url = https://github.com/Quick/Quick.git

67
.travis.yml
View File

@ -1,70 +1,5 @@
language: objective-c
xcode_workspace: Mantle.xcworkspace
git:
submodules: false
before_install:
- git submodule update --init --recursive
script:
- set -o pipefail
- xcodebuild $XCODE_ACTION
-workspace "$TRAVIS_XCODE_WORKSPACE"
-scheme "$TRAVIS_XCODE_SCHEME"
-sdk "$XCODE_SDK"
-destination "$XCODE_DESTINATION"
RUN_CLANG_STATIC_ANALYZER=NO
| xcpretty
matrix:
include:
# Xcode 8
- xcode_scheme: "Mantle Mac"
osx_image: xcode8.3
env:
- XCODE_ACTION=test
- XCODE_SDK=macosx
- XCODE_DESTINATION="arch=x86_64"
- xcode_scheme: "Mantle iOS"
osx_image: xcode8.3
env:
- XCODE_ACTION=test
- XCODE_SDK=iphonesimulator
- XCODE_DESTINATION="name=iPhone 7"
- xcode_scheme: "Mantle-tvOS"
osx_image: xcode8.3
env:
- XCODE_ACTION=test
- XCODE_SDK=appletvsimulator
- XCODE_DESTINATION="name=Apple TV 1080p"
- xcode_scheme: "Mantle-watchOS"
osx_image: xcode8.3
env:
- XCODE_ACTION=build
- XCODE_SDK=watchsimulator
- XCODE_DESTINATION="name=Apple Watch - 38mm"
# Xcode 9
- xcode_scheme: "Mantle Mac"
osx_image: xcode9
env:
- XCODE_ACTION=test
- XCODE_SDK=macosx
- XCODE_DESTINATION="arch=x86_64"
- xcode_scheme: "Mantle iOS"
osx_image: xcode9
env:
- XCODE_ACTION=test
- XCODE_SDK=iphonesimulator
- XCODE_DESTINATION="name=iPhone 7"
- xcode_scheme: "Mantle-tvOS"
osx_image: xcode9
env:
- XCODE_ACTION=test
- XCODE_SDK=appletvsimulator
- XCODE_DESTINATION="name=Apple TV 1080p"
- xcode_scheme: "Mantle-watchOS"
osx_image: xcode9
env:
- XCODE_ACTION=build
- XCODE_SDK=watchsimulator
- XCODE_DESTINATION="name=Apple Watch - 38mm"
script: script/cibuild
notifications:
email: false
campfire:

188
CHANGELOG.md
View File

@ -1,188 +0,0 @@
# 2.0
This release of Mantle contains major breaking changes that we were unable to
make after freezing the 1.0 API.
The changes in 2.0 focus on simplifying concepts and increasing flexibility in
the framework.
For a complete list of the changes made in Mantle 2.0, see [the
milestone](https://github.com/Mantle/Mantle/issues?q=milestone%3A2.0+is%3Aclosed).
**[Breaking changes](#breaking-changes)**
1. [Explicit JSON key paths](#explicit-json-key-paths)
1. [Predefined transformers now part of JSON adapter](#predefined-transformers-now-part-of-json-adapter)
1. [Core Data adapter now separate](#core-data-adapter-now-separate)
1. [Managed object transformers reversed](#managed-object-transformers-reversed)
1. [OS X 10.9 and iOS 8](#os-x-109-and-ios-8)
1. [JSON key paths can only traverse objects](#json-key-paths-can-only-traverse-objects)
**[Additions and improvements](#additions-and-improvements)**
1. [MTLModel protocol](#mtlmodel-protocol)
1. [Error handling for value transformers](#error-handling-for-value-transformers)
1. [Storage behaviors for properties](#storage-behaviors-for-properties)
1. [Type checking during JSON parsing](#type-checking-during-json-parsing)
1. [Mapping multiple JSON fields to a single property](#mapping-multiple-json-fields-to-a-single-property)
## Breaking changes
### Explicit JSON key paths
`+JSONKeyPathsByPropertyKey` will [no
longer](https://github.com/Mantle/Mantle/pull/170) infer your property mappings
automatically.
Instead, you must explicitly specify every property that should
be mapped, and any properties omitted will not be considered for JSON
serialization or deserialization.
For convenience, you can use `+[NSDictionary mtl_identityPropertyMapWithModel:]`
to automatically create a one-to-one mapping that matches the previous default
behavior.
**To update:**
* Explicitly declare any property mappings in `+JSONKeyPathsByPropertyKey`
that were previously implicit.
* Optionally use `+[NSDictionary mtl_identityPropertyMapWithModel:]` for an
initial property map.
### Predefined transformers now part of JSON adapter
The `+mtl_JSONDictionaryTransformerWithModelClass:` and
`+mtl_JSONArrayWithModelClass:` methods [have
moved](https://github.com/Mantle/Mantle/pull/474) to `MTLJSONAdapter`.
This allows custom JSON adapter subclasses to substitute their own transformers
with additional logic, and moves the transformers closer to their actual point
of use.
**To update:**
* Replace occurrences of `+[NSValueTransformer
mtl_JSONDictionaryTransformerWithModelClass:]` with `+[MTLJSONAdapter
dictionaryTransformerWithModelClass:]`
* Replace occurrences of `+[NSValueTransformer
mtl_JSONArrayTransformerWithModelClass:]` with `+[MTLJSONAdapter
arrayTransformerWithModelClass:]`
### Core Data adapter now separate
The `MTLManagedObjectAdapter` class, used for converting to and from Core Data
objects, has been moved to [its own
framework](https://github.com/Mantle/MTLManagedObjectAdapter). This better
indicates its “semi-official” status, as it gets less attention than the core
Mantle features.
**To update:**
* Import the
[MTLManagedObjectAdapter](https://github.com/Mantle/MTLManagedObjectAdapter)
framework into your project.
### Managed object transformers reversed
In addition to being [a separate framework](#core-data-adapter-now-separate),
the behavior of `MTLManagedObjectAdapter` has changed as well—specifically, the
direction of managed object attribute transformers has been flipped.
Managed object transformers now convert _from_ managed object attributes _to_
model properties in the forward direction. In the reverse direction, they
convert from properties to managed object attributes.
**To update:**
* Swap the forward and reverse transformation logic of any custom managed
object transformers, or use `-mtl_invertedTransformer` to do it
automatically.
### OS X 10.9 and iOS 8
Mantle now requires OS X 10.9+ or iOS 8+, for the use of Swift and dynamic
frameworks.
**To update:**
* Increase your project’s deployment target to at least OS X 10.9 or iOS 8.
### JSON key paths can only traverse objects
Every element of a JSON key path specified in `+JSONKeyPathsByPropertyKey` [must
now refer to an object](https://github.com/Mantle/Mantle/pull/275) (dictionary).
It was [previously possible](https://github.com/Mantle/Mantle/issues/257) to use
an array as a key path element, but this was unintended behavior, and is now
explicitly disallowed.
**To update:**
* If you were using an array as an element in a key path, change the key path
to end at the array, and [update your JSON transformer](https://github.com/Mantle/Mantle/issues/257#issuecomment-36846503)
to handle the nested elements instead.
## Additions and improvements
### MTLModel protocol
The [new `<MTLModel>` protocol](https://github.com/Mantle/Mantle/pull/219) represents the basic behaviors expected from any
model object, and can be used instead of the `MTLModel` class when inheritance
is impossible, or to create more generic APIs.
For example, `<MTLModel>` conformance can be added to the objects from other
persistence frameworks in order to use those objects in conjunction with
Mantle’s adapters.
Accordingly, `MTLJSONAdapter` has been updated to only depend on `<MTLModel>`
conformance, and no longer requires a `MTLModel` subclass in order to serialize
or deserialize from JSON.
### Error handling for value transformers
The [new `<MTLTransformerErrorHandling>`
protocol](https://github.com/Mantle/Mantle/pull/153) can be used to add error
reporting behaviors to any `NSValueTransformer`.
`MTLValueTransformer` has been updated to take advantage of the new interface,
with the following new methods that provide error information:
* `+transformerUsingForwardBlock:`
* `+transformerUsingReversibleBlock:`
* `+transformerUsingForwardBlock:reverseBlock:`
Similarly, the predefined transformers that Mantle provides now provide error
information upon failure as well.
### Storage behaviors for properties
The [new `+storageBehaviorForPropertyWithKey:`
method](https://github.com/Mantle/Mantle/pull/210) can be used to redefine the
default behavior of methods like `-dictionaryValue`, `-isEqual:`,
`-description`, and `-copy` all at once.
Properties which have been omitted from `+propertyKeys` by default will continue
to be omitted under the new API, with a default behavior of
`MTLPropertyStorageNone`.
### Type checking during JSON parsing
`MTLJSONAdapter` now [implicitly
validates](https://github.com/Mantle/Mantle/pull/251) the type of values
assigned to your `<MTLModel>` objects during JSON parsing.
This can be prevent errors like an `NSString` being assigned to a `BOOL`
property.
This is only a simple safety check, though, and cannot catch every kind of
error! Continue to verify that your types align ahead of time.
### Mapping multiple JSON fields to a single property
`MTLJSONAdapter` can now map multiple fields to a single property, and
vice-versa. Specify an array of keypaths for the property when implementing
`+JSONKeyPathsByPropertyKey` rather than an `NSString`.
The default behaviour is to set the property to a dictionary of values for the
specified keypaths. If you specify a value transformer for the given property
key, this transformer will receive an `NSDictionary` of values.

3
Cartfile.private
View File

@ -1,3 +0,0 @@
github "jspahrsummers/xcconfigs" "1ef9763"
github "Quick/Quick" ~> 1.1.0
github "Quick/Nimble" ~> 7.0.1

3
Cartfile.resolved
View File

@ -1,3 +0,0 @@
github "Quick/Nimble" "v7.0.1"
github "Quick/Quick" "v1.1.0"
github "jspahrsummers/xcconfigs" "1ef97639ffbe041da0b1392b2114fa19b922a7a1"

1
Carthage/Checkouts/Nimble vendored

@ -1 +0,0 @@
Subproject commit 39b67002306fda9de4c9fd1290a6295f97edd09e

1
Carthage/Checkouts/Quick vendored

@ -1 +0,0 @@
Subproject commit e4fa1e85c0305ba4e0866f25812d3fa398f3a048

1
Carthage/Checkouts/xcconfigs vendored

@ -1 +0,0 @@
Subproject commit 1ef97639ffbe041da0b1392b2114fa19b922a7a1

1
Configuration Submodule

@ -0,0 +1 @@
Subproject commit 23f7c17fbd74a091694632907d3a3a4e65125d58

2
LICENSE.md
View File

@ -1,4 +1,4 @@
**Copyright (c) GitHub, Inc.**
**Copyright (c) 2012 - 2013, GitHub, Inc.**
**All rights reserved.**
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

1701
Mantle.xcodeproj/project.pbxproj
View File

File diff suppressed because it is too large Load Diff

95
Mantle.xcodeproj/xcshareddata/xcschemes/Mantle Mac.xcscheme
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0800"
version = "2.0">
LastUpgradeVersion = "0500"
version = "1.3">
<BuildAction
parallelizeBuildables = "NO"
buildImplicitDependencies = "NO">
parallelizeBuildables = "YES"
buildImplicitDependencies = "YES">
<BuildActionEntries>
<BuildActionEntry
buildForTesting = "YES"
@ -16,121 +16,62 @@
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC3B15F72B23004E8054"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-Mac"
BlueprintName = "Mantle Mac"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForRunning = "YES"
buildForProfiling = "YES"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "1F925EAC195C0D6300ED456B"
BuildableName = "Nimble.framework"
BlueprintName = "Nimble-macOS"
ReferencedContainer = "container:Carthage/Checkouts/Nimble/Nimble.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "DAEB6B8D1943873100289F44"
BuildableName = "Quick.framework"
BlueprintName = "Quick-macOS"
ReferencedContainer = "container:Carthage/Checkouts/Quick/Quick.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC5315F72B23004E8054"
BuildableName = "Mantle-MacTests.xctest"
BlueprintName = "Mantle-MacTests"
BuildableName = "Mantle Mac Tests.octest"
BlueprintName = "Mantle Mac Tests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
</BuildAction>
<TestAction
buildConfiguration = "Release"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
shouldUseLaunchSchemeArgsEnv = "YES">
shouldUseLaunchSchemeArgsEnv = "YES"
buildConfiguration = "Debug">
<Testables>
<TestableReference
skipped = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC5315F72B23004E8054"
BuildableName = "Mantle-MacTests.xctest"
BlueprintName = "Mantle-MacTests"
BuildableName = "Mantle Mac Tests.octest"
BlueprintName = "Mantle Mac Tests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</TestableReference>
</Testables>
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC3B15F72B23004E8054"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-Mac"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</TestAction>
<LaunchAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = ""
selectedLauncherIdentifier = "Xcode.IDEFoundation.Launcher.PosixSpawn"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
buildConfiguration = "Debug"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
debugXPCServices = "NO"
debugServiceExtension = "internal"
allowLocationSimulation = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC3B15F72B23004E8054"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-Mac"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
buildConfiguration = "Profile"
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
buildConfiguration = "Profile"
debugDocumentVersioning = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D042FC3B15F72B23004E8054"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-Mac"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">

96
Mantle.xcodeproj/xcshareddata/xcschemes/Mantle iOS.xcscheme
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0800"
LastUpgradeVersion = "0500"
version = "1.3">
<BuildAction
parallelizeBuildables = "NO"
buildImplicitDependencies = "NO">
parallelizeBuildables = "YES"
buildImplicitDependencies = "YES">
<BuildActionEntries>
<BuildActionEntry
buildForTesting = "YES"
@ -14,122 +14,64 @@
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C35619F6DB38000D427D"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-iOS"
BlueprintIdentifier = "D042FC7815F72BC7004E8054"
BuildableName = "libMantle.a"
BlueprintName = "Mantle iOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForRunning = "YES"
buildForProfiling = "YES"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "1F1A74281940169200FFFC47"
BuildableName = "Nimble.framework"
BlueprintName = "Nimble-iOS"
ReferencedContainer = "container:Carthage/Checkouts/Nimble/Nimble.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "5A5D117B19473F2100F6D13D"
BuildableName = "Quick.framework"
BlueprintName = "Quick-iOS"
ReferencedContainer = "container:Carthage/Checkouts/Quick/Quick.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C36019F6DB38000D427D"
BuildableName = "Mantle-iOSTests.xctest"
BlueprintName = "Mantle-iOSTests"
BlueprintIdentifier = "D042FC8615F72BC7004E8054"
BuildableName = "Mantle iOS Tests.octest"
BlueprintName = "Mantle iOS Tests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
</BuildAction>
<TestAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
shouldUseLaunchSchemeArgsEnv = "YES">
shouldUseLaunchSchemeArgsEnv = "YES"
buildConfiguration = "Debug">
<Testables>
<TestableReference
skipped = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C36019F6DB38000D427D"
BuildableName = "Mantle-iOSTests.xctest"
BlueprintName = "Mantle-iOSTests"
BlueprintIdentifier = "D042FC8615F72BC7004E8054"
BuildableName = "Mantle iOS Tests.octest"
BlueprintName = "Mantle iOS Tests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</TestableReference>
</Testables>
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C35619F6DB38000D427D"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-iOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</TestAction>
<LaunchAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
buildConfiguration = "Debug"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
debugServiceExtension = "internal"
allowLocationSimulation = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C35619F6DB38000D427D"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-iOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
buildConfiguration = "Release"
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
buildConfiguration = "Profile"
debugDocumentVersioning = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "D0E9C35619F6DB38000D427D"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-iOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">

141
Mantle.xcodeproj/xcshareddata/xcschemes/Mantle-tvOS.xcscheme
View File

@ -1,141 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0800"
version = "1.3">
<BuildAction
parallelizeBuildables = "NO"
buildImplicitDependencies = "NO">
<BuildActionEntries>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "YES"
buildForProfiling = "YES"
buildForArchiving = "YES"
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABA71D33FC5100240A4B"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-tvOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "1F5DF1541BDCA0CE00C3A531"
BuildableName = "Nimble.framework"
BlueprintName = "Nimble-tvOS"
ReferencedContainer = "container:Carthage/Checkouts/Nimble/Nimble.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "1F118CD41BDCA4AB005013A2"
BuildableName = "Quick.framework"
BlueprintName = "Quick-tvOS"
ReferencedContainer = "container:Carthage/Checkouts/Quick/Quick.xcodeproj">
</BuildableReference>
</BuildActionEntry>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "NO"
buildForProfiling = "NO"
buildForArchiving = "NO"
buildForAnalyzing = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABD31D33FC7900240A4B"
BuildableName = "Mantle-tvOSTests.xctest"
BlueprintName = "Mantle-tvOSTests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
</BuildAction>
<TestAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
shouldUseLaunchSchemeArgsEnv = "YES">
<Testables>
<TestableReference
skipped = "NO">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABD31D33FC7900240A4B"
BuildableName = "Mantle-tvOSTests.xctest"
BlueprintName = "Mantle-tvOSTests"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</TestableReference>
</Testables>
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABA71D33FC5100240A4B"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-tvOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</TestAction>
<LaunchAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
debugServiceExtension = "internal"
allowLocationSimulation = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABA71D33FC5100240A4B"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-tvOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
buildConfiguration = "Release"
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
debugDocumentVersioning = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CDEEABA71D33FC5100240A4B"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-tvOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">
</AnalyzeAction>
<ArchiveAction
buildConfiguration = "Release"
revealArchiveInOrganizer = "YES">
</ArchiveAction>
</Scheme>

80
Mantle.xcodeproj/xcshareddata/xcschemes/Mantle-watchOS.xcscheme
View File

@ -1,80 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0800"
version = "1.3">
<BuildAction
parallelizeBuildables = "NO"
buildImplicitDependencies = "NO">
<BuildActionEntries>
<BuildActionEntry
buildForTesting = "YES"
buildForRunning = "YES"
buildForProfiling = "YES"
buildForArchiving = "YES"
buildForAnalyzing = "YES">
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CD7C6D881D33ACCC002EC294"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-watchOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
</BuildAction>
<TestAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
shouldUseLaunchSchemeArgsEnv = "YES">
<Testables>
</Testables>
<AdditionalOptions>
</AdditionalOptions>
</TestAction>
<LaunchAction
buildConfiguration = "Debug"
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
debugServiceExtension = "internal"
allowLocationSimulation = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CD7C6D881D33ACCC002EC294"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-watchOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
buildConfiguration = "Release"
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
debugDocumentVersioning = "YES">
<MacroExpansion>
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "CD7C6D881D33ACCC002EC294"
BuildableName = "Mantle.framework"
BlueprintName = "Mantle-watchOS"
ReferencedContainer = "container:Mantle.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">
</AnalyzeAction>
<ArchiveAction
buildConfiguration = "Release"
revealArchiveInOrganizer = "YES">
</ArchiveAction>
</Scheme>

13
Mantle.xcworkspace/contents.xcworkspacedata generated
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<Workspace
version = "1.0">
<FileRef
location = "group:Mantle.xcodeproj">
</FileRef>
<FileRef
location = "group:Carthage/Checkouts/Quick/Quick.xcodeproj">
</FileRef>
<FileRef
location = "group:Carthage/Checkouts/Nimble/Nimble.xcodeproj">
</FileRef>
</Workspace>

332
Mantle/MTLJSONAdapter.h
View File

@ -8,280 +8,120 @@
#import <Foundation/Foundation.h>
@protocol MTLModel;
@protocol MTLTransformerErrorHandling;
@class MTLModel;
/// A MTLModel object that supports being parsed from and serialized to JSON.
@protocol MTLJSONSerializing <MTLModel>
// A MTLModel object that supports being parsed from and serialized to JSON.
@protocol MTLJSONSerializing
@required
/// Specifies how to map property keys to different key paths in JSON.
///
/// Subclasses overriding this method should combine their values with those of
/// `super`.
///
/// Values in the dictionary can either be key paths in the JSON representation
/// of the receiver or an array of such key paths. If an array is used, the
/// deserialized value will be a dictionary containing all of the keys in the
/// array.
///
/// Any keys omitted will not participate in JSON serialization.
///
/// Examples
///
/// + (NSDictionary *)JSONKeyPathsByPropertyKey {
/// return @{
/// @"name": @"POI.name",
/// @"point": @[ @"latitude", @"longitude" ],
/// @"starred": @"starred"
/// };
/// }
///
/// This will map the `starred` property to `JSONDictionary[@"starred"]`, `name`
/// to `JSONDictionary[@"POI"][@"name"]` and `point` to a dictionary equivalent
/// to:
///
/// @{
/// @"latitude": JSONDictionary[@"latitude"],
/// @"longitude": JSONDictionary[@"longitude"]
/// }
///
/// Returns a dictionary mapping property keys to one or multiple JSON key paths
/// (as strings or arrays of strings).
// Specifies how to map property keys to different key paths in JSON.
//
// Subclasses overriding this method should combine their values with those of
// `super`.
//
// Any property keys not present in the dictionary are assumed to match the JSON
// key that should be used. Any keys associated with NSNull will not participate
// in JSON serialization.
//
// Returns a dictionary mapping property keys to JSON key paths (as strings) or
// NSNull values.
+ (NSDictionary *)JSONKeyPathsByPropertyKey;
@optional
/// Specifies how to convert a JSON value to the given property key. If
/// reversible, the transformer will also be used to convert the property value
/// back to JSON.
///
/// If the receiver implements a `+<key>JSONTransformer` method, MTLJSONAdapter
/// will use the result of that method instead.
///
/// Returns a value transformer, or nil if no transformation should be performed.
// Specifies how to convert a JSON value to the given property key. If
// reversible, the transformer will also be used to convert the property value
// back to JSON.
//
// If the receiver implements a `+<key>JSONTransformer` method, MTLJSONAdapter
// will use the result of that method instead.
//
// Returns a value transformer, or nil if no transformation should be performed.
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key;
/// Overridden to parse the receiver as a different class, based on information
/// in the provided dictionary.
///
/// This is mostly useful for class clusters, where the abstract base class would
/// be passed into -[MTLJSONAdapter initWithJSONDictionary:modelClass:], but
/// a subclass should be instantiated instead.
///
/// JSONDictionary - The JSON dictionary that will be parsed.
///
/// Returns the class that should be parsed (which may be the receiver), or nil
/// to abort parsing (e.g., if the data is invalid).
// Overridden to parse the receiver as a different class, based on information
// in the provided dictionary.
//
// This is mostly useful for class clusters, where the abstract base class would
// be passed into -[MTLJSONAdapter initWithJSONDictionary:modelClass:], but
// a subclass should be instantiated instead.
//
// JSONDictionary - The JSON dictionary that will be parsed.
//
// Returns the class that should be parsed (which may be the receiver), or nil
// to abort parsing (e.g., if the data is invalid).
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary;
@end
/// The domain for errors originating from MTLJSONAdapter.
// The domain for errors originating from MTLJSONAdapter.
extern NSString * const MTLJSONAdapterErrorDomain;
/// +classForParsingJSONDictionary: returned nil for the given dictionary.
// +classForParsingJSONDictionary: returned nil for the given dictionary.
extern const NSInteger MTLJSONAdapterErrorNoClassFound;
/// The provided JSONDictionary is not valid.
extern const NSInteger MTLJSONAdapterErrorInvalidJSONDictionary;
/// The model's implementation of +JSONKeyPathsByPropertyKey included a key which
/// does not actually exist in +propertyKeys.
extern const NSInteger MTLJSONAdapterErrorInvalidJSONMapping;
/// An exception was thrown and caught.
extern const NSInteger MTLJSONAdapterErrorExceptionThrown;
/// Associated with the NSException that was caught.
extern NSString * const MTLJSONAdapterThrownExceptionErrorKey;
/// Converts a MTLModel object to and from a JSON dictionary.
// Converts a MTLModel object to and from a JSON dictionary.
@interface MTLJSONAdapter : NSObject
/// Attempts to parse a JSON dictionary into a model object.
///
/// modelClass - The MTLModel subclass to attempt to parse from the JSON.
/// This class must conform to <MTLJSONSerializing>. This
/// argument must not be nil.
/// JSONDictionary - A dictionary representing JSON data. This should match the
/// format returned by NSJSONSerialization. If this argument is
/// nil, the method returns nil.
/// error - If not NULL, this may be set to an error that occurs during
/// parsing or initializing an instance of `modelClass`.
///
/// Returns an instance of `modelClass` upon success, or nil if a parsing error
/// occurred.
// The model object that the receiver was initialized with, or that the receiver
// parsed from a JSON dictionary.
@property (nonatomic, strong, readonly) MTLModel<MTLJSONSerializing> *model;
// Attempts to parse a JSON dictionary into a model object.
//
// modelClass - The MTLModel subclass to attempt to parse from the JSON.
// This class must conform to <MTLJSONSerializing>. This
// argument must not be nil.
// JSONDictionary - A dictionary representing JSON data. This should match the
// format returned by NSJSONSerialization. If this argument is
// nil, the method returns nil.
// error - If not NULL, this may be set to an error that occurs during
// parsing or initializing an instance of `modelClass`.
//
// Returns an instance of `modelClass` upon success, or nil if a parsing error
// occurred.
+ (id)modelOfClass:(Class)modelClass fromJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError **)error;
/// Attempts to parse an array of JSON dictionary objects into a model objects
/// of a specific class.
///
/// modelClass - The MTLModel subclass to attempt to parse from the JSON. This
/// class must conform to <MTLJSONSerializing>. This argument must
/// not be nil.
/// JSONArray - A array of dictionaries representing JSON data. This should
/// match the format returned by NSJSONSerialization. If this
/// argument is nil, the method returns nil.
/// error - If not NULL, this may be set to an error that occurs during
/// parsing or initializing an any of the instances of
/// `modelClass`.
///
/// Returns an array of `modelClass` instances upon success, or nil if a parsing
/// error occurred.
+ (NSArray *)modelsOfClass:(Class)modelClass fromJSONArray:(NSArray *)JSONArray error:(NSError **)error;
// Converts a model into a JSON representation.
//
// model - The model to use for JSON serialization. This argument must not be
// nil.
//
// Returns a JSON dictionary, or nil if a serialization error occurred.
+ (NSDictionary *)JSONDictionaryFromModel:(MTLModel<MTLJSONSerializing> *)model;
/// Converts a model into a JSON representation.
///
/// model - The model to use for JSON serialization. This argument must not be
/// nil.
/// error - If not NULL, this may be set to an error that occurs during
/// serializing.
///
/// Returns a JSON dictionary, or nil if a serialization error occurred.
+ (NSDictionary *)JSONDictionaryFromModel:(id<MTLJSONSerializing>)model error:(NSError **)error;
// Initializes the receiver by attempting to parse a JSON dictionary into
// a model object.
//
// JSONDictionary - A dictionary representing JSON data. This should match the
// format returned by NSJSONSerialization. If this argument is
// nil, the method returns nil.
// modelClass - The MTLModel subclass to attempt to parse from the JSON.
// This class must conform to <MTLJSONSerializing>. This
// argument must not be nil.
// error - If not NULL, this may be set to an error that occurs during
// parsing or initializing an instance of `modelClass`.
//
// Returns an initialized adapter upon success, or nil if a parsing error
// occurred.
- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass error:(NSError **)error;
/// Converts a array of models into a JSON representation.
///
/// models - The array of models to use for JSON serialization. This argument
/// must not be nil.
/// error - If not NULL, this may be set to an error that occurs during
/// serializing.
///
/// Returns a JSON array, or nil if a serialization error occurred for any
/// model.
+ (NSArray *)JSONArrayFromModels:(NSArray *)models error:(NSError **)error;
// Initializes the receiver with an existing model.
//
// model - The model to use for JSON serialization. This argument must not be
// nil.
- (id)initWithModel:(MTLModel<MTLJSONSerializing> *)model;
/// Initializes the receiver with a given model class.
///
/// modelClass - The MTLModel subclass to attempt to parse from the JSON and
/// back. This class must conform to <MTLJSONSerializing>. This
/// argument must not be nil.
///
/// Returns an initialized adapter.
- (id)initWithModelClass:(Class)modelClass;
/// Deserializes a model from a JSON dictionary.
///
/// The adapter will call -validate: on the model and consider it an error if the
/// validation fails.
///
/// JSONDictionary - A dictionary representing JSON data. This should match the
/// format returned by NSJSONSerialization. This argument must
/// not be nil.
/// error - If not NULL, this may be set to an error that occurs during
/// deserializing or validation.
///
/// Returns a model object, or nil if a deserialization error occurred or the
/// model did not validate successfully.
- (id)modelFromJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError **)error;
/// Serializes a model into JSON.
///
/// model - The model to use for JSON serialization. This argument must not be
/// nil.
/// error - If not NULL, this may be set to an error that occurs during
/// serializing.
///
/// Returns a model object, or nil if a serialization error occurred.
- (NSDictionary *)JSONDictionaryFromModel:(id<MTLJSONSerializing>)model error:(NSError **)error;
/// Filters the property keys used to serialize a given model.
///
/// propertyKeys - The property keys for which `model` provides a mapping.
/// model - The model being serialized.
///
/// Subclasses may override this method to determine which property keys should
/// be used when serializing `model`. For instance, this method can be used to
/// create more efficient updates of server-side resources.
///
/// The default implementation simply returns `propertyKeys`.
///
/// Returns a subset of propertyKeys that should be serialized for a given
/// model.
- (NSSet *)serializablePropertyKeys:(NSSet *)propertyKeys forModel:(id<MTLJSONSerializing>)model;
/// An optional value transformer that should be used for properties of the given
/// class.
///
/// A value transformer returned by the model's +JSONTransformerForKey: method
/// is given precedence over the one returned by this method.
///
/// The default implementation invokes `+<class>JSONTransformer` on the
/// receiver if it's implemented. It supports NSURL conversion through
/// +NSURLJSONTransformer.
///
/// modelClass - The class of the property to serialize. This property must not be
/// nil.
///
/// Returns a value transformer or nil if no transformation should be used.
+ (NSValueTransformer *)transformerForModelPropertiesOfClass:(Class)modelClass;
/// A value transformer that should be used for a properties of the given
/// primitive type.
///
/// If `objCType` matches @‎encode(id), the value transformer returned by
/// +transformerForModelPropertiesOfClass: is used instead.
///
/// The default implementation transforms properties that match @‎encode(BOOL)
/// using the MTLBooleanValueTransformerName transformer.
///
/// objCType - The type encoding for the value of this property. This is the type
/// as it would be returned by the @‎encode() directive.
///
/// Returns a value transformer or nil if no transformation should be used.
+ (NSValueTransformer *)transformerForModelPropertiesOfObjCType:(const char *)objCType;
// Serializes the receiver's `model` into JSON.
//
// Returns a JSON dictionary, or nil if a serialization error occurred.
- (NSDictionary *)JSONDictionary;
@end
@interface MTLJSONAdapter (ValueTransformers)
/// Creates a reversible transformer to convert a JSON dictionary into a MTLModel
/// object, and vice-versa.
///
/// modelClass - The MTLModel subclass to attempt to parse from the JSON. This
/// class must conform to <MTLJSONSerializing>. This argument must
/// not be nil.
///
/// Returns a reversible transformer which uses the class of the receiver for
/// transforming values back and forth.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)dictionaryTransformerWithModelClass:(Class)modelClass;
/// Creates a reversible transformer to convert an array of JSON dictionaries
/// into an array of MTLModel objects, and vice-versa.
///
/// modelClass - The MTLModel subclass to attempt to parse from each JSON
/// dictionary. This class must conform to <MTLJSONSerializing>.
/// This argument must not be nil.
///
/// Returns a reversible transformer which uses the class of the receiver for
/// transforming array elements back and forth.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)arrayTransformerWithModelClass:(Class)modelClass;
/// This value transformer is used by MTLJSONAdapter to automatically convert
/// NSURL properties to JSON strings and vice versa.
+ (NSValueTransformer *)NSURLJSONTransformer;
/// This value transformer is used by MTLJSONAdapter to automatically convert
/// NSUUID properties to JSON strings and vice versa.
+ (NSValueTransformer *)NSUUIDJSONTransformer;
@end
@class MTLModel;
@interface MTLJSONAdapter (Deprecated)
@property (nonatomic, strong, readonly) id<MTLJSONSerializing> model __attribute__((unavailable("Replaced by -modelFromJSONDictionary:error:")));
+ (NSArray *)JSONArrayFromModels:(NSArray *)models __attribute__((deprecated("Replaced by +JSONArrayFromModels:error:"))) NS_SWIFT_UNAVAILABLE("Replaced by +JSONArrayFromModels:error:");
+ (NSDictionary *)JSONDictionaryFromModel:(MTLModel<MTLJSONSerializing> *)model __attribute__((deprecated("Replaced by +JSONDictionaryFromModel:error:"))) NS_SWIFT_UNAVAILABLE("Replaced by +JSONDictionaryFromModel:error:");
- (NSDictionary *)JSONDictionary __attribute__((unavailable("Replaced by -JSONDictionaryFromModel:error:"))) NS_SWIFT_UNAVAILABLE("Replaced by -JSONDictionaryFromModel:error:");
- (NSString *)JSONKeyPathForPropertyKey:(NSString *)key __attribute__((unavailable("Replaced by -serializablePropertyKeys:forModel:")));
- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass error:(NSError **)error __attribute__((unavailable("Replaced by -initWithModelClass:")));
- (id)initWithModel:(id<MTLJSONSerializing>)model __attribute__((unavailable("Replaced by -initWithModelClass:"))) NS_SWIFT_UNAVAILABLE("Replaced by -initWithModelClass:");
- (NSDictionary *)serializeToJSONDictionary:(NSError **)error __attribute__((unavailable("Replaced by -JSONDictionaryFromModel:error:"))) NS_SWIFT_UNAVAILABLE("Replaced by -JSONDictionaryFromModel:error:");
+ (id)modelOfClass:(Class)modelClass fromJSONDictionary:(NSDictionary *)JSONDictionary __attribute__((deprecated("Replaced by +modelOfClass:fromJSONDictionary:error:")));
- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass __attribute__((deprecated("Replaced by -initWithJSONDictionary:modelClass:error:")));
@end

639
Mantle/MTLJSONAdapter.m
View File

@ -6,29 +6,18 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <objc/runtime.h>
#import "NSDictionary+MTLJSONKeyPath.h"
#import <Mantle/EXTRuntimeExtensions.h>
#import <Mantle/EXTScope.h>
#import "MTLJSONAdapter.h"
#import "MTLModel.h"
#import "MTLTransformerErrorHandling.h"
#import "MTLReflection.h"
#import "NSValueTransformer+MTLPredefinedTransformerAdditions.h"
#import "MTLValueTransformer.h"
NSString * const MTLJSONAdapterErrorDomain = @"MTLJSONAdapterErrorDomain";
const NSInteger MTLJSONAdapterErrorNoClassFound = 2;
const NSInteger MTLJSONAdapterErrorInvalidJSONDictionary = 3;
const NSInteger MTLJSONAdapterErrorInvalidJSONMapping = 4;
// An exception was thrown and caught.
const NSInteger MTLJSONAdapterErrorExceptionThrown = 1;
static const NSInteger MTLJSONAdapterErrorExceptionThrown = 1;
// Associated with the NSException that was caught.
NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownException";
static NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownException";
@interface MTLJSONAdapter ()
@ -39,33 +28,20 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
// A cached copy of the return value of +JSONKeyPathsByPropertyKey.
@property (nonatomic, copy, readonly) NSDictionary *JSONKeyPathsByPropertyKey;
// A cached copy of the return value of -valueTransformersForModelClass:
@property (nonatomic, copy, readonly) NSDictionary *valueTransformersByPropertyKey;
// Looks up the NSValueTransformer that should be used for the given key.
//
// key - The property key to transform from or to. This argument must not be nil.
//
// Returns a transformer to use, or nil to not transform the property.
- (NSValueTransformer *)JSONTransformerForKey:(NSString *)key;
// Used to cache the JSON adapters returned by -JSONAdapterForModelClass:error:.
@property (nonatomic, strong, readonly) NSMapTable *JSONAdaptersByModelClass;
// If +classForParsingJSONDictionary: returns a model class different from the
// one this adapter was initialized with, use this method to obtain a cached
// instance of a suitable adapter instead.
// Looks up the JSON key path that corresponds to the given key.
//
// modelClass - The class from which to parse the JSON. This class must conform
// to <MTLJSONSerializing>. This argument must not be nil.
// error - If not NULL, this may be set to an error that occurs during
// initializing the adapter.
// key - The property key to retrieve the corresponding JSON key path for. This
// argument must not be nil.
//
// Returns a JSON adapter for modelClass, creating one of necessary. If no
// adapter could be created, nil is returned.
- (MTLJSONAdapter *)JSONAdapterForModelClass:(Class)modelClass error:(NSError **)error;
// Collect all value transformers needed for a given class.
//
// modelClass - The class from which to parse the JSON. This class must conform
// to <MTLJSONSerializing>. This argument must not be nil.
//
// Returns a dictionary with the properties of modelClass that need
// transformation as keys and the value transformers as values.
+ (NSDictionary *)valueTransformersForModelClass:(Class)modelClass;
// Returns a key path to use, or nil to omit the property from JSON.
- (NSString *)JSONKeyPathForKey:(NSString *)key;
@end
@ -74,192 +50,32 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
#pragma mark Convenience methods
+ (id)modelOfClass:(Class)modelClass fromJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError **)error {
MTLJSONAdapter *adapter = [[self alloc] initWithModelClass:modelClass];
return [adapter modelFromJSONDictionary:JSONDictionary error:error];
MTLJSONAdapter *adapter = [[self alloc] initWithJSONDictionary:JSONDictionary modelClass:modelClass error:error];
return adapter.model;
}
+ (NSArray *)modelsOfClass:(Class)modelClass fromJSONArray:(NSArray *)JSONArray error:(NSError **)error {
if (JSONArray == nil || ![JSONArray isKindOfClass:NSArray.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Missing JSON array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"%@ could not be created because an invalid JSON array was provided: %@", @""), NSStringFromClass(modelClass), JSONArray.class],
};
*error = [NSError errorWithDomain:MTLJSONAdapterErrorDomain code:MTLJSONAdapterErrorInvalidJSONDictionary userInfo:userInfo];
}
return nil;
}
NSMutableArray *models = [NSMutableArray arrayWithCapacity:JSONArray.count];
for (NSDictionary *JSONDictionary in JSONArray){
MTLModel *model = [self modelOfClass:modelClass fromJSONDictionary:JSONDictionary error:error];
if (model == nil) return nil;
[models addObject:model];
}
return models;
}
+ (NSDictionary *)JSONDictionaryFromModel:(id<MTLJSONSerializing>)model error:(NSError **)error {
MTLJSONAdapter *adapter = [[self alloc] initWithModelClass:model.class];
return [adapter JSONDictionaryFromModel:model error:error];
}
+ (NSArray *)JSONArrayFromModels:(NSArray *)models error:(NSError **)error {
NSParameterAssert(models != nil);
NSParameterAssert([models isKindOfClass:NSArray.class]);
NSMutableArray *JSONArray = [NSMutableArray arrayWithCapacity:models.count];
for (MTLModel<MTLJSONSerializing> *model in models) {
NSDictionary *JSONDictionary = [self JSONDictionaryFromModel:model error:error];
if (JSONDictionary == nil) return nil;
[JSONArray addObject:JSONDictionary];
}
return JSONArray;
+ (NSDictionary *)JSONDictionaryFromModel:(MTLModel<MTLJSONSerializing> *)model {
MTLJSONAdapter *adapter = [[self alloc] initWithModel:model];
return adapter.JSONDictionary;
}
#pragma mark Lifecycle
- (id)init {
NSAssert(NO, @"%@ must be initialized with a model class", self.class);
NSAssert(NO, @"%@ must be initialized with a JSON dictionary or model object", self.class);
return nil;
}
- (id)initWithModelClass:(Class)modelClass {
- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass error:(NSError **)error {
NSParameterAssert(modelClass != nil);
NSParameterAssert([modelClass isSubclassOfClass:MTLModel.class]);
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)]);
self = [super init];
if (self == nil) return nil;
if (JSONDictionary == nil) return nil;
_modelClass = modelClass;
_JSONKeyPathsByPropertyKey = [modelClass JSONKeyPathsByPropertyKey];
NSSet *propertyKeys = [self.modelClass propertyKeys];
for (NSString *mappedPropertyKey in _JSONKeyPathsByPropertyKey) {
if (![propertyKeys containsObject:mappedPropertyKey]) {
NSAssert(NO, @"%@ is not a property of %@.", mappedPropertyKey, modelClass);
return nil;
}
id value = _JSONKeyPathsByPropertyKey[mappedPropertyKey];
if ([value isKindOfClass:NSArray.class]) {
for (NSString *keyPath in value) {
if ([keyPath isKindOfClass:NSString.class]) continue;
NSAssert(NO, @"%@ must either map to a JSON key path or a JSON array of key paths, got: %@.", mappedPropertyKey, value);
return nil;
}
} else if (![value isKindOfClass:NSString.class]) {
NSAssert(NO, @"%@ must either map to a JSON key path or a JSON array of key paths, got: %@.",mappedPropertyKey, value);
return nil;
}
}
_valueTransformersByPropertyKey = [self.class valueTransformersForModelClass:modelClass];
_JSONAdaptersByModelClass = [NSMapTable strongToStrongObjectsMapTable];
return self;
}
#pragma mark Serialization
- (NSDictionary *)JSONDictionaryFromModel:(id<MTLJSONSerializing>)model error:(NSError **)error {
NSParameterAssert(model != nil);
NSParameterAssert([model isKindOfClass:self.modelClass]);
if (self.modelClass != model.class) {
MTLJSONAdapter *otherAdapter = [self JSONAdapterForModelClass:model.class error:error];
return [otherAdapter JSONDictionaryFromModel:model error:error];
}
NSSet *propertyKeysToSerialize = [self serializablePropertyKeys:[NSSet setWithArray:self.JSONKeyPathsByPropertyKey.allKeys] forModel:model];
NSDictionary *dictionaryValue = [model.dictionaryValue dictionaryWithValuesForKeys:propertyKeysToSerialize.allObjects];
NSMutableDictionary *JSONDictionary = [[NSMutableDictionary alloc] initWithCapacity:dictionaryValue.count];
__block BOOL success = YES;
__block NSError *tmpError = nil;
[dictionaryValue enumerateKeysAndObjectsUsingBlock:^(NSString *propertyKey, id value, BOOL *stop) {
id JSONKeyPaths = self.JSONKeyPathsByPropertyKey[propertyKey];
if (JSONKeyPaths == nil) return;
NSValueTransformer *transformer = self.valueTransformersByPropertyKey[propertyKey];
if ([transformer.class allowsReverseTransformation]) {
// Map NSNull -> nil for the transformer, and then back for the
// dictionaryValue we're going to insert into.
if ([value isEqual:NSNull.null]) value = nil;
if ([transformer respondsToSelector:@selector(reverseTransformedValue:success:error:)]) {
id<MTLTransformerErrorHandling> errorHandlingTransformer = (id)transformer;
value = [errorHandlingTransformer reverseTransformedValue:value success:&success error:&tmpError];
if (!success) {
*stop = YES;
return;
}
} else {
value = [transformer reverseTransformedValue:value] ?: NSNull.null;
}
}
void (^createComponents)(id, NSString *) = ^(id obj, NSString *keyPath) {
NSArray *keyPathComponents = [keyPath componentsSeparatedByString:@"."];
// Set up dictionaries at each step of the key path.
for (NSString *component in keyPathComponents) {
if ([obj valueForKey:component] == nil) {
// Insert an empty mutable dictionary at this spot so that we
// can set the whole key path afterward.
[obj setValue:[NSMutableDictionary dictionary] forKey:component];
}
obj = [obj valueForKey:component];
}
};
if ([JSONKeyPaths isKindOfClass:NSString.class]) {
createComponents(JSONDictionary, JSONKeyPaths);
[JSONDictionary setValue:value forKeyPath:JSONKeyPaths];
}
if ([JSONKeyPaths isKindOfClass:NSArray.class]) {
for (NSString *JSONKeyPath in JSONKeyPaths) {
createComponents(JSONDictionary, JSONKeyPath);
[JSONDictionary setValue:value[JSONKeyPath] forKeyPath:JSONKeyPath];
}
}
}];
if (success) {
return JSONDictionary;
} else {
if (error != NULL) *error = tmpError;
return nil;
}
}
- (id)modelFromJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError **)error {
if ([self.modelClass respondsToSelector:@selector(classForParsingJSONDictionary:)]) {
Class class = [self.modelClass classForParsingJSONDictionary:JSONDictionary];
if (class == nil) {
if ([modelClass respondsToSelector:@selector(classForParsingJSONDictionary:)]) {
modelClass = [modelClass classForParsingJSONDictionary:JSONDictionary];
if (modelClass == nil) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not parse JSON", @""),
@ -272,70 +88,37 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
return nil;
}
if (class != self.modelClass) {
NSAssert([class conformsToProtocol:@protocol(MTLJSONSerializing)], @"Class %@ returned from +classForParsingJSONDictionary: does not conform to <MTLJSONSerializing>", class);
MTLJSONAdapter *otherAdapter = [self JSONAdapterForModelClass:class error:error];
return [otherAdapter modelFromJSONDictionary:JSONDictionary error:error];
}
NSAssert([modelClass isSubclassOfClass:MTLModel.class], @"Class %@ returned from +classForParsingJSONDictionary: is not a subclass of MTLModel", modelClass);
NSAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)], @"Class %@ returned from +classForParsingJSONDictionary: does not conform to <MTLJSONSerializing>", modelClass);
}
self = [super init];
if (self == nil) return nil;
_modelClass = modelClass;
_JSONKeyPathsByPropertyKey = [[modelClass JSONKeyPathsByPropertyKey] copy];
NSMutableDictionary *dictionaryValue = [[NSMutableDictionary alloc] initWithCapacity:JSONDictionary.count];
for (NSString *propertyKey in [self.modelClass propertyKeys]) {
id JSONKeyPaths = self.JSONKeyPathsByPropertyKey[propertyKey];
if (JSONKeyPaths == nil) continue;
id value;
if ([JSONKeyPaths isKindOfClass:NSArray.class]) {
NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
for (NSString *keyPath in JSONKeyPaths) {
BOOL success = NO;
id value = [JSONDictionary mtl_valueForJSONKeyPath:keyPath success:&success error:error];
if (!success) return nil;
if (value != nil) dictionary[keyPath] = value;
}
value = dictionary;
} else {
BOOL success = NO;
value = [JSONDictionary mtl_valueForJSONKeyPath:JSONKeyPaths success:&success error:error];
if (!success) return nil;
}
NSString *JSONKeyPath = [self JSONKeyPathForKey:propertyKey];
if (JSONKeyPath == nil) continue;
id value = [JSONDictionary valueForKeyPath:JSONKeyPath];
if (value == nil) continue;
@try {
NSValueTransformer *transformer = self.valueTransformersByPropertyKey[propertyKey];
NSValueTransformer *transformer = [self JSONTransformerForKey:propertyKey];
if (transformer != nil) {
// Map NSNull -> nil for the transformer, and then back for the
// dictionary we're going to insert into.
if ([value isEqual:NSNull.null]) value = nil;
if ([transformer respondsToSelector:@selector(transformedValue:success:error:)]) {
id<MTLTransformerErrorHandling> errorHandlingTransformer = (id)transformer;
BOOL success = YES;
value = [errorHandlingTransformer transformedValue:value success:&success error:error];
if (!success) return nil;
} else {
value = [transformer transformedValue:value];
}
if (value == nil) value = NSNull.null;
value = [transformer transformedValue:value] ?: NSNull.null;
}
dictionaryValue[propertyKey] = value;
} @catch (NSException *ex) {
NSLog(@"*** Caught exception %@ parsing JSON key path \"%@\" from: %@", ex, JSONKeyPaths, JSONDictionary);
NSLog(@"*** Caught exception %@ parsing JSON key path \"%@\" from: %@", ex, JSONKeyPath, JSONDictionary);
// Fail fast in Debug builds.
#if DEBUG
@ -343,8 +126,7 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
#else
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Caught exception parsing JSON key path \"%@\" for model class: %@", JSONKeyPaths, self.modelClass],
NSLocalizedRecoverySuggestionErrorKey: ex.description,
NSLocalizedDescriptionKey: ex.description,
NSLocalizedFailureReasonErrorKey: ex.reason,
MTLJSONAdapterThrownExceptionErrorKey: ex
};
@ -357,295 +139,96 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
}
}
id model = [self.modelClass modelWithDictionary:dictionaryValue error:error];
_model = [self.modelClass modelWithDictionary:dictionaryValue error:error];
if (_model == nil) return nil;
return [model validate:error] ? model : nil;
return self;
}
+ (NSDictionary *)valueTransformersForModelClass:(Class)modelClass {
NSParameterAssert(modelClass != nil);
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)]);
- (id)initWithModel:(MTLModel<MTLJSONSerializing> *)model {
NSParameterAssert(model != nil);
NSMutableDictionary *result = [NSMutableDictionary dictionary];
self = [super init];
if (self == nil) return nil;
for (NSString *key in [modelClass propertyKeys]) {
SEL selector = MTLSelectorWithKeyPattern(key, "JSONTransformer");
if ([modelClass respondsToSelector:selector]) {
IMP imp = [modelClass methodForSelector:selector];
NSValueTransformer * (*function)(id, SEL) = (__typeof__(function))imp;
NSValueTransformer *transformer = function(modelClass, selector);
_model = model;
_modelClass = model.class;
_JSONKeyPathsByPropertyKey = [[model.class JSONKeyPathsByPropertyKey] copy];
if (transformer != nil) result[key] = transformer;
continue;
}
if ([modelClass respondsToSelector:@selector(JSONTransformerForKey:)]) {
NSValueTransformer *transformer = [modelClass JSONTransformerForKey:key];
if (transformer != nil) {
result[key] = transformer;
continue;
}
}
objc_property_t property = class_getProperty(modelClass, key.UTF8String);
if (property == NULL) continue;
mtl_propertyAttributes *attributes = mtl_copyPropertyAttributes(property);
@onExit {
free(attributes);
};
NSValueTransformer *transformer = nil;
if (*(attributes->type) == *(@encode(id))) {
Class propertyClass = attributes->objectClass;
if (propertyClass != nil) {
transformer = [self transformerForModelPropertiesOfClass:propertyClass];
}
// For user-defined MTLModel, try parse it with dictionaryTransformer.
if (nil == transformer && [propertyClass conformsToProtocol:@protocol(MTLJSONSerializing)]) {
transformer = [self dictionaryTransformerWithModelClass:propertyClass];
}
if (transformer == nil) transformer = [NSValueTransformer mtl_validatingTransformerForClass:propertyClass ?: NSObject.class];
} else {
transformer = [self transformerForModelPropertiesOfObjCType:attributes->type] ?: [NSValueTransformer mtl_validatingTransformerForClass:NSValue.class];
}
if (transformer != nil) result[key] = transformer;
}
return result;
return self;
}
- (MTLJSONAdapter *)JSONAdapterForModelClass:(Class)modelClass error:(NSError **)error {
NSParameterAssert(modelClass != nil);
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)]);
#pragma mark Serialization
@synchronized(self) {
MTLJSONAdapter *result = [self.JSONAdaptersByModelClass objectForKey:modelClass];
- (NSDictionary *)JSONDictionary {
NSDictionary *dictionaryValue = self.model.dictionaryValue;
NSMutableDictionary *JSONDictionary = [[NSMutableDictionary alloc] initWithCapacity:dictionaryValue.count];
if (result != nil) return result;
[dictionaryValue enumerateKeysAndObjectsUsingBlock:^(NSString *propertyKey, id value, BOOL *stop) {
NSString *JSONKeyPath = [self JSONKeyPathForKey:propertyKey];
if (JSONKeyPath == nil) return;
result = [[self.class alloc] initWithModelClass:modelClass];
if (result != nil) {
[self.JSONAdaptersByModelClass setObject:result forKey:modelClass];
NSValueTransformer *transformer = [self JSONTransformerForKey:propertyKey];
if ([transformer.class allowsReverseTransformation]) {
// Map NSNull -> nil for the transformer, and then back for the
// dictionaryValue we're going to insert into.
if ([value isEqual:NSNull.null]) value = nil;
value = [transformer reverseTransformedValue:value] ?: NSNull.null;
}
NSArray *keyPathComponents = [JSONKeyPath componentsSeparatedByString:@"."];
// Set up dictionaries at each step of the key path.
id obj = JSONDictionary;
for (NSString *component in keyPathComponents) {
if ([obj valueForKey:component] == nil) {
// Insert an empty mutable dictionary at this spot so that we
// can set the whole key path afterward.
[obj setValue:[NSMutableDictionary dictionary] forKey:component];
}
obj = [obj valueForKey:component];
}
[JSONDictionary setValue:value forKeyPath:JSONKeyPath];
}];
return JSONDictionary;
}
- (NSValueTransformer *)JSONTransformerForKey:(NSString *)key {
NSParameterAssert(key != nil);
SEL selector = MTLSelectorWithKeyPattern(key, "JSONTransformer");
if ([self.modelClass respondsToSelector:selector]) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[self.modelClass methodSignatureForSelector:selector]];
invocation.target = self.modelClass;
invocation.selector = selector;
[invocation invoke];
__unsafe_unretained id result = nil;
[invocation getReturnValue:&result];
return result;
}
}
- (NSSet *)serializablePropertyKeys:(NSSet *)propertyKeys forModel:(id<MTLJSONSerializing>)model {
return propertyKeys;
}
+ (NSValueTransformer *)transformerForModelPropertiesOfClass:(Class)modelClass {
NSParameterAssert(modelClass != nil);
SEL selector = MTLSelectorWithKeyPattern(NSStringFromClass(modelClass), "JSONTransformer");
if (![self respondsToSelector:selector]) return nil;
IMP imp = [self methodForSelector:selector];
NSValueTransformer * (*function)(id, SEL) = (__typeof__(function))imp;
NSValueTransformer *result = function(self, selector);
return result;
}
+ (NSValueTransformer *)transformerForModelPropertiesOfObjCType:(const char *)objCType {
NSParameterAssert(objCType != NULL);
if (strcmp(objCType, @encode(BOOL)) == 0) {
return [NSValueTransformer valueTransformerForName:MTLBooleanValueTransformerName];
if ([self.modelClass respondsToSelector:@selector(JSONTransformerForKey:)]) {
return [self.modelClass JSONTransformerForKey:key];
}
return nil;
}
@end
- (NSString *)JSONKeyPathForKey:(NSString *)key {
NSParameterAssert(key != nil);
@implementation MTLJSONAdapter (ValueTransformers)
id JSONKeyPath = self.JSONKeyPathsByPropertyKey[key];
if ([JSONKeyPath isEqual:NSNull.null]) return nil;
+ (NSValueTransformer<MTLTransformerErrorHandling> *)dictionaryTransformerWithModelClass:(Class)modelClass {
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLModel)]);
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)]);
__block MTLJSONAdapter *adapter;
return [MTLValueTransformer
transformerUsingForwardBlock:^ id (id JSONDictionary, BOOL *success, NSError **error) {
if (JSONDictionary == nil) return nil;
if (![JSONDictionary isKindOfClass:NSDictionary.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert JSON dictionary to model object", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSDictionary, got: %@", @""), JSONDictionary],
MTLTransformerErrorHandlingInputValueErrorKey : JSONDictionary
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
if (!adapter) {
adapter = [[self alloc] initWithModelClass:modelClass];
}
id model = [adapter modelFromJSONDictionary:JSONDictionary error:error];
if (model == nil) {
*success = NO;
}
return model;
}
reverseBlock:^ NSDictionary * (id model, BOOL *success, NSError **error) {
if (model == nil) return nil;
if (![model conformsToProtocol:@protocol(MTLModel)] || ![model conformsToProtocol:@protocol(MTLJSONSerializing)]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert model object to JSON dictionary", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected a MTLModel object conforming to <MTLJSONSerializing>, got: %@.", @""), model],
MTLTransformerErrorHandlingInputValueErrorKey : model
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
if (!adapter) {
adapter = [[self alloc] initWithModelClass:modelClass];
}
NSDictionary *result = [adapter JSONDictionaryFromModel:model error:error];
if (result == nil) {
*success = NO;
}
return result;
}];
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)arrayTransformerWithModelClass:(Class)modelClass {
id<MTLTransformerErrorHandling> dictionaryTransformer = [self dictionaryTransformerWithModelClass:modelClass];
return [MTLValueTransformer
transformerUsingForwardBlock:^ id (NSArray *dictionaries, BOOL *success, NSError **error) {
if (dictionaries == nil) return nil;
if (![dictionaries isKindOfClass:NSArray.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert JSON array to model array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSArray, got: %@.", @""), dictionaries],
MTLTransformerErrorHandlingInputValueErrorKey : dictionaries
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSMutableArray *models = [NSMutableArray arrayWithCapacity:dictionaries.count];
for (id JSONDictionary in dictionaries) {
if (JSONDictionary == NSNull.null) {
[models addObject:NSNull.null];
continue;
}
if (![JSONDictionary isKindOfClass:NSDictionary.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert JSON array to model array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSDictionary or an NSNull, got: %@.", @""), JSONDictionary],
MTLTransformerErrorHandlingInputValueErrorKey : JSONDictionary
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
id model = [dictionaryTransformer transformedValue:JSONDictionary success:success error:error];
if (*success == NO) return nil;
if (model == nil) continue;
[models addObject:model];
}
return models;
}
reverseBlock:^ id (NSArray *models, BOOL *success, NSError **error) {
if (models == nil) return nil;
if (![models isKindOfClass:NSArray.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert model array to JSON array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSArray, got: %@.", @""), models],
MTLTransformerErrorHandlingInputValueErrorKey : models
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSMutableArray *dictionaries = [NSMutableArray arrayWithCapacity:models.count];
for (id model in models) {
if (model == NSNull.null) {
[dictionaries addObject:NSNull.null];
continue;
}
if (![model isKindOfClass:MTLModel.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert JSON array to model array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected a MTLModel or an NSNull, got: %@.", @""), model],
MTLTransformerErrorHandlingInputValueErrorKey : model
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSDictionary *dict = [dictionaryTransformer reverseTransformedValue:model success:success error:error];
if (*success == NO) return nil;
if (dict == nil) continue;
[dictionaries addObject:dict];
}
return dictionaries;
}];
}
+ (NSValueTransformer *)NSURLJSONTransformer {
return [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
}
+ (NSValueTransformer *)NSUUIDJSONTransformer {
return [NSValueTransformer valueTransformerForName:MTLUUIDValueTransformerName];
if (JSONKeyPath == nil) {
return key;
} else {
return JSONKeyPath;
}
}
@end
@ -655,12 +238,12 @@ NSString * const MTLJSONAdapterThrownExceptionErrorKey = @"MTLJSONAdapterThrownE
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-implementations"
+ (NSArray *)JSONArrayFromModels:(NSArray *)models {
return [self JSONArrayFromModels:models error:NULL];
+ (id)modelOfClass:(Class)modelClass fromJSONDictionary:(NSDictionary *)JSONDictionary {
return [self modelOfClass:modelClass fromJSONDictionary:JSONDictionary error:NULL];
}
+ (NSDictionary *)JSONDictionaryFromModel:(MTLModel<MTLJSONSerializing> *)model {
return [self JSONDictionaryFromModel:model error:NULL];
- (id)initWithJSONDictionary:(NSDictionary *)JSONDictionary modelClass:(Class)modelClass {
return [self initWithJSONDictionary:JSONDictionary modelClass:modelClass error:NULL];
}
#pragma clang diagnostic pop

143
Mantle/MTLManagedObjectAdapter.h Normal file
View File

@ -0,0 +1,143 @@
//
// MTLManagedObjectAdapter.h
// Mantle
//
// Created by Justin Spahr-Summers on 2013-03-29.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <CoreData/CoreData.h>
@class MTLModel;
// A MTLModel object that supports being serialized to and from Core Data as an
// NSManagedObject.
@protocol MTLManagedObjectSerializing
@required
// The name of the Core Data entity that the receiver serializes to and
// deserializes from.
//
// This method must not return nil.
+ (NSString *)managedObjectEntityName;
// Specifies how to map property keys to different keys on the receiver's
// +managedObjectEntity.
//
// Entity attributes will be mapped to and from the receiver's properties using
// +entityAttributeTransformerForKey:. Entity relationships will be mapped to
// and from MTLModel objects using +relationshipModelClassesByPropertyKey.
// Fetched properties are not supported.
//
// Subclasses overriding this method should combine their values with those of
// `super`.
//
// Any property keys not present in the dictionary are assumed to match the
// entity key that should be used. Any keys associated with NSNull will not
// participate in managed object serialization.
//
// Returns a dictionary mapping property keys to entity keys (as strings) or
// NSNull values.
+ (NSDictionary *)managedObjectKeysByPropertyKey;
@optional
// Specifies how to convert the given property key to a managed object attribute. If
// reversible, the transformer will also be used to convert the managed object
// attribute back to the property.
//
// If the receiver implements a `+<key>EntityAttributeTransformer` method,
// MTLManagedObjectAdapter will use the result of that method instead.
//
// Returns a value transformer, or nil if no transformation should be performed.
+ (NSValueTransformer *)entityAttributeTransformerForKey:(NSString *)key;
// Specifies the MTLModel subclasses that should be deserialized to the
// receiver's property keys when a property key corresponds to an entity
// relationship.
//
// In other words, the dictionary returned by this method is used to decode
// managed object relationships into MTLModels (or NSArrays or NSSets thereof)
// set on the receiver.
//
// If a property key is omitted from the returned dictionary, but present in
// +managedObjectKeysByPropertyKey, and the receiver's +managedObjectEntity has
// a relationship at the corresponding key, an exception will be thrown during
// deserialization.
//
// Subclasses overriding this method should combine their values with those of
// `super`.
//
// Returns a dictionary mapping property keys to the Class objects that should
// be used.
+ (NSDictionary *)relationshipModelClassesByPropertyKey;
// Overridden to deserialize a different class instead of the receiver, based on
// information in the provided object.
//
// This is mostly useful for class clusters, where the abstract base class would
// be passed into +[MTLManagedObjectAdapter
// modelOfClass:fromManagedObject:error:], but a subclass should be instantiated
// instead.
//
// managedObject - The object that will be deserialized.
//
// Returns the class that should be instantiated (which may be the receiver), or
// nil to abort parsing (e.g., if the data is invalid).
+ (Class)classForDeserializingManagedObject:(NSManagedObject *)managedObject;
@end
// The domain for errors originating from MTLManagedObjectAdapter.
extern NSString * const MTLManagedObjectAdapterErrorDomain;
// +classForDeserializingManagedObject: returned nil for the given object.
extern const NSInteger MTLManagedObjectAdapterErrorNoClassFound;
// An NSManagedObject failed to initialize.
extern const NSInteger MTLManagedObjectAdapterErrorInitializationFailed;
// The managed object key specified by +managedObjectKeysByPropertyKey does not
// exist in the NSEntityDescription.
extern const NSInteger MTLManagedObjectAdapterErrorInvalidManagedObjectKey;
// The managed object property specified has a type that isn't supported by
// MTLManagedObjectAdapter.
extern const NSInteger MTLManagedObjectAdapterErrorUnsupportedManagedObjectPropertyType;
// A MTLModel property cannot be serialized to or deserialized from an
// NSManagedObject relationship.
//
// For a to-one relationship, this means that the property does not contain
// a MTLModel, or the MTLModel does not conform to <MTLManagedObjectSerializing>.
//
// For a to-many relationship, this means that the property does not contain an
// NSArray or NSSet of MTLModel<MTLManagedObjectSerializing> instances.
extern const NSInteger MTLManagedObjectAdapterErrorUnsupportedRelationshipClass;
// Converts a MTLModel object to and from an NSManagedObject.
@interface MTLManagedObjectAdapter : NSObject
// Attempts to deserialize an NSManagedObject into a MTLModel object.
//
// modelClass - The MTLModel subclass to return. This class must conform to
// <MTLManagedObjectSerializing>. This argument must not be nil.
// managedObject - The managed object to deserialize. If this argument is nil,
// the method returns nil.
// error - If not NULL, this may be set to an error that occurs during
// deserialization or initializing an instance of `modelClass`.
//
// Returns an instance of `modelClass` upon success, or nil if an error
// occurred.
+ (id)modelOfClass:(Class)modelClass fromManagedObject:(NSManagedObject *)managedObject error:(NSError **)error;
// Serializes a MTLModel into an NSManagedObject.
//
// model - The model object to serialize. This argument must not be nil.
// context - The context into which to insert the created managed object. This
// argument must not be nil.
// error - If not NULL, this may be set to an error that occurs during
// serialization or insertion.
+ (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context error:(NSError **)error;
@end

530
Mantle/MTLManagedObjectAdapter.m Normal file
View File

@ -0,0 +1,530 @@
//
// MTLManagedObjectAdapter.m
// Mantle
//
// Created by Justin Spahr-Summers on 2013-03-29.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import "MTLManagedObjectAdapter.h"
#import "EXTScope.h"
#import "MTLModel.h"
#import "MTLReflection.h"
NSString * const MTLManagedObjectAdapterErrorDomain = @"MTLManagedObjectAdapterErrorDomain";
const NSInteger MTLManagedObjectAdapterErrorNoClassFound = 2;
const NSInteger MTLManagedObjectAdapterErrorInitializationFailed = 3;
const NSInteger MTLManagedObjectAdapterErrorInvalidManagedObjectKey = 4;
const NSInteger MTLManagedObjectAdapterErrorUnsupportedManagedObjectPropertyType = 5;
const NSInteger MTLManagedObjectAdapterErrorUnsupportedRelationshipClass = 6;
// Performs the given block in the context's queue, if it has one.
static id performInContext(NSManagedObjectContext *context, id (^block)(void)) {
if (context.concurrencyType == NSConfinementConcurrencyType) {
return block();
}
__block id result = nil;
[context performBlockAndWait:^{
result = block();
}];
return result;
}
// An exception was thrown and caught.
static const NSInteger MTLManagedObjectAdapterErrorExceptionThrown = 1;
@interface MTLManagedObjectAdapter ()
// The MTLModel subclass being serialized or deserialized.
@property (nonatomic, strong, readonly) Class modelClass;
// A cached copy of the return value of +managedObjectKeysByPropertyKey.
@property (nonatomic, copy, readonly) NSDictionary *managedObjectKeysByPropertyKey;
// A cached copy of the return value of +relationshipModelClassesByPropertyKey.
@property (nonatomic, copy, readonly) NSDictionary *relationshipModelClassesByPropertyKey;
// Initializes the receiver to serialize or deserialize a MTLModel of the given
// class.
- (id)initWithModelClass:(Class)modelClass;
// Invoked from +modelOfClass:fromManagedObject:processedObjects:error: after
// the receiver's properties have been initialized.
- (id)modelFromManagedObject:(NSManagedObject *)managedObject processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error;
// Performs the actual work of deserialization. This method is also invoked when
// processing relationships, to create a new adapter (if needed) to handle them.
//
// `processedObjects` is a dictionary mapping NSManagedObjects to the MTLModels
// that have been created so far. It should remain alive for the full process
// of deserializing the top-level managed object.
+ (id)modelOfClass:(Class)modelClass fromManagedObject:(NSManagedObject *)managedObject processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error;
// Invoked from
// +managedObjectFromModel:insertingIntoContext:processedObjects:error: after
// the receiver's properties have been initialized.
- (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error;
// Performs the actual work of serialization. This method is also invoked when
// processing relationships, to create a new adapter (if needed) to handle them.
//
// `processedObjects` is a dictionary mapping MTLModels to the NSManagedObjects
// that have been created so far. It should remain alive for the full process
// of serializing the top-level MTLModel.
+ (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error;
// Looks up the NSValueTransformer that should be used for any attribute that
// corresponds the given property key.
//
// key - The property key to transform from or to. This argument must not be nil.
//
// Returns a transformer to use, or nil to not transform the property.
- (NSValueTransformer *)entityAttributeTransformerForKey:(NSString *)key;
// Looks up the managed object key that corresponds to the given key.
//
// key - The property key to retrieve the corresponding managed object key for.
// This argument must not be nil.
//
// Returns a key to use, or nil to omit the property from managed object
// serialization.
- (NSString *)managedObjectKeyForKey:(NSString *)key;
@end
@implementation MTLManagedObjectAdapter
#pragma mark Lifecycle
- (id)init {
NSAssert(NO, @"%@ should not be initialized using -init", self.class);
return nil;
}
- (id)initWithModelClass:(Class)modelClass {
NSParameterAssert(modelClass != nil);
self = [super init];
if (self == nil) return nil;
_modelClass = modelClass;
_managedObjectKeysByPropertyKey = [[modelClass managedObjectKeysByPropertyKey] copy];
if ([modelClass respondsToSelector:@selector(relationshipModelClassesByPropertyKey)]) {
_relationshipModelClassesByPropertyKey = [[modelClass relationshipModelClassesByPropertyKey] copy];
}
return self;
}
#pragma mark Serialization
- (id)modelFromManagedObject:(NSManagedObject *)managedObject processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error {
NSParameterAssert(managedObject != nil);
NSParameterAssert(processedObjects != nil);
NSEntityDescription *entity = managedObject.entity;
NSAssert(entity != nil, @"%@ returned a nil +entity", managedObject);
NSManagedObjectContext *context = managedObject.managedObjectContext;
NSDictionary *managedObjectProperties = entity.propertiesByName;
MTLModel *model = [[self.modelClass alloc] init];
// Pre-emptively consider this object processed, so that we don't get into
// any cycles when processing its relationships.
CFDictionaryAddValue(processedObjects, (__bridge void *)managedObject, (__bridge void *)model);
BOOL (^setValueForKey)(NSString *, id) = ^(NSString *key, id value) {
// Mark this as being autoreleased, because validateValue may return
// a new object to be stored in this variable (and we don't want ARC to
// double-free or leak the old or new values).
__autoreleasing id replaceableValue = value;
if (![model validateValue:&replaceableValue forKey:key error:error]) return NO;
[model setValue:replaceableValue forKey:key];
return YES;
};
for (NSString *propertyKey in [self.modelClass propertyKeys]) {
NSString *managedObjectKey = [self managedObjectKeyForKey:propertyKey];
if (managedObjectKey == nil) continue;
BOOL (^deserializeAttribute)(NSAttributeDescription *) = ^(NSAttributeDescription *attributeDescription) {
id value = performInContext(context, ^{
return [managedObject valueForKey:managedObjectKey];
});
NSValueTransformer *attributeTransformer = [self entityAttributeTransformerForKey:propertyKey];
if (attributeTransformer != nil) value = [attributeTransformer reverseTransformedValue:value];
return setValueForKey(propertyKey, value);
};
BOOL (^deserializeRelationship)(NSRelationshipDescription *) = ^(NSRelationshipDescription *relationshipDescription) {
Class nestedClass = self.relationshipModelClassesByPropertyKey[propertyKey];
if (nestedClass == nil) {
[NSException raise:NSInvalidArgumentException format:@"No class specified for decoding relationship at key \"%@\" in managed object %@", managedObjectKey, managedObject];
}
if ([relationshipDescription isToMany]) {
id models = performInContext(context, ^ id {
id relationshipCollection = [managedObject valueForKey:managedObjectKey];
NSMutableArray *models = [NSMutableArray arrayWithCapacity:[relationshipCollection count]];
for (NSManagedObject *nestedObject in relationshipCollection) {
MTLModel *model = [self.class modelOfClass:nestedClass fromManagedObject:nestedObject processedObjects:processedObjects error:error];
if (model == nil) return nil;
[models addObject:model];
}
return models;
});
if (models == nil) return NO;
if (![relationshipDescription isOrdered]) models = [NSSet setWithArray:models];
return setValueForKey(propertyKey, models);
} else {
NSManagedObject *nestedObject = performInContext(context, ^{
return [managedObject valueForKey:managedObjectKey];
});
if (nestedObject == nil) return YES;
MTLModel *model = [self.class modelOfClass:nestedClass fromManagedObject:nestedObject processedObjects:processedObjects error:error];
if (model == nil) return NO;
return setValueForKey(propertyKey, model);
}
};
BOOL (^deserializeProperty)(NSPropertyDescription *) = ^(NSPropertyDescription *propertyDescription) {
if (propertyDescription == nil) {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"No property by name \"%@\" exists on the entity.", @""), managedObjectKey];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not deserialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorInvalidManagedObjectKey userInfo:userInfo];
}
return NO;
}
// Jump through some hoops to avoid referencing classes directly.
NSString *propertyClassName = NSStringFromClass(propertyDescription.class);
if ([propertyClassName isEqual:@"NSAttributeDescription"]) {
return deserializeAttribute((id)propertyDescription);
} else if ([propertyClassName isEqual:@"NSRelationshipDescription"]) {
return deserializeRelationship((id)propertyDescription);
} else {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Property descriptions of class %@ are unsupported.", @""), propertyClassName];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not deserialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorUnsupportedManagedObjectPropertyType userInfo:userInfo];
}
return NO;
}
};
if (!deserializeProperty(managedObjectProperties[managedObjectKey])) return nil;
}
return model;
}
+ (id)modelOfClass:(Class)modelClass fromManagedObject:(NSManagedObject *)managedObject error:(NSError **)error {
CFMutableDictionaryRef processedObjects = CFDictionaryCreateMutable(NULL, 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
if (processedObjects == NULL) return nil;
@onExit {
CFRelease(processedObjects);
};
return [self modelOfClass:modelClass fromManagedObject:managedObject processedObjects:processedObjects error:error];
}
+ (id)modelOfClass:(Class)modelClass fromManagedObject:(NSManagedObject *)managedObject processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error {
NSParameterAssert(modelClass != nil);
NSParameterAssert(processedObjects != nil);
if (managedObject == nil) return nil;
const void *existingModel = CFDictionaryGetValue(processedObjects, (__bridge void *)managedObject);
if (existingModel != NULL) {
return (__bridge id)existingModel;
}
if ([modelClass respondsToSelector:@selector(classForDeserializingManagedObject:)]) {
modelClass = [modelClass classForDeserializingManagedObject:managedObject];
if (modelClass == nil) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not deserialize managed object", @""),
NSLocalizedFailureReasonErrorKey: NSLocalizedString(@"No model class could be found to deserialize the object.", @"")
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorNoClassFound userInfo:userInfo];
}
return nil;
}
}
MTLManagedObjectAdapter *adapter = [[self alloc] initWithModelClass:modelClass];
return [adapter modelFromManagedObject:managedObject processedObjects:processedObjects error:error];
}
- (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error {
NSParameterAssert(model != nil);
NSParameterAssert(context != nil);
NSParameterAssert(processedObjects != nil);
NSString *entityName = [model.class managedObjectEntityName];
NSAssert(entityName != nil, @"%@ returned a nil +managedObjectEntityName", model.class);
Class entityDescriptionClass = NSClassFromString(@"NSEntityDescription");
NSAssert(entityDescriptionClass != nil, @"CoreData.framework must be linked to use MTLManagedObjectAdapter");
__block NSManagedObject *managedObject = [entityDescriptionClass insertNewObjectForEntityForName:entityName inManagedObjectContext:context];
if (managedObject == nil) {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Failed to initialize a managed object from entity named \"%@\".", @""), entityName];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not serialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorInitializationFailed userInfo:userInfo];
}
return nil;
}
// Pre-emptively consider this object processed, so that we don't get into
// any cycles when processing its relationships.
CFDictionaryAddValue(processedObjects, (__bridge void *)model, (__bridge void *)managedObject);
NSDictionary *dictionaryValue = model.dictionaryValue;
NSDictionary *managedObjectProperties = managedObject.entity.propertiesByName;
[dictionaryValue enumerateKeysAndObjectsUsingBlock:^(NSString *propertyKey, id value, BOOL *stop) {
NSString *managedObjectKey = [self managedObjectKeyForKey:propertyKey];
if (managedObjectKey == nil) return;
if ([value isEqual:NSNull.null]) value = nil;
BOOL (^serializeAttribute)(NSAttributeDescription *) = ^(NSAttributeDescription *attributeDescription) {
// Mark this as being autoreleased, because validateValue may return
// a new object to be stored in this variable (and we don't want ARC to
// double-free or leak the old or new values).
__autoreleasing id transformedValue = value;
NSValueTransformer *attributeTransformer = [self entityAttributeTransformerForKey:propertyKey];
if (attributeTransformer != nil) transformedValue = [attributeTransformer transformedValue:transformedValue];
if (![managedObject validateValue:&transformedValue forKey:managedObjectKey error:error]) return NO;
[managedObject setValue:transformedValue forKey:managedObjectKey];
return YES;
};
NSManagedObject * (^objectForRelationshipFromModel)(id) = ^ id (id model) {
if (![model isKindOfClass:MTLModel.class] || ![model conformsToProtocol:@protocol(MTLManagedObjectSerializing)]) {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Property of class %@ cannot be encoded into an NSManagedObject.", @""), [model class]];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not serialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorUnsupportedRelationshipClass userInfo:userInfo];
}
return nil;
}
return [self.class managedObjectFromModel:model insertingIntoContext:context processedObjects:processedObjects error:error];
};
BOOL (^serializeRelationship)(NSRelationshipDescription *) = ^(NSRelationshipDescription *relationshipDescription) {
if (value == nil) return YES;
if ([relationshipDescription isToMany]) {
if (![value conformsToProtocol:@protocol(NSFastEnumeration)]) {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Property of class %@ cannot be encoded into a to-many relationship.", @""), [value class]];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not serialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorUnsupportedRelationshipClass userInfo:userInfo];
}
return NO;
}
id relationshipCollection;
if ([relationshipDescription isOrdered]) {
relationshipCollection = [managedObject mutableOrderedSetValueForKey:managedObjectKey];
} else {
relationshipCollection = [managedObject mutableSetValueForKey:managedObjectKey];
}
for (MTLModel *model in value) {
NSManagedObject *nestedObject = objectForRelationshipFromModel(model);
if (nestedObject == nil) return NO;
[relationshipCollection addObject:nestedObject];
}
} else {
NSManagedObject *nestedObject = objectForRelationshipFromModel(value);
if (nestedObject == nil) return NO;
[managedObject setValue:nestedObject forKey:managedObjectKey];
}
return YES;
};
BOOL (^serializeProperty)(NSPropertyDescription *) = ^(NSPropertyDescription *propertyDescription) {
if (propertyDescription == nil) {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"No property by name \"%@\" exists on the entity.", @""), managedObjectKey];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not serialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorInvalidManagedObjectKey userInfo:userInfo];
}
return NO;
}
// Jump through some hoops to avoid referencing classes directly.
NSString *propertyClassName = NSStringFromClass(propertyDescription.class);
if ([propertyClassName isEqual:@"NSAttributeDescription"]) {
return serializeAttribute((id)propertyDescription);
} else if ([propertyClassName isEqual:@"NSRelationshipDescription"]) {
return serializeRelationship((id)propertyDescription);
} else {
if (error != NULL) {
NSString *failureReason = [NSString stringWithFormat:NSLocalizedString(@"Property descriptions of class %@ are unsupported.", @""), propertyClassName];
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not serialize managed object", @""),
NSLocalizedFailureReasonErrorKey: failureReason,
};
*error = [NSError errorWithDomain:MTLManagedObjectAdapterErrorDomain code:MTLManagedObjectAdapterErrorUnsupportedManagedObjectPropertyType userInfo:userInfo];
}
return NO;
}
};
if (!serializeProperty(managedObjectProperties[managedObjectKey])) {
performInContext(context, ^ id {
[context deleteObject:managedObject];
return nil;
});
managedObject = nil;
*stop = YES;
}
}];
if (![managedObject validateForInsert:error]) {
performInContext(context, ^ id {
[context deleteObject:managedObject];
return nil;
});
}
return managedObject;
}
+ (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context error:(NSError **)error {
CFDictionaryKeyCallBacks keyCallbacks = kCFTypeDictionaryKeyCallBacks;
// Compare MTLModel keys using pointer equality, not -isEqual:.
keyCallbacks.equal = NULL;
CFMutableDictionaryRef processedObjects = CFDictionaryCreateMutable(NULL, 0, &keyCallbacks, &kCFTypeDictionaryValueCallBacks);
if (processedObjects == NULL) return nil;
@onExit {
CFRelease(processedObjects);
};
return [self managedObjectFromModel:model insertingIntoContext:context processedObjects:processedObjects error:error];
}
+ (NSManagedObject *)managedObjectFromModel:(MTLModel<MTLManagedObjectSerializing> *)model insertingIntoContext:(NSManagedObjectContext *)context processedObjects:(CFMutableDictionaryRef)processedObjects error:(NSError **)error {
NSParameterAssert(model != nil);
NSParameterAssert(context != nil);
NSParameterAssert(processedObjects != nil);
const void *existingManagedObject = CFDictionaryGetValue(processedObjects, (__bridge void *)model);
if (existingManagedObject != NULL) {
return (__bridge id)existingManagedObject;
}
MTLManagedObjectAdapter *adapter = [[self alloc] initWithModelClass:model.class];
return [adapter managedObjectFromModel:model insertingIntoContext:context processedObjects:processedObjects error:error];
}
- (NSValueTransformer *)entityAttributeTransformerForKey:(NSString *)key {
NSParameterAssert(key != nil);
SEL selector = MTLSelectorWithKeyPattern(key, "EntityAttributeTransformer");
if ([self.modelClass respondsToSelector:selector]) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[self.modelClass methodSignatureForSelector:selector]];
invocation.target = self.modelClass;
invocation.selector = selector;
[invocation invoke];
__unsafe_unretained id result = nil;
[invocation getReturnValue:&result];
return result;
}
if ([self.modelClass respondsToSelector:@selector(entityAttributeTransformerForKey:)]) {
return [self.modelClass entityAttributeTransformerForKey:key];
}
return nil;
}
- (NSString *)managedObjectKeyForKey:(NSString *)key {
NSParameterAssert(key != nil);
id managedObjectKey = self.managedObjectKeysByPropertyKey[key];
if ([managedObjectKey isEqual:NSNull.null]) return nil;
if (managedObjectKey == nil) {
return key;
} else {
return managedObjectKey;
}
}
@end

182
Mantle/MTLModel+NSCoding.h
View File

@ -8,121 +8,121 @@
#import "MTLModel.h"
/// Defines how a MTLModel property key should be encoded into an archive.
///
/// MTLModelEncodingBehaviorExcluded - The property should never be encoded.
/// MTLModelEncodingBehaviorUnconditional - The property should always be
/// encoded.
/// MTLModelEncodingBehaviorConditional - The object should be encoded only
/// if unconditionally encoded elsewhere.
/// This should only be used for object
/// properties.
// Defines how a MTLModel property key should be encoded into an archive.
//
// MTLModelEncodingBehaviorExcluded - The property should never be encoded.
// MTLModelEncodingBehaviorUnconditional - The property should always be
// encoded.
// MTLModelEncodingBehaviorConditional - The object should be encoded only
// if unconditionally encoded elsewhere.
// This should only be used for object
// properties.
typedef enum : NSUInteger {
MTLModelEncodingBehaviorExcluded = 0,
MTLModelEncodingBehaviorUnconditional,
MTLModelEncodingBehaviorConditional,
} MTLModelEncodingBehavior;
/// Implements default archiving and unarchiving behaviors for MTLModel.
// Implements default archiving and unarchiving behaviors for MTLModel.
@interface MTLModel (NSCoding) <NSCoding>
/// Initializes the receiver from an archive.
///
/// This will decode the original +modelVersion of the archived object, then
/// invoke -decodeValueForKey:withCoder:modelVersion: for each of the receiver's
/// +propertyKeys.
///
/// Returns an initialized model object, or nil if a decoding error occurred.
// Initializes the receiver from an archive.
//
// This will decode the original +modelVersion of the archived object, then
// invoke -decodeValueForKey:withCoder:modelVersion: for each of the receiver's
// +propertyKeys.
//
// Returns an initialized model object, or nil if a decoding error occurred.
- (id)initWithCoder:(NSCoder *)coder;
/// Archives the receiver using the given coder.
///
/// This will encode the receiver's +modelVersion, then the receiver's properties
/// according to the behaviors specified in +encodingBehaviorsByPropertyKey.
// Archives the receiver using the given coder.
//
// This will encode the receiver's +modelVersion, then the receiver's properties
// according to the behaviors specified in +encodingBehaviorsByPropertyKey.
- (void)encodeWithCoder:(NSCoder *)coder;
/// Determines how the +propertyKeys of the class are encoded into an archive.
/// The values of this dictionary should be boxed MTLModelEncodingBehavior
/// values.
///
/// Any keys not present in the dictionary will be excluded from the archive.
///
/// Subclasses overriding this method should combine their values with those of
/// `super`.
///
/// Returns a dictionary mapping the receiver's +propertyKeys to default encoding
/// behaviors. If a property is an object with `weak` semantics, the default
/// behavior is MTLModelEncodingBehaviorConditional; otherwise, the default is
/// MTLModelEncodingBehaviorUnconditional.
// Determines how the +propertyKeys of the class are encoded into an archive.
// The values of this dictionary should be boxed MTLModelEncodingBehavior
// values.
//
// Any keys not present in the dictionary will be excluded from the archive.
//
// Subclasses overriding this method should combine their values with those of
// `super`.
//
// Returns a dictionary mapping the receiver's +propertyKeys to default encoding
// behaviors. If a property is an object with `weak` semantics, the default
// behavior is MTLModelEncodingBehaviorConditional; otherwise, the default is
// MTLModelEncodingBehaviorUnconditional.
+ (NSDictionary *)encodingBehaviorsByPropertyKey;
/// Determines the classes that are allowed to be decoded for each of the
/// receiver's properties when using <NSSecureCoding>. The values of this
/// dictionary should be NSArrays of Class objects.
///
/// If any encodable keys (as determined by +encodingBehaviorsByPropertyKey) are
/// not present in the dictionary, an exception will be thrown during secure
/// encoding or decoding.
///
/// Subclasses overriding this method should combine their values with those of
/// `super`.
///
/// Returns a dictionary mapping the receiver's encodable keys (as determined by
/// +encodingBehaviorsByPropertyKey) to default allowed classes, based on the
/// type that each property is declared as. If type of an encodable property
/// cannot be determined (e.g., it is declared as `id`), it will be omitted from
/// the dictionary, and subclasses must provide a valid value to prevent an
/// exception being thrown during encoding/decoding.
// Determines the classes that are allowed to be decoded for each of the
// receiver's properties when using <NSSecureCoding>. The values of this
// dictionary should be NSArrays of Class objects.
//
// If any encodable keys (as determined by +encodingBehaviorsByPropertyKey) are
// not present in the dictionary, an exception will be thrown during secure
// encoding or decoding.
//
// Subclasses overriding this method should combine their values with those of
// `super`.
//
// Returns a dictionary mapping the receiver's encodable keys (as determined by
// +encodingBehaviorsByPropertyKey) to default allowed classes, based on the
// type that each property is declared as. If type of an encodable property
// cannot be determined (e.g., it is declared as `id`), it will be omitted from
// the dictionary, and subclasses must provide a valid value to prevent an
// exception being thrown during encoding/decoding.
+ (NSDictionary *)allowedSecureCodingClassesByPropertyKey;
/// Decodes the value of the given property key from an archive.
///
/// By default, this method looks for a `-decode<Key>WithCoder:modelVersion:`
/// method on the receiver, and invokes it if found.
///
/// If the custom method is not implemented and `coder` does not require secure
/// coding, `-[NSCoder decodeObjectForKey:]` will be invoked with the given
/// `key`.
///
/// If the custom method is not implemented and `coder` requires secure coding,
/// `-[NSCoder decodeObjectOfClasses:forKey:]` will be invoked with the
/// information from +allowedSecureCodingClassesByPropertyKey and the given `key`. The
/// receiver must conform to <NSSecureCoding> for this to work correctly.
///
/// key - The property key to decode the value for. This argument cannot
/// be nil.
/// coder - The NSCoder representing the archive being decoded. This
/// argument cannot be nil.
/// modelVersion - The version of the original model object that was encoded.
///
/// Returns the decoded and boxed value, or nil if the key was not present.
// Decodes the value of the given property key from an archive.
//
// By default, this method looks for a `-decode<Key>WithCoder:modelVersion:`
// method on the receiver, and invokes it if found.
//
// If the custom method is not implemented and `coder` does not require secure
// coding, `-[NSCoder decodeObjectForKey:]` will be invoked with the given
// `key`.
//
// If the custom method is not implemented and `coder` requires secure coding,
// `-[NSCoder decodeObjectOfClasses:forKey:]` will be invoked with the
// information from +allowedSecureCodingClassesByPropertyKey and the given `key`. The
// receiver must conform to <NSSecureCoding> for this to work correctly.
//
// key - The property key to decode the value for. This argument cannot
// be nil.
// coder - The NSCoder representing the archive being decoded. This
// argument cannot be nil.
// modelVersion - The version of the original model object that was encoded.
//
// Returns the decoded and boxed value, or nil if the key was not present.
- (id)decodeValueForKey:(NSString *)key withCoder:(NSCoder *)coder modelVersion:(NSUInteger)modelVersion;
/// The version of this MTLModel subclass.
///
/// This version number is saved in archives so that later model changes can be
/// made backwards-compatible with old versions.
///
/// Subclasses should override this method to return a higher version number
/// whenever a breaking change is made to the model.
///
/// Returns 0.
// The version of this MTLModel subclass.
//
// This version number is saved in archives so that later model changes can be
// made backwards-compatible with old versions.
//
// Subclasses should override this method to return a higher version number
// whenever a breaking change is made to the model.
//
// Returns 0.
+ (NSUInteger)modelVersion;
@end
/// This method must be overridden to support archives created by older versions
/// of Mantle (before the `MTLModel+NSCoding` interface existed).
// This method must be overridden to support archives created by older versions
// of Mantle (before the `MTLModel+NSCoding` interface existed).
@interface MTLModel (OldArchiveSupport)
/// Converts an archived external representation to a dictionary suitable for
/// passing to -initWithDictionary:.
///
/// externalRepresentation - The decoded external representation of the receiver.
/// fromVersion - The model version at the time the external
/// representation was encoded.
///
/// Returns nil by default, indicating that conversion failed.
// Converts an archived external representation to a dictionary suitable for
// passing to -initWithDictionary:.
//
// externalRepresentation - The decoded external representation of the receiver.
// fromVersion - The model version at the time the external
// representation was encoded.
//
// Returns nil by default, indicating that conversion failed.
+ (NSDictionary *)dictionaryValueFromArchivedExternalRepresentation:(NSDictionary *)externalRepresentation version:(NSUInteger)fromVersion;
@end

78
Mantle/MTLModel+NSCoding.m
View File

@ -7,9 +7,10 @@
//
#import "MTLModel+NSCoding.h"
#import <Mantle/EXTRuntimeExtensions.h>
#import <Mantle/EXTScope.h>
#import "EXTRuntimeExtensions.h"
#import "EXTScope.h"
#import "MTLReflection.h"
#import <objc/runtime.h>
// Used in archives to store the modelVersion of the archived instance.
static NSString * const MTLModelVersionKey = @"MTLModelVersion";
@ -128,25 +129,25 @@ static void verifyAllowedClassesByPropertyKey(Class modelClass) {
SEL selector = MTLSelectorWithCapitalizedKeyPattern("decode", key, "WithCoder:modelVersion:");
if ([self respondsToSelector:selector]) {
IMP imp = [self methodForSelector:selector];
id (*function)(id, SEL, NSCoder *, NSUInteger) = (__typeof__(function))imp;
id result = function(self, selector, coder, modelVersion);
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[self methodSignatureForSelector:selector]];
invocation.target = self;
invocation.selector = selector;
[invocation setArgument:&coder atIndex:2];
[invocation setArgument:&modelVersion atIndex:3];
[invocation invoke];
__unsafe_unretained id result = nil;
[invocation getReturnValue:&result];
return result;
}
@try {
if (coderRequiresSecureCoding(coder)) {
NSArray *allowedClasses = self.class.allowedSecureCodingClassesByPropertyKey[key];
NSAssert(allowedClasses != nil, @"No allowed classes specified for securely decoding key \"%@\" on %@", key, self.class);
return [coder decodeObjectOfClasses:[NSSet setWithArray:allowedClasses] forKey:key];
} else {
return [coder decodeObjectForKey:key];
}
} @catch (NSException *ex) {
NSLog(@"*** Caught exception decoding value for key \"%@\" on class %@: %@", key, self.class, ex);
@throw ex;
if (coderRequiresSecureCoding(coder)) {
NSArray *allowedClasses = self.class.allowedSecureCodingClassesByPropertyKey[key];
NSAssert(allowedClasses != nil, @"No allowed classes specified for securely decoding key \"%@\" on %@", key, self.class);
return [coder decodeObjectOfClasses:[NSSet setWithArray:allowedClasses] forKey:key];
} else {
return [coder decodeObjectForKey:key];
}
}
@ -211,29 +212,24 @@ static void verifyAllowedClassesByPropertyKey(Class modelClass) {
NSDictionary *encodingBehaviors = self.class.encodingBehaviorsByPropertyKey;
[self.dictionaryValue enumerateKeysAndObjectsUsingBlock:^(NSString *key, id value, BOOL *stop) {
@try {
// Skip nil values.
if ([value isEqual:NSNull.null]) return;
switch ([encodingBehaviors[key] unsignedIntegerValue]) {
// This will also match a nil behavior.
case MTLModelEncodingBehaviorExcluded:
break;
case MTLModelEncodingBehaviorUnconditional:
[coder encodeObject:value forKey:key];
break;
case MTLModelEncodingBehaviorConditional:
[coder encodeConditionalObject:value forKey:key];
break;
default:
NSAssert(NO, @"Unrecognized encoding behavior %@ on class %@ for key \"%@\"", self.class, encodingBehaviors[key], key);
}
} @catch (NSException *ex) {
NSLog(@"*** Caught exception encoding value for key \"%@\" on class %@: %@", key, self.class, ex);
@throw ex;
// Skip nil values.
if ([value isEqual:NSNull.null]) return;
switch ([encodingBehaviors[key] unsignedIntegerValue]) {
// This will also match a nil behavior.
case MTLModelEncodingBehaviorExcluded:
break;
case MTLModelEncodingBehaviorUnconditional:
[coder encodeObject:value forKey:key];
break;
case MTLModelEncodingBehaviorConditional:
[coder encodeConditionalObject:value forKey:key];
break;
default:
NSAssert(NO, @"Unrecognized encoding behavior %@ for key \"%@\"", encodingBehaviors[key], key);
}
}];
}

226
Mantle/MTLModel.h
View File

@ -8,172 +8,94 @@
#import <Foundation/Foundation.h>
/// Defines a property's storage behavior, which affects how it will be copied,
/// compared, and persisted.
///
/// MTLPropertyStorageNone - This property is not included in -description,
/// -hash, or anything else.
/// MTLPropertyStorageTransitory - This property is included in one-off
/// operations like -copy and -dictionaryValue but
/// does not affect -isEqual: or -hash.
/// It may disappear at any time.
/// MTLPropertyStoragePermanent - The property is included in serialization
/// (like `NSCoding`) and equality, since it can
/// be expected to stick around.
typedef enum : NSUInteger {
MTLPropertyStorageNone,
MTLPropertyStorageTransitory,
MTLPropertyStoragePermanent,
} MTLPropertyStorage;
// An abstract base class for model objects, using reflection to provide
// sensible default behaviors.
//
// The default implementations of <NSCopying>, -hash, and -isEqual: make use of
// the +propertyKeys method.
@interface MTLModel : NSObject <NSCopying>
/// This protocol defines the minimal interface that classes need to implement to
/// interact with Mantle adapters.
///
/// It is intended for scenarios where inheriting from MTLModel is not feasible.
/// However, clients are encouraged to subclass the MTLModel class if they can.
///
/// Clients that wish to implement their own adapters should target classes
/// conforming to this protocol rather than subclasses of MTLModel to ensure
/// maximum compatibility.
@protocol MTLModel <NSObject, NSCopying>
/// Initializes a new instance of the receiver using key-value coding, setting
/// the keys and values in the given dictionary.
///
/// dictionaryValue - Property keys and values to set on the instance. Any NSNull
/// values will be converted to nil before being used. KVC
/// validation methods will automatically be invoked for all of
/// the properties given.
/// error - If not NULL, this may be set to any error that occurs
/// (like a KVC validation error).
///
/// Returns an initialized model object, or nil if validation failed.
// Returns a new instance of the receiver initialized using
// -initWithDictionary:error:.
+ (instancetype)modelWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;
/// A dictionary representing the properties of the receiver.
///
/// Combines the values corresponding to all +propertyKeys into a dictionary,
/// with any nil values represented by NSNull.
///
/// This property must never be nil.
@property (nonatomic, copy, readonly) NSDictionary *dictionaryValue;
/// Initializes the receiver using key-value coding, setting the keys and values
/// in the given dictionary.
///
/// Subclass implementations may override this method, calling the super
/// implementation, in order to perform further processing and initialization
/// after deserialization.
///
/// dictionaryValue - Property keys and values to set on the receiver. Any NSNull
/// values will be converted to nil before being used. KVC
/// validation methods will automatically be invoked for all of
/// the properties given. If nil, this method is equivalent to
/// -init.
/// error - If not NULL, this may be set to any error that occurs
/// (like a KVC validation error).
///
/// Returns an initialized model object, or nil if validation failed.
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;
/// Merges the value of the given key on the receiver with the value of the same
/// key from the given model object, giving precedence to the other model object.
- (void)mergeValueForKey:(NSString *)key fromModel:(id<MTLModel>)model;
/// Returns the keys for all @property declarations, except for `readonly`
/// properties without ivars, or properties on MTLModel itself.
+ (NSSet *)propertyKeys;
/// Validates the model.
///
/// error - If not NULL, this may be set to any error that occurs during
/// validation
///
/// Returns YES if the model is valid, or NO if the validation failed.
- (BOOL)validate:(NSError **)error;
@end
/// An abstract base class for model objects, using reflection to provide
/// sensible default behaviors.
///
/// The default implementations of <NSCopying>, -hash, and -isEqual: make use of
/// the +propertyKeys method.
@interface MTLModel : NSObject <MTLModel>
/// Initializes the receiver using key-value coding, setting the keys and values
/// in the given dictionary.
///
/// dictionaryValue - Property keys and values to set on the receiver. Any NSNull
/// values will be converted to nil before being used. KVC
/// validation methods will automatically be invoked for all of
/// the properties given. If nil, this method is equivalent to
/// -init.
/// error - If not NULL, this may be set to any error that occurs
/// (like a KVC validation error).
///
/// Returns an initialized model object, or nil if validation failed.
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;
/// Initializes the receiver with default values.
///
/// This is the designated initializer for this class.
// Initializes the receiver with default values.
//
// This is the designated initializer for this class.
- (instancetype)init;
/// By default, this method looks for a `-merge<Key>FromModel:` method on the
/// receiver, and invokes it if found. If not found, and `model` is not nil, the
/// value for the given key is taken from `model`.
- (void)mergeValueForKey:(NSString *)key fromModel:(id<MTLModel>)model;
// Initializes the receiver using key-value coding, setting the keys and values
// in the given dictionary.
//
// dictionaryValue - Property keys and values to set on the receiver. Any NSNull
// values will be converted to nil before being used. KVC
// validation methods will automatically be invoked for all of
// the properties given. If nil, this method is equivalent to
// -init.
// error - If not NULL, this may be set to any error that occurs
// (like a KVC validation error).
//
// Returns an initialized model object, or nil if validation failed.
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;
/// Merges the values of the given model object into the receiver, using
/// -mergeValueForKey:fromModel: for each key in +propertyKeys.
///
/// `model` must be an instance of the receiver's class or a subclass thereof.
- (void)mergeValuesForKeysFromModel:(id<MTLModel>)model;
// Returns the keys for all @property declarations, except for `readonly`
// properties without ivars, or properties on MTLModel itself.
+ (NSSet *)propertyKeys;
/// The storage behavior of a given key.
///
/// The default implementation returns MTLPropertyStorageNone for properties that
/// are readonly and not backed by an instance variable and
/// MTLPropertyStoragePermanent otherwise.
///
/// Subclasses can use this method to prevent MTLModel from resolving circular
/// references by returning MTLPropertyStorageTransitory.
///
/// Returns the storage behavior for a given key on the receiver.
+ (MTLPropertyStorage)storageBehaviorForPropertyWithKey:(NSString *)propertyKey;
// A dictionary representing the properties of the receiver.
//
// The default implementation combines the values corresponding to all
// +propertyKeys into a dictionary, with any nil values represented by NSNull.
//
// This property must never be nil.
@property (nonatomic, copy, readonly) NSDictionary *dictionaryValue;
/// Compares the receiver with another object for equality.
///
/// The default implementation is equivalent to comparing all properties of both
/// models for which +storageBehaviorForPropertyWithKey: returns
/// MTLPropertyStoragePermanent.
///
/// Returns YES if the two models are considered equal, NO otherwise.
- (BOOL)isEqual:(id)object;
// Merges the value of the given key on the receiver with the value of the same
// key from the given model object, giving precedence to the other model object.
//
// By default, this method looks for a `-merge<Key>FromModel:` method on the
// receiver, and invokes it if found. If not found, and `model` is not nil, the
// value for the given key is taken from `model`.
- (void)mergeValueForKey:(NSString *)key fromModel:(MTLModel *)model;
/// A string that describes the contents of the receiver.
///
/// The default implementation is based on the receiver's class and all its
/// properties for which +storageBehaviorForPropertyWithKey: returns
/// MTLPropertyStoragePermanent.
- (NSString *)description;
// Merges the values of the given model object into the receiver, using
// -mergeValueForKey:fromModel: for each key in +propertyKeys.
//
// `model` must be an instance of the receiver's class or a subclass thereof.
- (void)mergeValuesForKeysFromModel:(MTLModel *)model;
@end
/// Implements validation logic for MTLModel.
// Implements validation logic for MTLModel.
@interface MTLModel (Validation)
/// Validates the model.
///
/// The default implementation simply invokes -validateValue:forKey:error: with
/// all +propertyKeys and their current value. If -validateValue:forKey:error:
/// returns a new value, the property is set to that new value.
///
/// error - If not NULL, this may be set to any error that occurs during
/// validation
///
/// Returns YES if the model is valid, or NO if the validation failed.
// Validates the model.
//
// The default implementation simply invokes -validateValue:forKey:error: with
// all +propertyKeys and their current value. If -validateValue:forKey:error:
// returns a new value, the property is set to that new value.
//
// error - If not NULL, this may be set to any error that occurs during
// validation
//
// Returns YES if the model is valid, or NO if the validation failed.
- (BOOL)validate:(NSError **)error;
@end
@interface MTLModel (Unavailable)
+ (instancetype)modelWithDictionary:(NSDictionary *)dictionaryValue __attribute__((deprecated("Replaced by +modelWithDictionary:error:")));
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue __attribute__((deprecated("Replaced by -initWithDictionary:error:")));
+ (instancetype)modelWithExternalRepresentation:(NSDictionary *)externalRepresentation __attribute__((deprecated("Replaced by -[MTLJSONAdapter initWithJSONDictionary:modelClass:]")));
- (instancetype)initWithExternalRepresentation:(NSDictionary *)externalRepresentation __attribute__((deprecated("Replaced by -[MTLJSONAdapter initWithJSONDictionary:modelClass:]")));
@property (nonatomic, copy, readonly) NSDictionary *externalRepresentation __attribute__((deprecated("Replaced by MTLJSONAdapter.JSONDictionary")));
+ (NSDictionary *)externalRepresentationKeyPathsByPropertyKey __attribute__((deprecated("Replaced by +JSONKeyPathsByPropertyKey in <MTLJSONSerializing>")));
+ (NSValueTransformer *)transformerForKey:(NSString *)key __attribute__((deprecated("Replaced by +JSONTransformerForKey: in <MTLJSONSerializing>")));
+ (NSDictionary *)migrateExternalRepresentation:(NSDictionary *)externalRepresentation fromVersion:(NSUInteger)fromVersion __attribute__((deprecated("Replaced by -decodeValueForKey:withCoder:modelVersion:")));
@end

150
Mantle/MTLModel.m
View File

@ -8,22 +8,19 @@
#import "NSError+MTLModelException.h"
#import "MTLModel.h"
#import <Mantle/EXTRuntimeExtensions.h>
#import <Mantle/EXTScope.h>
#import "EXTRuntimeExtensions.h"
#import "EXTScope.h"
#import "MTLReflection.h"
#import <objc/runtime.h>
// This coupling is needed for backwards compatibility in MTLModel's deprecated
// methods.
#import "MTLJSONAdapter.h"
#import "MTLModel+NSCoding.h"
// Used to cache the reflection performed in +propertyKeys.
static void *MTLModelCachedPropertyKeysKey = &MTLModelCachedPropertyKeysKey;
// Associated in +generateAndCachePropertyKeys with a set of all transitory
// property keys.
static void *MTLModelCachedTransitoryPropertyKeysKey = &MTLModelCachedTransitoryPropertyKeysKey;
// Associated in +generateAndCachePropertyKeys with a set of all permanent
// property keys.
static void *MTLModelCachedPermanentPropertyKeysKey = &MTLModelCachedPermanentPropertyKeysKey;
// Validates a value for an object and sets it if necessary.
//
// obj - The object for which the value is being validated. This value
@ -70,18 +67,6 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
@interface MTLModel ()
// Inspects all properties of returned by +propertyKeys using
// +storageBehaviorForPropertyWithKey and caches the results.
+ (void)generateAndCacheStorageBehaviors;
// Returns a set of all property keys for which
// +storageBehaviorForPropertyWithKey returned MTLPropertyStorageTransitory.
+ (NSSet *)transitoryPropertyKeys;
// Returns a set of all property keys for which
// +storageBehaviorForPropertyWithKey returned MTLPropertyStoragePermanent.
+ (NSSet *)permanentPropertyKeys;
// Enumerates all properties of the receiver's class hierarchy, starting at the
// receiver, and continuing up until (but not including) MTLModel.
//
@ -95,31 +80,6 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
#pragma mark Lifecycle
+ (void)generateAndCacheStorageBehaviors {
NSMutableSet *transitoryKeys = [NSMutableSet set];
NSMutableSet *permanentKeys = [NSMutableSet set];
for (NSString *propertyKey in self.propertyKeys) {
switch ([self storageBehaviorForPropertyWithKey:propertyKey]) {
case MTLPropertyStorageNone:
break;
case MTLPropertyStorageTransitory:
[transitoryKeys addObject:propertyKey];
break;
case MTLPropertyStoragePermanent:
[permanentKeys addObject:propertyKey];
break;
}
}
// It doesn't really matter if we replace another thread's work, since we do
// it atomically and the result should be the same.
objc_setAssociatedObject(self, MTLModelCachedTransitoryPropertyKeysKey, transitoryKeys, OBJC_ASSOCIATION_COPY);
objc_setAssociatedObject(self, MTLModelCachedPermanentPropertyKeysKey, permanentKeys, OBJC_ASSOCIATION_COPY);
}
+ (instancetype)modelWithDictionary:(NSDictionary *)dictionary error:(NSError **)error {
return [[self alloc] initWithDictionary:dictionary error:error];
}
@ -138,7 +98,7 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
// a new object to be stored in this variable (and we don't want ARC to
// double-free or leak the old or new values).
__autoreleasing id value = [dictionary objectForKey:key];
if ([value isEqual:NSNull.null]) value = nil;
BOOL success = MTLValidateAndSetValue(self, key, value, YES, error);
@ -179,11 +139,15 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
NSMutableSet *keys = [NSMutableSet set];
[self enumeratePropertiesUsingBlock:^(objc_property_t property, BOOL *stop) {
NSString *key = @(property_getName(property));
mtl_propertyAttributes *attributes = mtl_copyPropertyAttributes(property);
@onExit {
free(attributes);
};
if ([self storageBehaviorForPropertyWithKey:key] != MTLPropertyStorageNone) {
[keys addObject:key];
}
if (attributes->readonly && attributes->ivar == NULL) return;
NSString *key = @(property_getName(property));
[keys addObject:key];
}];
// It doesn't really matter if we replace another thread's work, since we do
@ -193,64 +157,13 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
return keys;
}
+ (NSSet *)transitoryPropertyKeys {
NSSet *transitoryPropertyKeys = objc_getAssociatedObject(self, MTLModelCachedTransitoryPropertyKeysKey);
if (transitoryPropertyKeys == nil) {
[self generateAndCacheStorageBehaviors];
transitoryPropertyKeys = objc_getAssociatedObject(self, MTLModelCachedTransitoryPropertyKeysKey);
}
return transitoryPropertyKeys;
}
+ (NSSet *)permanentPropertyKeys {
NSSet *permanentPropertyKeys = objc_getAssociatedObject(self, MTLModelCachedPermanentPropertyKeysKey);
if (permanentPropertyKeys == nil) {
[self generateAndCacheStorageBehaviors];
permanentPropertyKeys = objc_getAssociatedObject(self, MTLModelCachedPermanentPropertyKeysKey);
}
return permanentPropertyKeys;
}
- (NSDictionary *)dictionaryValue {
NSSet *keys = [self.class.transitoryPropertyKeys setByAddingObjectsFromSet:self.class.permanentPropertyKeys];
return [self dictionaryWithValuesForKeys:keys.allObjects];
}
+ (MTLPropertyStorage)storageBehaviorForPropertyWithKey:(NSString *)propertyKey {
objc_property_t property = class_getProperty(self.class, propertyKey.UTF8String);
if (property == NULL) return MTLPropertyStorageNone;
mtl_propertyAttributes *attributes = mtl_copyPropertyAttributes(property);
@onExit {
free(attributes);
};
BOOL hasGetter = [self instancesRespondToSelector:attributes->getter];
BOOL hasSetter = [self instancesRespondToSelector:attributes->setter];
if (!attributes->dynamic && attributes->ivar == NULL && !hasGetter && !hasSetter) {
return MTLPropertyStorageNone;
} else if (attributes->readonly && attributes->ivar == NULL) {
if ([self isEqual:MTLModel.class]) {
return MTLPropertyStorageNone;
} else {
// Check superclass in case the subclass redeclares a property that
// falls through
return [self.superclass storageBehaviorForPropertyWithKey:propertyKey];
}
} else {
return MTLPropertyStoragePermanent;
}
return [self dictionaryWithValuesForKeys:self.class.propertyKeys.allObjects];
}
#pragma mark Merging
- (void)mergeValueForKey:(NSString *)key fromModel:(NSObject<MTLModel> *)model {
- (void)mergeValueForKey:(NSString *)key fromModel:(MTLModel *)model {
NSParameterAssert(key != nil);
SEL selector = MTLSelectorWithCapitalizedKeyPattern("merge", key, "FromModel:");
@ -262,17 +175,16 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
return;
}
IMP imp = [self methodForSelector:selector];
void (*function)(id, SEL, id<MTLModel>) = (__typeof__(function))imp;
function(self, selector, model);
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[self methodSignatureForSelector:selector]];
invocation.target = self;
invocation.selector = selector;
[invocation setArgument:&model atIndex:2];
[invocation invoke];
}
- (void)mergeValuesForKeysFromModel:(id<MTLModel>)model {
NSSet *propertyKeys = model.class.propertyKeys;
- (void)mergeValuesForKeysFromModel:(MTLModel *)model {
for (NSString *key in self.class.propertyKeys) {
if (![propertyKeys containsObject:key]) continue;
[self mergeValueForKey:key fromModel:model];
}
}
@ -293,23 +205,19 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
#pragma mark NSCopying
- (instancetype)copyWithZone:(NSZone *)zone {
MTLModel *copy = [[self.class allocWithZone:zone] init];
[copy setValuesForKeysWithDictionary:self.dictionaryValue];
return copy;
return [[self.class allocWithZone:zone] initWithDictionary:self.dictionaryValue error:NULL];
}
#pragma mark NSObject
- (NSString *)description {
NSDictionary *permanentProperties = [self dictionaryWithValuesForKeys:self.class.permanentPropertyKeys.allObjects];
return [NSString stringWithFormat:@"<%@: %p> %@", self.class, self, permanentProperties];
return [NSString stringWithFormat:@"<%@: %p> %@", self.class, self, self.dictionaryValue];
}
- (NSUInteger)hash {
NSUInteger value = 0;
for (NSString *key in self.class.permanentPropertyKeys) {
for (NSString *key in self.class.propertyKeys) {
value ^= [[self valueForKey:key] hash];
}
@ -320,7 +228,7 @@ static BOOL MTLValidateAndSetValue(id obj, NSString *key, id value, BOOL forceUp
if (self == model) return YES;
if (![model isMemberOfClass:self.class]) return NO;
for (NSString *key in self.class.permanentPropertyKeys) {
for (NSString *key in self.class.propertyKeys) {
id selfValue = [self valueForKey:key];
id modelValue = [model valueForKey:key];

36
Mantle/MTLReflection.h
View File

@ -8,24 +8,24 @@
#import <Foundation/Foundation.h>
/// Creates a selector from a key and a constant string.
///
/// key - The key to insert into the generated selector. This key should be in
/// its natural case.
/// suffix - A string to append to the key as part of the selector.
///
/// Returns a selector, or NULL if the input strings cannot form a valid
/// selector.
// Creates a selector from a key and a constant string.
//
// key - The key to insert into the generated selector. This key should be in
// its natural case.
// suffix - A string to append to the key as part of the selector.
//
// Returns a selector, or NULL if the input strings cannot form a valid
// selector.
SEL MTLSelectorWithKeyPattern(NSString *key, const char *suffix) __attribute__((pure, nonnull(1, 2)));
/// Creates a selector from a key and a constant prefix and suffix.
///
/// prefix - A string to prepend to the key as part of the selector.
/// key - The key to insert into the generated selector. This key should be in
/// its natural case, and will have its first letter capitalized when
/// inserted.
/// suffix - A string to append to the key as part of the selector.
///
/// Returns a selector, or NULL if the input strings cannot form a valid
/// selector.
// Creates a selector from a key and a constant prefix and suffix.
//
// prefix - A string to prepend to the key as part of the selector.
// key - The key to insert into the generated selector. This key should be in
// its natural case, and will have its first letter capitalized when
// inserted.
// suffix - A string to append to the key as part of the selector.
//
// Returns a selector, or NULL if the input strings cannot form a valid
// selector.
SEL MTLSelectorWithCapitalizedKeyPattern(const char *prefix, NSString *key, const char *suffix) __attribute__((pure, nonnull(1, 2, 3)));

66
Mantle/MTLTransformerErrorHandling.h
View File

@ -1,66 +0,0 @@
//
// MTLTransformerErrorHandling.h
// Mantle
//
// Created by Robert Böhnke on 10/6/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
/// The domain for errors originating from the MTLTransformerErrorHandling
/// protocol.
///
/// Transformers conforming to this protocol are expected to use this error
/// domain if the transformation fails.
extern NSString * const MTLTransformerErrorHandlingErrorDomain;
/// Used to indicate that the input value was illegal.
///
/// Transformers conforming to this protocol are expected to use this error code
/// if the transformation fails due to an invalid input value.
extern const NSInteger MTLTransformerErrorHandlingErrorInvalidInput;
/// Associated with the invalid input value.
///
/// Transformers conforming to this protocol are expected to associate this key
/// with the invalid input in the userInfo dictionary.
extern NSString * const MTLTransformerErrorHandlingInputValueErrorKey;
/// This protocol can be implemented by NSValueTransformer subclasses to
/// communicate errors that occur during transformation.
@protocol MTLTransformerErrorHandling <NSObject>
@required
/// Transforms a value, returning any error that occurred during transformation.
///
/// value - The value to transform.
/// success - If not NULL, this will be set to a boolean indicating whether the
/// transformation was successful.
/// error - If not NULL, this may be set to an error that occurs during
/// transforming the value.
///
/// Returns the result of the transformation which may be nil. Clients should
/// inspect the success parameter to decide how to proceed with the result.
- (id)transformedValue:(id)value success:(BOOL *)success error:(NSError **)error;
@optional
/// Reverse-transforms a value, returning any error that occurred during
/// transformation.
///
/// Transformers conforming to this protocol are expected to implemented this
/// method if they support reverse transformation.
///
/// value - The value to transform.
/// success - If not NULL, this will be set to a boolean indicating whether the
/// transformation was successful.
/// error - If not NULL, this may be set to an error that occurs during
/// transforming the value.
///
/// Returns the result of the reverse transformation which may be nil. Clients
/// should inspect the success parameter to decide how to proceed with the
/// result.
- (id)reverseTransformedValue:(id)value success:(BOOL *)success error:(NSError **)error;
@end

15
Mantle/MTLTransformerErrorHandling.m
View File

@ -1,15 +0,0 @@
//
// MTLTransformerErrorHandling.h
// Mantle
//
// Created by Robert Böhnke on 10/6/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import "MTLTransformerErrorHandling.h"
NSString * const MTLTransformerErrorHandlingErrorDomain = @"MTLTransformerErrorHandlingErrorDomain";
const NSInteger MTLTransformerErrorHandlingErrorInvalidInput = 1;
NSString * const MTLTransformerErrorHandlingInputValueErrorKey = @"MTLTransformerErrorHandlingInputValueErrorKey";

52
Mantle/MTLValueTransformer.h
View File

@ -8,45 +8,29 @@
#import <Foundation/Foundation.h>
#import "MTLTransformerErrorHandling.h"
typedef id (^MTLValueTransformerBlock)(id);
/// A block that represents a transformation.
///
/// value - The value to transform.
/// success - The block must set this parameter to indicate whether the
/// transformation was successful.
/// MTLValueTransformer will always call this block with *success
/// initialized to YES.
/// error - If not NULL, this may be set to an error that occurs during
/// transforming the value.
///
/// Returns the result of the transformation, which may be nil.
typedef id (^MTLValueTransformerBlock)(id value, BOOL *success, NSError **error);
//
// A value transformer supporting block-based transformation.
//
@interface MTLValueTransformer : NSValueTransformer
///
/// A value transformer supporting block-based transformation.
///
@interface MTLValueTransformer : NSValueTransformer <MTLTransformerErrorHandling>
// Returns a transformer which transforms values using the given block. Reverse
// transformations will not be allowed.
+ (instancetype)transformerWithBlock:(MTLValueTransformerBlock)transformationBlock;
/// Returns a transformer which transforms values using the given block. Reverse
/// transformations will not be allowed.
+ (instancetype)transformerUsingForwardBlock:(MTLValueTransformerBlock)transformation;
// Returns a transformer which transforms values using the given block, for
// forward or reverse transformations.
+ (instancetype)reversibleTransformerWithBlock:(MTLValueTransformerBlock)transformationBlock;
/// Returns a transformer which transforms values using the given block, for
/// forward or reverse transformations.
+ (instancetype)transformerUsingReversibleBlock:(MTLValueTransformerBlock)transformation;
/// Returns a transformer which transforms values using the given blocks.
+ (instancetype)transformerUsingForwardBlock:(MTLValueTransformerBlock)forwardTransformation reverseBlock:(MTLValueTransformerBlock)reverseTransformation;
// Returns a transformer which transforms values using the given blocks.
+ (instancetype)reversibleTransformerWithForwardBlock:(MTLValueTransformerBlock)forwardBlock reverseBlock:(MTLValueTransformerBlock)reverseBlock;
@end
@interface MTLValueTransformer (Deprecated)
+ (NSValueTransformer *)transformerWithBlock:(id (^)(id))transformationBlock __attribute__((deprecated("Replaced by +transformerUsingForwardBlock:")));
+ (NSValueTransformer *)reversibleTransformerWithBlock:(id (^)(id))transformationBlock __attribute__((deprecated("Replaced by +transformerUsingReversibleBlock:")));
+ (NSValueTransformer *)reversibleTransformerWithForwardBlock:(id (^)(id))forwardBlock reverseBlock:(id (^)(id))reverseBlock __attribute__((deprecated("Replaced by +transformerUsingForwardBlock:reverseBlock:")));
//
// Any MTLValueTransformer supporting reverse transformation. Necessary because
// +allowsReverseTransformation is a class method.
//
@interface MTLReversibleValueTransformer : MTLValueTransformer
@end

85
Mantle/MTLValueTransformer.m
View File

@ -8,13 +8,6 @@
#import "MTLValueTransformer.h"
//
// Any MTLValueTransformer supporting reverse transformation. Necessary because
// +allowsReverseTransformation is a class method.
//
@interface MTLReversibleValueTransformer : MTLValueTransformer
@end
@interface MTLValueTransformer ()
@property (nonatomic, copy, readonly) MTLValueTransformerBlock forwardBlock;
@ -26,15 +19,15 @@
#pragma mark Lifecycle
+ (instancetype)transformerUsingForwardBlock:(MTLValueTransformerBlock)forwardBlock {
return [[self alloc] initWithForwardBlock:forwardBlock reverseBlock:nil];
+ (instancetype)transformerWithBlock:(MTLValueTransformerBlock)transformationBlock {
return [[self alloc] initWithForwardBlock:transformationBlock reverseBlock:nil];
}
+ (instancetype)transformerUsingReversibleBlock:(MTLValueTransformerBlock)reversibleBlock {
return [self transformerUsingForwardBlock:reversibleBlock reverseBlock:reversibleBlock];
+ (instancetype)reversibleTransformerWithBlock:(MTLValueTransformerBlock)transformationBlock {
return [self reversibleTransformerWithForwardBlock:transformationBlock reverseBlock:transformationBlock];
}
+ (instancetype)transformerUsingForwardBlock:(MTLValueTransformerBlock)forwardBlock reverseBlock:(MTLValueTransformerBlock)reverseBlock {
+ (instancetype)reversibleTransformerWithForwardBlock:(MTLValueTransformerBlock)forwardBlock reverseBlock:(MTLValueTransformerBlock)reverseBlock {
return [[MTLReversibleValueTransformer alloc] initWithForwardBlock:forwardBlock reverseBlock:reverseBlock];
}
@ -57,26 +50,11 @@
}
+ (Class)transformedValueClass {
return NSObject.class;
return [NSObject class];
}
- (id)transformedValue:(id)value {
NSError *error = nil;
BOOL success = YES;
return self.forwardBlock(value, &success, &error);
}
- (id)transformedValue:(id)value success:(BOOL *)outerSuccess error:(NSError **)outerError {
NSError *error = nil;
BOOL success = YES;
id transformedValue = self.forwardBlock(value, &success, &error);
if (outerSuccess != NULL) *outerSuccess = success;
if (outerError != NULL) *outerError = error;
return transformedValue;
return self.forwardBlock(value);
}
@end
@ -97,54 +75,7 @@
}
- (id)reverseTransformedValue:(id)value {
NSError *error = nil;
BOOL success = YES;
return self.reverseBlock(value, &success, &error);
}
- (id)reverseTransformedValue:(id)value success:(BOOL *)outerSuccess error:(NSError **)outerError {
NSError *error = nil;
BOOL success = YES;
id transformedValue = self.reverseBlock(value, &success, &error);
if (outerSuccess != NULL) *outerSuccess = success;
if (outerError != NULL) *outerError = error;
return transformedValue;
return self.reverseBlock(value);
}
@end
@implementation MTLValueTransformer (Deprecated)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-implementations"
+ (instancetype)transformerWithBlock:(id (^)(id))transformationBlock {
return [self transformerUsingForwardBlock:^(id value, BOOL *success, NSError **error) {
return transformationBlock(value);
}];
}
+ (instancetype)reversibleTransformerWithBlock:(id (^)(id))transformationBlock {
return [self transformerUsingReversibleBlock:^(id value, BOOL *success, NSError **error) {
return transformationBlock(value);
}];
}
+ (instancetype)reversibleTransformerWithForwardBlock:(id (^)(id))forwardBlock reverseBlock:(id (^)(id))reverseBlock {
return [self
transformerUsingForwardBlock:^(id value, BOOL *success, NSError **error) {
return forwardBlock(value);
}
reverseBlock:^(id value, BOOL *success, NSError **error) {
return reverseBlock(value);
}];
}
#pragma clang diagnostic pop
@end

14
Mantle/Info.plist → Mantle/Mantle-Info.plist
View File

@ -3,15 +3,17 @@
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<string>English</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<string>${EXECUTABLE_NAME}</string>
<key>CFBundleIconFile</key>
<string></string>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<string>com.github.${PRODUCT_NAME:rfc1034identifier}</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<string>${PRODUCT_NAME}</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleShortVersionString</key>
@ -19,7 +21,9 @@
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>$(CURRENT_PROJECT_VERSION)</string>
<string>1</string>
<key>NSHumanReadableCopyright</key>
<string>Copyright © 2012 GitHub. All rights reserved.</string>
<key>NSPrincipalClass</key>
<string></string>
</dict>

7
Mantle/Mantle-Prefix.pch Normal file
View File

@ -0,0 +1,7 @@
//
// Prefix header for all source files of the 'Mantle' target in the 'Mantle' project
//
#ifdef __OBJC__
#import <Foundation/Foundation.h>
#endif

11
Mantle/Mantle.h
View File

@ -6,22 +6,13 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
//! Project version number for Mantle.
FOUNDATION_EXPORT double MantleVersionNumber;
//! Project version string for Mantle.
FOUNDATION_EXPORT const unsigned char MantleVersionString[];
#import <Mantle/MTLJSONAdapter.h>
#import <Mantle/MTLManagedObjectAdapter.h>
#import <Mantle/MTLModel.h>
#import <Mantle/MTLModel+NSCoding.h>
#import <Mantle/MTLValueTransformer.h>
#import <Mantle/MTLTransformerErrorHandling.h>
#import <Mantle/NSArray+MTLManipulationAdditions.h>
#import <Mantle/NSDictionary+MTLManipulationAdditions.h>
#import <Mantle/NSDictionary+MTLMappingAdditions.h>
#import <Mantle/NSObject+MTLComparisonAdditions.h>
#import <Mantle/NSValueTransformer+MTLInversionAdditions.h>
#import <Mantle/NSValueTransformer+MTLPredefinedTransformerAdditions.h>

14
Mantle/NSArray+MTLManipulationAdditions.h
View File

@ -10,19 +10,19 @@
@interface NSArray (MTLManipulationAdditions)
/// The first object in the array or nil if the array is empty.
/// Forwards to `firstObject` which has been first declared in iOS7, but works with iOS4/10.6.
// The first object in the array or nil if the array is empty.
// Forwards to `firstObject` which has been first declared in iOS7, but works with iOS4/10.6.
@property (nonatomic, readonly, strong) id mtl_firstObject;
/// Returns a new array without all instances of the given object.
// Returns a new array without all instances of the given object.
- (NSArray *)mtl_arrayByRemovingObject:(id)object;
/// Returns a new array without the first object. If the array is empty, it
/// returns the empty array.
// Returns a new array without the first object. If the array is empty, it
// returns the empty array.
- (NSArray *)mtl_arrayByRemovingFirstObject;
/// Returns a new array without the last object. If the array is empty, it
/// returns the empty array.
// Returns a new array without the last object. If the array is empty, it
// returns the empty array.
- (NSArray *)mtl_arrayByRemovingLastObject;
@end

27
Mantle/NSDictionary+MTLJSONKeyPath.h
View File

@ -1,27 +0,0 @@
//
// NSDictionary+MTLJSONKeyPath.h
// Mantle
//
// Created by Robert Böhnke on 19/03/14.
// Copyright (c) 2014 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
@interface NSDictionary (MTLJSONKeyPath)
/// Looks up the value of a key path in the receiver.
///
/// JSONKeyPath - The key path that should be resolved. Every element along this
/// key path needs to be an instance of NSDictionary for the
/// resolving to be successful.
/// success - If not NULL, this will be set to a boolean indicating whether
/// the key path was resolved successfully.
/// error - If not NULL, this may be set to an error that occurs during
/// resolving the value.
///
/// Returns the value for the key path which may be nil. Clients should inspect
/// the success parameter to decide how to proceed with the result.
- (id)mtl_valueForJSONKeyPath:(NSString *)JSONKeyPath success:(BOOL *)success error:(NSError **)error;
@end

47
Mantle/NSDictionary+MTLJSONKeyPath.m
View File

@ -1,47 +0,0 @@
//
// NSDictionary+MTLJSONKeyPath.m
// Mantle
//
// Created by Robert Böhnke on 19/03/14.
// Copyright (c) 2014 GitHub. All rights reserved.
//
#import "NSDictionary+MTLJSONKeyPath.h"
#import "MTLJSONAdapter.h"
@implementation NSDictionary (MTLJSONKeyPath)
- (id)mtl_valueForJSONKeyPath:(NSString *)JSONKeyPath success:(BOOL *)success error:(NSError **)error {
NSArray *components = [JSONKeyPath componentsSeparatedByString:@"."];
id result = self;
for (NSString *component in components) {
// Check the result before resolving the key path component to not
// affect the last value of the path.
if (result == nil || result == NSNull.null) break;
if (![result isKindOfClass:NSDictionary.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Invalid JSON dictionary", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"JSON key path %1$@ could not resolved because an incompatible JSON dictionary was supplied: \"%2$@\"", @""), JSONKeyPath, self]
};
*error = [NSError errorWithDomain:MTLJSONAdapterErrorDomain code:MTLJSONAdapterErrorInvalidJSONDictionary userInfo:userInfo];
}
if (success != NULL) *success = NO;
return nil;
}
result = result[component];
}
if (success != NULL) *success = YES;
return result;
}
@end

24
Mantle/NSDictionary+MTLManipulationAdditions.h
View File

@ -10,22 +10,16 @@
@interface NSDictionary (MTLManipulationAdditions)
/// Merges the keys and values from the given dictionary into the receiver. If
/// both the receiver and `dictionary` have a given key, the value from
/// `dictionary` is used.
///
/// Returns a new dictionary containing the entries of the receiver combined with
/// those of `dictionary`.
// Merges the keys and values from the given dictionary into the receiver. If
// both the receiver and `dictionary` have a given key, the value from
// `dictionary` is used.
//
// Returns a new dictionary containing the entries of the receiver combined with
// those of `dictionary`.
- (NSDictionary *)mtl_dictionaryByAddingEntriesFromDictionary:(NSDictionary *)dictionary;
/// Creates a new dictionary with all the entries for the given keys removed from
/// the receiver.
- (NSDictionary *)mtl_dictionaryByRemovingValuesForKeys:(NSArray *)keys;
@end
@interface NSDictionary (MTLManipulationAdditions_Deprecated)
- (NSDictionary *)mtl_dictionaryByRemovingEntriesWithKeys:(NSSet *)keys __attribute__((deprecated("Replaced by -mtl_dictionaryByRemovingValuesForKeys:")));
// Creates a new dictionary with all the entries for the given keys removed from
// the receiver.
- (NSDictionary *)mtl_dictionaryByRemovingEntriesWithKeys:(NSSet *)keys;
@end

17
Mantle/NSDictionary+MTLManipulationAdditions.m
View File

@ -16,23 +16,10 @@
return result;
}
- (NSDictionary *)mtl_dictionaryByRemovingValuesForKeys:(NSArray *)keys {
- (NSDictionary *)mtl_dictionaryByRemovingEntriesWithKeys:(NSSet *)keys {
NSMutableDictionary *result = [self mutableCopy];
[result removeObjectsForKeys:keys];
[result removeObjectsForKeys:keys.allObjects];
return result;
}
@end
@implementation NSDictionary (MTLManipulationAdditions_Deprecated)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
- (NSDictionary *)mtl_dictionaryByRemovingEntriesWithKeys:(NSSet *)keys {
return [self mtl_dictionaryByRemovingValuesForKeys:keys.allObjects];
}
#pragma clang diagnostic pop
@end

21
Mantle/NSDictionary+MTLMappingAdditions.h
View File

@ -1,21 +0,0 @@
//
// NSDictionary+MTLMappingAdditions.h
// Mantle
//
// Created by Robert Böhnke on 10/31/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
@interface NSDictionary (MTLMappingAdditions)
/// Creates an identity mapping for serialization.
///
/// class - A subclass of MTLModel.
///
/// Returns a dictionary that maps all properties of the given class to
/// themselves.
+ (NSDictionary *)mtl_identityPropertyMapWithModel:(Class)modelClass;
@end

23
Mantle/NSDictionary+MTLMappingAdditions.m
View File

@ -1,23 +0,0 @@
//
// NSDictionary+MTLMappingAdditions.m
// Mantle
//
// Created by Robert Böhnke on 10/31/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import "MTLModel.h"
#import "NSDictionary+MTLMappingAdditions.h"
@implementation NSDictionary (MTLMappingAdditions)
+ (NSDictionary *)mtl_identityPropertyMapWithModel:(Class)modelClass {
NSCParameterAssert([modelClass conformsToProtocol:@protocol(MTLModel)]);
NSArray *propertyKeys = [modelClass propertyKeys].allObjects;
return [NSDictionary dictionaryWithObjects:propertyKeys forKeys:propertyKeys];
}
@end

16
Mantle/NSError+MTLModelException.h
View File

@ -10,14 +10,14 @@
@interface NSError (MTLModelException)
/// Creates a new error for an exception that occurred during updating an
/// MTLModel.
///
/// exception - The exception that was thrown while updating the model.
/// This argument must not be nil.
///
/// Returns an error that takes its localized description and failure reason
/// from the exception.
// Creates a new error for an exception that occured during updating an
// MTLModel.
//
// exception - The exception that was thrown while updating the model.
// This argument must not be nil.
//
// Returns an error that takes its localized description and failure reason
// from the exception.
+ (instancetype)mtl_modelErrorWithException:(NSException *)exception;
@end

2
Mantle/NSObject+MTLComparisonAdditions.h
View File

@ -11,5 +11,5 @@
#import <Foundation/Foundation.h>
/// Returns whether both objects are identical or equal via -isEqual:
// Returns whether both objects are identical or equal via -isEqual:
BOOL MTLEqualObjects(id obj1, id obj2);

12
Mantle/NSValueTransformer+MTLInversionAdditions.h
View File

@ -10,12 +10,12 @@
@interface NSValueTransformer (MTLInversionAdditions)
/// Flips the direction of the receiver's transformation, such that
/// -transformedValue: will become -reverseTransformedValue:, and vice-versa.
///
/// The receiver must allow reverse transformation.
///
/// Returns an inverted transformer.
// Flips the direction of the receiver's transformation, such that
// -transformedValue: will become -reverseTransformedValue:, and vice-versa.
//
// The receiver must allow reverse transformation.
//
// Returns an inverted transformer.
- (NSValueTransformer *)mtl_invertedTransformer;
@end

23
Mantle/NSValueTransformer+MTLInversionAdditions.m
View File

@ -7,7 +7,6 @@
//
#import "NSValueTransformer+MTLInversionAdditions.h"
#import "MTLTransformerErrorHandling.h"
#import "MTLValueTransformer.h"
@implementation NSValueTransformer (MTLInversionAdditions)
@ -15,23 +14,11 @@
- (NSValueTransformer *)mtl_invertedTransformer {
NSParameterAssert(self.class.allowsReverseTransformation);
if ([self conformsToProtocol:@protocol(MTLTransformerErrorHandling)]) {
NSParameterAssert([self respondsToSelector:@selector(reverseTransformedValue:success:error:)]);
id<MTLTransformerErrorHandling> errorHandlingSelf = (id)self;
return [MTLValueTransformer transformerUsingForwardBlock:^(id value, BOOL *success, NSError **error) {
return [errorHandlingSelf reverseTransformedValue:value success:success error:error];
} reverseBlock:^(id value, BOOL *success, NSError **error) {
return [errorHandlingSelf transformedValue:value success:success error:error];
}];
} else {
return [MTLValueTransformer transformerUsingForwardBlock:^(id value, BOOL *success, NSError **error) {
return [self reverseTransformedValue:value];
} reverseBlock:^(id value, BOOL *success, NSError **error) {
return [self transformedValue:value];
}];
}
return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(id value) {
return [self reverseTransformedValue:value];
} reverseBlock:^(id value) {
return [self transformedValue:value];
}];
}
@end

134
Mantle/NSValueTransformer+MTLPredefinedTransformerAdditions.h
View File

@ -8,111 +8,47 @@
#import <Foundation/Foundation.h>
#import "MTLTransformerErrorHandling.h"
/// The name for a value transformer that converts strings into URLs and back.
// The name for a value transformer that converts strings into URLs and back.
extern NSString * const MTLURLValueTransformerName;
/// The name for a value transformer that converts strings into NSUUIDs and back.
extern NSString * const MTLUUIDValueTransformerName;
/// Ensure an NSNumber is backed by __NSCFBoolean/CFBooleanRef
///
/// NSJSONSerialization, and likely other serialization libraries, ordinarily
/// serialize NSNumbers as numbers, and thus booleans would be serialized as
/// 0/1. The exception is when the NSNumber is backed by __NSCFBoolean, which,
/// though very much an implementation detail, is detected and serialized as a
/// proper boolean.
// Ensure an NSNumber is backed by __NSCFBoolean/CFBooleanRef
//
// NSJSONSerialization, and likely other serialization libraries, ordinarily
// serialize NSNumbers as numbers, and thus booleans would be serialized as
// 0/1. The exception is when the NSNumber is backed by __NSCFBoolean, which,
// though very much an implementation detail, is detected and serialized as a
// proper boolean.
extern NSString * const MTLBooleanValueTransformerName;
@interface NSValueTransformer (MTLPredefinedTransformerAdditions)
/// An optionally reversible transformer which applies the given transformer to
/// each element of an array.
///
/// transformer - The transformer to apply to each element. If the transformer
/// is reversible, the transformer returned by this method will be
/// reversible. This argument must not be nil.
///
/// Returns a transformer which applies a transformation to each element of an
/// array.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_arrayMappingTransformerWithTransformer:(NSValueTransformer *)transformer;
// Creates a reversible transformer to convert a JSON dictionary into a MTLModel
// object, and vice-versa.
//
// modelClass - The MTLModel subclass to attempt to parse from the JSON. This
// class must conform to <MTLJSONSerializing>. This argument must
// not be nil.
//
// Returns a reversible transformer which uses MTLJSONAdapter for transforming
// values back and forth.
+ (NSValueTransformer *)mtl_JSONDictionaryTransformerWithModelClass:(Class)modelClass;
/// A reversible value transformer to transform between the keys and objects of a
/// dictionary.
///
/// dictionary - The dictionary whose keys and values should be
/// transformed between. This argument must not be nil.
/// defaultValue - The result to fall back to, in case no key matching the
/// input value was found during a forward transformation.
/// reverseDefaultValue - The result to fall back to, in case no value matching
/// the input value was found during a reverse
/// transformation.
///
/// Can for example be used for transforming between enum values and their string
/// representation.
///
/// NSValueTransformer *valueTransformer = [NSValueTransformer mtl_valueMappingTransformerWithDictionary:@{
/// @"foo": @(EnumDataTypeFoo),
/// @"bar": @(EnumDataTypeBar),
/// } defaultValue: @(EnumDataTypeUndefined) reverseDefaultValue: @"undefined"];
///
/// Returns a transformer which will map from keys to objects for forward
/// transformations, and from objects to keys for reverse transformations.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_valueMappingTransformerWithDictionary:(NSDictionary *)dictionary defaultValue:(id)defaultValue reverseDefaultValue:(id)reverseDefaultValue;
/// Returns a value transformer created by calling
/// `+mtl_valueMappingTransformerWithDictionary:defaultValue:reverseDefaultValue:`
/// with a default value of `nil` and a reverse default value of `nil`.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_valueMappingTransformerWithDictionary:(NSDictionary *)dictionary;
/// A reversible value transformer to transform between a date and its string
/// representation
///
/// dateFormat - The date format used by the date formatter (http://www.unicode.org/reports/tr35/tr35-31/tr35-dates.html#Date_Field_Symbol_Table)
/// calendar - The calendar used by the date formatter
/// locale - The locale used by the date formatter
/// timeZone - The time zone used by the date formatter
///
/// Returns a transformer which will map from strings to dates for forward
/// transformations, and from dates to strings for reverse transformations.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_dateTransformerWithDateFormat:(NSString *)dateFormat calendar:(NSCalendar *)calendar locale:(NSLocale *)locale timeZone:(NSTimeZone *)timeZone defaultDate:(NSDate *)defaultDate;
/// Returns a value transformer created by calling
/// `+mtl_dateTransformerWithDateFormat:calendar:locale:timeZone:defaultDate:`
/// with a calendar, locale, time zone and default date of `nil`.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_dateTransformerWithDateFormat:(NSString *)dateFormat locale:(NSLocale *)locale;
/// A reversible value transformer to transform between a number and its string
/// representation
///
/// numberStyle - The number style used by the number formatter
///
/// Returns a transformer which will map from strings to numbers for forward
/// transformations, and from numbers to strings for reverse transformations.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_numberTransformerWithNumberStyle:(NSNumberFormatterStyle)numberStyle locale:(NSLocale *)locale;
/// A reversible value transformer to transform between an object and its string
/// representation
///
/// formatter - The formatter used to perform the transformation
/// objectClass - The class of object that the formatter operates on
///
/// Returns a transformer which will map from strings to objects for forward
/// transformations, and from objects to strings for reverse transformations.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_transformerWithFormatter:(NSFormatter *)formatter forObjectClass:(Class)objectClass;
/// A value transformer that errors if the transformed value are not of the given
/// class.
///
/// class - The expected class. This argument must not be nil.
///
/// Returns a transformer which will return an error if the transformed in value
/// is not a member of class. Otherwise, the value is simply passed through.
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_validatingTransformerForClass:(Class)modelClass;
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_JSONDictionaryTransformerWithModelClass:(Class)modelClass __attribute__((deprecated("Replaced by +[MTLJSONAdapter dictionaryTransformerWithModelClass:]")));
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_JSONArrayTransformerWithModelClass:(Class)modelClass __attribute__((deprecated("Replaced by +[MTLJSONAdapter arrayTransformerWithModelClass:]")));
// Creates a reversible transformer to convert an array of JSON dictionaries
// into an array of MTLModel objects, and vice-versa.
//
// modelClass - The MTLModel subclass to attempt to parse from each JSON
// dictionary. This class must conform to <MTLJSONSerializing>.
// This argument must not be nil.
//
// Returns a reversible transformer which uses MTLJSONAdapter for transforming
// array elements back and forth.
+ (NSValueTransformer *)mtl_JSONArrayTransformerWithModelClass:(Class)modelClass;
@end
@interface NSValueTransformer (UnavailableMTLPredefinedTransformerAdditions)
+ (NSValueTransformer *)mtl_externalRepresentationTransformerWithModelClass:(Class)modelClass __attribute__((deprecated("Replaced by +mtl_JSONDictionaryTransformerWithModelClass:")));
+ (NSValueTransformer *)mtl_externalRepresentationArrayTransformerWithModelClass:(Class)modelClass __attribute__((deprecated("Replaced by +mtl_JSONArrayTransformerWithModelClass:")));
@end

440
Mantle/NSValueTransformer+MTLPredefinedTransformerAdditions.m
View File

@ -12,7 +12,6 @@
#import "MTLValueTransformer.h"
NSString * const MTLURLValueTransformerName = @"MTLURLValueTransformerName";
NSString * const MTLUUIDValueTransformerName = @"MTLUUIDValueTransformerName";
NSString * const MTLBooleanValueTransformerName = @"MTLBooleanValueTransformerName";
@implementation NSValueTransformer (MTLPredefinedTransformerAdditions)
@ -22,132 +21,20 @@ NSString * const MTLBooleanValueTransformerName = @"MTLBooleanValueTransformerNa
+ (void)load {
@autoreleasepool {
MTLValueTransformer *URLValueTransformer = [MTLValueTransformer
transformerUsingForwardBlock:^ id (NSString *str, BOOL *success, NSError **error) {
if (str == nil) return nil;
if (![str isKindOfClass:NSString.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert string to URL", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSString, got: %@.", @""), str],
MTLTransformerErrorHandlingInputValueErrorKey : str
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSURL *result = [NSURL URLWithString:str];
if (result == nil) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert string to URL", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Input URL string %@ was malformed", @""), str],
MTLTransformerErrorHandlingInputValueErrorKey : str
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
return result;
reversibleTransformerWithForwardBlock:^ id (NSString *str) {
if (![str isKindOfClass:NSString.class]) return nil;
return [NSURL URLWithString:str];
}
reverseBlock:^ id (NSURL *URL, BOOL *success, NSError **error) {
if (URL == nil) return nil;
if (![URL isKindOfClass:NSURL.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert URL to string", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSURL, got: %@.", @""), URL],
MTLTransformerErrorHandlingInputValueErrorKey : URL
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
reverseBlock:^ id (NSURL *URL) {
if (![URL isKindOfClass:NSURL.class]) return nil;
return URL.absoluteString;
}];
[NSValueTransformer setValueTransformer:URLValueTransformer forName:MTLURLValueTransformerName];
MTLValueTransformer *UUIDValueTransformer = [MTLValueTransformer
transformerUsingForwardBlock:^id(NSString *string, BOOL *success, NSError **error) {
if (string == nil) return nil;
if (![string isKindOfClass:NSString.class]) {
if (error) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert string to UUID", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSString, got: %@.", @""), string],
MTLTransformerErrorHandlingInputValueErrorKey : string
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSUUID *result = [[NSUUID alloc] initWithUUIDString:string];
if (result == nil) {
if (error) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert string to UUID", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Input UUID string %@ was malformed", @""), string],
MTLTransformerErrorHandlingInputValueErrorKey : string
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
return result;
}
reverseBlock:^id(NSUUID *uuid, BOOL *success, NSError **error) {
if (uuid == nil) return nil;
if (![uuid isKindOfClass:NSUUID.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert UUID to string", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSUUID, got: %@.", @""), uuid],
MTLTransformerErrorHandlingInputValueErrorKey : uuid};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
return uuid.UUIDString;
}];
[NSValueTransformer setValueTransformer:UUIDValueTransformer forName:MTLUUIDValueTransformerName];
MTLValueTransformer *booleanValueTransformer = [MTLValueTransformer
transformerUsingReversibleBlock:^ id (NSNumber *boolean, BOOL *success, NSError **error) {
if (boolean == nil) return nil;
if (![boolean isKindOfClass:NSNumber.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not convert number to boolean-backed number or vice-versa", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSNumber, got: %@.", @""), boolean],
MTLTransformerErrorHandlingInputValueErrorKey : boolean
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
reversibleTransformerWithBlock:^ id (NSNumber *boolean) {
if (![boolean isKindOfClass:NSNumber.class]) return nil;
return (NSNumber *)(boolean.boolValue ? kCFBooleanTrue : kCFBooleanFalse);
}];
@ -157,291 +44,62 @@ NSString * const MTLBooleanValueTransformerName = @"MTLBooleanValueTransformerNa
#pragma mark Customizable Transformers
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_arrayMappingTransformerWithTransformer:(NSValueTransformer *)transformer {
NSParameterAssert(transformer != nil);
id (^forwardBlock)(NSArray *values, BOOL *success, NSError **error) = ^ id (NSArray *values, BOOL *success, NSError **error) {
if (values == nil) return nil;
if (![values isKindOfClass:NSArray.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not transform non-array type", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSArray, got: %@.", @""), values],
MTLTransformerErrorHandlingInputValueErrorKey: values
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSMutableArray *transformedValues = [NSMutableArray arrayWithCapacity:values.count];
NSInteger index = -1;
for (id value in values) {
index++;
if (value == NSNull.null) {
[transformedValues addObject:NSNull.null];
continue;
}
id transformedValue = nil;
if ([transformer conformsToProtocol:@protocol(MTLTransformerErrorHandling)]) {
NSError *underlyingError = nil;
transformedValue = [(id<MTLTransformerErrorHandling>)transformer transformedValue:value success:success error:&underlyingError];
if (*success == NO) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not transform array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Could not transform value at index %d", @""), index],
NSUnderlyingErrorKey: underlyingError,
MTLTransformerErrorHandlingInputValueErrorKey: values
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
return nil;
}
} else {
transformedValue = [transformer transformedValue:value];
}
if (transformedValue == nil) continue;
[transformedValues addObject:transformedValue];
}
return transformedValues;
};
id (^reverseBlock)(NSArray *values, BOOL *success, NSError **error) = nil;
if (transformer.class.allowsReverseTransformation) {
reverseBlock = ^ id (NSArray *values, BOOL *success, NSError **error) {
if (values == nil) return nil;
if (![values isKindOfClass:NSArray.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not transform non-array type", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSArray, got: %@.", @""), values],
MTLTransformerErrorHandlingInputValueErrorKey: values
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSMutableArray *transformedValues = [NSMutableArray arrayWithCapacity:values.count];
NSInteger index = -1;
for (id value in values) {
index++;
if (value == NSNull.null) {
[transformedValues addObject:NSNull.null];
continue;
}
id transformedValue = nil;
if ([transformer respondsToSelector:@selector(reverseTransformedValue:success:error:)]) {
NSError *underlyingError = nil;
transformedValue = [(id<MTLTransformerErrorHandling>)transformer reverseTransformedValue:value success:success error:&underlyingError];
if (*success == NO) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Could not transform array", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Could not transform value at index %d", @""), index],
NSUnderlyingErrorKey: underlyingError,
MTLTransformerErrorHandlingInputValueErrorKey: values
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
return nil;
}
} else {
transformedValue = [transformer reverseTransformedValue:value];
}
if (transformedValue == nil) continue;
[transformedValues addObject:transformedValue];
}
return transformedValues;
};
}
if (reverseBlock != nil) {
return [MTLValueTransformer transformerUsingForwardBlock:forwardBlock reverseBlock:reverseBlock];
} else {
return [MTLValueTransformer transformerUsingForwardBlock:forwardBlock];
}
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_validatingTransformerForClass:(Class)modelClass {
NSParameterAssert(modelClass != nil);
return [MTLValueTransformer transformerUsingForwardBlock:^ id (id value, BOOL *success, NSError **error) {
if (value != nil && ![value isKindOfClass:modelClass]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: NSLocalizedString(@"Value did not match expected type", @""),
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected %1$@ to be of class %2$@ but got %3$@", @""), value, modelClass, [value class]],
MTLTransformerErrorHandlingInputValueErrorKey : value
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
return value;
}];
}
+ (NSValueTransformer *)mtl_valueMappingTransformerWithDictionary:(NSDictionary *)dictionary defaultValue:(id)defaultValue reverseDefaultValue:(id)reverseDefaultValue {
NSParameterAssert(dictionary != nil);
NSParameterAssert(dictionary.count == [[NSSet setWithArray:dictionary.allValues] count]);
+ (NSValueTransformer *)mtl_JSONDictionaryTransformerWithModelClass:(Class)modelClass {
NSParameterAssert([modelClass isSubclassOfClass:MTLModel.class]);
NSParameterAssert([modelClass conformsToProtocol:@protocol(MTLJSONSerializing)]);
return [MTLValueTransformer
transformerUsingForwardBlock:^ id (id <NSCopying> key, BOOL *success, NSError **error) {
return dictionary[key ?: NSNull.null] ?: defaultValue;
}
reverseBlock:^ id (id value, BOOL *success, NSError **error) {
__block id result = nil;
[dictionary enumerateKeysAndObjectsUsingBlock:^(id key, id anObject, BOOL *stop) {
if ([value isEqual:anObject]) {
result = key;
*stop = YES;
}
}];
reversibleTransformerWithForwardBlock:^ id (NSDictionary *JSONDictionary) {
if (JSONDictionary == nil) return nil;
return result ?: reverseDefaultValue;
}];
NSAssert([JSONDictionary isKindOfClass:NSDictionary.class], @"Expected a dictionary, got: %@", JSONDictionary);
return [MTLJSONAdapter modelOfClass:modelClass fromJSONDictionary:JSONDictionary error:NULL];
}
reverseBlock:^ id (MTLModel<MTLJSONSerializing> *model) {
if (model == nil) return nil;
NSAssert([model isKindOfClass:MTLModel.class], @"Expected a MTLModel object, got %@", model);
NSAssert([model conformsToProtocol:@protocol(MTLJSONSerializing)], @"Expected a model object conforming to <MTLJSONSerializing>, got %@", model);
return [MTLJSONAdapter JSONDictionaryFromModel:model];
}];
}
+ (NSValueTransformer *)mtl_valueMappingTransformerWithDictionary:(NSDictionary *)dictionary {
return [self mtl_valueMappingTransformerWithDictionary:dictionary defaultValue:nil reverseDefaultValue:nil];
}
+ (NSValueTransformer *)mtl_JSONArrayTransformerWithModelClass:(Class)modelClass {
NSValueTransformer *dictionaryTransformer = [self mtl_JSONDictionaryTransformerWithModelClass:modelClass];
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_dateTransformerWithDateFormat:(NSString *)dateFormat calendar:(NSCalendar *)calendar locale:(NSLocale *)locale timeZone:(NSTimeZone *)timeZone defaultDate:(NSDate *)defaultDate {
NSParameterAssert(dateFormat.length);
NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
dateFormatter.dateFormat = dateFormat;
dateFormatter.calendar = calendar;
dateFormatter.locale = locale;
dateFormatter.timeZone = timeZone;
dateFormatter.defaultDate = defaultDate;
return [NSValueTransformer mtl_transformerWithFormatter:dateFormatter forObjectClass:NSDate.class];
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_dateTransformerWithDateFormat:(NSString *)dateFormat locale:(NSLocale *)locale {
return [self mtl_dateTransformerWithDateFormat:dateFormat calendar:nil locale:locale timeZone:nil defaultDate:nil];
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_numberTransformerWithNumberStyle:(NSNumberFormatterStyle)numberStyle locale:(NSLocale *)locale {
NSNumberFormatter *numberFormatter = [[NSNumberFormatter alloc] init];
numberFormatter.numberStyle = numberStyle;
numberFormatter.locale = locale;
return [self mtl_transformerWithFormatter:numberFormatter forObjectClass:NSNumber.class];
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_transformerWithFormatter:(NSFormatter *)formatter forObjectClass:(Class)objectClass {
NSParameterAssert(formatter != nil);
NSParameterAssert(objectClass != nil);
return [MTLValueTransformer
transformerUsingForwardBlock:^ id (NSString *str, BOOL *success, NSError *__autoreleasing *error) {
if (str == nil) return nil;
reversibleTransformerWithForwardBlock:^ id (NSArray *dictionaries) {
if (dictionaries == nil) return nil;
if (![str isKindOfClass:NSString.class]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: [NSString stringWithFormat:NSLocalizedString(@"Could not convert string to %@", @""), objectClass],
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an NSString as input, got: %@.", @""), str],
MTLTransformerErrorHandlingInputValueErrorKey : str
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSAssert([dictionaries isKindOfClass:NSArray.class], @"Expected a array of dictionaries, got: %@", dictionaries);
id object = nil;
NSString *errorDescription = nil;
*success = [formatter getObjectValue:&object forString:str errorDescription:&errorDescription];
NSMutableArray *models = [NSMutableArray arrayWithCapacity:dictionaries.count];
for (NSDictionary *JSONDictionary in dictionaries) {
id model = [dictionaryTransformer transformedValue:JSONDictionary];
if (model == nil) continue;
if (errorDescription != nil) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: [NSString stringWithFormat:NSLocalizedString(@"Could not convert string to %@", @""), objectClass],
NSLocalizedFailureReasonErrorKey: errorDescription,
MTLTransformerErrorHandlingInputValueErrorKey : str
};
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
[models addObject:model];
}
if (![object isKindOfClass:objectClass]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: [NSString stringWithFormat:NSLocalizedString(@"Could not convert string to %@", @""), objectClass],
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an %@ as output from the formatter, got: %@.", @""), objectClass, object],
};
return models;
}
reverseBlock:^ id (NSArray *models) {
if (models == nil) return nil;
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFormattingError userInfo:userInfo];
}
*success = NO;
return nil;
}
NSAssert([models isKindOfClass:NSArray.class], @"Expected a array of MTLModels, got: %@", models);
return object;
} reverseBlock:^id(id object, BOOL *success, NSError *__autoreleasing *error) {
if (object == nil) return nil;
NSMutableArray *dictionaries = [NSMutableArray arrayWithCapacity:models.count];
for (MTLModel *model in models) {
NSDictionary *dict = [dictionaryTransformer reverseTransformedValue:model];
if (dict == nil) continue;
if (![object isKindOfClass:objectClass]) {
if (error != NULL) {
NSDictionary *userInfo = @{
NSLocalizedDescriptionKey: [NSString stringWithFormat:NSLocalizedString(@"Could not convert %@ to string", @""), objectClass],
NSLocalizedFailureReasonErrorKey: [NSString stringWithFormat:NSLocalizedString(@"Expected an %@ as input, got: %@.", @""), objectClass, object],
MTLTransformerErrorHandlingInputValueErrorKey : object
};
[dictionaries addObject:dict];
}
*error = [NSError errorWithDomain:MTLTransformerErrorHandlingErrorDomain code:MTLTransformerErrorHandlingErrorInvalidInput userInfo:userInfo];
}
*success = NO;
return nil;
}
NSString *string = [formatter stringForObjectValue:object];
*success = (string != nil);
return string;
}];
return dictionaries;
}];
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-implementations"
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_JSONDictionaryTransformerWithModelClass:(Class)modelClass {
return [MTLJSONAdapter dictionaryTransformerWithModelClass:modelClass];
}
+ (NSValueTransformer<MTLTransformerErrorHandling> *)mtl_JSONArrayTransformerWithModelClass:(Class)modelClass {
return [MTLJSONAdapter arrayTransformerWithModelClass:modelClass];
}
#pragma clang diagnostic pop
@end

4
Mantle/extobjc/EXTKeyPathCoding.h
View File

@ -50,10 +50,10 @@ NSString *lowercaseStringPath = @keypath(NSString.new, lowercaseString);
*
* @code
NSString *employeesFirstNamePath = @collectionKeypath(department.employees, Employee.new, firstName)
NSString *employessFirstNamePath = @collectionKeypath(department.employees, Employee.new, firstName)
// => @"employees.firstName"
NSString *employeesFirstNamePath = @collectionKeypath(Department.new, employees, Employee.new, firstName)
NSString *employessFirstNamePath = @collectionKeypath(Department.new, employees, Employee.new, firstName)
// => @"employees.firstName"
* @endcode

2
Mantle/extobjc/EXTRuntimeExtensions.m
View File

@ -9,8 +9,6 @@
#import "EXTRuntimeExtensions.h"
#import <Foundation/Foundation.h>
mtl_propertyAttributes *mtl_copyPropertyAttributes (objc_property_t property) {
const char * const attrString = property_getAttributes(property);
if (!attrString) {

2
Mantle/extobjc/EXTScope.h
View File

@ -88,7 +88,7 @@
_Pragma("clang diagnostic pop")
/*** implementation details follow ***/
typedef void (^mtl_cleanupBlock_t)(void);
typedef void (^mtl_cleanupBlock_t)();
void mtl_executeCleanupBlock (__strong mtl_cleanupBlock_t *block);

28
MantleTests/MTLArrayManipulationSpec.m
View File

@ -6,21 +6,17 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
QuickSpecBegin(MTLArrayManipulationAdditions)
SpecBegin(MTLArrayManipulationAdditions)
describe(@"-mtl_firstObject", ^{
it(@"should return the first object", ^{
NSArray *array = @[ @1, @2, @3 ];
expect(array.mtl_firstObject).to(equal(@1));
expect(array.mtl_firstObject).to.equal(@1);
});
it(@"should return nil for an empty array", ^{
NSArray *array = @[];
expect(array.mtl_firstObject).to(beNil());
expect(array.mtl_firstObject).to.beNil();
});
});
@ -28,18 +24,18 @@ describe(@"-mtl_arrayByRemovingObject:", ^{
it(@"should return a new array without the object", ^{
NSArray *array = @[ @1, @2, @3 ];
NSArray *expected = @[ @2, @3 ];
expect([array mtl_arrayByRemovingObject:@1]).to(equal(expected));
expect([array mtl_arrayByRemovingObject:@1]).to.equal(expected);
});
it(@"should return a new array without all occurrences of the object", ^{
NSArray *array = @[ @1, @2, @3, @1, @1 ];
NSArray *expected = @[ @2, @3 ];
expect([array mtl_arrayByRemovingObject:@1]).to(equal(expected));
expect([array mtl_arrayByRemovingObject:@1]).to.equal(expected);
});
it(@"should return an equivalent array if it doesn't contain the object", ^{
NSArray *array = @[ @1, @2, @3 ];
expect([array mtl_arrayByRemovingObject:@42]).to(equal(array));
expect([array mtl_arrayByRemovingObject:@42]).to.equal(array);
});
});
@ -47,12 +43,12 @@ describe(@"-mtl_arrayByRemovingFirstObject", ^{
it(@"should return the array without the first object", ^{
NSArray *array = @[ @1, @2, @3 ];
NSArray *expected = @[ @2, @3 ];
expect(array.mtl_arrayByRemovingFirstObject).to(equal(expected));
expect(array.mtl_arrayByRemovingFirstObject).to.equal(expected);
});
it(@"should return the same array if it's empty", ^{
NSArray *array = @[];
expect(array.mtl_arrayByRemovingFirstObject).to(equal(array));
expect(array.mtl_arrayByRemovingFirstObject).to.equal(array);
});
});
@ -60,13 +56,13 @@ describe(@"-mtl_arrayByRemovingLastObject", ^{
it(@"should return the array without the last object", ^{
NSArray *array = @[ @1, @2, @3 ];
NSArray *expected = @[ @1, @2 ];
expect(array.mtl_arrayByRemovingLastObject).to(equal(expected));
expect(array.mtl_arrayByRemovingLastObject).to.equal(expected);
});
it(@"should return the same array if it's empty", ^{
NSArray *array = @[];
expect(array.mtl_arrayByRemovingLastObject).to(equal(array));
expect(array.mtl_arrayByRemovingLastObject).to.equal(array);
});
});
QuickSpecEnd
SpecEnd

20
MantleTests/MTLComparisonAdditionsSpec.m
View File

@ -9,36 +9,32 @@
// See the LICENSE file for more information.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "NSObject+MTLComparisonAdditions.h"
QuickSpecBegin(MTLComparisonAdditions)
SpecBegin(MTLComparisonAdditions)
describe(@"MTLEqualObjects", ^{
id obj1 = @"Test1";
id obj2 = @"Test2";
it(@"returns true when given two values of nil", ^{
expect(@(MTLEqualObjects(nil, nil))).to(beTruthy());
expect(MTLEqualObjects(nil, nil)).to.beTruthy();
});
it(@"returns true when given two equal objects", ^{
expect(@(MTLEqualObjects(obj1, obj1))).to(beTruthy());
expect(MTLEqualObjects(obj1, obj1)).to.beTruthy();
});
it(@"returns false when given two inequal objects", ^{
expect(@(MTLEqualObjects(obj1, obj2))).to(beFalsy());
expect(MTLEqualObjects(obj1, obj2)).to.beFalsy();
});
it(@"returns false when given an object and nil", ^{
expect(@(MTLEqualObjects(obj1, nil))).to(beFalsy());
expect(MTLEqualObjects(obj1, nil)).to.beFalsy();
});
it(@"returns the same value when given symmetric arguments", ^{
expect(@(MTLEqualObjects(obj2, obj1))).to(equal(@(MTLEqualObjects(obj1, obj2))));
expect(MTLEqualObjects(obj2, obj1)).to.equal(MTLEqualObjects(obj1, obj2));
});
describe(@"when comparing mutable objects", ^{
@ -46,9 +42,9 @@ describe(@"MTLEqualObjects", ^{
id mutableObj2 = [obj1 mutableCopy];
it(@"returns true when given two equal but not identical objects", ^{
expect(@(MTLEqualObjects(mutableObj1, mutableObj2))).to(beTruthy());
expect(MTLEqualObjects(mutableObj1, mutableObj2)).to.beTruthy();
});
});
});
QuickSpecEnd
SpecEnd

35
MantleTests/MTLCoreDataTestModels.h Normal file
View File

@ -0,0 +1,35 @@
//
// MTLCoreDataTestModels.h
// Mantle
//
// Created by Justin Spahr-Summers on 2013-04-05.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <CoreData/CoreData.h>
// Corresponds to the `Parent` entity.
@interface MTLParentTestModel : MTLModel <MTLManagedObjectSerializing>
// Associated with the `number` attribute.
@property (nonatomic, copy) NSString *numberString;
@property (nonatomic, copy) NSDate *date;
@property (nonatomic, copy) NSString *requiredString;
@property (nonatomic, copy) NSArray *orderedChildren;
@property (nonatomic, copy) NSSet *unorderedChildren;
@end
// Corresponds to the `Child` entity.
@interface MTLChildTestModel : MTLModel <MTLManagedObjectSerializing>
// Associated with the `id` attribute.
@property (nonatomic, assign) NSUInteger childID;
@property (nonatomic, weak) MTLParentTestModel *parent1;
@property (nonatomic, weak) MTLParentTestModel *parent2;
@end

60
MantleTests/MTLCoreDataTestModels.m Normal file
View File

@ -0,0 +1,60 @@
//
// MTLCoreDataTestModels.m
// Mantle
//
// Created by Justin Spahr-Summers on 2013-04-05.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import "MTLCoreDataTestModels.h"
@implementation MTLParentTestModel
+ (NSString *)managedObjectEntityName {
return @"Parent";
}
+ (NSDictionary *)managedObjectKeysByPropertyKey {
return @{
@"numberString": @"number",
@"requiredString": @"string"
};
}
+ (NSValueTransformer *)numberStringEntityAttributeTransformer {
return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSString *str) {
return [NSDecimalNumber decimalNumberWithString:str];
} reverseBlock:^(NSNumber *num) {
return num.stringValue;
}];
}
+ (NSDictionary *)relationshipModelClassesByPropertyKey {
return @{
@"orderedChildren": MTLChildTestModel.class,
@"unorderedChildren": MTLChildTestModel.class,
};
}
@end
@implementation MTLChildTestModel
+ (NSString *)managedObjectEntityName {
return @"Child";
}
+ (NSDictionary *)managedObjectKeysByPropertyKey {
return @{
@"childID": @"id"
};
}
+ (NSDictionary *)relationshipModelClassesByPropertyKey {
return @{
@"parent1": MTLParentTestModel.class,
@"parent2": MTLParentTestModel.class,
};
}
@end

34
MantleTests/MTLDictionaryManipulationSpec.m
View File

@ -6,62 +6,58 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
QuickSpecBegin(MTLDictionaryManipulationAdditions)
SpecBegin(MTLDictionaryManipulationAdditions)
describe(@"-mtl_dictionaryByAddingEntriesFromDictionary:", ^{
NSDictionary *dict = @{ @"foo": @"bar", @(5): NSNull.null };
it(@"should return the same dictionary when adding from an empty dictionary", ^{
NSDictionary *combined = [dict mtl_dictionaryByAddingEntriesFromDictionary:@{}];
expect(combined).to(equal(dict));
expect(combined).to.equal(dict);
});
it(@"should return the same dictionary when adding from nil", ^{
NSDictionary *combined = [dict mtl_dictionaryByAddingEntriesFromDictionary:nil];
expect(combined).to(equal(dict));
expect(combined).to.equal(dict);
});
it(@"should add any new keys", ^{
NSDictionary *combined = [dict mtl_dictionaryByAddingEntriesFromDictionary:@{ @"buzz": @(10), @"baz": NSNull.null }];
NSDictionary *expected = @{ @"foo": @"bar", @(5): NSNull.null, @"buzz": @(10), @"baz": NSNull.null };
expect(combined).to(equal(expected));
expect(combined).to.equal(expected);
});
it(@"should replace any existing keys", ^{
NSDictionary *combined = [dict mtl_dictionaryByAddingEntriesFromDictionary:@{ @(5): @(10), @"buzz": @"baz" }];
NSDictionary *expected = @{ @"foo": @"bar", @(5): @(10), @"buzz": @"baz" };
expect(combined).to(equal(expected));
expect(combined).to.equal(expected);
});
});
describe(@"-mtl_dictionaryByRemovingValuesForKeys:", ^{
describe(@"-mtl_dictionaryByRemovingEntriesWithKeys:", ^{
NSDictionary *dict = @{ @"foo": @"bar", @(5): NSNull.null };
it(@"should return the same dictionary when removing keys that don't exist in the receiver", ^{
NSDictionary *removed = [dict mtl_dictionaryByRemovingValuesForKeys:@[ @"hi"]];
expect(removed).to(equal(dict));
NSDictionary *removed = [dict mtl_dictionaryByRemovingEntriesWithKeys:[NSSet setWithObject:@"hi"]];
expect(removed).to.equal(dict);
});
it(@"should return the same dictionary when given a nil array of keys", ^{
NSDictionary *removed = [dict mtl_dictionaryByRemovingValuesForKeys:nil];
expect(removed).to(equal(dict));
NSDictionary *removed = [dict mtl_dictionaryByRemovingEntriesWithKeys:nil];
expect(removed).to.equal(dict);
});
it(@"should remove all the entries for the given keys", ^{
NSDictionary *removed = [dict mtl_dictionaryByRemovingValuesForKeys:@[ @5 ]];
NSDictionary *removed = [dict mtl_dictionaryByRemovingEntriesWithKeys:[NSSet setWithObject:@(5)]];
NSDictionary *expected = @{ @"foo": @"bar" };
expect(removed).to(equal(expected));
expect(removed).to.equal(expected);
});
it(@"should return an empty dictionary when it removes all its keys", ^{
NSDictionary *removed = [dict mtl_dictionaryByRemovingValuesForKeys:dict.allKeys];
NSDictionary *removed = [dict mtl_dictionaryByRemovingEntriesWithKeys:[NSSet setWithArray:dict.allKeys]];
NSDictionary *expected = @{};
expect(removed).to(equal(expected));
expect(removed).to.equal(expected);
});
});
QuickSpecEnd
SpecEnd

28
MantleTests/MTLDictionaryMappingSpec.m
View File

@ -1,28 +0,0 @@
//
// MTLDictionaryMappingSpec.m
// Mantle
//
// Created by Robert Böhnke on 10/23/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Quick/Quick.h>
#import <Nimble/Nimble.h>
#import "MTLTestModel.h"
#import "NSDictionary+MTLMappingAdditions.h"
QuickSpecBegin(MTLDictionaryMappingAdditions)
it(@"should return a mapping", ^{
NSDictionary *mapping = @{
@"name": @"name",
@"count": @"count",
@"nestedName": @"nestedName",
@"weakModel": @"weakModel"
};
expect([NSDictionary mtl_identityPropertyMapWithModel:MTLTestModel.class]).to(equal(mapping));
});
QuickSpecEnd

14
MantleTests/MTLErrorModelExceptionSpec.m
View File

@ -6,13 +6,9 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "NSError+MTLModelException.h"
QuickSpecBegin(MTLErrorModelException)
SpecBegin(MTLErrorModelException)
describe(@"+mtl_modelErrorWithException:", ^{
it(@"should return a new error for that exception", ^{
@ -20,10 +16,10 @@ describe(@"+mtl_modelErrorWithException:", ^{
NSError *error = [NSError mtl_modelErrorWithException:exception];
expect(error).notTo(beNil());
expect(error.localizedDescription).to(equal(@"Just Testing"));
expect(error.localizedFailureReason).to(equal(@"Just Testing"));
expect(error).toNot.beNil();
expect(error.localizedDescription).to.equal(@"Just Testing");
expect(error.localizedFailureReason).to.equal(@"Just Testing");
});
});
QuickSpecEnd
SpecEnd

667
MantleTests/MTLJSONAdapterSpec.m
View File

@ -6,57 +6,52 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "MTLTestJSONAdapter.h"
#import "MTLTestModel.h"
#import "MTLTransformerErrorExamples.h"
@interface MTLJSONAdapter (SpecExtensions)
SpecBegin(MTLJSONAdapter)
// Used for testing transformer lifetimes.
+ (NSValueTransformer *)NSDateJSONTransformer;
@end
@implementation MTLJSONAdapter (SpecExtensions)
+ (NSValueTransformer *)NSDateJSONTransformer {
return [[NSValueTransformer alloc] init];
}
@end
QuickSpecBegin(MTLJSONAdapterSpec)
it(@"should initialize with a model class", ^{
it(@"should initialize from JSON", ^{
NSDictionary *values = @{
@"username": NSNull.null,
@"count": @"5",
};
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithModelClass:MTLTestModel.class];
expect(adapter).notTo(beNil());
NSError *error = nil;
MTLTestModel *model = [adapter modelFromJSONDictionary:values error:&error];
expect(error).to(beNil());
expect(model).notTo(beNil());
expect(model.name).to(beNil());
expect(@(model.count)).to(equal(@5));
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithJSONDictionary:values modelClass:MTLTestModel.class error:&error];
expect(adapter).notTo.beNil();
expect(error).to.beNil();
MTLTestModel *model = (id)adapter.model;
expect(model).notTo.beNil();
expect(model.name).to.beNil();
expect(model.count).to.equal(5);
NSDictionary *JSONDictionary = @{
@"username": NSNull.null,
@"count": @"5",
@"nested": @{ @"name": NSNull.null },
};
__block NSError *serializationError;
expect([adapter JSONDictionaryFromModel:model error:&serializationError]).to(equal(JSONDictionary));
expect(serializationError).to(beNil());
expect(adapter.JSONDictionary).to.equal(JSONDictionary);
});
it(@"should initialize from a model", ^{
MTLTestModel *model = [MTLTestModel modelWithDictionary:@{
@"name": @"foobar",
@"count": @5,
} error:NULL];
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithModel:model];
expect(adapter).notTo.beNil();
expect(adapter.model).to.beIdenticalTo(model);
NSDictionary *JSONDictionary = @{
@"username": @"foobar",
@"count": @"5",
@"nested": @{ @"name": NSNull.null },
};
expect(adapter.JSONDictionary).to.equal(JSONDictionary);
});
it(@"should initialize nested key paths from JSON", ^{
@ -68,98 +63,21 @@ it(@"should initialize nested key paths from JSON", ^{
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLTestModel.class fromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(model).notTo.beNil();
expect(error).to.beNil();
expect(model.name).to(equal(@"foo"));
expect(@(model.count)).to(equal(@0));
expect(model.nestedName).to(equal(@"bar"));
expect(model.name).to.equal(@"foo");
expect(model.count).to.equal(0);
expect(model.nestedName).to.equal(@"bar");
__block NSError *serializationError;
expect([MTLJSONAdapter JSONDictionaryFromModel:model error:&serializationError]).to(equal(values));
expect(serializationError).to(beNil());
expect([MTLJSONAdapter JSONDictionaryFromModel:model]).to.equal(values);
});
it(@"it should initialize properties with multiple key paths from JSON", ^{
NSDictionary *values = @{
@"location": @20,
@"length": @12,
@"nested": @{
@"location": @12,
@"length": @34
}
};
it(@"should return nil with a nil JSON dictionary, but no error", ^{
NSError *error = nil;
MTLMultiKeypathModel *model = [MTLJSONAdapter modelOfClass:MTLMultiKeypathModel.class fromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(@(model.range.location)).to(equal(@20));
expect(@(model.range.length)).to(equal(@12));
expect(@(model.nestedRange.location)).to(equal(@12));
expect(@(model.nestedRange.length)).to(equal(@34));
__block NSError *serializationError;
expect([MTLJSONAdapter JSONDictionaryFromModel:model error:&serializationError]).to(equal(values));
expect(serializationError).to(beNil());
});
it(@"should return nil and error with an invalid key path from JSON",^{
NSDictionary *values = @{
@"username": @"foo",
@"nested": @"bar",
@"count": @"0"
};
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLTestModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLJSONAdapterErrorDomain));
expect(@(error.code)).to(equal(@(MTLJSONAdapterErrorInvalidJSONDictionary)));
});
it(@"should support key paths across arrays", ^{
NSDictionary *values = @{
@"users": @[
@{
@"name": @"foo"
},
@{
@"name": @"bar"
},
@{
@"name": @"baz"
}
]
};
NSError *error = nil;
MTLArrayTestModel *model = [MTLJSONAdapter modelOfClass:MTLArrayTestModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLJSONAdapterErrorDomain));
expect(@(error.code)).to(equal(@(MTLJSONAdapterErrorInvalidJSONDictionary)));
});
it(@"should initialize without returning any error when using a JSON dictionary which Null.null as value",^{
NSDictionary *values = @{
@"username": @"foo",
@"nested": NSNull.null,
@"count": @"0"
};
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLTestModel.class fromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(model.name).to(equal(@"foo"));
expect(@(model.count)).to(equal(@0));
expect(model.nestedName).to(beNil());
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithJSONDictionary:nil modelClass:MTLTestModel.class error:&error];
expect(adapter).to.beNil();
expect(error).to.beNil();
});
it(@"should ignore unrecognized JSON keys", ^{
@ -173,12 +91,12 @@ it(@"should ignore unrecognized JSON keys", ^{
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLTestModel.class fromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(model).notTo.beNil();
expect(error).to.beNil();
expect(model.name).to(equal(@"buzz"));
expect(@(model.count)).to(equal(@2));
expect(model.nestedName).to(equal(@"bar"));
expect(model.name).to.equal(@"buzz");
expect(model.count).to.equal(2);
expect(model.nestedName).to.equal(@"bar");
});
it(@"should fail to initialize if JSON dictionary validation fails", ^{
@ -188,175 +106,9 @@ it(@"should fail to initialize if JSON dictionary validation fails", ^{
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLTestModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error.domain).to(equal(MTLTestModelErrorDomain));
expect(@(error.code)).to(equal(@(MTLTestModelNameTooLong)));
});
it(@"should implicitly transform NSStrings to URLs", ^{
NSDictionary *values = @{
@"URL": @"http://github.com/1",
@"otherURL": @"http://github.com/2",
};
NSError *error = nil;
MTLURLSubclassModel *model = [MTLJSONAdapter modelOfClass:MTLURLSubclassModel.class fromJSONDictionary:values error:&error];
expect(model.URL).to(equal([NSURL URLWithString:@"http://github.com/1"]));
expect(model.otherURL).to(equal([NSURL URLWithString:@"http://github.com/2"]));
expect(error).to(beNil());
});
it(@"should implicitly transform URLs", ^{
MTLURLModel *model = [[MTLURLModel alloc] init];
NSError *error = nil;
NSDictionary *JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:&error];
expect(JSONDictionary[@"URL"]).to(equal(@"http://github.com"));
expect(error).to(beNil());
});
it(@"should implicitly transform NSStrings to UUIDs", ^{
NSDictionary *values = @{
@"UUID": @"D278C472-6DC3-4EE1-A947-861E6AF311C3",
@"otherUUID": @"24E1E56A-3F37-4ECE-8310-931F6ACD401A",
};
NSError *error = nil;
MTLUUIDSubclassModel *model = [MTLJSONAdapter modelOfClass:MTLUUIDSubclassModel.class fromJSONDictionary:values error:&error];
expect(model.UUID).to(equal([[NSUUID alloc] initWithUUIDString:@"D278C472-6DC3-4EE1-A947-861E6AF311C3"]));
expect(model.otherUUID).to(equal([[NSUUID alloc] initWithUUIDString:@"24E1E56A-3F37-4ECE-8310-931F6ACD401A"]));
expect(error).to(beNil());
});
it(@"should implicitly transform UUIDs", ^{
MTLUUIDModel *model = [[MTLUUIDModel alloc] init];
NSError *error = nil;
NSDictionary *JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:&error];
expect(JSONDictionary[@"UUID"]).to(equal(@"4A275FBD-8217-4397-964B-403F4C2B8545"));
expect(error).to(beNil());
});
it(@"should implicitly transform BOOLs", ^{
MTLBoolModel *model = [[MTLBoolModel alloc] init];
NSError *error = nil;
NSDictionary *JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:&error];
expect(JSONDictionary[@"flag"]).to(beIdenticalTo((id)kCFBooleanFalse));
expect(error).to(beNil());
});
it(@"should not invoke implicit transformers for property keys not actually backed by properties", ^{
MTLNonPropertyModel *model = [[MTLNonPropertyModel alloc] init];
NSError *error = nil;
NSDictionary *JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:&error];
expect(error).to(beNil());
expect(JSONDictionary[@"homepage"]).to(equal(model.homepage));
});
it(@"should fail to initialize if JSON transformer fails", ^{
NSDictionary *values = @{
@"URL": @666,
};
NSError *error = nil;
MTLModel *model = [MTLJSONAdapter modelOfClass:MTLURLModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(@666));
});
it(@"should fail to deserialize if the JSON types don't match the primitive properties", ^{
NSDictionary *values = @{
@"flag": @"Potentially"
};
NSError *error = nil;
MTLModel *model = [MTLJSONAdapter modelOfClass:MTLBoolModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(@"Potentially"));
});
it(@"should fail to deserialize if the JSON types don't match the properties", ^{
NSDictionary *values = @{
@"string": @666
};
NSError *error = nil;
MTLModel *model = [MTLJSONAdapter modelOfClass:MTLStringModel.class fromJSONDictionary:values error:&error];
expect(model).to(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(@666));
});
it(@"should allow subclasses to filter serialized property keys", ^{
NSDictionary *values = @{
@"username": @"foo",
@"count": @"5",
@"nested": @{ @"name": NSNull.null }
};
MTLTestJSONAdapter *adapter = [[MTLTestJSONAdapter alloc] initWithModelClass:MTLTestModel.class];
NSError *error;
MTLTestModel *model = [adapter modelFromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
NSDictionary *complete = [adapter JSONDictionaryFromModel:model error:&error];
NSDictionary *expected = [values mtl_dictionaryByAddingEntriesFromDictionary:@{ @"test": @YES }];
expect(complete).to(equal(expected));
expect(error).to(beNil());
adapter.ignoredPropertyKeys = [NSSet setWithObjects:@"count", @"nestedName", nil];
NSDictionary *partial = [adapter JSONDictionaryFromModel:model error:&error];
expected = @{
@"username": @"foo",
@"test": @YES,
};
expect(partial).to(equal(expected));
expect(error).to(beNil());
});
it(@"should accept any object for id properties", ^{
NSDictionary *values = @{
@"anyObject": @"Not an NSValue"
};
NSError *error = nil;
MTLIDModel *model = [MTLJSONAdapter modelOfClass:MTLIDModel.class fromJSONDictionary:values error:&error];
expect(model).notTo(beNil());
expect(model.anyObject).to(equal(@"Not an NSValue"));
expect(error.domain).to(beNil());
});
it(@"should fail to serialize if a JSON transformer errors", ^{
MTLURLModel *model = [[MTLURLModel alloc] init];
[model setValue:@"totallyNotAnNSURL" forKey:@"URL"];
NSError *error;
NSDictionary *dictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:&error];
expect(dictionary).to(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(@"totallyNotAnNSURL"));
expect(model).to.beNil();
expect(error.domain).to.equal(MTLTestModelErrorDomain);
expect(error.code).to.equal(MTLTestModelNameTooLong);
});
it(@"should parse a different model class", ^{
@ -368,325 +120,24 @@ it(@"should parse a different model class", ^{
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLSubstitutingTestModel.class fromJSONDictionary:values error:&error];
expect(model).to(beAnInstanceOf(MTLTestModel.class));
expect(error).to(beNil());
expect(model).to.beKindOf(MTLTestModel.class);
expect(error).to.beNil();
expect(model.name).to(equal(@"foo"));
expect(@(model.count)).to(equal(@0));
expect(model.nestedName).to(equal(@"bar"));
expect(model.name).to.equal(@"foo");
expect(model.count).to.equal(0);
expect(model.nestedName).to.equal(@"bar");
__block NSError *serializationError;
expect([MTLJSONAdapter JSONDictionaryFromModel:model error:&serializationError]).to(equal(values));
expect(serializationError).to(beNil());
});
it(@"should serialize different model classes", ^{
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithModelClass:MTLClassClusterModel.class];
MTLChocolateClassClusterModel *chocolate = [MTLChocolateClassClusterModel modelWithDictionary:@{
@"bitterness": @100
} error:NULL];
NSError *error = nil;
NSDictionary *chocolateValues = [adapter JSONDictionaryFromModel:chocolate error:&error];
expect(error).to(beNil());
expect(chocolateValues).to(equal((@{
@"flavor": @"chocolate",
@"chocolate_bitterness": @"100"
})));
MTLStrawberryClassClusterModel *strawberry = [MTLStrawberryClassClusterModel modelWithDictionary:@{
@"freshness": @20
} error:NULL];
NSDictionary *strawberryValues = [adapter JSONDictionaryFromModel:strawberry error:&error];
expect(error).to(beNil());
expect(strawberryValues).to(equal((@{
@"flavor": @"strawberry",
@"strawberry_freshness": @20
})));
});
it(@"should parse model classes not inheriting from MTLModel", ^{
NSDictionary *values = @{
@"name": @"foo",
};
NSError *error = nil;
MTLConformingModel *model = [MTLJSONAdapter modelOfClass:MTLConformingModel.class fromJSONDictionary:values error:&error];
expect(model).to(beAnInstanceOf(MTLConformingModel.class));
expect(error).to(beNil());
expect(model.name).to(equal(@"foo"));
expect([MTLJSONAdapter JSONDictionaryFromModel:model]).to.equal(values);
});
it(@"should return an error when no suitable model class is found", ^{
NSError *error = nil;
MTLTestModel *model = [MTLJSONAdapter modelOfClass:MTLSubstitutingTestModel.class fromJSONDictionary:@{} error:&error];
expect(model).to(beNil());
expect(model).to.beNil();
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLJSONAdapterErrorDomain));
expect(@(error.code)).to(equal(@(MTLJSONAdapterErrorNoClassFound)));
expect(error).notTo.beNil();
expect(error.domain).to.equal(MTLJSONAdapterErrorDomain);
expect(error.code).to.equal(MTLJSONAdapterErrorNoClassFound);
});
it(@"should validate models", ^{
NSError *error = nil;
MTLValidationModel *model = [MTLJSONAdapter modelOfClass:MTLValidationModel.class fromJSONDictionary:@{} error:&error];
expect(model).to(beNil());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTestModelErrorDomain));
expect(@(error.code)).to(equal(@(MTLTestModelNameMissing)));
});
describe(@"JSON transformers", ^{
describe(@"dictionary transformer", ^{
__block NSValueTransformer *transformer;
__block MTLTestModel *model;
__block NSDictionary *JSONDictionary;
beforeEach(^{
model = [[MTLTestModel alloc] init];
JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:model error:NULL];
transformer = [MTLJSONAdapter dictionaryTransformerWithModelClass:MTLTestModel.class];
expect(transformer).notTo(beNil());
});
it(@"should transform a JSON dictionary into a model", ^{
expect([transformer transformedValue:JSONDictionary]).to(equal(model));
});
it(@"should transform a model into a JSON dictionary", ^{
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect([transformer reverseTransformedValue:model]).to(equal(JSONDictionary));
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
describe(@"external representation array transformer", ^{
__block NSValueTransformer *transformer;
__block NSArray *models;
__block NSArray *JSONDictionaries;
beforeEach(^{
NSMutableArray *uniqueModels = [NSMutableArray array];
NSMutableArray *mutableDictionaries = [NSMutableArray array];
for (NSUInteger i = 0; i < 10; i++) {
MTLTestModel *model = [[MTLTestModel alloc] init];
model.count = i;
[uniqueModels addObject:model];
NSDictionary *dict = [MTLJSONAdapter JSONDictionaryFromModel:model error:NULL];
expect(dict).notTo(beNil());
[mutableDictionaries addObject:dict];
}
uniqueModels[2] = NSNull.null;
mutableDictionaries[2] = NSNull.null;
models = [uniqueModels copy];
JSONDictionaries = [mutableDictionaries copy];
transformer = [MTLJSONAdapter arrayTransformerWithModelClass:MTLTestModel.class];
expect(transformer).notTo(beNil());
});
it(@"should transform JSON dictionaries into models", ^{
expect([transformer transformedValue:JSONDictionaries]).to(equal(models));
});
it(@"should transform models into JSON dictionaries", ^{
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect([transformer reverseTransformedValue:models]).to(equal(JSONDictionaries));
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
it(@"should use receiving class for serialization", ^{
NSDictionary *values = @{
@"username": @"foo",
@"count": @"5",
@"nested": @{ @"name": NSNull.null }
};
NSValueTransformer *transformer = [MTLTestJSONAdapter dictionaryTransformerWithModelClass:MTLTestModel.class];
MTLTestModel *model = [transformer transformedValue:values];
expect(model).to(beAKindOf(MTLTestModel.class));
expect(model).notTo(beNil());
NSDictionary *serialized = [transformer reverseTransformedValue:model];
expect(serialized).notTo(beNil());
expect(serialized[@"test"]).to(beTruthy());
});
});
describe(@"Deserializing multiple models", ^{
NSDictionary *value1 = @{
@"username": @"foo"
};
NSDictionary *value2 = @{
@"username": @"bar"
};
NSArray *JSONModels = @[ value1, value2 ];
it(@"should initialize models from an array of JSON dictionaries", ^{
NSError *error = nil;
NSArray *mantleModels = [MTLJSONAdapter modelsOfClass:MTLTestModel.class fromJSONArray:JSONModels error:&error];
expect(error).to(beNil());
expect(mantleModels).notTo(beNil());
expect(@(mantleModels.count)).to(equal(@2));
expect([mantleModels[0] name]).to(equal(@"foo"));
expect([mantleModels[1] name]).to(equal(@"bar"));
});
it(@"should not be affected by a NULL error parameter", ^{
NSError *error = nil;
NSArray *expected = [MTLJSONAdapter modelsOfClass:MTLTestModel.class fromJSONArray:JSONModels error:&error];
NSArray *models = [MTLJSONAdapter modelsOfClass:MTLTestModel.class fromJSONArray:JSONModels error:NULL];
expect(models).to(equal(expected));
});
});
it(@"should return nil and an error if it fails to initialize any model from an array", ^{
NSDictionary *value1 = @{
@"username": @"foo",
@"count": @"1",
};
NSDictionary *value2 = @{
@"count": @[ @"This won't parse" ],
};
NSArray *JSONModels = @[ value1, value2 ];
NSError *error = nil;
NSArray *mantleModels = [MTLJSONAdapter modelsOfClass:MTLSubstitutingTestModel.class fromJSONArray:JSONModels error:&error];
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLJSONAdapterErrorDomain));
expect(@(error.code)).to(equal(@(MTLJSONAdapterErrorNoClassFound)));
expect(mantleModels).to(beNil());
});
it(@"should return an array of dictionaries from models", ^{
MTLTestModel *model1 = [[MTLTestModel alloc] init];
model1.name = @"foo";
MTLTestModel *model2 = [[MTLTestModel alloc] init];
model2.name = @"bar";
NSError *error;
NSArray *JSONArray = [MTLJSONAdapter JSONArrayFromModels:@[ model1, model2 ] error:&error];
expect(error).to(beNil());
expect(JSONArray).notTo(beNil());
expect(@(JSONArray.count)).to(equal(@2));
expect(JSONArray[0][@"username"]).to(equal(@"foo"));
expect(JSONArray[1][@"username"]).to(equal(@"bar"));
});
it(@"should not leak transformers", ^{
__weak id weakTransformer;
@autoreleasepool {
id transformer = [MTLJSONAdapter transformerForModelPropertiesOfClass:NSDate.class];
weakTransformer = transformer;
expect(transformer).notTo(beNil());
}
expect(weakTransformer).toEventually(beNil());
});
it(@"should support recursive models", ^{
NSDictionary *dictionary = @{
@"owner": @{ @"name": @"Cameron" },
@"users": @[
@{ @"name": @"Dimitri" },
@{ @"name": @"John" },
],
};
NSError *error = nil;
MTLRecursiveGroupModel *group = [MTLJSONAdapter modelOfClass:MTLRecursiveGroupModel.class fromJSONDictionary:dictionary error:&error];
expect(group).notTo(beNil());
expect(@(group.users.count)).to(equal(@2));
});
it(@"should automatically transform a property that conforms to MTLJSONSerializing", ^{
NSDictionary *JSONDictionary = @{
@"property": @"property",
@"conformingMTLJSONSerializingProperty":@{
@"username": @"testName",
@"count": @"5",
},
@"nonConformingMTLJSONSerializingProperty": NSNull.null
};
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithModelClass:MTLPropertyDefaultAdapterModel.class];
expect(adapter).notTo(beNil());
NSError *error = nil;
MTLPropertyDefaultAdapterModel *model = [MTLJSONAdapter modelOfClass:MTLPropertyDefaultAdapterModel.class fromJSONDictionary:JSONDictionary error:&error];
expect(model).notTo(beNil());
expect(model.conformingMTLJSONSerializingProperty).notTo(beNil());
expect(model.conformingMTLJSONSerializingProperty.name).to(equal(@"testName"));
expect(model.nonConformingMTLJSONSerializingProperty).to(beNil());
expect(model.property).to(equal(@"property"));
expect(error).to(beNil());
});
it(@"should not automatically transform a property that conforms to MTLModel but not MTLJSONSerializing", ^{
NSDictionary *JSONDictionary = @{
@"property": @"property",
@"conformingMTLJSONSerializingProperty":@{
@"username": @"testName",
@"count": @"5",
},
/// Triggers an error since the dictionary is not automatically parsed
/// and no transformer is supplied.
@"nonConformingMTLJSONSerializingProperty": @{}
};
MTLJSONAdapter *adapter = [[MTLJSONAdapter alloc] initWithModelClass:MTLPropertyDefaultAdapterModel.class];
expect(adapter).notTo(beNil());
NSError *error = nil;
MTLPropertyDefaultAdapterModel *model = [adapter modelFromJSONDictionary:JSONDictionary error:&error];
expect(model).to(beNil());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
});
QuickSpecEnd
SpecEnd

236
MantleTests/MTLManagedObjectAdapterSpec.m Normal file
View File

@ -0,0 +1,236 @@
//
// MTLManagedObjectAdapterSpec.m
// Mantle
//
// Created by Justin Spahr-Summers on 2013-05-17.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import "MTLCoreDataTestModels.h"
SpecBegin(MTLManagedObjectAdapter)
__block NSPersistentStoreCoordinator *persistentStoreCoordinator;
beforeEach(^{
NSManagedObjectModel *model = [NSManagedObjectModel mergedModelFromBundles:@[ [NSBundle bundleForClass:self.class] ]];
expect(model).notTo.beNil();
persistentStoreCoordinator = [[NSPersistentStoreCoordinator alloc] initWithManagedObjectModel:model];
expect(persistentStoreCoordinator).notTo.beNil();
expect([persistentStoreCoordinator addPersistentStoreWithType:NSInMemoryStoreType configuration:nil URL:nil options:nil error:NULL]).notTo.beNil();
});
describe(@"with a confined context", ^{
__block NSManagedObjectContext *context;
__block NSEntityDescription *parentEntity;
__block NSEntityDescription *childEntity;
beforeEach(^{
context = [[NSManagedObjectContext alloc] initWithConcurrencyType:NSConfinementConcurrencyType];
expect(context).notTo.beNil();
context.undoManager = nil;
context.persistentStoreCoordinator = persistentStoreCoordinator;
parentEntity = [NSEntityDescription entityForName:@"Parent" inManagedObjectContext:context];
expect(parentEntity).notTo.beNil();
childEntity = [NSEntityDescription entityForName:@"Child" inManagedObjectContext:context];
expect(childEntity).notTo.beNil();
});
describe(@"+modelOfClass:fromManagedObject:error:", ^{
__block NSManagedObject *parent;
__block NSDate *date;
__block NSString *numberString;
__block NSString *requiredString;
beforeEach(^{
date = [NSDate date];
numberString = @"1234";
requiredString = @"foobar";
parent = [[NSManagedObject alloc] initWithEntity:parentEntity insertIntoManagedObjectContext:context];
expect(parent).notTo.beNil();
for (NSUInteger i = 0; i < 3; i++) {
NSManagedObject *child = [[NSManagedObject alloc] initWithEntity:childEntity insertIntoManagedObjectContext:context];
expect(child).notTo.beNil();
[child setValue:@(i) forKey:@"id"];
[[parent mutableOrderedSetValueForKey:@"orderedChildren"] addObject:child];
}
for (NSUInteger i = 3; i < 6; i++) {
NSManagedObject *child = [[NSManagedObject alloc] initWithEntity:childEntity insertIntoManagedObjectContext:context];
expect(child).notTo.beNil();
[child setValue:@(i) forKey:@"id"];
[[parent mutableSetValueForKey:@"unorderedChildren"] addObject:child];
}
[parent setValue:requiredString forKey:@"string"];
__block NSError *error = nil;
expect([context save:&error]).to.beTruthy();
expect(error).to.beNil();
// Make sure that pending changes are picked up too.
[parent setValue:@(numberString.integerValue) forKey:@"number"];
[parent setValue:date forKey:@"date"];
});
it(@"should initialize a MTLParentTestModel with children", ^{
NSError *error = nil;
MTLParentTestModel *parentModel = [MTLManagedObjectAdapter modelOfClass:MTLParentTestModel.class fromManagedObject:parent error:&error];
expect(parentModel).to.beKindOf(MTLParentTestModel.class);
expect(error).to.beNil();
expect(parentModel.date).to.equal(date);
expect(parentModel.numberString).to.equal(numberString);
expect(parentModel.requiredString).to.equal(requiredString);
expect(parentModel.orderedChildren.count).to.equal(3);
expect(parentModel.unorderedChildren.count).to.equal(3);
for (NSUInteger i = 0; i < 3; i++) {
MTLChildTestModel *child = parentModel.orderedChildren[i];
expect(child).to.beKindOf(MTLChildTestModel.class);
expect(child.childID).to.equal(i);
expect(child.parent1).to.beNil();
expect(child.parent2).to.beIdenticalTo(parentModel);
}
for (MTLChildTestModel *child in parentModel.unorderedChildren) {
expect(child).to.beKindOf(MTLChildTestModel.class);
expect(child.childID).to.beGreaterThanOrEqualTo(3);
expect(child.childID).to.beLessThan(6);
expect(child.parent1).to.beIdenticalTo(parentModel);
expect(child.parent2).to.beNil();
}
});
});
describe(@"+managedObjectFromModel:insertingIntoContext:error:", ^{
__block MTLParentTestModel *parentModel;
beforeEach(^{
parentModel = [MTLParentTestModel modelWithDictionary:@{
@"date": [NSDate date],
@"numberString": @"1234",
@"requiredString": @"foobar"
} error:NULL];
expect(parentModel).notTo.beNil();
NSMutableArray *orderedChildren = [NSMutableArray array];
NSMutableSet *unorderedChildren = [NSMutableSet set];
for (NSUInteger i = 0; i < 3; i++) {
MTLChildTestModel *child = [MTLChildTestModel modelWithDictionary:@{
@"childID": @(i),
@"parent2": parentModel
} error:NULL];
expect(child).notTo.beNil();
[orderedChildren addObject:child];
}
for (NSUInteger i = 3; i < 6; i++) {
MTLChildTestModel *child = [MTLChildTestModel modelWithDictionary:@{
@"childID": @(i),
@"parent1": parentModel
} error:NULL];
expect(child).notTo.beNil();
[unorderedChildren addObject:child];
}
parentModel.orderedChildren = orderedChildren;
parentModel.unorderedChildren = unorderedChildren;
});
it(@"should insert a managed object with children", ^{
__block NSError *error = nil;
NSManagedObject *parent = [MTLManagedObjectAdapter managedObjectFromModel:parentModel insertingIntoContext:context error:&error];
expect(parent).notTo.beNil();
expect(error).to.beNil();
expect(parent.entity).to.equal(parentEntity);
expect(context.insertedObjects).to.contain(parent);
expect([parent valueForKey:@"date"]).to.equal(parentModel.date);
expect([[parent valueForKey:@"number"] stringValue]).to.equal(parentModel.numberString);
expect([parent valueForKey:@"string"]).to.equal(parentModel.requiredString);
NSOrderedSet *orderedChildren = [parent valueForKey:@"orderedChildren"];
expect(orderedChildren).notTo.beNil();
expect(orderedChildren.count).to.equal(3);
NSSet *unorderedChildren = [parent valueForKey:@"unorderedChildren"];
expect(unorderedChildren).notTo.beNil();
expect(unorderedChildren.count).to.equal(3);
for (NSUInteger i = 0; i < 3; i++) {
NSManagedObject *child = orderedChildren[i];
expect(child.entity).to.equal(childEntity);
expect(context.insertedObjects).to.contain(child);
expect([[child valueForKey:@"id"] unsignedIntegerValue]).to.equal(i);
expect([child valueForKey:@"parent1"]).to.beNil();
expect([child valueForKey:@"parent2"]).to.equal(parent);
}
for (NSManagedObject *child in unorderedChildren) {
expect(child.entity).to.equal(childEntity);
expect(context.insertedObjects).to.contain(child);
NSUInteger childID = [[child valueForKey:@"id"] unsignedIntegerValue];
expect(childID).to.beGreaterThanOrEqualTo(3);
expect(childID).to.beLessThan(6);
expect([child valueForKey:@"parent1"]).to.equal(parent);
expect([child valueForKey:@"parent2"]).to.beNil();
}
expect([context save:&error]).to.beTruthy();
expect(error).to.beNil();
});
});
});
describe(@"with a main queue context", ^{
__block NSManagedObjectContext *context;
__block NSEntityDescription *parentEntity;
beforeEach(^{
context = [[NSManagedObjectContext alloc] initWithConcurrencyType:NSMainQueueConcurrencyType];
expect(context).notTo.beNil();
context.undoManager = nil;
context.persistentStoreCoordinator = persistentStoreCoordinator;
parentEntity = [NSEntityDescription entityForName:@"Parent" inManagedObjectContext:context];
expect(parentEntity).notTo.beNil();
});
it(@"should not deadlock on the main thread", ^{
NSManagedObject *parent = [[NSManagedObject alloc] initWithEntity:parentEntity insertIntoManagedObjectContext:context];
expect(parent).notTo.beNil();
[parent setValue:@"foobar" forKey:@"string"];
NSError *error = nil;
MTLParentTestModel *parentModel = [MTLManagedObjectAdapter modelOfClass:MTLParentTestModel.class fromManagedObject:parent error:&error];
expect(parentModel).to.beKindOf(MTLParentTestModel.class);
expect(error).to.beNil();
});
});
SpecEnd

86
MantleTests/MTLModelNSCodingSpec.m
View File

@ -6,39 +6,35 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "MTLTestModel.h"
QuickSpecBegin(MTLModelNSCoding)
SpecBegin(MTLModelNSCoding)
it(@"should have default encoding behaviors", ^{
NSDictionary *behaviors = MTLTestModel.encodingBehaviorsByPropertyKey;
expect(behaviors).notTo(beNil());
expect(behaviors).notTo.beNil();
expect(behaviors[@"name"]).to(equal(@(MTLModelEncodingBehaviorUnconditional)));
expect(behaviors[@"count"]).to(equal(@(MTLModelEncodingBehaviorUnconditional)));
expect(behaviors[@"weakModel"]).to(equal(@(MTLModelEncodingBehaviorConditional)));
expect(behaviors[@"dynamicName"]).to(beNil());
expect(behaviors[@"name"]).to.equal(@(MTLModelEncodingBehaviorUnconditional));
expect(behaviors[@"count"]).to.equal(@(MTLModelEncodingBehaviorUnconditional));
expect(behaviors[@"weakModel"]).to.equal(@(MTLModelEncodingBehaviorConditional));
expect(behaviors[@"dynamicName"]).to.beNil();
});
it(@"should have default allowed classes", ^{
NSDictionary *allowedClasses = MTLTestModel.allowedSecureCodingClassesByPropertyKey;
expect(allowedClasses).notTo(beNil());
expect(allowedClasses[@"name"]).to(equal(@[ NSString.class ]));
expect(allowedClasses[@"count"]).to(equal(@[ NSValue.class ]));
expect(allowedClasses[@"weakModel"]).to(equal(@[ MTLEmptyTestModel.class ]));
expect(allowedClasses).notTo.beNil();
expect(allowedClasses[@"name"]).to.equal(@[ NSString.class ]);
expect(allowedClasses[@"count"]).to.equal(@[ NSValue.class ]);
expect(allowedClasses[@"weakModel"]).to.equal(@[ MTLEmptyTestModel.class ]);
// Not encoded into archives.
expect(allowedClasses[@"nestedName"]).to(beNil());
expect(allowedClasses[@"dynamicName"]).to(beNil());
expect(allowedClasses[@"nestedName"]).to.beNil();
expect(allowedClasses[@"dynamicName"]).to.beNil();
});
it(@"should default to version 0", ^{
expect(@(MTLEmptyTestModel.modelVersion)).to(equal(@0));
expect(MTLEmptyTestModel.modelVersion).to.equal(0);
});
describe(@"archiving", ^{
@ -50,7 +46,7 @@ describe(@"archiving", ^{
beforeEach(^{
emptyModel = [[MTLEmptyTestModel alloc] init];
expect(emptyModel).notTo(beNil());
expect(emptyModel).notTo.beNil();
values = @{
@"name": @"foobar",
@ -59,77 +55,77 @@ describe(@"archiving", ^{
NSError *error = nil;
model = [[MTLTestModel alloc] initWithDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(model).notTo.beNil();
expect(error).to.beNil();
archiveAndUnarchiveModel = [^{
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:model];
expect(data).notTo(beNil());
expect(data).notTo.beNil();
MTLTestModel *unarchivedModel = [NSKeyedUnarchiver unarchiveObjectWithData:data];
expect(unarchivedModel).notTo(beNil());
expect(unarchivedModel).notTo.beNil();
return unarchivedModel;
} copy];
});
it(@"should archive unconditional properties", ^{
expect(archiveAndUnarchiveModel()).to(equal(model));
expect(archiveAndUnarchiveModel()).to.equal(model);
});
it(@"should not archive excluded properties", ^{
model.nestedName = @"foobar";
MTLTestModel *unarchivedModel = archiveAndUnarchiveModel();
expect(unarchivedModel.nestedName).to(beNil());
expect(unarchivedModel).notTo(equal(model));
expect(unarchivedModel.nestedName).to.beNil();
expect(unarchivedModel).notTo.equal(model);
model.nestedName = nil;
expect(unarchivedModel).to(equal(model));
expect(unarchivedModel).to.equal(model);
});
it(@"should not archive conditional properties if not encoded elsewhere", ^{
model.weakModel = emptyModel;
MTLTestModel *unarchivedModel = archiveAndUnarchiveModel();
expect(unarchivedModel.weakModel).to(beNil());
expect(unarchivedModel.weakModel).to.beNil();
});
it(@"should archive conditional properties if encoded elsewhere", ^{
model.weakModel = emptyModel;
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:@[ model, emptyModel ]];
expect(data).notTo(beNil());
expect(data).notTo.beNil();
NSArray *objects = [NSKeyedUnarchiver unarchiveObjectWithData:data];
expect(@(objects.count)).to(equal(@2));
expect(objects[1]).to(equal(emptyModel));
expect(objects.count).to.equal(2);
expect(objects[1]).to.equal(emptyModel);
MTLTestModel *unarchivedModel = objects[0];
expect(unarchivedModel).to(equal(model));
expect(unarchivedModel.weakModel).to(equal(emptyModel));
expect(unarchivedModel).to.equal(model);
expect(unarchivedModel.weakModel).to.equal(emptyModel);
});
it(@"should invoke custom decoding logic", ^{
MTLTestModel.modelVersion = 0;
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:model];
expect(data).notTo(beNil());
expect(data).notTo.beNil();
MTLTestModel.modelVersion = 1;
MTLTestModel *unarchivedModel = [NSKeyedUnarchiver unarchiveObjectWithData:data];
expect(unarchivedModel).notTo(beNil());
expect(unarchivedModel.name).to(equal(@"M: foobar"));
expect(@(unarchivedModel.count)).to(equal(@5));
expect(unarchivedModel).notTo.beNil();
expect(unarchivedModel.name).to.equal(@"M: foobar");
expect(unarchivedModel.count).to.equal(@5);
});
it(@"should unarchive an external representation from the old model format", ^{
NSURL *archiveURL = [[NSBundle bundleForClass:self.class] URLForResource:@"MTLTestModel-OldArchive" withExtension:@"plist"];
expect(archiveURL).notTo(beNil());
expect(archiveURL).notTo.beNil();
MTLTestModel *unarchivedModel = [NSKeyedUnarchiver unarchiveObjectWithFile:archiveURL.path];
expect(unarchivedModel).notTo(beNil());
expect(unarchivedModel).notTo.beNil();
NSDictionary *expectedValues = @{
@"name": @"foobar",
@ -137,9 +133,9 @@ describe(@"archiving", ^{
@"nestedName": @"fuzzbuzz",
@"weakModel": NSNull.null,
};
expect(unarchivedModel.dictionaryValue).to(equal(expectedValues));
expect(unarchivedModel.dictionaryValue).to.equal(expectedValues);
});
});
QuickSpecEnd
SpecEnd

151
MantleTests/MTLModelSpec.m
View File

@ -6,29 +6,25 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "MTLTestModel.h"
QuickSpecBegin(MTLModelSpec)
SpecBegin(MTLModel)
it(@"should not loop infinitely in +propertyKeys without any properties", ^{
expect(MTLEmptyTestModel.propertyKeys).to(equal([NSSet set]));
expect(MTLEmptyTestModel.propertyKeys).to.equal([NSSet set]);
});
it(@"should not include dynamic readonly properties in +propertyKeys", ^{
NSSet *expectedKeys = [NSSet setWithObjects:@"name", @"count", @"nestedName", @"weakModel", nil];
expect(MTLTestModel.propertyKeys).to(equal(expectedKeys));
expect(MTLTestModel.propertyKeys).to.equal(expectedKeys);
});
it(@"should initialize with default values", ^{
MTLTestModel *model = [[MTLTestModel alloc] init];
expect(model).notTo(beNil());
expect(model).notTo.beNil();
expect(model.name).to(beNil());
expect(@(model.count)).to(equal(@1));
expect(model.name).to.beNil();
expect(model.count).to.equal(1);
NSDictionary *expectedValues = @{
@"name": NSNull.null,
@ -37,18 +33,18 @@ it(@"should initialize with default values", ^{
@"weakModel": NSNull.null,
};
expect(model.dictionaryValue).to(equal(expectedValues));
expect([model dictionaryWithValuesForKeys:expectedValues.allKeys]).to(equal(expectedValues));
expect(model.dictionaryValue).to.equal(expectedValues);
expect([model dictionaryWithValuesForKeys:expectedValues.allKeys]).to.equal(expectedValues);
});
it(@"should initialize to default values with a nil dictionary", ^{
NSError *error = nil;
MTLTestModel *dictionaryModel = [[MTLTestModel alloc] initWithDictionary:nil error:&error];
expect(dictionaryModel).notTo(beNil());
expect(error).to(beNil());
expect(dictionaryModel).notTo.beNil();
expect(error).to.beNil();
MTLTestModel *defaultModel = [[MTLTestModel alloc] init];
expect(dictionaryModel).to(equal(defaultModel));
expect(dictionaryModel).to.equal(defaultModel);
});
describe(@"with a dictionary of values", ^{
@ -58,7 +54,7 @@ describe(@"with a dictionary of values", ^{
beforeEach(^{
emptyModel = [[MTLEmptyTestModel alloc] init];
expect(emptyModel).notTo(beNil());
expect(emptyModel).notTo.beNil();
values = @{
@"name": @"foobar",
@ -69,136 +65,63 @@ describe(@"with a dictionary of values", ^{
NSError *error = nil;
model = [[MTLTestModel alloc] initWithDictionary:values error:&error];
expect(model).notTo(beNil());
expect(error).to(beNil());
expect(model).notTo.beNil();
expect(error).to.beNil();
});
it(@"should initialize with the given values", ^{
expect(model.name).to(equal(@"foobar"));
expect(@(model.count)).to(equal(@5));
expect(model.nestedName).to(equal(@"fuzzbuzz"));
expect(model.weakModel).to(equal(emptyModel));
expect(model.name).to.equal(@"foobar");
expect(model.count).to.equal(5);
expect(model.nestedName).to.equal(@"fuzzbuzz");
expect(model.weakModel).to.equal(emptyModel);
expect(model.dictionaryValue).to(equal(values));
expect([model dictionaryWithValuesForKeys:values.allKeys]).to(equal(values));
expect(model.dictionaryValue).to.equal(values);
expect([model dictionaryWithValuesForKeys:values.allKeys]).to.equal(values);
});
it(@"should compare equal to a matching model", ^{
expect(model).to(equal(model));
expect(model).to.equal(model);
MTLTestModel *matchingModel = [[MTLTestModel alloc] initWithDictionary:values error:NULL];
expect(model).to(equal(matchingModel));
expect(@(model.hash)).to(equal(@(matchingModel.hash)));
expect(model.dictionaryValue).to(equal(matchingModel.dictionaryValue));
expect(model).to.equal(matchingModel);
expect(model.hash).to.equal(matchingModel.hash);
expect(model.dictionaryValue).to.equal(matchingModel.dictionaryValue);
});
it(@"should not compare equal to different model", ^{
MTLTestModel *differentModel = [[MTLTestModel alloc] init];
expect(model).notTo(equal(differentModel));
expect(model.dictionaryValue).notTo(equal(differentModel.dictionaryValue));
expect(model).notTo.equal(differentModel);
expect(model.dictionaryValue).notTo.equal(differentModel.dictionaryValue);
});
it(@"should implement <NSCopying>", ^{
MTLTestModel *copiedModel = [model copy];
expect(copiedModel).to(equal(model));
expect(copiedModel).notTo(beIdenticalTo(model));
});
it(@"should not consider -weakModel for equality", ^{
MTLTestModel *copiedModel = [model copy];
copiedModel.weakModel = nil;
expect(model).to(equal(copiedModel));
expect(copiedModel).to.equal(model);
expect(copiedModel).notTo.beIdenticalTo(model);
});
});
it(@"should fail to initialize if dictionary validation fails", ^{
NSError *error = nil;
MTLTestModel *model = [[MTLTestModel alloc] initWithDictionary:@{ @"name": @"this is too long a name" } error:&error];
expect(model).to(beNil());
expect(model).to.beNil();
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTestModelErrorDomain));
expect(@(error.code)).to(equal(@(MTLTestModelNameTooLong)));
expect(error).notTo.beNil();
expect(error.domain).to.equal(MTLTestModelErrorDomain);
expect(error.code).to.equal(MTLTestModelNameTooLong);
});
it(@"should merge two models together", ^{
MTLTestModel *target = [[MTLTestModel alloc] initWithDictionary:@{ @"name": @"foo", @"count": @(5) } error:NULL];
expect(target).notTo(beNil());
expect(target).notTo.beNil();
MTLTestModel *source = [[MTLTestModel alloc] initWithDictionary:@{ @"name": @"bar", @"count": @(3) } error:NULL];
expect(source).notTo(beNil());
expect(source).notTo.beNil();
[target mergeValuesForKeysFromModel:source];
expect(target.name).to(equal(@"bar"));
expect(@(target.count)).to(equal(@8));
expect(target.name).to.equal(@"bar");
expect(target.count).to.equal(8);
});
it(@"should consider primitive properties permanent", ^{
expect(@([MTLStorageBehaviorModel storageBehaviorForPropertyWithKey:@"primitive"])).to(equal(@(MTLPropertyStoragePermanent)));
});
it(@"should consider object-type assign properties permanent", ^{
expect(@([MTLStorageBehaviorModel storageBehaviorForPropertyWithKey:@"assignProperty"])).to(equal(@(MTLPropertyStoragePermanent)));
});
it(@"should consider object-type strong properties permanent", ^{
expect(@([MTLStorageBehaviorModel storageBehaviorForPropertyWithKey:@"strongProperty"])).to(equal(@(MTLPropertyStoragePermanent)));
});
it(@"should ignore readonly properties without backing ivar", ^{
expect(@([MTLStorageBehaviorModel storageBehaviorForPropertyWithKey:@"notIvarBacked"])).to(equal(@(MTLPropertyStorageNone)));
});
it(@"should consider properties declared in subclass with storage in superclass permanent", ^{
expect(@([MTLStorageBehaviorModelSubclass storageBehaviorForPropertyWithKey:@"shadowedInSubclass"])).to(equal(@(MTLPropertyStoragePermanent)));
expect(@([MTLStorageBehaviorModelSubclass storageBehaviorForPropertyWithKey:@"declaredInProtocol"])).to(equal(@(MTLPropertyStoragePermanent)));
});
it(@"should ignore optional protocol properties not implemented", ^{
expect(@([MTLOptionalPropertyModel storageBehaviorForPropertyWithKey:@"optionalUnimplementedProperty"])).to(equal(@(MTLPropertyStorageNone)));
expect(@([MTLOptionalPropertyModel storageBehaviorForPropertyWithKey:@"optionalImplementedProperty"])).to(equal(@(MTLPropertyStoragePermanent)));
});
describe(@"merging with model subclasses", ^{
__block MTLTestModel *superclass;
__block MTLSubclassTestModel *subclass;
beforeEach(^{
superclass = [MTLTestModel modelWithDictionary:@{
@"name": @"foo",
@"count": @5
} error:NULL];
expect(superclass).notTo(beNil());
subclass = [MTLSubclassTestModel modelWithDictionary:@{
@"name": @"bar",
@"count": @3,
@"generation": @1,
@"role": @"subclass"
} error:NULL];
expect(subclass).notTo(beNil());
});
it(@"should merge from subclass model", ^{
[superclass mergeValuesForKeysFromModel:subclass];
expect(superclass.name).to(equal(@"bar"));
expect(@(superclass.count)).to(equal(@8));
});
it(@"should merge from superclass model", ^{
[subclass mergeValuesForKeysFromModel:superclass];
expect(subclass.name).to(equal(@"foo"));
expect(@(subclass.count)).to(equal(@8));
expect(subclass.generation).to(equal(@1));
expect(subclass.role).to(equal(@"subclass"));
});
});
QuickSpecEnd
SpecEnd

26
MantleTests/MTLModelValidationSpec.m
View File

@ -6,26 +6,22 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "MTLTestModel.h"
#import "MTLModel.h"
QuickSpecBegin(MTLModelValidation)
SpecBegin(MTLModelValidation)
it(@"should fail with incorrect values", ^{
MTLValidationModel *model = [[MTLValidationModel alloc] init];
NSError *error = nil;
BOOL success = [model validate:&error];
expect(@(success)).to(beFalsy());
expect(success).to.beFalsy();
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTestModelErrorDomain));
expect(@(error.code)).to(equal(@(MTLTestModelNameMissing)));
expect(error).notTo.beNil();
expect(error.domain).to.equal(MTLTestModelErrorDomain);
expect(error.code).to.equal(MTLTestModelNameMissing);
});
it(@"should succeed with correct values", ^{
@ -33,9 +29,9 @@ it(@"should succeed with correct values", ^{
NSError *error = nil;
BOOL success = [model validate:&error];
expect(@(success)).to(beTruthy());
expect(success).to.beTruthy();
expect(error).to(beNil());
expect(error).to.beNil();
});
it(@"should apply values returned from -validateValue:error:", ^{
@ -43,11 +39,11 @@ it(@"should apply values returned from -validateValue:error:", ^{
NSError *error = nil;
BOOL success = [model validate:&error];
expect(@(success)).to(beTruthy());
expect(success).to.beTruthy();
expect(model.name).to(equal(@"foobar"));
expect(model.name).to.equal(@"foobar");
expect(error).to(beNil());
expect(error).to.beNil();
});
QuickSpecEnd
SpecEnd

343
MantleTests/MTLPredefinedTransformerAdditionsSpec.m
View File

@ -6,299 +6,108 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
#import "MTLTransformerErrorExamples.h"
#import "MTLTestModel.h"
enum : NSInteger {
MTLPredefinedTransformerAdditionsSpecEnumNegative = -1,
MTLPredefinedTransformerAdditionsSpecEnumZero = 0,
MTLPredefinedTransformerAdditionsSpecEnumPositive = 1,
MTLPredefinedTransformerAdditionsSpecEnumDefault = 42,
} MTLPredefinedTransformerAdditionsSpecEnum;
SpecBegin(MTLPredefinedTransformerAdditions)
QuickSpecBegin(MTLPredefinedTransformerAdditions)
it(@"should define a URL value transformer", ^{
NSValueTransformer *transformer = [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
expect(transformer).notTo.beNil();
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
describe(@"The URL transformer", ^{
__block NSValueTransformer *transformer;
NSString *URLString = @"http://www.github.com/";
expect([transformer transformedValue:URLString]).to.equal([NSURL URLWithString:URLString]);
expect([transformer reverseTransformedValue:[NSURL URLWithString:URLString]]).to.equal(URLString);
beforeEach(^{
transformer = [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
});
it(@"should convert NSStrings to NSURLs and back", ^{
NSString *URLString = @"http://www.github.com/";
expect([transformer transformedValue:URLString]).to(equal([NSURL URLWithString:URLString]));
expect([transformer reverseTransformedValue:[NSURL URLWithString:URLString]]).to(equal(URLString));
expect([transformer transformedValue:nil]).to(beNil());
expect([transformer reverseTransformedValue:nil]).to(beNil());
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: @"not a valid URL",
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
expect([transformer transformedValue:nil]).to.beNil();
expect([transformer reverseTransformedValue:nil]).to.beNil();
});
describe(@"The UUID transformer", ^{
__block NSValueTransformer *transformer;
it(@"should define an NSNumber boolean value transformer", ^{
// Back these NSNumbers with ints, rather than booleans,
// to ensure that the value transformers are actually transforming.
NSNumber *booleanYES = @(1);
NSNumber *booleanNO = @(0);
NSValueTransformer *transformer = [NSValueTransformer valueTransformerForName:MTLBooleanValueTransformerName];
expect(transformer).notTo.beNil();
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
expect([transformer transformedValue:booleanYES]).to.equal([NSNumber numberWithBool:YES]);
expect([transformer transformedValue:booleanYES]).to.equal((id)kCFBooleanTrue);
expect([transformer reverseTransformedValue:booleanYES]).to.equal([NSNumber numberWithBool:YES]);
expect([transformer reverseTransformedValue:booleanYES]).to.equal((id)kCFBooleanTrue);
expect([transformer transformedValue:booleanNO]).to.equal([NSNumber numberWithBool:NO]);
expect([transformer transformedValue:booleanNO]).to.equal((id)kCFBooleanFalse);
expect([transformer reverseTransformedValue:booleanNO]).to.equal([NSNumber numberWithBool:NO]);
expect([transformer reverseTransformedValue:booleanNO]).to.equal((id)kCFBooleanFalse);
expect([transformer transformedValue:nil]).to.beNil();
expect([transformer reverseTransformedValue:nil]).to.beNil();
});
describe(@"JSON transformers", ^{
__block NSArray *models;
__block NSArray *JSONDictionaries;
beforeEach(^{
transformer = [NSValueTransformer valueTransformerForName:MTLUUIDValueTransformerName];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
});
it(@"should convert NSStrings to NSUUIDs and back", ^{
NSString *UUIDString = @"4A275FBD-8217-4397-964B-403F4C2B8545";
expect([transformer transformedValue:UUIDString]).to(equal([[NSUUID alloc] initWithUUIDString:UUIDString]));
expect([transformer reverseTransformedValue:[[NSUUID alloc] initWithUUIDString:UUIDString]]).to(equal(UUIDString));
expect([transformer transformedValue:nil]).to(beNil());
expect([transformer reverseTransformedValue:nil]).to(beNil());
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: @"not a valid UUID",
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
NSMutableArray *uniqueModels = [NSMutableArray array];
NSMutableArray *mutableDictionaries = [NSMutableArray array];
describe(@"The number transformer", ^{
__block NSValueTransformer *transformer;
for (NSUInteger i = 0; i < 10; i++) {
MTLTestModel *model = [[MTLTestModel alloc] init];
model.count = i;
beforeEach(^{
transformer = [NSValueTransformer valueTransformerForName:MTLBooleanValueTransformerName];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
[uniqueModels addObject:model];
NSDictionary *dict = [MTLJSONAdapter JSONDictionaryFromModel:model];
expect(dict).notTo.beNil();
[mutableDictionaries addObject:dict];
}
models = [uniqueModels copy];
JSONDictionaries = [mutableDictionaries copy];
});
it(@"it convert int- to boolean-backed NSNumbers and back", ^{
// Back these NSNumbers with ints, rather than booleans,
// to ensure that the value transformers are actually transforming.
NSNumber *booleanYES = @(1);
NSNumber *booleanNO = @(0);
describe(@"dictionary transformer", ^{
__block NSValueTransformer *transformer;
expect([transformer transformedValue:booleanYES]).to(equal([NSNumber numberWithBool:YES]));
expect([transformer transformedValue:booleanYES]).to(beIdenticalTo((id)kCFBooleanTrue));
expect([transformer reverseTransformedValue:booleanYES]).to(equal([NSNumber numberWithBool:YES]));
expect([transformer reverseTransformedValue:booleanYES]).to(beIdenticalTo((id)kCFBooleanTrue));
expect([transformer transformedValue:booleanNO]).to(equal([NSNumber numberWithBool:NO]));
expect([transformer transformedValue:booleanNO]).to(beIdenticalTo((id)kCFBooleanFalse));
expect([transformer reverseTransformedValue:booleanNO]).to(equal([NSNumber numberWithBool:NO]));
expect([transformer reverseTransformedValue:booleanNO]).to(beIdenticalTo((id)kCFBooleanFalse));
expect([transformer transformedValue:nil]).to(beNil());
expect([transformer reverseTransformedValue:nil]).to(beNil());
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
describe(@"+mtl_arrayMappingTransformerWithTransformer:", ^{
__block NSValueTransformer *transformer;
NSArray *URLStrings = @[
@"https://github.com/",
@"https://github.com/MantleFramework",
@"http://apple.com"
];
NSArray *URLs = @[
[NSURL URLWithString:@"https://github.com/"],
[NSURL URLWithString:@"https://github.com/MantleFramework"],
[NSURL URLWithString:@"http://apple.com"]
];
describe(@"when called with a reversible transformer", ^{
beforeEach(^{
NSValueTransformer *appliedTransformer = [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
transformer = [NSValueTransformer mtl_arrayMappingTransformerWithTransformer:appliedTransformer];
expect(transformer).notTo(beNil());
before(^{
transformer = [NSValueTransformer mtl_JSONDictionaryTransformerWithModelClass:MTLTestModel.class];
expect(transformer).notTo.beNil();
});
it(@"should allow reverse transformation", ^{
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
it(@"should transform a JSON dictionary into a model", ^{
expect([transformer transformedValue:JSONDictionaries.lastObject]).to.equal(models.lastObject);
});
it(@"should apply the transformer to each element", ^{
expect([transformer transformedValue:URLStrings]).to(equal(URLs));
});
it(@"should apply the transformer to each element in reverse", ^{
expect([transformer reverseTransformedValue:URLs]).to(equal(URLStrings));
it(@"should transform a model into a JSON dictionary", ^{
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
expect([transformer reverseTransformedValue:models.lastObject]).to.equal(JSONDictionaries.lastObject);
});
});
describe(@"when called with a non-reversible transformer", ^{
beforeEach(^{
NSValueTransformer *appliedTransformer = [MTLValueTransformer transformerUsingForwardBlock:^(NSString *str, BOOL *success, NSError **error) {
return [NSURL URLWithString:str];
}];
transformer = [NSValueTransformer mtl_arrayMappingTransformerWithTransformer:appliedTransformer];
expect(transformer).notTo(beNil());
describe(@"external representation array transformer", ^{
__block NSValueTransformer *transformer;
before(^{
transformer = [NSValueTransformer mtl_JSONArrayTransformerWithModelClass:MTLTestModel.class];
expect(transformer).notTo.beNil();
});
it(@"should not allow reverse transformation", ^{
expect(@([transformer.class allowsReverseTransformation])).to(beFalsy());
it(@"should transform JSON dictionaries into models", ^{
expect([transformer transformedValue:JSONDictionaries]).to.equal(models);
});
it(@"should apply the transformer to each element", ^{
expect([transformer transformedValue:URLStrings]).to(equal(URLs));
});
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
describe(@"value mapping transformer", ^{
__block NSValueTransformer *transformer;
NSDictionary *dictionary = @{
@"negative": @(MTLPredefinedTransformerAdditionsSpecEnumNegative),
@[ @"zero" ]: @(MTLPredefinedTransformerAdditionsSpecEnumZero),
@"positive": @(MTLPredefinedTransformerAdditionsSpecEnumPositive),
};
beforeEach(^{
transformer = [NSValueTransformer mtl_valueMappingTransformerWithDictionary:dictionary];
});
it(@"should transform enum values into strings", ^{
expect([transformer transformedValue:@"negative"]).to(equal(@(MTLPredefinedTransformerAdditionsSpecEnumNegative)));
expect([transformer transformedValue:@[ @"zero" ]]).to(equal(@(MTLPredefinedTransformerAdditionsSpecEnumZero)));
expect([transformer transformedValue:@"positive"]).to(equal(@(MTLPredefinedTransformerAdditionsSpecEnumPositive)));
});
it(@"should transform strings into enum values", ^{
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect([transformer reverseTransformedValue:@(MTLPredefinedTransformerAdditionsSpecEnumNegative)]).to(equal(@"negative"));
expect([transformer reverseTransformedValue:@(MTLPredefinedTransformerAdditionsSpecEnumZero)]).to(equal(@[ @"zero" ]));
expect([transformer reverseTransformedValue:@(MTLPredefinedTransformerAdditionsSpecEnumPositive)]).to(equal(@"positive"));
});
describe(@"default values", ^{
beforeEach(^{
transformer = [NSValueTransformer mtl_valueMappingTransformerWithDictionary:dictionary defaultValue:@(MTLPredefinedTransformerAdditionsSpecEnumDefault) reverseDefaultValue:@"default"];
});
it(@"should transform unknown strings into the default enum value", ^{
expect([transformer transformedValue:@"unknown"]).to(equal(@(MTLPredefinedTransformerAdditionsSpecEnumDefault)));
});
it(@"should transform the default enum value into the default string", ^{
expect([transformer reverseTransformedValue:@(MTLPredefinedTransformerAdditionsSpecEnumDefault)]).to(equal(@"default"));
it(@"should transform models into JSON dictionaries", ^{
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
expect([transformer reverseTransformedValue:models]).to.equal(JSONDictionaries);
});
});
});
describe(@"date format transformer", ^{
__block NSValueTransformer<MTLTransformerErrorHandling> *transformer;
beforeEach(^{
transformer = [NSValueTransformer mtl_dateTransformerWithDateFormat:@"MMMM d, yyyy" calendar:[NSCalendar calendarWithIdentifier:NSCalendarIdentifierGregorian] locale:[NSLocale localeWithLocaleIdentifier:@"en_US"] timeZone:[NSTimeZone timeZoneWithName:@"America/Los_Angeles"] defaultDate:nil];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect([transformer transformedValue:nil]).to(beNil());
expect([transformer reverseTransformedValue:nil]).to(beNil());
});
it(@"should transform strings into dates", ^{
expect([transformer transformedValue:@"September 25, 2015"]).to(equal([NSDate dateWithTimeIntervalSince1970:1443164400]));
});
it(@"should transform dates into strings", ^{
expect([transformer reverseTransformedValue:[NSDate dateWithTimeIntervalSince1970:1183135260]]).to(equal(@"June 29, 2007"));
});
it(@"should surface date formatter error descriptions", ^{
__block NSError *error;
__block BOOL success = NO;
expect([transformer transformedValue:@"September 37, 2015" success:&success error:&error]).to(beNil());
expect(@(success)).to(beFalsy());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[NSLocalizedFailureReasonErrorKey]).notTo(beNil());
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
describe(@"number format transformer", ^{
__block NSValueTransformer<MTLTransformerErrorHandling> *transformer;
beforeEach(^{
transformer = [NSValueTransformer mtl_numberTransformerWithNumberStyle:NSNumberFormatterDecimalStyle locale:[NSLocale localeWithLocaleIdentifier:@"en_US"]];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect([transformer transformedValue:nil]).to(beNil());
expect([transformer reverseTransformedValue:nil]).to(beNil());
});
it(@"should transform strings into numbers", ^{
expect([transformer transformedValue:@"0.12345"]).to(equal(@0.12345));
});
it(@"should transform numbers into strings", ^{
expect([transformer reverseTransformedValue:@12345.678]).to(equal(@"12,345.678"));
});
it(@"should surface number formatter error descriptions", ^{
__block NSError *error;
__block BOOL success = NO;
expect([transformer transformedValue:@"Apple" success:&success error:&error]).to(beNil());
expect(@(success)).to(beFalsy());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[NSLocalizedFailureReasonErrorKey]).notTo(beNil());
});
itBehavesLike(MTLTransformerErrorExamples, ^{
return @{
MTLTransformerErrorExamplesTransformer: transformer,
MTLTransformerErrorExamplesInvalidTransformationInput: NSNull.null,
MTLTransformerErrorExamplesInvalidReverseTransformationInput: NSNull.null
};
});
});
QuickSpecEnd
SpecEnd

17
MantleTests/MTLTestJSONAdapter.h
View File

@ -1,17 +0,0 @@
//
// MTLTestJSONAdapter.h
// Mantle
//
// Created by Robert Böhnke on 03/04/14.
// Copyright (c) 2014 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
// Adds a custom key "test" to constructed JSON.
@interface MTLTestJSONAdapter : MTLJSONAdapter
// These property keys are not serialized.
@property (readwrite, nonatomic, strong) NSSet *ignoredPropertyKeys;
@end

28
MantleTests/MTLTestJSONAdapter.m
View File

@ -1,28 +0,0 @@
//
// MTLTestJSONAdapter.m
// Mantle
//
// Created by Robert Böhnke on 03/04/14.
// Copyright (c) 2014 GitHub. All rights reserved.
//
#import "MTLTestJSONAdapter.h"
@implementation MTLTestJSONAdapter
- (NSSet *)serializablePropertyKeys:(NSSet *)propertyKeys forModel:(id<MTLJSONSerializing>)model {
NSMutableSet *copy = [propertyKeys mutableCopy];
[copy minusSet:self.ignoredPropertyKeys];
return copy;
}
- (NSDictionary *)JSONDictionaryFromModel:(id<MTLJSONSerializing>)model error:(NSError **)error {
NSDictionary *dictionary = [super JSONDictionaryFromModel:model error:error];
return [dictionary mtl_dictionaryByAddingEntriesFromDictionary:@{
@"test": @YES
}];
}
@end

176
MantleTests/MTLTestModel.h
View File

@ -6,14 +6,10 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
extern NSString * const MTLTestModelErrorDomain;
extern const NSInteger MTLTestModelNameTooLong;
extern const NSInteger MTLTestModelNameMissing;
@interface MTLEmptyTestModel : MTLModel
@end
@ -40,31 +36,16 @@ extern const NSInteger MTLTestModelNameMissing;
// Should not be stored in the dictionary value or JSON.
@property (nonatomic, copy, readonly) NSString *dynamicName;
// Should not be stored in JSON, has MTLPropertyStorageTransitory.
// Should not be stored in JSON.
@property (nonatomic, weak) MTLEmptyTestModel *weakModel;
@end
@interface MTLSubclassTestModel : MTLTestModel
// Properties to test merging between subclass and superclass
@property (nonatomic, copy) NSString *role;
@property (nonatomic, copy) NSNumber *generation;
@end
@interface MTLArrayTestModel : MTLModel <MTLJSONSerializing>
// This property is associated with a "users.username" key in JSON.
@property (nonatomic, copy) NSString *names;
@end
// Parses MTLTestModel objects from JSON instead.
@interface MTLSubstitutingTestModel : MTLModel <MTLJSONSerializing>
@end
@interface MTLValidationModel : MTLModel <MTLJSONSerializing>
@interface MTLValidationModel : MTLModel
// Defaults to nil, which is not considered valid.
@property (nonatomic, copy) NSString *name;
@ -74,156 +55,3 @@ extern const NSInteger MTLTestModelNameMissing;
// Returns a default name of 'foobar' when validateName:error: is invoked
@interface MTLSelfValidatingModel : MTLValidationModel
@end
@interface MTLURLModel : MTLModel <MTLJSONSerializing>
// Defaults to http://github.com.
@property (nonatomic, strong) NSURL *URL;
@end
@interface MTLURLSubclassModel : MTLURLModel
// Defaults to http://github.com/Mantle/Mantle.
@property (nonatomic, strong) NSURL *otherURL;
@end
@interface MTLUUIDModel : MTLModel <MTLJSONSerializing>
// Defaults to 4A275FBD-8217-4397-964B-403F4C2B8545
@property (nonatomic, strong) NSUUID *UUID;
@end
@interface MTLUUIDSubclassModel : MTLUUIDModel
// Defaults to 593246D2-A290-43D5-9070-A299A489AE29
@property (nonatomic, strong) NSUUID *otherUUID;
@end
// Conforms to MTLJSONSerializing but does not inherit from the MTLModel class.
@interface MTLConformingModel : NSObject <MTLJSONSerializing>
@property (nonatomic, copy) NSString *name;
@end
@interface MTLStorageBehaviorModel : MTLModel
@property (readonly, nonatomic, assign) BOOL primitive;
@property (readonly, nonatomic, assign) id assignProperty;
@property (readonly, nonatomic, weak) id weakProperty;
@property (readonly, nonatomic, strong) id strongProperty;
@property (readonly, nonatomic, strong) id shadowedInSubclass;
@property (readonly, nonatomic, strong) id declaredInProtocol;
@end
@protocol MTLDateProtocol <NSObject>
@property (readonly, nonatomic, strong) id declaredInProtocol;
@end
@interface MTLStorageBehaviorModelSubclass : MTLStorageBehaviorModel <MTLDateProtocol>
@property (readonly, nonatomic, strong) id shadowedInSubclass;
@end
@interface MTLBoolModel : MTLModel <MTLJSONSerializing>
@property (nonatomic, assign) BOOL flag;
@end
@interface MTLStringModel : MTLModel <MTLJSONSerializing>
@property (readwrite, nonatomic, copy) NSString *string;
@end
@interface MTLIDModel : MTLModel <MTLJSONSerializing>
@property (nonatomic, strong) id anyObject;
@end
@interface MTLNonPropertyModel : MTLModel <MTLJSONSerializing>
- (NSURL *)homepage;
@end
@interface MTLMultiKeypathModel : MTLModel <MTLJSONSerializing>
// This property is associated with the "location" and "length" keys in JSON.
@property (readonly, nonatomic, assign) NSRange range;
// This property is associated with the "nested.location" and "nested.length"
// keys in JSON.
@property (readonly, nonatomic, assign) NSRange nestedRange;
@end
@interface MTLClassClusterModel : MTLModel <MTLJSONSerializing>
@property (readonly, nonatomic, copy) NSString *flavor;
@end
@interface MTLChocolateClassClusterModel : MTLClassClusterModel
// Associated with the "chocolate_bitterness" JSON key and transformed to a
// string.
@property (readwrite, nonatomic, assign) NSUInteger bitterness;
@end
@interface MTLStrawberryClassClusterModel : MTLClassClusterModel
// Associated with the "strawberry_freshness" JSON key.
@property (readwrite, nonatomic, assign) NSUInteger freshness;
@end
@protocol MTLOptionalPropertyProtocol
@optional
@property (readwrite, nonatomic, strong) id optionalUnimplementedProperty;
@property (readwrite, nonatomic, strong) id optionalImplementedProperty;
@end
@interface MTLOptionalPropertyModel : MTLModel <MTLOptionalPropertyProtocol>
@property (readwrite, nonatomic, strong) id optionalImplementedProperty;
@end
@interface MTLRecursiveUserModel : MTLModel <MTLJSONSerializing>
@property (nonatomic, copy, readonly) NSString *name;
@property (nonatomic, copy, readonly) NSArray *groups;
@end
@interface MTLRecursiveGroupModel : MTLModel <MTLJSONSerializing>
@property (nonatomic, readonly) MTLRecursiveUserModel *owner;
@property (nonatomic, readonly) NSArray *users;
@end
@interface MTLPropertyDefaultAdapterModel : MTLModel<MTLJSONSerializing>
@property (readwrite, nonatomic, strong) MTLEmptyTestModel *nonConformingMTLJSONSerializingProperty;
@property (readwrite, nonatomic, strong) MTLTestModel *conformingMTLJSONSerializingProperty;
@property (readwrite, nonatomic, strong) NSString *property;
@end

424
MantleTests/MTLTestModel.m
View File

@ -6,10 +6,7 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import "NSDictionary+MTLManipulationAdditions.h"
#import "MTLTestModel.h"
#import "NSDictionary+MTLMappingAdditions.h"
NSString * const MTLTestModelErrorDomain = @"MTLTestModelErrorDomain";
const NSInteger MTLTestModelNameTooLong = 1;
@ -60,23 +57,19 @@ static NSUInteger modelVersion = 1;
#pragma mark MTLJSONSerializing
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
NSMutableDictionary *mapping = [[NSDictionary mtl_identityPropertyMapWithModel:self] mutableCopy];
[mapping removeObjectForKey:@"weakModel"];
[mapping addEntriesFromDictionary:@{
return @{
@"name": @"username",
@"nestedName": @"nested.name"
}];
return mapping;
@"nestedName": @"nested.name",
@"weakModel": NSNull.null,
};
}
+ (NSValueTransformer *)countJSONTransformer {
return [MTLValueTransformer
transformerUsingForwardBlock:^(NSString *str, BOOL *success, NSError **error) {
reversibleTransformerWithForwardBlock:^(NSString *str) {
return @(str.integerValue);
}
reverseBlock:^(NSNumber *num, BOOL *success, NSError **error) {
reverseBlock:^(NSNumber *num) {
return num.stringValue;
}];
}
@ -119,16 +112,6 @@ static NSUInteger modelVersion = 1;
};
}
#pragma mark Property Storage Behavior
+ (MTLPropertyStorage)storageBehaviorForPropertyWithKey:(NSString *)propertyKey {
if ([propertyKey isEqual:@"weakModel"]) {
return MTLPropertyStorageTransitory;
} else {
return [super storageBehaviorForPropertyWithKey:propertyKey];
}
}
#pragma mark Merging
- (void)mergeCountFromModel:(MTLTestModel *)model {
@ -137,23 +120,10 @@ static NSUInteger modelVersion = 1;
@end
@implementation MTLSubclassTestModel
@end
@implementation MTLArrayTestModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"names": @"users.name"
};
}
@end
@implementation MTLSubstitutingTestModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
return @{};
}
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary {
@ -170,12 +140,6 @@ static NSUInteger modelVersion = 1;
@implementation MTLValidationModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"name": @"name"
};
}
- (BOOL)validateName:(NSString **)name error:(NSError **)error {
if (*name != nil) return YES;
if (error != NULL) {
@ -198,377 +162,3 @@ static NSUInteger modelVersion = 1;
}
@end
@implementation MTLURLModel
- (instancetype)init {
self = [super init];
if (self == nil) return nil;
self.URL = [NSURL URLWithString:@"http://github.com"];
return self;
}
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
}
@end
@implementation MTLURLSubclassModel
- (instancetype)init {
self = [super init];
if (self == nil) return nil;
self.otherURL = [NSURL URLWithString:@"http://github.com/Mantle/Mantle"];
return self;
}
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key {
return @{
// Not provided transformer for self.URL
@"otherURL": [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName],
}[key];
}
@end
@implementation MTLUUIDModel
- (instancetype)init {
self = [super init];
if (self == nil) return nil;
self.UUID = [[NSUUID alloc] initWithUUIDString:@"4A275FBD-8217-4397-964B-403F4C2B8545"];
return self;
}
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
}
@end
@implementation MTLUUIDSubclassModel
- (instancetype)init {
self = [super init];
if (self == nil) return nil;
self.otherUUID = [[NSUUID alloc] initWithUUIDString:@"593246D2-A290-43D5-9070-A299A489AE29"];
return self;
}
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key {
return @{
// Not provided transformer for self.UUID
@"otherUUID": [NSValueTransformer valueTransformerForName:MTLUUIDValueTransformerName],
}[key];
}
@end
@implementation MTLBoolModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
}
@end
@implementation MTLStringModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
}
@end
@implementation MTLIDModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [NSDictionary mtl_identityPropertyMapWithModel:self];
}
@end
@implementation MTLNonPropertyModel
+ (NSSet *)propertyKeys {
return [NSSet setWithObject:@"homepage"];
}
- (NSURL *)homepage {
return [NSURL URLWithString:@"about:blank"];
}
+ (MTLPropertyStorage)storageBehaviorForPropertyWithKey:(NSString *)propertyKey {
if ([propertyKey isEqual:@"homepage"]) {
return MTLPropertyStoragePermanent;
}
return [super storageBehaviorForPropertyWithKey:propertyKey];
}
#pragma mark - MTLJSONSerializing
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"homepage": @"homepage"
};
}
@end
@interface MTLConformingModel ()
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error;
@end
@implementation MTLConformingModel
#pragma mark Lifecycle
+ (instancetype)modelWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error {
return [[self alloc] initWithDictionary:dictionaryValue error:error];
}
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error {
self = [super init];
if (self == nil) return nil;
_name = dictionaryValue[@"name"];
return self;
}
- (BOOL)validate:(NSError **)error {
return YES;
}
#pragma mark MTLModel
- (NSDictionary *)dictionaryValue {
if (self.name == nil) return @{};
return @{
@"name": self.name
};
}
+ (NSSet *)propertyKeys {
return [NSSet setWithObject:@"name"];
}
- (void)mergeValueForKey:(NSString *)key fromModel:(id<MTLModel>)model {
if ([key isEqualToString:@"name"]) {
self.name = [model dictionaryValue][@"name"];
}
}
- (void)mergeValuesForKeysFromModel:(id<MTLModel>)model {
self.name = [model dictionaryValue][@"name"];
}
#pragma mark MTLJSONSerializing
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"name": @"name"
};
}
#pragma mark NSObject
- (NSUInteger)hash {
return self.name.hash;
}
- (BOOL)isEqual:(MTLConformingModel *)model {
if (self == model) return YES;
if (![model isMemberOfClass:self.class]) return NO;
return self.name == model.name || [self.name isEqual:model.name];
}
#pragma mark NSCopying
- (id)copyWithZone:(NSZone *)zone {
return self;
}
@end
@implementation MTLStorageBehaviorModel
- (id)notIvarBacked {
return self;
}
@end
@implementation MTLStorageBehaviorModelSubclass
@dynamic shadowedInSubclass;
@end
@implementation MTLMultiKeypathModel
#pragma mark MTLJSONSerializing
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"range": @[ @"location", @"length" ],
@"nestedRange": @[ @"nested.location", @"nested.length" ]
};
}
+ (NSValueTransformer *)rangeJSONTransformer {
return [MTLValueTransformer
transformerUsingForwardBlock:^(NSDictionary *value, BOOL *success, NSError **error) {
NSUInteger location = [value[@"location"] unsignedIntegerValue];
NSUInteger length = [value[@"length"] unsignedIntegerValue];
return [NSValue valueWithRange:NSMakeRange(location, length)];
} reverseBlock:^(NSValue *value, BOOL *success, NSError **error) {
NSRange range = value.rangeValue;
return @{
@"location": @(range.location),
@"length": @(range.length)
};
}];
}
+ (NSValueTransformer *)nestedRangeJSONTransformer {
return [MTLValueTransformer
transformerUsingForwardBlock:^(NSDictionary *value, BOOL *success, NSError **error) {
NSUInteger location = [value[@"nested.location"] unsignedIntegerValue];
NSUInteger length = [value[@"nested.length"] unsignedIntegerValue];
return [NSValue valueWithRange:NSMakeRange(location, length)];
} reverseBlock:^(NSValue *value, BOOL *success, NSError **error) {
NSRange range = value.rangeValue;
return @{
@"nested.location": @(range.location),
@"nested.length": @(range.length)
};
}];
}
@end
@implementation MTLClassClusterModel : MTLModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"flavor": @"flavor"
};
}
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary {
if ([JSONDictionary[@"flavor"] isEqualToString:@"chocolate"]) {
return MTLChocolateClassClusterModel.class;
}
if ([JSONDictionary[@"flavor"] isEqualToString:@"strawberry"]) {
return MTLStrawberryClassClusterModel.class;
}
return nil;
}
@end
@implementation MTLChocolateClassClusterModel : MTLClassClusterModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [[super JSONKeyPathsByPropertyKey] mtl_dictionaryByAddingEntriesFromDictionary:@{
@"bitterness": @"chocolate_bitterness"
}];
}
- (NSString *)flavor {
return @"chocolate";
}
+ (NSValueTransformer *)bitternessJSONTransformer {
return [MTLValueTransformer
transformerUsingForwardBlock:^(NSString *string, BOOL *success, NSError **error) {
NSNumberFormatter *formatter = [[NSNumberFormatter alloc] init];
return [formatter numberFromString:string];
}
reverseBlock:^(NSNumber *value, BOOL *success, NSError **error) {
return [value description];
}];
}
@end
@implementation MTLStrawberryClassClusterModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return [[super JSONKeyPathsByPropertyKey] mtl_dictionaryByAddingEntriesFromDictionary:@{
@"freshness": @"strawberry_freshness"
}];
}
- (NSString *)flavor {
return @"strawberry";
}
@end
@implementation MTLOptionalPropertyModel
@end
@implementation MTLRecursiveUserModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"name": @"name",
@"groups": @"groups",
};
}
+ (NSValueTransformer *)groupsJSONTransformer {
return [MTLJSONAdapter arrayTransformerWithModelClass:MTLRecursiveGroupModel.class];
}
@end
@implementation MTLRecursiveGroupModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"owner": @"owner",
@"users": @"users",
};
}
+ (NSValueTransformer *)ownerJSONTransformer {
return [MTLJSONAdapter dictionaryTransformerWithModelClass:MTLRecursiveUserModel.class];
}
+ (NSValueTransformer *)usersJSONTransformer {
return [MTLJSONAdapter arrayTransformerWithModelClass:MTLRecursiveUserModel.class];
}
@end
@implementation MTLPropertyDefaultAdapterModel
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"conformingMTLJSONSerializingProperty": @"conformingMTLJSONSerializingProperty",
@"nonConformingMTLJSONSerializingProperty": @"nonConformingMTLJSONSerializingProperty",
@"property": @"property"
};
}
@end

18
MantleTests/MTLTestNotificationObserver.h Normal file
View File

@ -0,0 +1,18 @@
//
// MTLTestNotificationObserver.h
// Mantle
//
// Created by Justin Spahr-Summers on 2012-09-26.
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
@interface MTLTestNotificationObserver : NSObject
@property (nonatomic, assign, readonly) BOOL receivedNotification;
// Should only be invoked once.
- (void)notificationPosted:(NSNotification *)notification;
@end

24
MantleTests/MTLTestNotificationObserver.m Normal file
View File

@ -0,0 +1,24 @@
//
// MTLTestNotificationObserver.m
// Mantle
//
// Created by Justin Spahr-Summers on 2012-09-26.
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import "MTLTestNotificationObserver.h"
@interface MTLTestNotificationObserver ()
@property (nonatomic, assign, readwrite) BOOL receivedNotification;
@end
@implementation MTLTestNotificationObserver
- (void)notificationPosted:(NSNotification *)notification {
NSParameterAssert(notification != nil);
NSAssert(!self.receivedNotification, @"Should receive a single notification: %@", notification);
self.receivedNotification = YES;
}
@end

15
MantleTests/MTLTransformerErrorExamples.h
View File

@ -1,15 +0,0 @@
//
// MTLTransformerErrorExamples.h
// Mantle
//
// Created by Robert Böhnke on 10/9/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Foundation/Foundation.h>
extern NSString * const MTLTransformerErrorExamples;
extern NSString * const MTLTransformerErrorExamplesTransformer;
extern NSString * const MTLTransformerErrorExamplesInvalidTransformationInput;
extern NSString * const MTLTransformerErrorExamplesInvalidReverseTransformationInput;

65
MantleTests/MTLTransformerErrorExamples.m
View File

@ -1,65 +0,0 @@
//
// MTLTransformerErrorExamples.m
// Mantle
//
// Created by Robert Böhnke on 10/9/13.
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Quick/Quick.h>
#import <Nimble/Nimble.h>
#import "MTLTransformerErrorExamples.h"
#import "MTLTransformerErrorHandling.h"
NSString * const MTLTransformerErrorExamples = @"MTLTransformerErrorExamples";
NSString * const MTLTransformerErrorExamplesTransformer = @"MTLTransformerErrorExamplesTransformer";
NSString * const MTLTransformerErrorExamplesInvalidTransformationInput = @"MTLTransformerErrorExamplesInvalidTransformationInput";
NSString * const MTLTransformerErrorExamplesInvalidReverseTransformationInput = @"MTLTransformerErrorExamplesInvalidReverseTransformationInput";
QuickConfigurationBegin(MTLTransformerErrorExamplesConfiguration)
+ (void)configure:(Configuration *)configuration {
sharedExamples(MTLTransformerErrorExamples, ^(QCKDSLSharedExampleContext data) {
__block NSValueTransformer<MTLTransformerErrorHandling> *transformer;
__block id invalidTransformationInput;
__block id invalidReverseTransformationInput;
beforeEach(^{
transformer = data()[MTLTransformerErrorExamplesTransformer];
invalidTransformationInput = data()[MTLTransformerErrorExamplesInvalidTransformationInput];
invalidReverseTransformationInput = data()[MTLTransformerErrorExamplesInvalidReverseTransformationInput];
expect(@([transformer conformsToProtocol:@protocol(MTLTransformerErrorHandling)])).to(beTruthy());
});
it(@"should return errors occurring during transformation", ^{
__block NSError *error;
__block BOOL success = NO;
expect([transformer transformedValue:invalidTransformationInput success:&success error:&error]).to(beNil());
expect(@(success)).to(beFalsy());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(invalidTransformationInput));
});
it(@"should return errors occurring during reverse transformation", ^{
if (![transformer.class allowsReverseTransformation]) return;
__block NSError *error;
__block BOOL success = NO;
expect([transformer reverseTransformedValue:invalidReverseTransformationInput success:&success error:&error]).to(beNil());
expect(@(success)).to(beFalsy());
expect(error).notTo(beNil());
expect(error.domain).to(equal(MTLTransformerErrorHandlingErrorDomain));
expect(@(error.code)).to(equal(@(MTLTransformerErrorHandlingErrorInvalidInput)));
expect(error.userInfo[MTLTransformerErrorHandlingInputValueErrorKey]).to(equal(invalidReverseTransformationInput));
});
});
}
QuickConfigurationEnd

22
MantleTests/MTLValueTransformerInversionAdditionsSpec.m
View File

@ -6,10 +6,6 @@
// Copyright (c) 2013 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
@interface TestTransformer : NSValueTransformer
@end
@ -33,29 +29,29 @@
@end
QuickSpecBegin(MTLValueTransformerInversionAdditions)
SpecBegin(MTLValueTransformerInversionAdditions)
__block TestTransformer *transformer;
beforeEach(^{
transformer = [[TestTransformer alloc] init];
expect(transformer).notTo(beNil());
expect(transformer).notTo.beNil();
});
it(@"should invert a transformer", ^{
NSValueTransformer *inverted = transformer.mtl_invertedTransformer;
expect(inverted).notTo(beNil());
expect(inverted).notTo.beNil();
expect([inverted transformedValue:nil]).to(equal(@"reverse"));
expect([inverted reverseTransformedValue:nil]).to(equal(@"forward"));
expect([inverted transformedValue:nil]).to.equal(@"reverse");
expect([inverted reverseTransformedValue:nil]).to.equal(@"forward");
});
it(@"should invert an inverted transformer", ^{
NSValueTransformer *inverted = transformer.mtl_invertedTransformer.mtl_invertedTransformer;
expect(inverted).notTo(beNil());
expect(inverted).notTo.beNil();
expect([inverted transformedValue:nil]).to(equal(@"forward"));
expect([inverted reverseTransformedValue:nil]).to(equal(@"reverse"));
expect([inverted transformedValue:nil]).to.equal(@"forward");
expect([inverted reverseTransformedValue:nil]).to.equal(@"reverse");
});
QuickSpecEnd
SpecEnd

40
MantleTests/MTLValueTransformerSpec.m
View File

@ -6,50 +6,46 @@
// Copyright (c) 2012 GitHub. All rights reserved.
//
#import <Mantle/Mantle.h>
#import <Nimble/Nimble.h>
#import <Quick/Quick.h>
QuickSpecBegin(MTLValueTransformerSpec)
SpecBegin(MTLValueTransformer)
it(@"should return a forward transformer with a block", ^{
MTLValueTransformer *transformer = [MTLValueTransformer transformerUsingForwardBlock:^(NSString *str, BOOL *success, NSError **error) {
MTLValueTransformer *transformer = [MTLValueTransformer transformerWithBlock:^(NSString *str) {
return [str stringByAppendingString:@"bar"];
}];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beFalsy());
expect(transformer).notTo.beNil();
expect([transformer.class allowsReverseTransformation]).to.beFalsy();
expect([transformer transformedValue:@"foo"]).to(equal(@"foobar"));
expect([transformer transformedValue:@"bar"]).to(equal(@"barbar"));
expect([transformer transformedValue:@"foo"]).to.equal(@"foobar");
expect([transformer transformedValue:@"bar"]).to.equal(@"barbar");
});
it(@"should return a reversible transformer with a block", ^{
MTLValueTransformer *transformer = [MTLValueTransformer transformerUsingReversibleBlock:^(NSString *str, BOOL *success, NSError **error) {
MTLValueTransformer *transformer = [MTLValueTransformer reversibleTransformerWithBlock:^(NSString *str) {
return [str stringByAppendingString:@"bar"];
}];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect(transformer).notTo.beNil();
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
expect([transformer transformedValue:@"foo"]).to(equal(@"foobar"));
expect([transformer reverseTransformedValue:@"foo"]).to(equal(@"foobar"));
expect([transformer transformedValue:@"foo"]).to.equal(@"foobar");
expect([transformer reverseTransformedValue:@"foo"]).to.equal(@"foobar");
});
it(@"should return a reversible transformer with forward and reverse blocks", ^{
MTLValueTransformer *transformer = [MTLValueTransformer
transformerUsingForwardBlock:^(NSString *str, BOOL *success, NSError **error) {
reversibleTransformerWithForwardBlock:^(NSString *str) {
return [str stringByAppendingString:@"bar"];
}
reverseBlock:^(NSString *str, BOOL *success, NSError **error) {
reverseBlock:^(NSString *str) {
return [str substringToIndex:str.length - 3];
}];
expect(transformer).notTo(beNil());
expect(@([transformer.class allowsReverseTransformation])).to(beTruthy());
expect(transformer).notTo.beNil();
expect([transformer.class allowsReverseTransformation]).to.beTruthy();
expect([transformer transformedValue:@"foo"]).to(equal(@"foobar"));
expect([transformer reverseTransformedValue:@"foobar"]).to(equal(@"foo"));
expect([transformer transformedValue:@"foo"]).to.equal(@"foobar");
expect([transformer reverseTransformedValue:@"foobar"]).to.equal(@"foo");
});
QuickSpecEnd
SpecEnd

6
MantleTests/Info.plist → MantleTests/MantleTests-Info.plist
View File

@ -5,13 +5,11 @@
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<string>${EXECUTABLE_NAME}</string>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<string>com.github.${PRODUCT_NAME:rfc1034identifier}</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<key>CFBundlePackageType</key>
<string>BNDL</string>
<key>CFBundleShortVersionString</key>

13
MantleTests/MantleTests-Prefix.pch Normal file
View File

@ -0,0 +1,13 @@
//
// Prefix header for all source files of the 'MantleTests' target in the 'Mantle' project
//
#ifdef __OBJC__
#import <Foundation/Foundation.h>
#import <Mantle/Mantle.h>
#import "Specta.h"
#define EXP_SHORTHAND
#import "Expecta.h"
#endif

19
MantleTests/SwiftSpec.swift
View File

@ -1,19 +0,0 @@
//
// SwiftSpec.swift
// Archimedes
//
// Created by Justin Spahr-Summers on 2014-10-02.
// Copyright (c) 2014 GitHub. All rights reserved.
//
import Foundation
import Nimble
import Quick
// Without this, the Swift stdlib won't be linked into the test target (even if
// “Embedded Content Contains Swift Code” is enabled).
class SwiftSpec: QuickSpec {
override func spec() {
expect(true).to(beTruthy())
}
}

19
MantleTests/TestModel.xcdatamodeld/TestModel.xcdatamodel/contents Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<model name="" userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="2061" systemVersion="12D78" minimumToolsVersion="Xcode 4.3" macOSVersion="Automatic" iOSVersion="Automatic">
<entity name="Child" syncable="YES">
<attribute name="id" attributeType="Integer 16" defaultValueString="0" indexed="YES" syncable="YES"/>
<relationship name="parent1" optional="YES" minCount="1" maxCount="1" deletionRule="Nullify" destinationEntity="Parent" inverseName="unorderedChildren" inverseEntity="Parent" syncable="YES"/>
<relationship name="parent2" optional="YES" minCount="1" maxCount="1" deletionRule="Nullify" destinationEntity="Parent" inverseName="orderedChildren" inverseEntity="Parent" syncable="YES"/>
</entity>
<entity name="Parent" syncable="YES">
<attribute name="date" optional="YES" attributeType="Date" syncable="YES"/>
<attribute name="number" optional="YES" attributeType="Integer 64" defaultValueString="0" syncable="YES"/>
<attribute name="string" attributeType="String" syncable="YES"/>
<relationship name="orderedChildren" optional="YES" toMany="YES" deletionRule="Nullify" ordered="YES" destinationEntity="Child" inverseName="parent2" inverseEntity="Child" syncable="YES"/>
<relationship name="unorderedChildren" optional="YES" toMany="YES" deletionRule="Nullify" destinationEntity="Child" inverseName="parent1" inverseEntity="Child" syncable="YES"/>
</entity>
<elements>
<element name="Child" positionX="405" positionY="324" width="128" height="88"/>
<element name="Parent" positionX="160" positionY="192" width="128" height="118"/>
</elements>
</model>

1
MantleTests/expecta Submodule

@ -0,0 +1 @@
Subproject commit dc270cfa343a4d1482a5b0c221106086eb8134d4

1
MantleTests/specta Submodule

@ -0,0 +1 @@
Subproject commit aebf44e527aebc411bb456bcac40bbae46d14a7a

273
README.md
View File

@ -1,8 +1,13 @@
# Mantle [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
# Mantle
Mantle makes it easy to write a simple model layer for your Cocoa or Cocoa Touch
application.
## Getting Started
To start building the framework, clone this repository and then run `script/bootstrap`.
This will automatically pull down any dependencies.
## The Typical Model Object
What's wrong with the way model objects are usually written in Objective-C?
@ -27,7 +32,6 @@ typedef enum : NSUInteger {
@property (nonatomic, copy, readonly) NSString *reporterLogin;
@property (nonatomic, copy, readonly) NSDate *updatedAt;
@property (nonatomic, strong, readonly) GHUser *assignee;
@property (nonatomic, copy, readonly) NSDate *retrievedAt;
@property (nonatomic, copy) NSString *title;
@property (nonatomic, copy) NSString *body;
@ -54,7 +58,7 @@ typedef enum : NSUInteger {
_URL = [NSURL URLWithString:dictionary[@"url"]];
_HTMLURL = [NSURL URLWithString:dictionary[@"html_url"]];
_number = dictionary[@"number"];
if ([dictionary[@"state"] isEqualToString:@"open"]) {
_state = GHIssueStateOpen;
} else if ([dictionary[@"state"] isEqualToString:@"closed"]) {
@ -62,7 +66,6 @@ typedef enum : NSUInteger {
}
_title = [dictionary[@"title"] copy];
_retrievedAt = [NSDate date];
_body = [dictionary[@"body"] copy];
_reporterLogin = [dictionary[@"user"][@"login"] copy];
_assignee = [[GHUser alloc] initWithDictionary:dictionary[@"assignee"]];
@ -81,7 +84,6 @@ typedef enum : NSUInteger {
_number = [coder decodeObjectForKey:@"number"];
_state = [coder decodeUnsignedIntegerForKey:@"state"];
_title = [coder decodeObjectForKey:@"title"];
_retrievedAt = [NSDate date];
_body = [coder decodeObjectForKey:@"body"];
_reporterLogin = [coder decodeObjectForKey:@"reporterLogin"];
_assignee = [coder decodeObjectForKey:@"assignee"];
@ -114,10 +116,7 @@ typedef enum : NSUInteger {
issue->_updatedAt = self.updatedAt;
issue.title = self.title;
issue->_retrievedAt = [NSDate date];
issue.body = self.body;
return issue;
}
- (NSUInteger)hash {
@ -136,12 +135,11 @@ typedef enum : NSUInteger {
Whew, that's a lot of boilerplate for something so simple! And, even then, there
are some problems that this example doesn't address:
* If the `url` or `html_url` field is missing, `+[NSURL URLWithString:]` will throw an exception.
* There's no way to update a `GHIssue` with new data from the server.
* There's no way to turn a `GHIssue` _back_ into JSON.
* `GHIssueState` shouldn't be encoded as-is. If the enum changes in the future,
existing archives might break.
* If the interface of `GHIssue` changes down the road, existing archives might
break.
* `GHIssueState` shouldn't be encoded as-is. If the enum changes in the future, existing archives might break.
* If the interface of `GHIssue` changes down the road, existing archives might break.
## Why Not Use Core Data?
@ -162,8 +160,8 @@ If you're just trying to access some JSON objects, Core Data can be a lot of
work for little gain.
Nonetheless, if you're using or want to use Core Data in your app already,
Mantle can still be a convenient translation layer between the API and your
managed model objects.
Mantle can still be a convenient translation layer between the API and your managed
model objects.
## MTLModel
@ -190,8 +188,6 @@ typedef enum : NSUInteger {
@property (nonatomic, copy) NSString *title;
@property (nonatomic, copy) NSString *body;
@property (nonatomic, copy, readonly) NSDate *retrievedAt;
@end
```
@ -209,8 +205,6 @@ typedef enum : NSUInteger {
return @{
@"URL": @"url",
@"HTMLURL": @"html_url",
@"number": @"number",
@"state": @"state",
@"reporterLogin": @"user.login",
@"assignee": @"assignee",
@"updatedAt": @"updated_at"
@ -226,34 +220,30 @@ typedef enum : NSUInteger {
}
+ (NSValueTransformer *)stateJSONTransformer {
return [NSValueTransformer mtl_valueMappingTransformerWithDictionary:@{
NSDictionary *states = @{
@"open": @(GHIssueStateOpen),
@"closed": @(GHIssueStateClosed)
};
return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSString *str) {
return states[str];
} reverseBlock:^(NSNumber *state) {
return [states allKeysForObject:state].lastObject;
}];
}
+ (NSValueTransformer *)assigneeJSONTransformer {
return [MTLJSONAdapter dictionaryTransformerWithModelClass:GHUser.class];
return [NSValueTransformer mtl_JSONDictionaryTransformerWithModelClass:GHUser.class];
}
+ (NSValueTransformer *)updatedAtJSONTransformer {
return [MTLValueTransformer transformerUsingForwardBlock:^id(NSString *dateString, BOOL *success, NSError *__autoreleasing *error) {
return [self.dateFormatter dateFromString:dateString];
} reverseBlock:^id(NSDate *date, BOOL *success, NSError *__autoreleasing *error) {
return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSString *str) {
return [self.dateFormatter dateFromString:str];
} reverseBlock:^(NSDate *date) {
return [self.dateFormatter stringFromDate:date];
}];
}
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error {
self = [super initWithDictionary:dictionaryValue error:error];
if (self == nil) return nil;
// Store a value that needs to be determined locally upon initialization.
_retrievedAt = [NSDate date];
return self;
}
@end
```
@ -264,6 +254,11 @@ implementations for all these methods.
The problems with the original example all happen to be fixed as well:
> If the `url` or `html_url` field is missing, `+[NSURL URLWithString:]` will throw an exception.
The URL transformer we used (included in Mantle) returns `nil` if given a `nil`
string.
> There's no way to update a `GHIssue` with new data from the server.
`MTLModel` has an extensible `-mergeValuesForKeysFromModel:` method, which makes
@ -272,9 +267,8 @@ it easy to specify how new model data should be integrated.
> There's no way to turn a `GHIssue` _back_ into JSON.
This is where reversible transformers really come in handy. `+[MTLJSONAdapter
JSONDictionaryFromModel:error:]` can transform any model object conforming to
`<MTLJSONSerializing>` back into a JSON dictionary. `+[MTLJSONAdapter
JSONArrayFromModels:error:]` is the same but turns an array of model objects into an JSON array of dictionaries.
JSONDictionaryFromModel:]` can transform any model object conforming to
`<MTLJSONSerializing>` back into a JSON dictionary.
> If the interface of `GHIssue` changes down the road, existing archives might break.
@ -282,185 +276,6 @@ JSONArrayFromModels:error:]` is the same but turns an array of model objects int
archival. When unarchiving, `-decodeValueForKey:withCoder:modelVersion:` will
be invoked if overridden, giving you a convenient hook to upgrade old data.
## MTLJSONSerializing
In order to serialize your model objects from or into JSON, you need to
implement `<MTLJSONSerializing>` in your `MTLModel` subclass. This allows you to
use `MTLJSONAdapter` to convert your model objects from JSON and back:
```objc
NSError *error = nil;
XYUser *user = [MTLJSONAdapter modelOfClass:XYUser.class fromJSONDictionary:JSONDictionary error:&error];
```
```objc
NSError *error = nil;
NSDictionary *JSONDictionary = [MTLJSONAdapter JSONDictionaryFromModel:user error:&error];
```
### `+JSONKeyPathsByPropertyKey`
The dictionary returned by this method specifies how your model object's
properties map to the keys in the JSON representation, for example:
```objc
@interface XYUser : MTLModel
@property (readonly, nonatomic, copy) NSString *name;
@property (readonly, nonatomic, strong) NSDate *createdAt;
@property (readonly, nonatomic, assign, getter = isMeUser) BOOL meUser;
@property (readonly, nonatomic, strong) XYHelper *helper;
@end
@implementation XYUser
+ (NSDictionary *)JSONKeyPathsByPropertyKey {
return @{
@"name": @"name",
@"createdAt": @"created_at"
};
}
- (instancetype)initWithDictionary:(NSDictionary *)dictionaryValue error:(NSError **)error {
self = [super initWithDictionary:dictionaryValue error:error];
if (self == nil) return nil;
_helper = [XYHelper helperWithName:self.name createdAt:self.createdAt];
return self;
}
@end
```
In this example, the `XYUser` class declares four properties that Mantle
handles in different ways:
- `name` is mapped to a key of the same name in the JSON representation.
- `createdAt` is converted to its snake case equivalent.
- `meUser` is not serialized into JSON.
- `helper` is initialized exactly once after JSON deserialization.
Use `-[NSDictionary mtl_dictionaryByAddingEntriesFromDictionary:]` if your
model's superclass also implements `MTLJSONSerializing` to merge their mappings.
If you'd like to map all properties of a Model class to themselves, you can use
the `+[NSDictionary mtl_identityPropertyMapWithModel:]` helper method.
When deserializing JSON using
`+[MTLJSONAdapter modelOfClass:fromJSONDictionary:error:]`, JSON keys that don't
correspond to a property name or have an explicit mapping are ignored:
```objc
NSDictionary *JSONDictionary = @{
@"name": @"john",
@"created_at": @"2013/07/02 16:40:00 +0000",
@"plan": @"lite"
};
XYUser *user = [MTLJSONAdapter modelOfClass:XYUser.class fromJSONDictionary:JSONDictionary error:&error];
```
Here, the `plan` would be ignored since it neither matches a property name of
`XYUser` nor is it otherwise mapped in `+JSONKeyPathsByPropertyKey`.
### `+JSONTransformerForKey:`
Implement this optional method to convert a property from a different type when
deserializing from JSON.
```
+ (NSValueTransformer *)JSONTransformerForKey:(NSString *)key {
if ([key isEqualToString:@"createdAt"]) {
return [NSValueTransformer valueTransformerForName:XYDateValueTransformerName];
}
return nil;
}
```
`key` is the key that applies to your model object; not the original JSON key. Keep this in mind if you transform the key names using `+JSONKeyPathsByPropertyKey`.
For added convenience, if you implement `+<key>JSONTransformer`,
`MTLJSONAdapter` will use the result of that method instead. For example, dates
that are commonly represented as strings in JSON can be transformed to `NSDate`s
like so:
```objc
return [MTLValueTransformer transformerUsingForwardBlock:^id(NSString *dateString, BOOL *success, NSError *__autoreleasing *error) {
return [self.dateFormatter dateFromString:dateString];
} reverseBlock:^id(NSDate *date, BOOL *success, NSError *__autoreleasing *error) {
return [self.dateFormatter stringFromDate:date];
}];
}
```
If the transformer is reversible, it will also be used when serializing the
object into JSON.
### `+classForParsingJSONDictionary:`
If you are implementing a class cluster, implement this optional method to
determine which subclass of your base class should be used when deserializing an
object from JSON.
```objc
@interface XYMessage : MTLModel
@end
@interface XYTextMessage: XYMessage
@property (readonly, nonatomic, copy) NSString *body;
@end
@interface XYPictureMessage : XYMessage
@property (readonly, nonatomic, strong) NSURL *imageURL;
@end
@implementation XYMessage
+ (Class)classForParsingJSONDictionary:(NSDictionary *)JSONDictionary {
if (JSONDictionary[@"image_url"] != nil) {
return XYPictureMessage.class;
}
if (JSONDictionary[@"body"] != nil) {
return XYTextMessage.class;
}
NSAssert(NO, @"No matching class for the JSON dictionary '%@'.", JSONDictionary);
return self;
}
@end
```
`MTLJSONAdapter` will then pick the class based on the JSON dictionary you pass
in:
```objc
NSDictionary *textMessage = @{
@"id": @1,
@"body": @"Hello World!"
};
NSDictionary *pictureMessage = @{
@"id": @2,
@"image_url": @"http://example.com/lolcat.gif"
};
XYTextMessage *messageA = [MTLJSONAdapter modelOfClass:XYMessage.class fromJSONDictionary:textMessage error:NULL];
XYPictureMessage *messageB = [MTLJSONAdapter modelOfClass:XYMessage.class fromJSONDictionary:pictureMessage error:NULL];
```
## Persistence
Mantle doesn't automatically persist your objects for you. However, `MTLModel`
@ -470,35 +285,7 @@ does conform to `<NSCoding>`, so model objects can be archived to disk using
If you need something more powerful, or want to avoid keeping your whole model
in memory at once, Core Data may be a better choice.
## System Requirements
Mantle supports OS X 10.9+ and iOS 8.0+.
## Importing Mantle
To add Mantle to your application:
1. Add the Mantle repository as a submodule of your application's repository.
1. Run `git submodule update --init --recursive` from within the Mantle folder.
1. Drag and drop `Mantle.xcodeproj` into your application's Xcode project.
1. On the "General" tab of your application target, add `Mantle.framework` to the "Embedded Binaries".
[Carthage](https://github.com/Carthage/Carthage) users can simply add Mantle to their `Cartfile`:
```
github "Mantle/Mantle"
```
If you would prefer to use [CocoaPods](http://cocoapods.org), there are some
[Mantle podspecs](https://github.com/CocoaPods/Specs/tree/master/Specs/5/d/c/Mantle) that
have been generously contributed by third parties.
If you’re instead developing Mantle on its own, use the `Mantle.xcworkspace` file.
## License
Mantle is released under the MIT license. See
[LICENSE.md](https://github.com/github/Mantle/blob/master/LICENSE.md).
## More Info
Have a question? Please [open an issue](https://github.com/Mantle/Mantle/issues/new)!

0
Cartfile → script/README.md
View File

9
script/bootstrap Executable file
View File

@ -0,0 +1,9 @@
#!/bin/bash
SCRIPT_DIR=$(dirname "$0")
cd "$SCRIPT_DIR/.."
echo "*** Updating submodules..."
git submodule sync --quiet || exit $?
git submodule update --init || exit $?
git submodule foreach --recursive --quiet "git submodule sync --quiet && git submodule update --init" || exit $?

114
script/cibuild Executable file
View File

@ -0,0 +1,114 @@
#!/bin/bash
SCRIPT_DIR=$(dirname "$0")
cd "$SCRIPT_DIR/.."
##
## Configuration Variables
##
# The build configuration to use.
if [ -z "$XCCONFIGURATION" ]
then
XCCONFIGURATION="Release"
fi
# The workspace to build.
#
# If not set and no workspace is found, the -workspace flag will not be passed
# to xcodebuild.
if [ -z "$XCWORKSPACE" ]
then
XCWORKSPACE=$(ls -d *.xcworkspace 2>/dev/null | head -n 1)
fi
# A bootstrap script to run before building.
#
# If this file does not exist, it is not considered an error.
BOOTSTRAP="$SCRIPT_DIR/bootstrap"
# A whitespace-separated list of default targets or schemes to build, if none
# are specified on the command line.
#
# Individual names can be quoted to avoid word splitting.
DEFAULT_TARGETS=
# Extra build settings to pass to xcodebuild.
XCODEBUILD_SETTINGS="TEST_AFTER_BUILD=YES"
##
## Build Process
##
if [ -z "$*" ]
then
# lol recursive shell script
if [ -n "$DEFAULT_TARGETS" ]
then
echo "$DEFAULT_TARGETS" | xargs "$SCRIPT_DIR/cibuild"
else
xcodebuild -list | awk -f "$SCRIPT_DIR/targets.awk" | xargs "$SCRIPT_DIR/cibuild"
fi
exit $?
fi
if [ -f "$BOOTSTRAP" ]
then
echo "*** Bootstrapping..."
bash "$BOOTSTRAP"
fi
echo "*** The following targets will be built:"
for target in "$@"
do
echo "$target"
done
echo "*** Cleaning all targets..."
xcodebuild -alltargets clean OBJROOT="$PWD/build" SYMROOT="$PWD/build" $XCODEBUILD_SETTINGS
run_xcodebuild ()
{
local scheme=$1
if [ -n "$XCWORKSPACE" ]
then
xcodebuild -workspace "$XCWORKSPACE" -scheme "$scheme" -configuration "$XCCONFIGURATION" build OBJROOT="$PWD/build" SYMROOT="$PWD/build" $XCODEBUILD_SETTINGS
else
xcodebuild -scheme "$scheme" -configuration "$XCCONFIGURATION" build OBJROOT="$PWD/build" SYMROOT="$PWD/build" $XCODEBUILD_SETTINGS
fi
local status=$?
return $status
}
build_scheme ()
{
local scheme=$1
run_xcodebuild "$scheme" 2>&1 | awk -f "$SCRIPT_DIR/xcodebuild.awk"
local awkstatus=$?
local xcstatus=${PIPESTATUS[0]}
if [ "$xcstatus" -eq "65" ]
then
# This probably means that there's no scheme by that name. Give up.
echo "*** Error building scheme $scheme -- perhaps it doesn't exist"
elif [ "$awkstatus" -eq "1" ]
then
return $awkstatus
fi
return $xcstatus
}
echo "*** Building..."
for scheme in "$@"
do
build_scheme "$scheme" || exit $?
done

12
script/targets.awk Normal file
View File

@ -0,0 +1,12 @@
BEGIN {
FS = "\n";
}
/Targets:/ {
while (getline && $0 != "") {
if ($0 ~ /Tests/) continue;
sub(/^ +/, "");
print "'" $0 "'";
}
}

35
script/xcodebuild.awk Normal file
View File

@ -0,0 +1,35 @@
# Exit statuses:
#
# 0 - No errors found.
# 1 - Build or test failure. Errors will be logged automatically.
# 2 - Untestable target. Retry with the "build" action.
BEGIN {
status = 0;
}
{
print;
fflush(stdout);
}
/is not valid for Testing/ {
exit 2;
}
/[0-9]+: (error|warning):/ {
errors = errors $0 "\n";
}
/(TEST|BUILD) FAILED/ {
status = 1;
}
END {
if (length(errors) > 0) {
print "\n*** All errors:\n" errors;
}
fflush(stdout);
exit status;
}