verbal 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 526bba90d57ec2d0d460252bee24f7068b531f39
+  data.tar.gz: 53190021c432f71d10c9f9f50e80176d20bedf42
+SHA512:
+  metadata.gz: d8fe772702fed5ec96203b6bcdcad4e46c9d1d7c8c898fd0d9a76cfd22f5608ac983f0381b17cd1951e0e27d9062576b44af64939050af70dd42feed047ed2ce
+  data.tar.gz: b2ff2540cdb9dc558d539b2a04a403ddcf028e4b3e92db27005e5bddbed83c6be144f9e48a32f491c9847172a8da24dff82eef5a771aa9ba2857421c414b348e

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+LICENSE
+README.md

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rspec',   '~> 2.14'
+  gem 'bundler', '~> 1.3'
+  gem 'jeweler', '~> 1.8'
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    yard (0.8.6.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  jeweler (~> 1.8)
+  rspec (~> 2.14)
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Ryan Endacott, Jiunn Haur Lim
+
+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/README.md

@@ -0,0 +1,69 @@
+Verbal
+=====================
+[![Build Status](https://travis-ci.org/jimjh/verbal.png?branch=master)](https://travis-ci.org/jimjh/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).
+
+## Installation
+
+```sh
+$> gem install verbal
+```
+
+```ruby
+require 'verbal'
+```
+
+## Examples
+
+Here's a couple of simple examples to give an idea of how Verbal works:
+
+### Testing if we have a valid URL
+
+```ruby
+# Create an example of how to test for correctly formed URLs
+tester = Verbal.new do
+  start_of_line
+  find 'http'
+  maybe 's'
+  find '://'
+  maybe 'www.'
+  anything_but ' '
+  end_of_line
+end
+
+# Create an example URL
+test_url = "https://www.google.com"
+
+# Use it just like a regular Ruby regex:
+puts 'Hooray!  It works!' if tester.match(test_url)
+puts 'This works too!' if tester =~ test_url
+
+# Print the generated regex:
+puts tester.source # => /^(?:http)(s)?(?::\/\/)(www\.)?([^\ ]*)$/i
+```
+
+### Replacing strings
+
+```ruby
+# Create a test string
+replace_me = "Replace bird with a duck"
+
+# Create an expression that seeks for word "bird"
+expression = Verbal.new { find 'bird' }
+
+# Execute the expression like a normal Regexp object
+result = replace_me.gsub( expression, "duck" );
+
+puts result # Outputs "Replace duck with a duck"
+```
+
+## Issues
+ - I haven't yet ported the modifier code because Ruby Regexp handles modifiers a little differently.
+
+## Thanks!
+Thank you to @jehna for coming up with the awesome original idea.
+
+Thank you to @ryan-endacott for the original port.

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = 'verbal'
+  gem.summary = %Q{Library that makes difficult regular expressions easy!}
+  gem.description = %Q{Verbal Expressions is a library that makes constructing difficult regular expressions simple and easy!}
+  gem.authors = ['Ryan Endacott', 'Jim Lim']
+  gem.email   = 'jim@jimjh.com'
+  gem.homepage = 'http://github.com/jimjh/verbal'
+  gem.platform = Gem::Platform::RUBY
+  gem.license  = 'MIT'
+  gem.has_rdoc = 'yard'
+  gem.files.include 'LICENSE', 'VERSION', 'README.md', '.yardopts', 'Rakefile'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/verbal.rb

@@ -0,0 +1,184 @@
+# Ruby Verbal Expressions, based on the awesome JavaScript repo by @jehna.
+#
+# @see https://github.com/jehna/VerbalExpressions   Original idea
+# @see https://github.com/jimjh/verbal              Main repository
+class Verbal < Regexp
+
+  # @example Create a new RegExp
+  #     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
+    instance_eval(&block)
+    super(@prefixes + @source + @suffixes, @modifiers)
+  end
+
+  # Matches an exact string.
+  # @param [String] value     string to match
+  # @example Replace all dots with the word "Stop".
+  #   paragraph = "Lorem. Dolor."
+  #   verbal    = Verbal.new do
+  #     find '.'
+  #   end
+  #   paragraph.gsub(verbal, 'Stop') # => "Lorem Stop Dolor Stop"
+  def find(value)
+    append "(?:#{sanitize value})"
+  end
+
+  # Marks the expression to start at the beginning of a line.
+  # @example Add a hyphen to the beginning of each line.
+  #   lines = "first\nsecond\nthird"
+  #   verbal = Verbal.new do
+  #     start_of_line
+  #   end
+  #   lines.gsub(verbal, '- ') # => "- first\n- second\n- third"
+  def start_of_line
+    @prefixes = '^'
+  end
+
+  # Marks the expression to end at the last character of a line.
+  # @example Add a hyphen to the end of each line.
+  #   lines = "first\nsecond\nthird"
+  #   verbal = Verbal.new do
+  #     end_of_line
+  #   end
+  #   lines.gsub(verbal, '- ') # => "first- \nsecond- \nthird"
+  def end_of_line
+    @suffixes = '$'
+  end
+
+  # Add a string to the expression that might appear once.
+  # @param [String] value   the string to look for
+  # @example Find http or https.
+  #   Verbal.new do
+  #     find 'http'
+  #     maybe 's'
+  #   end
+  def maybe(value)
+    append "(#{sanitize value})?"
+  end
+
+  # Matches any character any number of times.
+  # @example Match the entire string.
+  #   Verbal.new do
+  #     anything
+  #   end
+  def anything
+    append '(.*)'
+  end
+
+  # Matches any number of any character that is not in +value+.
+  # @example Match everything except underscores.
+  #   Verbal.new do
+  #     anything_but '_'
+  #   end
+  # @param [String] value       characters to excluded
+  def anything_but(value)
+    append "([^#{sanitize value}]*)"
+  end
+
+  # Adds a universal line break expression.
+  # @example Converts all line breaks to unix-style with \<br\> tag.
+  #   lorem = "Lorem.\r\nDolor\namet."
+  #   verbal = Verbal.new do
+  #     line_break
+  #   end
+  #   lorem.gsub(veral, "<br>\n") # => "Lorem.<br>\nDolor<br>\namet."
+  def line_break
+    append '(\n|(\r\n))'
+  end
+  alias_method :br, :line_break
+
+  # Matches the tab character.
+  # @example Find the tab character.
+  #   "\n\t" =~ Verbal.new { tab | # => 1
+  def tab
+    append '\t'
+  end
+
+  # Matches a word, which is a continuous chunk of any alphanumeric character.
+  # @example Split a sentence into words.
+  #   s = "this is a sentence"
+  #   s.scan Verbal.new { word } # => ["this", "is", "a", "sentence"]
+  def word
+    append '\w+'
+  end
+
+  # Matches any one of the characters in +value+.
+  # @param [String] value     string of characters to match
+  # @example Find one of 'abc' in 'xkcd'
+  #   verbal = Verbal.new do
+  #     any_of 'abc'
+  #   end
+  #   'xkcd'.scan verbal # => ['c']
+  def any_of(value)
+    append "[#{sanitize value}]"
+  end
+  alias_method :any, :any_of
+
+  # Matches a character from the given range.
+  # @param [Array] args    alternate starting and ending characters.
+  # @example Find any character in the alphabet.
+  #   verbal = Verbal.new do
+  #     range 'a', 'z', 'A', 'Z'
+  #   end
+  def range(*args)
+    value = "["
+    args.each_slice(2) do |from, to|
+      from = sanitize(from)
+      to = sanitize(to)
+      value += "#{from}-#{to}"
+    end
+    value += "]"
+    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
+  def multiple(value)
+    value = sanitize value
+    value += '+' unless %w[+ *].include? value[-1]
+    append value
+  end
+
+  # Adds a alternative expression to be matched.
+  # @example Tests if the string begins with 'http://' or 'ftp://'
+  #   link = 'ftp://ftp.google.com/';
+  #   verbal = Verbal.new do
+  #     find 'http'
+  #     maybe 's'
+  #     find '://'
+  #     otherwise
+  #     find 'ftp://'
+  #   end
+  #   link =~ verbal # => 0
+  def otherwise(value = nil)
+    @prefixes += "(" unless @prefixes.include?("(")
+    @suffixes = ")" + @suffixes unless @suffixes.include?(")")
+    append(")|(")
+    find(value) if value
+  end
+
+  private
+
+    # Escapes +value+ so that it can be used in a regular expression.
+    def sanitize(value)
+      case value
+      when Regexp then value.source
+      else Regexp.escape value
+      end
+    end
+
+    # Appends +value+ to the regex source.
+    def append(value = '')
+      @source += value
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'verbal'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/verbal_spec.rb

@@ -0,0 +1,68 @@
+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
+      Verbal.new do
+        start_of_line
+        find 'http'
+        maybe 's'
+        find '://'
+        maybe 'www.'
+        anything_but ' '
+        end_of_line
+      end
+    end
+
+    it 'successfully builds regex for matching URLs' do
+      matcher.source.should == "^(?:http)(s)?(?:://)(www\\.)?([^\\ ]*)$"
+    end
+
+    it 'matches regular http URL' do
+      matcher.match('http://google.com').should be_true
+    end
+
+    it 'matches https URL' do
+      matcher.match('https://google.com').should be_true
+    end
+
+    it 'matches a URL with www' do
+      matcher.match('https://www.google.com').should be_true
+    end
+
+    it 'fails to match when URL has a space' do
+      matcher.match('http://goo gle.com').should be_false
+    end
+
+    it 'fails to match with htp:// is malformed' do
+      matcher.match('htp://google.com').should be_false
+    end
+  end
+end

data/verbal.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "verbal"
+  s.version = "0.1.1"
+
+  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.description = "Verbal Expressions is a library that makes constructing difficult regular expressions simple and easy!"
+  s.email = "jim@jimjh.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".travis.yml",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/verbal.rb",
+    "spec/spec_helper.rb",
+    "spec/verbal_spec.rb",
+    "verbal.gemspec"
+  ]
+  s.homepage = "http://github.com/jimjh/verbal"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.2"
+  s.summary = "Library that makes difficult regular expressions easy!"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<bundler>, ["~> 1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: verbal
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ryan Endacott
+- Jim Lim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Verbal Expressions is a library that makes constructing difficult regular
+  expressions simple and easy!
+email: jim@jimjh.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/verbal.rb
+- spec/spec_helper.rb
+- spec/verbal_spec.rb
+- verbal.gemspec
+homepage: http://github.com/jimjh/verbal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Library that makes difficult regular expressions easy!
+test_files: []