rubocop-md 0.0.1 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7b9c73c1b57e18aa8503ec32612a418f0c2116
-  data.tar.gz: 41079271c626e418ceb341c681545fe557012825
+  metadata.gz: 1e95074f390ef2a3e4dbe7fe57399cfd4066d661
+  data.tar.gz: 2717015145fb478f8dbeb7778e1f1423d34b1195
 SHA512:
-  metadata.gz: 6dee3f3a08b43d79485d4344ca5980183bca18d0b7704782442a7c46c5ad3650daf6c24fa1b772fda78640ae13bfb29207ea731472401cb38f533ad7b2f674d8
-  data.tar.gz: d97dbadbf2742fca963c28a55db3af9006f11e9de6b194784ced04297af0148cf59b7fb9e34901a59f89595e9a078a85c1ab9e4781dee88bc7d97431ba1aa993
+  metadata.gz: 6f7dd5441cc1b408114e524be0bf7eae2a9415331801a8157e4d484a610a0661986e9bfc0b462454982fc2e35b0a2d72975e1b464d2b0b65a49c800f87860d21
+  data.tar.gz: c61d81e351f7be36dac4fbd6ebbcb010f3d8fdd9f33439ff736b379692a89f9b26c50b38935fc93b3d3fd27a03c5c35363497cac7df29a7e4241d8d3e9c4fa33

data/.gem_release.yml

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

data/.rubocop.yml

@@ -38,3 +38,11 @@ Metrics/LineLength:
   Max: 100
   Exclude:
     - 'test/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*.rb'

data/Rakefile

@@ -1,10 +1,14 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
+  t.warning = false
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :test]

data/config/default.yml

@@ -0,0 +1,38 @@
+Layout/CommentIndentation:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Layout/LeadingCommentSpace:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Layout/TrailingBlankLines:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Style/AsciiComments:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Style/Documentation:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Style/CommentAnnotation:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+
+Metrics/LineLength:
+  IgnoredPatterns:
+    - !ruby/regexp /^\#/

data/lib/rubocop/markdown/preprocess.rb

@@ -0,0 +1,106 @@
+require "ripper"
+
+module RuboCop
+  module Markdown
+    # Transform source Markdown file into valid Ruby file
+    # by commenting out all non-code lines
+    module Preprocess
+      # This is a regexp to extract code blocks from .md files.
+      #
+      # 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
+
+      MARKER = "<--rubocop/md-->".freeze
+
+      # See https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L3925
+      RUBY_TYPES = %w[
+        ruby
+        jruby
+        macruby
+        rake
+        rb
+        rbx
+      ].freeze
+
+      class Walker # :nodoc:
+        STEPS = %i[text code_start code_attr code_body code_end].freeze
+
+        STEPS.each do |step|
+          define_method("#{step}?") do
+            STEPS[current_step] == step
+          end
+        end
+
+        attr_accessor :current_step
+
+        def initialize
+          @current_step = 0
+        end
+
+        def next!
+          self.current_step = current_step == (STEPS.size - 1) ? 0 : current_step + 1
+        end
+      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
+        # using preproccessed source buffer.
+        #
+        # We have to restore it.
+        def restore!(file)
+          contents = File.read(file)
+          contents.gsub!(/^##{MARKER}/m, "")
+          File.write(file, contents)
+        end
+
+        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)
+          !Ripper.sexp(src).nil?
+        end
+
+        def comment_lines!(src)
+          return if src =~ /\A\n\z/
+          src.gsub!(/^(.)/m, "##{MARKER}\\1")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -0,0 +1,58 @@
+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
+
+    def self.markdown_file?(file)
+      MARKDOWN_EXTENSIONS.include?(File.extname(file))
+    end
+  end
+end
+
+RuboCop::Markdown.inject!
+
+RuboCop::Runner.prepend(Module.new do
+  # 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)
+    return yield if RuboCop::Markdown.markdown_file?(file)
+    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)
+
+    offenses = super
+    RuboCop::Markdown::Preprocess.restore!(file)
+
+    offenses
+  end
+end)
+
+# Allow Rubocop to analyze markdown files
+RuboCop::TargetFinder.prepend(Module.new do
+  def ruby_file?(file)
+    super || RuboCop::Markdown.markdown_file?(file)
+  end
+end)
+
+# Extend ProcessedSource#parse with pre-processing
+RuboCop::ProcessedSource.prepend(Module.new do
+  def parse(src, *args)
+    # only process Markdown files
+    src = RuboCop::Markdown::Preprocess.call(src) if
+      path.nil? || RuboCop::Markdown.markdown_file?(path)
+    super(src, *args)
+  end
+end)

data/lib/rubocop/markdown/version.rb

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

data/lib/rubocop/markdown.rb

@@ -0,0 +1,13 @@
+require "rubocop/markdown/version"
+require "pathname"
+
+module RuboCop
+  # Plugin to run Rubocop against Markdown files
+  module Markdown
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+
+    require_relative "./markdown/preprocess"
+    require_relative "./markdown/rubocop_ext" if defined?(::RuboCop::ProcessedSource)
+  end
+end

data/lib/rubocop-md.rb

@@ -0,0 +1 @@
+require "rubocop/markdown"

data/rubocop-md.gemspec

@@ -1,10 +1,10 @@
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/md/version"
+require "rubocop/markdown/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rubocop-md"
-  spec.version       = Rubocop::Md::VERSION
+  spec.version       = RuboCop::Markdown::VERSION
   spec.authors       = ["Vladimir Dementyev"]
   spec.email         = ["dementiev.vm@gmail.com"]
 
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rubocop", "~> 0.50"
+
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rubocop", "~> 0.50"
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: '0.50'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0.50'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '5.0'
 description: Run Rubocop against your Markdown files to make sure that code examples
   follow style guidelines.
 email:
@@ -82,10 +82,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
 - bin/setup
-- lib/rubocop/md.rb
-- lib/rubocop/md/version.rb
+- config/default.yml
+- lib/rubocop-md.rb
+- lib/rubocop/markdown.rb
+- lib/rubocop/markdown/preprocess.rb
+- lib/rubocop/markdown/rubocop_ext.rb
+- lib/rubocop/markdown/version.rb
 - rubocop-md.gemspec
 homepage: https://github.com/palkan/rubocop-md
 licenses:
@@ -102,9 +105,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rubocop/md"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/lib/rubocop/md/version.rb

@@ -1,5 +0,0 @@
-module Rubocop
-  module Md
-    VERSION = "0.0.1".freeze
-  end
-end

data/lib/rubocop/md.rb

@@ -1,8 +0,0 @@
-require "rubocop/md/version"
-
-module Rubocop
-  # Plugin to run Rubocop against Markdown files
-  module Md
-    # Your code goes here...
-  end
-end