js_regex 3.2.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48540644a806114addad63fb0f3ff9ba7ad00a084b3b281b9132d2eddbe610ff
-  data.tar.gz: 775fd5d3f54c8b3c32b145414707c0b69c5c783cbd5270d9bc8d5e1564a6fec7
+  metadata.gz: 8365bf02c61518e8db07367f1501e31ac8599f709b0cfb80847803d7aa4f17b1
+  data.tar.gz: f6840ad243194ad82ff589a9cd3f11c3db11b6f2a0f471b50dbb0b3510ebcc08
 SHA512:
-  metadata.gz: 97810021249f6b512ebae5898f6ffe51ae95269f1e47909fb7b95fbe1e8aa6ba9696e4c7966bac27cbc7c1bd36668729aeb5d0ab4c243e85a88bb70fd6cbb203
-  data.tar.gz: 5681e9d950c14f7260596b46a382a9829c0be4326bd898acbdcf5a257936c0f543018b5c7b1435582d8ba976a680d3b08ac0189e85d82b49e621e5f8918b93a9
+  metadata.gz: 163fdc6a6011088e22804a0bb2174d30c5c053afec187964aac9f6cfaf1dfecd93719a824971f6820b25c54e6ac521e2cd2ca7b5be13463ab7461fb1f1ac794d
+  data.tar.gz: f0f6efbf118747f79211caec3335b8b34f5f69b69c7d0c78db5b0edb77812a2663dba6bd78e0b074efe2b27d58542c504e18239f78d5b25d40942f21b1486e15

data/lib/js_regex/conversion.rb

@@ -13,25 +13,27 @@ class JsRegex
     require_relative 'second_pass'
 
     class << self
-      def of(ruby_regex, options: nil)
-        source, warnings = convert_source(ruby_regex)
-        options_string   = convert_options(ruby_regex, options)
+      def of(input, options: nil)
+        source, warnings = convert_source(input)
+        options_string   = convert_options(input, options)
         [source, options_string, warnings]
       end
 
       private
 
-      def convert_source(ruby_regex)
-        tree = Regexp::Parser.parse(ruby_regex)
+      def convert_source(input)
+        tree = Regexp::Parser.parse(input)
         context = Converter::Context.new(case_insensitive_root: tree.i?)
         converted_tree = Converter.convert(tree, context)
         final_tree = SecondPass.call(converted_tree)
         [final_tree.to_s, context.warnings]
       end
 
-      def convert_options(ruby_regex, custom_options)
+      def convert_options(input, custom_options)
         options = custom_options.to_s.scan(/[gimuy]/)
-        options << 'i' if (ruby_regex.options & Regexp::IGNORECASE).nonzero?
+        if input.is_a?(Regexp) && (input.options & Regexp::IGNORECASE).nonzero?
+          options << 'i'
+        end
         options.uniq.sort.join
       end
     end

data/lib/js_regex/converter.rb

@@ -32,18 +32,10 @@ class JsRegex
         MAP[expression.type].new
       end
 
-      # Limit the number of generated surrogate pairs, else the output might
-      # get to large for certain applications. The chosen number is somewhat
-      # arbitrary. 100 pairs make for about 1 KB, uncompressed. The median char
-      # count of all properties supported by Ruby is 92. 75% are below 300 chars.
-      #
-      # Set this to nil if you need full unicode matches and size doesn't matter.
-      attr_writer :surrogate_pair_limit
-
-      def in_surrogate_pair_limit?(&pair_count)
-        @surrogate_pair_limit.nil? || @surrogate_pair_limit >= pair_count.call
+      # Legacy method. Remove in v4.0.0.
+      def surrogate_pair_limit=(_arg)
+        warn '#surrogate_pair_limit= is deprecated and has no effect anymore.'
       end
     end
-    self.surrogate_pair_limit = 300
   end
 end

data/lib/js_regex/converter/anchor_converter.rb

@@ -23,9 +23,8 @@ class JsRegex
       end
 
       def pass_boundary_with_warning(boundary)
-        warn("The boundary '#{boundary}' at index #{expression.ts} "\
-             'is not unicode-aware in JavaScript, '\
-             'so it might act differently than in Ruby.')
+        warn_of("The anchor '#{boundary}' at index #{expression.ts} "\
+                'only works at ASCII word boundaries in JavaScript.')
         boundary
       end
     end

data/lib/js_regex/converter/base.rb

@@ -54,11 +54,11 @@ class JsRegex
       def warn_of_unsupported_feature(description = nil)
         description ||= "#{subtype} #{expression.type}".tr('_', ' ')
         full_desc = "#{description} '#{expression}'"
-        warn("Dropped unsupported #{full_desc} at index #{expression.ts}")
+        warn_of("Dropped unsupported #{full_desc} at index #{expression.ts}")
         drop
       end
 
