srx 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 153660bff1d0fc6c00bebc7fae34b11d9f70b16c54628ebf5023f8815b105b45
-  data.tar.gz: 1e01d70b8f8a3cb032e62137f7ab1224e3942bb2314a47c05af295ff6431ba35
+  metadata.gz: f678f4fe5e7f30edbe600f27a5dd00217528d84291248ebf76f8d5c4df62f333
+  data.tar.gz: 5d096e1688a5c57756bb86be9a31d504aa99cbb877de434737e5c4578808f4f1
 SHA512:
-  metadata.gz: e3ac37ecbb4bba2c31d90d32f3b4c0ae4cd236a70e6ab25c340f35c52e12364d4aad14dff01e0b8381fd28811ea46f6f861d1ff23540c0f280575cbbd24d1262
-  data.tar.gz: b89f432b242e1bd8e2b8e5917888d78f75ef9749b2add35e9991a4d33e38be8876c110e107b994f27bdaf214612f231c1cd2041a0090759f053d839f7bd3d741
+  metadata.gz: 78d28e9ebb51c4ac61f2b15dc27d527f802a7a9c40812741ca817a14b0e231e0dce310f0b9c38411fb8dfe2f02953ca7344a90ad85fea5290d2b234be5795130
+  data.tar.gz: 2521273e4f164b44be0f43b2dd54cc17f380edc130e600c37cf8ef2b0ae847e287e91a59c036e638461462c7b2fc83401a5c348501429fe107becacbdd906188

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.6.0] - 2021-04-15
+
+- Improved HTML parsing accuracy
+
 ## [0.5.0] - 2021-02-25
 
 - When `nil` is supplied for the `language` parameter, it is now treated as the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    srx (0.5.0)
+    srx (0.6.0)
       nokogiri (~> 1.11)
 
 GEM
@@ -14,29 +14,29 @@ GEM
     diff-lcs (1.4.4)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     memory_profiler (1.0.0)
-    minitest (5.14.3)
-    nokogiri (1.11.1-x86_64-darwin)
+    minitest (5.14.4)
+    nokogiri (1.11.3-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     racc (1.5.2)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     reverse_markdown (2.0.0)
       nokogiri
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.10.0)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -48,7 +48,7 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    solargraph (0.40.3)
+    solargraph (0.40.4)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)

data/lib/srx/format/html.rb

@@ -5,11 +5,23 @@ require 'English'
 
 module Srx
   module Format
-    # Support for XML
+    # Support for HTML. Tag grammar based on XML.
     #
     # @see https://www.w3.org/TR/xml/
+    # @see https://html.spec.whatwg.org/multipage/syntax.html
     class Html < Xml
-      START_TAG_CAPTURE = /<(?<name>#{Xml::NAME})(?:#{Xml::SPACE}#{Xml::ATTRIBUTE})*#{Xml::SPACE}?>/.freeze
+      # Differs from XML in supporting unquoted values
+      # @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+      ATT_VALUE = /#{Xml::ATT_VALUE}|(?:[^<>&"'`=\u0020\u0009\u000D\u000A]|#{Xml::REFERENCE})+/.freeze
+
+      # Differs from XML in supporting empty attributes
+      # @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+      ATTRIBUTE = /#{Xml::NAME}(?:#{Xml::EQUALS}#{ATT_VALUE})?/.freeze
+
+      START_TAG = /<(?<name>#{Xml::NAME})(?:#{Xml::SPACE}#{ATTRIBUTE})*#{Xml::SPACE}?>/.freeze
+      EMPTY_ELEM_TAG = %r{<#{Xml::NAME}(?:#{Xml::SPACE}#{ATTRIBUTE})*#{Xml::SPACE}?/>}.freeze
+
+      TAG = /#{START_TAG}|#{Xml::END_TAG}|#{EMPTY_ELEM_TAG}/.freeze
 
       # A set of HTML tags that are "void elements", meaning they do not need a
       # paired closing tag.
@@ -23,16 +35,20 @@ module Srx
         'link', 'meta', 'menuitem', 'param', 'source', 'track', 'wbr'
       ].freeze
 
+      def extract_markups(str)
+        extract_markups_by_pattern(str, TAG)
+      end
+
       def start_formatting?(markup)
-        START_TAG_CAPTURE.match(markup) do |m|
+        START_TAG.match(markup) do |m|
           !VOID_ELEMENTS.include?(m['name'])
         end
       end
 
       def isolated_formatting?(markup)
-        return true if super(markup)
+        return true if EMPTY_ELEM_TAG.match?(markup)
 
-        START_TAG_CAPTURE.match(markup) do |m|
+        START_TAG.match(markup) do |m|
           VOID_ELEMENTS.include?(m['name'])
         end
       end

data/lib/srx/format/xml.rb

@@ -27,14 +27,7 @@ module Srx
       TAG = /#{START_TAG}|#{END_TAG}|#{EMPTY_ELEM_TAG}/.freeze
 
       def extract_markups(str)
-        markups = []
-
-        plain_text = str.gsub(TAG) do |match|
-          markups << [$LAST_MATCH_INFO.begin(0), match]
-          ''
-        end
-
-        [plain_text, markups]
+        extract_markups_by_pattern(str, TAG)
       end
 
       def start_formatting?(markup)
@@ -48,6 +41,21 @@ module Srx
       def isolated_formatting?(markup)
         EMPTY_ELEM_TAG.match?(markup)
       end
+
+      protected
+
+      # @param str [String]
+      # @param pattern [Regexp]
+      def extract_markups_by_pattern(str, pattern)
+        markups = []
+
+        plain_text = str.gsub(pattern) do |match|
+          markups << [$LAST_MATCH_INFO.begin(0), match]
+          ''
+        end
+
+        [plain_text, markups]
+      end
     end
   end
 end

data/lib/srx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Srx
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: srx
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Aaron Madlon-Kay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri