Class: ActionDispatch::Journey::Route

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/journey/route.rb

Defined Under Namespace

Modules: VerbMatchers

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, app, path, constraints, required_defaults, defaults, request_method_match, precedence, internal = false) ⇒ Route

path is a path constraint. constraints is a hash of constraints to be applied to this route.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/action_dispatch/journey/route.rb', line 58

def initialize(name, app, path, constraints, required_defaults, defaults, request_method_match, precedence, 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
  @internal          = internal
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



5
6
7
 
# File 'lib/action_dispatch/journey/route.rb', line 5

def app
  @app
end

#constraints ⇒ Object (readonly) Also known as: conditions

Returns the value of attribute constraints.



7
8
9
 
# File 'lib/action_dispatch/journey/route.rb', line 7

def constraints
  @constraints
end

#defaults ⇒ Object (readonly)

Returns the value of attribute defaults.



5
6
7
 
# File 'lib/action_dispatch/journey/route.rb', line 5

def defaults
  @defaults
end

#internal ⇒ Object (readonly)

Returns the value of attribute internal.



7
8
9
 
# File 'lib/action_dispatch/journey/route.rb', line 7

def internal
  @internal
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/action_dispatch/journey/route.rb', line 5

def name
  @name
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



5
6
7
 
# File 'lib/action_dispatch/journey/route.rb', line 5

def path
  @path
end

#precedence ⇒ Object (readonly)

Returns the value of attribute precedence.



5
6
7
 
# File 'lib/action_dispatch/journey/route.rb', line 5

def precedence
  @precedence
end

Class Method Details

.build(name, app, path, constraints, required_defaults, defaults) ⇒ Object 



50
51
52
53
 
# File 'lib/action_dispatch/journey/route.rb', line 50

def self.build(name, app, path, constraints, required_defaults, defaults)
  request_method_match = verb_matcher(constraints.delete(:request_method))
  new name, app, path, constraints, required_defaults, defaults, request_method_match, 0
end

.verb_matcher(verb) ⇒ Object 



44
45
46
47
48
 
# File 'lib/action_dispatch/journey/route.rb', line 44

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 



84
85
86
87
88
89
90
 
# File 'lib/action_dispatch/journey/route.rb', line 84

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

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/action_dispatch/journey/route.rb', line 149

def dispatcher?
  @app.dispatcher?
end

#eager_load! ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/action_dispatch/journey/route.rb', line 76

def eager_load!
  path.eager_load!
  ast
  parts
  required_defaults
  nil
end

#format(path_options) ⇒ Object 



127
128
129
 
# File 'lib/action_dispatch/journey/route.rb', line 127

def format(path_options)
  @path_formatter.evaluate path_options
end

#glob? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/action_dispatch/journey/route.rb', line 145

def glob?
  !path.spec.grep(Nodes::Star).empty?
end

#ip ⇒ Object 



171
172
173
 
# File 'lib/action_dispatch/journey/route.rb', line 171

def ip
  constraints[:ip] || //
end

#matches?(request) ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/action_dispatch/journey/route.rb', line 153

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 



122
123
124
 
# File 'lib/action_dispatch/journey/route.rb', line 122

def parts
  @parts ||= segments.map(&:to_sym)
end

#required_default?(key) ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/action_dispatch/journey/route.rb', line 135

def required_default?(key)
  @_required_defaults.include?(key)
end

#required_defaults ⇒ Object 



139
140
141
142
143
 
# File 'lib/action_dispatch/journey/route.rb', line 139

def required_defaults
  @required_defaults ||= @defaults.dup.delete_if do |k, _|
    parts.include?(k) || !required_default?(k)
  end
end

#required_keys ⇒ Object 



103
104
105
 
# File 'lib/action_dispatch/journey/route.rb', line 103

def required_keys
  required_parts + required_defaults.keys
end

#required_parts ⇒ Object 



131
132
133
 
# File 'lib/action_dispatch/journey/route.rb', line 131

def required_parts
  @required_parts ||= path.required_names.map(&:to_sym)
end

#requirements ⇒ Object 



92
93
94
95
96
97
 
# File 'lib/action_dispatch/journey/route.rb', line 92

def requirements
  # needed for rails `rails routes`
  @defaults.merge(path.requirements).delete_if { |_, v|
    /.+?/ == v
  }
end

#requires_matching_verb? ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/action_dispatch/journey/route.rb', line 175

def requires_matching_verb?
  !@request_method_match.all? { |x| x == VerbMatchers::All }
end

#score(supplied_keys) ⇒ Object 



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

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 



99
100
101
 
# File 'lib/action_dispatch/journey/route.rb', line 99

def segments
  path.names
end

#verb ⇒ Object 



179
180
181
 
# File 'lib/action_dispatch/journey/route.rb', line 179

def verb
  verbs.join("|")
end