Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos & grammar in README #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed typos & grammar in README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 32 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ ReverseRegex

[![Build Status](https://travis-ci.org/icomefromthenet/ReverseRegex.png)](https://travis-ci.org/icomefromthenet/ReverseRegex)

Use Regular Expressions to generate text strings can be used in the following situations:
Using Regular Expressions to generate text strings can be used in the following situations:

1. Wrting test data for web forms.
1. Writing test data for web forms.
2. Writing test data for databases.
3. Generating test data for regular expressions.
3. Generating test data for regular expressions.


##Example
Expand Down Expand Up @@ -48,6 +48,8 @@ auinmymonl
dujyzuhoag
vaygybwkfm
```


#### Other examples

1. [Australian phone numbers](https://github.com/icomefromthenet/ReverseRegex/blob/master/examples/ausphone.php)
Expand All @@ -57,7 +59,7 @@ vaygybwkfm

##Installing

To install use composer
To install, use Composer:

```json
{
Expand All @@ -66,14 +68,17 @@ To install use composer
}
}
```


## Writing a Regex

1. Escape all meta-characters i.e. if you need to escape the character in a regex you will need to escape here.
2. Not all meta-characters are suppported see list below.
3. Use `\X{####}` to specify unicode value use `[\X{####}-\X{####}]` to specify range.
4. Unicdoe `\p` not supported, I could not find a port of [UCD](http://www.unicode.org/ucd/) to php, maybe in the future support be added.
5. Quantifiers are applied to left most group, literal or character class.
6. Beware of the `+` and `*` quantifers they apply a possible maxium number of occurances up to `PHP_INT_MAX`.
1. Escape all meta-characters, i.e. if you need to escape the character in a regex, you will need to escape it here.
2. Not all meta-characters are suppported, see the list below.
3. Use `\X{####}` to specify a Unicode value; use `[\X{####}-\X{####}]` to specify a range.
4. Unicode `\p` is not supported, I could not find a port of [UCD](http://www.unicode.org/ucd/) to PHP, maybe in the future support will be added.
5. Quantifiers are applied to the leftmost group, literal or character class.
6. Beware of the `+` and `*` quantifiers, they apply a possible maximum number of occurences up to `PHP_INT_MAX`.


### Regex Support

Expand All @@ -89,55 +94,55 @@ To install use composer
Resulting String
</th>
</tr>

<tr>
<td> (abcf) </td> <td> Support literals this would generate string </td> <td>`abcf`</td>
<td> (abcf) </td> <td> Support literals, this would generate a string </td> <td>`abcf`</td>
</tr>
<tr>
<td> \((abcf)\) </td> <td> Escape meta characters as you normally would in a regex </td> <td>`(abcf)`</td>
<td> \((abcf)\) </td> <td> Escape meta-characters as you normally would in a regex </td> <td>`(abcf)`</td>
</tr>
<tr>
<td> [a-z] </td> <td> Character Classes are supported </td> <td>`a`</td>
<td> [a-z] </td> <td> Character Classes are supported </td> <td>`a`</td>
</tr>
<tr>
<td> a{5} </td> <td> Quantifiers supported always <strong>last</strong> group or literal or character class </td> <td>`aaaaa`</td>
<td> a{5} </td> <td> Quantifiers always support the <strong>last</strong> group or literal or character class </td> <td>`aaaaa`</td>
</tr>
<tr>
<td> a{1,5} </td> <td> Range Quantifiers supported</td> <td>`aa`</td>
<td> a{1,5} </td> <td> Range Quantifiers are supported</td> <td>`aa`</td>
</tr>
<tr>
<td> a|b|c </td> <td> Alternation supported pick one of three at random </td> <td>`b`</td>
<td> a|b|c </td> <td> Alternation is supported, pick one of the three at random </td> <td>`b`</td>
</tr>
<tr>
<td> a|(y|d){5} </td> <td> Groups supported with alternation and quantifiers </td> <td>`ddddd` or `a` or `yyyyy` </td>
<td> a|(y|d){5} </td> <td> Groups are supported with alternation and quantifiers </td> <td>`ddddd` or `a` or `yyyyy` </td>
</tr>
<tr>
<tr>
<td> \d </td> <td> Digit shorthand equ [0-9] </td> <td>`1`</td>
<td> \d </td> <td> Digit shorthand equ [0-9] </td> <td>`1`</td>
</tr>
<tr>
<td> \w </td><td> word character shorthand equ [a-zA-Z0-9_] </td> <td>`j`</td>
<td> \w </td><td> Word character shorthand equ [a-zA-Z0-9_] </td> <td>`j`</td>
</tr>
<tr>
<td> \W </td><td>Non word character shorthand equ [^a-zA-Z0-9_] </td> <td>`j`</td>
<td> \W </td><td>Non-word character shorthand equ [^a-zA-Z0-9_] </td> <td>`j`</td>
</tr>
<tr>
<td> \s </td><td>White space shorthand ASCII only </td> <td>` `</td>
<td> \s </td><td>White space shorthand ASCII only </td> <td>` `</td>
</tr>
<tr>
<td> \S </td><td>Non White space shorthand ASCII only </td> <td>`i`</td>
<td> \S </td><td>Non-white space shorthand ASCII only </td> <td>`i`</td>
</tr>
<tr>
<td> . </td><td>Dot all ASCII characters </td> <td>`$`</td>
<td> . </td><td>Dot all ASCII characters </td> <td>`$`</td>
</tr>
<tr>
<td> * + ? </td><td>Short hand quantifiers, recommend not use them </td> <td> </td>
<td> * + ? </td><td>Shorthand quantifiers, it is recommended not to use them </td> <td> </td>
</tr>
<tr>
<td> \X{00FF}[\X{00FF}-\X{00FF}] </td><td>Unicode ranges</td> <td> </td>
<td> \X{00FF}[\X{00FF}-\X{00FF}] </td><td>Unicode ranges</td> <td> </td>
</tr>
<tr>
<td> \xFF[\xFF-\xFF] </td><td> Hex ranges</td> <td> </td>
<td> \xFF[\xFF-\xFF] </td><td> Hex ranges</td> <td> </td>
</tr>
</table>

Expand Down