rubocop-md 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481459568a982c49d109a7514bc891f22acf485a22954372eae24fb94e7543bc
-  data.tar.gz: 9af60abc5f0fc512eeeba617cf52b12ce471db0ff0b39e452f2e5ac246dad51a
+  metadata.gz: 2e1a8d57e542393892dbdf2f9ffd7229d82e1996e900dd33edec55c0b94371ef
+  data.tar.gz: 5503ee8519df1ead15a2ae9602ffc4e960a6d6ddd2d36f32e0dea39c6ac87eef
 SHA512:
-  metadata.gz: 8f7b69a5a9bb3aec08882635b3746ed6aececc5c485b3d228564c66bc41fbb06935b1574b69027fb18c7fdd1c6515a17e8f7f1a99e83b8b9ad2b1daa4de06bd2
-  data.tar.gz: 2917282ce852086f06facda93acdd037a5782f217376b709c00ab05a0805bf72c4e7ac67520e2a99ed60a17dbd7339eb74b57e9564fad65d96956a5326724574
+  metadata.gz: 3e0c6ff91ac90e928919e12774f4b1013e67b2957e1b3dfc958ef177f1c74ec3f2eb494ffe58c1a98946a69bc1eace0f79dd5664055f448388fedd02cbe7e824
+  data.tar.gz: d24bc990a119f44ddb136047bcf3423934d8252ee340cdc09b9500cf42da09aa352f0a58e8f22d249f9449cad2fb71681f5689c65af760697b493222899e7814

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 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.
+
 ## 1.2.0 (2023-01-31)
 
 - Fix parsing compound syntax hints in code snippets.

data/README.md

@@ -12,7 +12,12 @@ Run Rubocop against your Markdown files to make sure that code examples follow s
 - Preserves specified language (i.e., do not try to analyze "\`\`\`sh")
 - **Supports autocorrect 📝**
 
-This project was developed to keep [test-prof](https://github.com/test-prof/test-prof) guides consistent with Ruby style guide.
+This project was developed to keep [test-prof](https://github.com/test-prof/test-prof) guides consistent with Ruby style guide back in 2017. Since then, many popular Ruby projects adopted it, including:
+
+- [Ruby on Rails](https://github.com/rails/rails)
+- [AnyCable](https://github.com/anycable/anycable)
+- [ViewComponent](https://github.com/ViewComponent/view_component)
+- [Action Policy](https://github.com/palkan/action_policy)
 
 ## Installation
 
@@ -111,7 +116,7 @@ Lint/Void:
 
 You can use this tricks
 
-```md
+````md
 # my_post.md
 
 ... some markdown ...
@@ -129,7 +134,7 @@ end of snippet
 <span style="display:none;"># rubocop:enable all</span>
 
 ... continuation of article ...
-```
+````
 
 ## How it works?
 

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
 
@@ -42,9 +45,10 @@ RuboCop::Markdown.inject!
 
 RuboCop::Runner.prepend(Module.new do
   # Set config store for Markdown
-  def initialize(*args)
+  def get_processed_source(*args)
+    RuboCop::Markdown.config_store = @config_store unless RuboCop::Markdown.config_store
+
     super
-    RuboCop::Markdown.config_store = @config_store
   end
 
   # Do not cache markdown files, 'cause cache doesn't know about processing.
@@ -60,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.0"
+    VERSION = "1.2.2"
   end
 end

data/lib/rubocop/markdown.rb

@@ -9,7 +9,7 @@ module RuboCop
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
 
-    require_relative "./markdown/preprocess"
-    require_relative "./markdown/rubocop_ext" if defined?(::RuboCop::ProcessedSource)
+    require_relative "markdown/preprocess"
+    require_relative "markdown/rubocop_ext" if defined?(::RuboCop::ProcessedSource)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -74,28 +74,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gem_release.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/lint.yml"
-- ".github/workflows/test-jruby.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - config/default.yml
-- gemfiles/rubocopmaster.gemfile
 - lib/rubocop-md.rb
 - lib/rubocop/markdown.rb
 - lib/rubocop/markdown/preprocess.rb
 - lib/rubocop/markdown/rubocop_ext.rb
 - lib/rubocop/markdown/version.rb
-- rubocop-md.gemspec
-homepage: https://github.com/palkan/rubocop-md
+homepage: https://github.com/rubocop-hq/rubocop-md
 licenses:
 - MIT
 metadata:
@@ -119,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Run Rubocop against your Markdown files to make sure that code examples follow

data/.gem_release.yml

@@ -1,3 +0,0 @@
-bump:
-  file: lib/rubocop/markdown/version.rb
-  skip_ci: true

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      interval: 'weekly'

data/.github/workflows/lint.yml

@@ -1,41 +0,0 @@
-name: Lint
-
-on:
-  push:
-    branches:
-    - master
-  pull_request:
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-      CI: true
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-        bundler-cache: true
-    - name: Run Rubocop
-      run: |
-        bundle exec rubocop
-  rubocop-md:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-      CI: true
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.1
-        bundler-cache: true
-    - name: Run Rubocop
-      run: |
-        bundle exec rubocop -r./lib/rubocop-md.rb README.md CHANGELOG.md
-        git status
-        git diff --exit-code

data/.github/workflows/test-jruby.yml

@@ -1,24 +0,0 @@
-name: JRuby Test
-
-on:
-  push:
-    branches:
-    - master
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-      CI: true
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: jruby
-        bundler-cache: true
-    - name: Run tests
-      run: |
-        bundle exec rake test

data/.github/workflows/test.yml

@@ -1,38 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches:
-    - master
-  pull_request:
-  schedule:
-    - cron: "10 4 * * */2"
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-      CI: true
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2", ruby-head]
-        gemfile: [
-          "Gemfile"
-        ]
-        include:
-        - ruby: "2.6"
-          gemfile: "Gemfile"
-        - ruby: "3.1"
-          gemfile: "gemfiles/rubocopmaster.gemfile"
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run tests
-      run: |
-        bundle exec rake test

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/Gemfile.local
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rubocop.yml

@@ -1,63 +0,0 @@
-AllCops:
-  NewCops: enable
-  Include:
-    - 'lib/**/*.rb'
-    - 'lib/**/*.rake'
-    - 'test/**/*.rb'
-  Exclude:
-    - 'bin/**/*'
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-    - 'Rakefile'
-    - 'Gemfile'
-    - '*.gemspec'
-  DisplayCopNames: true
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.5
-  SuggestExtensions: false
-
-Style/Documentation:
-  Exclude:
-    - 'test/**/*.rb'
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'test/**/*.rb'
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: no_space
-
-Naming/FileName:
-  Exclude:
-    - 'lib/rubocop-md.rb'
-
-Layout/LineLength:
-  Max: 100
-  Exclude:
-    - 'test/**/*.rb'
-
-Metrics/MethodLength:
-  Exclude:
-    - 'test/**/*.rb'
-
-Metrics/ClassLength:
-  Exclude:
-    - 'test/**/*.rb'

data/.travis.yml

@@ -1,33 +0,0 @@
-sudo: false
-language: ruby
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-
-notifications:
-  email: false
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/rubocopmaster.gemfile
-    - rvm: jruby-9.2.8.0
-      gemfile: Gemfile
-    - rvm: 2.7
-      gemfile: gemfiles/rubocopmaster.gemfile
-    - rvm: 2.7
-      gemfile: Gemfile
-    - rvm: 2.6
-      gemfile: Gemfile
-    - rvm: 2.5
-      gemfile: Gemfile
-    - rvm: 2.4.2
-      gemfile: Gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/rubocopmaster.gemfile
-    - rvm: jruby-9.2.8.0
-      gemfile: Gemfile
-    - rvm: 2.5.0
-      gemfile: gemfiles/rubocopmaster.gemfile

data/Gemfile

@@ -1,12 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in rubocop-md.gemspec
-gemspec
-
-local_gemfile = "Gemfile.local"
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-end

data/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rubocop/rake_task"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.warning = false
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-RuboCop::RakeTask.new
-
-task default: [:rubocop, :test]

data/gemfiles/rubocopmaster.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "rubocop", github: "bbatsov/rubocop"
-
-gemspec path: ".."

data/rubocop-md.gemspec

@@ -1,37 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/markdown/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "rubocop-md"
-  spec.version       = RuboCop::Markdown::VERSION
-  spec.authors       = ["Vladimir Dementyev"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = %q{Run Rubocop against your Markdown files to make sure that code examples follow style guidelines.}
-  spec.description   = %q{Run Rubocop against your Markdown files to make sure that code examples follow style guidelines.}
-  spec.homepage      = "https://github.com/palkan/rubocop-md"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.metadata = {
-    "bug_tracker_uri" => "http://github.com/rubocop-hq/rubocop-md/issues",
-    "changelog_uri" => "https://github.com/rubocop-hq/rubocop-md/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://github.com/rubocop-hq/rubocop-md/blob/master/README.md",
-    "homepage_uri" => "https://github.com/rubocop-hq/rubocop-md",
-    "source_code_uri" => "http://github.com/rubocop-hq/rubocop-md"
-  }
-
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "rubocop", ">= 1.0"
-
-  spec.add_development_dependency "bundler", ">= 1.15"
-  spec.add_development_dependency "rake", ">= 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-end