Class: HttpRouter

Inherits:
Object
  • Object
show all
Defined in:
lib/http_router/version.rb,
lib/http_router.rb,
lib/http_router/node.rb,
lib/http_router/rack.rb,
lib/http_router/path.rb,
lib/http_router/route.rb,
lib/http_router/request.rb,
lib/http_router/response.rb,
lib/http_router/node/root.rb,
lib/http_router/node/glob.rb,
lib/http_router/node/regex.rb,
lib/http_router/regex_route.rb,
lib/http_router/node/lookup.rb,
lib/http_router/rack/url_map.rb,
lib/http_router/node/request.rb,
lib/http_router/node/variable.rb,
lib/http_router/node/arbitrary.rb,
lib/http_router/node/free_regex.rb,
lib/http_router/node/glob_regex.rb,
lib/http_router/node/destination.rb,
lib/http_router/node/spanning_regex.rb

Overview

:nodoc

Defined Under Namespace

Modules: Rack Classes: Node, Path, RegexRoute, Request, Response, Route

Constant Summary

InvalidRouteException =

Raised when a url is not able to be generated for the given parameters

Class.new(RuntimeError)
MissingParameterException =

Raised when a Route is not able to be generated due to a missing parameter.

Class.new(RuntimeError)
VERSION = 
'0.8.11'

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (HttpRouter) initialize(*args, &blk)

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.

  • :known_methods -- Array of http methods tested for 405s.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/http_router.rb', line 32

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
  @known_methods           = Set.new(options && options[:known_methods] || [])
  @counter                 = 0
  reset!
  instance_eval(&blk) if blk
end

Instance Attribute Details

- (Object) default_app

Returns the value of attribute default_app



17
18
19
 
# File 'lib/http_router.rb', line 17

def default_app
  @default_app
end

- (Object) known_methods (readonly)

Returns the value of attribute known_methods



16
17
18
 
# File 'lib/http_router.rb', line 16

def known_methods
  @known_methods
end

- (Object) named_routes (readonly)

Returns the value of attribute named_routes



16
17
18
 
# File 'lib/http_router.rb', line 16

def named_routes
  @named_routes
end

- (Object) nodes (readonly)

Returns the value of attribute nodes



16
17
18
 
# File 'lib/http_router.rb', line 16

def nodes
  @nodes
end

- (Object) root (readonly)

Returns the value of attribute root



16
17
18
 
# File 'lib/http_router.rb', line 16

def root
  @root
end

- (Object) routes (readonly)

Returns the value of attribute routes



16
17
18
 
# File 'lib/http_router.rb', line 16

def routes
  @routes
end

- (Object) url_mount

Returns the value of attribute url_mount



17
18
19
 
# File 'lib/http_router.rb', line 17

def url_mount
  @url_mount
end

Instance Method Details

- (Object) add(path, opts = {}, &app)

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.

The second argument, options, is an optional hash that can 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.



59
60
61
62
63
 
# File 'lib/http_router.rb', line 59

def add(path, opts = {}, &app)
  route = add_route((Regexp === path ? RegexRoute : Route).new(self, path, opts))
  route.to(app) if app
  route
end

- (Object) add_route(route) 



65
66
67
68
 
# File 'lib/http_router.rb', line 65

def add_route(route)
  @routes << route
  route
end

- (Object) call(env, perform_call = true)

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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/http_router.rb', line 107

def call(env, perform_call = true)
  rack_request = ::Rack::Request.new(env)
  request = Request.new(rack_request.path_info, rack_request, perform_call)
  response = catch(:success) { @root[request] }
  if response
    response
  elsif response.nil?
    no_response(env, perform_call)
  elsif perform_call
    @default_app.call(env)
  else
    nil
  end
end

- (Object) clone(klass = self.class)

Creates a deep-copy of the router.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/http_router.rb', line 184

def clone(klass = self.class)
  cloned_router = klass.new(@options)
  @routes.each do |route|
    new_route = route.clone(cloned_router)
    cloned_router.add_route(new_route)
    new_route.name(route.named) if route.named
    begin
      new_route.to route.dest.clone
    rescue
      new_route.to route.dest
    end
  end
  cloned_router
end

- (Object) default(app)

Assigns the default application.



129
130
131
 
# File 'lib/http_router.rb', line 129

def default(app)
  @default_app = app
end

- (Object) delete(path, opts = {}, &app)

Adds a path that only responds to the request method DELETE.

Returns the route object.



88
 
# File 'lib/http_router.rb', line 88

def delete(path, opts = {}, &app); add_with_request_method(path, :delete, opts, &app); end

- (Object) get(path, opts = {}, &app)

Adds a path that only responds to the request method GET.

Returns the route object.



73
 
# File 'lib/http_router.rb', line 73

def get(path, opts = {}, &app); add_with_request_method(path, :get, opts, &app); end

- (Object) head(path, opts = {}, &app)

Adds a path that only responds to the request method HEAD.

Returns the route object.



83
 
# File 'lib/http_router.rb', line 83

def head(path, opts = {}, &app); add_with_request_method(path, :head, opts, &app); end

- (Boolean) ignore_trailing_slash?

Ignore trailing slash feature enabled? See #initialize for details.

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/http_router.rb', line 164

def ignore_trailing_slash?
  @ignore_trailing_slash
end

- (Object) next_counter 



199
200
201
 
# File 'lib/http_router.rb', line 199

def next_counter
  @counter += 1
end

- (Object) options(path, opts = {}, &app)

Adds a path that only responds to the request method OPTIONS.

Returns the route object.



98
 
# File 'lib/http_router.rb', line 98

def options(path, opts = {}, &app); add_with_request_method(path, :options, opts, &app); end

- (Object) pass_on_response(response) 



159
160
161
 
# File 'lib/http_router.rb', line 159

def pass_on_response(response)
  response[1]['X-Cascade'] == 'pass'
end

- (Object) post(path, opts = {}, &app)

Adds a path that only responds to the request method POST.

Returns the route object.



78
 
# File 'lib/http_router.rb', line 78

def post(path, opts = {}, &app); add_with_request_method(path, :post, opts, &app); end

- (Object) process_destination_path(path, env) 



155
156
157
 
# File 'lib/http_router.rb', line 155

def process_destination_path(path, env)
  path.route.dest.call(env)
end

- (Object) put(path, opts = {}, &app)

Adds a path that only responds to the request method PUT.

Returns the route object.



93
 
# File 'lib/http_router.rb', line 93

def put(path, opts = {}, &app); add_with_request_method(path, :put, opts, &app); end

- (Object) recognize(env) 



100
101
102
 
# File 'lib/http_router.rb', line 100

def recognize(env)
  call(env, false)
end

- (Boolean) redirect_trailing_slash?

Redirect trailing slash feature enabled? See #initialize for details.

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/http_router.rb', line 169

def redirect_trailing_slash?
  @redirect_trailing_slash
end

- (Object) reset!

Resets the router to a clean state.



123
124
125
126
 
# File 'lib/http_router.rb', line 123

def reset!
  @routes, @named_routes, @root = [], {}, Node::Root.new(self)
  @default_app = Proc.new{ |env| ::Rack::Response.new("Your request couldn't be found", 404).finish }
end

- (Object) rewrite_partial_path_info(env, request) 



173
174
175
176
 
# File 'lib/http_router.rb', line 173

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

- (Object) rewrite_path_info(env, request) 



178
179
180
181
 
# File 'lib/http_router.rb', line 178

def rewrite_path_info(env, request)
  env['SCRIPT_NAME'] += request.rack_request.path_info
  env['PATH_INFO'] = ''    
end

- (Object) url(route, *args)

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.url(:test, 123, 'html')
# ==> "/123.html"
router.url(:test, 123, :format => 'html')
# ==> "/123.html"
router.url(:test, :foo => 123, :format => 'html')
# ==> "/123.html"
router.url(:test, :foo => 123, :format => 'html', :fun => 'inthesun')
# ==> "/123.html?fun=inthesun"


147
148
149
150
151
152
153
 
# File 'lib/http_router.rb', line 147

def url(route, *args)
  case route
  when Symbol then @named_routes.key?(route) ? @named_routes[route].url(*args) : raise(InvalidRouteException)
  when Route  then route.url(*args)
  else raise InvalidRouteException
  end
end