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, defaults, controller, default_action, modyoule, to, formatted, scope_constraints, blocks, via, options_constraints, anchor, options) ⇒ Mapping

Returns a new instance of Mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
 
# File 'lib/action_dispatch/routing/mapper.rb', line 102

def initialize(set, ast, defaults, controller, default_action, modyoule, to, formatted, scope_constraints, blocks, via, options_constraints, anchor, options)
  @defaults = defaults
  @set = set

  @to                 = to
  @default_controller = controller
  @default_action     = default_action
  @ast                = ast
  @anchor             = anchor
  @via                = via
  @internal           = options.delete(:internal)

  path_params = ast.find_all(&:symbol?).map(&:to_sym)

  options = add_wildcard_options(options, formatted, ast)

  options = normalize_options!(options, path_params, modyoule)

  split_options = constraints(options, path_params)

  constraints = scope_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 = 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.



63
64
65
 
# File 'lib/action_dispatch/routing/mapper.rb', line 63

def ast
  @ast
end

#default_action ⇒ Object (readonly)

Returns the value of attribute default_action.



62
63
64
 
# File 'lib/action_dispatch/routing/mapper.rb', line 62

def default_action
  @default_action
end

#default_controller ⇒ Object (readonly)

Returns the value of attribute default_controller.



62
63
64
 
# File 'lib/action_dispatch/routing/mapper.rb', line 62

def default_controller
  @default_controller
end

#defaults ⇒ Object (readonly)

Returns the value of attribute defaults.



61
62
63
 
# File 'lib/action_dispatch/routing/mapper.rb', line 61

def defaults
  @defaults
end

#required_defaults ⇒ Object (readonly)

Returns the value of attribute required_defaults.



63
64
65
 
# File 'lib/action_dispatch/routing/mapper.rb', line 63

def required_defaults
  @required_defaults
end

#requirements ⇒ Object (readonly)

Returns the value of attribute requirements.



61
62
63
 
# File 'lib/action_dispatch/routing/mapper.rb', line 61

def requirements
  @requirements
end

#to ⇒ Object (readonly)

Returns the value of attribute to.



62
63
64
 
# File 'lib/action_dispatch/routing/mapper.rb', line 62

def to
  @to
end

Class Method Details

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



65
66
67
68
69
70
71
72
 
# File 'lib/action_dispatch/routing/mapper.rb', line 65

def self.build(scope, set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, options)
  options = scope[:options].merge(options) if scope[:options]

  defaults = (scope[:defaults] || {}).dup
  scope_constraints = scope[:constraints] || {}

  new set, ast, defaults, controller, default_action, scope[:module], to, formatted, scope_constraints, scope[:blocks] || [], via, options_constraints, anchor, options
end

.check_via(via) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/action_dispatch/routing/mapper.rb', line 74

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 



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/action_dispatch/routing/mapper.rb', line 86

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) 


98
99
100
 
# File 'lib/action_dispatch/routing/mapper.rb', line 98

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

Instance Method Details

#application ⇒ Object 



164
165
166
 
# File 'lib/action_dispatch/routing/mapper.rb', line 164

def application
  app(@blocks)
end

#conditions ⇒ Object 



172
173
174
 
# File 'lib/action_dispatch/routing/mapper.rb', line 172

def conditions
  build_conditions @conditions, @set.request_class
end

#make_route(name, precedence) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/action_dispatch/routing/mapper.rb', line 150

def make_route(name, precedence)
  route = Journey::Route.new(name,
                    application,
                    path,
                    conditions,
                    required_defaults,
                    defaults,
                    request_method,
                    precedence,
                    @internal)

  route
end

#path ⇒ Object 



168
169
170
 
# File 'lib/action_dispatch/routing/mapper.rb', line 168

def path
  build_path @ast, requirements, @anchor
end