appium_doc_lint 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7db3e1b388facaa63c87131d99f10ed6ce96bb20
-  data.tar.gz: 20d1a901aff559fe701668df86680718ce8043b7
+  metadata.gz: 3cf34820e15746a7650f52dd18f56506d191b401
+  data.tar.gz: b86c445e31a5d4cdd56c261d63608ac2fe1844a5
 SHA512:
-  metadata.gz: 9deecffaf2b9893cba1a43b044fa1d5aa368c32b2cf1df52cfd10dafccccccdf5c9ad593751727480e1f87058b718a449a3fa40bd10bf8975e37ce69283a498d
-  data.tar.gz: 35caf3baca6118ba6aa4360f1249cbfb1a82271db05361f5f77be410e1355a96eb2e80db295ec1c340b822ec21df57a105c16e296ccbd126964b75e6e58bb300
+  metadata.gz: 04a73f49c502c5b16b9ac0d1e346d7062e092170bdade13858ec84a35d404e7ab353911049488fd24fb6c5700a5533bd174ba697daf93708f25c12bb3b407b9c
+  data.tar.gz: 313669c69f1502bebdc5d33e425ab09d367ada994a9b44851c782e9965cf48fee51ce44acd6e2e8dfafd9d6147cd5d654bf9368713ff1c1fc65af00ca1959eda

data/lib/appium_doc_lint/lint/ext_missing.rb

@@ -23,7 +23,10 @@ module Appium
           # process docs/en/filename.md#testing links
           link_target = trim_link link_target
 
-          if link_target && !link_target.include?('/')
+          no_slash = !link_target.include?('/')
+          not_link_to_self = link_target != '#'
+
+          if link_target && no_slash && not_link_to_self
             ext = File.extname link_target
             if invalid_ext?(ext, link_target)
               warn index, full
@@ -37,12 +40,18 @@ module Appium
         warnings
       end
 
+      # from github.com/appium/api-docs/lib/api_docs.rb
       def invalid_ext? ext, link_target
         ext.empty? && ! link_target.end_with?('/')
       end
 
+      # process docs/en/filename.md#testing links
+      # handle relative links [getting started](../../README.md)
       def trim_link link_target
-        trim = link_target.start_with?('docs/') && ! link_target.end_with?('/')
+        link_target = link_target.strip if link_target
+        return link_target if link_target.end_with?('/')
+        # trim doc and relative
+        trim = link_target.start_with?('docs/') || link_target.start_with?('../')
         trim ? File.basename(link_target) : link_target
       end
 

data/lib/appium_doc_lint/version.rb

@@ -1,6 +1,6 @@
 module Appium
   class Lint
-    VERSION = '0.0.8' unless defined? ::Appium::Lint::VERSION
+    VERSION = '0.0.9' unless defined? ::Appium::Lint::VERSION
     DATE    = '2014-04-27' unless defined? ::Appium::Lint::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v0.0.8 2014-04-27
+
+- [2d3bfe1](https://github.com/appium/appium_doc_lint/commit/2d3bfe186204455c1c19f714748d369345216d75) Release 0.0.8
+- [2b9a5d1](https://github.com/appium/appium_doc_lint/commit/2b9a5d1b434eb85fb03a1e91930c45b2fd65d4a9) Detect missing links in docs/ folder
+- [1171ec6](https://github.com/appium/appium_doc_lint/commit/1171ec69632382382cedbf7596dec06aac7f3168) Add link to folder to test
+
+
 #### v0.0.7 2014-04-26
 
 - [9a9eaa9](https://github.com/appium/appium_doc_lint/commit/9a9eaa9854c2f16409d06333b120937995a42af0) Release 0.0.7

data/spec/lint_spec.rb

@@ -291,7 +291,7 @@ markdown--
 [link to read](readme)
 [ok](ok#ok)
 [intro](intro#start)
-[testing](docs/en/ok) en should be .md
+[testing](docs/en/ok) ok should be ok.md
       MARKDOWN
       rule     = ExtMissing.new data: data
       expected = { 1 => [rule.fail + ' [link to read](readme)'],
@@ -310,6 +310,8 @@ markdown--
 [intro](intro.md#start)
 [example](https://example.com/)
 [testing](docs/en/)
+[getting started doc](../../README.md)
+[link to self is valid](#)
       MARKDOWN
       rule     = ExtMissing.new data: data
       expected = {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_doc_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - code@bootstraponline.com