Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Quick/Nimble

A Matcher Framework for Swift and Objective-C
https://github.com/Quick/Nimble

asynchronous-expectations bdd failure-messages matcher-functions operator-overloads swift swift-assertions swift-generics testing

Last synced: 3 days ago
JSON representation

A Matcher Framework for Swift and Objective-C

Awesome Lists containing this project

README 

        
# Nimble



[![Build Status](https://github.com/Quick/Nimble/actions/workflows/ci-xcode.yml/badge.svg)](https://github.com/Quick/Nimble/actions/workflows/ci-xcode.yml)

[![CocoaPods](https://img.shields.io/cocoapods/v/Nimble.svg)](https://cocoapods.org/pods/Nimble)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Platforms](https://img.shields.io/cocoapods/p/Nimble.svg)](https://cocoapods.org/pods/Nimble)



Use Nimble to express the expected outcomes of Swift

or Objective-C expressions. Inspired by

[Cedar](https://github.com/pivotal/cedar).



```swift

// Swift

expect(1 + 1).to(equal(2))

expect(1.2).to(beCloseTo(1.1, within: 0.1))

expect(3) > 2

expect("seahorse").to(contain("sea"))

expect(["Atlantic", "Pacific"]).toNot(contain("Mississippi"))

expect(ocean.isClean).toEventually(beTruthy())

```



# Documentation



Nimble's documentation is now lives in [Sources/Nimble/Nimble.docc](Sources/Nimble/Nimble.docc)

as a Documentation Catalog. You can easily browse it [quick.github.io/Nimble](https://quick.github.io/Nimble/documentation/nimble).



# Installing Nimble



> Nimble can be used on its own, or in conjunction with its sister

  project, [Quick](https://github.com/Quick/Quick). To install both

  Quick and Nimble, follow [the installation instructions in the Quick

  Documentation](https://github.com/Quick/Quick/blob/main/Documentation/en-us/InstallingQuick.md).



Nimble can currently be installed in one of four ways: Swift Package Manager, 

CocoaPods, Carthage or with git submodules.



## Swift Package Manager



### Xcode



To install Nimble via Xcode's Swift Package Manager Integration:

Select your project configuration, then the project tab, then the Package

Dependencies tab. Click on the "plus" button at the bottom of the list,

then follow the wizard to add Quick to your project. Specify

`https://github.com/Quick/Nimble.git` as the url, and be sure to add

Nimble as a dependency of your unit test target, not your app target.



### Package.Swift



To use Nimble with Swift Package Manager to test your applications, add Nimble

to your `Package.Swift` and link it with your test target:



```swift

// swift-tools-version:5.7



import PackageDescription



let package = Package(

    name: "MyAwesomeLibrary",

    products: [

        // ...

    ],

    dependencies: [

        // ...

        .package(url:  "https://github.com/Quick/Nimble.git", from: "13.0.0"),

    ],

    targets: [

        // Targets are the basic building blocks of a package. A target can define a module or a test suite.

        // Targets can depend on other targets in this package, and on products in packages this package depends on.

        .target(

            name: "MyAwesomeLibrary",

            dependencies: ...),

        .testTarget(

            name: "MyAwesomeLibraryTests",

            dependencies: ["MyAwesomeLibrary", "Nimble"]),

    ]

)

```



Please note that if you install Nimble using Swift Package Manager, then `raiseException` is not available.



## CocoaPods



To use Nimble in CocoaPods to test your macOS, iOS, tvOS or watchOS applications, add

Nimble to your podfile and add the ```use_frameworks!``` line to enable Swift

support for CocoaPods.



```ruby

platform :ios, '13.0'



source 'https://github.com/CocoaPods/Specs.git'



# Whatever pods you need for your app go here



target 'YOUR_APP_NAME_HERE_Tests', :exclusive => true do

  use_frameworks!

  pod 'Nimble'

end

```



Finally run `pod install`.



## Carthage



To use Nimble in Carthage to test your macOS, iOS, tvOS or watchOS applications,

add Nimble to your `Cartfile.private`:



```

github "Quick/Nimble" ~> 13.2

```



Then follow the rest of the [Carthage Quick Start](https://github.com/carthage/carthage/?tab=readme-ov-file#quick-start)

and link Nimble with your unit tests.



## Git Submodules



To use Nimble as a submodule to test your macOS, iOS or tvOS applications, follow

these 4 easy steps:



1. Clone the Nimble repository

2. Add Nimble.xcodeproj to the Xcode workspace for your project

3. Link Nimble.framework to your test target

4. Start writing expectations!



For more detailed instructions on each of these steps,

read [How to Install Quick](https://github.com/Quick/Quick#how-to-install-quick).

Ignore the steps involving adding Quick to your project in order to

install just Nimble.



# Privacy Statement



Nimble is a library that is only used for testing and should never be included

in the binary submitted to App Store Connect.



Despite not being shipped to Apple, Nimble does not and will never collect any

kind of analytics or tracking.