rack-speling 0.0.1 → 0.0.2

data/Gemfile

@@ -1,3 +1,6 @@
 source :rubygems
 
 gemspec
+
+gem 'gem-release'
+gem 'redgreen'

data/Rakefile

@@ -1,45 +1,9 @@
 #!/usr/bin/env rake
 # vim:ft=ruby:fileencoding=utf-8
 
-# # enable trace to get better error output
-# Rake.application.options.trace = true
-
-# # documentation tasks
-# begin
-#   %w[ rake/rdoctask sdoc ].each { |lib| require lib }
-#   Rake::RDocTask.new do |rdoc|
-#     version = File.exist?('VERSION') ? File.read('VERSION') : ""
-#
-#     rdoc.rdoc_dir = 'doc/rdoc'
-#     rdoc.title = "to_pass #{version}"
-#     rdoc.options << '--fmt=shtml'
-#     rdoc.options << '--all'
-#     rdoc.options << '--charset=utf-8'
-#     rdoc.template = 'direct'
-#     rdoc.rdoc_files.include('README*')
-#     rdoc.rdoc_files.include('LICENSE')
-#     rdoc.rdoc_files.include('TODO')
-#     rdoc.rdoc_files.include('lib/**/*.rb')
-#     rdoc.rdoc_files.include('data/**/*.rb')
-#   end
-# rescue LoadError
-# end
-
 desc "run tests"
 task :test do
-  # optional libraries
-  %w[ redgreen ].each do |lib|
-    begin
-      require lib
-    rescue LoadError
-    end
-  end
-
-  require 'test/unit'
-
-  ( ['test/helper'] + Dir['test/test_*.rb'] ).each do |file|
-    require File.expand_path("../#{file}", __FILE__)
-  end
+  require File.expand_path("../test/all", __FILE__)
 end
 
 task :default => :test

data/lib/rack/speling.rb

@@ -0,0 +1,57 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+module Rack
+  class Speling
+    attr_reader :app, :lookup, :env, :response
+
+    # remember the application as we need to call before or after this
+    # an lookup-object may be supplied for further 404-handling
+    def initialize(app, options = {})
+      @app = app
+      @lookup = options[:lookup] || {}
+    end
+
+    # downcase PATH_INFO and REQUEST_URI
+    # furthermore, try to lookup 404s to react with a redirect
+    def call(env)
+      @env = env
+
+      downcase_path
+
+      @response = app.call(env)
+
+      if response[0] == 404 && path_lookup
+        correct_response
+      else
+        response
+      end
+    end
+
+    private
+
+    def correct_response
+      headers = response[1].merge({
+        'Location' => new_location
+      })
+
+      [302, headers, "Moved: #{headers['Location']}"]
+    end
+
+    def new_location
+      path_lookup.start_with?('http:') ? path_lookup : "http://#{env['HTTP_HOST']}#{path_lookup}"
+    end
+
+    def path_lookup
+      @path_lookup ||= lookup[path]
+    end
+
+    def path
+      env['PATH_INFO']
+    end
+
+    def downcase_path
+      env['PATH_INFO']   = env['PATH_INFO'].downcase
+      env['REQUEST_URI'] = env['REQUEST_URI'].downcase
+    end
+  end
+end

data/lib/rack/speling/sp_dist.rb

@@ -0,0 +1,81 @@
+module Rack
+  module Speling
+    class SpDist
+      def lookup(url)
+        check_speling(url)
+      end
+
+      # taken from apaches mod_speling
+      #
+      # we only want to worry about GET
+      # We've already got a file of some kind or another
+      def check_speling
+        raise NotImplentedError, "TODO: Complete port of apaches mod_speling into #{__FILE__}"
+      end
+
+      # return values of spdist(s,t)
+      SP_IDENTICAL = 0
+      SP_MISCAPITALIZED = 1
+      SP_TRANSPOSITION = 2
+      SP_MISSINGCHAR = 3
+      SP_EXTRACHAR = 4
+      SP_SIMPLETYPO = 5
+      SP_VERYDIFFERENT = 6
+
+      # spdist() is taken from Kernighan & Pike,
+      #  _The_UNIX_Programming_Environment_
+      # and adapted somewhat to correspond better to psychological reality.
+      # (Note the changes to the return values)
+      #
+      # According to Pollock and Zamora, CACM April 1984 (V. 27, No. 4),
+      # page 363, the correct order for this is:
+      # OMISSION = TRANSPOSITION > INSERTION > SUBSTITUTION
+      # thus, it was exactly backwards in the old version. -- PWP
+      #
+      # This routine was taken out of tcsh's spelling correction code
+      # (tcsh-6.07.04) and re-converted to apache data types ("char" type
+      # instead of tcsh's NLS'ed "Char"). Plus it now ignores the case
+      # during comparisons, so is a "approximate strcasecmp()".
+      # NOTE that is still allows only _one_ real "typo",
+      # it does NOT try to correct multiple errors.
+      #
+      # This version is taken from mod_speling.c, httpd-2.2.16 and
+      # adapted to ruby
+      # /Users/matthias/Projects/httpd-2.2.16/modules/mappers/mod_speling.c
+      # FIXME This won't work, yet
+      def spdist(s, t)
+        # exact match (sans case)
+        if s.downcase == t.downcase
+          return SP_MISCAPITALIZED
+        end
+
+        unless s.nil?
+          unless t.nil?
+            # transposition
+            if s[1] && t[1] && s.downcase == t[1].downcase && t.downcase == s[1].downcase && (s + 2).casecmp(t + 2) == 0
+              return SP_TRANSPOSITION
+            end
+
+            # char mismatch
+            if (s + 1).casecmp(t + 1) == 0
+              return SP_SIMPLETYPO
+            end
+          end
+
+          # extra character
+          if (s + 1).casecmp(t) == 0
+            return SP_EXTRACHAR
+          end
+        end
+
+        # missing character
+        if !t.nil? && s.casecmp(t+1) == 0
+          return SP_MISSINGCHAR
+        end
+
+        # distance too large to fix
+        return SP_VERYDIFFERENT
+      end
+    end
+  end
+end

data/lib/{rack-speling → rack/speling}/version.rb

@@ -2,7 +2,7 @@
 
 module Rack # :nodoc:
   module Speling
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
 
     SUMMARY = "Simple Speling corretor in Rack"
 

data/rack-speling.gemspec

@@ -1,5 +1,5 @@
 # vim:ft=ruby:fileencoding=utf-8
-require 'lib/rack-speling/version.rb'
+require 'lib/rack/speling/version.rb'
 
 spec = Gem::Specification.new do |s|
   s.name = 'rack-speling'
@@ -18,6 +18,5 @@ spec = Gem::Specification.new do |s|
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files test`.split("\n")
-  # s.executables  = `git ls-files bin`.split("\\n")
   s.require_path = 'lib'
 end

data/test/all.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path('../test_*.rb', __FILE__)].each do |file|
+  require file
+end

data/test/helper.rb

@@ -1,15 +1,15 @@
 # vim:ft=ruby:fileencoding=utf-8
 
-require 'test/unit/testcase'
-require 'test/unit' unless defined?(Test::Unit)
+require 'redgreen' rescue LoadError
+require 'test/unit'
 
 base_path = ( File.expand_path(File.dirname(__FILE__)+'/..') )
 lib_path  = "#{base_path}/lib"
-if File.exist?(base_path + '/lib/rack-speling')
+if File.exist?(base_path + '/lib/rack/speling')
   $LOAD_PATH << base_path unless $LOAD_PATH.include?(base_path)
 end
 if File.exist?( lib_path )
   $LOAD_PATH << lib_path unless $LOAD_PATH.include?(lib_path)
 end
 
-require 'rack-speling'
+require 'rack/speling'

data/test/test_rack-speling.rb

@@ -1,27 +1,52 @@
 require File.expand_path("../helper", __FILE__)
 
 class SpelingTest < Test::Unit::TestCase
-  def sut
-    speling = Class.new do
-      include Rack::Speling
-    end
-    app = lambda { |arg| return arg }
-
-    speling.new(app)
+  def sut(*args)
+    Rack::Speling.new(*args)
   end
 
   def env
     { 'PATH_INFO' => '/somepath', 'REQUEST_URI' => '/somepath' }
   end
 
+  def status_app(status)
+    lambda { |env|
+      [status, env, '']
+    }
+  end
+
+  def echo_app
+    lambda { |arg| return arg }
+  end
+
   def test_downcasing_path_info
-    result = sut.call( env.merge('PATH_INFO' => '/SOMEPATH') )
+    result = sut(echo_app).call( env.merge('PATH_INFO' => '/SOMEPATH') )
 
     assert_equal env, result
   end
 
   def test_downcasing_request_uri
-    result = sut.call( env.merge('REQUEST_URI' => '/SOMEPATH') )
+    result = sut(echo_app).call( env.merge('REQUEST_URI' => '/SOMEPATH') )
     assert_equal env, result
   end
+
+  def test_does_not_touch_200s
+    result = sut(status_app(200)).call(env)
+    assert_equal 200, result[0], result.inspect
+  end
+
+  def test_does_accept_an_optional_lookup_object
+    assert_nothing_raised do
+      sut(echo_app)
+      sut(echo_app, :lookup => {})
+    end
+  end
+
+  def test_redirect_on_successful_lookup
+    result = sut(status_app(404), :lookup => {
+      '/somepath' => 'http://example.com/newpath'
+    }).call(env)
+    assert_equal 302, result[0]
+    assert_equal 'http://example.com/newpath', result[1]['Location']
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-speling
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Matthias Viehweger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 +02:00
+date: 2010-09-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -33,9 +33,11 @@ files:
 - Gemfile
 - README.txt
 - Rakefile
-- lib/rack-speling.rb
-- lib/rack-speling/version.rb
+- lib/rack/speling.rb
+- lib/rack/speling/sp_dist.rb
+- lib/rack/speling/version.rb
 - rack-speling.gemspec
+- test/all.rb
 - test/helper.rb
 - test/test_rack-speling.rb
 has_rdoc: true
@@ -75,5 +77,6 @@ signing_key:
 specification_version: 3
 summary: Simple Speling corretor in Rack
 test_files: 
+- test/all.rb
 - test/helper.rb
 - test/test_rack-speling.rb

data/lib/rack-speling.rb

@@ -1,19 +0,0 @@
-# vim:ft=ruby:fileencoding=utf-8
-
-module Rack
-  module Speling
-    # remember the application as we need to call it later on
-    # (this is just a before-filter)
-    def initialize(app)
-      @app = app
-    end
-
-    # downcase PATH_INFO and REQUEST_URI
-    def call(env)
-      env['PATH_INFO']   = env['PATH_INFO'].downcase
-      env['REQUEST_URI'] = env['REQUEST_URI'].downcase
-
-      @app.call(env)
-    end
-  end
-end