rubocop-md 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79797f2e2130aabc8bac1cc72ecefe5acdb367d2
-  data.tar.gz: 4094bca4c4e9be29fa8b6630415e70c23a562838
+SHA256:
+  metadata.gz: 4e0bc7a246c9b83d118a61ec06d5a5142c5444d89143db2b5782eeaad048d1fb
+  data.tar.gz: 5fa52e9b357b75c79cffbf8d4ed1d8d7fa5e19435082e70f38e1bbd02fd0d80c
 SHA512:
-  metadata.gz: 60508616bb720460e5f6653aa0fa4ce852ad790858c32a52091e146d182d77cb6ac7d6a3ff0980c0917364aa21c8636e3d4529f0722ab161b821e9cc19320769
-  data.tar.gz: aa8cb2cdfd4416790d977f84a53feb031d551f2111ec701b3759a0fcb4ddc2fe8e1806685be0565b437b9ff08c48e282e2e418088d398087319f807f90d04873
+  metadata.gz: c29861c629e268aab54631f72d72971b6991d4b8413d65083d68b5726e321aabd6ee45a29e594b18efc37d10ece6a4d1c8ebf9927ef8a0fee9c291c7d841939d
+  data.tar.gz: 717e225fce45263a727732a4b7e17b3e98fde179b82bfe259631657767f6dc7210fb22e7885fab51d6502bdf446403fc9b65c473fb16b3075791503e710be08c

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Include:
     - 'lib/**/*.rb'
     - 'lib/**/*.rake'
@@ -12,10 +13,7 @@ AllCops:
     - '*.gemspec'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.2
-
-Rails:
-  Enabled: false
+  TargetRubyVersion: 2.4
 
 Style/Documentation:
   Exclude:
@@ -31,13 +29,26 @@ 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
 
-Metrics/LineLength:
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-md.rb'
+
+Layout/LineLength:
   Max: 100
   Exclude:
     - 'test/**/*.rb'

data/.travis.yml

@@ -1,28 +1,33 @@
 sudo: false
 language: ruby
-before_install: gem install bundler -v 1.15.4
+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.1.0.0
+    - rvm: jruby-9.2.8.0
       gemfile: Gemfile
-    - rvm: 2.5.0
+    - rvm: 2.7
       gemfile: gemfiles/rubocopmaster.gemfile
-    - rvm: 2.5.0
+    - rvm: 2.7
       gemfile: Gemfile
-    - rvm: 2.4.2
+    - rvm: 2.6
       gemfile: Gemfile
-    - rvm: 2.3.1
+    - rvm: 2.5
       gemfile: Gemfile
-    - rvm: 2.2.0
+    - rvm: 2.4.2
       gemfile: Gemfile
   allow_failures:
     - rvm: ruby-head
       gemfile: gemfiles/rubocopmaster.gemfile
