regex 1.0.0 → 1.1.0

data/HISTORY

@@ -1,6 +1,23 @@
 = RELEASE HISTORY
 
-1.0.0 / 2010-02-10
+== 1.1.0 / 2010-10-12
+
+This release adds a detailed output option, and corrects
+a bug when using `--escape` with search and replace. It also
+entails a pretty extensive under-the-hood overhaul of the
+Extractor class. One consequence of this overhaul is that the
+`--unxml` option has been deprecated until such time that it can
+be reimplemented correctly.
+
+Changes:
+
+* Add --detail/-d output option.
+* Fix isssue using escape with search and replace.
+* Reimplement Extractor class.
+* Deprecate `--unxml` option until implementation can be worked out.
+
+
+== 1.0.0 / 2010-02-10
 
 Initial release of Regex. Regex is a simple
 commandline Regular Expression tool.

data/LICENSE

@@ -1,23 +1,204 @@
-The MIT License
-
-Copyright (c) 2009 Thomas Sawyer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
 

data/PACKAGE

@@ -0,0 +1,7 @@
+name    : regex
+date    : 2010-10-10
+version : 1.1.0
+
+requires:
+  - syckle (build)
+  - qed (test)

data/PROFILE

@@ -0,0 +1,20 @@
+--- 
+title  : Regex
+summary: Regex is a simple commmandline Regular Expression tool.
+created: 2006-05-09
+
+authors:
+  - Thomas Sawyer
+  - Tyler Rick
+
+description:
+  Regex is a simple commmandline Regular Expression tool,
+  that makes easy to search documents for content matches.
+
+resources:
+  homepage: http://proutils.github.com/regex
+  repository: git://github.com/proutils/regex.git
+  documentation: http://wiki.github.com/proutils/regex
+  development: http://github.com/proutils/regex
+  download: http://github.com/proutils/regex/downloads
+  mailinglist: http://groups.google.com/group/proutils/topics?hl=en

data/README

@@ -1,45 +1,100 @@
-= Regex ("Like a Knife")
+= Regex
+
+("Like a Knife")
 
-* home: http://proutils.github.com/regex
-* work: http://github.com/proutils/regex
 
 == DESCRIPTION
 
-Yea, I know what you are going to say. "I can do that with ___" Fill in the blank
+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
-Langauge 2.0 (read "post-Ruby"). What I want is a simaple commandline tool that
-given me quick access to a Regular Expression engine. No more, no less.
+"Langauge 2.0" (read "post-Ruby"). What I want is a simple command-line tool that
+gives me quick access to a Regular Expression engine. No more, no less.
 
-Now I could have written this too in Perl. I'm sure it would just as good, if not
+Now I could have written this in Perl. I'm sure it would just as good, if not
 better since Perl's Regualar Expression engine rocks, or so I hear. But Ruby's is
-pretty good too, and getting better (with 1.9+). And since I know Ruby very
-well. Well that's waht you get.
+pretty damn good too, and getting better (with 1.9+). And since I know Ruby very
+well. Well that's what you get.
+
+
+== RESOURCES
+
+* Home: http://rubyworks.github.com/regex
+* Code: http://github.com/rubyworks/regex
+
 
 == USAGE
 
-Okay, check it out. It's real simple. Supply a regular expression and a file to
-match upon to the +regex+ command.
+For detailed explication and examples of usage refer to the
+(User Docs){http://wiki.github.com/rubyworks/regex}, the
+(QED Docs){http://github.com/rubyworks/regex/docs/qed} and the
+(API Docs){http://github.com/rubyworks/regex/docs/api}.
+
+In brief, usage simply entails supplying a regular expression and a list of files
+to be searched to the +regex+ command.
+
+  $ regex '/=begin.*?\n(.*)\n=end/' sample.rb
+
+This example does exactly what you would expect --returns the content between
+the first <code>=begin ... =end</code> clause it comes across. To see all such
+block comments, as you would expect, you can use add <code>g</code> regular
+expression mode flag.
+
+  $ regex '/=begin.*?\n(.*)\n=end/g' sample.rb
+
+Alternatively you can use the <code>--repeat/--global/-g</code> option.
+
+  $ regex -g '/=begin.*?\n(.*)\n=end/' sample.rb
 
-  $ regex '=begin.*?\n(.*)=end' sample.txt
+Notice that in all these examples we have used single quotes to wrap the
+regular expression. This is to prevent the shell from expanding <code>*</code>
+and <code>?<code> marks.
 
-It does exactly what you think it would.
+By default +regex+ produces string output. Regular expression groups are delimited
+by ASCII 29 (035 1D) END OF GROUP, and repeat matches are delimited by
+ASCII character 30 (036 1E) END OF RECORD.
 
-Check out the <tt>--help</tt> and I'm sure the rest will come to you real quick.
+Instead of string output, +regex+ also supports YAML and JSON formats using the
+<code>--yaml/-y</code> and <code>--json/-j</code> options.
+
+  $ regex -y -g '/=begin.*?\n(.*)\n=end/' sample.rb
+
+In this case the returned matches are delimited using as an array of arrays.
+
+To get more information that just the match results use the <code>--detail/-d</code>
+option.
+
+Also, we can do without the the <code>/ /<code> deliminators on the regular
+expression if we use the <code>--search/-s</code> option instead. Going back to
+our first example:
+
+  $ regex -s '=begin.*?\n(.*)\n=end' sample.rb
+
+To replace text, use the <code>--replace/--r</code> option.
+
+  $ regex --yaml --repeat -s 'Tom' -r 'Bob' sample.rb
+
+This will replace every occurance of "Tom" with "Bob" in the <code>sample.rb</code>
+file. By default <code>regex</code> will backup any file it changes by adding a
+<code>.bak</code> extension to the original copy.
+
+Check out the <code>--help</code> and I am sure the rest will be smooth sailing.
 But it you want more information, then do us the good favor of jumping over
-to the <a href="http://proutils.github.com/regex">documentation wiki</a>.
+to the wiki[http://wiki.github.com/rubyworks/regex].
 
 == STATUS
 
-This is a very release. So don't expect every feature under the sun just yet, or
-that every detail is going to work peachy keen. But hey, if something needs fixing
-or a feature needs adding, well then get in there and send me a patch --open
-source software is built on *TEAM WORK*.
+This is a very early release. So don't expect every feature under the sun just yet,
+or that every detail is going to work peachy. But hey, if something needs fixing
+or a feature needs adding, well then get in there and send me a patch. Open
+source software is built on *TEAM WORK*, baby.
 
-And expect a potenial for rapid change here at the beginning.
+Expect a potenial for rapid change here at the beginning.
 
 == COPYRIGHT
 
 Copyright (c) 2010 Thomas Sawyer
 
-Regex is licensed under the terms of the MIT license.
+Regex is licensed under the terms of the Apache License, Version 2.0.
+
+See LICENSE file for details.
 

data/bin/regex

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require 'regex'
-Regex::Command.main(*ARGV)
+Regex.cli(*ARGV)

data/lib/regex.rb

@@ -1,236 +1,27 @@
-# = Text Extraction Class
-#
-# Extractor is was designed particulalry for extracting source code from embedded
-# comment blocks.
-#
-# Todo:
-#   - How can we handle embedded code in stadanrd comments? Eg. #
-#
-class Regex
-  VERSION = "1.1"
-
-  # When the regular expression return multiple groups,
-  # each is divided by the group deliminator.
-  # This is the default value.
-  DELIMINATOR_GROUP  = 29.chr + "\n"
-
-  # When using repeat mode, each match is divided by
-  # the record deliminator. This is the default value.
-  DELIMINATOR_RECORD = 30.chr + "\n"
-
-  require 'fileutils'
-  require 'open-uri'
-
-  require 'regex/string'
-  require 'regex/command'
-
-  # TODO: generalize to plugin
-  require 'regex/templates/common'
-
-  #
-  #attr_accessor :text
-
-  # Remove XML tags from search.
-  attr_accessor :unxml
-
-  # Regular expression.
-  attr_accessor :pattern
-
-  # Select built-in regular expression by name.
-  attr_accessor :template
-
-  # Index of expression return.
-  attr_accessor :index
-
-  # Ignore case.
-  attr_accessor :insensitive
-
-  # Repeat Match.
-  attr_accessor :repeat
-
-  # Output format.
-  attr_accessor :format
-
-  # DEPRECATE: Not needed anymore.
-  #def self.load(io, options={}, &block)
-  #  new(io, options, &block)
-  #end
-
-  # New extractor.
-  def initialize(io, options={})
-    @raw = (String === io ? io : io.read)
-    options.each do |k,v|
-      __send__("#{k}=", v)
-    end
-    yield(self) if block_given?
-  end
-
-  # Read file.
-  #def raw
-  #  @raw ||= open(@file) # File.read(@file)
-  #end
-
-  #--
-  # TODO: unxml is too primative, use real xml parser like nokogiri
-  #++
-  def text
-    @text ||= (
-      if unxml
-        raw.gsub!(/\<(.*?)\>/, '')
-      else
-        @raw
-      end
+module Regex
+  DIRECTORY = File.dirname(__FILE__)
+
+  # Access to PACAKGE metadata.
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(DIRECTORY + '/regex/package.yml'))
     )
   end
 
-  #
-  def regex
-    @regex ||= (
-      if template
-        TEMPLATES.const_get(template.upcase)
-      else
-        case pattern
-        when Regexp
-          pattern
-        when String
-          flags = []
-          flags << Regexp::MULTILINE
-          flags << Regexp::IGNORECASE if insensitive
-          Regexp.new(pattern, *flags)
-        end
-      end
-    )
-  end
-
-  #
-  def to_s(format=nil)
-    case format
-    when :yaml
-      to_s_yaml
-    when :json
-      to_s_json
-    else
-      out = structure
-      if repeat
-        out = out.map{ |m| m.join(deliminator_group) }
-        out = out.join(deliminator_record) #.chomp("\n") + "\n"
-      else
-        out = out.join(deliminator_group) #.chomp("\n") + "\n"
-      end
-      out
-    end
-  end
-
-  #
-  def to_s_yaml
-    require 'yaml'
-    structure.to_yaml
-  end
-
-  #
-  def to_s_json
-    begin
-      require 'json'
-    rescue LoadError
-      require 'json_pure' 
-    end
-    structure.to_json
-  end
-
-  # Structure the matchdata according to specified options.
-  def structure
-    repeat ? structure_repeat : structure_single
-  end
-
-  # Structure the matchdata for single match.
-  def structure_single
-    md = extract
-    if index
-      [md[index]]
-    elsif md.size > 1
-      md[1..-1]
-    else
-      [md[0]]
-    end
-  end
-
-  # Structure the matchdata for repeat matches.
-  def structure_repeat
-    out = extract
-    if index
-      out.map{ |md| [md[index]] }
-    else
-      out.map{ |md| md.size > 1 ? md[1..-1] : [md[0]] }
-    end
-  end
-
-  # Extract match from source text.
-  def extract
-    if repeat
-      extract_repeat
-    else
-      extract_single
-    end
+  # Need VRESION? You got it.
+  def self.const_missing(name)
+    package[name.to_s.downcase] || super(name)
   end
 
-  #
-  #def extract_single
-  #  out = []
-  #  if md = matchdata
-  #    if index
-  #      out << md[index]
-  #    elsif md.size > 1
-  #      out = md[1..-1] #.join(deliminator_group)
-  #    else
-  #      out = md
-  #    end
-  #  end
-  #  return out
-  #end
-
-  # Extract single match from source text.
-  def extract_single
-    md = regex.match(text)
-    md ? md : []
-  end
-
-  #
-  #def matchdata
-  #  regex.match(text)
-  #end
-
-  #
-  #def extract_repeat
-  #  out = []
-  #  text.scan(regex) do
-  #    md = $~
-  #    if index
-  #      out << [md[index]]
-  #    elsif md.size > 1
-  #      out << md[1..-1] #.join(deliminator_group)
-  #    else
-  #      out << md
-  #    end      
-  #  end
-  #  out #.join(deliminator_record)
-  #end
-
-  # Extract repeat matches from source text.
-  def extract_repeat
-    out = []
-    text.scan(regex) do
-      out << $~
-    end
-    out
+  # Shortcut to create a new Regex::Extractor instance.
+  def self.new(*io)
+    Extractor.new(*io)
   end
-
-  def deliminator_group
-    DELIMINATOR_GROUP
-  end
-
-  def deliminator_record
-    DELIMINATOR_RECORD
-  end
-
 end
 
+require 'regex/templates'
+require 'regex/extractor'
+require 'regex/replacer'
+require 'regex/command'
+