appium_doc_lint 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c03b750ed72a48e5e12c84c80982105035bf82d8
-  data.tar.gz: 55f32988cbd981e5cbaacd98be0707bd69af8184
+  metadata.gz: 9e51c5890b05e13f9b3cb7a21120420df411822c
+  data.tar.gz: 7f3867ba30ad673c7b48524708b9272aa18ec25c
 SHA512:
-  metadata.gz: d12164d9788f093eceec163fdd6d9515f025c1096bacf14418f9684d0b90e7474539f1a4f9920ce269b1123617fe684f1e23401b70c966f47d02ec43c0870864
-  data.tar.gz: e68cdfb42a6b5a8b9b6b0987402a5e3a002eba5ce976632dd6d0fae490d02f48fba3dcaba7192d7c3eb657196ab59348a4d6385527d8be293c0d1cdd184cdba2
+  metadata.gz: ba53a6f63988c9a30fe82e5c4097bd6d1878bf37bbd17232a3b64308b80f222072342255eab763f16501e98406931c05c75bdcddf53b30cf6d02b6a197c26ed7
+  data.tar.gz: cb972b4a8371813897fe82395dac84435bc1d83fea905168e720ee2a5b90e3b5c8db3a7e045347ba8e7eb3c65a08765525b226382a8532da0248728309611f45

data/bin/appium_doc_lint

@@ -10,4 +10,8 @@ def run_glob
 end
 
 result = run_glob
-puts result if result
+
+if result
+  puts result
+  exit 1
+end

data/lib/appium_doc_lint/lint/h1_multiple.rb

@@ -0,0 +1,32 @@
+module Appium
+  class Lint
+    ###
+    # Each doc must have exactly 1 h1
+    class H1Multiple < Base
+      def call
+        h1_count = 0
+        in_code_block = false
+        input.lines.each_with_index do |line, index|
+          code_block = !! line.match(/^```/)
+          in_code_block = ! in_code_block if code_block
+
+          next if in_code_block
+
+          h1_detected = !! line.match(/^#[^#]/)
+          if h1_detected # only warn if h1 detected
+            h1_count += 1
+            warn index if h1_count > 1
+          end
+        end
+
+        warnings
+      end
+
+      FAIL = 'each doc must contain exactly one h1'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end

data/lib/appium_doc_lint/lint.rb

@@ -4,6 +4,7 @@ module Appium
   class Lint
     require_relative 'lint/base'
     require_relative 'lint/h1_invalid'
+    require_relative 'lint/h1_multiple'
     require_relative 'lint/h1_missing'
     require_relative 'lint/h2_invalid'
     require_relative 'lint/h456_invalid'
@@ -13,7 +14,7 @@ module Appium
     attr_reader :input
 
     def initialize
-      @rules = [H1Invalid, H1Missing, H2Invalid, H456Invalid, LineBreakInvalid]
+      @rules = [H1Missing, H1Multiple, H1Invalid, H2Invalid, H456Invalid, LineBreakInvalid]
     end
 
     def self.init_data opts={}, input

data/lib/appium_doc_lint/version.rb

@@ -1,6 +1,6 @@
 module Appium
   class Lint
-    VERSION = '0.0.2' unless defined? ::Appium::Lint::VERSION
+    VERSION = '0.0.3' unless defined? ::Appium::Lint::VERSION
     DATE    = '2014-04-19' unless defined? ::Appium::Lint::DATE
   end
 end

data/release_notes.md

@@ -0,0 +1,5 @@
+#### 
+
+- [910d158](https://github.com/appium/appium_doc_lint/commit/910d1583b5286c9c13242f97722ce50c99023944) Release 0.0.2
+- [4759871](https://github.com/appium/appium_doc_lint/commit/4759871312485a6574d468eb4baba703c44435e3) Guarantee glob order
+- [bdf6993](https://github.com/appium/appium_doc_lint/commit/bdf69931b0579dc657ffe5bf76a8bf75f2bf565f) Add gem badge

data/spec/data/sub/3.md

@@ -4,4 +4,18 @@
 
 hi
 
----
+---
+
+# h1 again
+
+##### h5
+
+don't detect duplicate h1 in code blocks
+
+```ruby
+# hi there
+# hi
+# testing
+```
+
+# dupe

data/spec/helper.rb

@@ -3,6 +3,7 @@ require 'rspec'
 require_relative '../lib/appium_doc_lint/lint'
 require_relative '../lib/appium_doc_lint/lint/base'
 require_relative '../lib/appium_doc_lint/lint/h1_missing'
+require_relative '../lib/appium_doc_lint/lint/h1_multiple'
 require_relative '../lib/appium_doc_lint/lint/h1_invalid'
 require_relative '../lib/appium_doc_lint/lint/h2_invalid'
 require_relative '../lib/appium_doc_lint/lint/h456_invalid'

data/spec/lint_spec.rb

@@ -2,22 +2,25 @@ require_relative 'helper'
 
 class Appium::Lint
   describe 'Lint' do
-    it 'processes globbed files' do
-      lint   = Appium::Lint.new
-      dir    = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
+    it 'processes globbed files using all lint rules' do
+      lint = Appium::Lint.new
+      dir  = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
 
-      actual = lint.glob dir
+      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],
                                5 => [H2Invalid::FAIL] },
-                   '3.md' => { 3 => [LineBreakInvalid::FAIL],
-                               7 => [LineBreakInvalid::FAIL] } }
+                   '3.md' => { 3  => [LineBreakInvalid::FAIL],
+                               7  => [LineBreakInvalid::FAIL],
+                               9  => [H1Multiple::FAIL],
+                               11 => [H456Invalid::FAIL],
+                               21  => [H1Multiple::FAIL],} }
 
       # convert path/to/0.md to 0.md
       actual.keys.each do |key|
-        new_key = File.basename key
+        new_key         = File.basename key
         actual[new_key] = actual[key]
         actual.delete key
       end
@@ -25,11 +28,11 @@ class Appium::Lint
       expect(actual).to eq(expected)
     end
 
-    it 'reports globbed files' do
-      lint   = Appium::Lint.new
-      dir    = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
+    it 'reports globbed files using all lint rules' do
+      lint = Appium::Lint.new
+      dir  = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
 
-      actual = lint.report lint.glob dir
+      actual   = lint.report lint.glob dir
       expected = (<<REPORT).strip
 0.md
   1: #{H1Missing::FAIL}
@@ -39,6 +42,9 @@ class Appium::Lint
 3.md
   3: #{LineBreakInvalid::FAIL}
   7: #{LineBreakInvalid::FAIL}
+  9: #{H1Multiple::FAIL}
+  11: #{H456Invalid::FAIL}
+  21: #{H1Multiple::FAIL}
 REPORT
 
       expect(actual).to eq(expected)
@@ -46,7 +52,7 @@ REPORT
 
     it 'empty report is falsey' do
       lint   = Appium::Lint.new
-      actual = !! lint.report({})
+      actual = !!lint.report({})
       expect(actual).to eq(false)
     end
 
@@ -92,6 +98,25 @@ MARKDOWN
     end
   end
 
+  describe H1Multiple do
+    it 'detects extra h1s' do
+      rule     = H1Multiple.new data: "# hi\n# bye\n#test"
+      expected = { 2 => [rule.fail],
+                   3 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'does not error on one h1' do
+      rule     = H1Multiple.new data: '# hi'
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+
   describe H1Missing do
     it 'detects missing h1' do
       rule     = H1Missing.new data: '## hi'
@@ -101,7 +126,7 @@ MARKDOWN
       expect(actual).to eq(expected)
     end
 
-    it 'detects h1 missing' do
+    it 'does not error on valid h1' do
       rule     = H1Missing.new data: '# hi'
       expected = {}
       actual   = rule.call

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_doc_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -73,6 +73,7 @@ files:
 - lib/appium_doc_lint/lint/base.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/h2_invalid.rb
 - lib/appium_doc_lint/lint/h456_invalid.rb
 - lib/appium_doc_lint/lint/line_break_invalid.rb