magellan 0.1.0 → 0.1.1

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 1
-:patch: 0
+:patch: 1
 :major: 0

data/lib/magellan/broken_link_tracker.rb

@@ -13,7 +13,7 @@ module Magellan
       failed = result.status_code.starts_with?("5") || result.status_code.starts_with?("4")
       @broken_links << result if failed
       changed
-      notify_observers(Time.now, !failed)
+      notify_observers(Time.now, !failed, broken_link_message(result))
       result.absolute_linked_resources.each do |linked_resource|
         @first_linked_from[linked_resource] = result.url if !@first_linked_from.has_key?(linked_resource)
       end
@@ -24,7 +24,11 @@ module Magellan
     end
 
     def failure_message
-      @broken_links.map{|broken_link| "#{broken_link.url} first linked from: #{@first_linked_from[broken_link.url]} returned: #{broken_link.status_code}"}.join("\n")
+      @broken_links.map{|broken_link| broken_link_message(broken_link)}.join("\n")
+    end
+    
+    def broken_link_message(broken_link)
+      "#{broken_link.url} first linked from: #{@first_linked_from[broken_link.url]} returned: #{broken_link.status_code}"
     end
   end
 end

data/lib/magellan/expected_links_tracker.rb

@@ -14,8 +14,9 @@ module Magellan
         patterns_that_apply(result).each do |pattern,expectation|
           passed = result.linked_resources.include?(expectation)
           changed
-          notify_observers(Time.now, passed)
-          @errors << "#{result.url} did not contain a link to #{expectation}" unless passed
+          message = "#{result.url} did not contain a link to #{expectation}"
+          notify_observers(Time.now, passed, message)
+          @errors << message unless passed
         end
       end
     end
@@ -43,7 +44,7 @@ module Magellan
     end
 
     def unmet_expecations_messages
-      message = "\n\n"
+      message = ""
       unmet_expecations.each {|pattern,unmet_expecation| message << "#{pattern} was never evaluted during the crawl\n"}
       message
     end

data/lib/magellan/explorer.rb

@@ -34,7 +34,7 @@ module Magellan
       rescue WWW::Mechanize::ResponseCodeError => the_error
         Explorer.create_result(url, url, the_error.response_code, [],UNKNOWN_CONTENT)
       rescue Timeout::Error
-        Explorer.create_result(url, url, "505", [],UNKNOWN_CONTENT)
+        Explorer.create_result(url, url, "504", [],UNKNOWN_CONTENT)
       end
     end
 

data/lib/magellan/logger.rb

@@ -1,8 +1,13 @@
 module Magellan
   class Logger
-    def update(time,result)
-      $stdout.putc(result ? '.' : 'F')
+    def initialize(file_name=nil)
+      @file_name = file_name
+    end
+    
+    def update(time,passed,message)
+      $stdout.putc(passed ? '.' : 'F')
       $stdout.flush
+      File.open(@file_name, 'a') {|f| f.write(message + "\n") } if @file_name && !passed
     end
   end
 end

data/lib/magellan/rake/base_magellan_task.rb

@@ -6,7 +6,10 @@ module Magellan
       attr_accessor :origin_url
       attr_accessor :explore_depth
       attr_accessor :ignored_urls
-
+      attr_accessor :links_to_explore
+      attr_accessor :success_message
+      attr_accessor :failure_log
+      
       def initialize(name)
         @ignored_urls = []
         @name=name
@@ -21,11 +24,11 @@ module Magellan
                       :ignored_urls =>ignored_urls, :links_to_explore => links_to_explore, :trace => ENV['TRACE']}
           cartographer = Magellan::Cartographer.new(settings)
           observer = create_observer
-          observer.add_observer(Magellan::Logger.new)
+          observer.add_observer(Magellan::Logger.new(failure_log))
           cartographer.add_observer(observer)
           cartographer.crawl
           if observer.failed?
-            STDERR.puts observer.failure_message
+            STDERR.puts "\n" + observer.failure_message
             exit 1
           else
             $stdout.puts "\n" + success_message

data/lib/magellan/rake/broken_link_task.rb

@@ -8,6 +8,8 @@ module Magellan
     
     class BrokenLinkTask < BaseMagellanTask
       def initialize(name="magellan:explore")
+        @links_to_explore = [["a","href"],["script","src"],["img","src"]]
+        @success_message = "No broken links were found!"
         super(name)
       end
       
@@ -15,18 +17,9 @@ module Magellan
         Magellan::BrokenLinkTracker.new
       end
       
-      def links_to_explore
-        [["a","href"],["script","src"],["img","src"]]
-      end
-      
       def description
         "explore #{@origin_url} for broken links"
-      end
-      
-      def success_message
-        "No broken links were found!"
-      end
-      
+      end      
     end
     
   end

data/lib/magellan/rake/expected_links_task.rb

@@ -10,25 +10,18 @@ module Magellan
       attr_accessor :patterns_and_expected_links
 
       def initialize(name="magellan:check_links")
+        @success_message = "All expected links found!"
+        @links_to_explore = [["a","href"]]
         super(name)
       end
 
       def description
         "Explore #{@origin_url} and find check if all given patterns are matched"
       end
