TextualRegexp 1.8.6

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-09-06
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/texrex
+lib/texrex.rb
+test/test_texrex.rb

data/README.txt

@@ -0,0 +1,83 @@
+TextualRegexp
+    by Ari Brown and Robert Kremme
+    http://texrex.rubyforge.com
+
+== DESCRIPTION:
+  
+And english-language wrapper for Regular Expressions - all of a sudden, they seem fun (hopefully)!
+
+== FEATURES/PROBLEMS:
+  
+Incompatible with 1.9, as far as we know. Technically, it supports everything current RegExp does.
+
+== SYNOPSIS:
+
+Password = TextualRegexp.new do
+  anchor :beginning
+
+  group :capture do
+    any :letter
+    repeat(4..13) do
+      any :char
+    end
+    any :digit
+  end
+end
+
+or 
+
+US_Phone = TextualRegexp.new do
+  group :capture do
+    maybe { literal "1"
+            literal "-"
+    }
+    any :of {
+      group { maybe { literal "(" }
+           repeat(3) { any :digit }
+           maybe { literal ")" }
+      }
+      group { repeat(3) { any :digit } }
+    }
+    literal "-"
+    repeat(3) { any :digit }
+    literal "-"
+    repeat(4) { any :digit }
+  end
+end
+
+You can even add them together:
+a = Password + US_Phone
+it returns a new TextualRegexp object.
+
+== REQUIREMENTS:
+
+Ruby 1.8
+
+== INSTALL:
+
+sudo gem install texrex
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 
+
+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.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/texrex.rb'
+
+Hoe.new('TextualRegexp', TextualRegexp::VERSION) do |p|
+  p.rubyforge_name = 'texrex'
+  p.author = 'Ari Brown and Robert Kremme'
+  p.email = 'ari [at] aribrown.com'
+  p.summary = 'An english wrapper for Regular Expressions'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/texrex.rb

