appium_doc_lint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e51c5890b05e13f9b3cb7a21120420df411822c
-  data.tar.gz: 7f3867ba30ad673c7b48524708b9272aa18ec25c
+  metadata.gz: d9a90d2baebe2ed13db1355e50c3a3917eb9a161
+  data.tar.gz: c91fd0b231071843d57892b66b567a99f3ee9735
 SHA512:
-  metadata.gz: ba53a6f63988c9a30fe82e5c4097bd6d1878bf37bbd17232a3b64308b80f222072342255eab763f16501e98406931c05c75bdcddf53b30cf6d02b6a197c26ed7
-  data.tar.gz: cb972b4a8371813897fe82395dac84435bc1d83fea905168e720ee2a5b90e3b5c8db3a7e045347ba8e7eb3c65a08765525b226382a8532da0248728309611f45
+  metadata.gz: 470605d83b8fc7aa33def2be3ca456f38ee13eae133ee0a089b775e3a4f39ddae3e03feb94a78b4bc991bce1c45bedab85a65e2af2a0990823fc7f07b9262ae0
+  data.tar.gz: bcb2a93f069a8bf49b0db79bfb77be2d39e29f60ec7aa7b213ba5ebc14ee376ddb259e18bcc17aaf1d0fc499cba3a7c9a69b4fba9d56f43d3ba9bbb161c4ff1d

data/lib/appium_doc_lint/lint.rb

@@ -3,6 +3,7 @@ require 'ostruct'
 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'
@@ -14,7 +15,7 @@ module Appium
     attr_reader :input
 
     def initialize
-      @rules = [H1Missing, H1Multiple, H1Invalid, H2Invalid, H456Invalid, LineBreakInvalid]
+      @rules = [ExtMissing, H1Missing, H1Multiple, H1Invalid, H2Invalid, H456Invalid, LineBreakInvalid]
     end
 
     def self.init_data opts={}, input

data/lib/appium_doc_lint/lint/ext_missing.rb

@@ -0,0 +1,42 @@
+module Appium
+  class Lint
+    ###
+    # all markdown links must have an extension
+    #
+    # [link to read](readme.md)
+    #
+    # invalid examples:
+    # [link](readme)
+    # [link](readme#testing)
+    class ExtMissing < Base
+      def call
+        input.lines.each_with_index do |line, index|
+          # regex from github.com/appium/api-docs/lib/api_docs.rb
+          # /(?<!!) -- negative look behind. excludes image links
+          match_data = line.match(/(?<!!) \[ ( [^\[]* ) \] \( ( [^)\/]+ ) \)/x)
+          next unless match_data # skip nil matches
+          link_text   = match_data[1]
+          link_target = match_data[2]
+
+          if link_target && !link_target.include?('/')
+            ext = File.extname link_target
+            if ext.empty?
+              warn index
+            else
+              ext, hash = ext.split '#'
+              warn index if ext.empty?
+            end
+          end
+        end
+
+        warnings
+      end
+
+      FAIL = 'Relative markdown links must have an extension. [readme](readme.md)'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end

data/lib/appium_doc_lint/version.rb

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

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v0.0.2 2014-04-19
+
+- [5bcd5c5](https://github.com/appium/appium_doc_lint/commit/5bcd5c58d25dace3ec356394d54f0a5d988602dd) Release 0.0.3
+- [b77dbb8](https://github.com/appium/appium_doc_lint/commit/b77dbb8c2d262cd9254a9cd2cf79227400632720) Set exit code when issues are detected
+- [aaf8ccf](https://github.com/appium/appium_doc_lint/commit/aaf8ccf1c596f4d50410622ecf6933c671b125b3) Improve test
+- [0c62101](https://github.com/appium/appium_doc_lint/commit/0c6210113c7eb9ccf62a59f36d894dd58b7ad173) Make h1 duplicate detection code block aware
+- [542859c](https://github.com/appium/appium_doc_lint/commit/542859c5059e411b483bfd74b9910b99ae58742d) Fix h1 detection and improve tests
+- [3ab939a](https://github.com/appium/appium_doc_lint/commit/3ab939aea1989e823c1fd3c27d6428f539c212eb) Detect more than one h1 per doc
+
+
 #### 
 
 - [910d158](https://github.com/appium/appium_doc_lint/commit/910d1583b5286c9c13242f97722ce50c99023944) Release 0.0.2

data/spec/data/sub/3.md

@@ -18,4 +18,8 @@ don't detect duplicate h1 in code blocks
 # testing
 ```
 
-# dupe
+# dupe
+
+[ok](ok#ok)
+[ok](ok.md)
+[ok](ok.md#ok)

data/spec/helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'rspec'
 require_relative '../lib/appium_doc_lint/lint'
 require_relative '../lib/appium_doc_lint/lint/base'
+require_relative '../lib/appium_doc_lint/lint/ext_missing'
 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'

data/spec/lint_spec.rb

@@ -16,7 +16,8 @@ class Appium::Lint
                                7  => [LineBreakInvalid::FAIL],
                                9  => [H1Multiple::FAIL],
                                11 => [H456Invalid::FAIL],
-                               21  => [H1Multiple::FAIL],} }
+                               21 => [H1Multiple::FAIL],
+                               23 => [ExtMissing::FAIL] } }
 
       # convert path/to/0.md to 0.md
       actual.keys.each do |key|
@@ -45,6 +46,7 @@ class Appium::Lint
   9: #{H1Multiple::FAIL}
   11: #{H456Invalid::FAIL}
   21: #{H1Multiple::FAIL}
+  23: #{ExtMissing::FAIL}
 REPORT
 
       expect(actual).to eq(expected)
@@ -282,4 +284,35 @@ markdown--
       expect(actual).to eq(expected)
     end
   end
+
+  describe ExtMissing do
+    it 'detects missing extensions in markdown links' do
+      data = <<-MARKDOWN
+[link to read](readme)
+[ok](ok#ok)
+[intro](intro#start)
+      MARKDOWN
+      rule     = ExtMissing.new data: data
+      expected = { 1 => [rule.fail],
+                   2 => [rule.fail],
+                   3 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects accepts valid links' do
+      data = <<-MARKDOWN
+[link to read](readme.md)
+[README](README.md)
+[intro](intro.md#start)
+[example](https://example.com/)
+      MARKDOWN
+      rule     = ExtMissing.new data: data
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_doc_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,7 @@ files:
 - lib/appium_doc_lint.rb
 - 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