awesome_bot 1.17.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3cf1c092e8b2268a453ae9322104d7cdb04eb45
-  data.tar.gz: 2c9e2b935aa0a6dcc4fe004a46f543e07facf6f5
+  metadata.gz: a3d4e16495337ecdb24033c9d20ebcf92d6079c6
+  data.tar.gz: dd8ccc69f014fc37dcffb1df137c218aa94f3698
 SHA512:
-  metadata.gz: 9f49bbe435557f0a0bf4cf5a02a90feca2590efc4ca94f3de3d1ff45a8696672e35e8288ee6ed21152abdef5b7e1407a60a6e9b9a30ddd5785297859fa3097c5
-  data.tar.gz: 841890e757726514ca372de064fd993a60eb5d7cc5180b52f5a7ef3b837edaaa63ff1fb3b15e5d74a7c6799af5c6357cbc9064c3e29ee1c9045e882cb1e73b55
+  metadata.gz: 1c2e95b89a2a3ab9df7dba8a8796e4f908ecbc308be6fceda5876cf10ca1d50e10c096b168f89d41cbbc2934c8c64a652bf1bf351b03307605e2351213bf436f
+  data.tar.gz: ae5d7bf39bb7967bbc759bd99a074f28e142bf09a18effd423540b125adca60f0fce64c6f3ac65375c7ab487a3e4cfdb088b0e30ceaa9929b01ccd324ace9985

data/.circleci/config.yml

@@ -0,0 +1,38 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/dkhamsing/awesome_bot
+    parallelism: 1
+    shell: /bin/bash --login
+    environment:
+      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
+      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
+    docker:
+    - image: circleci/build-image:ubuntu-14.04-XXL-upstart-1189-5614f37
+    steps:
+    - checkout
+    - run: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
+    - run:
+        working_directory: ~/dkhamsing/awesome_bot
+        command: rm -f dkhamsing/awesome_bot/.rvmrc; echo 2.4.1 > dkhamsing/awesome_bot/.ruby-version; rvm use 2.4.1 --default
+    - restore_cache:
+        keys:
+        - v1-dep-{{ .Branch }}-
+        - v1-dep-master-
+        - v1-dep-
+    - run: echo -e "export RAILS_ENV=test\nexport RACK_ENV=test" >> $BASH_ENV
+    - run: 'bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
+        --jobs=4 --retry=3 '
+    - save_cache:
+        key: v1-dep-{{ .Branch }}-{{ epoch }}
+        paths:
+        - vendor/bundle
+        - ~/virtualenvs
+        - ~/.bundle
+    - run: bundle exec rspec -fd --color -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+    - store_test_results:
+        path: /tmp/circleci-test-results
+    - store_artifacts:
+        path: /tmp/circleci-artifacts
+    - store_artifacts:
+        path: /tmp/circleci-test-results

data/.travis.yml

@@ -20,7 +20,5 @@ script:
   - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-redirect --allow-redirect
   - awesome_bot bin/assets/test-no-* --allow-redirect
   - awesome_bot bin/assets/test-ssl --allow-ssl
-  - awesome_bot bin/assets/test-invalid.md --allow-redirect --allow-dupe
-  - awesome_bot bin/assets/test-request-delay -d 1
   - awesome_bot README.md --allow-dupe --white-list gph.is,giphy,travis-ci.org,codeload,badge,rubydoc,rubygems,circleci,codeship,blob/master
   - gem install awesome_bot

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 Changes by [Daniel Khamsing][] unless otherwise noted.
 
