mdl 0.2.1 → 0.3.0

data/lib/mdl/ruleset.rb

@@ -4,6 +4,7 @@ module MarkdownLint
 
     def initialize(id, description, block)
       @id, @description = id, description
+      @aliases = []
       @tags = []
       @params = {}
       instance_eval &block
@@ -20,28 +21,36 @@ module MarkdownLint
       @tags
     end
 
+    def aliases(*a)
+      @aliases.concat(a)
+      @aliases
+    end
+
     def params(p = nil)
       @params.update(p) unless p.nil?
       @params
     end
+
   end
 
   class RuleSet
     attr_reader :rules
 
+    def initialize
+      @rules = {}
+    end
+
     def rule(id, description, &block)
-      @rules = {} if @rules.nil?
       @rules[id] = Rule.new(id, description, block)
     end
 
-    def self.load_default
-      self.load(File.expand_path("../rules.rb", __FILE__))
+    def load(rules_file)
+      instance_eval(File.read(rules_file), rules_file)
+      @rules
     end
 
-    def self.load(rules_file)
-      ruleset = new
-      ruleset.instance_eval(File.read(rules_file), rules_file)
-      ruleset.rules
+    def load_default
+      load(File.expand_path("../rules.rb", __FILE__))
     end
   end
 end

data/lib/mdl/style.rb

@@ -6,11 +6,15 @@ module MarkdownLint
 
     def initialize(all_rules)
       @tagged_rules = {}
+      @aliases = {}
       all_rules.each do |id, r|
         r.tags.each do |t|
           @tagged_rules[t] ||= Set.new
           @tagged_rules[t] << id
         end
+        r.aliases.each do |a|
+          @aliases[a] = id
+        end
       end
       @all_rules = all_rules
       @rules = Set.new
@@ -21,11 +25,13 @@ module MarkdownLint
     end
 
     def rule(id, params={})
+      id = @aliases[id] if @aliases[id]
       @rules << id
       @all_rules[id].params(params)
     end
 
     def exclude_rule(id)
+      id = @aliases[id] if @aliases[id]
       @rules.delete(id)
     end
 

data/lib/mdl/styles/default.rb

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

data/lib/mdl/styles/relaxed.rb

@@ -7,3 +7,4 @@ exclude_rule 'MD007' # List indentation
 exclude_rule 'MD033' # Inline HTML
 exclude_rule 'MD034' # Bare URL used
 exclude_rule 'MD040' # Fenced code blocks should have a language specified
+exclude_rule 'MD041' # First line in file should be a top level header

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/mdl.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.2'
 
-  spec.add_dependency 'kramdown', '~> 1.5', '>= 1.5.0'
+  spec.add_dependency 'kramdown', '~> 1.8', '>= 1.8.0'
   spec.add_dependency 'mixlib-config', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'mixlib-cli', '~> 1.5', '>= 1.5.0'
 

data/test/fixtures/default_mdlrc

@@ -0,0 +1 @@
+# Blank .mdlrc

data/test/fixtures/dir_with_md_and_markdown/bar.markdown

@@ -0,0 +1 @@
+## Second Header First

data/test/fixtures/dir_with_md_and_markdown/foo.md

@@ -0,0 +1 @@
+## Second Header First

data/test/fixtures/mdlrc_disable_rules

@@ -0,0 +1 @@
+rules "~MD001", "~MD002"

data/test/fixtures/mdlrc_disable_tags

@@ -0,0 +1 @@
+tags "ul", "~indentation"

data/test/fixtures/mdlrc_enable_rules

@@ -0,0 +1 @@
+rules "MD001", "MD002"

data/test/fixtures/mdlrc_enable_tags

@@ -0,0 +1 @@
+tags "headers", "whitespace"

data/test/fixtures/my_ruleset.rb

@@ -0,0 +1,6 @@
+rule "MY001", "Documents must start with Hello World" do
+  tags :opinionated
+  check do |doc|
+    [1] if doc.lines[0] != "Hello World"
+  end
+end

data/test/rule_tests/blockquote_spaces.md

@@ -10,12 +10,14 @@ This tests other things embedded in the blockquote:
 >  *foo* {MD027}
 >  **bar** {MD027}
 >   "Baz" {MD027}
-> *foo*
-> **bar**
-> 'baz'
+>   `qux` {MD027}
+> *foo* more text
+> **bar** more text
+> 'baz' more text
+> `qux` more text
 
 Test the first line being indented too much:
 
 >  Foo {MD027}
 >  Bar {MD027}
-> Baz
+> Baz

data/test/rule_tests/bulleted_list_2_space_indent_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD007', :indent => 4
+exclude_rule "MD041"

data/test/rule_tests/code_block_dollar_fence.md

@@ -0,0 +1,29 @@
+# header
+
+```fence
+$ code
+```
+
+text
+
+```fence
+$ code
+```
+
+text
+
+```fence
+$ code
+$ code
+```
+
+text
+
+```fence
+$ code
+$ code
+```
+
+text
+
+{MD014:3} {MD014:9} {MD014:15} {MD014:22}

data/test/rule_tests/default_test_style.rb

@@ -0,0 +1,4 @@
+# Default style file for rule tests
+all
+
+exclude_rule "MD041"

data/test/rule_tests/fenced_code_with_nesting.md

@@ -0,0 +1,73 @@
+# header
+
+text
+```fence {MD031}
+code
+``` {MD031}
+text
+~~~fence {MD031}
+code
+~~~ {MD031}
+text
+```fence {MD031}
+~~~fence
+code
+~~~
+``` {MD031}
+text
+~~~fence {MD031}
+```fence
+code
+```
+~~~ {MD031}
+text
+```fence {MD031}
+
+~~~fence
+code
+~~~
+
+``` {MD031}
+text
+~~~fence {MD031}
+
+```fence
+code
+```
+
+~~~ {MD031}
+text
+```fence {MD031}
+code
+~~~
+``` {MD031}
+text
+~~~fence {MD031}
+code
+```
+~~~ {MD031}
+text
+````fence {MD031}
+```fence
+code
+```
+```` {MD031}
+text
+~~~~fence {MD031}
+~~~fence
+code
+~~~
+~~~~ {MD031}
+text
+````fence {MD031}
+```fence
+code
+```
+````` {MD031}
+text
+~~~~fence {MD031}
+~~~fence
+code
+~~~
+~~~~~ {MD031}
+text

data/test/rule_tests/fenced_code_without_blank_lines_style.rb

@@ -1,2 +1,3 @@
 all
 exclude_rule "MD040"
+exclude_rule "MD041"

data/test/rule_tests/first_line_top_level_header_atx.md

@@ -0,0 +1,3 @@
+# First line is a top level header
+
+This shouldn't trigger MD041

data/test/rule_tests/first_line_top_level_header_atx_style.rb

@@ -0,0 +1,2 @@
+# Only test MD041 here
+rule "MD041"

data/test/rule_tests/first_line_top_level_header_setext.md

@@ -0,0 +1,4 @@
+First line top level header
+===========================
+
+This shouldn't trigger MD041

data/test/rule_tests/first_line_top_level_header_setext_style.rb

@@ -0,0 +1,2 @@
+# Only test MD041 here
+rule "MD041"

data/test/rule_tests/headers_good_setext_with_atx.md

@@ -0,0 +1,7 @@
+Header 1
+========
+
+Header 2
+--------
+
+### Header 3

data/test/rule_tests/headers_good_setext_with_atx_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD003', :style => :setext_with_atx

data/test/rule_tests/hr_style_dashes_style.rb

@@ -1,2 +1,3 @@
 all
 rule "MD035", :style => "---"
+exclude_rule "MD041"

data/test/rule_tests/hr_style_long_style.rb

@@ -1,2 +1,3 @@
 all
 rule "MD035", :style => "_____"
+exclude_rule "MD041"

data/test/rule_tests/hr_style_stars_style.rb

@@ -1,2 +1,3 @@
 all
 rule "MD035", :style => "***"
+exclude_rule "MD041"

data/test/rule_tests/incorrect_bullet_style_asterisk_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD004', :style => :asterisk
+exclude_rule "MD041"

data/test/rule_tests/incorrect_bullet_style_dash_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD004', :style => :dash
+exclude_rule "MD041"

data/test/rule_tests/incorrect_bullet_style_plus_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD004', :style => :plus
+exclude_rule "MD041"

data/test/rule_tests/long_lines_100_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD013', :line_length => 100
+exclude_rule "MD041"

data/test/rule_tests/long_lines_code.md

@@ -0,0 +1,38 @@
+This is a short line.
+
+This is a very very very very very very very very very very very very very very very very very very very very long line. {MD013}
+
+This is a short line.
+
+```text
+Here is a short line in a code block.
+Here is a very very very very very very very very very very very very very very very very very very very long line in a code block.
+```
+
+This is a short line.
+
+| First Header  | Second Header | Third Header  | Fourth Header | Fifth Header  | Sixth  Header |
+| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| ============= | ============= | ============= | ============= | ============= | ============= |
+| Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   |
+{: rules="groups"}
+
+This is a very very very very very very very very very very very very very very very very very very very very long line. {MD013}
+
+Another line.
+
+| First Header  | Second Header | Third Header  | Fourth Header | Fifth Header  | Sixth  Header |
+| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
+| ============= | ============= | ============= | ============= | ============= | ============= |
+| Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   |
+{: rules="groups"}

