rubocop-md 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e95074f390ef2a3e4dbe7fe57399cfd4066d661
-  data.tar.gz: 2717015145fb478f8dbeb7778e1f1423d34b1195
+  metadata.gz: 0e46efefca545c73bc0fabdb88966fdb1894d9bf
+  data.tar.gz: 2f843d47ab0553f8595f0ef7233cc9095349c070
 SHA512:
-  metadata.gz: 6f7dd5441cc1b408114e524be0bf7eae2a9415331801a8157e4d484a610a0661986e9bfc0b462454982fc2e35b0a2d72975e1b464d2b0b65a49c800f87860d21
-  data.tar.gz: c61d81e351f7be36dac4fbd6ebbcb010f3d8fdd9f33439ff736b379692a89f9b26c50b38935fc93b3d3fd27a03c5c35363497cac7df29a7e4241d8d3e9c4fa33
+  metadata.gz: 7e27a59d16c41ad2f3374d764b7172f3041a62e5c5c5809bdce88e644fe6d7f27c2e847123f398ec272f687bf797a4b130def0dbc4b9d3f5be19f2e343ff142a
+  data.tar.gz: 795ed0e01b160c7e5ac3ad18dfd50e39adcc96725e91bd210bec64e9008622f70d07f4536125900a794345a25c4979bbe89905ab5a4d8aa733779e62d4eb18f0

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/Gemfile.local
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -31,6 +31,9 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'test/**/*.rb'
 
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
 Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
 

data/.travis.yml

@@ -1,5 +1,17 @@
 sudo: false
 language: ruby
-rvm:
-  - 2.4.2
 before_install: gem install bundler -v 1.15.4
+
+matrix:
+  fast_finish: true
+  include:
+    - rvm: ruby-head
+      gemfile: gemfiles/rubocopmaster.gemfile
+    - rvm: jruby-9.1.0.0
+      gemfile: Gemfile
+    - rvm: 2.4.2
+      gemfile: Gemfile
+    - rvm: 2.3.1
+      gemfile: Gemfile
+    - rvm: 2.2.0
+      gemfile: Gemfile

data/Gemfile

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

data/README.md

