awesome_bot 1.8.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f195dc3e6ffcad817c7d912b22f7bb8d8b8e947d
-  data.tar.gz: 291f0250d6f81cffa3b5361aed805c3646797886
+  metadata.gz: 9f0cbdb5d7a7e2db7fb90d76ce2c444cee6456b1
+  data.tar.gz: 6dee220ffd70eb6b7f8fe37302faf51f1b9e7d9e
 SHA512:
-  metadata.gz: 77e634ea2d1a908496765ef33335e95a11c34137049c5d4f4b1b946daefa728bf8dc9110e3a55c25aeaa9c7e2ebc3bf7b08824182ab23358998696ee139395f0
-  data.tar.gz: 39394dd0a2db5b3dd8225e74e51dc32d77f1f31bb0fa2e37bb43ad0c87b7cb9d65925aea6f16fd3d85826ebbede5f35a1810af6f21079ad4bbec9862f6910743
+  metadata.gz: 894ee0128f3b177805182a6c6e74fac43c150182383647e27e8a3b021302937752377c836c88654aaba51b0e983159af3a49e4ebd724ab3eccb15a9c773e08af
+  data.tar.gz: 7694fe013d9a93af945cceaffee1cf045eabf22258a59d52b69fbffeac20ea5cae8679ea1486b7f6ad29c342b3721eee19f62b5dd52dc1964b5b61378eb8fa3b

data/.travis.yml

@@ -14,5 +14,8 @@ script:
   - awesome_bot bin/assets/test-redirect --allow-redirect
   - awesome_bot bin/assets/test-statuses --white-list bot,bad,super
   - awesome_bot bin/assets/test-errors
+  - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-no-links
+  - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-redirect --allow-redirect
+  - awesome_bot bin/assets/test-no-* --allow-redirect
   - awesome_bot README.md --allow-dupe --white-list gph.is,giphy,travis-ci.org,codeload,badge,rubydoc,rubygems,circleci
   - gem install awesome_bot

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Changes by [Daniel Khamsing][] unless otherwise noted.
 
+# 1.9.0
+
+- [cli] support checking multiple files (comma separated or `*` pattern  i.e. `docs/*.md`), suggested by [Sota Yamashita](https://github.com/sotayamashita)
+- [cli] use `optparse`
+
 # 1.8.5
 
 - [fix] request errors (make `get` requests), reported by [Richard Littauer](https://github.com/RichardLitt)

data/README.md

@@ -18,19 +18,24 @@ Verify links in [awesome](https://github.com/sindresorhus/awesome) projects
 
 ### Command Line
 
-    awesome_bot <file> [--allow-dupe] [--allow-redirect] [--allow-timeout] [--set-timeout d] [--white-list item1,item2,..]
-      file             Path to file, required as first argument
-      --allow-dupe     Duplicate URLs are allowed
-      --allow-redirect Redirected URLs are allowed
-      --allow-timeout  URLs that time out are allowed
-      --set-timeout    Set connection timeout (seconds)
-      --white-list     Comma separated URLs/domains to white list
+```
+Usage: awesome_bot [file or files]
+       awesome_bot [options]
+    -f, --files [files]              Comma separated files to check
+        --allow-dupe                 Duplicate URLs are allowed
+        --allow-redirect             Redirected URLs are allowed
+        --allow-timeout              URLs that time out are allowed
+    -t, --set-timeout [seconds]      Set connection timeout
+    -w, --white-list [urls]          Comma separated URLs to white list
+```
 
-By default, `awesome_bot` flags duplicates and URL redirects.
+- You can check multiple files (comma separated or `*` pattern, look below for details).
 
-- Use option `--allow-dupe` to allow duplicates.
-- Use option `--allow-redirect` to all redirects.
-- You can also white list specific links that will not be flagged (for dupe or redirect). `--white-list domain1.com/post/article,domain2.com` white lists `domain1.com/post/article` and all links matching `domain2.com`.
+- By default, `awesome_bot` flags duplicates and URL redirects.
+
+  - Use option `--allow-dupe` to allow duplicates.
+  - Use option `--allow-redirect` to all redirects.
+  - You can white list links so that they won't be flagged. `-w domain1.com/post/article,domain2.com` white lists `domain1.com/post/article` and all links matching `domain2.com`.
 
 ### Examples
 
@@ -57,22 +62,17 @@ Issues :-(
 ```
 
 ```shell
-$ awesome_bot README.md --allow-dupe --allow-redirect --white-list rubydoc,giphy
-> Checking links in README.md
-> Will allow redirects
-> Will allow duplicate links
-> White list links matching: rubydoc, giphy
-Links to check: 41, 5 white listed, 29 unique
-  01. https://github.com/sindresorhus/awesome
-  02. https://travis-ci.org/dkhamsing/awesome_bot.svg
-# ...
-Checking URLs: ✓✓→✓✓→→→✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓→✓✓✓→✓
-Checking white listed URLs: ?✓
+$ awesome_bot README.md --allow-dupe --allow-redirect --w rubydoc,giphy
+# allow redirects, dupes and white list all links matching rubydoc and giphy
+
+$ awesome_bot README.md,README-zh.md
+# check links in 2 files
+
+$ awesome_bot docs/*.md
+# check all markdown files in docs/ directory
 
-> White listed:
-  1. [L005] 200 http://i.giphy.com/urvsFBDfR6N32.gif
-  2. [L093] 202 http://www.rubydoc.info/gems/awesome_bot
-No issues :-)
+$ awesome_bot README.md --allow-timeout --t 5
+# speed up validation by setting a timeout of 5s per link request and allowing timeouts
 ```
 
 ### Library
@@ -96,15 +96,15 @@ More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
 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:
 
 - https://github.com/tiimgreen/github-cheat-sheet
-- https://github.com/vinta/awesome-python
 - https://github.com/enaqx/awesome-react
+- https://github.com/ziadoz/awesome-php
 - https://github.com/vsouza/awesome-ios
 - https://github.com/alebcay/awesome-shell
 - https://github.com/matteocrippa/awesome-swift
 
 and [more](status/status.md).
 
-Tip: Use the keyword `[ci skip]` in your commit title/message to selectively skip verification (if you are let's say working on a bunch of changes).
+Tip: Use the keyword `[ci skip]` in your commit title/message to skip verification.
 
 ### Travis CI
 
@@ -182,7 +182,7 @@ As it happens, the default code snippet provided contain a redirect so adding a
 - awesome_bot README.md --white-list travis-ci
 ```
 
-You can also add a badge for other CI tools, I recommend checking out [shields.io](http://shields.io/).
+You can also add a badge for other CI tools, check out [shields.io](http://shields.io/).
 
 ## Contact
 

data/lib/awesome_bot/cli.rb

@@ -5,101 +5,86 @@ require 'awesome_bot/version'
 
 # Command line interface
 module AwesomeBot
-  OPTION_DUPE = 'allow-dupe'
-  OPTION_REDIRECT = 'allow-redirect'
-  OPTION_TIMEOUT_ALLOW = 'allow-timeout'
-  OPTION_TIMEOUT_SET = 'set-timeout'
-  OPTION_WHITE_LIST = 'white-list'
+  RESULTS_PREFIX = 'ab-results'
 
-  RESULTS_FILE = 'ab-results.json'
+  class << self
+    def cli
+      require 'optparse'
 
-  USAGE = "\t"
+      ARGV << '-h' if ARGV.empty?
 
-  class << self
-    def make_option(o)
-      "--#{o}"
-    end
+      options = {}
+      ARGV.options do |opts|
+        opts.banner = "Usage: #{PROJECT} [file or files] \n"\
+                      "       #{PROJECT} [options]"
 
-    def cli
-      option_d   = make_option OPTION_DUPE
-      option_r   = make_option OPTION_REDIRECT
-      option_t   = make_option OPTION_TIMEOUT_SET
-      option_t_a = make_option OPTION_TIMEOUT_ALLOW
-      option_w   = make_option OPTION_WHITE_LIST
-
-      options = [
-        option_d,
-        option_r,
-        option_t,
-        option_t_a,
-        option_w
-      ]
-
-      if ARGV.count == 0
-        puts "Usage: #{PROJECT} <file> [#{option_d}] [#{option_r}] "\
-             "[#{option_t_a}] [#{option_t} d] "\
-             "[#{option_w} item1,item2,..]\n"\
-             "#{USAGE} file             Path to file, required as first argument\n"\
-             "#{USAGE} #{option_d}     Duplicate URLs are allowed \n"\
-             "#{USAGE} #{option_r} Redirected URLs are allowed \n"\
-             "#{USAGE} #{option_t_a}  URLs that time out are allowed \n"\
-             "#{USAGE} #{option_t}    Set connection timeout (seconds) \n"\
-             "#{USAGE} #{option_w}     Comma separated URLs to white list \n"\
-             "\nVersion #{VERSION}, see #{PROJECT_URL} for more information"
-        exit
+        opts.on("-f", "--files [files]", Array, 'Comma separated files to check')  { |val| options['files'] = val }
+        opts.on("--allow-dupe", TrueClass, 'Duplicate URLs are allowed')  { |val| options['allow_dupe'] = val }
+        opts.on("--allow-redirect", TrueClass, 'Redirected URLs are allowed')  { |val| options['allow_redirect'] = val }
+        opts.on("--allow-timeout", TrueClass, 'URLs that time out are allowed')  { |val| options['allow_timeout'] = val }
+        opts.on("-t", "--set-timeout [seconds]", Integer, 'Set connection timeout')  { |val| options['timeout'] = val }
+        opts.on("-w", "--white-list [urls]", Array, 'Comma separated URLs to white list')  { |val| options['white_list'] = val }
+
+        opts.on_tail("--help") do
+          puts opts
+          exit
+        end
+        opts.parse!
       end
 
-      filename = ARGV[0]
+      files = options['files']
+      if files.nil?
+        files = []
+        ARGV.each do |a|
+          files.push a if a !~ /^--.*/
+        end
+      end
 
-      if options.include? filename
-        puts "Usage: #{PROJECT} <file> [options] \n"\
-             '                   Path to file, requried as first argument'
-        exit 1
+      summary = {}
+      files.each do |f|
+        summary[f] = cli_process(f, options)
       end
 
-      # Check options
-      user_options = ARGV.select { |o| o.include? '--' }
-      options_diff = user_options - options
-      if options_diff.count > 0
-        puts "Error, invalid options: #{options_diff.join ', '} \n"
-        puts "Valid options are #{options.join ', '}"
-        exit 1
+      if summary.count>1
+        puts "\nSummary"
+
+        largest = 0
+        summary.each do |k, v|
+          s = k.size
+          largest = s if s>largest
+        end
+
+        summary.each do |k, v|
+          k_display = "%#{largest}.#{largest}s" % k
+          puts "#{k_display}: #{v}"
+        end
       end
 
+      summary.each { |k, v| exit 1 unless v==STATUS_OK }
+    end
+
+    def cli_process(filename, options)
       begin
         content = File.read filename
       rescue => error
         puts "File open error: #{error}"
-        exit 1
+        return error
       end
 
       puts "> Checking links in #{filename}"
 
-      if ARGV.count > 1
-        options = ARGV.drop 1
+      skip_dupe = options['allow_dupe']
 
-        skip_dupe = options.include? option_d
+      allow_redirects = options['allow_redirect']
+      puts '> Will allow redirects' if allow_redirects == true
 
-        allow_redirects = options.include? option_r
-        puts '> Will allow redirects' if allow_redirects == true
+      allow_timeouts = options['allow_timeout']
+      puts '> Will allow network timeouts' if allow_timeouts == true
 
-        allow_timeouts = options.include? option_t_a
-        puts '> Will allow network timeouts' if allow_timeouts == true
+      white_listed = options['white_list']
 
-        if options.include? option_w
-          i = options.find_index(option_w) + 1
-          white_listed = options[i].split ','
-        end
-
-        if options.include? option_t
-          i = options.find_index(option_t) + 1
-          timeout = options[i].to_i
-          puts "> Connection timeout = #{timeout}s"
-        end
-      else
-        allow_redirects = false
-        allow_timeouts = false
-      end
+      timeout = options['timeout']
+      puts "> Connection timeout = #{timeout}s" unless timeout.nil?
 
       options = {
         'whitelist' => white_listed,
@@ -119,9 +104,13 @@ module AwesomeBot
         end
       end
 
+      allow_redirects = false if allow_redirects.nil?
+      allow_timeouts = false if allow_timeouts.nil?
+
       if r.success(allow_redirects, allow_timeouts) == true
         puts 'No issues :-)'
-        r.write RESULTS_FILE
+        cli_write_results(filename, r)
+        return STATUS_OK
       else
         puts "\nIssues :-("
 
@@ -156,12 +145,16 @@ module AwesomeBot
           end
         end
 
-        # write results json
-        r.write RESULTS_FILE
-        puts "\nWrote results to #{RESULTS_FILE}"
-
-        exit 1
+        cli_write_results(filename, r)
+        return 'Issues'
       end
     end
+
+    def cli_write_results(f, r)
+      results_file_filter = f.gsub('/','-')
+      results_file = "#{RESULTS_PREFIX}-#{results_file_filter}.json"
+      r.write results_file
+      puts "\nWrote results to #{results_file}"
+    end
   end # class
 end

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.5'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 1.9.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel