list_matcher 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 621a7ac90f1ec09b2b73fd4b233f16953c0e958e
-  data.tar.gz: e8512d9fb2232a7951ee8cad6608eb082675ece6
+  metadata.gz: 34630b608a56f9a22605ff55956ed8da7793ed73
+  data.tar.gz: 160a5e81d4c9e3bbd0ba2a516e97a0ec9048d27f
 SHA512:
-  metadata.gz: 8042b06b05edacc8ecceb31ac2057c14333c4a84c6c09f83f52858368e8733a7081dfc60c2afc7775fd3b62337c79b07afd96938fdf701fc9722a6d241d74a86
-  data.tar.gz: fcade9f49ae41f514cf8078766932068c3dc44d0cb0f53b5cedbad55c6f4e689828f8650828c58e3935d75015eab784f90edd6e286caae32eff76086e92ae475
+  metadata.gz: 5a1523c2c3a36424bd76ba465345466993404c4e3b3e4e531b7ca2b9ea3765e392567df809f188af3bcb2ab8f58d1fe8c21b1dae3eed1087133f9d68767b922e
+  data.tar.gz: 917e5620134c0726880ba789db20bfe39f850ce11493d2cea17f690bbc5501ec18f5c66f72e41c8b745051e1776c341f86a8805c4e74b48db6486061c8706dc9

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
     $ gem install list_matcher
 
-## Usage
+## Synopsis
 
 ```ruby
 require 'list_matcher'
@@ -36,6 +36,16 @@ puts m.pattern %w( cat catalog )                           # (?:cat(?:alog)?)
 puts m.pattern (1..31).to_a                                # (?:[4-9]|1\d?|2\d?|3[01]?)
 ```
 
+## Usage
+
+One provides a list of expressions to match and perhaps some options and receives in turn either a
+compiled `Regexp` or a string from which such a regex can be compiled. The `rx` method provides a compiled
+regex and `pattern`, a string. The latter is chiefly useful when composing a larger regex out of smaller
+pieces.
+
+The options one may provide to `List::Matcher` are all validated. Any errors cause it to raise a
+`List::Matcher::Error` exception.
+
 ## Description
 
 `List::Matcher` facilitates generating efficient regexen programmatically. This is useful, for example, when looking for

data/lib/list_matcher/version.rb

@@ -1,3 +1,3 @@
 module ListMatcher
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/list_matcher.rb

@@ -5,6 +5,9 @@ module List
     attr_reader :atomic, :backtracking, :bound, :case_insensitive, :strip, :left_bound, 
       :right_bound, :word_test, :normalize_whitespace, :multiline, :name, :vet, :not_extended
 
+    # a special exception class for List::Matcher
+    class Error < ::StandardError; end
+
     # convenience method for one-off regexen where there's no point in keeping
     # around a pattern generator
     def self.pattern(list, opts={})
@@ -44,9 +47,12 @@ module List
       @normalize_whitespace = normalize_whitespace
       @vet                  = vet
       if name
-        raise "" unless name.is_a?(String) || name.is_a?(Symbol)
-        if Regexp.new "(?<#{name}>.*)"   # stir up any errors that might arise from using this name in a named capture
+        raise Error, "name must be a string or symbol" unless name.is_a?(String) || name.is_a?(Symbol)
+        begin
+          Regexp.new "(?<#{name}>.*)"   # stir up any errors that might arise from using this name in a named capture
           @name = name
+        rescue
+          raise Error, "#{name} does not work as the name of a named group"
         end
       end
       case bound
@@ -70,7 +76,7 @@ module List
           @left_bound  = '\b'
           @right_bound = '\b'
         else
-          raise "unfamiliar value for :bound option: #{bound.inspect}"
+          raise Error, "unfamiliar value for :bound option: #{bound.inspect}"
         end
         if /_left/ === bound.to_s
           @right_bound = nil
@@ -78,15 +84,25 @@ module List
           @left_bound = nil
         end
       when Hash
-        @word_test   = bound[:test] || raise('no boundary test provided')
+        @word_test   = bound[:test] || raise( Error, 'no boundary test provided' )
         @left_bound  = bound[:left]
         @right_bound = bound[:right]
-        raise 'neither bound provided' unless @left_bound || @right_bound
+        raise Error, 'neither bound provided' unless @left_bound || @right_bound
+        raise Error, 'test must be Regexp or String' unless @word_test.is_a?(Regexp) || @word_test.is_a?(String)
+        @word_test = Regexp.new @word_test unless @word_test.is_a?(Regexp)
+        [ @left_bound, @right_bound ].compact.each do |b|
+          raise Error, 'bounds must be strings' unless b.is_a?(String)
+          begin
+            Regexp.new b
+          rescue
+            raise Error, "bad boundary pattern: #{b}"
+          end
+        end
       else
-        raise "unfamiliar value for :bound option: #{bound.inspect}"
+        raise Error, "unfamiliar value for :bound option: #{bound.inspect}"
       end
       symbols.keys.each do |k|
-        raise "symbols variable #{k} is neither a string, a symbol, nor a regex" unless k.is_a?(String) || k.is_a?(Symbol) || k.is_a?(Regexp)
+        raise Error, "symbols variable #{k.inspect} is neither a string, a symbol, nor a regex" unless k.is_a?(String) || k.is_a?(Symbol) || k.is_a?(Regexp)
       end
       if normalize_whitespace
         @symbols[' '] = { pattern: '\s++' }
@@ -342,7 +358,7 @@ module List
             c = ( max += 1 ).chr
             sp = if opts.is_a? Hash
               pat = opts.delete :pattern
-              raise "variable #{var} requires a pattern" unless pat || var.is_a?(Regexp)
+              raise Error, "symbol #{var} requires a pattern" unless pat || var.is_a?(Regexp)
               pat ||= var.to_s
               SpecialPattern.new engine, c, var, pat, **opts
             elsif opts.is_a? String
@@ -350,7 +366,7 @@ module List
             elsif var.is_a?(Regexp) && opts.nil?
               SpecialPattern.new engine, c, var, nil
             else
-              raise "variable #{var} requires a pattern"
+              raise Error, "symbol #{var} requires a pattern"
             end
             ar << sp
           end
@@ -375,7 +391,7 @@ module List
           begin
             Regexp.new s.pat
           rescue
-            raise SyntaxError.new "the symbol #{s.var} has an ill-formed pattern: #{s.pat}"
+            raise Error, "the symbol #{s.symbol} has an ill-formed pattern: #{s.pat}"
           end
         end
       end
@@ -440,8 +456,8 @@ module List
       attr_accessor :engine, :optional, :symbols, :root
 
       def initialize(engine, symbols)
-        @engine = engine
-        @symbols = symbols
+        @engine   = engine
+        @symbols  = symbols
         @children = []
       end
 
@@ -507,15 +523,16 @@ module List
     end
 
     class SpecialPattern < Node
-      attr_accessor :char, :var, :left, :right, :pat
+      attr_accessor :char, :var, :left, :right, :pat, :symbol
       def initialize(engine, char, var, pat, atomic: (var.is_a?(Regexp) && pat.nil?), word_left: false, word_right: false)
         super(engine, nil)
-        @char = char
-        @var = var.is_a?(String) || var.is_a?(Symbol) ? Regexp.new(Regexp.quote(var.to_s)) : var
-        @pat = pat || var.to_s
+        @char   = char
+        @symbol = var.to_s
+        @var    = var.is_a?(String) || var.is_a?(Symbol) ? Regexp.new(Regexp.quote(var.to_s)) : var
+        @pat    = pat || var.to_s
         @atomic = !!atomic
-        @left = !!word_left
-        @right = !!word_right
+        @left   = !!word_left
+        @right  = !!word_right
       end
 
       def dup

data/test/basic_test.rb

@@ -276,7 +276,7 @@ class BasicTest < Minitest::Test
   end
 
   def test_vetting_bad
-    assert_raises SyntaxError do
+    assert_raises List::Matcher::Error do
       List::Matcher.pattern %w(cat), symbols: { foo: '+' }, vet: true
     end
   end

data/test/exception_test.rb

@@ -0,0 +1,83 @@
+require "minitest/autorun"
+
+require "list_matcher"
+
+class ExceptionTest < Minitest::Test
+
+  def test_bad_symbol
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), symbols: { foo: nil }
+    end
+    assert_equal 'symbol foo requires a pattern', e.message
+  end
+
+  def test_bad_name
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), name: []
+    end
+    assert_equal 'name must be a string or symbol', e.message
+  end
+
+  def test_bad_bound_symbol
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), bound: :foo
+    end
+    assert_equal 'unfamiliar value for :bound option: :foo', e.message
+  end
+
+  def test_bad_bound_no_test
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), bound: { left: '.' }
+    end
+    assert_equal 'no boundary test provided', e.message
+  end
+
+  def test_bad_bound_neither
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), bound: { test: '.' }
+    end
+    assert_equal 'neither bound provided', e.message
+  end
+
+  def test_bad_bound_strange_test
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), bound: { test: [], left: '.' }
+    end
+    assert_equal 'test must be Regexp or String', e.message
+  end
+
+  def test_bad_bound_not_string
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), bound: { test: /./, left: [] }
+    end
+    assert_equal 'bounds must be strings', e.message
+  end
+
+  def test_bad_symbol_no_pattern
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), symbols: { foo: {} }
+    end
+    assert_equal 'symbol foo requires a pattern', e.message
+  end
+
+  def test_bad_group_name
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), name: '3'
+    end
+    assert_equal '3 does not work as the name of a named group', e.message
+  end
+
+  def test_bad_symbol_key
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), symbols: { [] => 'foo' }
+    end
+    assert_equal 'symbols variable [] is neither a string, a symbol, nor a regex', e.message
+  end
+
+  def test_vetting
+    e = assert_raises List::Matcher::Error do
+      List::Matcher.pattern %w(cat), symbols: { foo: '++' }, vet: true
+    end
+    assert_equal 'the symbol foo has an ill-formed pattern: ++', e.message
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: list_matcher
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - dfhoughton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,6 +57,7 @@ files:
 - test/basic_test.rb
 - test/benchmarks.rb
 - test/doc_test.rb
+- test/exception_test.rb
 - test/stress.rb
 homepage: https://github.com/dfhoughton/list_matcher
 licenses:
@@ -86,4 +87,5 @@ test_files:
 - test/basic_test.rb
 - test/benchmarks.rb
 - test/doc_test.rb
+- test/exception_test.rb
 - test/stress.rb