Skip to content

Latest commit

 

History

History
209 lines (168 loc) · 6.81 KB

README.md

File metadata and controls

209 lines (168 loc) · 6.81 KB
Raw

StringStylizer

Carthage compatible Cocoapods compatible Swift 3.0.x

Type strict builder class for NSAttributedString.

What's this?

StringStylizer makes NSAttributedString more intuitive with Method chain and Operator. Building NSAttributedString is so difficult because it requires us to remember attribute names and types. If you do that with StringStylizer, There is no need to remember them 😃

NSAttributedString has the following format.

let attr: [String: AnyObject] = [
    NSForegroundColorAttributeName: UIColor.whiteColor(),
    NSFontAttributeName: UIFont(name: "HelveticaNeue", size: 14)
]
let str = NSAttributedString(string: "some text", attributes: attr)

StringStylizer enable developers to read and write their code in a linear manner. If you wanna convert String to NSAttributedString which has some colors, sizes and fonts, you can write that as follows.

let str = "some text".stylize().color(.whiteColor()).size(14).font(.HelveticaNeue).attr

Feature

  • Type strict format
  • Assigning ranges and attributes in a linear manner
  • More readable than NSAttributedString

Requirements

  • iOS 8.0+
  • Swift 3.0 or Swift 2.3 (swift2.3 branch)

Installation

Carthage

  • Install Carthage from Homebrew
> ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
> brew update
> brew install carthage
  • Move your project dir and create Cartfile
> touch Cartfile
  • add the following line to Cartfile
github "kazuhiro4949/StringStylizer"
  • Create framework
> carthage update --platform iOS
  • In Xcode, move to "Genera > Build Phase > Linked Frameworks and Library"
  • Add the framework to your project
  • Add a new run script and put the following code
/usr/local/bin/carthage copy-frameworks
  • Click "+" at Input file and Add the framework path
$(SRCROOT)/Carthage/Build/iOS/StringStylizer.framework
  • Write Import statement on your source file
Import StringStylizer

CocoaPods

  • Install CocoaPods
> gem install cocoapods
> pod setup
  • Create Podfile
> pod init
  • Edit Podfile
# Uncomment this line to define a global platform for your project
platform :ios, '8.0'  # add
use_framework!  # add

target 'MyAppName' do
  pod 'StringStylizer' # add
end

target 'MyAppTests' do

end

target 'MyAppUITests'
  • Install
> pod install

open .xcworkspace

Example

let label = UILabel(frame: CGRectMake(0, 0, 100, 50))

// build NSAttributedString.
let greed = "Hi, ".stylize().color(0x2200ee).size(12).font(.HelveticaNeue).attr

// build NSAttributedString with ranges.
let msg = "something happened ".stylize()
               .range(0..<9)        .color(0x009911).size(12).font(.HelveticaNeue)
               .range(10..<UInt.max).color(0xaa22cc).size(14).font(.HelveticaNeue_Bold).attr

// build NSAttributedString objects and join them.
let name = "to ".stylize().color(0x23abfc).size(12).font(.HelveticaNeue).attr +
           "you".stylize().color(0x123456).size(14).font(.HelveticaNeue_Italic).underline(.StyleDouble).attr

label.attributedText = greed + msg + name

This sample generates a styled label.

Of course, you can wrap up the method chains.

extension StringStylizer {
  func strong() -> NSAttributedString {
    return self
            .color(0x123456)
            .size(14)
            .font(.HelveticaNeue_Italic)
            .underline(.StyleDouble)
            .attr
  }
}

label.attributedText = "you".stylize().strong()

Usage

1. Convert String to StringStylizer object

let firstStep = "yay!".stylize() // => StringStylizer<Styling>

2. Call methods to select range. Then, StringStylizer change into "NarrowDown" state

let secondStep = "yay!".stylize().range(0..<UInt.max) // => StringStylizer<NarrowDown>

3. Call methods to set attributes. Then, StringStylizer change into "Styling" state

let thirdStep = "yay!".stylize().range(0..<UInt.max).size(14) // => StringStylizer<Styling>

4. Convert to NSAttributedString object.

let fourthStep = "yay!".stylize().range(0..<UInt.max).size(14).attr // => NSAttributedString

5. Join another NSAttributedString object.

let one     = "yay!".stylize().range(0..<UInt.max).size(14).attr
let another = " yay!".stylize().color(0xffffff).attr
let fifthStep = one + another // => NSAttributedString

That's it!

Architecture

StringStylizer is based on "Builder Pattern" (Effective Java version). In addition, it has states managed by "Phantom Type".

Because of them, we are able to

  • write our code in a liner manner
  • call proper methods depending on the situation.

Swift 2.3 & 3.0 Migration Guide

Current master branch and the latest release package is supporting Xcode8. You can install Swift 3.0 package in the usual process. If you wanna install Swift 2.3 branch, pull swift2.3 branch or install version 2.3.0.

License

Copyright (c) 2016 Kazuhiro Hayashi

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.