rubocop-md 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd427ec8e44c548cc33d0894f4cc8b0375ae3d92cbd5dac2ec0e5d5159cfc8cd
-  data.tar.gz: 920755489abe9ccb53e04b3386c980ab5b633649c8d0bcbedc566d0219d99f38
+  metadata.gz: bbf66c2759aece8c1924b0a8d54752bc9973a5c6435494f996564e60fcb02f19
+  data.tar.gz: 261e4725b749854bc320b7f9b14cd7d1fbabfbb0c179c16e0530ed35ba092f72
 SHA512:
-  metadata.gz: b97928bbbf89b26e887baae4220f7db61f88897bc1e96bdaf623df188c0345839e49ccb9d66bb0569ef98a69efd6e7127fb9b760bf416c16909a79b367c93893
-  data.tar.gz: 63a5bc235da592a26613f1ada3a2992e0d0c878b2576909e35f0a65cbfeced0faf9e0fe69dbd2bb6e381cb3c24d9b40870c8d3461714655f7d133463ac759f3d
+  metadata.gz: '09983fd1562ce4d2ec4820799bf662be764910cff9a38c02ef2ef2a8c717b6d07ba25a7536cd36363a124583fe8f39cdaa502a8be58000c788813d5301f63c19'
+  data.tar.gz: 5acf841fdfadd326664bab788a9a3f2f706bce8454af1b177967ebaca8e648c051db9b7cf65129ca58a5d9548d0d365c09f76e05cf1d8abef49a80e930c97439

data/.github/workflows/lint.yml

@@ -15,19 +15,27 @@ jobs:
       CI: true
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/cache@v1
-      with:
-        path: /home/runner/bundle
-        key: bundle-lint-${{ hashFiles('Gemfile') }}-${{ hashFiles('**/*.gemspec') }}
-        restore-keys: |
-          bundle-lint-
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7
-    - name: Bundle install
-      run: |
-        bundle config path /home/runner/bundle
-        bundle install
+        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

@@ -15,20 +15,10 @@ jobs:
       CI: true
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/cache@v1
-      with:
-        path: /home/runner/bundle
-        key: bundle-${{ hashFiles('Gemfile') }}-${{ hashFiles('**/*.gemspec') }}
-        restore-keys: |
-          bundle-
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: jruby
-    - name: Bundle install
-      run: |
-        bundle config path /home/runner/bundle
-        bundle install
-        bundle update
+        bundler-cache: true
     - name: Run tests
       run: |
         bundle exec rake test

data/.github/workflows/test.yml

@@ -5,6 +5,8 @@ on:
     branches:
     - master
   pull_request:
+  schedule:
+    - cron: "10 4 * * */2"
 
 jobs:
   test:
@@ -16,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7"]
+        ruby: ["2.7", "3.0", "3.1", ruby-head]
         gemfile: [
           "Gemfile"
         ]
@@ -25,25 +27,14 @@ jobs:
           gemfile: "Gemfile"
         - ruby: "2.6"
           gemfile: "Gemfile"
-        - ruby: "2.7"
+        - ruby: "3.1"
           gemfile: "gemfiles/rubocopmaster.gemfile"
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/cache@v1
-      with:
-        path: /home/runner/bundle
-        key: bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles(matrix.gemfile) }}-${{ hashFiles('**/*.gemspec') }}
-        restore-keys: |
-          bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: Bundle install
-      run: |
-        bundle config path /home/runner/bundle
-        bundle config --global gemfile ${{ matrix.gemfile }}
-        bundle install
-        bundle update
+        bundler-cache: true
     - name: Run tests
       run: |
         bundle exec rake test

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 1.1.0 (2022-10-24)
+
+- Ignore offenses in non-code source.
+
 ## 1.0.1 (2020-12-28)
 
 - Exclude `EmptyLineBetweenDefs` for MD files.

data/Gemfile

@@ -5,8 +5,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in rubocop-md.gemspec
 gemspec
 
-gem "pry-byebug", platform: :mri
-
 local_gemfile = "Gemfile.local"
 
 if File.exist?(local_gemfile)

data/README.md

@@ -19,7 +19,7 @@ This project was developed to keep [test-prof](https://github.com/test-prof/test
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rubocop-md'
+gem "rubocop-md"
 ```
 
 And then execute:
@@ -96,7 +96,7 @@ $ rubocop
 
 Also you can add special rules in the second `.rubocop.yml`
 
-```ruby
+```yml
 # rubocop.yml in docs folder
 
 Metrics/LineLength:
@@ -111,7 +111,7 @@ Lint/Void:
 
 You can use this tricks
 
-```
+```md
 # my_post.md
 
 ... some markdown ...
@@ -122,7 +122,9 @@ You can use this tricks
 def my_poor_method(foo)
   [:a, :b, :c] + ["#{foo}".to_sym]
 end
-``` end of snippet
+```
+
+end of snippet
 
 <span style="display:none;"># rubocop:enable all</span>
 

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -55,14 +55,25 @@ RuboCop::Runner.prepend(Module.new do
     super
   end
 
-  # Run Preprocess.restore if file has been autocorrected
-  def process_file(file)
-    return super unless @options[:auto_correct] && RuboCop::Markdown.markdown_file?(file)
+  def inspect_file(*args)
+    super.tap do |(offenses, *)|
+      # Skip offenses reported for ignored MD source (trailing whitespaces, etc.)
+      marker_comment = "##{RuboCop::Markdown::Preprocess::MARKER}"
+      offenses.reject! do |offense|
+        offense.location.source_line.start_with?(marker_comment)
+      end
+    end
+  end
 
-    offenses = super
-    RuboCop::Markdown::Preprocess.restore!(file)
+  def file_finished(file, offenses)
+    return super unless RuboCop::Markdown.markdown_file?(file)
+
+    # Run Preprocess.restore if file has been autocorrected
+    if @options[:auto_correct] || @options[:autocorrect]
+      RuboCop::Markdown::Preprocess.restore!(file)
+    end
 
-    offenses
+    super(file, offenses)
   end
 end)
 

data/lib/rubocop/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Markdown
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Run Rubocop against your Markdown files to make sure that code examples follow