aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_dispatch/routing/mapper.rb
blob: 34d75e55b69eca3910e725ce71fa38db02b99a74 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
module ActionDispatch
  module Routing
    class Mapper
      module Resources
        class Resource #:nodoc:
          attr_reader :plural, :singular
          attr_reader :path_prefix, :name_prefix

          def initialize(entities, options = {})
            entities = entities.to_s

            @plural   = entities.pluralize
            @singular = entities.singularize

            @path_prefix = options[:path_prefix]
            @name_prefix = options[:name_prefix]
          end

          def name
            plural
          end

          def controller
            plural
          end

          def member_name
            if name_prefix
              "#{name_prefix}_#{singular}"
            else
              singular
            end
          end

          def collection_name
            if name_prefix
              "#{name_prefix}_#{plural}"
            else
              plural
            end
          end

          def new_name
            if name_prefix
              "new_#{name_prefix}_#{singular}"
            else
              "new_#{singular}"
            end
          end

          def edit_name
            if name_prefix
              "edit_#{name_prefix}_#{singular}"
            else
              "edit_#{singular}"
            end
          end
        end

        class SingletonResource < Resource #:nodoc:
          def initialize(entity, options = {})
            super(entity)
          end

          def name
            singular
          end
        end

        def resource(*resources, &block)
          options = resources.extract_options!

          if resources.length > 1
            raise ArgumentError if block_given?
            resources.each { |r| resource(r, options) }
            return self
          end

          name_prefix = @scope[:options][:name_prefix] if @scope[:options]
          resource = SingletonResource.new(resources.pop, :name_prefix => name_prefix)

          if @scope[:scope_level] == :resources
            parent_resource = @scope[:scope_level_options][:name]
            parent_named_prefix = @scope[:scope_level_options][:name_prefix]
            with_scope_level(:member) do
              scope(":#{parent_resource}_id", :name_prefix => parent_named_prefix) do
                resource(resource.name, options, &block)
              end
            end
            return self
          end

          controller(resource.controller) do
            namespace(resource.name) do
              with_scope_level(:resource, :name => resource.singular, :name_prefix => resource.member_name) do
                yield if block_given?

                get "", :to => :show, :as => resource.member_name
                post "", :to => :create
                put "", :to => :update
                delete "", :to => :destroy
                get "new", :to => :new, :as => resource.new_name
                get "edit", :to => :edit, :as => resource.edit_name
              end
            end
          end

          self
        end

        def resources(*resources, &block)
          options = resources.extract_options!

          if resources.length > 1
            raise ArgumentError if block_given?
            resources.each { |r| resources(r, options) }
            return self
          end

          name_prefix = @scope[:options][:name_prefix] if @scope[:options]
          resource = Resource.new(resources.pop, :name_prefix => name_prefix)

          if @scope[:scope_level] == :resources
            parent_resource = @scope[:scope_level_options][:name]
            parent_named_prefix = @scope[:scope_level_options][:name_prefix]
            with_scope_level(:member) do
              scope(":#{parent_resource}_id", :name_prefix => parent_named_prefix) do
                resources(resource.name, options, &block)
              end
            end
            return self
          end

          controller(resource.controller) do
            namespace(resource.name) do
              with_scope_level(:resources, :name => resource.singular, :name_prefix => resource.member_name) do
                yield if block_given?

                collection do
                  get "", :to => :index, :as => resource.collection_name
                  post "", :to => :create
                  get "new", :to => :new, :as => resource.new_name
                end

                member do
                  get "", :to => :show, :as => resource.member_name
                  put "", :to => :update
                  delete "", :to => :destroy
                  get "edit", :to => :edit, :as => resource.edit_name
                end
              end
            end
          end

          self
        end

        def collection
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use collection outside resources scope"
          end

          with_scope_level(:collection) do
            yield
          end
        end

        def member
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use member outside resources scope"
          end

          with_scope_level(:member) do
            scope(":id") do
              yield
            end
          end
        end

        def match(*args)
          options = args.extract_options!
          args.push(options)

          case options.delete(:on)
          when :collection
            return collection { match(*args) }
          when :member
            return member { match(*args) }
          end

          if @scope[:scope_level] == :resources
            raise ArgumentError, "can't define route directly in resources scope"
          end

          super
        end

        private
          def with_scope_level(kind, options = {})
            old, @scope[:scope_level] = @scope[:scope_level], kind
            old_options, @scope[:scope_level_options] = @scope[:scope_level_options], options
            yield
          ensure
            @scope[:scope_level] = old
            @scope[:scope_level_options] = old_options
          end
      end

      module Scoping
        def self.extended(object)
          object.instance_eval do
            @scope = {}
          end
        end

        def scope(*args)
          options = args.extract_options!

          constraints = options.delete(:constraints) || {}
          unless constraints.is_a?(Hash)
            block, constraints = constraints, {}
          end
          constraints, @scope[:constraints] = @scope[:constraints], (@scope[:constraints] || {}).merge(constraints)
          blocks, @scope[:blocks] = @scope[:blocks], (@scope[:blocks] || []) + [block]

          options, @scope[:options] = @scope[:options], (@scope[:options] || {}).merge(options)

          path_set = controller_set = false

          case args.first
          when String
            path_set = true
            path = args.first
            path, @scope[:path] = @scope[:path], "#{@scope[:path]}#{Rack::Mount::Utils.normalize_path(path)}"
          when Symbol
            controller_set = true
            controller = args.first
            controller, @scope[:controller] = @scope[:controller], controller
          end

          yield

          self
        ensure
          @scope[:path] = path if path_set
          @scope[:controller] = controller if controller_set
          @scope[:options] = options
          @scope[:blocks] = blocks
          @scope[:constraints] = constraints
        end

        def controller(controller)
          scope(controller.to_sym) { yield }
        end

        def namespace(path)
          scope(path.to_s) { yield }
        end

        def constraints(constraints = {})
          scope(:constraints => constraints) { yield }
        end

        def match(*args)
          options = args.extract_options!
          options = (@scope[:options] || {}).merge(options)
          args.push(options)
          super(*args)
        end
      end

      module HttpHelpers
        def get(*args, &block)
          map_method(:get, *args, &block)
        end

        def post(*args, &block)
          map_method(:post, *args, &block)
        end

        def put(*args, &block)
          map_method(:put, *args, &block)
        end

        def delete(*args, &block)
          map_method(:delete, *args, &block)
        end

        def redirect(path, options = {})
          status = options[:status] || 301
          lambda { |env|
            req = Rack::Request.new(env)
            url = req.scheme + '://' + req.host + path
            [status, {'Location' => url, 'Content-Type' => 'text/html'}, ['Moved Permanently']]
          }
        end

        private
          def map_method(method, *args, &block)
            options = args.extract_options!
            options[:via] = method
            args.push(options)
            match(*args, &block)
            self
          end
      end

      class Constraints
        def new(app, constraints = [])
          if constraints.any?
            super(app, constraints)
          else
            app
          end
        end

        def initialize(app, constraints = [])
          @app, @constraints = app, constraints
        end

        def call(env)
          req = Rack::Request.new(env)

          @constraints.each { |constraint|
            if constraint.respond_to?(:matches?) && !constraint.matches?(req)
              return [417, {}, []]
            elsif constraint.respond_to?(:call) && !constraint.call(req)
              return [417, {}, []]
            end
          }

          @app.call(env)
        end
      end

      def initialize(set)
        @set = set

        extend HttpHelpers
        extend Scoping
        extend Resources
      end

      def root(options = {})
        match '/', options.merge(:as => :root)
      end

      def match(*args)
        options = args.extract_options!

        if args.length > 1
          args.each { |path| match(path, options) }
          return self
        end

        if args.first.is_a?(Symbol)
          return match(args.first.to_s, options.merge(:to => args.first.to_sym))
        end

        path = args.first

        conditions, defaults = {}, {}

        path = nil if path == ""
        path = Rack::Mount::Utils.normalize_path(path) if path
        path = "#{@scope[:path]}#{path}" if @scope[:path]

        raise ArgumentError, "path is required" unless path

        constraints = options[:constraints] || {}
        unless constraints.is_a?(Hash)
          block, constraints = constraints, {}
        end
        blocks = ((@scope[:blocks] || []) + [block]).compact
        constraints = (@scope[:constraints] || {}).merge(constraints)
        options.each { |k, v| constraints[k] = v if v.is_a?(Regexp) }

        conditions[:path_info] = path
        requirements = constraints.dup

        path_regexp = Rack::Mount::Strexp.compile(path, constraints, SEPARATORS)
        segment_keys = Rack::Mount::RegexpWithNamedGroups.new(path_regexp).names
        constraints.reject! { |k, v| segment_keys.include?(k.to_s) }
        conditions.merge!(constraints)

        requirements[:controller] ||= Routing.controller_constraints

        if via = options[:via]
          via = Array(via).map { |m| m.to_s.upcase }
          conditions[:request_method] = Regexp.union(*via)
        end

        defaults[:controller] ||= @scope[:controller].to_s if @scope[:controller]

        app = initialize_app_endpoint(options, defaults)
        validate_defaults!(app, defaults, segment_keys)
        app = Constraints.new(app, blocks)

        @set.add_route(app, conditions, requirements, defaults, options[:as])

        self
      end

      private
        def initialize_app_endpoint(options, defaults)
          app = nil

          if options[:to].respond_to?(:call)
            app = options[:to]
            defaults.delete(:controller)
            defaults.delete(:action)
          elsif options[:to].is_a?(String)
            defaults[:controller], defaults[:action] = options[:to].split('#')
          elsif options[:to].is_a?(Symbol)
            defaults[:action] = options[:to].to_s
          end

          app || Routing::RouteSet::Dispatcher.new(:defaults => defaults)
        end

        def validate_defaults!(app, defaults, segment_keys)
          return unless app.is_a?(Routing::RouteSet::Dispatcher)

          unless defaults.include?(:controller) || segment_keys.include?("controller")
            raise ArgumentError, "missing :controller"
          end

          unless defaults.include?(:action) || segment_keys.include?("action")
            raise ArgumentError, "missing :action"
          end
        end
    end
  end
end