@@ -0,0 +1,319 @@
+#!ruby
+
+# Written by Robert Klemme and (a little) Ari Brown
+
+class TextualRegexp
+
+  attr_reader :block
+
+  def initialize(flags = 0, &b)
+    @buffer = ""
+    @flags = flags
+    @groups = 0
+
+    if b
+      @block = b
+      instance_eval(&b)
+      finish
+    end
+  end
+
+  # construction
+
+=begin
+Include another TextualRegexp's code
+=end
+  def include(something)
+    instance_eval(something.block)
+  end
+
+=begin RDoc
+TextualRegexp.new + Regexp.new
+TextualRegexp.new + TextualRegexp.new
+=end  
+  def +(other)
+    if other.is_a?(Regexp)
+      g = self.rx
+      h = Regexp.new(g.source + other.source)
+    elsif other.is_a?(TextualRegexp)
+      self + other.rx
+    else
+      raise "Invalid Usage"
+    end
+  end
+
+=begin RDoc
+Matches a literal string.
+=end
+  def text(s)
+    update do
+      @buffer << Regexp.escape(s)
+    end
+  end
+
+  def regexp(s)
+    update do
+      @buffer << s
+    end
+  end
+
+  alias literal text
+
+  def case_insensitive(&b)
+    update do
+      @buffer << "(?i:"
+      instance_eval(&b)
+      @buffer << ")"
+    end
+  end
+
+  def case_sensitive(&b)
+    update do
+      @buffer << "(?-i:"
+      instance_eval(&b)
+      @buffer << ")"
+    end
+  end
+
+=begin RDoc
+Sets a group that gets captured
+=end
+  def group(mode=:non_capturing, &b)
+    update do
+      @buffer << "("
+      if mode == :capturing || mode == :capture
+        @groups += 1
+      else
+        @buffer << "?:"
+      end
+      instance_eval(&b)
+      @buffer << ")"
+    end
+  end
+
+=begin RDoc
+If a string is given, it's the equivalent of [sample].
+If an array is given, it will match any one of the fields in the array.
+If sample is nil, EXPLANATION
+=end  
+  def any(sample=nil, mode=:are, &b)
+    update do
+      sample = ("\w\\" + Regexp.escape("'_/;:-!@*()")) if sample == :char
+      sample = "0-9" if sample == :digit
+      sample = "a-zA-Z" if sample == :letter
+      case sample
+      when String
+        @buffer << "["
+        @buffer << "^" if mode == :not
+        @buffer << sample << "]"
+      when Array
+        @buffer << "(?:"
+        @buffer << "^" if mode == :not
+        @buffer << sample.join("|") << ")"
+      when nil, :of
+        @buffer << "(?:"
+        @buffer << "^" if mode == :not
+        @buffer << TxCollector.new(b).raw_rx << ")"
+      else
+        raise "Wrong usage"
+      end
+    end
+  end
+
+=begin RDoc
+If mode is set to :non_greedy (default), the block will match at least once. BETTER EXPLANATION NEEDED
+=end
+  def at_least_once(mode = :non_greedy, &b)
+    update do
+      instance_eval(&b)
+      @buffer << "+"
+      @buffer << "?" unless mode == :greedy
+    end
+  end
+
+=begin RDoc
+If mode is set to :non_greedy (default), the block will match at least zero times. BETTER EXPLANATION NEEDED
+=end  
+  def at_least_zero(mode = :non_greedy, &b)
+    update do
+      instance_eval(&b)
+      @buffer << "*"
+      @buffer << "?" unless mode == :greedy
+    end
+  end
+
+=begin RDoc
+The block will match either once or not at all (equivalent of '?')
+=end
+  def maybe(&b)
+    update do
+      instance_eval(&b)
+      @buffer << "?"
+    end
+  end
+
+=begin RDoc
+Repeats the block either spec times, or, if given a range (1..4), at least 1 and at most 4
+=end
+  def repeat(spec, &b)
+    update do
+      case spec
+      when 0
+        # ignore
+      when 1
+        # just once
+        instance_eval(&b)
+      when Integer
+        raise "Illegal negative" if spec < 0
+        instance_eval(&b)
+        @buffer << "{" << spec.to_s << "}"
+      when Range
+        instance_eval(&b)
+        @buffer << "{" << spec.first.to_s << ","
+        @buffer << (spec.exclude_end? ? spec.last.pred : spec.last).to_s
+        @buffer << "}"
+      else
+        raise "Wrong usage"
+      end
+    end
+  end
+
+=begin RDoc
+Sets an anchor to :beginning (\\A), :end (\\z), :word (\\b), or :eol and :end_of_line ($)
+=end
+  def anchor(where)
+    update do
+      @buffer << case where
+      when :beginning
+        "\\A"
+      when :end
+        "\\z"
+      when :word
+        "\\b"
+      when :eol, :end_of_line
+        "$"
+      else
+        raise "Illegal anchor #{where}"
+      end
+    end
+  end
+
+  def finish
+    @buffer.freeze
+    @rx = Regexp.new(@buffer, @flags)
+    freeze
+  end
+
+  # usage
+
+=begin RDoc
+Returns the equivalent RegExp object
+=end
+  def rx; @rx end
+
+  def groups; @groups end
+
+=begin RDoc
+Returns the raw RegExp code as a string
+=end
+  def raw_rx
+    @buffer
+  end
+
+  def to_s
+    rx.to_s
+  end
+
+=begin RDoc
+Scans self to s, and returns the matches made
+=end  
+  def scan(s, &b)
+    s.scan(rx, &b)
+  end
+
+  def split(s, &b)
+    s.split(rx, &b)
+  end
+
+=begin RDoc
+Matches self to s, returns the match if true, and false if false
+=end
+  def =~(s)
+    case s
+    when TextualRegexp
+      s.rx.match(self)
+    else
+      self.rx.match(s)
+    end
+  end
+
+=begin RDoc
+Matches self to s, returns true and false
+=end
+  def ===(s)
+    return true if self =~ s
+    return false
+  end
+
+=begin RDoc
+Captures all of the captured matches, which are accesible by their names
+=end
+
+  private
+  def update
+    raise "Immutable" if frozen?
+    yield
+    self
+  end
+
+  def collect_rx(b)
+    TxCollector.new(b).raw_rx
+  end
+
+  class TxCollector
+    def initialize(b)
+      @rx = []
+      instance_eval(&b)
+    end
+
+    def method_missing(*a,&b)
+      trx = TextualRegexp.new
+      trx.send(*a,&b)
+      @rx << trx
+      self
+    end
+
+    def raw_rx
+      @rx.map {|rx| rx.raw_rx}.join("|")
+    end
+  end
+end
+
+# simple test
+=begin
+mail_addr = TextualRegexp.new do
+  anchor :beginning
+
+  group :capture do
+    at_least_once { any "a-z" + "0-9" + "_" }
+  end
+
+  literal "@"
+
+  group :capture do
+    repeat 1..4 do
+      at_least_once { any "a-z" + "0-9" + "_" }
+      literal "."
+    end
+    any %w{com edu org}
+  end
+end
+
+puts mail_addr, mail_addr.rx, mail_addr.raw_rx
+puts
+puts mail_addr, mail_addr.raw_rx, mail_addr.rx.class
+
+mail_addr.scan "foobar@google.com" do |m|
+  p m
+end
+=end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: TextualRegexp
+version: !ruby/object:Gem::Version 
+  version: 1.8.6
+date: 2007-09-06 00:00:00 -04:00
+summary: An english wrapper for Regular Expressions
+require_paths: 
+- lib
+email: ari [at] aribrown.com
+homepage: "    by Ari Brown and Robert Kremme"
+rubyforge_project: texrex
+description: "== FEATURES/PROBLEMS:  Incompatible with 1.9, as far as we know. Technically, it supports everything current RegExp does.  == SYNOPSIS:  Password = TextualRegexp.new do anchor :beginning  group :capture do any :letter repeat(4..13) do any :char end any :digit end end"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Ari Brown and Robert Kremme
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/texrex
+- lib/texrex.rb
+- test/test_texrex.rb
+test_files: 
+- test/test_texrex.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- texrex
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: