link-checker 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/check-links

@@ -5,6 +5,7 @@ require 'trollop'
 
 options = Trollop::options do
 	opt :no_warnings, "Don't warn about redirects to valid links"
+	opt :warnings_are_errors, "Treat any warning as an error and produce an error return code"
 end
 
 exit LinkChecker.new(:options => options, :target => ARGV[0]).check_uris

data/lib/link_checker.rb

@@ -43,7 +43,6 @@ 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
@@ -89,9 +88,10 @@ class LinkChecker
         begin
           uri = URI(uri_string)
           response = self.class.check_uri(uri)
-          { :uri_string => uri_string, :response => response }
+          response.uri_string = uri_string
+          response
         rescue => error
-          { :uri_string => uri_string, :response => Error.new(:error => error.to_s) }
+          Error.new(:error => error.to_s, :uri_string => uri_string)
         end
       end
       report_results(source_name, results)
@@ -99,10 +99,16 @@ class LinkChecker
   end
       
   def report_results(file, results)
-    bad_checks = results.select{|result| result[:response].class.eql? Error}
-    warnings = results.select{|result| result[:response].class.eql? Redirect}
+    errors = results.select{|result| result.class.eql? Error}
+    warnings = results.select{|result| result.class.eql? Redirect}
+    @return_code = 1 unless errors.empty?
+    if @options[:warnings_are_errors]
+      @return_code = 1 unless warnings.empty?
+      errors = errors + warnings
+      warnings = []
+    end
     Thread.exclusive do
-      if bad_checks.empty?
+      if errors.empty?
         message = "Checked: #{file}"
         if warnings.empty? || @options[:no_warnings]
           puts message.green
@@ -111,22 +117,27 @@ class LinkChecker
         end
         unless @options[:no_warnings]
           warnings.each do |warning|
-            puts "   Warning: #{warning[:uri_string]}".yellow
-            puts "     Redirected to: #{warning[:response].final_destination_uri_string}".yellow
+            puts "   Warning: #{warning.uri_string}".yellow
+            puts "     Redirected to: #{warning.final_destination_uri_string}".yellow
           end
         end
       else
         puts "Problem: #{file}".red
-        bad_checks.each do |check|
-          puts "   Link: #{check[:uri_string]}".red
-          puts "     Response: #{check[:response].error.to_s}".red
+        errors.each do |error|
+          puts "   Link: #{error.uri_string}".red
+          case error
+          when Redirect
+            puts "     Redirected to: #{error.final_destination_uri_string}".red
+          when Error
+            puts "     Response: #{error.error.to_s}".red
+          end
         end
       end
     end
   end
 
   class Result
-    attr_reader :uri_string
+    attr_accessor :uri_string
     def initialize(params)
       @uri_string = params[:uri_string]
     end

data/link-checker.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "link-checker"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Alyn Porter"]

data/spec/link-checker_spec.rb

@@ -75,7 +75,8 @@ describe LinkChecker do
     before(:each) do
       LinkChecker.any_instance.stub(:html_file_paths) {
         ['spec/test-site/public/blog/2012/10/02/a-list-of-links/index.html'] }
-      LinkChecker.stub(:external_link_uri_strings).and_return(['http://something.com'])
+      LinkChecker.stub(:external_link_uri_strings).and_return(
+        ['http://something.com', 'http://something-else.com'])
     end
 
     it "prints green when the links are good." do
@@ -83,7 +84,7 @@ describe LinkChecker do
         LinkChecker::Good.new(:uri_string => 'http://something.com')
       end
       $stdout.should_receive(:puts).with(/Checked/i).once
-      LinkChecker.new(:target => @site_path).check_uris
+      LinkChecker.new(:target => @site_path).check_uris.should == 0 # Return value: good
     end
 
     it "prints red when the links are bad." do
@@ -94,9 +95,9 @@ describe LinkChecker do
         )
       end
       $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(:target => @site_path).check_uris
+      $stdout.should_receive(:puts).with(/Link/i).twice
+      $stdout.should_receive(:puts).with(/Response/i).twice
+      LinkChecker.new(:target => @site_path).check_uris.should == 1 # Return value: error
     end
 
     it "prints yellow warnings when the links redirect." do
@@ -107,22 +108,38 @@ describe LinkChecker do
         )
       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
+      $stdout.should_receive(:puts).with(/Warning/i).twice
+      $stdout.should_receive(:puts).with(/Redirected/i).twice
+      LinkChecker.new(:target => @site_path).check_uris.should == 0 # Return value: good
+    end
+
+    it "prints errors when there are warnings with the --warnings_are_errors option." do
+      LinkChecker.stub(:check_uri) do
+        LinkChecker::Redirect.new(
+          :uri_string => 'http://something.com',
+          :final_destination_uri_string => 'http://something-else.com'
+        )
+      end
+      $stdout.should_receive(:puts).with(/Problem/i).once
+      $stdout.should_receive(:puts).with(/Link/i).twice
+      $stdout.should_receive(:puts).with(/Redirected/i).twice
+      LinkChecker.new(
+        :target => @site_path,
+        :options => { :warnings_are_errors => true }
+      ).check_uris.should == 1 # Return value: error
     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'
+          :final_destination_uri_string => '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
+      $stdout.should_receive(:puts).with(/Warning/i).twice
+      $stdout.should_receive(:puts).with(/Redirected/i).twice
+      LinkChecker.new(:target => @site_path).check_uris.should == 0 # Return value: good
     end
 
   end
@@ -130,10 +147,11 @@ describe LinkChecker do
   describe "prints output for invalid links and" do
 
     it "declares them to be bad." do
-      LinkChecker.stub(:external_link_uri_strings).and_return(['hQQp://!!!.com'])
+      LinkChecker.stub(:external_link_uri_strings).and_return(
+        ['hQQp://!!!.com', 'hOOp://???.com'])
       $stdout.should_receive(:puts).with(/Problem/i).once
-      $stdout.should_receive(:puts).with(/Link/i).once
-      $stdout.should_receive(:puts).with(/Response/i).once
+      $stdout.should_receive(:puts).with(/Link/i).twice
+      $stdout.should_receive(:puts).with(/Response/i).twice
       thread = LinkChecker.new(:target => @site_path).start_link_check_thread('<html></html>', 'source.html')
       thread.join
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link-checker
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -558,7 +558,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1966410350842699633
+      hash: -2838258292777551333
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: