RubyGems - regex - Versions diffs - 1.1.0 → 1.1.1 - Mend

regex 1.1.0 → 1.1.1

Files changed (24) hide show

@@ -0,0 +1,106 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "REGEX" "1" "October 2011" "" ""
+.
+.SH "NAME"
+\fBregex\fR \- regular expression tool
+.
+.SH "DESCRIPTION"
+Regex is a simple commmandline Regular Expression tool, that makes it easy to search documents for content matches\.
+.
+.P
+Yea, I know what you are going to say\. "I can do that with ____" Fill in the blank with +grep+, +awk+, +sed+, +perl+, etc\. But honestly, none of these tools are as straight forward and capable as one might want\. What is needed is a simple command\-line tool that gives quick access to a Regular Expression engine\. No more, no less\.
+.
+.P
+Now this could have written this in Perl\. No doubt, it would be just as good, if not better since Perl\'s Regualar Expression engine rocks (or so it is said)\. But Ruby\'s is pretty damn good too, and getting better (with 1\.9+)\. And since your humble author knows Ruby very well\.\.\.\. Well that\'s what you get\.
+.
+.SH "OPTIONS"
+The \fBregex\fR command line has the following options\.
+.
+.SS "Search Options"
+.
+.IP "\(bu" 4
+\fB\-s\fR, \fB\-\-search PATTERN\fR \- Search for this pattern\.
+.
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-template NAME\fR \- Use a built\-in regular expression (instead of \fB\-s\fR)\.
+.
+.IP "\(bu" 4
+\fB\-i\fR, \fB\-\-insensitive\fR \- Case insensitive matching\.
+.
+.IP "\(bu" 4
+\fB\-m\fR, \fB\-\-multiline\fR \- Multiline matching\.
+.
+.IP "\(bu" 4
+\fB\-g\fR, \fB\-\-global\fR \- Global search\. By default regex only searches for the first match\. Use the global option to search for all matches\.
+.
+.IP "\(bu" 4
+\fB\-e\fR, \'\-\-escape\' \- Make all patterns verbatim string matchers\.
+.
+.IP "\(bu" 4
+\fB\-n\fR, \fB\-\-index INT\fR \- Return a specific match index\.
+.
+.IP "\(bu" 4
+\fB\-R\fR, \fB\-\-recursive\fR \- Search though subdirectories recursively\.
+.
+.IP "\(bu" 4
+\fB\-y\fR, \fB\-\-yaml\fR \- Output in YAML format\.
+.
+.IP "\(bu" 4
+\fB\-j\fR, \fB\-\-json\fR \- Output in JSON format\.
+.
+.IP "\(bu" 4
+\fB\-d\fR, \fB\-\-detail\fR \- Provide match details\.
+.
+.IP "" 0
+.
+.SS "Replace Options"
+.
+.IP "\(bu" 4
+\fB\-r\fR, \fB\-\-replace TEXT\fR \- Replace matching pattern with the given text\.
+.
+.IP "\(bu" 4
+\fB\-b\fR, \fB\-\-backup\fR \- Backup any files that are changed\.
+.
+.IP "" 0
+.
+.SS "Special Options"
+.
+.IP "\(bu" 4
+\fB\-\-[no\-]ansi\fR \- Toggle ansi color\.
+.
+.IP "\(bu" 4
+\fB\-\-debug\fR \- Run in debug mode\.
+.
+.IP "\(bu" 4
+\fB\-h\fR, \fB\-\-help\fR \- Display this lovely help message\.
+.
+.IP "" 0
+.
+.SH "OUTPUT"
+Regex has three output modes\. YAML, JSON and standard text\. The standard text output is unique in that it utilizes special ASCII characters to separate matches and regex groups\. ASCII 29, called the \fIrecord separator\fR, is used to separate repeat matches\. ASCII 30, called the \fIgroup separator\fR, is is used to separate regular expression groups\.
+.
+.SH "EXAMPLES"
+The following example returns the content between the first \fB=begin \.\.\. =end\fR clause it comes across\.
+.
+.P
+$ regex \'/=begin\.\fI?\en(\.\fR)\en=end/\' sample\.rb
+.
+.P
+Instead of the first argument being the regular expresion, we can use the \fB\-s\fR option\. This exampe finds the first line starting with a Q\.
+.
+.P
+$ regex \-s \' sample\.txt
+.
+.P
+This example would replace all words starting with an X with an A in all \.txt files in the current directory\.
+.
+.P
+$ regex \-g \-s \'\ebX\' \-r \'A\' *\.txt
+.
+.SH "COPYRIGHTS"
+Copyright (c) 2009 Thomas Sawyer, Rubyworks
+.
+.P
+Regex is distributable in accordance with the terms of the BSD\-2\-Clause license\.

data/man/man1/regex.1.html ADDED

@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>regex(1) - regular expression tool</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#OUTPUT">OUTPUT</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#COPYRIGHTS">COPYRIGHTS</a>
+    </div>
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>regex(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>regex(1)</li>
+  </ol>
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>regex</code> - <span class="man-whatis">regular expression tool</span>
+</p>
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p>Regex is a simple commmandline Regular Expression tool, that makes it easy
+to search documents for content matches.</p>
+<p>Yea, I know what you are going to say. "I can do that with ____" Fill in the blank
+with +grep+, +awk+, +sed+, +perl+, etc. But honestly, none of these tools are
+as straight forward and capable as one might want. What is needed is a simple
+command-line tool that gives quick access to a Regular Expression engine.
+No more, no less.</p>
+<p>Now this could have written this in Perl. No doubt, it would be just as good, if
+not better since Perl's Regualar Expression engine rocks (or so it is said).
+But Ruby's is pretty damn good too, and getting better (with 1.9+). And since
+your humble author knows Ruby very well.... Well that's what you get.</p>
+<h2 id="OPTIONS">OPTIONS</h2>
+<p>The <code>regex</code> command line has the following options.</p>
+<h3 id="Search-Options">Search Options</h3>
+<ul>
+<li><p><code>-s</code>, <code>--search PATTERN</code> - Search for this pattern.</p></li>
+<li><p><code>-t</code>, <code>--template NAME</code> - Use a built-in regular expression (instead of <code>-s</code>).</p></li>
+<li><p><code>-i</code>, <code>--insensitive</code> - Case insensitive matching.</p></li>
+<li><p><code>-m</code>, <code>--multiline</code> - Multiline matching.</p></li>
+<li><p><code>-g</code>, <code>--global</code> - Global search. By default regex only searches for the
+ first match. Use the global option to search for all matches.</p></li>
+<li><p><code>-e</code>, '--escape' - Make all patterns verbatim string matchers.</p></li>
+<li><p><code>-n</code>, <code>--index INT</code> - Return a specific match index.</p></li>
+<li><p><code>-R</code>, <code>--recursive</code> - Search though subdirectories recursively.</p></li>
+<li><p><code>-y</code>, <code>--yaml</code> - Output in YAML format.</p></li>
+<li><p><code>-j</code>, <code>--json</code> - Output in JSON format.</p></li>
+<li><p><code>-d</code>, <code>--detail</code> - Provide match details.</p></li>
+</ul>
+<h3 id="Replace-Options">Replace Options</h3>
+<ul>
+<li><p><code>-r</code>, <code>--replace TEXT</code> - Replace matching pattern with the given text.</p></li>
+<li><p><code>-b</code>, <code>--backup</code> - Backup any files that are changed.</p></li>
+</ul>
+<h3 id="Special-Options">Special Options</h3>
+<ul>
+<li><p><code>--[no-]ansi</code> - Toggle ansi color.</p></li>
+<li><p><code>--debug</code> - Run in debug mode.</p></li>
+<li><p><code>-h</code>, <code>--help</code> - Display this lovely help message.</p></li>
+</ul>
+<h2 id="OUTPUT">OUTPUT</h2>
+<p>Regex has three output modes. YAML, JSON and standard text. The standard
+text output is unique in that it utilizes special ASCII characters
+to separate matches and regex groups. ASCII 29, called the <em>record separator</em>,
+is used to separate repeat matches. ASCII 30, called the <em>group separator</em>, is
+is used to separate regular expression groups.</p>
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<p>The following example returns the content between the first <code>=begin ... =end</code>
+clause it comes across.</p>
+<p>  $ regex '/=begin.<em>?\n(.</em>)\n=end/' sample.rb</p>
+<p>Instead of the first argument being the regular expresion, we can use the <code>-s</code>
+option. This exampe finds the first line starting with a Q.</p>
+<p>  $ regex -s '<sup>Q'</sup> sample.txt</p>
+<p>This example would replace all words starting with an X with an A in all .txt
+files in the current directory.</p>
+<p>  $ regex -g -s '\bX' -r 'A' *.txt</p>
+<h2 id="COPYRIGHTS">COPYRIGHTS</h2>
+<p>Copyright (c) 2009 Thomas Sawyer, Rubyworks</p>
+<p>Regex is distributable in accordance with the terms of the BSD-2-Clause license.</p>
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2011</li>
+    <li class='tr'>regex(1)</li>
+  </ol>
+  </div>
+</body>
+</html>

data/man/man1/regex.1.ronn ADDED

@@ -0,0 +1,97 @@
+regex(1) - regular expression tool
+==================================
+## DESCRIPTION
+Regex is a simple commmandline Regular Expression tool, that makes it easy
+to search documents for content matches.
+Yea, I know what you are going to say. "I can do that with ____" Fill in the blank
+with +grep+, +awk+, +sed+, +perl+, etc. But honestly, none of these tools are
+as straight forward and capable as one might want. What is needed is a simple
+command-line tool that gives quick access to a Regular Expression engine.
+No more, no less.
+Now this could have written this in Perl. No doubt, it would be just as good, if
+not better since Perl's Regualar Expression engine rocks (or so it is said).
+But Ruby's is pretty damn good too, and getting better (with 1.9+). And since
+your humble author knows Ruby very well.... Well that's what you get.
+## OPTIONS
+The `regex` command line has the following options.
+### Search Options
+  * `-s`, `--search PATTERN` - Search for this pattern.
+  * `-t`, `--template NAME` - Use a built-in regular expression (instead of `-s`).
+  * `-i`, `--insensitive` - Case insensitive matching.
+  * `-m`, `--multiline` - Multiline matching.
+  * `-g`, `--global` - Global search. By default regex only searches for the
+     first match. Use the global option to search for all matches.
+  * `-e`, '--escape' - Make all patterns verbatim string matchers.
+  * `-n`, `--index INT` - Return a specific match index.
+  * `-R`, `--recursive` - Search though subdirectories recursively.
+  * `-y`, `--yaml` - Output in YAML format.
+  * `-j`, `--json` - Output in JSON format.
+  * `-d`, `--detail` - Provide match details.
+### Replace Options
+  * `-r`, `--replace TEXT` - Replace matching pattern with the given text.
+  * `-b`, `--backup` - Backup any files that are changed.
+### Special Options
+  * `--[no-]ansi` - Toggle ansi color.
+  * `--debug` - Run in debug mode.
+  * `-h`, `--help` - Display this lovely help message.
+## OUTPUT
+Regex has three output modes. YAML, JSON and standard text. The standard
+text output is unique in that it utilizes special ASCII characters
+to separate matches and regex groups. ASCII 29, called the *record separator*,
+is used to separate repeat matches. ASCII 30, called the *group separator*, is
+is used to separate regular expression groups.
+## EXAMPLES
+The following example returns the content between the first `=begin ... =end`
+clause it comes across.
+  $ regex '/=begin.*?\n(.*)\n=end/' sample.rb
+Instead of the first argument being the regular expresion, we can use the `-s`
+option. This exampe finds the first line starting with a Q.
+  $ regex -s '^Q' sample.txt
+This example would replace all words starting with an X with an A in all .txt
+files in the current directory.
+  $ regex -g -s '\bX' -r 'A' *.txt
+## COPYRIGHTS
+Copyright (c) 2009 Thomas Sawyer, Rubyworks
+Regex is distributable in accordance with the terms of the BSD-2-Clause license.

data/qed/00_intro.rdoc ADDED

	@@ -0,0 +1,2 @@
1	+ = Regex
2	+

data/qed/cli/applique/env.rb ADDED

@@ -0,0 +1,19 @@
+require 'regex'
+When 'Given a file (((\S+))) containing' do |file, text|
+  File.open(file, 'w'){ |f| f << text }
+end
+When 'invoking the command' do |text|
+  text = text.sub(/^\$\s+/, '')
+  @out = `#{text}`
+end
+When 'Should produce' do |text|
+  @out.strip.assert == text.strip
+end
+When 'result in a new file (((\S+))) containing' do |file, text|
+  File.read(file).strip.assert == text.strip
+end

data/qed/cli/replace.rdoc ADDED

@@ -0,0 +1,26 @@
+== Search and Replace on Files
+Given a file a.txt containing:
+  This is file a.txt.
+  This is an example.
+And given a file b.txt containing:
+  This is file b.txt.
+  This is another example.
+Then invoking the command:
+  $ regex -s example -r EXAMPLE a.txt b.txt
+Should result in a new file a.txt containing:
+  This is file a.txt.
+  This is an EXAMPLE.
+And should result in a new file b.txt containing:
+  This is file b.txt.
+  This is another EXAMPLE.

data/qed/cli/search.rdoc ADDED

@@ -0,0 +1,31 @@
+== Searching Files
+Given a file a.txt containing:
+  This is file a.txt.
+  This is an example.
+And given a file b.txt containing:
+  This is file b.txt.
+  This is another example.
+Then invoking the command:
+  $ regex -s example a.txt b.txt
+Should produce:
+  example
+In this case it found the first match and returned it.
+To handle a global search we add the `-g` flag.
+Invoking the command:
+  $ regex -g -s example a.txt b.txt
+Will give a more complex result.
+  @out.assert == "example\036\nexample\n"