regexp-examples 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6b6bd1d3602690963b1f1ecb61dbb91b38d0847
-  data.tar.gz: c104bcd97175689467336fa4c11f4f187d483332
+  metadata.gz: 7e76c8504f718a77052f24bdd8785042ded1b584
+  data.tar.gz: 5f63fd56430a4f8f0f10fd9ffc4f82d7b1301b2e
 SHA512:
-  metadata.gz: 75662efea94170727d89f7f88335a02ab688cbe37a587a01d1c08b72ab69e64ff3bdc0ff2faef91ebb9622b0f465b67843620d3219639cc41156800f59d8ed22
-  data.tar.gz: 85b54784013793a0a192cf2b456eb48fab304be07c87149726f3379a7409ae2a3f3fdc66c592b526d6c634d4a2bea0a53b60c0ea226fd295191549a6e8f67f2c
+  metadata.gz: ead89c6fead001d78b5336a69fa044af6fce905664c48a1430594b811b3729d4ea341e369ef190a43159672c4ca16a75a3c92c9a068c3638774b6030d318932a
+  data.tar.gz: d9edc5da0d9f2d3a6b856f00b202e5c119a1733f130cdf40b27e70875771f3f08707a9f0523b607b9882220b39e486a844e2013d774660c17c3b0f51743db02a

data/README.md

@@ -29,14 +29,15 @@ For more detail on this, see [configuration options](#configuration-options).
 ## Supported syntax
 
 * All forms of repeaters (quantifiers), e.g. `/a*/`, `/a+/`, `/a?/`, `/a{1,4}/`, `/a{3,}/`, `/a{,2}/`
+  * Reluctant and possissive repeaters work fine, too - e.g. `/a*?/`, `/a*+/`
 * Boolean "Or" groups, e.g. `/a|b|c/`
 * Character sets (inluding ranges and negation!), e.g. `/[abc]/`, `/[A-Z0-9]/`, `/[^a-z]/`, `/[\w\s\b]/`
 * Escaped characters, e.g. `/\n/`, `/\w/`, `/\D/` (and so on...)
-* Non-capture groups, e.g. `/(?:foo)/`
 * Capture groups, e.g. `/(group)/`
   * Including named groups, e.g. `/(?<name>group)/`
   * ...And backreferences(!!!), e.g. `/(this|that) \1/` `/(?<name>foo) \k<name>/`
-  * Groups work fine, even if nested! e.g. `/(even(this(works?))) \1 \2 \3/`
+  * Groups work fine, even if nested or optional e.g. `/(even(this(works?))) \1 \2 \3/`, `/what about (this)? \1/`
+  * Non-capture groups, e.g. `/(?:foo)/`
 * Control characters, e.g. `/\ca/`, `/\cZ/`, `/\C-9/`
 * Escape sequences, e.g. `/\x42/`, `/\x3D/`, `/\x5word/`, `/#{"\x80".force_encoding("ASCII-8BIT")}/`
 * Unicode characters, e.g. `/\u0123/`, `/\uabcd/`, `/\u{789}/`
@@ -44,27 +45,22 @@ For more detail on this, see [configuration options](#configuration-options).
 
 ## Bugs and Not-Yet-Supported syntax
 
-* Backreferences are replaced by the _first_ occurance of the group, not the _last_ (as it should be). This is quite a rare occurance, but for example:
-  * `/(a|b){2} \1/.examples` incorrectly includes: `"ba b"` rather than the correct: `"ba a"`
-
 * Options, e.g. `/pattern/i`, `/foo.*bar/m` - Using options will currently just be ignored, for example:
   * `/test/i.examples` will NOT include `"TEST"`
   * `/white  space/x.examples` will not strip out the whitespace from the pattern, i.e. this incorrectly returns `["white  space"]` rather than `["whitespace"]`
 
 * Nested character classes, and the use of set intersection ([See here](http://www.ruby-doc.org/core-2.2.0/Regexp.html#class-Regexp-label-Character+Classes) for the official documentation on this.) For example:
   * `/[[abc]]/.examples`  (which _should_ return `["a", "b", "c"]`)
-  * `/[[a-d]&&[c-f]]/.examples` (which _should_ return: `["c", "d"]`) 
+  * `/[[a-d]&&[c-f]]/.examples` (which _should_ return: `["c", "d"]`)
 
 * Extended groups are not yet supported, such as:
   * Including comments inside the pattern, i.e. `/(?#...)/`
   * Conditional capture groups, such as `/(group1) (?(1)yes|no)`
   * Options toggling, i.e. `/(?imx)/`, `/(?-imx)/`, `/(?imx: re)/` and `/(?-imx: re)/`
 
-* Possessive quantifiers, i.e. `/.?+/`, `/.*+/`, `/.++/`
-
 * The patterns: `/\10/` ... `/\77/` should match the octal representation of their character code, if there is no nth grouped subexpression. For example, `/\10/.examples` should return `["\x08"]`. Funnily enough, I did not think of this when writing my regexp parser.
 
-Full documentation on all the various other obscurities in the ruby (version 2.x) regexp parser can be found [here](https://raw.githubusercontent.com/k-takata/Onigmo/master/doc/RE).
+There are loads more (increasingly obscure) unsupported bits of syntax, which I cannot be bothered to write out here. Full documentation on all the various other obscurities in the ruby (version 2.x) regexp parser can be found [here](https://raw.githubusercontent.com/k-takata/Onigmo/master/doc/RE).
 
 Using any of the following will raise a RegexpExamples::UnsupportedSyntax exception (until such time as they are implemented!):
 
@@ -105,8 +101,10 @@ When generating examples, the gem uses 2 configurable values to limit how many e
 To use an alternative value, simply pass the configuration option as follows:
 
 ```ruby
-/a*/.examples(max_repeater_variance: 5) #=> [''. 'a', 'aa', 'aaa', 'aaaa' 'aaaaa']
-/[F-X]/.examples(max_group_results: 10) #=> ['F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O']
+/a*/.examples(max_repeater_variance: 5)
+  #=> [''. 'a', 'aa', 'aaa', 'aaaa' 'aaaaa']
+/[F-X]/.examples(max_group_results: 10)
+  #=> ['F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O']
 ```
 
 _**WARNING**: Choosing huge numbers, along with a "complex" regex, could easily cause your system to freeze!_

data/lib/regexp-examples/helpers.rb

@@ -20,6 +20,11 @@ module RegexpExamples
     subgroups = result
       .map(&:all_subgroups)
       .flatten
+
+    # Only save the LAST group from repeated capture groups, e.g. /([ab]){2}/
+    subgroups.delete_if do |subgroup|
+      subgroups.count { |other_subgroup| other_subgroup.group_id == subgroup.group_id } > 1
+    end
     GroupResult.new(result.join, nil, subgroups)
   end
 

data/lib/regexp-examples/parser.rb

@@ -212,26 +212,26 @@ module RegexpExamples
 
     def parse_star_repeater(group)
       @current_position += 1
-      parse_non_greedy_repeater
+      parse_reluctant_or_possessive_repeater
       StarRepeater.new(group)
     end
 
     def parse_plus_repeater(group)
       @current_position += 1
-      parse_non_greedy_repeater
+      parse_reluctant_or_possessive_repeater
       PlusRepeater.new(group)
     end
 
-    def parse_non_greedy_repeater
-      if next_char == '?'
-        # TODO: Delay this warning until after parsing, and only display if capture groups are used
-        warn "Warning: Non-greedy operators (*? and +?) might not work properly, when using capture groups"
+    def parse_reluctant_or_possessive_repeater
+      if next_char =~ /[?+]/
+        # Don't treat these repeaters any differently when generating examples
         @current_position += 1
       end
     end
 
     def parse_question_mark_repeater(group)
       @current_position += 1
+      parse_reluctant_or_possessive_repeater
       QuestionMarkRepeater.new(group)
     end
 
@@ -241,7 +241,18 @@ module RegexpExamples
       min = match[1].to_i if match[1]
       has_comma = !match[2].nil?
       max = match[3].to_i if match[3]
-      RangeRepeater.new(group, min, has_comma, max)
+      repeater = RangeRepeater.new(group, min, has_comma, max)
+      parse_reluctant_or_possessive_range_repeater(repeater, min, has_comma, max)
+    end
+
+    def parse_reluctant_or_possessive_range_repeater(repeater, min, has_comma, max)
+        # .{1}? should be equivalent to (?:.{1})?, i.e. NOT a "non-greedy quantifier"
+        if min && !has_comma && !max && next_char == "?"
+          repeater = parse_question_mark_repeater(repeater)
+        else
+          parse_reluctant_or_possessive_repeater
+        end
+        repeater
     end
 
     def parse_one_time_repeater(group)

data/lib/regexp-examples/version.rb

@@ -1,3 +1,3 @@
 module RegexpExamples
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/spec/regexp-examples_spec.rb

@@ -40,16 +40,28 @@ RSpec.describe Regexp, "#examples" do
   context 'returns matching strings' do
     context "for basic repeaters" do
       examples_exist_and_match(
-        /a/,
-        /a*/,
-        /a*?/,
+        /a/,   # "one-time repeater"
+        /a*/,  # greedy
+        /a*?/, # reluctant (non-greedy)
+        /a*+/, # possesive
         /a+/,
         /a+?/,
+        /a*+/,
         /a?/,
+        /a??/,
+        /a?+/,
         /a{1}/,
+        /a{1}?/,
+        /a{1}+/,
         /a{1,}/,
+        /a{1,}?/,
+        /a{1,}+/,
         /a{,2}/,
-        /a{1,2}/
+        /a{,2}?/,
+        /a{,2}+/,
+        /a{1,2}/,
+        /a{1,2}?/,
+        /a{1,2}+/
       )
     end
 
@@ -119,7 +131,8 @@ RSpec.describe Regexp, "#examples" do
         /(one)(two)(three)(four)(five)(six)(seven)(eight)(nine)(ten) \10\9\8\7\6\5\4\3\2\1/,
         /(a?(b?(c?(d?(e?)))))/,
         /(a)? \1/,
-        /(a|(b)) \2/
+        /(a|(b)) \2/,
+        /([ab]){2} \1/ # \1 should always be the LAST result of the capture group
       )
     end
 
@@ -221,9 +234,13 @@ RSpec.describe Regexp, "#examples" do
     context "exact examples match" do
       # More rigorous tests to assert that ALL examples are being listed
       context "default options" do
+        # Simple examples
         it { expect(/[ab]{2}/.examples).to eq ["aa", "ab", "ba", "bb"] }
         it { expect(/(a|b){2}/.examples).to eq ["aa", "ab", "ba", "bb"] }
         it { expect(/a+|b?/.examples).to eq ["a", "aa", "aaa", "", "b"] }
+
+        # a{1}? should be equivalent to (?:a{1})?, i.e. NOT a "non-greedy quantifier"
+        it { expect(/a{1}?/.examples).to eq ["", "a"] }
       end
       context "max_repeater_variance option" do
         it do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regexp-examples
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Tom Lord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Extends the Regexp class with '#examples'