regexp-examples 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94abdab1c267eae56ef6b2d7d9968891776cb64d
-  data.tar.gz: 8e01129cc7d0d34d584f25e52950e89cea9d431b
+  metadata.gz: 7ce9ae460670e7c7525a38992990271751c311d4
+  data.tar.gz: f9501da52ba2b57b6ef92324f43ba7252a8d70f8
 SHA512:
-  metadata.gz: 776ca69a842d56844c0fd2b9eb0d03d5999a1bce2018ff74ee0a92106347f5710dc8c0bab1ce9beb705393768be8709d1f2193bc23381385f386e037f68151fb
-  data.tar.gz: 1c429180eec239661ab896a19a88835428ec74e05bb9af4ad6d63998d3d213510fc72d50d91be96eac9e78cad9e42c6f18d29f61b772b954fc48ea0b16b75a7e
+  metadata.gz: 5fabfe8bf9dcb41d4e1a6ceba7b8c98278ea44f12ea657409821abd25fbf856b11effc726d67d06c0d2c67e728caf24853a89e2e73f26f1c5fba58ea397478e9
+  data.tar.gz: 717755a835ca5f0a611c4a62ba4d8f4b90b7a422ce8d80136f79a97a71ee2f439b027c3fbd42f68ac79e65884940f0004b9f35a72197e8748cc6c7fef2680891

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - ruby-head
 matrix:
   allow_failures:

data/README.md

@@ -15,7 +15,7 @@ or a huge number of possible matches, such as `/.\w/`, then only a subset of the
 
 For more detail on this, see [configuration options](#configuration-options).
 
-If you'd like to understand how/why this gem works, please check out my [blog post](http://tom-lord.weebly.com/blog/reverse-engineering-regular-expressions) about it.
+If you'd like to understand how/why this gem works, please check out my [blog post](https://tom-lord.github.io/Reverse-Engineering-Regular-Expressions/) about it.
 
 ## Usage
 
@@ -100,12 +100,14 @@ Long answer:
   * Negation, e.g. `/[^a-z]/`
   * Escaped characters, e.g. `/[\w\s\b]/`
   * POSIX bracket expressions, e.g. `/[[:alnum:]]/`, `/[[:^space:]]/`
+    * ...Taking the current ruby version into account - e.g. the definition of `/[[:punct:]]/`
+      [changed](https://bugs.ruby-lang.org/issues/12577) in version `2.4.0`.
   * Set intersection, e.g. `/[[a-h]&&[f-z]]/`
 * Escaped characters, e.g. `/\n/`, `/\w/`, `/\D/` (and so on...)
 * Capture groups, e.g. `/(group)/`
   * Including named groups, e.g. `/(?<name>group)/`
   * And backreferences(!!!), e.g. `/(this|that) \1/` `/(?<name>foo) \k<name>/`
-  * ...even for the more "obscure" syntax, e.g. `/(?<future>the) \k'future'/`, `/(a)(b) \k<-1>/``
+  * ...even for the more "obscure" syntax, e.g. `/(?<future>the) \k'future'/`, `/(a)(b) \k<-1>/`
   * ...and even if nested or optional, e.g. `/(even(this(works?))) \1 \2 \3/`, `/what about (this)? \1/`
   * Non-capture groups, e.g. `/(?:foo)/`
   * Comment groups, e.g. `/foo(?#comment)bar/`
@@ -178,15 +180,12 @@ For instance, the following takes no more than ~ 1 second on my machine:
 There are no known major bugs with this library. However, there are a few obscure issues that you *may* encounter:
 
 * Conditional capture groups, e.g. `/(group1)? (?(1)yes|no)/.examples` are not yet supported. (This example *should* return: `["group1 yes", " no"]`)
-* `\Z` should be interpreted like `\n?\z`; it's currently just interpreted like `\z`. (This basically just means you'll be missing a few examples.)
-* Ideally, `regexp#examples` should always return up to `max_results_limit`. Currenty, it usually "aborts" before this limit is reached.
- (I.e. the exact number of examples generated can be hard to predict, for complex patterns.)
-* There are some (rare) edge cases where backreferences do not work properly, e.g. `/(a*)a* \1/.examples` -
- which includes `"aaaa aa"`. This is because each repeater is not context-aware, so the "greediness" logic is flawed.
- (E.g. in this case, the second `a*` should always evaluate to an empty string, because the previous `a*` was greedy.)
- However, patterns like this are highly unusual...
 * Nested repeat operators are incorrectly parsed, e.g. `/b{2}{3}/` - which *should* be interpreted like `/b{6}/`. (However, there is probably no reason
  to ever write regexes like this!)
+* A new ["absent operator" (`/(?~exp)/`)](https://medium.com/rubyinside/the-new-absent-operator-in-ruby-s-regular-expressions-7c3ef6cd0b99)
+ was added to Ruby version `2.4.1`. This gem does not yet support it (or gracefully fail when used).
+* Ideally, `regexp#examples` should always return up to `max_results_limit`. Currenty, it usually "aborts" before this limit is reached.
+ (I.e. the exact number of examples generated can be hard to predict, for complex patterns.)
 
 Some of the most obscure regexp features are not even mentioned in [the ruby docs](http://ruby-doc.org/core/Regexp.html).
 However, full documentation on all the intricate obscurities in the ruby (version 2.x) regexp parser can be found
@@ -195,7 +194,7 @@ However, full documentation on all the intricate obscurities in the ruby (versio
 ## Impossible features ("illegal syntax")
 
 The following features in the regex language can never be properly implemented into this gem because, put simply, they are not technically "regular"!
-If you'd like to understand this in more detail, check out what I had to say in [my blog post](http://tom-lord.weebly.com/blog/reverse-engineering-regular-expressions) about this gem.
+If you'd like to understand this in more detail, check out what I had to say in [my blog post](https://tom-lord.github.io/Reverse-Engineering-Regular-Expressions/) about this gem.
 
 Using any of the following will raise a `RegexpExamples::IllegalSyntax` exception:
 

data/lib/regexp-examples/chargroup_parser.rb

@@ -15,7 +15,7 @@ module RegexpExamples
     include CharsetNegationHelper
 
     attr_reader :regexp_string, :current_position
-    alias_method :length, :current_position
+    alias length current_position
 
     def initialize(regexp_string, is_sub_group: false)
       @regexp_string = regexp_string
@@ -85,10 +85,10 @@ module RegexpExamples
 
     def parse_after_backslash
       case next_char
-      when *BackslashCharMap.keys
-        BackslashCharMap[next_char]
       when 'b'
         ["\b"]
+      when *BackslashCharMap.keys
+        BackslashCharMap[next_char]
       else
         [next_char]
       end

data/lib/regexp-examples/constants.rb

@@ -21,10 +21,12 @@ module RegexpExamples
     # This is to prevent the system "freezing" when given instructions like:
     # /[ab]{30}/.examples
     # (Which would attempt to generate 2**30 == 1073741824 examples!!!)
-    MAX_RESULTS_LIMIT_DEFAULT = 10000
+    MAX_RESULTS_LIMIT_DEFAULT = 10_000
     class << self
       attr_reader :max_repeater_variance, :max_group_results, :max_results_limit
-      def configure!(max_repeater_variance: nil, max_group_results: nil, max_results_limit: nil)
+      def configure!(max_repeater_variance: nil,
+                     max_group_results: nil,
+                     max_results_limit: nil)
         @max_repeater_variance = (max_repeater_variance || MAX_REPEATER_VARIANCE_DEFAULT)
         @max_group_results = (max_group_results || MAX_GROUP_RESULTS_DEFAULT)
         @max_results_limit = (max_results_limit || MAX_RESULTS_LIMIT_DEFAULT)
@@ -35,9 +37,11 @@ module RegexpExamples
   def self.max_repeater_variance
     ResultCountLimiters.max_repeater_variance
   end
+
   def self.max_group_results
     ResultCountLimiters.max_group_results
   end
+
   def self.max_results_limit
     ResultCountLimiters.max_results_limit
   end
@@ -48,13 +52,11 @@ module RegexpExamples
     Lower        = Array('a'..'z')
     Upper        = Array('A'..'Z')
     Digit        = Array('0'..'9')
-    # Note: Punct should also include the following chars: $ + < = > ^ ` | ~
-    # I.e. Punct = %w(! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~)
-    # However, due to a ruby bug (!!) these do not work properly at the moment!
-    Punct        = %w(! " # % & ' ( ) * , - . / : ; ? @ [ \\ ] _ { })
+    Punct        = %w[! " # % & ' ( ) * , - . / : ; ? @ [ \\ ] _ { }] \
+                     | (RUBY_VERSION >= '2.4.0' ? %w[$ + < = > ^ ` | ~] : [])
     Hex          = Array('a'..'f') | Array('A'..'F') | Digit
     Word         = Lower | Upper | Digit | ['_']
-    Whitespace   = [' ', "\t", "\n", "\r", "\v", "\f"]
+    Whitespace   = [' ', "\t", "\n", "\r", "\v", "\f"].freeze
     Control      = (0..31).map(&:chr) | ["\x7f"]
     # Ensure that the "common" characters appear first in the array
     # Also, ensure "\n" comes first, to make it obvious when included

data/lib/regexp-examples/groups.rb

@@ -131,7 +131,7 @@ module RegexpExamples
       end
     end
 
-    alias_method :random_result, :result
+    alias random_result result
   end
 
   # A boolean "or" group.
@@ -162,7 +162,7 @@ module RegexpExamples
       max_results_limiter = MaxResultsLimiterBySum.new
       repeaters_list
         .map { |repeaters| RegexpExamples.generic_map_result(repeaters, method) }
-        .map { |result| max_results_limiter.limit_results(result)}
+        .map { |result| max_results_limiter.limit_results(result) }
         .inject(:concat)
         .map { |result| GroupResult.new(result) }
         .uniq
@@ -184,7 +184,7 @@ module RegexpExamples
   # of /\1/ as being "__1__". It later gets updated.
   class BackReferenceGroup
     include RandomResultBySample
-    PLACEHOLDER_FORMAT = '__%s__'
+    PLACEHOLDER_FORMAT = '__%s__'.freeze
     attr_reader :id
     def initialize(id)
       @id = id

data/lib/regexp-examples/max_results_limiter.rb

@@ -44,7 +44,7 @@ module RegexpExamples
   end
 
   # For example:
-  # Needed when generating examples for /[ab]{10}|{cd}{11}/             
+  # Needed when generating examples for /[ab]{10}|{cd}{11}/
   # (here, results_count will reach 1024 + 2048 == 3072)
   class MaxResultsLimiterBySum < MaxResultsLimiter
     def initialize

data/lib/regexp-examples/parser_helpers/parse_after_backslash_group_helper.rb

@@ -5,35 +5,33 @@ module RegexpExamples
 
     def parse_after_backslash_group
       @current_position += 1
-      case
-      when rest_of_string =~ /\A(\d{1,3})/
+      if rest_of_string =~ /\A(\d{1,3})/
         parse_regular_backreference_group(Regexp.last_match(1))
-      when rest_of_string =~ /\Ak['<]([\w-]+)['>]/
+      elsif rest_of_string =~ /\Ak['<]([\w-]+)['>]/
         parse_named_backreference_group(Regexp.last_match(1))
-      when BackslashCharMap.keys.include?(next_char)
+      elsif BackslashCharMap.keys.include?(next_char)
         parse_backslash_special_char
-      when rest_of_string =~ /\A(c|C-)(.)/
+      elsif rest_of_string =~ /\A(c|C-)(.)/
         parse_backslash_control_char(Regexp.last_match(1), Regexp.last_match(2))
-      when rest_of_string =~ /\Ax(\h{1,2})/
+      elsif rest_of_string =~ /\Ax(\h{1,2})/
         parse_backslash_escape_sequence(Regexp.last_match(1))
-      when rest_of_string =~ /\Au(\h{4}|\{\h{1,4}\})/
+      elsif rest_of_string =~ /\Au(\h{4}|\{\h{1,4}\})/
         parse_backslash_unicode_sequence(Regexp.last_match(1))
-      when rest_of_string =~ /\A(p)\{(\^?)([^}]+)\}/i
+      elsif rest_of_string =~ /\A(p)\{(\^?)([^}]+)\}/i
         parse_backslash_named_property(
           Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)
         )
-      when next_char == 'K' # Keep (special lookbehind that CAN be supported safely!)
+      elsif next_char == 'K' # Keep (special lookbehind that CAN be supported safely!)
         PlaceHolderGroup.new
-      when next_char == 'R'
+      elsif next_char == 'R'
         parse_backslash_linebreak
-      when next_char == 'g'
+      elsif next_char == 'g'
         parse_backslash_subexpresion_call
-      when next_char =~ /[bB]/
+      elsif next_char =~ /[bB]/
         parse_backslash_anchor
-      when next_char =~ /[AG]/
+      elsif next_char =~ /[AG]/
         parse_backslash_start_of_string
-      when next_char =~ /[zZ]/
-        # TODO: /\Z/ should be treated as /\n?/
+      elsif next_char =~ /[zZ]/
         parse_backslash_end_of_string
       else
         parse_single_char_group(next_char)
@@ -112,8 +110,8 @@ module RegexpExamples
     end
 
     def parse_backslash_subexpresion_call
-      fail IllegalSyntaxError,
-           'Subexpression calls (\\g) cannot be supported, as they are not regular'
+      raise IllegalSyntaxError,
+            'Subexpression calls (\\g) cannot be supported, as they are not regular'
     end
 
     def parse_backslash_anchor
@@ -130,15 +128,19 @@ module RegexpExamples
 
     def parse_backslash_end_of_string
       if @current_position == (regexp_string.length - 1)
-        PlaceHolderGroup.new
+        if next_char == 'z'
+          PlaceHolderGroup.new
+        else # next_char == 'Z'
+          QuestionMarkRepeater.new(SingleCharGroup.new("\n", @ignorecase))
+        end
       else
         raise_anchors_exception!
       end
     end
 
     def raise_anchors_exception!
-      fail IllegalSyntaxError,
-           "Anchors ('#{next_char}') cannot be supported, as they are not regular"
+      raise IllegalSyntaxError,
+            "Anchors ('#{next_char}') cannot be supported, as they are not regular"
     end
   end
 end

data/lib/regexp-examples/parser_helpers/parse_multi_group_helper.rb

@@ -28,15 +28,14 @@ module RegexpExamples
             )?
           /x
         ) do |match|
-          case
-          when match[1].nil? # e.g. /(normal)/
+          if match[1].nil? # e.g. /(normal)/
             group_id = @num_groups.to_s
-          when match[2] == ':' # e.g. /(?:nocapture)/
+          elsif match[2] == ':' # e.g. /(?:nocapture)/
             @current_position += 2
-          when match[2] == '#' # e.g. /(?#comment)/
+          elsif match[2] == '#' # e.g. /(?#comment)/
             comment_group = rest_of_string.match(/.*?[^\\](?:\\{2})*\)/)[0]
             @current_position += comment_group.length
-          when match[2] =~ /\A(?=[mix-]+)([mix]*)-?([mix]*)/ # e.g. /(?i-mx)/
+          elsif match[2] =~ /\A(?=[mix-]+)([mix]*)-?([mix]*)/ # e.g. /(?i-mx)/
             regexp_options_toggle(Regexp.last_match(1), Regexp.last_match(2))
             @num_groups -= 1 # Toggle "groups" should not increase backref group count
             @current_position += $&.length + 1
@@ -45,12 +44,12 @@ module RegexpExamples
             else
               return PlaceHolderGroup.new
             end
-          when %w(! =).include?(match[2]) # e.g. /(?=lookahead)/, /(?!neglookahead)/
-            fail IllegalSyntaxError,
-                 'Lookaheads are not regular; cannot generate examples'
-          when %w(! =).include?(match[3]) # e.g. /(?<=lookbehind)/, /(?<!neglookbehind)/
-            fail IllegalSyntaxError,
-                 'Lookbehinds are not regular; cannot generate examples'
+          elsif %w[! =].include?(match[2]) # e.g. /(?=lookahead)/, /(?!neglookahead)/
+            raise IllegalSyntaxError,
+                  'Lookaheads are not regular; cannot generate examples'
+          elsif %w[! =].include?(match[3]) # e.g. /(?<=lookbehind)/, /(?<!neglookbehind)/
+            raise IllegalSyntaxError,
+                  'Lookbehinds are not regular; cannot generate examples'
           else # e.g. /(?<name>namedgroup)/
             @current_position += (match[3].length + 3)
             group_id = match[3]

data/lib/regexp-examples/repeaters.rb

@@ -92,7 +92,7 @@ module RegexpExamples
     private
 
     def smallest(x, y)
-      (x < y) ? x : y
+      x < y ? x : y
     end
   end
 end

data/lib/regexp-examples/unicode_char_ranges.rb

@@ -10,7 +10,7 @@ module RegexpExamples
     # Note: Only the first 128 results are listed, for performance.
     # Also, some groups seem to have no matches (weird!)
     # (Don't care about ruby micro version number)
-    STORE_FILENAME = "unicode_ranges_#{RUBY_VERSION[0..2]}.pstore"
+    STORE_FILENAME = "unicode_ranges_#{RUBY_VERSION[0..2]}.pstore".freeze
 
     attr_reader :range_store
 
@@ -24,7 +24,7 @@ module RegexpExamples
       end
     end
 
-    alias_method :[], :get
+    alias [] get
 
     private
 
@@ -40,7 +40,7 @@ module RegexpExamples
     def ranges_to_unicode(ranges)
       result = []
       ranges.each do |range|
-        if range.is_a? Fixnum # Small hack to increase data compression
+        if range.is_a? Integer # Small hack to increase data compression
           result << hex_to_unicode(range.to_s(16))
         else
           range.each { |num| result << hex_to_unicode(num.to_s(16)) }

data/lib/regexp-examples/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module RegexpExamples
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'.freeze
 end

data/spec/regexp-examples_spec.rb

@@ -170,8 +170,9 @@ RSpec.describe Regexp, '#examples' do
         /\Glast-match/,
         /^start/,
         /end$/,
-        /end\z/,
-        /end\Z/
+        /end\z/
+        # Cannot test /end\Z/ with the generic method here,
+        # as it's a special case. Tested specially below.
       )
     end
 
@@ -303,6 +304,11 @@ RSpec.describe Regexp, '#examples' do
         it { expect(/a{1}?/.examples).to match_array ['', 'a'] }
       end
 
+      context 'end of string' do
+        it { expect(/test\z/.examples).to match_array %w(test) }
+        it { expect(/test\Z/.examples).to match_array ['test', "test\n"] }
+      end
+
       context 'backreferences and escaped octal combined' do
         it do
           expect(/(a)(b)(c)(d)(e)(f)(g)(h)(i)(j)? \10\9\8\7\6\5\4\3\2\1/.examples)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regexp-examples
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Tom Lord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Extends the Regexp class with '#examples' and '#random_example'