+# 1.20.0
+
+- [cli] delay: change to use float by [Jonathan Lai](https://github.com/agsdot)
+- [gem] update `parallel`, `rspec` to latest
+
+# 1.19.1
+
+- [gem] update `parallel`, `rspec`, `rspec_junit_formatter` to latest
+
+# 1.19.0
+
+- [parse] handle javadoc links by [Davide Angelocola](https://github.com/dfa1)
+
+# 1.18.0
+
+- [parse] stricter parsing of relative urls by [Mat Moore](https://github.com/MatMoore)
+
+# 1.17.2
+
+- [cli] output version by [Budh Ram Gurung](https://github.com/budhrg)
+- [gem] update `parallel` to version 1.12.0
 
 # 1.17.1
 
@@ -196,14 +217,14 @@ Changes by [Daniel Khamsing][] unless otherwise noted.
 - use `result`
 - use `logger`
 
-## 1.1.0
+# 1.1.0
 
 - handle bad links
 - statuses yields `status`, `url`
 - add head option when getting statuses
 - [cli] improve output for `--allow-dupe`
 
-## 1.0.0
+# 1.0.0
 
 - correct failure logic
 - rename `run` to `check`
@@ -212,7 +233,7 @@ Changes by [Daniel Khamsing][] unless otherwise noted.
 - [gemspec] update
 - [travis] simplify
 
-## 0.1.0
+# 0.1.0
 
 - initial version
 

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:alpine
+
+RUN gem install awesome_bot --no-format-exec
+
+VOLUME /mnt
+
+WORKDIR /mnt
+
+ENTRYPOINT ["awesome_bot"]
+CMD ["--help"]

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
-gem 'rspec_junit_formatter', '0.2.3' # test meta data / ci
-gem 'rspec', '3.6.0' # tests'
+gem 'rspec_junit_formatter', '0.4.1' # test meta data / ci
+gem 'rspec', '3.10.0' # tests'

data/README.md

@@ -18,7 +18,7 @@ Verify links in [awesome](status/status.md) projects
 
 ### Command Line
 
-```
+``` shell
 Usage: awesome_bot [file or files]
        awesome_bot [options]
     -f, --files [files]              Comma separated files to check
@@ -29,7 +29,7 @@ Usage: awesome_bot [file or files]
         --allow-timeout              URLs that time out are allowed
         --base-url [base url]        Base URL to use for relative links
     -d, --request-delay [seconds]    Set request delay
-    -t, --set-timeout [seconds]      Set connection timeout
+    -t, --set-timeout [seconds]      Set connection timeout (default: 30)
         --skip-save-results          Skip saving results
     -w, --white-list [urls]          Comma separated URLs to white list
 ```
@@ -75,7 +75,7 @@ $ awesome_bot README.md,README-zh.md
 # check links in 2 files
 
 $ awesome_bot docs/*.md
-# check all markdown files in docs/ directory
+# check all Markdown files in the docs/ directory
 
 $ awesome_bot README.md --allow-timeout -t 5
 # speed up validation by setting a timeout of 5 seconds per link request and allowing timeouts
@@ -85,7 +85,7 @@ $ awesome_bot README.md --allow 403,429
 # --allow 301 would be similar to --allow-redirect
 
 $ awesome_bot README.md --base-url https://github.com/IDR/idr-notebooks/blob/master/
-# will check relative links using the base url provided
+# check relative links using the base URL provided
 ```
 
 ```shell
@@ -109,6 +109,25 @@ No issues :-)
 Wrote results to ab-results-new-readme.md.json
 ```
 
+### Docker Examples
+If you do not want to install Ruby or its dependencies you can simply use Docker and Docker image.
+
+Here is an example for checking the links in the Markdown files in your current directory/subdirectories:
+```shell
+docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --white-list "test.com" --allow-dupe --allow-redirect --skip-save-results `find . -name "*.md"`
+```
+
+or just check the links in a single file located at `./templates/ubuntu.md`:
+
+```shell
+docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --allow-dupe --allow-redirect --skip-save-results ./templates/ubuntu.md
+```
+
+You always need to specify the path to the file so you cannot simply use `*.md`; instead use `ls *.md"`:
+```shell
+docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --white-list "test.com" --allow-dupe --allow-redirect --skip-save-results `ls *.md`
+```
+
 ### Library
 
 ```ruby
@@ -140,16 +159,48 @@ and [more](status/status.md).
 
 Tips
 
-- Use the keyword `[ci skip]` in your commit title/message to skip verification.
+- Use the keyword [`[ci skip]`](https://docs.travis-ci.com/user/customizing-the-build/) in your commit title/message to skip verification.
 - Use [Danger](#danger).
 
+### GitHub Actions
+
+To use `awesome_bot` with GitHub Actions (workflows), here is an [example](https://github.com/dkhamsing/open-source-ios-apps/blob/master/.github/workflows/ruby.yml):
+
+```yml
+name: Ruby
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Checks
+      run: |
+        ruby .github/osia_convert.rb
+        gem install awesome_bot
+        ruby .github/osia_get_links.rb
+        awesome_bot check-unique.txt --allow-ssl -a 302,429 -w xbmc/xbmc
+```
+
 ### Travis CI
 
 To use `awesome_bot` with Travis CI, [connect your repo](https://travis-ci.org/) and create a [`.travis.yml` file](https://github.com/ziadoz/awesome-php/blob/master/.travis.yml).
 
 ```yml
 language: ruby
-rvm: 2.2
+rvm: 2.4.1
 before_script: gem install awesome_bot
 script: awesome_bot README.md
 ```
@@ -161,29 +212,27 @@ notifications:
   email: false
 ```
 
-### Circle CI
-
-If you prefer Circle CI, it'll work too. [Connect your repo](https://circleci.com/) and create a [`circle.yml` file](https://github.com/tmcw/awesome-geojson).
+In case you want to use the docker image inside Travis CI follow this example which will check broken links in all `*.md` files in your repository:
 
 ```yml
-machine:
-  ruby:
-    version: 2.2.0
-test:
-  pre:
-    - gem install awesome_bot
-  override:
-    - awesome_bot README.md
+sudo: required
+
+services:
+  - docker
+
+script:
+  # Link Checks
+  - docker run -ti --rm -v $PWD:/mnt:ro dkhamsing/awesome_bot --allow-dupe --allow-redirect --skip-save-results `find . -name "*.md"`
 ```
 
 ### More
 
-Circle CI, [Codeship](https://codeship.com/), and [Semaphore CI](https://semaphoreci.com/) support running tests without adding a file to the repo (a public configuration file can however help others contribute).
+[CircleCI](https://circleci.com), [Codeship](https://codeship.com/), and [Semaphore CI](https://semaphoreci.com/) support running tests without adding a file to the repo (a public configuration file can however help others contribute).
 
 ```
 # Codeship
 Setup
-rvm use 2.2.0 --install
+rvm use 2.4.1 --install
 gem install awesome_bot
 
 Test
@@ -193,7 +242,7 @@ awesome_bot README.md
 ```
 # Semaphore CI
 Language: Ruby
-Ruby version: 2.2
+Ruby version: 2.4.1
 Databases for: don't generate
 Setup:
 gem install awesome_bot
@@ -202,7 +251,7 @@ awesome_bot README.md
 
 ### Status Badge
 
-[![Build Status](https://travis-ci.org/unixorn/awesome-zsh-plugins.png)](https://travis-ci.org/unixorn/awesome-zsh-plugins)
+[![Build Status](https://travis-ci.org/unixorn/awesome-zsh-plugins.svg)](https://travis-ci.org/unixorn/awesome-zsh-plugins)
 
 To add the Travis CI build status badge above to your project, use the following code
 
@@ -213,17 +262,17 @@ i.e.
 [![Build Status](https://travis-ci.org/dkhamsing/awesome_bot.svg?branch=master)](https://travis-ci.org/dkhamsing/awesome_bot)
 ```
 
-As it happens, the default code snippet provided contain a redirect so adding a badge could fail your status :sob:.. one way to fix this is to white list `travis-ci`, i.e.
+As it happens, the default code snippet provided contains a redirect so adding a badge could fail your status :sob:.. one way to fix this is to white list `travis-ci`, i.e.
 
 ```
 - awesome_bot README.md --white-list travis-ci
 ```
 
-You can also add a badge for other CI tools, check out [shields.io](http://shields.io/).
+You can also add a badge for other CI tools, check out [shields.io](https://shields.io/).
 
 ### Danger
 
-Integrate `awesome_bot` with [Danger](https://github.com/danger/danger) and have results reported back to the [pull request](https://github.com/vsouza/awesome-ios/pull/1001)).
+Integrate `awesome_bot` with [Danger](https://github.com/danger/danger) and have results reported back to the [pull request](https://github.com/vsouza/awesome-ios/pull/1001).
 
 ![danger](https://cloud.githubusercontent.com/assets/4723115/17375716/0cdd37cc-5967-11e6-8ae3-829060a786dc.png)
 

data/awesome_bot.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_runtime_dependency 'parallel', '1.11.2' # threading
+  spec.add_runtime_dependency 'parallel', '1.20.1' # threading
 end

data/bin/assets/test-errors

@@ -1,6 +1,4 @@
- 
- 3.  [L056]  405 https://www.google.com/events/io
- 5.  [L130]  500 http://decentralizecamp.com/
+             500 http://decentralizecamp.com/
  02. [L0138] 401 https://developer.apple.com/library/ios/referencelibrary/GettingStarted/DevelopiOSAppsSwift/
  03. [L0145] 401 https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html
  04. [L0146] 401 https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/OOP_ObjC/Introduction/Introduction.html

data/bin/assets/test-timeout

@@ -1,2 +1,2 @@
-http://www.cmr.osu.edu/browse/datasets
+https://httpbin.org/delay/10
 https://github.com

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

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

data/lib/awesome_bot/cli.rb

@@ -24,10 +24,11 @@ module AwesomeBot
         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('--base-url [base url]',           String,    'Base URL to use for relative links') { |val| options['base_url'] = val }
-        opts.on('-d', '--request-delay [seconds]', Integer,   'Set request delay')                  { |val| options['delay'] = val }
-        opts.on('-t', '--set-timeout [seconds]',   Integer,   'Set connection timeout')             { |val| options['timeout'] = val }
-        opts.on('--skip-save-results',             TrueClass, 'Skip saving results')                { |val| options['no_results'] = val }        
+        opts.on('-d', '--request-delay [seconds]', Float,     'Set request delay')                  { |val| options['delay'] = val }
+        opts.on('-t', '--set-timeout [seconds]',   Integer,   'Set connection timeout (default: 30)')             { |val| options['timeout'] = val }
+        opts.on('--skip-save-results',             TrueClass, 'Skip saving results')                { |val| options['no_results'] = val }
         opts.on('-w', '--white-list [urls]',       Array,     'Comma separated URLs to white list') { |val| options['white_list'] = val }
+        opts.on('-v', '--version',                 String,    'Display version')                    { |val| puts "#{PROJECT} version #{VERSION}" }
 
         opts.on_tail("--help") do
           puts opts

data/lib/awesome_bot/links.rb

@@ -1,5 +1,14 @@
 # Get and filter links
 module AwesomeBot
+  # This matches, from left to right:
+  # a literal [
+  # the link title - i.e. anything up to the next closing bracket
+  # a literal ]
+  # a literal (
+  # the link destination (optionally enclosed in a single pair of angle brackets)
+  # a literal )
+  MARKDOWN_LINK_REGEX = /\[ [^\]]+ \] \( <? ([^)<>]+) >? \)/x
+
   class << self
     def links_filter(list)
       list.reject { |x| x.length < 9 }
@@ -9,6 +18,8 @@ module AwesomeBot
         .map do |x|
           if x.include? ')]'
             x.gsub /\)\].*/, ''
+          elsif (x.scan(')').count == 1) && (x.scan('(').count == 1)
+            x
           elsif (x.scan(')').count == 2) && (x.scan('(').count == 1)
             x.gsub(/\)\).*/, ')')
           elsif (x.scan(')').count > 0)
@@ -45,9 +56,10 @@ module AwesomeBot
     end
 
     def get_relative_links(content, base)
-      links = content.scan /\].*?\)/
+      links = []
+      content.scan(MARKDOWN_LINK_REGEX) { |groups| links << groups.first }
+
       links.reject { |x| x.include?('http') || x.include?('#') }
-        .map { |x| x.sub '](', ''}
         .map { |x| x =~ /\S/ ? x.match(/^\S*/) : x }
         .map { |x| "#{base}#{x}"}
     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.17.1'
+  VERSION = '1.20.0'
 end

data/status/list-travis-ci

@@ -3,13 +3,15 @@ vsouza/awesome-ios
 enaqx/awesome-react
 bayandin/awesome-awesomeness
 toddmotto/public-apis
-herrbischoff/awesome-osx-command-line
+herrbischoff/awesome-macos-command-line
 ziadoz/awesome-php
 matteocrippa/awesome-swift
 wsargent/docker-cheat-sheet
+jaywcjlove/awesome-mac
+Kickball/awesome-selfhosted
 alebcay/awesome-shell
 cjwirth/awesome-ios-ui
-abhishekbanthia/Public-APIs
+n0shake/Public-APIs
 gztchan/awesome-design
 veggiemonk/awesome-docker
 hangtwenty/dive-into-machine-learning
@@ -22,7 +24,7 @@ n1trux/awesome-sysadmin
 hsavit1/Awesome-Swift-Education
 k4m4/terminals-are-sexy
 chiraggude/awesome-laravel
-AngularClass/awesome-angular
+gdi2290/awesome-angular
 JStumpp/awesome-android
 ellisonleao/magictools
 j-delaney/easy-application
@@ -53,7 +55,7 @@ willianjusten/awesome-audio-visualization
 sitepoint-editors/awesome-symfony
 fasouto/awesome-dataviz
 matiassingers/awesome-readme
-sotayamashita/awesome-css
+awesome-css-group/awesome-css
 ramitsurana/awesome-kubernetes
 wbinnssmith/awesome-promises
 nikgraf/awesome-draft-js
@@ -76,7 +78,7 @@ benoitjadinon/awesome-xamarin
 matteofigus/awesome-speaking
 burningtree/awesome-json
 ahkscript/awesome-AutoHotkey
-vredniy/awesome-newsletters
+zudochkin/awesome-newsletters
 brunopulis/awesome-a11y
 jbucaran/awesome-fish
 hackerkid/bots
@@ -91,14 +93,14 @@ aviaryan/awesome-no-login-web-apps
 arbox/ruby-style-guide
 iJackUA/awesome-vagrant
 deanhume/typography
-vinkla/awesome-fuse
+fuse-compound/awesome-fuse
 notthetup/awesome-webaudio
 brabadu/awesome-fonts
 tedyoung/awesome-java8
 MakinGiants/awesome-android-learner
 christian-bromann/awesome-selenium
 busterc/awesome-cordova
-jjaderg/awesome-postcss
+jdrgomes/awesome-postcss
 jakoch/awesome-composer
 filipelinhares/awesome-slack
 shime/creative-commons-media
@@ -107,11 +109,11 @@ joubertredrat/awesome-devops
 J2TeaM/awesome-AutoIt
 arbox/rails-style-guide
 neueda/awesome-neo4j
-RichardLitt/endangered-languages
+RichardLitt/low-resource-languages
 cugu/awesome-forensics
 rabbiabram/awesome-fortran
 vkarampinis/awesome-icons
-wfhio/awesome-job-boards
+tramcar/awesome-job-boards
 yangshun/awesome-spinners
 sjfricke/awesome-webgl
 Jolg42/awesome-typography
@@ -122,6 +124,14 @@ ramitsurana/awesome-openstack
 Nipher/awesome-hacktivism
 ipfs/newsletter
 ellerbrock/awesome-typescript
-cdleon/awesome-front-end
+cdleon/awesome-browser-dev
 adriagalin/tools
 arthurwayne/awesome-pentester
+alister/php-in-london
+IQDevs/Awesome-IQDevs
+BubuAnabelas/awesome-markdown
+serhii-londar/open-source-mac-os-apps
+frenck/awesome-home-assistant
+duyetdev/awesome-web-scraper
+tapaswenipathak/Women-GitHubers
+emacs-tw/awesome-emacs