awesome_bot 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b49b5fcbf456b3edd938ec1e75237c054cdaea7
-  data.tar.gz: e7cfb3e92f182a0fa20b354d55750870b57b7e1c
+  metadata.gz: 60ade84e7c925224c447476c2dff8ca5a1c9a70b
+  data.tar.gz: 3bfaeb0385871cc68c077bdda4b400bd9cabc368
 SHA512:
-  metadata.gz: 0719b5d14fe5242ac1d388290b1654ebb8370124666a88e041f61b6c02a091b3266d7f719a9ac1c4df99a2b7ea5a4dbdfe2ae728a70c89996fd901c081a0b592
-  data.tar.gz: 15acf467a98ba48c6cb6124a4194c61c49d23ab468736222b72aaac86ca2d7b8581807bd1fd941fee50f120d64b5ea0658f0c1c72ff859099ca3a69ab0984d07
+  metadata.gz: 221cfd97f2fb670eee8ff712a129192a020a094bf2d67f9bb15c217de50b7f0aec8e1f5b1097bdca480f9315b49229f2eef1a1707abd149f803177a3034772a7
+  data.tar.gz: 9d1d26c95e0aeaa8f4f4c8b8ffc1c15b9678372c605dc4429a13b46c80ed70404b7ceafe19e54d31057d2222d9f1316a753383d21595d09a0e0f2414e727bafd

data/CHANGELOG.md

@@ -2,10 +2,16 @@
 
 Changes by [Daniel Khamsing][] unless otherwise noted.
 
+# 1.8.1
+
+- [output] show link line number, suggested by [Daniel Gomez Rico](https://github.com/danielgomezrico)
+- [output] improve enumeration with padding
+- set default open link timeout to 30 seconds 
+
 # 1.8.0
 
 - remove `faraday`
-- [fix] parse links with commas (url encode)
+- [fix] parse links with commas (url encode), reported by [Kishan Bagaria](https://github.com/KishanBagaria)
 
 # 1.7.1
 

data/README.md

@@ -16,22 +16,6 @@ Verify links in [awesome](https://github.com/sindresorhus/awesome) projects
 
 ## Usage
 
-### Library
-
-```ruby
-irb(main):001:0> require 'awesome_bot'
-=> true
-irb(main):002:0> content = File.read 'README.md'
-=> "..."
-irb(main):003:0> result = AwesomeBot.check content
-=> #<AwesomeBot::Result:0x007fdde39f4408 @links=...>
-# AwesomeBot Result with success, statuses_issues, dupes and more
-irb(main):004:0> puts result.success ? 'No errors' : ':-('
-:-(
-```
-
-More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
-
 ### Command Line
 
     awesome_bot <file> [--allow-dupe] [--allow-redirect] [--allow-timeout] [--set-timeout d] [--white-list item1,item2,..]
@@ -53,49 +37,61 @@ By default, `awesome_bot` flags duplicates and URL redirects.
 ```shell
 $ awesome_bot README.md
 > Checking links in README.md
-Links found: 56, 53 unique
-  1. https://github.com/sindresorhus/awesome
-  2. http://i.giphy.com/urvsFBDfR6N32.gif
-  3. https://travis-ci.org/dkhamsing/awesome_bot.svg
-  ...
-  53. https://twitter.com/dkhamsing
-Checking URLs: ✓x→✓✓✓✓→→✓→✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓→✓✓✓✓✓✓✓✓
-
-Issues :-(
-> Links
-  1. 202 http://www.rubydoc.info/gems/awesome_bot
-  2. 301 http://rubygems.org/gems/awesome_bot → https://rubygems.org/gems/awesome_bot
-  3. 302 https://badge.fury.io/rb/awesome_bot.svg → https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=6&v=1.4.0&x2=0
-  4. 302 https://badge.fury.io/rb/awesome_bot → http://rubygems.org/gems/awesome_bot
-  5. 301 https://travis-ci.org/dkhamsing/awesome_bot.svg → https://api.travis-ci.org/dkhamsing/awesome_bot.svg
-  6. 301 http://gph.is/XM6gMT → http://giphy.com/gifs/urvsFBDfR6N32
-> Dupes
-  1. https://github.com/sindresorhus/awesome
-  2. https://github.com/veggiemonk/awesome-docker
-  3. https://github.com/dotfiles/dotfiles.github.com  
+Links found: 56, 37 unique
+  01. https://github.com/sindresorhus/awesome
+  02. http://i.giphy.com/urvsFBDfR6N32.gif
+  03. https://travis-ci.org/dkhamsing/awesome_bot.svg
+# ...
+  37. https://github.com/dkhamsing
+  Checking URLs: ✓✓✓→?✓→✓→→✓✓→✓✓✓→✓✓✓✓✓✓✓✓✓✓✓→✓✓✓✓✓→✓✓
+
+  Issues :-(
+  > Links
+    1. [L007] 301 https://travis-ci.org/dkhamsing/awesome_bot.svg → https://api.travis-ci.org/dkhamsing/awesome_bot.svg
+    2. [L008] 302 https://badge.fury.io/rb/awesome_bot → http://rubygems.org/gems/awesome_bot
+# ...
+  > Dupes
+    1. https://github.com/sindresorhus/awesome
+    2. http://i.giphy.com/urvsFBDfR6N32.gif
+# ...
 ```
 
 ```shell
-$ awesome_bot README.md --allow-dupe --white-list fury,rubydoc,travis,codeload,gems,giphy,gph
+$ awesome_bot README.md --allow-dupe --white-list travis,badge,rubydoc,rubygems,giphy,gph
 > Checking links in README.md
 > Will allow duplicate links
-> White list links matching: fury, rubydoc, travis, codeload, gems, giphy, gph
-Links found: 51, 23 white listed, 42 unique
-  1. https://github.com/sindresorhus/awesome
-  2. https://twitter.com/dkhamsing
-  ...
-Checking URLs: ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓
-Checking white listed URLs: →→✓x✓✓✓→✓✓→→→
+> White list links matching: travis, badge, rubydoc, rubygems, giphy, gph
+Links to check: 21, 27 white listed, 16 unique
+  01. https://github.com/sindresorhus/awesome
+  02. https://circleci.com/gh/dkhamsing/awesome_bot
+  03. https://github.com/dkhamsing
+# ...
+Checking URLs: ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓
+Checking white listed URLs: ✓✓✓→→?✓→→✓→✓→✓→✓→✓
 
 > White listed:
-  1. 301 http://rubygems.org/gems/awesome_bot → https://rubygems.org/gems/awesome_bot
-  2. 301 http://gph.is/XM6gMT → http://giphy.com/gifs/urvsFBDfR6N32
-  3. 200 http://i.giphy.com/urvsFBDfR6N32.gif
-  ...
-
+  01. [L005] 200 http://i.giphy.com/urvsFBDfR6N32.gif
+  02. [L007] 200 https://img.shields.io/badge/tests-circle%20ci-brightgreen.svg
+# ...
 No issues :-)
 ```
 
+### Library
+
+```ruby
+irb(main):001:0> require 'awesome_bot'
+=> true
+irb(main):002:0> content = File.read 'README.md'
+=> "..."
+irb(main):003:0> result = AwesomeBot.check content
+=> #<AwesomeBot::Result:0x007fdde39f4408 @links=...>
+# AwesomeBot Result with success, statuses_issues, dupes and more
+irb(main):004:0> puts result.success ? 'No errors' : ':-('
+:-(
+```
+
+More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
+
 ## Validate Pull Requests
 
 Does your GitHub README contain a lot of links? `awesome_bot` can help you validate them when a [pull request](https://github.com/dkhamsing/open-source-ios-apps/pull/159) is created (or a commit is pushed). It is used by:

data/bin/assets/test-timeout-and-redirect

@@ -1,4 +1,3 @@
-http://platipy.org
+http://www.cmr.osu.edu/browse/datasets
 https://github.com
-
 https://github.com/supermarin/Alcatraz

data/lib/awesome_bot/check.rb

@@ -52,7 +52,10 @@ module AwesomeBot
       uniq = r.links.uniq.count
       log.addp ", #{uniq} unique" if uniq != r.links.count
       log.add ''
-      r.links.uniq.each_with_index { |u, j| log.add "  #{j + 1}. #{u}" }
+      r.links.uniq.each_with_index do |u, j|
+        format = "%0#{r.links.uniq.count.to_s.size}d"
+        log.add "  #{sprintf format, j + 1}. #{u}"
+      end
 
       log.addp 'Checking URLs: ' if r.links.count > 0
       r.status =

data/lib/awesome_bot/cli.rb

@@ -19,10 +19,41 @@ module AwesomeBot
       "--#{o}"
     end
 
-    def output(x, k)
+    def loc_formatted(loc, largest=3)
+      format = "%0#{largest}d"
+      line = "#{sprintf format, loc}"
+      "[L#{line}] "
+    end
+
+    def loc(x, content)
+      count = 0
+      lines = content.split "\n"
+      lines.each do |l|
+        count += 1
+        return count if l.include? x
+      end
+    end
+
+    def number_of_digits(content)
+      lines = content.split "\n"
+      return lines.count.to_s.size
+    end
+
+    def order_by_loc(list, content)
+      list.each do |x|
+        x['loc'] = loc x['url'], content
+      end
+
+      s = list.sort_by { |h| h['loc'] }
+      return s
+    end
+
+    def output(x, k, total, largest)
+      format = "%0#{total}d"
+      print "  #{sprintf format, k + 1}. "
       s = x['status']
-      print "  #{k + 1}. "
-      print "#{s} " unless s == STATUS_ERROR
+      print loc_formatted x['loc'], largest
+      print "#{s} " unless s== STATUS_ERROR
       print "#{x['url']}"
       print " #{x['error']}" if s == STATUS_ERROR
       print " #{STATUS_REDIRECT} #{x['headers']['location']}" if status_is_redirected? s
@@ -110,8 +141,6 @@ module AwesomeBot
         allow_timeouts = false
       end
 
-      # Faraday.options.timeout = timeout unless timeout.nil?
-
       log = Log.new(true)
 
       options = {
@@ -121,10 +150,12 @@ module AwesomeBot
       }
       r = check(content, options, log)
 
+      digits = number_of_digits content
       unless r.white_listed.nil?
         puts "\n> White listed:"
-        r.white_listed.each_with_index do |x, k|
-          output x, k
+        o = order_by_loc r.white_listed, content
+        o.each_with_index do |x, k|
+          output x, k, o.count.to_s.size, digits
         end
       end
 
@@ -138,9 +169,9 @@ module AwesomeBot
         if r.success_links(allow_redirects, allow_timeouts)
           puts "  All OK #{STATUS_OK}"
         else
-          r.statuses_issues(allow_redirects, allow_timeouts)
-            .each_with_index do |x, k|
-              output x, k
+          o = order_by_loc r.statuses_issues(allow_redirects, allow_timeouts), content
+          o.each_with_index do |x, k|
+              output x, k, o.count.to_s.size, digits
           end
         end
 

data/lib/awesome_bot/statuses.rb

@@ -9,9 +9,8 @@ module AwesomeBot
   STATUS_ERROR = -1
 
   class << self
-    def net_status(url, head, timeout)
+    def net_status(url, head, timeout=30)
       uri = URI.parse url
-      timeout = 60 if timeout.nil?
       Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https', :open_timeout => timeout) do |http|
        request = Net::HTTP::Get.new uri
        response = http.request request
@@ -28,8 +27,7 @@ module AwesomeBot
       Parallel.each(links, in_threads: threads) do |u|
         begin
           response = net_status u, head, timeout
-          status = response.code.to_i
-          status = 200 if status.nil?
+          status = response.code==nil ? 200 : response.code.to_i
           headers = {}
           response.each { |k, v| headers[k] = v }
           error = nil # nil (success)

data/lib/awesome_bot/version.rb

@@ -5,5 +5,5 @@ module AwesomeBot
                         'Great for "awesome" projects.'
   PROJECT_URL = 'https://github.com/dkhamsing/awesome_bot'
 
-  VERSION = '1.8.0'
+  VERSION = '1.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel