mdl 0.9.0 → 0.10.0

data/lib/mdl/ruleset.rb

@@ -1,38 +1,39 @@
 module MarkdownLint
+  # defines a single rule
   class Rule
     attr_accessor :id, :description
 
     def initialize(id, description, block)
-      @id, @description = id, description
+      @id = id
+      @description = description
       @aliases = []
       @tags = []
       @params = {}
       instance_eval(&block)
     end
 
-
     def check(&block)
       @check = block unless block.nil?
       @check
     end
 
-    def tags(*t)
-      @tags = t.flatten.map {|i| i.to_sym} unless t.empty?
+    def tags(*tags)
+      @tags = tags.flatten.map(&:to_sym) unless tags.empty?
       @tags
     end
 
-    def aliases(*a)
-      @aliases.concat(a)
+    def aliases(*aliases)
+      @aliases.concat(aliases)
       @aliases
     end
 
-    def params(p = nil)
-      @params.update(p) unless p.nil?
+    def params(params = nil)
+      @params.update(params) unless params.nil?
       @params
     end
-
   end
 
+  # defines a ruleset
   class RuleSet
     attr_reader :rules
 
@@ -50,7 +51,7 @@ module MarkdownLint
     end
 
     def load_default
-      load(File.expand_path("../rules.rb", __FILE__))
+      load(File.expand_path('rules.rb', __dir__))
     end
   end
 end

data/lib/mdl/style.rb

@@ -1,6 +1,7 @@
 require 'set'
 
 module MarkdownLint
+  # defines a style
   class Style
     attr_reader :rules
 
@@ -24,14 +25,15 @@ module MarkdownLint
       @rules.merge(@all_rules.keys)
     end
 
-    def rule(id, params={})
+    def rule(id, params = {})
       if block_given?
-        raise "'rule' does not take a block. Should this definition go in a ruleset instead?"
+        raise '"rule" does not take a block. Should this definition go in a ' +
+              'ruleset instead?'
       end
+
       id = @aliases[id] if @aliases[id]
-      unless @all_rules[id]
-        raise "No such rule: #{id}"
-      end
+      raise "No such rule: #{id}" unless @all_rules[id]
+
       @rules << id
       @all_rules[id].params(params)
     end
@@ -41,35 +43,35 @@ module MarkdownLint
       @rules.delete(id)
     end
 
-    def tag(t)
-      @rules.merge(@tagged_rules[t])
+    def tag(tag)
+      @rules.merge(@tagged_rules[tag])
     end
 
-    def exclude_tag(t)
-      @rules.subtract(@tagged_rules[t])
+    def exclude_tag(tag)
+      @rules.subtract(@tagged_rules[tag])
     end
 
     def self.load(style_file, rules)
-      unless style_file.include?("/") || style_file.end_with?(".rb")
+      unless style_file.include?('/') || style_file.end_with?('.rb')
         tmp = File.expand_path("../styles/#{style_file}.rb", __FILE__)
         unless File.exist?(tmp)
-          STDERR.puts "#{style_file} does not appear to be a built-in style." +
-            " If you meant to pass in your own style file, it must contain" +
-            " a '/' or end in '.rb'. See https://github.com/markdownlint/" +
-            "markdownlint/blob/master/docs/configuration.md"
+          warn "#{style_file} does not appear to be a built-in style." +
+               ' If you meant to pass in your own style file, it must contain' +
+               " a '/' or end in '.rb'. See https://github.com/markdownlint/" +
+               'markdownlint/blob/master/docs/configuration.md'
           exit(1)
         end
         style_file = tmp
       end
 
       unless File.exist?(style_file)
-        STDERR.puts "Style '#{style_file}' does not exist."
+        warn "Style '#{style_file}' does not exist."
         exit(1)
       end
 
       style = new(rules)
       style.instance_eval(File.read(style_file), style_file)
-      rules.select! {|r| style.rules.include?(r)}
+      rules.select! { |r| style.rules.include?(r) }
       style
     end
   end

data/lib/mdl/styles/cirosantilli.rb

@@ -1,10 +1,10 @@
-# Enforce the style guide at http://www.cirosantilli.com/markdown-styleguide
+# Enforce the style guide at https://cirosantilli.com/markdown-style-guide
 all
 rule 'MD003', :style => :atx
 rule 'MD004', :style => :dash
 rule 'MD007', :indent => 4
 rule 'MD030', :ul_multi => 3, :ol_multi => 2
-rule 'MD035', :style => "---"
+rule 'MD035', :style => '---'
 
 # Inline HTML - this isn't forbidden by the style guide, and raw HTML use is
 # explicitly mentioned in the 'email automatic links' section.

data/lib/mdl/styles/default.rb

@@ -1,4 +1,4 @@
 all
 
-exclude_rule 'fenced-code-language' # Fenced code blocks should have a language specified
+exclude_rule 'fenced-code-language' # Fenced code blocks should have a language
 exclude_rule 'first-line-h1' # First line in file should be a top level header

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.9.0"
+  VERSION = '0.10.0'.freeze
 end

data/mdl.gemspec

@@ -1,32 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mdl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "mdl"
-  spec.version       = MarkdownLint::VERSION
-  spec.authors       = ["Mark Harrison"]
-  spec.email         = ["mark@mivok.net"]
-  spec.summary       = %q{Markdown lint tool}
-  spec.description   = %q{Style checker/lint tool for markdown files}
-  spec.homepage      = "http://github.com/markdownlint/markdownlint"
-  spec.license       = "MIT"
+  spec.name = 'mdl'
+  spec.version = MarkdownLint::VERSION
+  spec.authors = ['Mark Harrison']
+  spec.email = ['mark@mivok.net']
+  spec.summary = 'Markdown lint tool'
+  spec.description = 'Style checker/lint tool for markdown files'
+  spec.homepage = 'http://github.com/markdownlint/markdownlint'
+  spec.license = 'MIT'
 
-  spec.files         = %w{LICENSE.txt Gemfile} + Dir.glob("*.gemspec") + Dir.glob("lib/**/*")
-  spec.bindir        = "bin"
-  spec.executables   = %w{mdl}
-  spec.require_paths = ["lib"]
+  spec.files = %w{LICENSE.txt Gemfile} + Dir.glob('*.gemspec') +
+               Dir.glob('lib/**/*')
+  spec.bindir = 'bin'
+  spec.executables = %w{mdl}
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency 'kramdown', '~> 2.0'
-  spec.add_dependency 'kramdown-parser-gfm', '~> 1.0'
-  spec.add_dependency 'mixlib-config', '>= 2.2.1', '< 4'
+  spec.add_dependency 'kramdown', '~> 2.3'
+  spec.add_dependency 'kramdown-parser-gfm', '~> 1.1'
   spec.add_dependency 'mixlib-cli', '~> 2.1', '>= 2.1.1'
+  spec.add_dependency 'mixlib-config', '>= 2.2.1', '< 4'
+  spec.add_dependency 'mixlib-shellout'
 
   spec.add_development_dependency 'bundler', '>= 1.12', '< 3'
-  spec.add_development_dependency 'rake', '>= 11.2', '< 14'
   spec.add_development_dependency 'minitest', '~> 5.9'
   spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '>= 11.2', '< 14'
+  spec.add_development_dependency 'rubocop', '>= 0.49.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,28 +16,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
@@ -59,25 +79,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: mixlib-cli
+  name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,53 +113,67 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '14'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '14'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '11.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '11.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
 description: Style checker/lint tool for markdown files
 email:
 - mark@mivok.net
@@ -191,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Markdown lint tool