broken_link_finder 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f89fd142f329ee9b5df8de5a01abd2976cab0b16a690e50d98a0775a94eb937
-  data.tar.gz: 81e1db2b0a7f2e76e0113b4086fea5a41a6bca6b8f51d79d849007fe73fb3c34
+  metadata.gz: 00dd2be1d5bc9a2fe1d6c94a66a27dc29844aa986b9742328135b70ed490e289
+  data.tar.gz: 72669b20d0a080254b1e6481cb08887126aed78f37c138f6d3658c696c719fae
 SHA512:
-  metadata.gz: d8d9d745fdd025ce30a6c082730b878deb409bd7342d82f63dfbffbbecb5fa75f4ddadea2acace87904255199cb32b53277662d573534079d7d6575d2e80e03b
-  data.tar.gz: 813926476b8fed62c28a46decbff72018134f547f1618dd28418d6ea31f55bbc55bd43d0cd47bfc36fd8a476e0d65f4dd21d31d6bd79aeb3317d5282bbe9c46b
+  metadata.gz: c21b88afb280842f4fc72723a1dbfca6cd80cd8a3d821bff53b385bc793c009fe02c5e58c3feeb836b86f867014ca468037a3d863b6b50cf1833af29327c15f9
+  data.tar.gz: b471806008dafff72fd66994cc95c5622314115faaf939c739bd2f09c1d8055b6abcdc3507530821f93787678d0c52b91f25c727e6f4061d1e281afc4a27c31d

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    broken_link_finder (0.3.0)
+    broken_link_finder (0.4.0)
+      thor (= 0.20.3)
       thread (= 0.2)
       wgit (= 0.0.9)
 
@@ -29,6 +30,7 @@ GEM
     public_suffix (3.1.0)
     rake (10.5.0)
     safe_yaml (1.0.5)
+    thor (0.20.3)
     thread (0.2.0)
     webmock (3.5.1)
       addressable (>= 2.3.6)

data/README.md

@@ -26,7 +26,19 @@ Or install it yourself as:
 
 ## Usage
 
-Below is a simple script which crawls a website and outputs its broken links to STDOUT.
+### Executable
+
+Installing this gem installs the `broken_link_finder` executable into your `$PATH`. The executable allows you to find broken links from your command line. For example:
+
+    $ broken_link_finder crawl http://txti.es
+
+Adding the `-r` switch would crawl the entire txti.es site, not just it's index page.
+
+See the [output](##Output) section below for an example of a site with broken links.
+
+### Library
+
+Below is a simple script which crawls a website and outputs it's broken links to `STDOUT`.
 
 > main.rb
 
@@ -42,7 +54,9 @@ Then execute the script with:
 
     $ ruby main.rb
 
-If broken links are found then the output should look something like:
+## Output
+
+If broken links are found then the output will look something like:
 
 ```text
 Below is a breakdown of the different pages and their broken links...
@@ -60,7 +74,6 @@ http://imgur.com
 
 ## TODO
 
-- Create a `broken_link_finder` executable.
 - Add logger functionality (especially useful in the console during development).
 
 ## Development

data/broken_link_finder.gemspec

@@ -29,9 +29,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "bin"
-  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = "exe"
+  spec.executables   = ["broken_link_finder"]
   spec.require_paths = ["lib"]
+  spec.post_install_message = "Added the executable 'broken_link_finder' to $PATH"
 
   spec.required_ruby_version = '~> 2.5' # Only works with ruby 2.5.x
 
@@ -44,4 +45,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "wgit", "0.0.9"
   spec.add_runtime_dependency "thread", "0.2"
+  spec.add_runtime_dependency "thor", "0.20.3"
 end

data/exe/broken_link_finder

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'broken_link_finder'
+require 'thor'
+
+class BrokenLinkFinderCLI < Thor
+  desc 'crawl [URL]', 'Find broken links at the URL'
+  option :recursive, type: :boolean, aliases: [:r], desc: 'Crawl the entire site'
+  def crawl(url)
+    url = "http://#{url}" unless url.start_with?('http')
+    finder = BrokenLinkFinder::Finder.new
+    options[:recursive] ? finder.crawl_site(url) : finder.crawl_page(url)
+    finder.pretty_print_broken_links
+  end
+end
+
+BrokenLinkFinderCLI.start(ARGV)

data/lib/broken_link_finder/version.rb

@@ -1,3 +1,3 @@
 module BrokenLinkFinder
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: broken_link_finder
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Telford
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,10 +122,25 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.3
 description: Finds a website's broken links using the 'wgit' gem and reports back
   to you with a summary.
 email: michael.telford@live.com
-executables: []
+executables:
+- broken_link_finder
 extensions: []
 extra_rdoc_files: []
 files:
@@ -140,6 +155,7 @@ files:
 - bin/console
 - bin/setup
 - broken_link_finder.gemspec
+- exe/broken_link_finder
 - lib/broken_link_finder.rb
 - lib/broken_link_finder/finder.rb
 - lib/broken_link_finder/version.rb
@@ -150,7 +166,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/michaeltelford/broken-link-finder
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: Added the executable 'broken_link_finder' to $PATH
 rdoc_options: []
 require_paths:
 - lib