rubocop-md 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4b62aa5ac22f5dd82b132acd7439582c1d7e4a925d8a44cfeb48f250d579aa
-  data.tar.gz: 5acca30ab4a740b8bb9fdd25bd1b769f96504a63c8f6e4d3460ddfe61c66dbcf
+  metadata.gz: 2e1a8d57e542393892dbdf2f9ffd7229d82e1996e900dd33edec55c0b94371ef
+  data.tar.gz: 5503ee8519df1ead15a2ae9602ffc4e960a6d6ddd2d36f32e0dea39c6ac87eef
 SHA512:
-  metadata.gz: eb68e5947593be1fce3b2c7131d7a445615b3a9a47c86db9e5b5e31ba966e0c4f7030c20578e140cfe1f55b824e1224a6a2ef3206317db51fa7bd89b60d93e52
-  data.tar.gz: '0138f08797108912f2fdcc4b68fbff18e1def69a35a133d94a4cdc409f1a12f695ca8d155df4f3349fa99da0a551b9863a47e61b9984609ef2d815e553969a20'
+  metadata.gz: 3e0c6ff91ac90e928919e12774f4b1013e67b2957e1b3dfc958ef177f1c74ec3f2eb494ffe58c1a98946a69bc1eace0f79dd5664055f448388fedd02cbe7e824
+  data.tar.gz: d24bc990a119f44ddb136047bcf3423934d8252ee340cdc09b9500cf42da09aa352f0a58e8f22d249f9449cad2fb71681f5689c65af760697b493222899e7814

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 1.2.2 (2023-12-01) ❄️
+
+- Fix analyzing code blocks with backticks.
+
 ## 1.2.1 (2023-10-20)
 
 - Fix incompatibility when loading the plugin from YAML and using other RuboCop options.

data/lib/rubocop/markdown/preprocess.rb

@@ -7,12 +7,18 @@ module RuboCop
     # Transform source Markdown file into valid Ruby file
     # by commenting out all non-code lines
     class Preprocess
-      # This is a regexp to extract code blocks from .md files.
+      # This is a regexp to parse code blocks from .md files.
       #
       # Only recognizes backticks-style code blocks.
       #
       # Try it: https://rubular.com/r/YMqSWiBuh2TKIJ
-      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]+]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m.freeze
+      MD_REGEXP = /
+        ^([[:blank:]]*`{3,4}) # Match opening backticks
+        ([\w[[:blank:]]+]*)?\n # Match the code block syntax
+        ([\s\S]+?) # Match everything inside the code block
+        (^[[:blank:]]*\1[[:blank:]]*\n?) # Match closing backticks
+        |(^.*$) # If we are not in a codeblock, match the whole line
+      /x.freeze
 
       MARKER = "<--rubocop/md-->"
 
@@ -26,26 +32,6 @@ module RuboCop
         rbx
       ].freeze
 
-      class Walker # :nodoc:
-        STEPS = %i[text code_start code_attr code_body code_end].freeze
-
-        STEPS.each do |step|
-          define_method("#{step}?") do
-            STEPS[current_step] == step
-          end
-        end
-
-        attr_accessor :current_step
-
-        def initialize
-          @current_step = 0
-        end
-
-        def next!
-          self.current_step = current_step == (STEPS.size - 1) ? 0 : current_step + 1
-        end
-      end
-
       class << self
         # Revert preprocess changes.
         #
@@ -68,31 +54,34 @@ module RuboCop
 
       # rubocop:disable Metrics/MethodLength
       def call(src)
-        parts = src.split(MD_REGEXP)
-
-        walker = Walker.new
-
-        parts.each do |part|
-          if walker.code_body? && maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
-            next walker.next!
+        src.gsub(MD_REGEXP) do |full_match|
+          m = Regexp.last_match
+          open_backticks = m[1]
+          syntax = m[2]
+          code = m[3]
+          close_backticks = m[4]
+          markdown = m[5]
+
+          if markdown
+            # We got markdown outside of a codeblock
+            comment_lines(markdown)
+          elsif ruby_codeblock?(syntax, code)
+            # The codeblock we parsed is assumed ruby, keep as is and append markers to backticks
+            "#{comment_lines(open_backticks + syntax)}\n#{code}#{comment_lines(close_backticks)}"
+          else
+            # The codeblock is not relevant, comment it out
+            comment_lines(full_match)
           end
-
-          if walker.code_attr?
-            @syntax = part.gsub(/(^\s+|\s+$)/, "")
-            next walker.next!
-          end
-
-          comment_lines! part
-
-          walker.next!
         end
-
-        parts.join
       end
       # rubocop:enable Metrics/MethodLength
 
       private
 
+      def ruby_codeblock?(syntax, src)
+        maybe_ruby?(syntax) && valid_syntax?(syntax, src)
+      end
+
       # Check codeblock attribute to prevent from parsing
       # non-Ruby snippets and avoid false positives
       def maybe_ruby?(syntax)
@@ -124,10 +113,8 @@ module RuboCop
         config["Markdown"]&.fetch("Autodetect", true)
       end
 
-      def comment_lines!(src)
-        return if src =~ /\A\n\z/
-
-        src.gsub!(/^(.)/m, "##{MARKER}\\1")
+      def comment_lines(src)
+        src.gsub(/^/, "##{MARKER}")
       end
     end
   end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -17,6 +17,9 @@ module RuboCop
       .workbook
     ].freeze
 
+    # A list of cops that could produce offenses in commented lines
+    MARKDOWN_OFFENSE_COPS = %w[Lint/Syntax].freeze
+
     class << self
       attr_accessor :config_store
 
@@ -61,6 +64,8 @@ RuboCop::Runner.prepend(Module.new do
       # Skip offenses reported for ignored MD source (trailing whitespaces, etc.)
       marker_comment = "##{RuboCop::Markdown::Preprocess::MARKER}"
       offenses.reject! do |offense|
+        next if RuboCop::Markdown::MARKDOWN_OFFENSE_COPS.include?(offense.cop_name)
+
         offense.location.source_line.start_with?(marker_comment)
       end
     end

data/lib/rubocop/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Markdown
-    VERSION = "1.2.1"
+    VERSION = "1.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop