appium_doc_lint 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9a90d2baebe2ed13db1355e50c3a3917eb9a161
-  data.tar.gz: c91fd0b231071843d57892b66b567a99f3ee9735
+  metadata.gz: f0e9f63601abb0da7d52d2c491653f8fdbc4b14e
+  data.tar.gz: 3aa7a18f06ab0b2f9329d49b06835b9587a36467
 SHA512:
-  metadata.gz: 470605d83b8fc7aa33def2be3ca456f38ee13eae133ee0a089b775e3a4f39ddae3e03feb94a78b4bc991bce1c45bedab85a65e2af2a0990823fc7f07b9262ae0
-  data.tar.gz: bcb2a93f069a8bf49b0db79bfb77be2d39e29f60ec7aa7b213ba5ebc14ee376ddb259e18bcc17aaf1d0fc499cba3a7c9a69b4fba9d56f43d3ba9bbb161c4ff1d
+  metadata.gz: ab9a10d536e7fb7d31034d141b897e51197ac622f0378587531179aa728abe18786c4239cc810af5e39ea05e19d494de64a43ef9c7b1138f737a6e0be45bb201
+  data.tar.gz: 0dbd40d2dec1e79c46d80db6cceefbfedf2454730810af9e0420632f656515d5a41b16af4102a0beda0086e48986fc54262792da76290f3a395b8fa93c7bcebd

data/Rakefile

@@ -112,32 +112,26 @@ end
 desc 'Update release notes'
 task :notes do
   tag_sort = ->(tag1,tag2) do
-    begin
     tag1_numbers = tag1.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
     tag2_numbers = tag2.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
     tag1_numbers <=> tag2_numbers
-    rescue
-      raise "Match failed on\n'#{tag1}'\n'#{tag2}'"
-    end
   end
 
   tags = `git tag`.split "\n"
   tags.sort! &tag_sort
   pairs = []
-  tags.each_index { |a| pairs.push tags[a] + '..' + tags[a+1] unless tags[a+1].nil? }
+  tags.each_index { |a| pairs.push tags[a] + '...' + tags[a+1] unless tags[a+1].nil? }
 
   notes = ''
 
   dates = `git log --tags --simplify-by-decoration --pretty="format:%d %ad" --date=short`.split "\n"
-  #  " (tag: v0.0.21) 2013-03-22"
-  dates.reject! { |d| ! d.match /\(tag: v\d+\.\d+\.\d+\) \d+-\d+-\d+/ }
 
   pairs.sort! &tag_sort
   pairs.reverse! # pairs are in reverse order.
 
   tag_date = []
   pairs.each do |pair|
-    tag = pair.split('..').last
+    tag = pair.split('...').last
     dates.each do |line|
       # regular tag, or tag on master.
       if line.include?(tag + ')') || line.include?(tag + ',')

data/lib/appium_doc_lint/lint/base.rb

@@ -15,8 +15,9 @@ module Appium
       #
       # @param line_number [int] line number to warn on
       # @return [warnings]
-      def warn line_number
-        warnings[line_number + 1] += [fail]
+      def warn line_number, extra=nil
+        message = extra ? fail + ' ' + extra : fail
+        warnings[line_number + 1] += [message]
         warnings
       end
 

data/lib/appium_doc_lint/lint/ext_missing.rb

@@ -15,16 +15,17 @@ module Appium
           # /(?<!!) -- negative look behind. excludes image links
           match_data = line.match(/(?<!!) \[ ( [^\[]* ) \] \( ( [^)\/]+ ) \)/x)
           next unless match_data # skip nil matches
+          full        = match_data[0]
           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
+              warn index, full
             else
               ext, hash = ext.split '#'
-              warn index if ext.empty?
+              warn index, full if ext.empty?
             end
           end
         end
@@ -32,7 +33,7 @@ module Appium
         warnings
       end
 
-      FAIL = 'Relative markdown links must have an extension. [readme](readme.md)'
+      FAIL = 'Relative markdown links must have an extension'
 
       def fail
         FAIL

data/lib/appium_doc_lint/version.rb

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

data/release_notes.md

@@ -1,4 +1,10 @@
-#### v0.0.2 2014-04-19
+#### v0.0.4 2014-04-26
+
+- [293f87b](https://github.com/appium/appium_doc_lint/commit/293f87b56667e1c0d81b069cc9b700be521a965a) Release 0.0.4
+- [54813cf](https://github.com/appium/appium_doc_lint/commit/54813cf164f33866d7643260498d115f40411d0f) Add link check for invalid hyperlinks
+
+
+#### v0.0.3 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
@@ -8,7 +14,7 @@
 - [3ab939a](https://github.com/appium/appium_doc_lint/commit/3ab939aea1989e823c1fd3c27d6428f539c212eb) Detect more than one h1 per doc
 
 
-#### 
+#### v0.0.2 2014-04-19
 
 - [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

data/spec/lint_spec.rb

@@ -17,7 +17,7 @@ class Appium::Lint
                                9  => [H1Multiple::FAIL],
                                11 => [H456Invalid::FAIL],
                                21 => [H1Multiple::FAIL],
-                               23 => [ExtMissing::FAIL] } }
+                               23 => [ExtMissing::FAIL + ' [ok](ok#ok)'] } }
 
       # convert path/to/0.md to 0.md
       actual.keys.each do |key|
@@ -46,7 +46,7 @@ class Appium::Lint
   9: #{H1Multiple::FAIL}
   11: #{H456Invalid::FAIL}
   21: #{H1Multiple::FAIL}
-  23: #{ExtMissing::FAIL}
+  23: #{ExtMissing::FAIL + ' [ok](ok#ok)'}
 REPORT
 
       expect(actual).to eq(expected)
@@ -293,9 +293,9 @@ markdown--
 [intro](intro#start)
       MARKDOWN
       rule     = ExtMissing.new data: data
-      expected = { 1 => [rule.fail],
-                   2 => [rule.fail],
-                   3 => [rule.fail] }
+      expected = { 1 => [rule.fail + ' [link to read](readme)'],
+                   2 => [rule.fail + ' [ok](ok#ok)'],
+                   3 => [rule.fail + ' [intro](intro#start)'] }
       actual   = rule.call
 
       expect(actual).to eq(expected)

metadata

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