regexp-examples 0.3.1 → 0.3.2

data/lib/regexp-examples/constants.rb

@@ -1,6 +1,12 @@
 module RegexpExamples
-  # Number of times to repeat for Star and Plus repeaters
-  TIMES = 2
+  # The maximum variance for any given repeater, to prevent a huge/infinite number of
+  # examples from being listed. For example, if MaxRepeaterVariance = 2 then:
+  # .* is equivalent to .{0,2}
+  # .+ is equivalent to .{1,3}
+  # .{2,} is equivalent to .{2,4}
+  # .{,3} is equivalent to .{0,2}
+  # .{3,8} is equivalent to .{3,5}
+  MaxRepeaterVariance = 2
 
   # Maximum number of characters returned from a char set, to reduce output spam
   # For example:
@@ -9,14 +15,13 @@ module RegexpExamples
   MaxGroupResults = 5
 
   module CharSets
-    Lower = Array('a'..'z')
-    Upper = Array('A'..'Z')
-    Digit = Array('0'..'9')
-    # 45.chr = "-". Need to make sure this is at the START of the array, or things break
-    # This is because of the /[a-z]/ regex syntax, and how it's being parsed
-    Punct = [45..45, 33..44, 46..47, 58..64, 91..96, 123..126].map { |r| r.map { |val| val.chr } }.flatten
-    Hex   = Array('a'..'f') | Array('A'..'F') | Digit
-    Any   = Lower | Upper | Digit | Punct
+    Lower      = Array('a'..'z')
+    Upper      = Array('A'..'Z')
+    Digit      = Array('0'..'9')
+    Punct      = [33..47, 58..64, 91..96, 123..126].map { |r| r.map { |val| val.chr } }.flatten
+    Hex        = Array('a'..'f') | Array('A'..'F') | Digit
+    Whitespace = [' ', "\t", "\n", "\r", "\v", "\f"]
+    Any        = Lower | Upper | Digit | Punct
   end
 
   # Map of special regex characters, to their associated character sets
@@ -25,8 +30,8 @@ module RegexpExamples
     'D' => CharSets::Lower | CharSets::Upper | CharSets::Punct,
     'w' => CharSets::Lower | CharSets::Upper | CharSets::Digit | ['_'],
     'W' => CharSets::Punct.reject { |val| val == '_' },
-    's' => [' ', "\t", "\n", "\r", "\v", "\f"],
-    'S' => CharSets::Any - [' ', "\t", "\n", "\r", "\v", "\f"],
+    's' => CharSets::Whitespace,
+    'S' => CharSets::Any - CharSets::Whitespace,
     'h' => CharSets::Hex,
     'H' => CharSets::Any - CharSets::Hex,
 

data/lib/regexp-examples/groups.rb

@@ -53,9 +53,16 @@ module RegexpExamples
       last = nil
       first = @chars.shift if @chars.first == "-"
       last = @chars.pop if @chars.last == "-"
-      # Replace all instances of e.g. ["a" "-" "z"] with ["a", "b", ..., "z"]
+      # Replace all instances of e.g. ["a", "-", "z"] with ["a", "b", ..., "z"]
       while i = @chars.index("-")
-        @chars[i-1..i+1] = (@chars[i-1]..@chars[i+1]).to_a
+        # Prevent infinite loops from expanding [",", "-", "."] to itself
+        # (Since ",".ord = 44, "-".ord = 45, ".".ord = 46)
+        if (@chars[i-1] == ',' && @chars[i+1] == '.')
+          first = '-'
+          @chars.delete_at(i)
+        else
+          @chars[i-1..i+1] = (@chars[i-1]..@chars[i+1]).to_a
+        end
       end
       # restore them back
       @chars.unshift(first) if first
@@ -66,7 +73,7 @@ module RegexpExamples
       @chars.each_with_index do |char, i|
         if char == "\\"
           if BackslashCharMap.keys.include?(@chars[i+1])
-            @chars[i..i+1] = BackslashCharMap[@chars[i+1]]
+            @chars[i..i+1] = move_backslash_to_front( BackslashCharMap[@chars[i+1]] )
           elsif @chars[i+1] == 'b'
             @chars[i..i+1] = "\b"
           elsif @chars[i+1] == "\\"
@@ -83,6 +90,14 @@ module RegexpExamples
         GroupResult.new(result)
       end
     end
+
+    private
+    def move_backslash_to_front(chars)
+      if index = chars.index { |char| char == '\\' }
+        chars.unshift chars.delete_at(index)
+      end
+      chars
+    end
   end
 
   class DotGroup
@@ -120,13 +135,10 @@ module RegexpExamples
       @right_repeaters = right_repeaters
     end
 
+
     def result
-      left_result = @left_repeaters.map do |repeater|
-        RegexpExamples::permutations_of_strings([repeater.result])
-      end
-      right_result = @right_repeaters.map do |repeater|
-        RegexpExamples::permutations_of_strings([repeater.result])
-      end
+      left_result = RegexpExamples::map_results(@left_repeaters)
+      right_result = RegexpExamples::map_results(@right_repeaters)
       left_result.concat(right_result).flatten.uniq.map do |result|
         GroupResult.new(result)
       end

data/lib/regexp-examples/helpers.rb

@@ -5,12 +5,12 @@ module RegexpExamples
   # element from each array
   #
   # For example:
-  # permutations_of_strings [ ['a'], ['b'], ['c', 'd', 'e'] ] #=> ['acb', 'abd', 'abe']
+  # permutations_of_strings [ ['a'], ['b'], ['c', 'd', 'e'] ] #=> ['abc', 'abd', 'abe']
   # permutations_of_strings [ ['a', 'b'], ['c', 'd'] ] #=> [ 'ac', 'ad', 'bc', 'bd' ]
-  def self.permutations_of_strings(arrays_of_strings, options={})
+  def self.permutations_of_strings(arrays_of_strings)
     first = arrays_of_strings.shift
     return first if arrays_of_strings.empty?
-    first.product( permutations_of_strings(arrays_of_strings, options) ).map do |result|
+    first.product( permutations_of_strings(arrays_of_strings) ).map do |result|
       join_preserving_capture_groups(result)
     end
   end
@@ -22,5 +22,13 @@ module RegexpExamples
       .flatten
     GroupResult.new(result.join, nil, subgroups)
   end
+
+  def self.map_results(repeaters)
+    repeaters
+      .map {|repeater| repeater.result}
+      .instance_eval do |partial_results|
+        RegexpExamples::permutations_of_strings(partial_results)
+      end
+  end
 end
 

data/lib/regexp-examples/parser.rb

@@ -12,7 +12,9 @@ module RegexpExamples
       while @current_position < regexp_string.length
         group = parse_group(repeaters)
         break if group.is_a? MultiGroupEnd
-        repeaters = [] if group.is_a? OrGroup
+        if group.is_a? OrGroup
+          return [OneTimeRepeater.new(group)]
+        end
         @current_position += 1
         repeaters << parse_repeater(group)
       end
@@ -65,7 +67,10 @@ module RegexpExamples
         group = parse_backreference_group($1)
       when BackslashCharMap.keys.include?(regexp_string[@current_position])
         group = CharGroup.new(
-          BackslashCharMap[regexp_string[@current_position]])
+          # Note: The `.dup` is important, as it prevents modifying the constant, in
+          # CharGroup#init_ranges (where the '-' is moved to the front)
+          BackslashCharMap[regexp_string[@current_position]].dup
+        )
       when rest_of_string =~ /\A(c|C-)(.)/ # Control character
         @current_position += $1.length
         group = parse_single_char_group( parse_control_character($2) )
@@ -98,7 +103,6 @@ module RegexpExamples
         end
       else
         group = parse_single_char_group( regexp_string[@current_position] )
-        # TODO: What about cases like \A, \z, \Z ?
       end
       group
     end

data/lib/regexp-examples/regexp_extensions.rb

@@ -1,11 +1,9 @@
 class Regexp
   module Examples
     def examples
-      partial_examples =
-        RegexpExamples::Parser.new(source)
-          .parse
-          .map {|repeater| repeater.result}
-      full_examples = RegexpExamples::permutations_of_strings(partial_examples)
+      full_examples = RegexpExamples::map_results(
+        RegexpExamples::Parser.new(source).parse
+      )
       RegexpExamples::BackReferenceReplacer.new.substitute_backreferences(full_examples)
     end
   end

data/lib/regexp-examples/repeaters.rb

@@ -33,7 +33,7 @@ module RegexpExamples
     end
 
     def result
-      super(0, TIMES)
+      super(0, MaxRepeaterVariance)
     end
   end
 
@@ -43,7 +43,7 @@ module RegexpExamples
     end
 
     def result
-      super(1, TIMES)
+      super(1, MaxRepeaterVariance + 1)
     end
   end
 
@@ -62,17 +62,23 @@ module RegexpExamples
       super(group)
       @min = min || 0
       if max
-        @max = max
+        # Prevent huge number of results in case of e.g. /.{1,100}/.examples
+        @max = smallest(max, @min + MaxRepeaterVariance)
       elsif has_comma
-        @max = min + TIMES
+        @max = @min + MaxRepeaterVariance
       else
-        @max = min
+        @max = @min
       end
     end
 
     def result
       super(@min, @max)
     end
+
+    private
+    def smallest(x, y)
+      (x < y) ? x : y
+    end
   end
 end
 

data/lib/regexp-examples/version.rb

@@ -1,3 +1,3 @@
 module RegexpExamples
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/regexp-examples_spec.rb

@@ -29,6 +29,14 @@ RSpec.describe Regexp, "#examples" do
     end
   end
 
+  def self.examples_are_empty(*regexps)
+    regexps.each do |regexp|
+      it do
+        expect(regexp.examples).to be_empty
+      end
+    end
+  end
+
   context 'returns matching strings' do
     context "for basic repeaters" do
       examples_exist_and_match(
@@ -54,6 +62,7 @@ RSpec.describe Regexp, "#examples" do
 
     context "for complex char groups (square brackets)" do
       examples_exist_and_match(
+
         /[abc]/,
         /[a-c]/,
         /[abc-e]/,
@@ -65,7 +74,8 @@ RSpec.describe Regexp, "#examples" do
         /[\\\]]/,
         /[\n-\r]/,
         /[\-]/,
-        /[%-+]/ # This regex is "supposed to" match some surprising things!!!
+        /[%-+]/, # This regex is "supposed to" match some surprising things!!!
+        /['-.]/ # Test to ensure no "infinite loop" on character set expansion
       )
     end
 
@@ -118,7 +128,8 @@ RSpec.describe Regexp, "#examples" do
         /((a?b*c+)) \1/,
         /((a?b*c+)?) \1/,
         /a|b|c|d/,
-        /a+|b*|c?/
+        /a+|b*|c?/,
+        /one|two|three/
       )
     end
 
@@ -189,5 +200,20 @@ RSpec.describe Regexp, "#examples" do
       )
     end
 
+    context "for empty character sets" do
+      examples_are_empty(
+        /[^\d\D]/,
+        /[^\w\W]/,
+        /[^\s\S]/,
+        /[^\h\H]/,
+        /[^\D0-9]/,
+        /[^\Wa-zA-Z0-9_]/,
+        /[^\d\D]*/,
+        /[^\d\D]+/,
+        /[^\d\D]{2}/,
+        /[^\d\D]word/
+      )
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -33,7 +33,6 @@ RSpec.configure do |config|
   end
 
   config.disable_monkey_patching!
-  config.warnings = true
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regexp-examples
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Tom Lord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler