rubocop-md 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5b04c2e0fbc284635fa82174064344fee7bbd71
-  data.tar.gz: 0abd5499484c03abbdae84b89a82af505a025df8
+SHA256:
+  metadata.gz: fc562e28add38f2053f69cfedb41bc66d86398191a6eaa55c067b33f738ecfe8
+  data.tar.gz: 5b9281774067e963d133b33674395b1cc92ade3d76d0a190f6eb8195464adbb2
 SHA512:
-  metadata.gz: a943e124c09fe2fea37d0199b32568cfe166caa0d4d3745482d7a9992950a19939f70a9a2dee4d117086c9f55d5fc44f7cae30c60af42ec12be9b6f9c46d5ddf
-  data.tar.gz: 65a2893d0e458f66b94271632060e238cc089ef6bfeeb120df6bc6aeea5838068b62c3ff07742227395a9ab2c30f0420be720d318f42259dc93341b25bd28ba6
+  metadata.gz: 4ddbf872ef05fb4f9ce11906f186970c9516eb5dfdf8560a369ed26c726b790226b0355510b59ca766d26f4bc6dc5c821b34ed635e8ba9fa30f541c68354d2bc
+  data.tar.gz: 54a503aa50566c9fa9f8e86cafe3f207c228c4aead514775f5bebee0d8c2f6e04be5b83d1c45ce0152895dfe4f1ffaf78b6b4137a63d95518e5ad49725301d36

data/.gem_release.yml

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

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,17 +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.4.2
+    - rvm: 2.7
+      gemfile: gemfiles/rubocopmaster.gemfile
+    - rvm: 2.7
       gemfile: Gemfile
-    - rvm: 2.3.1
+    - rvm: 2.6
       gemfile: Gemfile
-    - rvm: 2.2.0
+    - 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

@@ -0,0 +1,25 @@
+# Change log
+
+## master (unreleased)
+
+## 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
 
@@ -24,7 +24,7 @@ gem 'rubocop-md'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -46,22 +46,87 @@ Autocorrect works too:
 rubocop -r "rubocop-md" -a ./lib
 ```
 
-### Configuration file
+### Configuration
 
-First, add `rubocop-md` to your `.rubocop.yml`:
+Code in the documentation does not make sense to be checked for some style guidelines (eg `Style/FrozenStringLiteralComment`).
+
+We described such rules in the [default config](config/default.yml), but if you use the same settings in your project’s `.rubocop.yml` file, `RoboCop` will override them.
+
+Fortunately, `RuboCop` supports directory-level configuration and we can do the next trick.
+
+At first, add `rubocop-md` to your main `.rubocop.yml`:
 
 ```yml
+# .rubocop.yml
+
 require:
- - "rubocop-md"
+  - "rubocop-md"
 ```
 
-Additional options:
+*Notice: additional options*
 
 ```yml
 # .rubocop.yml
+
 Markdown:
   # Whether to run RuboCop against non-valid snippets
   WarnInvalid: true
+  # Whether to lint codeblocks without code attributes
+  Autodetect: true
+```
+
+Secondly, create empty `.rubocop.yml` in your docs directory.
+
+```bash
+├── docs
+│   ├── .rubocop.yml
+│   ├── doc1.md
+│   ├── doc2.md
+│   └── doc3.md
+├── lib
+├── .rubocop.yml # main
+└── ...
+```
+
+Third, just run
+
+```bash
+$ rubocop
+```
+
+Also you can add special rules in the second `.rubocop.yml`
+
+```ruby
+# rubocop.yml in docs folder
+
+Metrics/LineLength:
+  Max: 100
+
+Lint/Void:
+  Exclude:
+    - '*.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?
@@ -73,9 +138,11 @@ Markdown:
 ## Limitations
 
 - RuboCop cache is disabled for Markdown files (because cache knows nothing about preprocessing)
-- Uses naive Regexp-based approach to extract code blocks from Markdown, support only backticks-style code blocks
+- Uses naive Regexp-based approach to extract code blocks from Markdown, support only backticks-style code blocks\*
 - No language detection included; if you do not specify language for your code blocks, you'd better turn `WarnInvalid` off (see above)
 
+\* It should be easy to integrate a _real_ parser (e.g. [Kramdown](https://kramdown.gettalong.org)) and handle all possible syntax. Feel free to open an issue or pull request!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.

data/config/default.yml

@@ -1,5 +1,6 @@
 Markdown:
   WarnInvalid: true
+  Autodetect: true
 
 Layout/CommentIndentation:
   Exclude:
@@ -16,6 +17,16 @@ Layout/TrailingBlankLines:
     - '**/*.md'
     - '**/*.markdown'
 
+Layout/TrailingEmptyLines:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Lint/UselessAssignment:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
 Naming/FileName:
   Exclude:
     - '**/*.md'
@@ -41,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[
@@ -72,7 +74,7 @@ module RuboCop
 
         parts.each do |part|
           if walker.code_body?
-            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(part)
+            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
           end
 
           if walker.code_attr?
@@ -94,23 +96,37 @@ module RuboCop
       # Check codeblock attribute to prevent from parsing
       # non-Ruby snippets and avoid false positives
       def maybe_ruby?(syntax)
-        syntax.empty? || RUBY_TYPES.include?(syntax)
+        (autodetect? && syntax.empty?) || ruby?(syntax)
+      end
+
+      # Check codeblack attribute if it's defined and of Ruby type
+      def ruby?(syntax)
+        RUBY_TYPES.include?(syntax)
       end
 
-      # Try to parse with Ripper.
-      # Invalid Ruby (non-Ruby) code returns `nil`.
-      def valid_syntax?(src)
-        return true if warn_invalid?
+      # Try to parse with Ripper
+      # Invalid Ruby code (or non-Ruby) returns `nil`.
+      # 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
 
-      # Where to show warning when snippet is not a valid Ruby
+      # Whether to show warning when snippet is not a valid Ruby
       def warn_invalid?
-        config["Markdown"] && config["Markdown"].fetch("WarnInvalid", false)
+        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"]&.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!
@@ -26,7 +42,7 @@ RuboCop::Markdown.inject!
 
 RuboCop::Runner.prepend(Module.new do
   # Set config store for Markdown
-  def initialize(*)
+  def initialize(*args)
     super
     RuboCop::Markdown.config_store = @config_store
   end
@@ -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.1.1".freeze
+    VERSION = "0.4.0"
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,26 +16,26 @@ dependencies:
     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