@@ -1,7 +1,18 @@
-# Rubocop Mardkdown
+[![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)
 
-Run Rubocop against your Markdown files to make sure that code examples follow style guidelines.
+# Rubocop Markdown
 
+Run Rubocop against your Markdown files to make sure that code examples follow style guidelines and have valid syntax.
+
+## Features
+
+- Analyzes code blocks within Markdown files
+- Shows correct line numbers in output
+- 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.
 
 ## Installation
 
@@ -21,7 +32,49 @@ Or install it yourself as:
 
 ## Usage
 
-TBD
+### Command line
+
+Just require `rubocop-md` in your command:
+
+```sh
+rubocop -r "rubocop-md" ./lib
+```
+
+Autocorrect works too:
+
+```sh
+rubocop -r "rubocop-md" -a ./lib
+```
+
+### Configuration file
+
+First, add `rubocop-md` to your `.rubocop.yml`:
+
+```yml
+require:
+ - "rubocop-md"
+```
+
+Additional options:
+
+```yml
+# .rubocop.yml
+Markdown:
+  # Whether to run RuboCop against non-valid snippets
+  WarnInvalid: true
+```
+
+## How it works?
+
+- Preprocess Markdown source into Ruby source preserving line numbers
+- Let RuboCop do its job
+- Restore Markdown from preprocessed Ruby if it has been autocorrected
+
+## 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
+- No language detection included; if you do not specify language for your code blocks, you'd better turn `WarnInvalid` off (see above)
 
 ## Development
 

data/config/default.yml

@@ -1,3 +1,6 @@
+Markdown:
+  WarnInvalid: true
+
 Layout/CommentIndentation:
   Exclude:
     - '**/*.md'

data/gemfiles/rubocopmaster.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rubocop", github: "bbatsov/rubocop"
+
+gemspec path: ".."

data/lib/rubocop/markdown/preprocess.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Markdown
     # Transform source Markdown file into valid Ruby file
     # by commenting out all non-code lines
-    module Preprocess
+    class Preprocess
       # This is a regexp to extract code blocks from .md files.
       #
       # Only recognizes backticks-style code blocks.
@@ -45,31 +45,6 @@ module RuboCop
       end
 
       class << self
-        # rubocop:disable Metrics/MethodLength
-        def call(src)
-          parts = src.split(MD_REGEXP)
-
-          walker = Walker.new
-
-          parts.each do |part|
-            if walker.code_body?
-              next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(part)
-            end
-
-            if walker.code_attr?
-              @syntax = part.gsub(/(^\s+|\s+$)/, "")
-              next walker.next!
-            end
-
-            comment_lines! part
-
-            walker.next!
-          end
-
-          parts.join
-        end
-        # rubocop:enable Metrics/MethodLength
-
         # Revert preprocess changes.
         #
         # When autocorrect is applied, RuboCop re-writes the file
@@ -81,25 +56,62 @@ module RuboCop
           contents.gsub!(/^##{MARKER}/m, "")
           File.write(file, contents)
         end
+      end
 
-        private
+      attr_reader :config
 
-        # Check codeblock attribute to prevent from parsing
-        # non-Ruby snippets and avoid false positives
-        def maybe_ruby?(syntax)
-          syntax.empty? || RUBY_TYPES.include?(syntax)
-        end
+      def initialize(file)
+        @config = Markdown.config_store.for(file)
+      end
 
-        # Try to parse with Ripper.
-        # Invalid Ruby (non-Ruby) code returns `nil`.
-        def valid_syntax?(src)
-          !Ripper.sexp(src).nil?
-        end
+      # rubocop:disable Metrics/MethodLength
+      def call(src)
+        parts = src.split(MD_REGEXP)
+
+        walker = Walker.new
 
-        def comment_lines!(src)
-          return if src =~ /\A\n\z/
-          src.gsub!(/^(.)/m, "##{MARKER}\\1")
+        parts.each do |part|
+          if walker.code_body?
+            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(part)
+          end
+
+          if walker.code_attr?
+            @syntax = part.gsub(/(^\s+|\s+$)/, "")
+            next walker.next!
+          end
+
+          comment_lines! part
+
+          walker.next!
         end
+
+        parts.join
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      # Check codeblock attribute to prevent from parsing
+      # non-Ruby snippets and avoid false positives
+      def maybe_ruby?(syntax)
+        syntax.empty? || 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?
+        !Ripper.sexp(src).nil?
+      end
+
+      # Where to show warning when snippet is not a valid Ruby
+      def warn_invalid?
+        config["Markdown"] && config["Markdown"].fetch("WarnInvalid", false)
+      end
+
+      def comment_lines!(src)
+        return if src =~ /\A\n\z/
+        src.gsub!(/^(.)/m, "##{MARKER}\\1")
       end
     end
   end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -2,19 +2,22 @@ module RuboCop
   module Markdown # :nodoc:
     MARKDOWN_EXTENSIONS = %w[.md .markdown].freeze
 
-    # Merge markdown config into default configuration
-    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-    def self.inject!
-      path = CONFIG_DEFAULT.to_s
-      hash = ConfigLoader.send(:load_yaml_configuration, path)
-      config = Config.new(hash, path)
-      puts "configuration from #{path}" if ConfigLoader.debug?
-      config = ConfigLoader.merge_with_default(config, path)
-      ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
+    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!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
 
-    def self.markdown_file?(file)
-      MARKDOWN_EXTENSIONS.include?(File.extname(file))
+      def markdown_file?(file)
+        MARKDOWN_EXTENSIONS.include?(File.extname(file))
+      end
     end
   end
 end
@@ -22,6 +25,12 @@ end
 RuboCop::Markdown.inject!
 
 RuboCop::Runner.prepend(Module.new do
+  # Set config store for Markdown
+  def initialize(*)
+    super
+    RuboCop::Markdown.config_store = @config_store
+  end
+
   # Do not cache markdown files, 'cause cache doesn't know about processing.
   # NOTE: we should involve preprocessing in RuboCop::CachedData#deserialize_offenses
   def file_offense_cache(file)
@@ -51,7 +60,7 @@ end)
 RuboCop::ProcessedSource.prepend(Module.new do
   def parse(src, *args)
     # only process Markdown files
-    src = RuboCop::Markdown::Preprocess.call(src) if
+    src = RuboCop::Markdown::Preprocess.new(path).call(src) if
       path.nil? || RuboCop::Markdown.markdown_file?(path)
     super(src, *args)
   end

data/lib/rubocop/markdown/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Markdown
-    VERSION = "0.1.0.pre".freeze
+    VERSION = "0.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - bin/setup
 - config/default.yml
+- gemfiles/rubocopmaster.gemfile
 - lib/rubocop-md.rb
 - lib/rubocop/markdown.rb
 - lib/rubocop/markdown/preprocess.rb
@@ -105,9 +106,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13