ardekantur-shnork 0.2.1

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+   t.spec_files = FileList['spec/*.rb'] - ['spec/site.rb']
+   # t.spec_opts = ['--color']
+end
+
+spec = Gem::Specification.load('shnork.gemspec')
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "run rspec + rcov"
+Spec::Rake::SpecTask.new("spec:rcov") do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov_opts = ['--exclude', "spec/,rcov.rb,rspec.rb,spec*,gems*"]
+  t.rcov = true
+  t.rcov_dir = 'doc/coverage'
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end

data/lib/rspec_shnork_matchers.rb

@@ -0,0 +1,59 @@
+module RspecShnork
+  
+  def shnork thresholds = {404 => 0, 500 => 0}
+    RspecShnork.new(thresholds, '/')
+  end
+  
+  def shnork_at path, thresholds = {404 => 0, 500 => 0}
+    RspecSnork.new(thresholds, path)
+  end
+    
+  class RspecShnork
+    
+    def initialize thresholds, path = nil
+      @path = path || '/'
+      @thresholds = thresholds
+    end
+  
+    def matches?(target)
+      @results = Shnork::Hunt(@path)
+      messages_for(404) <= @thresholds[404] and messages_for(500) <= @thresholds[500]
+    end
+    
+    def failure_message
+      max_messages = 5
+      msg = <<-EOM
+      Shnork found #{messages_to_string(404)} and #{messages_to_string(500)}.
+      One or both of these are over the accepted thresholds (404 -> #{@thresholds[404]}, 500 -> #{@thresholds[500]}).
+      EOM
+      [404, 500].each do |error|
+        i = 0
+        if messages_for(error) > 0 then
+          show_errors = messages_for(error) < max_messages ? messages_for(error) : max_messages
+          msg += "      First #{show_errors} discovered #{error} error#{ show_errors == 1 ? '' : 's'}:\n"
+          while i < max_messages and i < messages_for(error)
+            msg += "      * " + @results.codes[error][i] + "\n"
+            i += 1
+          end
+        end
+      end
+      return msg
+    end
+    
+    def messages_for(error)
+      return 0 unless @results.codes.has_key? error
+      return @results.codes[error].size
+    end
+    
+    def messages_to_string(error)
+      err = (messages_for(error) == 1) ? "error" : "errors"
+      "#{messages_for(error)} #{error} #{err}"
+    end
+    
+    def negative_failure_message
+      "expected shnork not to pass"
+    end
+  
+  end
+  
+end

data/lib/shnork.rb

@@ -0,0 +1,104 @@
+require 'nokogiri'
+require 'rack'
+
+$LOAD_PATH.unshift( File.dirname(__FILE__) )
+require 'rspec_shnork_matchers'
+
+module Shnork
+  
+  def self.Hunt page
+    return Shnork.new().analyze(page)
+  end
+  
+  def self.new
+    return Shnork.new()
+  end
+  
+  class Shnork
+    
+    include Rack::Utils
+    
+    attr_reader :page, :reached
+    attr_accessor :depth
+    
+    def initialize
+      set :env, :production
+      set :run, false
+      @app = Sinatra::application
+      @request = Rack::MockRequest.new(Sinatra.build_application)
+      @reached = []
+      @found   = []
+      
+      @internal_depth = {}
+      @internal_pred  = {}
+      @depth   = :all
+      
+      @results = ShnorkResults.new
+    end
+    
+    def analyze page
+      @found << [page, nil]
+      while @found.size != 0
+        link = @found.shift
+        next if @reached.include? link.first
+        retrieve link
+      end
+      
+      return @results
+    end
+    
+    def record page
+      @reached = @reached | [page]
+    end
+    
+    def less_than_max_depth d
+      return true if @depth == :all 
+      d <= @depth
+    end
+        
+    def retrieve page_from
+      page = page_from.first
+      from = page_from.last
+      @internal_depth[page] = from ? @internal_depth[from] + 1 : 0
+      @internal_pred[page]  = from
+      return unless less_than_max_depth @internal_depth[page]
+        @page = @request.get(page)
+        @page = @request.get(@page.headers["Location"]) if @page.status >= 300 and @page.status < 400
+      @results.add @page.status, page
+      @found = @found | links(page)
+      record page
+    end
+    
+    def links current_page
+      return [] unless @page
+      Nokogiri::HTML(@page.body).xpath('//a').select { |link| link.attributes["href"] =~ /^\// }.map { |link| [link.attributes["href"], current_page] }
+    end
+    
+    private
+    
+    def status
+      puts "DEPTH: #{@internal_depth.inspect}"
+      puts "PREDS: #{@internal_pred.inspect}"
+      puts "FOUND: #{@found.inspect}"
+      puts "REACH: #{@reached.inspect}"
+      puts "----------------------"
+    end
+    
+  end
+  
+  class ShnorkResults
+    
+    attr_reader :codes
+    
+    def initialize
+      @codes = {}
+    end
+    
+    def add return_code, page
+      @codes[return_code] ||= []
+      @codes[return_code] <<  page
+    end
+    
+  end
+  
+end

data/readme.md

@@ -0,0 +1,64 @@
+# shnork
+
+shnork is [dwemthy's][] lil' cousin. he's kinda headstrong but he doesn't take any guff. he explores your website like a dungeon, making sure it's structurally sound, all cavernous.
+
+shnork is link testing for sinatra. lookatitgo!
+
+## features
+
+ * specify the depth you want to allow shnork to descend
+ * provide thresholds: allow _x_ number of `404`s or _y_ number of `500`s
+
+## syntax
+
+    describe "My awesome Sinatra web application" do
+      include RspecShnork
+    
+      it "should be a perfect website" do
+        Sinatra::application.should shnork
+      end
+
+      it "should not be broken beyond four 404 errors and 9 500 errors" do
+        Sinatra::application.should shnork({404 => 4, 500 => 9})
+      end      
+
+      it "should be a perfect from the members section in" do
+        Sinatra::application.should shnork_at '/members'
+      end
+    
+    end
+    
+## the results are in
+
+Actual code results! **Exciting**.
+
+    1)
+    'Shnork RSpec matchers should work' FAILED
+          Shnork found 6 404 errors and 6 500 errors.
+          One or both of these are over the accepted thresholds (404 -> 0, 500 -> 0).
+          First 5 discovered 404 errors:
+          * /broken-link/1
+          * /broken-link/2
+          * /broken-link/3
+          * /broken-link/4
+          * /broken-link/5
+          First 2 discovered 500 errors:
+          * /error/1
+          * /error/2
+          * /error/3
+    ./spec/shnork_rspec_spec.rb:8:
+    
+Wootabega.
+
+## helping out
+
+this code is in its infancy. please feel free to contribute suggestions as to what features you'd like. features have a greater chance of being implemented if you write a spec, or if you fork and write how you think it should work!
+
+here's [where you can file bugs][].
+
+### misc
+
+licensed under the gpl. enjoy.
+
+[dwemthy's]: http://poignantguide.net/dwemthy/
+[where you can file bugs]: http://ardekantur.lighthouseapp.com/projects/20004-shnork/overview

data/spec/shnork_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Shnork" do
+  
+  setup do
+    Sinatra.application = nil
+    
+    page = Proc.new { [
+      "<h1>My Web Page</h1>",
+      "This is my unsightly webpage! It's not even valid markup!",
+      "<a href='http://www.google.com'>Google</a>",
+      "<hr />",
+      '<a href="/login">Login</a>',
+      "<a href='/about'>About this page</a>"
+      ].join }
+    get '/', &page
+    
+    about = Proc.new { "<a href='/second/layer/down'>Second layer down link</a>" }    
+    get '/about', &about
+    
+    second_layer_down = Proc.new { "You made it here!" }
+    get '/second/layer/down', &second_layer_down
+    
+    @shallow_hunt = Shnork.new()
+    @shallow_hunt.depth = 0
+    @shallow_results = @shallow_hunt.analyze('/')
+    
+    @deep_hunt = Shnork.new()
+    @deep_results = @deep_hunt.analyze('/')
+  end
+  
+  teardown do
+    Sinatra.application = nil
+  end
+  
+  it "should record the initial link as reached" do
+    @shallow_hunt.reached.should == ['/']
+  end
+  
+  it "should provide information about the initial link in results" do
+    @shallow_results.codes.size.should == 1
+    @shallow_results.codes.should == { 200 => ['/'] }
+  end
+  
+  it "should find links the second level down" do
+    @deep_results.codes[200].should include('/second/layer/down')
+  end
+  
+  it "should appropriately handle redirects"
+  it "should should only descend to the desired depth"
+  
+end

data/spec/site.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'sinatra'
+
+get '/' do
+  <<-EOM
+  Hello World!
+  <a href="/">Home</a>
+  <a href="/working-link">Working Link</a>
+  <a href="/working-link/1">Working Link</a>
+  <a href="/working-link/2">Working Link</a>
+  <a href="/working-link/3">Working Link</a>
+  <a href="/working-link/4">Working Link</a>
+  <a href="/working-link/5">Working Link</a>
+  <a href="/working-link/6">Working Link</a>
+  EOM
+end
+
+get '/working-link' do
+  <<-EOM
+  This is a working page!
+  EOM
+end
+
+get '/working-link/:number' do
+  <<-EOM
+  This is a working page!
+  Here is another: <a href='/working-link'>Working Link</a>
+  This is a broken link: <a href='/broken-link/#{params[:number]}'>Broken Link #{params[:number]}</a>
+  This link will cause a 500 error: <a href='/error/#{params[:number]}'>500 Error link #{params[:number]}</a>
+  EOM
+end
+
+error do
+  "<h1>500</h1>"
+end
+
+get '/error/:number' do
+    throw :halt, [500, 'error']
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'sinatra'
+require 'spec/interop/test'
+require 'sinatra/test/unit'
+
+require File.dirname(__FILE__) + '/../lib/shnork'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: ardekantur-shnork
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- ardekantur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+description: make sure your sinatra websites are logically sound
+email: greystone@ardekantur.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- readme.md
+- Rakefile
+- lib/shnork.rb
+- lib/rspec_shnork_matchers.rb
+- spec/shnork_spec.rb
+- spec/spec_helper.rb
+- spec/site.rb
+has_rdoc: false
+homepage: http://github.com/ardekantur/shnork
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: make sure your sinatra websites are logically sound
+test_files: 
+- spec/shnork_spec.rb