Insanity 0.2.0

Insanity 0.2.0

TestsTested
LangLanguage Obj-CObjective C
License MIT
ReleasedLast Release Dec 2016

Maintained by Krzysztof Zabłocki.


Downloads

Total12
Week0
Month0

Installs

Apps3
powered by Segment

Insanity 0.2.0

What is Insanity?

Doing the same thing over and over again and expecting different results.

Swift is a beautiful language that powers a lot of great iOS apps. Unfortunately it features very limited runtime and no meta-programming features. This has led our projects to contain a lot of duplicated code patterns, they can be considered the same code, just with minimal variations.

Have you ever?

  • Had to write NSCoding support?
  • Had to implement JSON serialization?
  • Wanted value types to be equatable and hashable?
  • Used enum to wrap decoupled types?

If you did then you probably found yourself writing a lot of repetitive code to deal with those scenarios, does this feel right?

Even worse, if you ever add a new property to a type all of those implementations have to be updated, or you'll end up with bugs. In those scenarios usually compiler won't generate the error for you, which leads to error prone code.

Insanity is a tool that scans your source code, applies your personal templates and generates Swift code for you, allowing you to use meta-programming techniques to save time and decrease potential mistakes.

  • Scans your project code.
  • Allows your templates to access information about project types.
  • Generates swift code.
  • Immediate feedback: Insanity features built-in daemon support, allowing you to write your templates in real-time side-by-side with generated code.

There are multiple benefits in using Insanity approach:

  • Write less boilerplate code and make it easy adhere to DRY principle
  • Avoid the risk of forgetting to update boilerplate when refactoring
  • Gives you meta-programming powers, while still allowing the compiler to ensure everything is correct.

Daemon mode in action:

Daemon demo

How everything connects:

                                   +--------------+
         Scans code to build AST   |              |  Generates new code
      +---------------------------->   INSANITY   +--------------------------------+
      |                            |              |                                |
      |                            +--^--------^--+                                |
      |                               |        |                                   |
      |                               |        | Reads templates                   |
      |                               |        |                                   |
+-----+------+       +----------------+--+  +--+----------------+        +---------v---------+
|            |       |                   |  |                   |        |                   |
|   Source   |       | Equality Template |  | NSCoding Template |        |  Generated Swift  |
|            |       |                   |  |                   |        |                   |
+-----^------+       +-------------------+  +-------------------+        +-------------------+
      |                                                                            |
      |                                                                            |
      |                                                                            |
      +----------------------------------------------------------------------------+
                              Compiled into your project

Examples

Use case: I want to know how many elements are in each enum

Template:

{% for enum in types.enums %}
extension {{ enum.name }} {
  static var count: Int { return {{ enum.cases.count }} }
}
{% endfor %}

Result:

extension AdType {
  static var count: Int { return 2 }
}

Use case: `I want to generate Equality for types implementing specific protocol.'

Template:

{% for type in types.implementing.AutoEquatable %}
extension {{ type.name }}: Equatable {}

func == (lhs: {{ type.name }}, rhs: {{ type.name }}) -> Bool {
    {% for variable in type.storedVariables %} if lhs.{{ variable.name }} != rhs.{{ variable.name }} { return false }
    {% endfor %}
    return true
}
{% endfor %}

Result:

extension AccountSectionConfiguration: Equatable {}

func == (lhs: AccountSectionConfiguration, rhs: AccountSectionConfiguration) -> Bool {
     if lhs.status != rhs.status { return false }
     if lhs.user != rhs.user { return false }
     if lhs.entitlements != rhs.entitlements { return false }

    return true
}
Use case: `I want to list all computed variables in a given type.'

Template:

{% for variable in type.VideoViewModel.computedVariables %} {{ variable.name }}: {{ variable.type }}
{% endfor %}

Result:

attributedTitle: NSAttributedString
attributedKicker: NSAttributedString
attributedHeadline: NSAttributedString
attributedSummary: NSAttributedString

Writing templates

Insanity templates are powered by Stencil

Make sure you leverage Insanity built-in daemon to make writing templates a pleasure: you can open template side-by-side with generated code and see it change live.

There are multiple ways to access your types:

  • type.TypeName => access specific type by name
  • types.all => all types, excluding protocols
  • types.classes
  • types.structs
  • types.enums
  • types.protocols => lists all protocols (that were defined in the project)
  • types.inheriting.BaseClassOrProtocol => lists all types inheriting from given BaseClass or implementing given Protocol
  • types.implementing.BaseClassOrProtocol => convience alias that works exactly the same as .inheriting

For each type you can access following properties:

  • name
  • localName <- name within parent scope
  • staticVariables <- list of static variables
  • variables <- list of instance variables
  • computedVariables <- list of computed instance variables
  • storedVariables <- list of computed stored variables
  • inheritedTypes <- list of type names that this type implements / inherits
  • containedTypes <- list of types contained within this type
  • parentName <- list of parent type (for contained ones)

Enum types builts on top of regular types and adds:

  • rawType <- enum raw type
  • cases <- list of Enum.Case

Enum.Case provides:

  • name <- name
  • rawValue <- raw value
  • associatedValues <- list of AssociatedValue

Enum.Case.AssociatedValue provides:

  • name <- name
  • type <- type of associated value

Installing

Installation

Via CocoaPods If you're using CocoaPods, you can simply add pod 'Insanity' to your Podfile.

This will download the Insanity binaries and dependencies in Pods/. You just need to add $PODS_ROOT/Insanity/bin/Insanity in your Script Build Phases.

Manually You can clone it from the repo and just run Insanity.xcworkspace.

Usage

Insanity is a command line tool Insanity:

$ ./Insanity <source> <templates> <output>

Arguments:

  • source - Path to a source swift files.
  • templates - Path to templates. File or Directory.
  • output - Path to output. File or Directory.

Options:

  • --watch [default: false] - Watch template for changes and regenerate as needed. Only works with specific template path (not directory).
  • --verbose [default: false] - Turn on verbose logging for ignored entities

Contributing

Contributions to Insanity are welcomed and encouraged!

Please see the Contributing guide.

A list of contributors is available through GitHub.

To give clarity of what is expected of our community, Insanity has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and I think it articulates my values well. For more, see the Code of Conduct.

License

Insanity is available under the MIT license. See LICENSE for more information.

Attributions

This tool is powered by

Olivier Halligon pointed me to few of his setup scripts for CLI tools, very helpful, thank you!

Other Libraries / Tools

If you want to generate code for asset related logic, I highly recommend SwiftGen

Make sure to check my other libraries and tools, especially:

  • KZPlayground - Powerful playgrounds for Swift and Objective-C
  • KZFileWatchers - Daemon for observing local and remote file changes, used for building other developer tools (Insanity uses it)

You can follow me on twitter for news / updates about other projects I'm creating.