mdl 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb98b688ab9d9dc7bac3c169f20fefc7c0cb27ce5bf574bec52053d592b7a9c7
-  data.tar.gz: 873df51b4011d23617c1d73ab47a1928765fee0502b6f58853e2932bb3d5ec59
+  metadata.gz: 0b0bf6bf60ca7328cdc7b7c979b1c7f9eea59f99c35a219da0eddf8c73e529cc
+  data.tar.gz: 954a6871342a9137babebe806cab333bbf883d835cdc1ff867731145fb52d85f
 SHA512:
-  metadata.gz: fea533cf2d4a61c4da291a094e3f94080acee8837919935e789e1b39c98d8bcc416cb9fcb143a10a1f63738ee993d3fe5ce89ca3dc664a9a11712796db8dbc4d
-  data.tar.gz: 8dc7470f981b1267dddb1f668afc4f85c742d6c467ae9a31bcaf24618792d6d9c7792a328ff3258d8efd071d9592b4a84600a2825e787b26d1cb5f7e979989af
+  metadata.gz: 987343bbcf9c9a260e205970c1ea1bba1c5eb8dc5e0d2f3ed03013126efdf58a65085275f24081019d27fe63c02ce0ebbe0dded59e265392833f19cd00b582dd
+  data.tar.gz: aa09c154c250f31e0f0ad9cefc8b1e243562a836c9d2c1d740aa7d5d20eac38ea91f56dd73c7a6d1d8aa5ab57b0ba41143013372a65eb208411d3b8ebe4b53bf

data/Gemfile

@@ -1,2 +1,11 @@
-source 'https://rubygems.org'
+source 'https://gem.coop'
 gemspec
+
+group :development, :test do
+  gem 'base64'
+  gem 'bundler', '>= 1.12', '< 3'
+  gem 'minitest', '~> 5.26', '>= 5.26.2'
+  gem 'pry', '~> 0.15.2'
+  gem 'rake', '~> 13.3', '>= 13.3.1'
+  gem 'rubocop', '~> 1.81'
+end

data/lib/mdl/doc.rb

@@ -282,7 +282,7 @@ module MarkdownLint
       # returned and we'll just not catch that part of the text, which seems
       # like a sensible failure mode.
       element.children.map do |e|
-        if e.type == :text || e.type == :codespan
+        if %i{text codespan}.include?(e.type)
           e.value
         elsif %i{strong em p a}.include?(e.type)
           extract_as_text(e).join("\n")

data/lib/mdl/formatters/sarif.rb

@@ -8,7 +8,7 @@ module MarkdownLint
     class << self
       def generate(rules, results)
         matched_rules_id = results.map { |result| result['rule'] }.uniq
-        matched_rules = rules.select { |id, _| matched_rules_id.include?(id) }
+        matched_rules = rules.slice(*matched_rules_id)
         JSON.generate(generate_sarif(matched_rules, results))
       end
 

data/lib/mdl/rules.rb

@@ -51,8 +51,8 @@ rule 'MD003', 'Header style' do
       if doc_style == :setext_with_atx
         headers.map do |h|
           doc.element_linenumber(h) \
-                      unless (doc.header_style(h) == :setext) || \
-                             ((doc.header_style(h) == :atx) && \
+                      unless (doc.header_style(h) == :setext) ||
+                             ((doc.header_style(h) == :atx) &&
                               (h.options[:level] > 2))
         end.compact
       else
@@ -180,7 +180,7 @@ rule 'MD010', 'Hard tabs' do
     # inside of a code block are acceptable.
     codeblock_lines = doc.find_type_elements(:codeblock).map do |e|
       (doc.element_linenumber(e)..
-               doc.element_linenumber(e) + e.value.lines.count).to_a
+               (doc.element_linenumber(e) + e.value.lines.count)).to_a
     end.flatten
 
     # Check for lines with hard tab
@@ -207,7 +207,7 @@ rule 'MD012', 'Multiple consecutive blank lines' do
     # inside of a code block are acceptable.
     codeblock_lines = doc.find_type_elements(:codeblock).map do |e|
       (doc.element_linenumber(e)..
-               doc.element_linenumber(e) + e.value.lines.count).to_a
+               (doc.element_linenumber(e) + e.value.lines.count)).to_a
     end.flatten
     blank_lines = doc.matching_lines(/^\s*$/)
     cons_blank_lines = blank_lines.each_cons(2).select do |p, n|
@@ -227,7 +227,7 @@ rule 'MD013', 'Line length' do
     # Every line in the document that is part of a code block.
     codeblock_lines = doc.find_type_elements(:codeblock).map do |e|
       (doc.element_linenumber(e)..
-               doc.element_linenumber(e) + e.value.lines.count).to_a
+               (doc.element_linenumber(e) + e.value.lines.count)).to_a
     end.flatten
     # Every line in the document that is part of a table.
     locations = doc.elements
@@ -236,7 +236,7 @@ rule 'MD013', 'Line length' do
     table_lines = locations.map.with_index do |(l, e), i|
       if e.type == :table
         if i + 1 < locations.size
