nathankot/SpecificationPattern

Specification pattern implemented in swift (iOS/OSX)

SpecificationPattern

The Specification design pattern implemented in swift for iOS/OSX.

In computer programming, the specification pattern is a particular software design pattern, whereby business rules can be recombined by chaining the business rules together using boolean logic.

Source: wikipedia.org

Requirements

• Xcode 6.1
• iOS 7.0+ / Mac OS X 10.9+

Usage

Chain two specifications into a single specification.

let s0 = RegularExpressionSpecification(pattern: "hello.*world")
let s1 = CountSpecification.between(20, 30)
let spec = s0 & s1

spec == "42"
# false, doesn't satify s0 and s1
spec == "hello world"
# false, s0 is satisfied, but not s1
spec == "say hello to the world today"
# true

Useful classes

Beyond the specification pattern itself, this project provides the following iOS/OSX specifications

• CharacterSetSpecification - for ensuring all characters in a string are of a certain kind, eg. all digits
• CountSpecification - for ensuring that a string/array isn't too long or short
• EmailSpecification - decide if an email is valid or not
• PredicateSpecification - if you don't want to subclass you can use this and instead provide a closure
• RegularExpressionSpecification - useful for string matching

Operators

And operator

Use the & operator when two specifications both must be satisfied.

Or operator

Use the | operator when one of two specifications must be satisfied.

Not operator

Use the ! operator when a specifications must not be satisfied.

Equal operator

Use the == operator to check if a candidate object satisfies the specification.

Not equal operator

Use the != operator to check if a candidate object doesn't satisfy the specification.

Example - Invoice handling

In the following example, we are retrieving invoices and sending them to a collection agency if

1. they are overdue,
2. notices have been sent, and
3. they are not already with the collection agency.

This example is meant to show the end result of how the logic is 'chained' together.

let overDue = OverDueSpecification()
let noticeSent = NoticeSentSpecification()
let inCollection = InCollectionSpecification()

// example of specification pattern logic chaining
let sendToCollection = overDue & noticeSent & !inCollection

let invoiceCollection = Service.invoices()
for invoice in invoiceCollection {
    if sendToCollection.isSatisfiedBy(invoice) {
        invoice.sendToCollection()
    }
}

Sample project - Live text validation

The coloring are like this:

1. Red, when the text neither can be "taylor" nor "swift"
2. White, when the text is partially matching either "taylor" or "swift"
3. Green, when the text is exactly "taylor" or exactly "swift".

You find this in the Basic_iOS project in the Examples folder.

Contributing

1. Fork it
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create new Pull Request