verbal 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 526bba90d57ec2d0d460252bee24f7068b531f39
-  data.tar.gz: 53190021c432f71d10c9f9f50e80176d20bedf42
+  metadata.gz: be46d2de1760f8493f75fdde627b054376a2409c
+  data.tar.gz: 3a1e75bb4a2cda4f31134ac0021e7677c421b8cc
 SHA512:
-  metadata.gz: d8fe772702fed5ec96203b6bcdcad4e46c9d1d7c8c898fd0d9a76cfd22f5608ac983f0381b17cd1951e0e27d9062576b44af64939050af70dd42feed047ed2ce
-  data.tar.gz: b2ff2540cdb9dc558d539b2a04a403ddcf028e4b3e92db27005e5bddbed83c6be144f9e48a32f491c9847172a8da24dff82eef5a771aa9ba2857421c414b348e
+  metadata.gz: 8000d9253dd50b1a40cbad16284f1ceb1646a200e36bda1550bfdaf0839f50659de938d21228d56c98f531d2cec2a3d5cea78aa0b3aff26c7f859dd5dadb9d00
+  data.tar.gz: fce342144f71b2725d898bb36b092e74bc94a6ed309dff8625748c58d166c8df43002e66b4eef3dcc0aef9a9ae6a7739657823ed73d0b281d75d7dd6f27cedc5

data/README.md

@@ -1,10 +1,12 @@
 Verbal
 =====================
 [![Build Status](https://travis-ci.org/jimjh/verbal.png?branch=master)](https://travis-ci.org/jimjh/verbal)
+[![Gem Version](https://badge.fury.io/rb/verbal.png)](http://badge.fury.io/rb/verbal)
 
 ## Overview
 Verbal is a Ruby library that helps to construct difficult regular expressions.
 It's ported from the awesome JavaScript [VerbalExpressions](https://github.com/jehna/VerbalExpressions).
+Detailed documentation is available at [rubydoc](http://rubydoc.info/gems/verbal/frames).
 
 ## Installation
 
@@ -60,6 +62,21 @@ result = replace_me.gsub( expression, "duck" );
 puts result # Outputs "Replace duck with a duck"
 ```
 
+### Capturing strings
+
+```ruby
+# create expression
+verbal = Verbal.new do
+  capture { anything }
+  find /\sby\s/
+  capture { anything }
+end
+# match against test string
+data = verbal.match('this is it by michael jackson')
+puts data[1] # >> 'this is it'
+puts data[2] # >> 'michael jackson'
+```
+
 ## Issues
  - I haven't yet ported the modifier code because Ruby Regexp handles modifiers a little differently.
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/verbal.rb

@@ -5,16 +5,16 @@
 class Verbal < Regexp
 
   # @example Create a new RegExp
-  #     verbal = Verbal.new do
-  #       start_of_line
-  #       find 'x'
-  #     end
-  #     verbal =~ 'x' # => 0
+  #   verbal = Verbal.new do
+  #     start_of_line
+  #     find 'x'
+  #   end
+  #   verbal =~ 'x' # => 0
   def initialize(&block)
-    @prefixes = ""
-    @source   = ""
-    @suffixes = ""
-    @modifiers = "" # TODO: Ruby Regexp option flags
+    @prefixes = ''
+    @source   = ''
+    @suffixes = ''
+    @modifiers = '' # TODO: Ruby Regexp option flags
     instance_eval(&block)
     super(@prefixes + @source + @suffixes, @modifiers)
   end
@@ -53,6 +53,32 @@ class Verbal < Regexp
     @suffixes = '$'
   end
 
+  # Marks the expression to start at the beginning of the string.
+  # @example Matching the entire string
+  #   verbal = Verbal.new do
+  #     start_of_string
+  #     find 'dinosaur'
+  #     end_of_string
+  #   end
+  #   verbal.match('dinosaur')  # matches
+  #   verbal.match('a dinosaur') # does not match
+  def start_of_string
+    @prefixes = '\A' + @prefixes
+  end
+
+  # Marks the expression to start at the end of the string.
+  # @example Matching the entire string
+  #   verbal = Verbal.new do
+  #     start_of_string
+  #     find 'dinosaur'
+  #     end_of_string
+  #   end
+  #   verbal.match('dinosaur')  # matches
+  #   verbal.match('dinosaurs') # does not match
+  def end_of_string
+    @suffixes += '\z'
+  end
+
   # Add a string to the expression that might appear once.
   # @param [String] value   the string to look for
   # @example Find http or https.
@@ -61,7 +87,7 @@ class Verbal < Regexp
   #     maybe 's'
   #   end
   def maybe(value)
-    append "(#{sanitize value})?"
+    append "(?:#{sanitize value})?"
   end
 
   # Matches any character any number of times.
@@ -70,7 +96,7 @@ class Verbal < Regexp
   #     anything
   #   end
   def anything
-    append '(.*)'
+    append '(?:.*)'
   end
 
   # Matches any number of any character that is not in +value+.
@@ -80,7 +106,7 @@ class Verbal < Regexp
   #   end
   # @param [String] value       characters to excluded
   def anything_but(value)
-    append "([^#{sanitize value}]*)"
+    append "(?:[^#{sanitize value}]*)"
   end
 
   # Adds a universal line break expression.
@@ -91,7 +117,7 @@ class Verbal < Regexp
   #   end
   #   lorem.gsub(veral, "<br>\n") # => "Lorem.<br>\nDolor<br>\namet."
   def line_break
-    append '(\n|(\r\n))'
+    append '(?:\n|(?:\r\n))'
   end
   alias_method :br, :line_break
 
@@ -139,13 +165,19 @@ class Verbal < Regexp
     append value
   end
 
-  # Matches multiple of +value+. Defaults to one or many. You can specify zero
-  # or more by suffixing +value+ with +'*'+.
-  # @param [String] value     string to match
+  # Matches one or many of value.
+  # @param [String|Regexp] value     string to match
+  # @example Matching multiples of "xyz"
+  #   verbal = Verbal.new { multiple 'xyz' }
+  #   verbal.match('this is xyzxyz')[0] # => 'xyzxyz'
+  # @example Matching multiples of /[xyz]/
+  #   verbal = Verbal.new { multiple /[xyz]/ }
+  #   verbal.match('abcxxyz')[0] # => 'xxyz'
   def multiple(value)
-    value = sanitize value
-    value += '+' unless %w[+ *].include? value[-1]
-    append value
+    append case value
+    when Regexp then "(#{value.source})+"
+    else "(#{sanitize value})+"
+    end
   end
 
   # Adds a alternative expression to be matched.
@@ -160,12 +192,26 @@ class Verbal < Regexp
   #   end
   #   link =~ verbal # => 0
   def otherwise(value = nil)
-    @prefixes += "(" unless @prefixes.include?("(")
-    @suffixes = ")" + @suffixes unless @suffixes.include?(")")
-    append(")|(")
+    @prefixes += "(?:"
+    @suffixes = ")" + @suffixes
+    append(")|(?:")
     find(value) if value
   end
 
+  # Captures the nested regular expression.
+  # @example Capture the title of the concert and performer
+  #   verbal = Verbal.new do
+  #     capture { anything }
+  #     find /\sby\s/
+  #     capture { anything }
+  #   end
+  #   data = verbal.match('this is it by michael jackson')
+  #   data[1] # => 'this is it'
+  #   data[2] # => 'michael jackson'
+  def capture(&block)
+    append "(#{Verbal.new(&block).source})"
+  end
+
   private
 
     # Escapes +value+ so that it can be used in a regular expression.

data/spec/anything_but_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Verbal, '#anythingBut' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find  'http'
+      anything_but 's:.?'
+    end
+  end
+
+  its(:source) { should eq '(?:http)(?:[^s:\.\?]*)' }
+
+  it 'matches a string without a suffix' do
+    (verbal =~ 'http').should eq 0
+  end
+
+  it 'matches a string with a suffix' do
+    verbal.match('whttps://')[0].should eq 'http'
+  end
+
+end
+
+

data/spec/anything_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Verbal, '#anything' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find  'http'
+      anything
+    end
+  end
+
+  its(:source) { should eq '(?:http)(?:.*)' }
+
+  it 'matches a string without a suffix' do
+    (verbal =~ 'http').should eq 0
+  end
+
+  it 'matches a string with a suffix' do
+    verbal.match('whttps://')[0].should eq 'https://'
+  end
+
+end
+
+

data/spec/capture_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Verbal, '#capture' do
+
+  subject { verbal }
+  let(:verbal) do
+    Verbal.new do
+      capture { anything }
+      find ' by '
+      capture { anything }
+    end
+  end
+  let(:string) { 'this is it by michael jackson' }
+
+  it { should match string }
+
+  context 'matched data' do
+    subject { verbal.match string }
+    its([1]) { should eq 'this is it' }
+    its([2]) { should eq 'michael jackson' }
+  end
+
+end
+

data/spec/end_of_line_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Verbal, '#end_of_line' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find 'x'
+      end_of_line
+    end
+  end
+
+  its(:source) { should eq '(?:x)$' }
+
+  it 'matches a string at the end of a line' do
+    (verbal =~ 'zyx').should eq 2
+  end
+
+end
+

data/spec/end_of_string_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Verbal, '#end_of_string' do
+
+  subject { verbal }
+  let(:verbal) do
+    Verbal.new do
+      find 'cat'
+      end_of_string
+    end
+  end
+
+  its(:source) { should eq '(?:cat)\z' }
+  it { should match 'cat' }
+  it { should_not match 'cats' }
+
+end
+

data/spec/find_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Verbal, '#find' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find 'lions? yup.'
+    end
+  end
+
+  its(:source) { should eq '(?:lions\?\ yup\.)' }
+
+  it 'matches a string at the correct position' do
+    (verbal =~ 'are these lions? yup...').should eq 10
+  end
+
+end
+

data/spec/line_break_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Verbal, '#line_break' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find  'this'
+      line_break
+      find 'that'
+    end
+  end
+
+  its(:source) { should eq '(?:this)(?:\n|(?:\r\n))(?:that)' }
+
+  it 'matches a string correctly' do
+    verbal.match("this\nthat and w")[0].should eq "this\nthat"
+  end
+
+end
+
+

data/spec/maybe_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Verbal, '#maybe' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      find  'http'
+      maybe 's'
+    end
+  end
+
+  its(:source) { should eq '(?:http)(?:s)?' }
+
+  it 'matches a string without the value' do
+    (verbal =~ 'http').should eq 0
+  end
+
+  it 'matches a string with the value' do
+    (verbal =~ 'https').should eq 0
+  end
+
+end
+

data/spec/multiple_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Verbal, '#multiple' do
+
+  subject { verbal }
+
+  context 'string' do
+    let(:verbal) { Verbal.new { multiple 'zk.+' } }
+    its(:source) { should eq '(zk\.\+)+' }
+    it 'matches multiples of the given value' do
+      (verbal =~ 'whereiszk.+zk.+zk.+qw').should eq 7
+    end
+  end
+
+  context 'regex' do
+    let(:verbal) { Verbal.new { multiple(/[xyz]u/) } }
+    its(:source) { should eq '([xyz]u)+' }
+    it 'matches multiples of the given value' do
+      verbal.match('this is xuxuyuzu')[0].should eq 'xuxuyuzu'
+    end
+  end
+
+end
+
+
+

data/spec/otherwise_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Verbal, '#otherwise' do
+
+  subject { verbal }
+  let(:verbal) do
+    Verbal.new do
+      find 'http'
+      maybe 's'
+      find '://'
+      otherwise
+      maybe 's'
+      find 'ftp://'
+    end
+  end
+
+  it { should match 'http://' }
+  it { should match 'https://' }
+  it { should match 'ftp://' }
+  it { should match 'sftp://' }
+
+end
+

data/spec/range_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Verbal, '#range' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      range 'a', 'z', '0', '9'
+      find 'that'
+    end
+  end
+
+  its(:source) { should eq '[a-z0-9](?:that)' }
+
+  it 'matches a string correctly' do
+    (verbal =~ 'W9that').should eq 1
+  end
+
+end
+
+
+

data/spec/start_of_line_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Verbal, '#start_of_line' do
+
+  subject { verbal }
+
+  let(:verbal) do
+    Verbal.new do
+      start_of_line
+      find 'x'
+    end
+  end
+
+  its(:source) { should eq '^(?:x)' }
+
+  it 'matches a string at the beginning' do
+    (verbal =~ 'xyz').should eq 0
+  end
+
+end
+

data/spec/start_of_string_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Verbal, '#start_of_string' do
+
+  subject { verbal }
+  let(:verbal) do
+    Verbal.new do
+      start_of_string
+      find 'cat'
+    end
+  end
+
+  its(:source) { should eq '\A(?:cat)' }
+  it { should match 'cat' }
+  it { should_not match 'a cat' }
+
+end
+

data/spec/verbal_spec.rb

@@ -2,31 +2,6 @@ require 'spec_helper'
 
 describe Verbal do
 
-  describe '#find' do
-
-    let(:matcher) do
-      Verbal.new do
-        find 'lions'
-      end
-    end
-
-    it 'should correctly build find regex' do
-      matcher.source.should == '(?:lions)'
-    end
-
-    it 'should correctly match find' do
-      matcher.match('lions').should be_true
-    end
-
-    it 'should match part of a string with find' do
-      matcher.match('lions, tigers, and bears, oh my!').should be_true
-    end
-
-    it 'should only match the `find` part of a string' do
-      matcher.match('lions, tigers, and bears, oh my!')[0].should == 'lions'
-    end
-  end
-
   describe 'URL Regex Test' do
 
     let(:matcher) do
@@ -42,7 +17,7 @@ describe Verbal do
     end
 
     it 'successfully builds regex for matching URLs' do
-      matcher.source.should == "^(?:http)(s)?(?:://)(www\\.)?([^\\ ]*)$"
+      matcher.source.should == "^(?:http)(?:s)?(?:://)(?:www\\.)?(?:[^\\ ]*)$"
     end
 
     it 'matches regular http URL' do

data/verbal.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "verbal"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Endacott", "Jim Lim"]
-  s.date = "2013-07-25"
+  s.date = "2013-07-26"
   s.description = "Verbal Expressions is a library that makes constructing difficult regular expressions simple and easy!"
   s.email = "jim@jimjh.com"
   s.extra_rdoc_files = [
@@ -27,7 +27,20 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/verbal.rb",
+    "spec/anything_but_spec.rb",
+    "spec/anything_spec.rb",
+    "spec/capture_spec.rb",
+    "spec/end_of_line_spec.rb",
+    "spec/end_of_string_spec.rb",
+    "spec/find_spec.rb",
+    "spec/line_break_spec.rb",
+    "spec/maybe_spec.rb",
+    "spec/multiple_spec.rb",
+    "spec/otherwise_spec.rb",
+    "spec/range_spec.rb",
     "spec/spec_helper.rb",
+    "spec/start_of_line_spec.rb",
+    "spec/start_of_string_spec.rb",
     "spec/verbal_spec.rb",
     "verbal.gemspec"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verbal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryan Endacott
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -86,7 +86,20 @@ files:
 - Rakefile
 - VERSION
 - lib/verbal.rb
+- spec/anything_but_spec.rb
+- spec/anything_spec.rb
+- spec/capture_spec.rb
+- spec/end_of_line_spec.rb
+- spec/end_of_string_spec.rb
+- spec/find_spec.rb
+- spec/line_break_spec.rb
+- spec/maybe_spec.rb
+- spec/multiple_spec.rb
+- spec/otherwise_spec.rb
+- spec/range_spec.rb
 - spec/spec_helper.rb
+- spec/start_of_line_spec.rb
+- spec/start_of_string_spec.rb
 - spec/verbal_spec.rb
 - verbal.gemspec
 homepage: http://github.com/jimjh/verbal