Swiftpack.co - Package - FabrizioBrancati/BFKit-Swift

BFKit-Swift Banner

Build Status Coverage Status codebeat badge Swift Package Manager Compatible Carthage Compatible Version License
Language Platforms


FeaturesClasses and Extensions CompatibilityRequirementsCommunicationContributingInstalling and UsageDocumentationChangelogExampleTodoAuthorLicense


Swift 5.0

If you need Swift 5.0 support, switch to the swift-5 branch!

Features

BFKit-Swift is a collection of useful classes, structs and extensions to develop Apps faster.
For example you can use every iOS font with just an enum!
It also adds some useful functions with Custom classes and extends Foundation, UIKit, AppKit and WatchKit classes.

Classes and Extensions Compatibility

BFKit

| | iOS | macOS | watchOS | Linux | |-----------------|---------|-----------|-------------|-----------| | BFApp | ✓ | ✓ | ✓ | ✓ | | BFBiometric | ✓ | | | | | BFButton | ✓ | | | | | BFDataStructures
(List - Queue - Stack) | ✓ | ✓ | ✓ | ✓ | | BFLog | ✓ | ✓ | ✓ | ✓ | | BFPassword | ✓ | ✓ | ✓ | ✓ | | BFSystemSound | ✓ | | | | | BFTextField | ✓ | | | | | BFTouchID | ✓ | | |   |

Foundation

| | iOS | macOS | watchOS | Linux | |-----------------|---------|-----------|-------------|-----------| | Array | ✓ | ✓ | ✓ | ✓ | | Collection | ✓ | ✓ | ✓ | ✓ | | Data | ✓ | ✓ | ✓ | ✓ | | Date | ✓ | ✓ | ✓ | ✓ | | FileManager | ✓ | ✓ | ✓ | ✓ | | Number | ✓ | ✓ | ✓ | ✓ | | NSObject | ✓ | ✓ | ✓ | ✓ | | NSAttributedString | ✓ | ✓ | ✓ | | | NSPointerArray | ✓ | ✓ | ✓ | | | ProcessInfo | ✓ | ✓ | ✓ | ✓ | | Set | ✓ | ✓ | ✓ | ✓ | | String | ✓ | ✓ | ✓ | ✓ | | Thread | ✓ | ✓ | ✓ | ✓ |

Core Graphics

| | iOS | macOS | watchOS | Linux | |-----------------|---------|-----------|-------------|-----------| | CGPoint | ✓ | ✓ | ✓ |   |

UIKit / AppKit

| | iOS | macOS | watchOS | Linux | |-----------------|---------|-----------|-------------|-----------| | UIBarButtonItem | ✓ | | | | | UIButton | ✓ | | | | | UIColor | ✓ | ✓ | ✓ | | | UIDevice | ✓ | | | | | UIFont | ✓ | | ✓ | | | UIImage | ✓ | | ✓ | | | UIImageView | ✓ | | | | | UILabel | ✓ | | | | | UINavigationBar | ✓ | | | | | UIPasteboard | ✓ | | | | | UIScreen | ✓ | | | | | UIScrollView | ✓ | | | | | UITableView | ✓ | | | | | UITextField | ✓ | | | | | UITextView | ✓ | | | | | UIToolbar | ✓ | | | | | UIView | ✓ | | | | | UIViewController | ✓ | | | | | UIWebView | ✓ | | | | | UIWindow | ✓ | | |   |

WatchKit

| | iOS | macOS | watchOS | Linux | |-----------------|---------|-----------|-------------|-----------| | WKInterfaceController | | | ✓ |   |

Requirements

| Swift | Xcode | BFKit-Swift | iOS | macOS | watchOS | Linux | |-----------|-----------|-----------------|----------|------------|-------------|-----------| | 1.2 | 6.3 | 1.0.0...1.4.1 | 7.0+ | | | | | 2.0...2.1 | 7.0 | 1.5.0...1.6.2 | 7.0+ | | | | | 2.2 | 7.3 | 1.6.3...1.7.0 | 7.0+ | | | | | 2.3 | 8.0 | 1.8.0 | 7.0+ | | | | | 3.0...3.1 | 8.0...8.3 | 2.0.0...2.3.0 | 8.0+ | | | ✓ | | 3.0...3.1 | 8.0...8.3 | 2.4.0...2.5.0 | 8.0+ | | 2.0+ | ✓ | | 3.0...3.2 | 8.0...9.0 | 2.6.0 | 8.0+ | 10.10+ | 2.0+ | ✓ | | 4.0 | 9.0...9.2 | 3.0.0...3.1.1 | 8.0+ * | 10.10+ * | 2.0+ * | ✓ | | 4.1 | 9.3...9.4 | 3.1.2...3.2.1 | 8.0+ * | 10.10+ * | 2.0+ * | ✓ | | 4.2 | 10.0 | 4.0.0...4.1.0 | 8.0+ * | 10.10+ * | 2.0+ * | ✓ |

* With App Extension Support

Communication

  • If you need help, open an issue
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, see Contributing section.

Contributing

See CONTRIBUTING.md file.

Installing and Usage

See Requirements section to check Swift, Xcode, BFKit-Swift and OS versions.

Manual

  • Open and build the framework from the project (BFKit.xcodeproj)
  • Import BFKit.framework into your project
  • Import the framework with import BFKit
  • Enjoy!

CocoaPods

  • Create a Podfile in your project directory and write into:

    platform :ios, '8.0'
    xcodeproj 'Project.xcodeproj'
    use_frameworks!
    
    pod 'BFKit-Swift'
    
  • Change "Project" with your real project name

  • Open Terminal, go to your project directory and type: pod install

  • Import the framework with import BFKit

  • Enjoy!

Carthage

  • Create a Cartfile in your project directory and write into:

    github "FabrizioBrancati/BFKit-Swift"
    
  • Open Terminal, go to project directory and type: carthage update

  • Include the created Framework in your project

  • Add Build Phase with the following contents:

    /usr/local/bin/carthage copy-frameworks
    

    Add the paths to the BFKit-Swift framework under Input Files

    $(SRCROOT)/Carthage/Build/iOS/BFKit.framework
    

    Add the paths to the copied frameworks to the Output Files

    $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/BFKit.framework
    

    This script works around an App Store submission bug triggered by universal binaries and ensures that necessary bitcode-related files are copied when archiving

  • (Optional) Add Build Phase with the following contents

    /usr/local/bin/carthage outdated --xcode-warnings
    

    To automatically warn you when one of your dependencies is out of date

  • Import the framework with import BFKit

  • Enjoy!

Swift Package Manager

  • Create a Package.swift file in your project directory and write into:

    // swift-tools-version:4.2
    import PackageDescription
    
    let package = Package(
        name: "Project",
        products: [
            .executable(name: "Project", targets: ["Project"])
        ],
        dependencies: [
            .package(url: "https://github.com/FabrizioBrancati/BFKit-Swift.git", .upToNextMajor(from: "4.0.0"))
        ],
        targets: [
            .target(name: "Project", dependencies: ["BFKit"])
        ]
    )
    
  • Change "Project" with your real project name

  • Open Terminal, go to project directory and type: swift build

  • Import the framework with import BFKit

  • Enjoy!

Documentation

Documentation

Jazzy generated documentation - 100% Documented

Changelog

To see what has changed in recent versions of BFKit-Swift, see the CHANGELOG.md file.

Example

Open and run the BFKitExample project in Example folder in this repo with Xcode and see BFKit-Swift in action!

Todo

  • [ ] Add tvOS support
  • [ ] Create a new Example App that shows all the functionalities of BFKit-Swift
  • [ ] ~100% of code coverage with Unit Tests
  • [ ] Improve code to get an A from codebeat
  • [x] Add macOS support
  • [x] Add watchOS support
  • [x] Create Unit Tests and add Codecov badge
  • [x] Add Linux support (Foundation extensions only)
  • [x] Add Carthage support
  • [x] Add to CocoaPods
  • [x] Create a great documentation

Author

Fabrizio Brancati

Website: https://www.fabriziobrancati.com
Email: fabrizio.brancati@gmail.com

License

BFKit-Swift is available under the MIT license. See the LICENSE file for more info.

Github

link
Stars: 800
Help us keep the lights on

Dependencies

Releases

4.1.0 - Feb 3, 2019

BFKit-Swift 4.1.0

03 Feb 2019

Added

  • Added iPhone XS, iPhone XS Max and iPhone XR in UIDevice extension
  • Added isFromTestFlight function in BFApp enum to check if the app has been installed from TestFlight

Thanks to @gennick for this release

4.0.1 - Feb 3, 2019

BFKit-Swift 4.0.1

27 Dec 2018

Added

  • Added new iPad Pro 11-inch and 12.9-inch in UIDevice extension
  • Added missing CoreGraphics files to CocoaPods

Removed

  • Removed watchOS 2.0 support in favor of watchOS 3.0, thanks to an App Store submission bug #11

Improved

  • Improved settings reading and saving in FileManager extension
  • Updated SwiftLint to 0.29.2

4.0.0 - Oct 10, 2018

BFKit-Swift 4.0.0

11 Oct 2018

Added

  • Added support to Xcode 10 and Swift 4.2
  • Added localized and numberValue variables in String extension
  • Added queryStringParameter(parameter:), queryDictionary() and urlValid() functions in String extension

Changed

  • BFTouchID is deprecated and will be removed in a future version of BFKit-Swift. Please use BFBiometrics enum instead
  • lightFont in UIFont extension is deprecated and will be removed in a future version of BFKit-Swift
  • regularFont in UIFont extension is deprecated and will be removed in a future version of BFKit-Swift
  • boldFont in UIFont extension is deprecated and will be removed in a future version of BFKit-Swift
  • All random functions in Number extension are deprecated and will be removed in a future version of BFKit-Swift
  • Changed from Codecov to Coveralls service for code coverage

Improved

  • Updated package tools version to 4.2

Fixed

  • Now .applicationSupport case available in PathType enum in FileManager extension fully works, even if Application Support folder doesn't exist

3.2.1 - Sep 13, 2018

BFKit-Swift 3.2.1

14 Sep 2018

Improved

  • Updated SwiftLint to 0.27.0

Fixed

  • Fixed wrong corner radius in cornerRadius(corners:, radius:) function in UIView extension

3.2.0 - Jul 14, 2018

BFKit-Swift 3.2.0

14 Jul 2018

Added

  • Added force attribute to generateUniqueIdentifier(save: Bool = default, force: Bool = default) in UIDevice extension with a default value, hence no changes are required
  • Added resetFirstStart(version: String = default) in BFApp struct, to reset the App like has never been opened
  • Added FileManager extension to Linux

Improved

  • Improved code of a lot of classes / structs and enums
  • Updated SwiftLint to 0.26.0
  • Use of canImport() instead of os()
  • Converted static only structs to enums to avoid initialization
  • Removed all force unwrapping to avoid possible crashes
  • Fixing some memory leaks

Deprecated

  • BFTouchID struct in favour of BFBiometrics enum
  • lightFont, mediumFont and boldFont from UIFont extension
  • length in favour of count in String extension

Removed

  • Removed Hound CI