Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nonchalant/factoryprovider

:factory: Generate boilerplate of factory Swift framework :factory:
https://github.com/nonchalant/factoryprovider

automation cli factory swift-package-manager xcode

Last synced: about 2 months ago
JSON representation

:factory: Generate boilerplate of factory Swift framework :factory:

Host: GitHub
URL: https://github.com/nonchalant/factoryprovider
Owner: Nonchalant
License: mit
Created: 2018-06-05T16:54:21.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2018-10-23T07:20:21.000Z (about 6 years ago)
Last Synced: 2024-03-14T15:48:09.379Z (10 months ago)
Topics: automation, cli, factory, swift-package-manager, xcode
Language: Swift
Homepage:
Size: 72.3 KB
Stars: 32
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # :factory: FactoryProvider :factory:

[![Build Status](https://travis-ci.com/Nonchalant/FactoryProvider.svg?branch=master)](https://travis-ci.com/Nonchalant/FactoryProvider)

[![Version](http://img.shields.io/cocoapods/v/FactoryProvider.svg?style=flat)](http://cocoadocs.org/pods/FactoryProvider)

[![Platform](http://img.shields.io/cocoapods/p/FactoryProvider.svg?style=flat)](http://cocoadocs.org/pods/FactoryProvider)

[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/Nonchalant/FactoryProvider/master/LICENSE.md)

[![GitHub release](https://img.shields.io/github/release/Nonchalant/FactoryProvider.svg)](https://github.com/Nonchalant/FactoryProvider/releases)

![Xcode](https://img.shields.io/badge/Xcode-10.svg)

![Swift](https://img.shields.io/badge/Swift-4.2.svg)

[![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-4.0.0-brightgreen.svg)](https://github.com/apple/swift-package-manager)

Generate boilerplate of factory Swift framework.

## Requirements

- **Swift 4+**

- **Xcode 9+**

## Platforms

FactoryProvider works on the following platforms:

- **iOS 8+**

- **Mac OSX 10.9+**

- **watchOS 2+**

- **tvOS 9+**

## Supports

- **Enum**

- **Struct**

## FactoryProvider

### 1. Installation

#### CocoaPods

FactoryProvider runtime is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your test target in your Podfile:

```Ruby

pod "FactoryProvider"

```

And add the following `Run script` build phase to your test target's `Build Phases`:

```Bash

"${PODS_ROOT}/FactoryProvider/generate" --config .factory.yml

```

After running once, locate `Factories.generated.swift` and drag it into your Xcode test target group.

#### .factory.yml

```yml

includes: # paths of file or directory to generate

  - Input/SubInput1

  - Input/SubInput2/Source.swift

excludes: # paths of file or directory not to generate

  - Input/SubInput1/SubSubInput

  - Input/SubInput2/Source.swift

testables: # testable targets

  - target1

  - target2

output: output/Factories.generated.swift # path of generated file

```

### 2. Usage

You can get a instance to call `Factory.provide()`. Each properties are set to default value.

```swift

struct Climber {

    let name: String

    let age: Int

}

let climber = Factory.provide()

// Climber(name: "", age: 0)

 let optClimber = Factory.provide()

// Optional(Climber(name: "", age: 0))

 let arrayClimber = Factory<[Climber]>.provide()

// [Climber(name: "", age: 0)]

```

### 3. Lens

`Factory.provide()` provides fixed instance. You can modify each property by Lens.

#### Get

```swift

let name = Factory.provide().name or Lens.name().get(Factory.provide())

// ""

```

#### Set

```swift

import FactoryProvider

let climber = Factory.provide() |> Lens.name() *~ "Climber"

// Climber(name: "Climber", age: 0)

```

#### Modify

```swift

import FactoryProvider

let name = Factory.provide() |> Lens.name() *~ { "Climber" |> { $0 + $0 } }()

// Climber(name: "ClimberClimber", age: 0)

```

#### Compose

```swift

import FactoryProvider

struct Climber {

    let id: Id

    let name: String

    

    struct Id {

        let value: String

    }

}

let climber1 = Factory.provide()

// Climber(id: Id(value: ""), name: "")

let climber2 = climber1 |> Lens.id() * Lens.value() *~ "id"

// Climber(id: Id(value: "id"), name: "")

```

## Notice

### Generics

If you want to contains type using generics, you should use `0.4.1`.

```Ruby

pod "FactoryProvider", '~> 0.4.1'

```

## Libraries

* [Commander](https://github.com/kylef/Commander)

* [PathKit](https://github.com/kylef/PathKit)

* [SourceKitten](https://github.com/jpsim/SourceKitten)

* [StencilSwiftKit](https://github.com/SwiftGen/StencilSwiftKit)

* [MirrorDiffKit](https://github.com/Kuniwak/MirrorDiffKit)

## License

FactoryProvider is available under the [MIT License](LICENSE).