Object
Raised when there are duplicate param names specified in a Path
Raised an invalid request value is used
Raised when a url is not able to be generated for the given parameters
Raised when there are left over options
Raised when a Route is not able to be generated due to a missing parameter.
Raised when there are extra parameters passed in to url
Creates a new HttpRouter. Can be called with either HttpRouter.new(proc{|env| ... }, { .. options .. }) or with the first argument omitted. If there is a proc first, then it’s used as the default app in the case of a non-match. Supported options are
:default_app – Default application used if there is a non-match on call. Defaults to 404 generator.
:ignore_trailing_slash – Ignore a trailing / when attempting to match. Defaults to true.
:redirect_trailing_slash – On trailing /, redirect to the same path without the /. Defaults to false.
# File lib/http_router.rb, line 43 def initialize(*args, &blk) default_app, options = args.first.is_a?(Hash) ? [nil, args.first] : [args.first, args[1]] @options = options @default_app = default_app || options && options[:default_app] || proc{|env| ::Rack::Response.new("Not Found", 404, {'X-Cascade' => 'pass'}).finish } @ignore_trailing_slash = options && options.key?(:ignore_trailing_slash) ? options[:ignore_trailing_slash] : true @redirect_trailing_slash = options && options.key?(:redirect_trailing_slash) ? options[:redirect_trailing_slash] : false @route_class = Route reset! instance_eval(&blk) if blk end
Adds a path to be recognized.
To assign a part of the path to a specific variable, use :variable_name within the route. For example, add('/path/:id') would match /path/test, with the variable :id having the value "test".
You can receive mulitple parts into a single variable by using the glob syntax. For example, add('/path/*id') would match /path/123/456/789, with the variable :id having the value ["123", "456", "789"].
As well, paths can end with two optional parts, * and /?. If it ends with a *, it will match partially, returning the part of the path unmatched in the PATH_INFO value of the env. The part matched to will be returned in the SCRIPT_NAME. If it ends with /?, then a trailing / on the path will be optionally matched for that specific route. As trailing /‘s are ignored by default, you probably don’t actually want to use this option that frequently.
Routes can also contain optional parts. There are surrounded with ( )‘s. If you need to match on a bracket in the route itself, you can escape the parentheses with a backslash.
As well, options can be passed in that modify the route in further ways. See HttpRouter::Route#with_options for details. Typically, you want to add further options to the route by calling additional methods on it. See HttpRouter::Route for further details.
Returns the route object.
# File lib/http_router.rb, line 69 def add(*args, &app) uncompile opts = args.last.is_a?(Hash) ? args.pop : nil path = args.first route = route_class.new add_route route route.path = path if path route.process_opts(opts) if opts route.to(app) if app route end
# File lib/http_router.rb, line 81 def add_route(route) @routes << route @named_routes[route.name] << route if route.name route.router = self end
Rack compatible call. If matching route is found, and dest value responds to call, processing will pass to the matched route. Otherwise, the default application will be called. The router will be available in the env under the key router. And parameters matched will be available under the key router.params.
# File lib/http_router.rb, line 140 def call(env, &callback) compile call(env, &callback) end
Creates a deep-copy of the router.
# File lib/http_router.rb, line 213 def clone(klass = self.class) cloned_router = klass.new(@options) @routes.each do |route| new_route = route.create_clone(cloned_router) cloned_router.add_route(new_route) end cloned_router end
Assigns the default application.
# File lib/http_router.rb, line 155 def default(app) @default_app = app end
Extends the route class with custom features.
Example:
router = HttpRouter.new { extend_route { attr_accessor :controller } } router.add('/foo', :controller => :foo).to{|env| [200, {}, ['foo!']]} matches, other_methods = router.recognize(Rack::MockRequest.env_for('/foo')) matches.first.route.controller # ==> :foo
# File lib/http_router.rb, line 95 def extend_route(&blk) @route_class = Class.new(Route) if @route_class == Route @route_class.class_eval(&blk) @extended_route_class = nil end
Adds a path that only responds to the request method GET.
Returns the route object.
# File lib/http_router.rb, line 121 def get(path, opts = {}, &app); add_with_request_method(path, [:get, :head], opts, &app); end
Ignore trailing slash feature enabled? See initialize for details.
# File lib/http_router.rb, line 203 def ignore_trailing_slash? @ignore_trailing_slash end
# File lib/http_router.rb, line 242 def inspect head = to_s "#{to_s}\n#{'=' * head.size}\n#{@root.inspect}" end
# File lib/http_router.rb, line 232 def no_response(request, env) request.acceptable_methods.empty? ? @default_app.call(env) : [405, {'Allow' => request.acceptable_methods.sort.join(", ")}, []] end
This method defines what sort of responses are considered “passes”, and thus, route processing will continue. Override it to implement custom passing.
# File lib/http_router.rb, line 198 def pass_on_response(response) response[1]['X-Cascade'] == 'pass' end
# File lib/http_router.rb, line 185 def path(route, *args) compile path(route, *args) end
This method is invoked when a Path object gets called with an env. Override it to implement custom path processing.
# File lib/http_router.rb, line 192 def process_destination_path(path, env) path.route.dest.call(env) end
# File lib/http_router.rb, line 281 def raw_call(env, &blk) rack_request = ::Rack::Request.new(env) request = Request.new(rack_request.path_info, rack_request) if blk @root.call(request, &blk) request else @root.call(request) or no_response(request, env) end end
# File lib/http_router.rb, line 273 def raw_path(route, *args) case route when Symbol then @named_routes.key?(route) && @named_routes[route].each{|r| path = r.path(*args); return path if path} when Route then return route.path(*args) end raise(InvalidRouteException.new "No route (path) could be generated for #{route.inspect}") end
# File lib/http_router.rb, line 257 def raw_url(route, *args) case route when Symbol then @named_routes.key?(route) && @named_routes[route].each{|r| url = r.url(*args); return url if url} when Route then return route.url(*args) end raise(InvalidRouteException.new "No route (url) could be generated for #{route.inspect}") end
# File lib/http_router.rb, line 265 def raw_url_ns(route, *args) case route when Symbol then @named_routes.key?(route) && @named_routes[route].each{|r| url = r.url_ns(*args); return url if url} when Route then return route.url_ns(*args) end raise(InvalidRouteException.new "No route (url_ns) could be generated for #{route.inspect}") end
Performs recoginition without actually calling the application and returns an array of all matching routes or nil if no match was found.
# File lib/http_router.rb, line 125 def recognize(env, &callback) if callback request = call(env, &callback) [request.called?, request.acceptable_methods] else matches = [] callback ||= Proc.new {|match| matches << match} request = call(env, &callback) [matches.empty? ? nil : matches, request.acceptable_methods] end end
Redirect trailing slash feature enabled? See initialize for details.
# File lib/http_router.rb, line 208 def redirect_trailing_slash? @redirect_trailing_slash end
Resets the router to a clean state.
# File lib/http_router.rb, line 147 def reset! uncompile @routes, @named_routes, @root = [], Hash.new{|h,k| h[k] = []}, Node::Root.new(self) @default_app = Proc.new{ |env| ::Rack::Response.new("Your request couldn't be found", 404).finish } @default_host, @default_port, @default_scheme = 'localhost', 80, 'http' end
# File lib/http_router.rb, line 222 def rewrite_partial_path_info(env, request) env['PATH_INFO'] = "/#{request.path.join('/')}" env['SCRIPT_NAME'] += request.rack_request.path_info[0, request.rack_request.path_info.size - env['PATH_INFO'].size] end
# File lib/http_router.rb, line 227 def rewrite_path_info(env, request) env['SCRIPT_NAME'] += request.rack_request.path_info env['PATH_INFO'] = '' end
# File lib/http_router.rb, line 101 def route_class @extended_route_class ||= begin @route_class.send(:include, RouteHelper) @route_class.send(:include, GenerationHelper) @route_class end end
# File lib/http_router.rb, line 237 def to_s compile "#<HttpRouter:0x#{object_id.to_s(16)} number of routes (#{routes.size}) ignore_trailing_slash? (#{ignore_trailing_slash?}) redirect_trailing_slash? (#{redirect_trailing_slash?})>" end
# File lib/http_router.rb, line 247 def uncompile return unless @compiled instance_eval "undef :path; alias :path :compiling_path undef :url; alias :url :compiling_url undef :url_ns; alias :url_ns :compiling_url_ns undef :call; alias :call :compiling_call", __FILE__, __LINE__ @root.uncompile @compiled = false end
Generate a URL for a specified route. This will accept a list of variable values plus any other variable names named as a hash. This first value must be either the Route object or the name of the route.
Example:
router = HttpRouter.new router.add('/:foo.:format', :name => :test).to{|env| [200, {}, []]} router.path(:test, 123, 'html') # ==> "/123.html" router.path(:test, 123, :format => 'html') # ==> "/123.html" router.path(:test, :foo => 123, :format => 'html') # ==> "/123.html" router.path(:test, :foo => 123, :format => 'html', :fun => 'inthesun') # ==> "/123.html?fun=inthesun"
# File lib/http_router.rb, line 173 def url(route, *args) compile url(route, *args) end
# File lib/http_router.rb, line 179 def url_ns(route, *args) compile url_ns(route, *args) end
Generated with the Darkfish Rdoc Generator 2.