to_regexp 0.1.1 → 0.1.2

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/
+.yardoc/

data/CHANGELOG

@@ -0,0 +1,6 @@
+0.1.2 / 2013-02-13
+
+* Enhancements
+
+  * Start keeping CHANGELOG!
+  * add :detect option

data/Gemfile

@@ -1,7 +1,4 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Specify your gem's dependencies in to_regexp.gemspec
 gemspec
-
-# development dependencies
-gem 'ensure-encoding'

data/README.rdoc

@@ -11,7 +11,7 @@ You can also treat strings as literal regexps. These two are equivalent:
 
     '/foo/'.to_regexp                                       #=> /foo/
     'foo'.to_regexp(:literal => true)                       #=> /foo/
-    
+
 If you need case insensitivity and you're using <tt>:literal</tt>, pass options like <tt>:ignore_case</tt>. These two are equivalent:
 
     '/foo/i'.to_regexp                                      #=> /foo/i
@@ -21,4 +21,11 @@ You can get the options passed to <tt>Regexp.new</tt> with <tt>#as_regexp</tt>:
 
     '/foo/'.to_regexp == Regexp.new('/foo/'.as_regexp) # true
 
+Finally, you can be more lazy using <tt>:detect</tt>:
+
+    'foo'.to_regexp(detect: true)     #=> /foo/
+    'foo\b'.to_regexp(detect: true)   #=> %r{foo\\b}
+    '/foo\b/'.to_regexp(detect: true) #=> %r{foo\b}
+    'foo\b/'.to_regexp(detect: true)  #=> %r{foo\\b/}
+
 Copyright 2012 Seamus Abshere

data/Rakefile

@@ -11,15 +11,7 @@ end
 
 task :default => :test
 
-begin
-  require 'rake/rdoctask'
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.title = 'remote_table'
-    rdoc.options << '--line-numbers' << '--inline-source'
-    rdoc.rdoc_files.include('README*')
-    rdoc.rdoc_files.include('lib/**/*.rb')
-  end
-rescue LoadError
-   puts "Rdoc is not available"
+require 'yard'
+YARD::Rake::YardocTask.new do |y|
+  y.options << '--no-private'
 end

data/lib/to_regexp.rb

@@ -12,19 +12,32 @@ module ToRegexp
       '/' => '/',
     }
 
+    # Get a regexp back
+    #
+    # Without :literal or :detect, `"foo".to_regexp` will return nil. 
+    #
+    # @param [optional, Hash] options
+    # @option options [true,false] :literal Treat meta characters and other regexp codes as just text; always return a regexp
+    # @option options [true,false] :detect If string starts and ends with valid regexp delimiters, treat it as a regexp; otherwise, interpret it literally
+    # @option options [true,false] :ignore_case /foo/i
+    # @option options [true,false] :multiline /foo/m
+    # @option options [true,false] :extended /foo/x
+    # @option options [true,false] :lang /foo/[nesu]
     def to_regexp(options = {})
       if args = as_regexp(options)
         ::Regexp.new *args
       end
     end
-    
+
+    # Return arguments that can be passed to `Regexp.new`
+    # @see to_regexp
     def as_regexp(options = {})
       unless options.is_a?(::Hash)
         raise ::ArgumentError, "[to_regexp] Options must be a Hash"
       end
       str = self.strip
-      
-      if options[:literal] == true
+
+      if options[:literal] or (options[:detect] and REGEXP_DELIMITERS.none? { |k, v| str.start_with?(k) and str.end_with?(v) })
         content = ::Regexp.escape str
       elsif delim_set = REGEXP_DELIMITERS.detect { |k, v| str.start_with?(k) }
         delim_start, delim_end = delim_set.map { |delim| ::Regexp.escape delim }

data/lib/to_regexp/version.rb

@@ -1,3 +1,3 @@
 module ToRegexp
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/test_to_regexp.rb

@@ -121,4 +121,11 @@ class TestToRegexp < Test::Unit::TestCase
     assert_equal /(?-mix:dogs)|(?i-mx:cats)/, Regexp.union(/dogs/, '/cats/i')
     assert_equal %r{&|<|>|'|"|\/}.inspect, Regexp.union(*ESCAPE_HTML_KEYS).inspect
   end
+
+  def test_016_detect
+    assert_equal /foo/, 'foo'.to_regexp(detect: true)
+    assert_equal %r{foo\\b}, 'foo\b'.to_regexp(detect: true)
+    assert_equal %r{foo\b}, '/foo\b/'.to_regexp(detect: true)
+    assert_equal %r{foo\\b/}, 'foo\b/'.to_regexp(detect: true)
+  end
 end

data/to_regexp.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "to_regexp/version"
+require File.expand_path("../lib/to_regexp/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "to_regexp"
@@ -18,4 +17,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency 'ensure-encoding'
+  s.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_regexp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
-dependencies: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ensure-encoding
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides String#to_regexp, for example if you want to make regexps out
   of a CSV you just imported.
 email:
@@ -20,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - History.txt
 - README.rdoc
@@ -49,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: to_regexp
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Provides String#to_regexp