-      def warn(text)
+      def warn_of(text)
         context.warnings << text
       end
 

data/lib/js_regex/converter/escape_converter.rb

@@ -44,7 +44,7 @@ class JsRegex
         when :control, :meta_sequence
           unicode_escape_codepoint
         when :literal
-          LiteralConverter.convert_data(data)
+          LiteralConverter.convert_data(expression.char)
         when *ESCAPES_SHARED_BY_RUBY_AND_JS
           pass_through
         when :bell, :escape

data/lib/js_regex/converter/group_converter.rb

@@ -34,9 +34,6 @@ class JsRegex
       end
 
       def build_options_group
-        unless (encoding_options = data.scan(/[adu]/)).empty?
-          warn_of_unsupported_feature("encoding options #{encoding_options}")
-        end
         if subtype.equal?(:options_switch)
           # can be ignored since #options on subsequent Expressions are correct
           drop_without_warning

data/lib/js_regex/converter/literal_converter.rb

@@ -13,40 +13,30 @@ class JsRegex
 
         def convert_data(data)
           if data =~ ASTRAL_PLANE_CODEPOINT_PATTERN
-            data.each_char.each_with_object(Node.new) do |chr, node|
-              if chr =~ ASTRAL_PLANE_CODEPOINT_PATTERN
-                node << surrogate_pair_for(chr)
-              else
-                node << convert_bmp_data(chr)
-              end
-            end
+            convert_astral_data(data)
           else
-            convert_bmp_data(data)
+            escape_incompatible_bmp_literals(data)
           end
         end
 
-        def convert_bmp_data(data)
-          ensure_json_compatibility(
-            ensure_forward_slashes_are_escaped(data)
-          )
+        def convert_astral_data(data)
+          data.each_char.each_with_object(Node.new) do |char, node|
+            if char =~ ASTRAL_PLANE_CODEPOINT_PATTERN
+              node << surrogate_substitution_for(char)
+            else
+              node << escape_incompatible_bmp_literals(char)
+            end
+          end
         end
 
-        private
-
-        def surrogate_pair_for(astral_char)
-          base = astral_char.codepoints.first - 65_536
-          high = ((base / 1024).floor + 55_296).to_s(16)
-          low  = (base % 1024 + 56_320).to_s(16)
-          "(?:\\u#{high}\\u#{low})"
+        def escape_incompatible_bmp_literals(data)
+          data.gsub('/', '\\/').gsub(/[\f\n\r\t]/) { |lit| Regexp.escape(lit) }
         end
 
-        def ensure_forward_slashes_are_escaped(data)
-          # literal slashes would signify the pattern end in JsRegex#to_s
-          data.gsub(%r{\\?/}, '\\/')
-        end
+        private
 
-        def ensure_json_compatibility(data)
-          data.gsub(%r{\\?([\f\n\r\t])}) { Regexp.escape($1) }
+        def surrogate_substitution_for(char)
+          CharacterSet::Writer.write_surrogate_ranges([], [char.codepoints])
         end
       end
 

data/lib/js_regex/converter/meta_converter.rb

@@ -8,6 +8,9 @@ class JsRegex
     # Template class implementation.
     #
     class MetaConverter < JsRegex::Converter::Base
+      DOT_EXPANSION    = '(?:[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\n\uD800-\uDFFF])'
+      ML_DOT_EXPANSION = '(?:[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\uD800-\uDFFF])'
+
       private
 
       def convert_data
@@ -15,22 +18,27 @@ class JsRegex
         when :alternation
           convert_alternatives
         when :dot
-          expression.multiline? ? '(?:.|\n)' : '.'
+          expression.multiline? ? ML_DOT_EXPANSION : DOT_EXPANSION
         else
           warn_of_unsupported_feature
         end
       end
 
       def convert_alternatives
-        kept_any = nil
+        kept_any_previous_branch = nil
 
         convert_subexpressions.transform do |node|
-          dropped = !node.children.empty? && node.children.all?(&:dropped?)
-          node.children.unshift('|') if kept_any && !dropped
-          kept_any = true unless dropped
+          unless dropped_branch?(node)
+            node.children.unshift('|') if kept_any_previous_branch
+            kept_any_previous_branch = true
+          end
           node
         end
       end
+
+      def dropped_branch?(branch_node)
+        branch_node.children.any? && branch_node.children.all?(&:dropped?)
+      end
     end
   end
 end

data/lib/js_regex/converter/property_converter.rb

@@ -15,25 +15,15 @@ class JsRegex
       private
 
       def convert_data
-        content = CharacterSet.of_property(subtype)
+        content = CharacterSet.of_expression(expression)
+
         if expression.case_insensitive? && !context.case_insensitive_root
           content = content.case_insensitive
+        elsif !expression.case_insensitive? && context.case_insensitive_root
+          warn_of_unsupported_feature('nested case-sensitive property')
         end
 
-        if expression.negative?
-          if content.astral_part?
-            warn_of_unsupported_feature('astral plane negation by property')
-          end
-        elsif Converter.in_surrogate_pair_limit? { content.astral_part.size }
-          return content.to_s_with_surrogate_alternation
-        else
-          warn_of_unsupported_feature('large astral plane match of property')
-        end
-
-        bmp_part = content.bmp_part
-        return drop if bmp_part.empty?
-
-        "[#{'^' if expression.negative?}#{bmp_part}]"
+        content.to_s_with_surrogate_ranges
       end
     end
   end

data/lib/js_regex/converter/set_converter.rb

@@ -19,10 +19,7 @@ class JsRegex
       private
 
       def convert_data
-        if directly_compatible?
-          return expression.to_s(:base)
-                           .gsub(%r{\\?([\f\n\r\t])}) { Regexp.escape($1) }
-        end
+        return pass_through_with_escaping if directly_compatible?
 
         content = CharacterSet.of_expression(expression)
         if expression.case_insensitive? && !context.case_insensitive_root
@@ -31,38 +28,42 @@ class JsRegex
           warn_of_unsupported_feature('nested case-sensitive set')
         end
 
-        if Converter.in_surrogate_pair_limit? { content.astral_part.size }
-          content.to_s_with_surrogate_alternation
-        else
-          warn_of_unsupported_feature('large astral plane match of set')
-          bmp_part = content.bmp_part
-          bmp_part.empty? ? drop : bmp_part.to_s(in_brackets: true)
-        end
+        content.to_s_with_surrogate_ranges
       end
 
       def directly_compatible?
-        if expression.case_insensitive? ^ context.case_insensitive_root
-          # casefolding needed
-          return
-        end
+        all_children_directly_compatible? && !casefolding_needed?
+      end
 
-        # check for children needing conversion (#each_expression is recursive)
+      def all_children_directly_compatible?
+        # note that #each_expression is recursive
         expression.each_expression do |exp|
-          case exp.type
-          when :literal
-            # surrogate pair substitution needed if astral
-            next if exp.text.ord <= 0xFFFF
-          when :set
-            # conversion needed for nested sets, intersections
-            next if exp.token.equal?(:range)
-          when :type
-            next if TypeConverter::TYPES_SHARED_BY_RUBY_AND_JS.include?(exp.token)
-          when :escape
-            next if EscapeConverter::ESCAPES_SHARED_BY_RUBY_AND_JS.include?(exp.token)
-          end
-          return
+          return unless child_directly_compatible?(exp)
         end
-        true
+      end
+
+      def child_directly_compatible?(exp)
+        case exp.type
+        when :literal
+          # surrogate pair substitution needed if astral
+          exp.text.ord <= 0xFFFF
+        when :set
+          # conversion needed for nested sets, intersections
+          exp.token.equal?(:range)
+        when :type
+          TypeConverter.directly_compatible?(exp)
+        when :escape
+          EscapeConverter::ESCAPES_SHARED_BY_RUBY_AND_JS.include?(exp.token)
+        end
+      end
+
+      def casefolding_needed?
+        expression.case_insensitive? ^ context.case_insensitive_root
+      end
+
+      def pass_through_with_escaping
+        string = expression.to_s(:base)
+        LiteralConverter.escape_incompatible_bmp_literals(string)
       end
     end
   end

data/lib/js_regex/converter/type_converter.rb

@@ -8,19 +8,19 @@ class JsRegex
     # Template class implementation.
     #
     class TypeConverter < JsRegex::Converter::Base
-      TYPES_SHARED_BY_RUBY_AND_JS = %i[
-        digit
-        nondigit
-        word
-        nonword
-        space
-        nonspace
-      ].freeze
-
       HEX_EXPANSION       = '[0-9A-Fa-f]'
       NONHEX_EXPANSION    = '[^0-9A-Fa-f]'
       LINEBREAK_EXPANSION = '(?:\r\n|[\n\v\f\r\u0085\u2028\u2029])'
 
+      def self.directly_compatible?(expression)
+        case expression.token
+        when :space, :nonspace
+          !expression.ascii_classes?
+        when :digit, :nondigit, :word, :nonword
+          !expression.unicode_classes?
+        end
+      end
+
       private
 
       def convert_data
@@ -28,12 +28,30 @@ class JsRegex
         when :hex then HEX_EXPANSION
         when :nonhex then NONHEX_EXPANSION
         when :linebreak then LINEBREAK_EXPANSION
-        when *TYPES_SHARED_BY_RUBY_AND_JS
-          pass_through
+        when :digit, :space, :word
+          return pass_through if self.class.directly_compatible?(expression)
+          set_substitution
+        when :nondigit, :nonspace, :nonword
+          return pass_through if self.class.directly_compatible?(expression)
+          negative_set_substitution
         else
           warn_of_unsupported_feature
         end
       end
+
+      def negative_set_substitution
+        # ::of_expression returns an inverted set for negative expressions,
+        # so we need to un-invert before wrapping in [^ and ]. Kinda lame.
+        "[^#{character_set.inversion.bmp_part}]"
+      end
+
+      def set_substitution
+        character_set.bmp_part.to_s(in_brackets: true)
+      end
+
+      def character_set
+        CharacterSet.of_expression(expression)
+      end
     end
   end
 end

data/lib/js_regex/second_pass.rb

@@ -25,32 +25,16 @@ class JsRegex
       end
 
       def conditional_tree_permutations(tree)
-        all_conditions = conditions(tree)
-        return [] if all_conditions.empty?
+        all_conds = conditions(tree)
+        return [] if all_conds.empty?
 
-        captured_groups_per_branch = captured_group_count(tree)
+        caps_per_branch = captured_group_count(tree)
 
-        condition_permutations(all_conditions).map.with_index do |truthy_conds, i|
+        condition_permutations(all_conds).map.with_index do |truthy_conds, i|
           tree_permutation = tree.clone
           # find referenced groups and conditionals and make one-sided
           crawl(tree_permutation) do |node|
-            truthy = truthy_conds.include?(node.reference)
-
-            if node.type.equal?(:captured_group) &&
-              all_conditions.include?(node.reference)
-              truthy ? min_quantify(node) : null_quantify(node)
-            elsif node.type.equal?(:conditional)
-              branches = node.children[1...-1]
-              if branches.count == 1
-                truthy || null_quantify(branches.first)
-              else
-                null_quantify(truthy ? branches.last : branches.first)
-              end
-              node.update(type: :plain)
-            elsif node.type.equal?(:backref_num)
-              new_num = node.children[0].to_i + captured_groups_per_branch * i
-              node.update(children: [new_num.to_s])
-            end
+            build_permutation(node, all_conds, truthy_conds, caps_per_branch, i)
           end
         end
       end
@@ -81,8 +65,40 @@ class JsRegex
         end
       end
 
+      def build_permutation(node, all_conds, truthy_conds, caps_per_branch, i)
+        truthy = truthy_conds.include?(node.reference)
+
+        if node.type.equal?(:captured_group) &&
+          all_conds.include?(node.reference)
+          adapt_referenced_group_to_permutation(node, truthy)
+        elsif node.type.equal?(:conditional)
+          adapt_conditional_to_permutation(node, truthy)
+        elsif node.type.equal?(:backref_num)
+          adapt_backref_to_permutation(node, caps_per_branch, i)
+        end
+      end
+
+      def adapt_referenced_group_to_permutation(group_node, truthy)
+        truthy ? min_quantify(group_node) : null_quantify(group_node)
+      end
+
+      def adapt_conditional_to_permutation(conditional_node, truthy)
+        branches = conditional_node.children[1...-1]
+        if branches.count == 1
+          truthy || null_quantify(branches.first)
+        else
+          null_quantify(truthy ? branches.last : branches.first)
+        end
+        conditional_node.update(type: :plain)
+      end
+
+      def adapt_backref_to_permutation(backref_node, caps_per_branch, i)
+        new_num = backref_node.children[0].to_i + caps_per_branch * i
+        backref_node.update(children: [new_num.to_s])
+      end
+
       def min_quantify(node)
-        return if (qtf = node.quantifier).nil? || qtf.min > 0
+        return if guarantees_at_least_one_match?(qtf = node.quantifier)
 
         if qtf.max.equal?(1) # any zero_or_one quantifier (?, ??, ?+)
           node.update(quantifier: nil)
@@ -91,6 +107,10 @@ class JsRegex
         end
       end
 
+      def guarantees_at_least_one_match?(quantifier)
+        quantifier.nil? || quantifier.min > 0
+      end
+
       def null_quantify(node)
         node.update(quantifier: '{0}')
       end

data/lib/js_regex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class JsRegex
-  VERSION = '3.2.0'
+  VERSION = '3.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_regex
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Janosch Müller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-18 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: character_set
@@ -16,126 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: regexp_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: regexp_property_values
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-core
+  name: mini_racer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rspec-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: therubyracer
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: mutant-rspec
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.2.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.2.12
 description: JsRegex converts Ruby's native regular expressions for JavaScript, taking
   care of various incompatibilities and returning warnings for unsolvable differences.
 email:
@@ -170,7 +142,7 @@ homepage: https://github.com/jaynetics/js_regex
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Converts Ruby regexes to JavaScript regexes.
 test_files: []