regexp_parser 1.7.1 → 1.8.0

data/lib/regexp_parser/scanner/scanner.rl

@@ -21,7 +21,7 @@
   set_close             = ']';
   brackets              = set_open | set_close;
 
-  comment               = ('#' . [^\n]* . '\n');
+  comment               = ('#' . [^\n]* . '\n'?);
 
   class_name_posix      = 'alnum' | 'alpha' | 'blank' |
                           'cntrl' | 'digit' | 'graph' |
@@ -120,7 +120,7 @@
 
   literal_delimiters    = ']' | '}';
 
-  ascii_print           = ((0x20..0x7e) - meta_char);
+  ascii_print           = ((0x20..0x7e) - meta_char - '#');
   ascii_nonprint        = (0x01..0x1f | 0x7f);
 
   utf8_2_byte           = (0xc2..0xdf 0x80..0xbf);
@@ -128,7 +128,7 @@
   utf8_4_byte           = (0xf0..0xf4 0x80..0xbf 0x80..0xbf 0x80..0xbf);
 
   non_literal_escape    = char_type_char | anchor_char | escaped_ascii |
-                          group_ref | keep_mark | [xucCM];
+                          keep_mark | [xucCM];
 
   non_set_escape        = (anchor_char - 'b') | group_ref | keep_mark |
                           multi_codepoint_char_type | [0-9cCM];
@@ -737,21 +737,16 @@ class Regexp::Scanner
   #
   # This method may raise errors if a syntax error is encountered.
   # --------------------------------------------------------------------------
-  def self.scan(input_object, &block)
-    new.scan(input_object, &block)
+  def self.scan(input_object, options: nil, &block)
+    new.scan(input_object, options: options, &block)
   end
 
-  def scan(input_object, &block)
+  def scan(input_object, options: nil, &block)
     self.literal = nil
     stack = []
 
-    if input_object.is_a?(Regexp)
-      input = input_object.source
-      self.free_spacing = (input_object.options & Regexp::EXTENDED != 0)
-    else
-      input = input_object
-      self.free_spacing = false
-    end
+    input = input_object.is_a?(Regexp) ? input_object.source : input_object
+    self.free_spacing = free_spacing?(input_object, options)
     self.spacing_stack = [{:free_spacing => free_spacing, :depth => 0}]
 
     data  = input.unpack("c*") if input.is_a?(String)
@@ -817,6 +812,18 @@ class Regexp::Scanner
   attr_accessor :tokens, :literal, :block, :free_spacing, :spacing_stack,
                 :group_depth, :set_depth, :conditional_stack
 
+  def free_spacing?(input_object, options)
+    if options && !input_object.is_a?(String)
+      raise ArgumentError, 'options cannot be supplied unless scanning a String'
+    end
+
+    options = input_object.options if input_object.is_a?(::Regexp)
+
+    return false unless options
+
+    options & Regexp::EXTENDED != 0
+  end
+
   def in_group?
     group_depth > 0
   end

data/lib/regexp_parser/version.rb

@@ -1,5 +1,5 @@
 class Regexp
   class Parser
-    VERSION = '1.7.1'
+    VERSION = '1.8.0'
   end
 end

data/spec/parser/free_space_spec.rb

@@ -24,13 +24,34 @@ RSpec.describe('FreeSpace parsing') do
     expect(root.first.text).to eq 'a b c d'
   end
 
+  specify('parse single-line free space comments without spaces') do
+    regexp = /a#b/x
+
+    root = RP.parse(regexp)
+    expect(root.length).to eq 2
+
+    expect(root[0]).to be_instance_of(Literal)
+    expect(root[1]).to be_instance_of(Comment)
+  end
+
+  specify('parse single-line free space comments with spaces') do
+    regexp = /a # b/x
+
+    root = RP.parse(regexp)
+    expect(root.length).to eq 3
+
+    expect(root[0]).to be_instance_of(Literal)
+    expect(root[1]).to be_instance_of(WhiteSpace)
+    expect(root[2]).to be_instance_of(Comment)
+  end
+
   specify('parse free space comments') do
     regexp = /
       a   ?     # One letter
       b {2,5}   # Another one
       [c-g]  +  # A set
       (h|i|j) | # A group
-      klm *
+      klm#nospace before or after comment hash
       nop +
     /x
 
@@ -51,11 +72,11 @@ RSpec.describe('FreeSpace parsing') do
 
     alt_2 = alt.alternatives.last
     expect(alt_2).to be_instance_of(Alternative)
-    expect(alt_2.length).to eq 7
+    expect(alt_2.length).to eq 8
 
-    [0, 2, 4, 6].each { |i| expect(alt_2[i].class).to eq WhiteSpace }
+    [0, 2, 5, 7].each { |i| expect(alt_2[i].class).to eq WhiteSpace }
 
-    expect(alt_2[1]).to be_instance_of(Comment)
+    [1, 4].each { |i| expect(alt_2[i]).to be_instance_of(Comment) }
   end
 
   specify('parse free space nested comments') do

data/spec/parser/options_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe('passing options to parse') do
+  it 'raises if if parsing from a Regexp and options are passed' do
+    expect { RP.parse(/a+/, options: ::Regexp::EXTENDED) }.to raise_error(
+      ArgumentError,
+      'options cannot be supplied unless parsing a String'
+    )
+  end
+
+  it 'sets options if parsing from a String' do
+    root = RP.parse('a+', options: ::Regexp::MULTILINE | ::Regexp::EXTENDED)
+
+    expect(root.options).to eq(m: true, x: true)
+  end
+
+  it 'allows options to not be supplied when parsing from a Regexp' do
+    root = RP.parse(/a+/ix)
+
+    expect(root.options).to eq(i: true, x: true)
+  end
+
+  it 'has an empty option-hash when parsing from a String and passing no options' do
+    root = RP.parse('a+')
+
+    expect(root.options).to be_empty
+  end
+end

data/spec/scanner/escapes_spec.rb

@@ -13,6 +13,10 @@ RSpec.describe('Escape scanning') do
 
   include_examples 'scan', 'c\qt',            1 => [:escape,  :literal,          '\q',             1,  3]
 
+  # these incomplete ref/call sequences are treated as literal escapes by Ruby
+  include_examples 'scan', 'c\gt',            1 => [:escape,  :literal,          '\g',             1,  3]
+  include_examples 'scan', 'c\kt',            1 => [:escape,  :literal,          '\k',             1,  3]
+
   include_examples 'scan', 'a\012c',          1 => [:escape,  :octal,            '\012',           1,  5]
   include_examples 'scan', 'a\0124',          1 => [:escape,  :octal,            '\012',           1,  5]
   include_examples 'scan', '\712+7',          0 => [:escape,  :octal,            '\712',           0,  4]

data/spec/scanner/options_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe('passing options to scan') do
+  def expect_type_tokens(tokens, type_tokens)
+    expect(tokens.map { |type, token, *| [type, token] }).to eq(type_tokens)
+  end
+
+  it 'raises if if scanning from a Regexp and options are passed' do
+    expect { RS.scan(/a+/, options: ::Regexp::EXTENDED) }.to raise_error(
+      ArgumentError,
+      'options cannot be supplied unless scanning a String'
+    )
+  end
+
+  it 'sets free_spacing based on options if scanning from a String' do
+    expect_type_tokens(
+      RS.scan('a+#c', options: ::Regexp::MULTILINE | ::Regexp::EXTENDED),
+      [
+        %i[literal literal],
+        %i[quantifier one_or_more],
+        %i[free_space comment]
+      ]
+    )
+  end
+
+  it 'does not set free_spacing if scanning from a String and passing no options' do
+    expect_type_tokens(
+      RS.scan('a+#c'),
+      [
+        %i[literal literal],
+        %i[quantifier one_or_more],
+        %i[literal literal]
+      ]
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regexp_parser
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Ammar Ali
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies: []
 description: A library for tokenizing, lexing, and parsing Ruby regular expressions.
 email:
@@ -124,6 +124,7 @@ files:
 - spec/parser/free_space_spec.rb
 - spec/parser/groups_spec.rb
 - spec/parser/keep_spec.rb
+- spec/parser/options_spec.rb
 - spec/parser/posix_classes_spec.rb
 - spec/parser/properties_spec.rb
 - spec/parser/quantifiers_spec.rb
@@ -143,6 +144,7 @@ files:
 - spec/scanner/keep_spec.rb
 - spec/scanner/literals_spec.rb
 - spec/scanner/meta_spec.rb
+- spec/scanner/options_spec.rb
 - spec/scanner/properties_spec.rb
 - spec/scanner/quantifiers_spec.rb
 - spec/scanner/refcalls_spec.rb
@@ -203,6 +205,7 @@ test_files:
 - spec/parser/sets_spec.rb
 - spec/parser/free_space_spec.rb
 - spec/parser/keep_spec.rb
+- spec/parser/options_spec.rb
 - spec/parser/all_spec.rb
 - spec/parser/conditionals_spec.rb
 - spec/parser/types_spec.rb
@@ -246,6 +249,7 @@ test_files:
 - spec/scanner/sets_spec.rb
 - spec/scanner/free_space_spec.rb
 - spec/scanner/keep_spec.rb
+- spec/scanner/options_spec.rb
 - spec/scanner/all_spec.rb
 - spec/scanner/conditionals_spec.rb
 - spec/scanner/types_spec.rb