appium_doc_lint 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3637ec9c28dbc012b5bfbdef591c8f0187aedcb2
-  data.tar.gz: 5865887056deb7ddf46cece65c03421ac9f7cc7d
+  metadata.gz: e93c52c6eae739adc62445e0ac87a1f5c680beca
+  data.tar.gz: 9a5771779fe0b00ac3d0ec7f25606dafd36e0db6
 SHA512:
-  metadata.gz: e0ea155206d3033272a894b0df55bf50bcdcab7920afc42716db27e55555533f0759eb62b3bc48bde0253c20eabd094e3a5872a893b0cfb60f03829e26849c27
-  data.tar.gz: c284e9b92a89a3ca9f6076bcb77e9a14a6a65a09c2c0ea37813c67d45a8396fa391b544b3d80f78a4b4789554f6bc539030197adcb6d3e0ded258dceecce605b
+  metadata.gz: 02f28b73ad0fdb69483a033182c9ca0126d4e76e3127bac10974c921b8f2f0ba7d950288f3e7f3adead5a6a8befb40a79f28d786a3e55c1460c23269bac3d45d
+  data.tar.gz: 3ccc0b18a9b4f7ae99e54cfd3111aa50e8424f8b0c15a22b4eb4b181ef1f4ea041b47166b045f1cbd9c822e63a4be8552c50384237805cc3e92539fbb03ac911

data/lib/appium_doc_lint/lint.rb

@@ -4,18 +4,17 @@ module Appium
   class Lint
     require_relative 'lint/base'
     require_relative 'lint/ext_missing'
-    require_relative 'lint/h1_invalid'
-    require_relative 'lint/h1_multiple'
-    require_relative 'lint/h1_missing'
+    require_relative 'lint/h2_multiple'
+    require_relative 'lint/h2_missing'
     require_relative 'lint/h2_invalid'
-    require_relative 'lint/h456_invalid'
+    require_relative 'lint/h156_invalid'
     require_relative 'lint/line_break_invalid'
 
     # OpenStruct.new data: '', lines: '', file: ''
     attr_reader :input
 
     def initialize
-      @rules = [ExtMissing, H1Missing, H1Multiple, H1Invalid, H2Invalid, H456Invalid, LineBreakInvalid]
+      @rules = [ExtMissing, H2Missing, H2Multiple, H2Invalid, H156Invalid, LineBreakInvalid]
     end
 
     def self.init_data opts={}, input
@@ -95,4 +94,4 @@ module Appium
       result.empty? ? nil : result
     end
   end
-end
+end

data/lib/appium_doc_lint/lint/{h456_invalid.rb → h156_invalid.rb}

@@ -3,17 +3,23 @@ module Appium
     ###
     # h4, h5, and h6 should not be used.
     # Slate works best with h1, h2, or h3
-    class H456Invalid < Base
+    class H156Invalid < Base
       def call
+        in_code_block = false
         input.lines.each_with_index do |line, index|