-    - rvm: jruby-9.1.0.0
+    - rvm: jruby-9.2.8.0
       gemfile: Gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rubocopmaster.gemfile

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Change log
+
+## master (unreleased)
+
+## 0.4.1 (2020-11-05)
+
+- Relax required RuboCop version.
+
+## 0.4.0 (2020-07-03)
+
+- [#10](https://github.com/rubocop-hq/rubocop-md/pull/10): **Drop Ruby 2.3 support** ([@dominicsayers][])
+
+## 0.3.2 (2020-03-18)
+
+- [#9](https://github.com/rubocop-hq/rubocop-md/pull/9): Add file extensions for Markdown ([@ybiquitous][])
+
+## 0.3.1 (2019-12-25)
+
+- Upgrade to RuboCop 0.78 ([@palkan][])
+
+Change the default config to use the new cop names for (e.g., `Layout/LineLength`).
+
+## 0.3.0 (2019-05-14)
+
+- **Drop Ruby 2.2 support** ([@palkan][])
+
+[@palkan]: https://github.com/palkan
+[@ybiquitous]: https://github.com/ybiquitous
+[@dominicsayers]: https://github.com/dominicsayers

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Vladimir Dementyev
+Copyright (c) 2017-2019 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

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop-md.svg)](http://badge.fury.io/rb/rubocop-md)
-[![Travis Status](https://travis-ci.org/palkan/rubocop-md.svg?branch=master)](https://travis-ci.org/palkan/rubocop-md)
+[![Travis Status](https://travis-ci.org/rubocop-hq/rubocop-md.svg?branch=master)](https://travis-ci.org/rubocop-hq/rubocop-md)
 
 # Rubocop Markdown
 
@@ -12,7 +12,7 @@ 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/palkan/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.
 
 ## Installation
 
@@ -24,7 +24,7 @@ gem 'rubocop-md'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -60,7 +60,7 @@ At first, add `rubocop-md` to your main `.rubocop.yml`:
 # .rubocop.yml
 
 require:
- - "rubocop-md"
+  - "rubocop-md"
 ```
 
 *Notice: additional options*
@@ -107,6 +107,28 @@ Lint/Void:
     - '*.md'
 ```
 
+### But if I want to use inline disabling some directive like in classic RuboCop?
+
+You can use this tricks
+
+```
+# my_post.md
+
+... some markdown ...
+
+<span style="display:none;"># rubocop:disable all</span>
+
+```ruby
+def my_poor_method(foo)
+  [:a, :b, :c] + ["#{foo}".to_sym]
+end
+``` end of snippet
+
+<span style="display:none;"># rubocop:enable all</span>
+
+... continuation of article ...
+```
+
 ## How it works?
 
 - Preprocess Markdown source into Ruby source preserving line numbers
@@ -129,7 +151,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/palkan/rubocop-md.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop-hq/rubocop-md.
 
 ## License
 

data/config/default.yml

@@ -17,6 +17,16 @@ Layout/TrailingBlankLines:
     - '**/*.md'
     - '**/*.markdown'
 
+Layout/TrailingEmptyLines:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Lint/UselessAssignment:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
 Naming/FileName:
   Exclude:
     - '**/*.md'
@@ -42,6 +52,6 @@ Style/FrozenStringLiteralComment:
     - '**/*.md'
     - '**/*.markdown'
 
-Metrics/LineLength:
+Layout/LineLength:
   IgnoredPatterns:
     - !ruby/regexp /^\#/

data/lib/rubocop-md.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "rubocop/markdown"

data/lib/rubocop/markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubocop/markdown/version"
 require "pathname"
 

data/lib/rubocop/markdown/preprocess.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "ripper"
 
 module RuboCop
@@ -10,9 +12,9 @@ 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
+      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m.freeze
 
-      MARKER = "<--rubocop/md-->".freeze
+      MARKER = "<--rubocop/md-->"
 
       # See https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L3925
       RUBY_TYPES = %w[
@@ -71,8 +73,8 @@ module RuboCop
         walker = Walker.new
 
         parts.each do |part|
-          if walker.code_body?
-            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
+          if walker.code_body? && maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
+            next walker.next!
           end
 
           if walker.code_attr?
@@ -107,22 +109,24 @@ module RuboCop
       # Return true if it's explicit Ruby and warn_invalid?
       def valid_syntax?(syntax, src)
         return true if ruby?(syntax) && warn_invalid?
+
         !Ripper.sexp(src).nil?
       end
 
       # Whether to show warning when snippet is not a valid Ruby
       def warn_invalid?
-        config["Markdown"] && config["Markdown"].fetch("WarnInvalid", true)
+        config["Markdown"]&.fetch("WarnInvalid", true)
       end
 
       # Whether to try to detect Ruby by parsing codeblock.
       # If it's set to false we lint only implicitly specified Ruby blocks.
       def autodetect?
-        config["Markdown"] && config["Markdown"].fetch("Autodetect", true)
+        config["Markdown"]&.fetch("Autodetect", true)
       end
 
       def comment_lines!(src)
         return if src =~ /\A\n\z/
+
         src.gsub!(/^(.)/m, "##{MARKER}\\1")
       end
     end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -1,9 +1,25 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Markdown # :nodoc:
-    MARKDOWN_EXTENSIONS = %w[.md .markdown].freeze
+    # According to Linguist.
+    # See https://github.com/github/linguist/blob/96ca71ab99c2f9928d5d69f4c08fd2a51440d045/lib/linguist/languages.yml#L3065-L3083
+    MARKDOWN_EXTENSIONS = %w[
+      .md
+      .markdown
+      .mdown
+      .mdwn
+      .mdx
+      .mkd
+      .mkdn
+      .mkdown
+      .ronn
+      .workbook
+    ].freeze
 
     class << self
       attr_accessor :config_store
+
       # Merge markdown config into default configuration
       # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
       def inject!
@@ -35,6 +51,7 @@ RuboCop::Runner.prepend(Module.new do
   # NOTE: we should involve preprocessing in RuboCop::CachedData#deserialize_offenses
   def file_offense_cache(file)
     return yield if RuboCop::Markdown.markdown_file?(file)
+
     super
   end
 
@@ -61,7 +78,7 @@ RuboCop::ProcessedSource.prepend(Module.new do
   def parse(src, *args)
     # only process Markdown files
     src = RuboCop::Markdown::Preprocess.new(path).call(src) if
-      path.nil? || RuboCop::Markdown.markdown_file?(path)
+      path && RuboCop::Markdown.markdown_file?(path)
     super(src, *args)
   end
 end)

data/lib/rubocop/markdown/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Markdown
-    VERSION = "0.2.0".freeze
+    VERSION = "0.4.1"
   end
 end

data/rubocop-md.gemspec

@@ -17,11 +17,21 @@ Gem::Specification.new do |spec|
     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.4.0"
+
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rubocop", "~> 0.50"
+  spec.add_runtime_dependency "rubocop", ">= 0.60"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.15"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.60'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,7 +95,12 @@ files:
 homepage: https://github.com/palkan/rubocop-md
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,15 +109,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Run Rubocop against your Markdown files to make sure that code examples follow