Giter VIP home page Giter VIP logo

yxtunsatisfiableconstraintsdetector's Introduction

YXTUnsatisfiableConstraintsDetector

CI Status

A debugging tool that catches unsatisfiable constraint errors as they appear at the console and provides call backs either directly to blocks or via NSNotificationCenter. This allows such errors to be handled at runtime.

This tool is intended for debugging only, and has not been designed for production-level performance.

Use cases

  • Highlighting constraint issues during development visually
  • Catching constraint problems during unit testing
  • Failing UI tests by killing the application on receipt of a constraint error.

Example Project

To run the example project, clone the repo, and run pod install from the Example directory first.

The example project shows a use of the detector to highlight UIViews with unsatisfiable constraints, displaying a red border on problem views.

Requirements

YXTUnsatisfiableConstraintsDetector supports projects for iOS 7 and above.

Installation

Manual Install

To install manually, copy the files under Pod/Classes into your project.

CocoaPods

YXTUnsatisfiableConstraintsDetector is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "YXTUnsatisfiableConstraintsDetector"

Usage

To import the detector into a given source file:

#import "YXTUnsatisfiableConstraintsDetector.h"

You can then instantiate an instance of YXTUnsatisfiableConstraintsDetector and add callback blocks using the registerBlock: method. When all your blocks are configured, call beginMonitoring to start listening for errors.

It is recommended to create a single instance of YXTUnsatisfiableConstraintsDetector in your AppDelegate's launch method, and to enclose this in a DEBUG check to ensure it is not called in release builds. For example, to register a callback that marks views with errors in red:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
#ifdef DEBUG
    YXTUnsatisfiableConstraintsDetector *detector = [[YXTUnsatisfiableConstraintsDetector alloc] init];
    [detector registerBlock:^(UIView *view){
        if(view != nil){
            dispatch_async(dispatch_get_main_queue(), ^(void){
                view.layer.borderColor = [UIColor redColor].CGColor;
                view.layer.borderWidth = 3.0;
            });
        }
    }];
    [detector beginMonitoring];
#endif
    return YES;
}

Note that view may be null if the problem UIView is not currently in the view hierarchy.

Author

Tom Elliott, [email protected]

License

YXTUnsatisfiableConstraintsDetector is available under the MIT license. See the LICENSE file for more info.

yxtunsatisfiableconstraintsdetector's People

Contributors

theothertomelliott avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.