-          h456_invalid = !!line.match(/^\#{4,6}[^#]/)
-          warn index if h456_invalid
-        end
+          code_block = !! line.match(/^```/)
+          in_code_block = ! in_code_block if code_block
+
+          next if in_code_block
 
+          h156_invalid = !!line.match(/^\#{5,6}[^#]|^#[^#]|^===+\s*$/)
+          warn index if h156_invalid
+
+        end
         warnings
       end
 
-      FAIL = 'h4, h5, h6 should not be used. Use h1, h2 or h3.'
+      FAIL = 'h1, h5, h6 should not be used. Use h2, h3 or h4.'
 
       def fail
         FAIL
@@ -26,4 +32,4 @@ end
 => "<h5>ok</h5>\n"
 > md.render(" ##### ok")
 => "<p>##### ok</p>\n"
-=end
+=end

data/lib/appium_doc_lint/lint/h2_missing.rb

@@ -0,0 +1,25 @@
+module Appium
+  class Lint
+    ###
+    # Each file must have a h2
+    # This forms the title for the document and is used to anchor the
+    # #filename.md link.
+    #
+    # The file should start with the h2. This rule will fail if the document
+    # doesn't contain at least one h2
+    class H2Missing < Base
+      def call
+        # either the doc has a h2 or it doesn't
+        # attach warning to line 0
+        h2_missing = !input.data.match(/^##[^#]/m)
+        h2_missing ? warn(0) : warnings
+      end
+
+      FAIL = 'h2 is missing'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end

data/lib/appium_doc_lint/lint/{h1_multiple.rb → h2_multiple.rb}

@@ -2,7 +2,7 @@ module Appium
   class Lint
     ###
     # Each doc must have exactly 1 h1
-    class H1Multiple < Base
+    class H2Multiple < Base
       def call
         h1_count = 0
         in_code_block = false
@@ -12,7 +12,7 @@ module Appium
 
           next if in_code_block
 
-          h1_detected = !! line.match(/^#[^#]/)
+          h1_detected = !! line.match(/^##[^#]/)
           if h1_detected # only warn if h1 detected
             h1_count += 1
             warn index if h1_count > 1
@@ -22,11 +22,11 @@ module Appium
         warnings
       end
 
-      FAIL = 'each doc must contain exactly one h1'
+      FAIL = 'each doc must contain exactly one h2'
 
       def fail
         FAIL
       end
     end
   end
-end
+end

data/lib/appium_doc_lint/version.rb

@@ -1,6 +1,6 @@
 module Appium
   class Lint
-    VERSION = '0.0.10' unless defined? ::Appium::Lint::VERSION
-    DATE    = '2014-07-01' unless defined? ::Appium::Lint::DATE
+    VERSION = '0.0.11' unless defined? ::Appium::Lint::VERSION
+    DATE    = '2014-07-03' unless defined? ::Appium::Lint::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v0.0.10 2014-07-01
+
+- [d1288b7](https://github.com/appium/appium_doc_lint/commit/d1288b77382f91334535671949717074f0e2d086) Release 0.0.10
+- [e055255](https://github.com/appium/appium_doc_lint/commit/e05525508a0b48cd5ffa32bc69d23b77a48be56d) Check that file isn't a directory
+- [56e3127](https://github.com/appium/appium_doc_lint/commit/56e31274068ef80e0f61d999bae06be1730785b2) Add test for multiple code blocks
+- [ee0ee4d](https://github.com/appium/appium_doc_lint/commit/ee0ee4d068c982152e22fd9a67d291d1a0ba463d) Add example one time scan
+
+
 #### v0.0.9 2014-04-27
 
 - [3c4661e](https://github.com/appium/appium_doc_lint/commit/3c4661ebe628ab2b320f77f53b53b537b8c1723e) Release 0.0.9

data/spec/data/1.md

@@ -1,3 +1,3 @@
-# h1
+## h2
 
-## h2
+### h3

data/spec/data/sub/3.md

@@ -1,4 +1,4 @@
-# h1
+## h2
 
 --
 
@@ -6,7 +6,7 @@ hi
 
 ---
 
-# h1 again
+## h2 again
 
 ##### h5
 
@@ -18,8 +18,8 @@ don't detect duplicate h1 in code blocks
 # testing
 ```
 
-# dupe
+## dupe
 
 [ok](ok#ok)
 [ok](ok.md)
-[ok](ok.md#ok)
+[ok](ok.md#ok)

data/spec/lint_spec.rb

@@ -9,14 +9,14 @@ class Appium::Lint
       actual   = lint.glob dir
 
       # 1.md has no problems so it doesn't show up in expected failures
-      expected = { '0.md' => { 1 => [H1Missing::FAIL],
-                               2 => [H1Invalid::FAIL],
+      expected = { '0.md' => { 1 => [H2Missing::FAIL],
+                               2 => [H156Invalid::FAIL],
                                5 => [H2Invalid::FAIL] },
                    '3.md' => { 3  => [LineBreakInvalid::FAIL],
                                7  => [LineBreakInvalid::FAIL],
-                               9  => [H1Multiple::FAIL],
-                               11 => [H456Invalid::FAIL],
-                               21 => [H1Multiple::FAIL],
+                               9  => [H2Multiple::FAIL],
+                               11 => [H156Invalid::FAIL],
+                               21 => [H2Multiple::FAIL],
                                23 => [ExtMissing::FAIL + ' [ok](ok#ok)'] } }
 
       # convert path/to/0.md to 0.md
@@ -36,16 +36,16 @@ class Appium::Lint
       actual   = lint.report lint.glob dir
       expected = (<<REPORT).strip
 ./spec/data/0.md
-  1: #{H1Missing::FAIL}
-  2: #{H1Invalid::FAIL}
+  1: #{H2Missing::FAIL}
+  2: #{H156Invalid::FAIL}
   5: #{H2Invalid::FAIL}
 
 ./spec/data/sub/3.md
   3: #{LineBreakInvalid::FAIL}
   7: #{LineBreakInvalid::FAIL}
-  9: #{H1Multiple::FAIL}
-  11: #{H456Invalid::FAIL}
-  21: #{H1Multiple::FAIL}
+  9: #{H2Multiple::FAIL}
+  11: #{H156Invalid::FAIL}
+  21: #{H2Multiple::FAIL}
   23: #{ExtMissing::FAIL + ' [ok](ok#ok)'}
 REPORT
 
@@ -83,16 +83,15 @@ there 2
 ###### h6
 MARKDOWN
 
-      expected = { 1  => [H1Missing::FAIL],
-                   2  => [H1Invalid::FAIL],
-                   5  => [H1Invalid::FAIL],
+      expected = { 1  => [H2Missing::FAIL],
+                   2  => [H156Invalid::FAIL],
+                   5  => [H156Invalid::FAIL],
                    8  => [H2Invalid::FAIL],
                    11 => [H2Invalid::FAIL],
                    13 => [LineBreakInvalid::FAIL],
                    15 => [LineBreakInvalid::FAIL],
-                   17 => [H456Invalid::FAIL],
-                   18 => [H456Invalid::FAIL],
-                   19 => [H456Invalid::FAIL] }
+                   18 => [H156Invalid::FAIL],
+                   19 => [H156Invalid::FAIL] }
 
       actual = lint.call data: markdown
 
@@ -100,9 +99,9 @@ MARKDOWN
     end
   end
 
-  describe H1Multiple do
-    it 'detects extra h1s' do
-      rule     = H1Multiple.new data: "# hi\n# bye\n#test"
+  describe H2Multiple do
+    it 'detects extra h2s' do
+      rule     = H2Multiple.new data: "## hi\n## bye\n##test"
       expected = { 2 => [rule.fail],
                    3 => [rule.fail] }
       actual   = rule.call
@@ -110,8 +109,8 @@ MARKDOWN
       expect(actual).to eq(expected)
     end
 
-    it 'does not error on one h1' do
-      rule     = H1Multiple.new data: '# hi'
+    it 'does not error on one h2' do
+      rule     = H2Multiple.new data: '## hi'
       expected = {}
       actual   = rule.call
 
@@ -134,52 +133,24 @@ Here's a Ruby example:
 # Ruby example
 ```
 DATA
-      rule     = H1Multiple.new data: data
+      rule     = H2Multiple.new data: data
       expected = {}
       actual   = rule.call
       expect(actual).to eq(expected)
     end
   end
 
-  describe H1Missing do
+  describe H2Missing do
     it 'detects missing h1' do
-      rule     = H1Missing.new data: '## hi'
+      rule     = H2Missing.new data: '### hi'
       expected = { 1 => [rule.fail] }
       actual   = rule.call
 
       expect(actual).to eq(expected)
     end
 
-    it 'does not error on valid h1' do
-      rule     = H1Missing.new data: '# hi'
-      expected = {}
-      actual   = rule.call
-
-      expect(actual).to eq(expected)
-    end
-  end
-
-  describe H1Invalid do
-    it 'detects invalid h1' do
-      rule     = H1Invalid.new data: "hi\n==="
-      expected = { 2 => [rule.fail] }
-      actual   = rule.call
-
-      expect(actual).to eq(expected)
-    end
-
-    it 'detects multiple invalid h1' do
-      rule     = H1Invalid.new data: "hi\n===\nbye\n======\n\n===="
-      expected = { 2 => [rule.fail],
-                   4 => [rule.fail],
-                   6 => [rule.fail] }
-      actual   = rule.call
-
-      expect(actual).to eq(expected)
-    end
-
-    it 'detects valid h1' do
-      rule     = H1Invalid.new data: '# hi'
+    it 'does not error on valid h2' do
+      rule     = H2Missing.new data: '## hi'
       expected = {}
       actual   = rule.call
 
@@ -197,7 +168,7 @@ DATA
     end
 
     it 'detects multiple invalid h2' do
-      rule     = H2Invalid.new data: "hi\n---\nbye\n-------"
+      rule     = H2Invalid.new data: "hi\n---\nbye\n-----\n\n-------"
       expected = { 2 => [rule.fail],
                    4 => [rule.fail] }
       actual   = rule.call
@@ -214,10 +185,10 @@ DATA
     end
   end
 
-  describe H456Invalid do
-    it 'detects invalid h4, h5, h6' do
-      ['#### h4', '##### h5', '###### h6'].each do |data|
-        rule     = H456Invalid.new data: data
+  describe H156Invalid do
+    it 'detects invalid h1, h5, h6' do
+      ['# h1', '##### h5', '###### h6'].each do |data|
+        rule     = H156Invalid.new data: data
         expected = { 1 => [rule.fail] }
         actual   = rule.call
 
@@ -225,7 +196,7 @@ DATA
       end
     end
 
-    it 'detects multiple invalid h4, h5, h6' do
+    it 'detects multiple invalid h1, h5, h6' do
       data = <<-MARKDOWN
 # h1
 ## h2
@@ -234,10 +205,11 @@ DATA
 ##### h5
 ###### h6
  #### not actually a h4 due to leading space
+
       MARKDOWN
 
-      rule     = H456Invalid.new data: data
-      expected = { 4 => [rule.fail],
+      rule     = H156Invalid.new data: data
+      expected = { 1 => [rule.fail],
                    5 => [rule.fail],
                    6 => [rule.fail] }
       actual   = rule.call
@@ -245,13 +217,13 @@ DATA
       expect(actual).to eq(expected)
     end
 
-    it 'does not error on h1, h2, h3' do
+    it 'does not error on h2, h3, h4' do
       data = <<-MARKDOWN
-# h1
-# h2
-# h3
+## h2
+### h3
+#### h4
       MARKDOWN
-      rule     = H456Invalid.new data: data
+      rule     = H156Invalid.new data: data
       expected = {}
       actual   = rule.call
 
@@ -342,4 +314,4 @@ markdown--
       expect(actual).to eq(expected)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_doc_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,11 +73,10 @@ files:
 - lib/appium_doc_lint/lint.rb
 - lib/appium_doc_lint/lint/base.rb
 - lib/appium_doc_lint/lint/ext_missing.rb
-- lib/appium_doc_lint/lint/h1_invalid.rb
-- lib/appium_doc_lint/lint/h1_missing.rb
-- lib/appium_doc_lint/lint/h1_multiple.rb
+- lib/appium_doc_lint/lint/h156_invalid.rb
 - lib/appium_doc_lint/lint/h2_invalid.rb
-- lib/appium_doc_lint/lint/h456_invalid.rb
+- lib/appium_doc_lint/lint/h2_missing.rb
+- lib/appium_doc_lint/lint/h2_multiple.rb
 - lib/appium_doc_lint/lint/line_break_invalid.rb
 - lib/appium_doc_lint/version.rb
 - release_notes.md

data/lib/appium_doc_lint/lint/h1_invalid.rb

@@ -1,36 +0,0 @@
-module Appium
-  class Lint
-    ###
-    # h1 must use the `#` syntax and not the `===` underline syntax.
-    # check for three = to reduce false positives
-    class H1Invalid < Base
-      def call
-        # === is always a h1 regardless of previous line
-        input.lines.each_with_index do |line, index|
-          h1_invalid = !!line.match(/^===+\s*$/)
-          warn index if h1_invalid
-        end
-
-        warnings
-      end
-
-      FAIL = 'h1 must not use === underline syntax. Use # instead'
-
-      def fail
-        FAIL
-      end
-    end
-  end
-end
-
-=begin
-md = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
-> md.render("hi\n=")
-=> "<h1>hi</h1>\n"
-> md.render("hi\n =")
-=> "<p>hi\n =</p>\n"
-> md.render("hi\n= ")
-=> "<h1>hi</h1>\n"
-> md.render("\n\n======")
-=> "<h1></h1>\n"
-=end

data/lib/appium_doc_lint/lint/h1_missing.rb

@@ -1,25 +0,0 @@
-module Appium
-  class Lint
-    ###
-    # Each file must have a h1
-    # This forms the title for the document and is used to anchor the
-    # #filename.md link.
-    #
-    # The file should start with the h1. This rule will fail if the document
-    # doesn't contain at least one h1
-    class H1Missing < Base
-      def call
-        # either the doc has a h1 or it doesn't
-        # attach warning to line 0
-        h1_missing = !input.data.match(/^#[^#]/m)
-        h1_missing ? warn(0) : warnings
-      end
-
-      FAIL = 'h1 is missing'
-
-      def fail
-        FAIL
-      end
-    end
-  end
-end