rubocop-md 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf66c2759aece8c1924b0a8d54752bc9973a5c6435494f996564e60fcb02f19
-  data.tar.gz: 261e4725b749854bc320b7f9b14cd7d1fbabfbb0c179c16e0530ed35ba092f72
+  metadata.gz: 8e4b62aa5ac22f5dd82b132acd7439582c1d7e4a925d8a44cfeb48f250d579aa
+  data.tar.gz: 5acca30ab4a740b8bb9fdd25bd1b769f96504a63c8f6e4d3460ddfe61c66dbcf
 SHA512:
-  metadata.gz: '09983fd1562ce4d2ec4820799bf662be764910cff9a38c02ef2ef2a8c717b6d07ba25a7536cd36363a124583fe8f39cdaa502a8be58000c788813d5301f63c19'
-  data.tar.gz: 5acf841fdfadd326664bab788a9a3f2f706bce8454af1b177967ebaca8e648c051db9b7cf65129ca58a5d9548d0d365c09f76e05cf1d8abef49a80e930c97439
+  metadata.gz: eb68e5947593be1fce3b2c7131d7a445615b3a9a47c86db9e5b5e31ba966e0c4f7030c20578e140cfe1f55b824e1224a6a2ef3206317db51fa7bd89b60d93e52
+  data.tar.gz: '0138f08797108912f2fdcc4b68fbff18e1def69a35a133d94a4cdc409f1a12f695ca8d155df4f3349fa99da0a551b9863a47e61b9984609ef2d815e553969a20'

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master (unreleased)
 
+## 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.
+
+- Drop Ruby 2.5 support.
+
 ## 1.1.0 (2022-10-24)
 
 - Ignore offenses in non-code source.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2021 Vladimir Dementyev
+Copyright (c) 2017-2023 Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

@@ -11,8 +11,8 @@ module RuboCop
       #
       # Only recognizes backticks-style code blocks.
       #
-      # Try it: http://rubular.com/r/iJaKBkSrrT
-      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m.freeze
+      # Try it: https://rubular.com/r/YMqSWiBuh2TKIJ
+      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]+]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m.freeze
 
       MARKER = "<--rubocop/md-->"
 

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -42,9 +42,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.

data/lib/rubocop/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Markdown
-    VERSION = "1.1.0"
+    VERSION = "1.2.1"
   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.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2023-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -74,27 +74,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gem_release.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:
@@ -103,7 +92,7 @@ metadata:
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,15 +100,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Run Rubocop against your Markdown files to make sure that code examples follow
   style guidelines.

data/.gem_release.yml

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

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@v2
-    - 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@v2
-    - 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@v2
-    - 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,40 +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", ruby-head]
-        gemfile: [
-          "Gemfile"
-        ]
-        include:
-        - ruby: "2.5"
-          gemfile: "Gemfile"
-        - ruby: "2.6"
-          gemfile: "Gemfile"
-        - ruby: "3.1"
-          gemfile: "gemfiles/rubocopmaster.gemfile"
-    steps:
-    - uses: actions/checkout@v2
-    - 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.5.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