ValidatableKit

1.0.0

Composable data validation API in Swift exposing simple DSL for writing validations.
SwiftyLab/ValidatableKit

What's New

v1.0.0

2022-12-18T10:35:59Z

1.0.0 (2022-12-18)

Tests

  • add data validation tests (ff66119)

📚 Documentation

  • add project documentation, contributing and conduct guidelines (a1602b7)

💄 Styles

  • add swift-format for code formatting (2ceacad)
  • add vscode workspace settings (541cf4d)

🚀 Features

ValidatableKit

API Docs CocoaPods Compatible Swift Package Manager Compatible Carthage compatible Swift Platforms CI/CD CodeFactor codecov

Composable data validation API in Swift exposing simple DSL for writing validations.

Overview

ValidatableKit allows validating data by providing Validator for the type. Validators can be created by directly providing callback that performs the validation on basic data types and provides ValidatorResult:

let skip: Validator<Int> = .init { _ in ValidatorResults.Skipped() }

Or the library provided DSL can be used to add validations to properties for complex data types:

struct User: Validatable {
    let name: String
    let email: String
    let age: Int

    var validator: Validator<Self> {
        return Validator<Self>
            .name(!.isEmpty, .alphanumeric)
            .email(.isEmail)
    }
}

Requirements

Platform Minimum Swift Version Installation Status
iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+ 5.1 CocoaPods, Carthage, Swift Package Manager, Manual Fully Tested
Linux 5.1 Swift Package Manager Fully Tested
Windows 5.3 Swift Package Manager Fully Tested

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate ValidatableKit into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'ValidatableKit'

Optionally, you can also use the pre-built XCFramework from the GitHub releases page by replacing {version} with the required version you want to use:

pod 'ValidatableKit', :http => 'https://github.com/SwiftyLab/ValidatableKit/releases/download/v{version}/ValidatableKit-{version}.xcframework.zip'

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate ValidatableKit into your Xcode project using Carthage, specify it in your Cartfile:

github "SwiftyLab/ValidatableKit"

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding ValidatableKit as a dependency is as easy as adding it to the dependencies value of your Package.swift.

.package(url: "https://github.com/SwiftyLab/ValidatableKit.git", from: "1.0.0"),

Optionally, you can also use the pre-built XCFramework from the GitHub releases page by replacing {version} and {checksum} with the required version and checksum of artifact you want to use:

.binaryTarget(name: "ValidatableKit", url: "https://github.com/SwiftyLab/ValidatableKit/releases/download/v{version}/ValidatableKit-{version}.xcframework.zip", checksum: "{checksum}"),

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate ValidatableKit into your project manually.

Git Submodule

  • Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

    $ git init
  • Add ValidatableKit as a git submodule by running the following command:

    $ git submodule add https://github.com/SwiftyLab/ValidatableKit.git
  • Open the new ValidatableKit folder, and drag the ValidatableKit.xcodeproj into the Project Navigator of your application's Xcode project or existing workspace.

    It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the ValidatableKit.xcodeproj in the Project Navigator and verify the deployment target satisfies that of your application target (should be less or equal).

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.

  • In the tab bar at the top of that window, open the "General" panel.

  • Click on the + button under the Frameworks and Libraries section.

  • You will see ValidatableKit.xcodeproj folder with ValidatableKit.framework nested inside.

  • Select the ValidatableKit.framework and that's it!

    The ValidatableKit.framework is automagically added as a target dependency, linked framework and embedded framework in build phase which is all you need to build on the simulator and a device.

XCFramework

You can also directly download the pre-built artifact from the GitHub releases page:

  • Download the artifact from the GitHub releases page of the format ValidatableKit-{version}.xcframework.zip where {version} is the version you want to use.

  • Extract the XCFrameworks from the archive, and drag the ValidatableKit.xcframework into the Project Navigator of your application's target folder in your Xcode project.

  • Select Copy items if needed and that's it!

    The ValidatableKit.xcframework is automagically added in the embedded Frameworks and Libraries section, an in turn the linked framework in build phase.

Usage

See the full documentation for API details and articles on sample scenarios.

Contributing

If you wish to contribute a change, suggest any improvements, please review our contribution guide, check for open issues, if it is already being worked upon or open a pull request.

License

ValidatableKit is released under the MIT license. See LICENSE for details.

Description

  • Swift Tools 5.6.0
View More Packages from this Author

Dependencies

Last updated: Fri Jan 27 2023 02:50:28 GMT-0500 (GMT-05:00)