https://github.com/yext/yxtunsatisfiableconstraintsdetector

A utility for detecting unsatisfiable constraint errors and calling back to allow automated runtime handling.
https://github.com/yext/yxtunsatisfiableconstraintsdetector

Last synced: 9 months ago
JSON representation

A utility for detecting unsatisfiable constraint errors and calling back to allow automated runtime handling.

• Host: GitHub
• URL: https://github.com/yext/yxtunsatisfiableconstraintsdetector
• Owner: yext
• License: mit
• Created: 2016-02-04T13:52:06.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-17T15:40:59.000Z (almost 3 years ago)
• Last Synced: 2024-12-25T00:45:58.301Z (over 1 year ago)
• Language: Objective-C
• Size: 52.7 KB
• Stars: 5
• Watchers: 14
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# YXTUnsatisfiableConstraintsDetector

[![CI Status](https://img.shields.io/travis/yext/YXTUnsatisfiableConstraintsDetector.svg?style=flat)](https://travis-ci.org/yext/YXTUnsatisfiableConstraintsDetector)

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](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

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, telliott@yext.com

## License

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