data/test/rule_tests/long_lines_code_style.rb

@@ -0,0 +1,3 @@
+all
+rule 'MD013', :code_blocks => false, :tables => false
+exclude_rule "MD041"

data/test/rule_tests/no_first_line_header.md

@@ -0,0 +1 @@
+This is a file without a top level header {MD041}

data/test/rule_tests/no_first_line_header_style.rb

@@ -0,0 +1 @@
+all

data/test/rule_tests/no_first_line_top_level_header.md

@@ -0,0 +1 @@
+## Second level header {MD041} {MD002}

data/test/rule_tests/no_first_line_top_level_header_style.rb

@@ -0,0 +1 @@
+all

data/test/rule_tests/ordered_list_item_prefix_ordered_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD029', :style => :ordered
+exclude_rule 'MD041'

data/test/rule_tests/spaces_after_list_marker_style.rb

@@ -1,3 +1,4 @@
 all
 rule "MD007", :indent => 4
 rule "MD030", :ul_multi => 3, :ol_multi => 2
+exclude_rule "MD041"

data/test/rule_tests/trailing_spaces_br_style.rb

@@ -1,2 +1,3 @@
 all
 rule 'MD009', :br_spaces => 2
+exclude_rule "MD041"

data/test/test_cli.rb

@@ -0,0 +1,205 @@
+require_relative 'setup_tests'
+require 'open3'
+require 'set'
+
+class TestCli < Minitest::Test
+  def run_cli(args, stdin = "", mdlrc="default_mdlrc")
+    mdl_script = File.expand_path("../../bin/mdl", __FILE__)
+    # Load the mdlrc file from the text/fixtures/ directory
+    mdlrc = File.expand_path("../fixtures/#{mdlrc}", __FILE__)
+    result = {}
+    result[:stdout], result[:stderr], result[:status] = \
+      Open3.capture3(*(%W{bundle exec #{mdl_script} -c #{mdlrc}} + args.split),
+                    :stdin_data => stdin)
+    result[:status] = result[:status].exitstatus
+    result
+  end
+
+  def assert_rules_enabled(result, rules, only_these_rules=false)
+    # Asserts that the given rules are enabled given the output of mdl -l
+    # If only_these_rules is set, then it asserts that the given rules and no
+    # others are enabled.
+    lines = result[:stdout].split("\n")
+    assert_equal("Enabled rules:", lines.first)
+    lines.shift
+    rules = rules.to_set
+    enabled_rules = lines.map{ |l| l.split(" ").first }.to_set
+    if only_these_rules
+      assert_equal(rules, enabled_rules)
+    else
+      assert_equal(Set.new, rules - enabled_rules)
+    end
+  end
+
+  def assert_rules_disabled(result, rules)
+    # Asserts that the given rules are _not_ enabled given the output of mdl -l
+    lines = result[:stdout].split("\n")
+    assert_equal("Enabled rules:", lines.first)
+    lines.shift
+    rules = rules.to_set
+    enabled_rules = lines.map{ |l| l.split(" ").first }.to_set
+    assert_equal(Set.new, rules & enabled_rules)
+  end
+
+  def assert_ran_ok(result)
+    assert_equal(0, result[:status])
+    assert_equal("", result[:stderr])
+  end
+
+  def test_help_text
+    result = run_cli("--help")
+    assert_match(/Usage: \S+ \[options\]/, result[:stdout])
+    assert_equal(0, result[:status])
+  end
+
+  def test_default_ruleset_loading
+    result = run_cli("-l")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["MD001"])
+  end
+
+  def test_show_alias_rule_list
+    result = run_cli("-al")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["header-increment"])
+  end
+
+  def test_show_alias_processing_file
+    result = run_cli("-a -r MD002", "## header2")
+    assert_equal(1, result[:status])
+    assert_equal("", result[:stderr])
+    assert_match(/^\(stdin\):1: first-header-h1/, result[:stdout])
+  end
+
+  def test_skipping_default_ruleset_loading
+    result = run_cli("-ld")
+    assert_rules_enabled(result, [], true)
+  end
+
+  def test_custom_ruleset_loading
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-ldu #{my_ruleset}")
+    assert_rules_enabled(result, ["MY001"], true)
+    assert_ran_ok(result)
+  end
+
+  def test_show_alias_rule_without_alias
+    # Tests that when -a is given, but the rule doesn't have an alias, it
+    # prints the rule ID instead.
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-ladu #{my_ruleset}")
+    assert_rules_enabled(result, ["MY001"], true)
+    assert_ran_ok(result)
+  end
+
+  def test_custom_ruleset_processing_success
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-du #{my_ruleset}", "Hello World")
+    assert_equal("", result[:stdout])
+    assert_ran_ok(result)
+  end
+
+  def test_custom_ruleset_processing_failure
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-du #{my_ruleset}", "Goodbye world")
+    assert_equal(1, result[:status])
+    assert_match(/^\(stdin\):1: MY001/, result[:stdout])
+    assert_equal("", result[:stderr])
+  end
+
+  def test_custom_ruleset_processing_failure_with_show_alias
+    # The custom rule doesn't have an alias, so the output should be identical
+    # to that without show_alias enabled.
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-dau #{my_ruleset}", "Goodbye world")
+    assert_equal(1, result[:status])
+    assert_match(/^\(stdin\):1: MY001/, result[:stdout])
+    assert_equal("", result[:stderr])
+  end
+
+  def test_custom_ruleset_loading_with_default
+    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
+    result = run_cli("-lu #{my_ruleset}")
+    assert_rules_enabled(result, ["MD001", "MY001"])
+    assert_ran_ok(result)
+  end
+
+  def test_rule_inclusion_cli
+    result = run_cli("-r MD001 -l")
+    assert_rules_enabled(result, ["MD001"], true)
+    assert_ran_ok(result)
+  end
+
+  def test_rule_exclusion_cli
+    result = run_cli("-r ~MD001 -l")
+    assert_rules_disabled(result, ["MD001"])
+    assert_ran_ok(result)
+  end
+
+  def test_rule_inclusion_with_exclusion_cli
+    result = run_cli("-r ~MD001,MD039 -l")
+    assert_rules_enabled(result, ["MD039"], true)
+    assert_ran_ok(result)
+  end
+
+  def test_tag_inclusion_cli
+    result = run_cli("-t headers -l")
+    assert_rules_enabled(result, ["MD001", "MD002", "MD003"])
+    assert_rules_disabled(result, ["MD004", "MD005", "MD006"])
+    assert_ran_ok(result)
+  end
+
+  def test_tag_exclusion_cli
+    result = run_cli("-t ~headers -l")
+    assert_ran_ok(result)
+    assert_rules_disabled(result, ["MD001", "MD002", "MD003"])
+    assert_rules_enabled(result, ["MD004", "MD005", "MD006"])
+  end
+
+  def test_rule_inclusion_config
+    result = run_cli("-l", "", "mdlrc_enable_rules")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["MD001", "MD002"], true)
+  end
+
+  def test_rule_exclusion_config
+    result = run_cli("-l", "", "mdlrc_disable_rules")
+    assert_ran_ok(result)
+    assert_rules_disabled(result, ["MD001", "MD002"])
+    assert_rules_enabled(result, ["MD003", "MD004"])
+  end
+
+  def test_tag_inclusion_config
+    result = run_cli("-l", "", "mdlrc_enable_tags")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["MD001", "MD002", "MD009", "MD010"])
+    assert_rules_disabled(result, ["MD004", "MD005"])
+  end
+
+  def test_tag_exclusion_config
+    result = run_cli("-l", "", "mdlrc_disable_tags")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["MD004", "MD030", "MD032"])
+    assert_rules_disabled(result, ["MD001", "MD005"])
+  end
+
+  def test_rule_inclusion_alias_cli
+    result = run_cli("-l -r header-increment")
+    assert_ran_ok(result)
+    assert_rules_enabled(result, ["MD001"], true)
+  end
+
+  def test_rule_exclusion_alias_cli
+    result = run_cli("-l -r ~header-increment")
+    assert_ran_ok(result)
+    assert_rules_disabled(result, ["MD001"])
+    assert_rules_enabled(result, ["MD002"])
+  end
+
+  def test_directory_scanning
+    path = File.expand_path("./fixtures/dir_with_md_and_markdown", File.dirname(__FILE__))
+    result = run_cli("#{path}")
+    files_with_issues = result[:stdout].split("\n").map { |l| l.split(":")[0] }.sort
+    assert_equal(files_with_issues, ["#{path}/bar.markdown", "#{path}/foo.md"])
+  end
+end