-      
-      def links_to_explore
-        [["a","href"]]
-      end
 
       def create_observer
         Magellan::ExpectedLinksTracker.new(@patterns_and_expected_links)
       end
-
-      def success_message
-        "All expected links found!"
-      end
-
     end
 
   end

data/spec/broken_link_task_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper'
 require 'rake'
+require 'fileutils'
 
 describe "Magellan BrokenLinkTask" do
 
@@ -22,7 +23,7 @@ describe "Magellan BrokenLinkTask" do
     Magellan::Rake::BrokenLinkTask.new
     tasks.include?("magellan:explore").should be_true
   end
-  
+
   it "should explore when task is invoked" do
     Magellan::Rake::BrokenLinkTask.new("invoke_task") do |t|
       t.explore_depth = 1
@@ -42,17 +43,36 @@ describe "Magellan BrokenLinkTask" do
     Magellan::Explorer.any_instance.stubs(:explore_a).once.with("http://canrailsscale.com").returns(create_result("http://canrailsscale.com","500"))
     lambda {@rake.invoke_task("exception_task")}.should raise_error
   end
-  
+
+  it "should create a log file if one was specified" do
+    begin
+      log = File.dirname(__FILE__) + "/log.txt"
+      FileUtils.rm(log,:force => true)
+      File.exists?(log).should be_false
+      Magellan::Rake::BrokenLinkTask.new("failure_log") do |t|
+        t.explore_depth = 1
+        t.failure_log = log
+        t.origin_url = "http://canrailsscale.com"
+      end
+      $stderr.expects(:puts)
+      Magellan::Explorer.any_instance.stubs(:explore_a).once.with("http://canrailsscale.com").returns(create_result("http://canrailsscale.com","504"))
+      lambda {@rake.invoke_task("failure_log")}.should raise_error
+      File.exists?(log).should be_true
+    ensure
+      FileUtils.rm(log,:force => true)
+    end
+  end
+
   it "should attach logger" do
-     Magellan::Rake::BrokenLinkTask.new("logger_test") do |t|
-       t.explore_depth = 1
-       t.origin_url = "http://canrailsscale.com"
-     end
-     $stderr.stubs(:puts)
-     Magellan::Logger.any_instance.expects(:update)
-     Magellan::Explorer.any_instance.stubs(:explore_a).once.with("http://canrailsscale.com").returns(create_result("http://canrailsscale.com","500"))
-     lambda {@rake.invoke_task("logger_test")}.should raise_error
-   end
+    Magellan::Rake::BrokenLinkTask.new("logger_test") do |t|
+      t.explore_depth = 1
+      t.origin_url = "http://canrailsscale.com"
+    end
+    $stderr.stubs(:puts)
+    Magellan::Logger.any_instance.expects(:update)
+    Magellan::Explorer.any_instance.stubs(:explore_a).once.with("http://canrailsscale.com").returns(create_result("http://canrailsscale.com","500"))
+    lambda {@rake.invoke_task("logger_test")}.should raise_error
+  end
 
   def create_result(url,status_code)
     Magellan::Explorer.create_result(url,url,status_code, [],"foo")
@@ -61,4 +81,4 @@ describe "Magellan BrokenLinkTask" do
   def tasks
     @rake.tasks.collect{|task| task.name }
   end
-end
+end

data/spec/explorer_spec.rb

@@ -11,7 +11,7 @@ describe Magellan::Explorer do
   it "should foo" do
     WWW::Mechanize.any_instance.expects(:get).raises(Timeout::Error)
     result = Magellan::Explorer.new(['http://canrailsscale.com/'],links_to_explore).explore
-    result.first.status_code.should eql('505')
+    result.first.status_code.should eql('504')
     result.first.url.should eql('http://canrailsscale.com/')
   end
 

data/spec/logger_spec.rb

@@ -5,11 +5,36 @@ describe Magellan::Logger do
   it "should put a . for a pass" do
     logger = Magellan::Logger.new
     $stdout.expects(:putc).with('.')
-    logger.update(Time.now,true)
+    logger.update(Time.now,true,'')
   end
   it "should put a F for a fail" do
     logger = Magellan::Logger.new
     $stdout.expects(:putc).with('F')
-    logger.update(Time.now,false)
+    logger.update(Time.now,false,'')
   end
-end
+  it "should create a log file if one is passed in and the updated failed" do
+    begin
+      log = File.dirname(__FILE__) + "/log.txt"
+      FileUtils.rm(log,:force => true)
+      File.exists?(log).should be_false
+      $stdout.stubs(:putc)
+      logger =Magellan::Logger.new(log)
+      logger.update(Time.now,false,'foozor')
+      File.exists?(log).should be_true
+      File.open(log).readlines.should include("foozor\n")
+    ensure
+      FileUtils.rm(log,:force => true)
+    end
+  end
+
+  it "should not a log file if one is passed in and the updated passed" do
+    log = File.dirname(__FILE__) + "/log2.txt"
+    FileUtils.rm(log,:force => true)
+    File.exists?(log).should be_false
+    $stdout.stubs(:putc)
+    logger =Magellan::Logger.new(log)
+    logger.update(Time.now,true,'foozor')
+    File.exists?(log).should be_false
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: magellan
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nolan Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-06 00:00:00 -07:00
+date: 2009-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency