Class: ActionDispatch::Routing::Mapper::Mapping

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/routing/mapper.rb

Overview

:nodoc:

Constant Summary collapse

ANCHOR_CHARACTERS_REGEX = 
%r{\A(\\A|\^)|(\\Z|\\z|\$)\Z}
OPTIONAL_FORMAT_REGEX = 
%r{(?:\(\.:format\)+|\.:format|/)\Z}
JOINED_SEPARATORS =

:nodoc:

SEPARATORS.join

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(set:, ast:, controller:, default_action:, to:, formatted:, via:, options_constraints:, anchor:, scope_params:, options:) ⇒ Mapping

Returns a new instance of Mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/action_dispatch/routing/mapper.rb', line 119

def initialize(set:, ast:, controller:, default_action:, to:, formatted:, via:, options_constraints:, anchor:, scope_params:, options:)
  @defaults           = scope_params[:defaults]
  @set                = set
  @to                 = intern(to)
  @default_controller = intern(controller)
  @default_action     = intern(default_action)
  @ast                = ast
  @anchor             = anchor
  @via                = via
  @internal           = options.delete(:internal)
  @scope_options      = scope_params[:options]

  path_params = []
  wildcard_options = {}
  ast.each do |node|
    if node.symbol?
      path_params << node.to_sym
    elsif formatted != false && node.star?
      # Add a constraint for wildcard route to make it non-greedy and match the
      # optional format part of the route by default.
      wildcard_options[node.name.to_sym] ||= /.+?/
    elsif node.cat?
      alter_regex_for_custom_routes(node)
    end
  end

  options = wildcard_options.merge!(options)

  options = normalize_options!(options, path_params, scope_params[:module])

  split_options = constraints(options, path_params)

  constraints = scope_params[:constraints].merge Hash[split_options[:constraints] || []]

  if options_constraints.is_a?(Hash)
    @defaults = Hash[options_constraints.find_all { |key, default|
      URL_OPTIONS.include?(key) && (String === default || Integer === default)
    }].merge @defaults
    @blocks = scope_params[:blocks]
    constraints.merge! options_constraints
  else
    @blocks = blocks(options_constraints)
  end

  requirements, conditions = split_constraints path_params, constraints
  verify_regexp_requirements requirements.map(&:last).grep(Regexp)

  formats = normalize_format(formatted)

  @requirements = formats[:requirements].merge Hash[requirements]
  @conditions = Hash[conditions]
  @defaults = formats[:defaults].merge(@defaults).merge(normalize_defaults(options))

  if path_params.include?(:action) && !@requirements.key?(:action)
    @defaults[:action] ||= "index"
  end

  @required_defaults = (split_options[:required_defaults] || []).map(&:first)
end

Instance Attribute Details

#ast ⇒ Object (readonly)

Returns the value of attribute ast.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def ast
  @ast
end

#default_action ⇒ Object (readonly)

Returns the value of attribute default_action.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def default_action
  @default_action
end

#default_controller ⇒ Object (readonly)

Returns the value of attribute default_controller.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def default_controller
  @default_controller
end

#defaults ⇒ Object (readonly)

Returns the value of attribute defaults.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def defaults
  @defaults
end

#required_defaults ⇒ Object (readonly)

Returns the value of attribute required_defaults.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def required_defaults
  @required_defaults
end

#requirements ⇒ Object (readonly)

Returns the value of attribute requirements.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def requirements
  @requirements
end

#scope_options ⇒ Object (readonly)

Returns the value of attribute scope_options.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def scope_options
  @scope_options
end

#to ⇒ Object (readonly)

Returns the value of attribute to.



74
75
76
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

def to
  @to
end

Class Method Details

.build(scope, set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, options) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/action_dispatch/routing/mapper.rb', line 77

def self.build(scope, set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, options)
  scope_params = {
    blocks: scope[:blocks] || [],
    constraints: scope[:constraints] || {},
    defaults: (scope[:defaults] || {}).dup,
    module: scope[:module],
    options: scope[:options] || {}
  }

  new set: set, ast: ast, controller: controller, default_action: default_action,
      to: to, formatted: formatted, via: via, options_constraints: options_constraints,
      anchor: anchor, scope_params: scope_params, options: scope_params[:options].merge(options)
end

.check_via(via) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/action_dispatch/routing/mapper.rb', line 91

def self.check_via(via)
  if via.empty?
    msg = "You should not use the `match` method in your router without specifying an HTTP method.\n" \
      "If you want to expose your action to both GET and POST, add `via: [:get, :post]` option.\n" \
      "If you want to expose your action to GET, use `get` in the router:\n" \
      "  Instead of: match \"controller#action\"\n" \
      "  Do: get \"controller#action\""
    raise ArgumentError, msg
  end
  via
end

.normalize_path(path, format) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/action_dispatch/routing/mapper.rb', line 103

def self.normalize_path(path, format)
  path = Mapper.normalize_path(path)

  if format == true
    "#{path}.:format"
  elsif optional_format?(path, format)
    "#{path}(.:format)"
  else
    path
  end
end

.optional_format?(path, format) ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/action_dispatch/routing/mapper.rb', line 115

def self.optional_format?(path, format)
  format != false && !path.match?(OPTIONAL_FORMAT_REGEX)
end

Instance Method Details

#application ⇒ Object 



186
187
188
 
# File 'lib/action_dispatch/routing/mapper.rb', line 186

def application
  app(@blocks)
end

#conditions ⇒ Object 



196
197
198
 
# File 'lib/action_dispatch/routing/mapper.rb', line 196

def conditions
  build_conditions @conditions, @set.request_class
end

#make_route(name, precedence) ⇒ Object 



179
180
181
182
183
184
 
# File 'lib/action_dispatch/routing/mapper.rb', line 179

def make_route(name, precedence)
  Journey::Route.new(name: name, app: application, path: path, constraints: conditions,
                     required_defaults: required_defaults, defaults: defaults,
                     request_method_match: request_method, precedence: precedence,
                     scope_options: scope_options, internal: @internal)
end

#path ⇒ Object 



192
193
194
 
# File 'lib/action_dispatch/routing/mapper.rb', line 192

def path
  Journey::Path::Pattern.new(@ast, requirements, JOINED_SEPARATORS, @anchor)
end