-          (l..locations[i + 1].first - 1).to_a
+          (l..(locations[i + 1].first - 1)).to_a
         else
           (l..doc.lines.count).to_a
         end
@@ -247,7 +247,7 @@ rule 'MD013', 'Line length' do
       overlines -= codeblock_lines
       unless params[:code_blocks]
         warn 'MD013 warning: Parameter :code_blocks is deprecated.'
-        warn '  Please replace \":code_blocks => false\" by '\
+        warn '  Please replace \":code_blocks => false\" by ' \
              '\":ignore_code_blocks => true\" in your configuration.'
       end
     end
@@ -543,7 +543,7 @@ rule 'MD030', 'Spaces after list markers' do
         next if line.empty?
 
         actual_spaces = line.gsub(/^> /, '').match(/^\s*\S+(\s+)/)[1].length
-        required_spaces = params["#{list_type}_#{srule}".to_sym]
+        required_spaces = params[:"#{list_type}_#{srule}"]
         errors << doc.element_linenumber(i) if required_spaces != actual_spaces
       end
     end
@@ -597,7 +597,7 @@ rule 'MD032', 'Lists should be surrounded by blank lines' do
       next if line.strip == '{:toc}'
 
       unless in_code
-        list_marker = line.strip.match(/^([*+\-]|(\d+\.))\s/)
+        list_marker = line.strip.match(/^([*+-]|(\d+\.))\s/)
         if list_marker && !in_list && !prev_line.match(/^($|\s)/)
           errors << (linenum + 1)
         elsif !list_marker && in_list && !line.match(/^($|\s)/)
@@ -692,7 +692,7 @@ rule 'MD037', 'Spaces inside emphasis markers' do
     # Kramdown doesn't parse emphasis with spaces, which means we can just
     # look for emphasis patterns inside regular text with spaces just inside
     # them.
-    (doc.matching_text_element_lines(/\s(\*\*?|__?)\s.+\1/) | \
+    (doc.matching_text_element_lines(/\s(\*\*?|__?)\s.+\1/) |
       doc.matching_text_element_lines(/(\*\*?|__?).+\s\1\s/)).sort
   end
 end
@@ -799,92 +799,3 @@ rule 'MD047', 'File should end with a single newline character' do
     error_lines
   end
 end
-
-rule 'MD055', 'Table row doesn\'t begin/end with pipes' do
-  tags :tables
-  aliases 'table-rows-start-and-end-with-pipes'
-  check do |doc|
-    error_lines = []
-    tables = doc.find_type_elements(:table)
-    lines = doc.lines
-
-    tables.each do |table|
-      table_pos = table.options[:location] - 1
-      table_rows = get_table_rows(lines, table_pos)
-
-      table_rows.each_with_index do |line, index|
-        if line.length < 2 || line[0] != '|' || line[-1] != '|'
-          error_lines << (table_pos + index + 1)
-        end
-      end
-    end
-
-    error_lines
-  end
-end
-
-rule 'MD056', 'Table has inconsistent number of columns' do
-  tags :tables
-  aliases 'inconsistent-columns-in-table'
-  check do |doc|
-    error_lines = []
-    tables = doc.find_type_elements(:table)
-    lines = doc.lines
-
-    tables.each do |table|
-      table_pos = table.options[:location] - 1
-      table_rows = get_table_rows(lines, table_pos)
-
-      num_headings = number_of_columns_in_a_table_row(lines[table_pos])
-
-      table_rows.each_with_index do |line, index|
-        if number_of_columns_in_a_table_row(line) != num_headings
-          error_lines << (table_pos + index + 1)
-        end
-      end
-    end
-
-    error_lines
-  end
-end
-
-rule 'MD057', 'Table has missing or invalid header separation (second row)' do
-  tags :tables
-  aliases 'table-invalid-second-row'
-  check do |doc|
-    error_lines = []
-    tables = doc.find_type_elements(:table)
-    lines = doc.lines
-
-    tables.each do |table|
-      second_row = ''
-
-      # line number of table start (1-indexed)
-      # which is equal to second row's index (0-indexed)
-      line_num = table.options[:location]
-      second_row = lines[line_num] if line_num < lines.length
-
-      # This pattern matches if
-      #   1) The row starts and stops with | characters
-      #   2) Only consists of characters '|', '-', ':' and whitespace
-      #   3) Each section between the separators (i.e. '|')
-      #      a) has at least three consecutive dashes
-      #      b) can have whitespace at the beginning or the end
-      #      c) can have colon before and/or after dashes (for alignment)
-      #   Some examples:
-      #       |-----|----|-------|      --> matches
-      #       |:---:|:---|-------|      --> matches
-      #       |  :------:  | ----|      --> matches
-      #       | - - - | - - - |         --> does NOT match
-      #       |::---|                   --> does NOT match
-      #       |----:|:--|----|          --> does NOT match
-      pattern = /^(\|\s*:?-{3,}:?\s*)+\|$/
-      unless second_row.match(pattern)
-        # Second row is not in the form described by the pattern
-        error_lines << (line_num + 1)
-      end
-    end
-
-    error_lines
-  end
-end

data/lib/mdl/ruleset.rb

@@ -3,7 +3,7 @@ module MarkdownLint
   class Rule
     attr_accessor :id, :description
 
-    def initialize(id, description, fallback_docs: nil, &block)
+    def initialize(id, description, fallback_docs: nil, &)
       @id = id
       @description = description
       @generate_docs = fallback_docs
@@ -11,7 +11,7 @@ module MarkdownLint
       @aliases = []
       @tags = []
       @params = {}
-      instance_eval(&block)
+      instance_eval(&)
     end
 
     def check(&block)
@@ -48,67 +48,6 @@ module MarkdownLint
     def docs_url
       @generate_docs&.call(id, description)
     end
-
-    # This method calculates the number of columns in a table row
-    #
-    # @param [String] table_row A row of the table in question.
-    # @return [Numeric] Number of columns in the row
-    def number_of_columns_in_a_table_row(table_row)
-      columns = table_row.strip.split('|')
-
-      if columns.empty?
-        # The stripped line consists of zero or more pipe characters
-        # and nothing more.
-        #
-        # Examples of stripped rows:
-        #   '||' --> one column
-        #   '|||' --> two columns
-        #   '|' --> zero columns
-        [0, table_row.count('|') - 1].max
-      else
-        # Number of columns is the number of splited
-        # segments with pipe separator. The first segment
-        # is ignored when it's empty string because
-        # someting like '|1|2|' is split into ['', '1', '2']
-        # when using split('|') function.
-        #
-        # Some examples:
-        #   '|foo|bar|' --> two columns
-        #   '  |foo|bar|' --> two columns
-        #   '|foo|bar' --> two columns
-        #   'foo|bar' --> two columns
-        columns.size - (columns[0].empty? ? 1 : 0)
-      end
-    end
-
-    # This method returns all the rows of a table
-    #
-    # @param [Array<String>] lines Lines of a doc as an array
-    # @param [Numeric] pos Position/index of the table in the array
-    # @return [Array<String>] Rows of the table in an array
-    def get_table_rows(lines, pos)
-      table_rows = []
-      while pos < lines.length
-        line = lines[pos]
-
-        # If the previous line is a table and the current line
-        #   1) includes pipe character
-        #   2) does not start with code block identifiers
-        #     a) >= 4 spaces
-        #     b) < 4 spaces and ``` right after
-        #
-        # it is possibly a table row
-        unless line.include?('|') && !line.start_with?('    ') &&
-               !line.strip.start_with?('```')
-          break
-        end
-
-        table_rows << line
-        pos += 1
-      end
-
-      table_rows
-    end
   end
 
   # defines a ruleset
@@ -119,9 +58,9 @@ module MarkdownLint
       @rules = {}
     end
 
-    def rule(id, description, &block)
+    def rule(id, description, &)
       @rules[id] =
-        Rule.new(id, description, :fallback_docs => @fallback_docs, &block)
+        Rule.new(id, description, :fallback_docs => @fallback_docs, &)
     end
 
     def load(rules_file)

data/lib/mdl/style.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 module MarkdownLint
   # defines a style
   class Style

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.15.0'.freeze
 end

data/lib/mdl.rb

@@ -27,21 +27,21 @@ module MarkdownLint
       unless Config[:rules][:include].empty?
         rules.select! do |r, v|
           Config[:rules][:include].include?(r) or
-            !(Config[:rules][:include] & v.aliases).empty?
+            Config[:rules][:include].intersect?(v.aliases)
         end
       end
       unless Config[:rules][:exclude].empty?
         rules.select! do |r, v|
           !Config[:rules][:exclude].include?(r) and
-            (Config[:rules][:exclude] & v.aliases).empty?
+            !Config[:rules][:exclude].intersect?(v.aliases)
         end
       end
     end
     # Tag option filter
     if Config[:tags]
-      rules.reject! { |_r, v| (v.tags & Config[:tags][:include]).empty? } \
+      rules.select! { |_r, v| v.tags.intersect?(Config[:tags][:include]) } \
         unless Config[:tags][:include].empty?
-      rules.select! { |_r, v| (v.tags & Config[:tags][:exclude]).empty? } \
+      rules.reject! { |_r, v| v.tags.intersect?(Config[:tags][:exclude]) } \
         unless Config[:tags][:exclude].empty?
     end
 

data/mdl.gemspec

@@ -19,17 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables = %w{mdl}
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.2'
 
   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-cli'
+  spec.add_dependency 'mixlib-config'
   spec.add_dependency 'mixlib-shellout'
-
-  spec.add_development_dependency 'bundler', '>= 1.12', '< 3'
-  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', '~> 1.28.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2025-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -42,42 +42,30 @@ dependencies:
   name: mixlib-cli
   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: mixlib-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -92,88 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.9'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        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: '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: 1.28.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.28.1
 description: Style checker/lint tool for markdown files
 email:
 - mark@mivok.net
@@ -213,14 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Markdown lint tool