<commit_before>//
//  NSStringMask.h
//  NSStringMask
//
//  Created by <NAME> on 4/17/13.
//  Copyright (c) 2013 FlavioCaetano. All rights reserved.
//

@import Foundation;


/** [![NSStringMask Version](http://cocoapod-badges.herokuapp.com/v/NSStringMask/badge.png)](http://cocoadocs.org/docsets/NSStringMask) [![NSStringMask Platforms](http://cocoapod-badges.herokuapp.com/p/NSStringMask/badge.svg)](http://cocoadocs.org/docsets/NSStringMask) [![Build Status](https://travis-ci.org/fjcaetano/NSStringMask.png)](https://travis-ci.org/fjcaetano/NSStringMask)
 
 The NSStringMask enables you to apply _masks_ or _formats_ to NSStrings using NSRegularExpression to input your format.
 
 Suppose you want to format a Social Security Number "12345678", its regex is "(\\d{3})-(\\d{2})-(\\d{3})". You can easily format it using:
 
    NStringMask maskString:@"12345678" withPattern:@"(\\d{3})-(\\d{2})-(\\d{3})"];
 
    // result: "123-45-678"
 
 @note In [this link](https://gist.github.com/fjcaetano/5600452) you'll find a list with some common patterns. Feel free to improve it!
 
 @warning When passing a pattern or regex, at least one capturing parentheses `[group]` must be informed. This is because NSStringMask will only format the expressions within groups.  This way, if you have a pattern "`\d`" the formatting won't replace any numbers because in its understanding, that's part of the mask, and not a "replacing regex".
 
 @warning Always remember to use double slashes to escape the pattern's special characters!
 */
@interface NSStringMask : NSObject

/// @name Properties

/** A placeholder to be used to fill voids in an incomplete string.
 
 Can be nil, but not empty. If an empty placeholder is given, it's assumed as nil. The placeholder will repeat for each capturing parentheses `[group]` in the regex, so, if the placeholder is a long string, it'll restart the filling for each group.
 
 No formatting is done when _placeholder_ is nil and the passed string is shorter than expected. In this case, the formatting will returned a clean string without unexpected characters.
 <commit_msg>Umbrella import<commit_after>//
//  NSStringMask.h
//  NSStringMask
//
//  Created by <NAME> on 4/17/13.
//  Copyright (c) 2013 FlavioCaetano. All rights reserved.
//

@import Foundation;

// This file is also the umbrella header
#import "UITextFieldMask.h"


/** [![NSStringMask Version](http://cocoapod-badges.herokuapp.com/v/NSStringMask/badge.png)](http://cocoadocs.org/docsets/NSStringMask) [![NSStringMask Platforms](http://cocoapod-badges.herokuapp.com/p/NSStringMask/badge.svg)](http://cocoadocs.org/docsets/NSStringMask) [![Build Status](https://travis-ci.org/fjcaetano/NSStringMask.png)](https://travis-ci.org/fjcaetano/NSStringMask)
 
 The NSStringMask enables you to apply _masks_ or _formats_ to NSStrings using NSRegularExpression to input your format.
 
 Suppose you want to format a Social Security Number "12345678", its regex is "(\\d{3})-(\\d{2})-(\\d{3})". You can easily format it using:
 
    NStringMask maskString:@"12345678" withPattern:@"(\\d{3})-(\\d{2})-(\\d{3})"];
 
    // result: "123-45-678"
 
 @note In [this link](https://gist.github.com/fjcaetano/5600452) you'll find a list with some common patterns. Feel free to improve it!
 
 @warning When passing a pattern or regex, at least one capturing parentheses `[group]` must be informed. This is because NSStringMask will only format the expressions within groups.  This way, if you have a pattern "`\d`" the formatting won't replace any numbers because in its understanding, that's part of the mask, and not a "replacing regex".
 
 @warning Always remember to use double slashes to escape the pattern's special characters!
 */
@interface NSStringMask : NSObject

/// @name Properties

/** A placeholder to be used to fill voids in an incomplete string.
 
 Can be nil, but not empty. If an empty placeholder is given, it's assumed as nil. The placeholder will repeat for each capturing parentheses `[group]` in the regex, so, if the placeholder is a long string, it'll restart the filling for each group.
 
 No formatting is done when _placeholder_ is nil and the passed string is shorter than expected. In this case, the formatting will returned a clean string without unexpected characters.
 
{'fraction_non_alphanumeric': 0.1130841121495327, 'fraction_numerical': 0.02149532710280374, 'mean_word_length': 4.220731707317073, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4022230', 'n_tokens_mistral': 1399, 'n_tokens_neox': 1204, 'n_words': 488}