link-checker 0.3.1 → 0.4.0

data/Gemfile

@@ -3,6 +3,7 @@ source :rubygems
 gem "nokogiri", "~> 1.5.5"
 gem "colorize", "~> 0.5.8"
 gem "anemone", "~> 0.7.2"
+gem "trollop", "~> 2.0"
 
 group(:test, :development) do
   gem "rspec", "~> 2.11.0"

data/Gemfile.lock

@@ -41,6 +41,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    trollop (2.0)
     yard (0.8.2.1)
 
 PLATFORMS
@@ -56,4 +57,5 @@ DEPENDENCIES
   redcarpet (~> 2.1.1)
   rspec (~> 2.11.0)
   simplecov (~> 0.6.4)
+  trollop (~> 2.0)
   yard (~> 0.8.2.1)

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/bin/check-links

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
 require 'link_checker'
+require 'trollop'
 
-# Assume the 'public' directory is the site unless otherwise specified.
-target = ARGV[0] || './'
+options = Trollop::options do
+	opt :no_warnings, "Don't warn about redirects to valid links"
+end
 
-LinkChecker.new(target).check_uris
+exit LinkChecker.new(:options => options, :target => ARGV[0]).check_uris

data/lib/link_checker.rb

@@ -8,8 +8,10 @@ require 'anemone'
 
 class LinkChecker
 
-  def initialize(target)
-    @target = target
+  def initialize(params)
+    @options = params[:options] || {}
+    @target =  params[:target] || './'
+    @return_code = 0
   end
 
   def html_file_paths
@@ -41,6 +43,7 @@ class LinkChecker
         when Net::HTTPRedirection then
           return self.check_uri(URI(response['location']), true)
         else
+          @return_code = 1
           return Error.new(:uri_string => uri.to_s, :response => response)
         end
       end
@@ -48,11 +51,16 @@ class LinkChecker
   end
 
   def check_uris
-    if @target =~ /^https?\:\/\//
-      check_uris_by_crawling
-    else
-      check_uris_in_files
+    begin
+      if @target =~ /^https?\:\/\//
+        check_uris_by_crawling
+      else
+        check_uris_in_files
+      end
+    rescue => error
+      puts "Error: #{error.to_s}".red
     end
+    @return_code
   end
 
   def check_uris_by_crawling
@@ -60,6 +68,7 @@ class LinkChecker
     Anemone.crawl(@target) do |anemone|
       anemone.storage = Anemone::Storage.PStore('link-checker-crawled-pages.pstore')
       anemone.on_every_page do |crawled_page|
+        raise StandardError.new(crawled_page.error) if crawled_page.error
         threads << start_link_check_thread(crawled_page.body, crawled_page.url.to_s)
       end
     end
@@ -95,14 +104,16 @@ class LinkChecker
     Thread.exclusive do
       if bad_checks.empty?
         message = "Checked: #{file}"
-        if warnings.empty?
+        if warnings.empty? || @options[:no_warnings]
           puts message.green
         else
           puts message.yellow
         end
-        warnings.each do |warning|
-          puts "   Warning: #{warning[:uri_string]}".yellow
-          puts "     Redirected to: #{warning[:response].final_destination_uri_string}".yellow
+        unless @options[:no_warnings]
+          warnings.each do |warning|
+            puts "   Warning: #{warning[:uri_string]}".yellow
+            puts "     Redirected to: #{warning[:response].final_destination_uri_string}".yellow
+          end
         end
       else
         puts "Problem: #{file}".red

data/link-checker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "link-checker"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Alyn Porter"]
-  s.date = "2012-10-05"
+  s.date = "2012-10-06"
   s.description = "Check the links in a web site before deploying, using Nokogiri."
   s.executables = ["check-links"]
   s.extra_rdoc_files = [
@@ -378,6 +378,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.5"])
       s.add_runtime_dependency(%q<colorize>, ["~> 0.5.8"])
       s.add_runtime_dependency(%q<anemone>, ["~> 0.7.2"])
+      s.add_runtime_dependency(%q<trollop>, ["~> 2.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<simplecov>, ["~> 0.6.4"])
@@ -389,6 +390,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<nokogiri>, ["~> 1.5.5"])
       s.add_dependency(%q<colorize>, ["~> 0.5.8"])
       s.add_dependency(%q<anemone>, ["~> 0.7.2"])
+      s.add_dependency(%q<trollop>, ["~> 2.0"])
       s.add_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<simplecov>, ["~> 0.6.4"])
@@ -401,6 +403,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<nokogiri>, ["~> 1.5.5"])
     s.add_dependency(%q<colorize>, ["~> 0.5.8"])
     s.add_dependency(%q<anemone>, ["~> 0.7.2"])
+    s.add_dependency(%q<trollop>, ["~> 2.0"])
     s.add_dependency(%q<rspec>, ["~> 2.11.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<simplecov>, ["~> 0.6.4"])

data/spec/link-checker_spec.rb

@@ -10,7 +10,7 @@ describe LinkChecker do
     end
 
     it "finds all of the HTML files in the target path." do
-      files = LinkChecker.new(@site_path).html_file_paths
+      files = LinkChecker.new(:target => @site_path).html_file_paths
       files.size.should == 3
     end
 
@@ -60,8 +60,8 @@ describe LinkChecker do
       end
 
       it "declares bad redirect targets to be bad." do
-        FakeWeb.register_uri(:get, @redirect_uri.to_s,
-          :location => @bad_uri.to_s, :status => ["302", "Moved"])
+          FakeWeb.register_uri(:get, @redirect_uri.to_s,
+            :location => @bad_uri.to_s, :status => ["302", "Moved"])
         result = LinkChecker.check_uri(@redirect_uri)
         result.class.should be LinkChecker::Error
       end
@@ -83,7 +83,7 @@ describe LinkChecker do
         LinkChecker::Good.new(:uri_string => 'http://something.com')
       end
       $stdout.should_receive(:puts).with(/Checked/i).once
-      LinkChecker.new(@site_path).check_uris
+      LinkChecker.new(:target => @site_path).check_uris
     end
 
     it "prints red when the links are bad." do
@@ -96,7 +96,7 @@ describe LinkChecker do
       $stdout.should_receive(:puts).with(/Problem/i).once
       $stdout.should_receive(:puts).with(/Link/i).once
       $stdout.should_receive(:puts).with(/Response/i).once
-      LinkChecker.new(@site_path).check_uris
+      LinkChecker.new(:target => @site_path).check_uris
     end
 
     it "prints yellow warnings when the links redirect." do
@@ -109,7 +109,20 @@ describe LinkChecker do
       $stdout.should_receive(:puts).with(/Checked/i).once
       $stdout.should_receive(:puts).with(/Warning/i).once
       $stdout.should_receive(:puts).with(/Redirected/i).once
-      LinkChecker.new(@site_path).check_uris
+      LinkChecker.new(:target => @site_path).check_uris
+    end
+
+    it "does not print warnings when the links redirect with the --no-warnings option." do
+      LinkChecker.stub(:check_uri) do
+        LinkChecker::Redirect.new(
+          :uri_string => 'http://something.com',
+          :final_desination => 'http://something-else.com'
+        )
+      end
+      $stdout.should_receive(:puts).with(/Checked/i).once
+      $stdout.should_receive(:puts).with(/Warning/i).once
+      $stdout.should_receive(:puts).with(/Redirected/i).once
+      LinkChecker.new(:target => @site_path).check_uris
     end
 
   end
@@ -121,19 +134,36 @@ describe LinkChecker do
       $stdout.should_receive(:puts).with(/Problem/i).once
       $stdout.should_receive(:puts).with(/Link/i).once
       $stdout.should_receive(:puts).with(/Response/i).once
-      thread = LinkChecker.new(@site_path).start_link_check_thread('<html></html>', 'source.html')
+      thread = LinkChecker.new(:target => @site_path).start_link_check_thread('<html></html>', 'source.html')
       thread.join
     end
 
   end
 
   it "crawls a web site." do
+    FakeWeb.register_uri(:any, 'http://some-target.com', :body => "Yay it worked.")
     LinkChecker.stub(:external_link_uri_strings).and_return(['http://something.com'])
     LinkChecker.stub(:check_uri) do
       LinkChecker::Good.new(:uri_string => 'http://something.com')
     end
     $stdout.should_receive(:puts).with(/Checked/i).once
-    LinkChecker.new('http://pretty-sure-this-is-not-real.com').check_uris
+    LinkChecker.new(:target => 'http://some-target.com').check_uris
+  end
+
+  describe "produces useful return codes when" do
+
+    it "the target file does not exist." do
+      Find.stub(:find).and_raise(Errno::ENOENT.new('test'))
+      $stdout.should_receive(:puts).with(/Error/i).once
+      LinkChecker.new(:target => 'does-not-exist').check_uris
+    end
+
+    it "the target file does not exist." do
+      FakeWeb.allow_net_connect = false
+      $stdout.should_receive(:puts).with(/Error/i).once
+      LinkChecker.new(:target => 'http://does-not-exist.com').check_uris
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link-checker
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -542,7 +558,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -623461632206689908
+      hash: 1966410350842699633
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: