rubocop-md 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3456efa614f5cb4f801f7b8b247e53b42022adfcdbffd3fab4752f4698ce321b
-  data.tar.gz: ac12ebd0c7bed14a4c05afd24bd24f1e463ffa0541dcf8a55353f52fbe3c9afd
+  metadata.gz: bbf66c2759aece8c1924b0a8d54752bc9973a5c6435494f996564e60fcb02f19
+  data.tar.gz: 261e4725b749854bc320b7f9b14cd7d1fbabfbb0c179c16e0530ed35ba092f72
 SHA512:
-  metadata.gz: 5309505cbbf58587a74f8ea7c50435f9258163cbc9ba8e75fa6f4361a92c13d05fe401bec4f8cb7611d26cefdf9a9f9f2adad0e4e1395d000c7d4f0b44f4754b
-  data.tar.gz: 5cded0021d44ef0bdfb02279eefffd7eed20cf2c5c184c1de65fe9e2559fb86111ae09a96068a271c890f8d1d662c98a875d3d4f8e81af8840a5bfea99d5a1e9
+  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/.travis.yml

@@ -0,0 +1,33 @@
+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/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 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.
+
 ## 1.0.0 (2020-12-24)
 
 - Drop Ruby 2.4 support and require RuboCop 1.0.

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/config/default.yml

@@ -22,7 +22,7 @@ Layout/TrailingEmptyLines:
     - '**/*.md'
     - '**/*.markdown'
 
-Lint/UselessAssignment:
+Layout/EmptyLineBetweenDefs:
   Exclude:
     - '**/*.md'
     - '**/*.markdown'

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.0"
+    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.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,6 +80,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -117,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