Class: Rack::Mount::RouteSet
- Inherits:
-
Object
- Object
- Rack::Mount::RouteSet
- Extended by:
- Mixover
- Includes:
- Generation::RouteSet, Rack::Mount::Recognition::CodeGeneration, Rack::Mount::Recognition::RouteSet
- Defined in:
- lib/rack/mount/route_set.rb
Constant Summary
Constants included from Rack::Mount::Recognition::RouteSet
Rack::Mount::Recognition::RouteSet::PASS, Rack::Mount::Recognition::RouteSet::PATH_INFO, Rack::Mount::Recognition::RouteSet::X_CASCADE
Instance Attribute Summary
Attributes included from Rack::Mount::Recognition::RouteSet
Class Method Summary collapse
-
.new_without_optimizations(*args, &block) ⇒ Object
Initialize a new RouteSet without optimizations.
Instance Method Summary collapse
-
#add_route(app, conditions = {}, defaults = {}, name = nil) ⇒ Object
Builder method to add a route to the set.
-
#call(env) ⇒ Object
See
Recognition::RouteSet#call
. -
#freeze ⇒ Object
Finalizes the set and builds optimized data structures.
-
#generate(*args) ⇒ Object
See
Generation::RouteSet#generate
. -
#initialize(options = {}, &block) ⇒ RouteSet
constructor
Basic RouteSet initializer.
-
#length ⇒ Object
Number of routes in the set.
-
#marshal_dump ⇒ Object
:nodoc:.
-
#marshal_load(hash) ⇒ Object
:nodoc:.
-
#rehash ⇒ Object
:nodoc:.
-
#url(*args) ⇒ Object
See
Generation::RouteSet#url
.
Methods included from Mixover
extended, extended_modules, include, new, new_with_module, new_without_module
Methods included from Rack::Mount::Recognition::CodeGeneration
Methods included from Rack::Mount::Recognition::RouteSet
Constructor Details
#initialize(options = {}, &block) ⇒ RouteSet
Basic RouteSet initializer.
If a block is given, the set is yielded and finalized.
See other aspects for other valid options:
-
Generation::RouteSet.new
-
Recognition::RouteSet.new
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/rack/mount/route_set.rb', line 25 def initialize( = {}, &block) @request_class = .delete(:request_class) || Rack::Request @valid_conditions = begin conditions = @request_class.instance_methods(false) conditions.map! { |m| m.to_sym } conditions end @routes = [] expire! if block_given? yield self rehash end end |
Class Method Details
.new_without_optimizations(*args, &block) ⇒ Object
Initialize a new RouteSet without optimizations
14 15 16 |
# File 'lib/rack/mount/route_set.rb', line 14 def self.new_without_optimizations(*args, &block) new_without_module(Recognition::CodeGeneration, *args, &block) end |
Instance Method Details
#add_route(app, conditions = {}, defaults = {}, name = nil) ⇒ Object
Builder method to add a route to the set
app
-
A valid Rack app to call if the conditions are met.
conditions
-
A hash of conditions to match against. Conditions may be expressed as strings or regexps to match against.
defaults
-
A hash of values that always gets merged in
name
-
Symbol identifier for the route used with named route generations
51 52 53 54 55 56 57 |
# File 'lib/rack/mount/route_set.rb', line 51 def add_route(app, conditions = {}, defaults = {}, name = nil) validate_conditions!(conditions) route = Route.new(app, conditions, defaults, name) @routes << route expire! route end |
#call(env) ⇒ Object
See Recognition::RouteSet#call
60 61 62 |
# File 'lib/rack/mount/route_set.rb', line 60 def call(env) raise NotImplementedError end |
#freeze ⇒ Object
Finalizes the set and builds optimized data structures. You must freeze the set before you can use call
and url
. So remember to call freeze after you are done adding routes.
85 86 87 88 89 90 91 92 93 94 |
# File 'lib/rack/mount/route_set.rb', line 85 def freeze unless frozen? rehash flush! @routes.each { |route| route.freeze } @routes.freeze end super end |
#generate(*args) ⇒ Object
See Generation::RouteSet#generate
70 71 72 |
# File 'lib/rack/mount/route_set.rb', line 70 def generate(*args) raise NotImplementedError end |
#length ⇒ Object
Number of routes in the set
75 76 77 |
# File 'lib/rack/mount/route_set.rb', line 75 def length @routes.length end |
#marshal_dump ⇒ Object
:nodoc:
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/rack/mount/route_set.rb', line 96 def marshal_dump #:nodoc: hash = {} instance_variables_to_serialize.each do |ivar| hash[ivar] = instance_variable_get(ivar) end if graph = hash[:@recognition_graph] hash[:@recognition_graph] = graph.dup end included_modules = (class << self; included_modules; end) included_modules.reject! { |mod| mod == Kernel } hash[:included_modules] = included_modules hash end |
#marshal_load(hash) ⇒ Object
:nodoc:
114 115 116 117 118 119 120 |
# File 'lib/rack/mount/route_set.rb', line 114 def marshal_load(hash) #:nodoc: hash.delete(:included_modules).reverse.each { |mod| extend(mod) } hash.each do |ivar, value| instance_variable_set(ivar, value) end end |
#rehash ⇒ Object
:nodoc:
79 80 |
# File 'lib/rack/mount/route_set.rb', line 79 def rehash #:nodoc: end |
#url(*args) ⇒ Object
See Generation::RouteSet#url
65 66 67 |
# File 'lib/rack/mount/route_set.rb', line 65 def url(*args) raise NotImplementedError end |