Class: ActionDispatch::Journey::Route
- Defined in:
- actionpack/lib/action_dispatch/journey/route.rb
Defined Under Namespace
Modules: VerbMatchers
Instance Attribute Summary collapse
-
#app ⇒ Object
readonly
Returns the value of attribute app.
-
#constraints ⇒ Object
(also: #conditions)
readonly
Returns the value of attribute constraints.
-
#defaults ⇒ Object
readonly
Returns the value of attribute defaults.
-
#internal ⇒ Object
readonly
Returns the value of attribute internal.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#path ⇒ Object
readonly
Returns the value of attribute path.
-
#precedence ⇒ Object
readonly
Returns the value of attribute precedence.
-
#scope_options ⇒ Object
readonly
Returns the value of attribute scope_options.
Class Method Summary collapse
Instance Method Summary collapse
- #ast ⇒ Object
- #dispatcher? ⇒ Boolean
- #eager_load! ⇒ Object
- #format(path_options) ⇒ Object
- #glob? ⇒ Boolean
-
#initialize(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false) ⇒ Route
constructor
path
is a path constraint. - #ip ⇒ Object
- #matches?(request) ⇒ Boolean
- #parts ⇒ Object (also: #segment_keys)
- #required_default?(key) ⇒ Boolean
- #required_defaults ⇒ Object
- #required_keys ⇒ Object
- #required_parts ⇒ Object
-
#requirements ⇒ Object
Needed for ‘bin/rails routes`.
- #requires_matching_verb? ⇒ Boolean
- #score(supplied_keys) ⇒ Object
- #segments ⇒ Object
- #verb ⇒ Object
Constructor Details
#initialize(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false) ⇒ Route
path
is a path constraint. constraints
is a hash of constraints to be applied to this route.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 55 def initialize(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false) @name = name @app = app @path = path @request_method_match = request_method_match @constraints = constraints @defaults = defaults @required_defaults = nil @_required_defaults = required_defaults @required_parts = nil @parts = nil @decorated_ast = nil @precedence = precedence @path_formatter = @path.build_formatter @scope_options = @internal = internal end |
Instance Attribute Details
#app ⇒ Object (readonly)
Returns the value of attribute app
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def app @app end |
#constraints ⇒ Object (readonly) Also known as: conditions
Returns the value of attribute constraints
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def constraints @constraints end |
#defaults ⇒ Object (readonly)
Returns the value of attribute defaults
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def defaults @defaults end |
#internal ⇒ Object (readonly)
Returns the value of attribute internal
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def internal @internal end |
#name ⇒ Object (readonly)
Returns the value of attribute name
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def name @name end |
#path ⇒ Object (readonly)
Returns the value of attribute path
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def path @path end |
#precedence ⇒ Object (readonly)
Returns the value of attribute precedence
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def precedence @precedence end |
#scope_options ⇒ Object (readonly)
Returns the value of attribute scope_options
7 8 9 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7 def @scope_options end |
Class Method Details
.verb_matcher(verb) ⇒ Object
46 47 48 49 50 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 46 def self.verb_matcher(verb) VerbMatchers::VERB_TO_CLASS.fetch(verb) do VerbMatchers::Unknown.new verb.to_s.dasherize.upcase end end |
Instance Method Details
#ast ⇒ Object
82 83 84 85 86 87 88 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 82 def ast @decorated_ast ||= begin decorated_ast = path.ast decorated_ast.find_all(&:terminal?).each { |n| n.memo = self } decorated_ast end end |
#dispatcher? ⇒ Boolean
154 155 156 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 154 def dispatcher? @app.dispatcher? end |
#eager_load! ⇒ Object
74 75 76 77 78 79 80 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 74 def eager_load! path.eager_load! ast parts required_defaults nil end |
#format(path_options) ⇒ Object
132 133 134 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 132 def format() @path_formatter.evaluate end |
#glob? ⇒ Boolean
150 151 152 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 150 def glob? path.spec.any?(Nodes::Star) end |
#ip ⇒ Object
176 177 178 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 176 def ip constraints[:ip] || // end |
#matches?(request) ⇒ Boolean
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 158 def matches?(request) match_verb(request) && constraints.all? { |method, value| case value when Regexp, String value === request.send(method).to_s when Array value.include?(request.send(method)) when TrueClass request.send(method).present? when FalseClass request.send(method).blank? else value === request.send(method) end } end |
#parts ⇒ Object Also known as: segment_keys
127 128 129 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 127 def parts @parts ||= segments.map(&:to_sym) end |
#required_default?(key) ⇒ Boolean
140 141 142 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 140 def required_default?(key) @_required_defaults.include?(key) end |
#required_defaults ⇒ Object
144 145 146 147 148 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 144 def required_defaults @required_defaults ||= @defaults.dup.delete_if do |k, _| parts.include?(k) || !required_default?(k) end end |
#required_keys ⇒ Object
108 109 110 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 108 def required_keys required_parts + required_defaults.keys end |
#required_parts ⇒ Object
136 137 138 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 136 def required_parts @required_parts ||= path.required_names.map(&:to_sym) end |
#requirements ⇒ Object
Needed for ‘bin/rails routes`. Picks up succinctly defined requirements for a route, for example route
get 'photo/:id', :controller => 'photos', :action => 'show',
:id => /[A-Z]\d{5}/
will have :action=>“show”, :id=>/d{5/} as requirements.
98 99 100 101 102 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 98 def requirements @defaults.merge(path.requirements).delete_if { |_, v| /.+?/ == v } end |
#requires_matching_verb? ⇒ Boolean
180 181 182 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 180 def requires_matching_verb? !@request_method_match.all? { |x| x == VerbMatchers::All } end |
#score(supplied_keys) ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 112 def score(supplied_keys) required_keys = path.required_names required_keys.each do |k| return -1 unless supplied_keys.include?(k) end score = 0 path.names.each do |k| score += 1 if supplied_keys.include?(k) end score + (required_defaults.length * 2) end |
#segments ⇒ Object
104 105 106 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 104 def segments path.names end |
#verb ⇒ Object
184 185 186 |
# File 'actionpack/lib/action_dispatch/journey/route.rb', line 184 def verb verbs.join("|") end |