mapper.rb 16.2 KB
Newer Older
J
Joshua Peek 已提交
1 2
module ActionDispatch
  module Routing
J
Joshua Peek 已提交
3
    class Mapper
4
      class Constraints
5
        def self.new(app, constraints = [])
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
          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)
J
Joshua Peek 已提交
22
              return [ 404, {'X-Cascade' => 'pass'}, [] ]
23
            elsif constraint.respond_to?(:call) && !constraint.call(req)
J
Joshua Peek 已提交
24
              return [ 404, {'X-Cascade' => 'pass'}, [] ]
25 26 27 28 29 30 31
            end
          }

          @app.call(env)
        end
      end

32 33 34 35
      class Mapping
        def initialize(set, scope, args)
          @set, @scope    = set, scope
          @path, @options = extract_path_and_options(args)
36
        end
J
Joshua Peek 已提交
37

38 39
        def to_route
          [ app, conditions, requirements, defaults, @options[:as] ]
40
        end
J
Joshua Peek 已提交
41

42 43
        private
          def extract_path_and_options(args)
44
            options = args.extract_options!
45

46 47
            case
            when using_to_shorthand?(args, options)
48 49
              path, to = options.find { |name, value| name.is_a?(String) }
              options.merge!(:to => to).delete(path) if path
50 51 52
            when using_match_shorthand?(args, options)
              path = args.first
              options = { :to => path.gsub("/", "#"), :as => path.gsub("/", "_") }
53 54 55
            else
              path = args.first
            end
J
Joshua Peek 已提交
56

57
            [ normalize_path(path), options ]
58
          end
59

60 61 62 63
          # match "account" => "account#index"
          def using_to_shorthand?(args, options)
            args.empty? && options.present?
          end
64

65 66
          # match "account/overview"
          def using_match_shorthand?(args, options)
67
            args.present? && options.except(:via).empty? && !args.first.include?(':')
68
          end
69

70 71 72
          def normalize_path(path)
            path = nil if path == ""
            path = "#{@scope[:path]}#{path}" if @scope[:path]
J
Joshua Peek 已提交
73
            path = Rack::Mount::Utils.normalize_path(path) if path
74

75
            raise ArgumentError, "path is required" unless path
J
Joshua Peek 已提交
76 77

            path
78
          end
79

80 81 82 83 84
          def app
            Constraints.new(
              to.respond_to?(:call) ? to : Routing::RouteSet::Dispatcher.new(:defaults => defaults),
              blocks
            )
85 86
          end

87 88 89
          def conditions
            { :path_info => @path }.merge(constraints).merge(request_method_condition)
          end
J
Joshua Peek 已提交
90

91 92 93 94 95 96 97
          def requirements
            @requirements ||= returning(@options[:constraints] || {}) do |requirements|
              requirements.reverse_merge!(@scope[:constraints]) if @scope[:constraints]
              @options.each { |k, v| requirements[k] = v if v.is_a?(Regexp) }
              requirements[:controller] ||= @set.controller_constraints
            end
          end
98

99 100 101 102 103 104 105 106 107
          def defaults
            @defaults ||= if to.respond_to?(:call)
              { }
            else
              defaults = case to
              when String
                controller, action = to.split('#')
                { :controller => controller, :action => action }
              when Symbol
108
                { :action => to.to_s }.merge(default_controller ? { :controller => default_controller } : {})
109
              else
110
                default_controller ? { :controller => default_controller } : {}
111
              end
J
Joshua Peek 已提交
112

113 114 115
              if defaults[:controller].blank? && segment_keys.exclude?("controller")
                raise ArgumentError, "missing :controller"
              end
J
Joshua Peek 已提交
116

117 118 119
              if defaults[:action].blank? && segment_keys.exclude?("action")
                raise ArgumentError, "missing :action"
              end
J
Joshua Peek 已提交
120

121 122 123
              defaults
            end
          end
124

125 126 127 128 129 130
          def blocks
            if @options[:constraints].present? && !@options[:constraints].is_a?(Hash)
              block = @options[:constraints]
            else
              block = nil
            end
J
Joshua Peek 已提交
131 132

            ((@scope[:blocks] || []) + [ block ]).compact
133
          end
J
Joshua Peek 已提交
134

135 136 137
          def constraints
            @constraints ||= requirements.reject { |k, v| segment_keys.include?(k.to_s) || k == :controller }
          end
138

139 140 141 142 143 144
          def request_method_condition
            if via = @options[:via]
              via = Array(via).map { |m| m.to_s.upcase }
              { :request_method => Regexp.union(*via) }
            else
              { }
145
            end
146
          end
J
Joshua Peek 已提交
147

148 149 150 151 152
          def segment_keys
            @segment_keys ||= Rack::Mount::RegexpWithNamedGroups.new(
                Rack::Mount::Strexp.compile(@path, requirements, SEPARATORS)
              ).names
          end
153

154 155 156
          def to
            @options[:to]
          end
J
Joshua Peek 已提交
157

158 159
          def default_controller
            @scope[:controller].to_s if @scope[:controller]
160
          end
161
      end
162

163 164 165 166
      module Base
        def initialize(set)
          @set = set
        end
167

168 169 170
        def root(options = {})
          match '/', options.reverse_merge(:as => :root)
        end
171

172 173 174 175
        def match(*args)
          @set.add_route(*Mapping.new(@set, @scope, args).to_route)
          self
        end
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
      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

195 196 197
        def redirect(*args, &block)
          options = args.last.is_a?(Hash) ? args.pop : {}

198 199 200
          path      = args.shift || block
          path_proc = path.is_a?(Proc) ? path : proc { |params| path % params }
          status    = options[:status] || 301
201
          body      = 'Moved Permanently'
202 203

          lambda do |env|
204 205
            req = Request.new(env)

206
            uri = URI.parse(path_proc.call(req.params.symbolize_keys))
207 208
            uri.scheme ||= req.scheme
            uri.host   ||= req.host
209
            uri.port   ||= req.port unless req.port == 80
210 211 212 213 214 215 216

            headers = {
              'Location' => uri.to_s,
              'Content-Type' => 'text/html',
              'Content-Length' => body.length.to_s
            }
            [ status, headers, [body] ]
217
          end
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
        end

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

      module Scoping
        def initialize(*args)
          @scope = {}
          super
        end

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

          case args.first
          when String
            options[:path] = args.first
          when Symbol
            options[:controller] = args.first
          end

          if path = options.delete(:path)
            path_set = true
J
Joshua Peek 已提交
248
            path, @scope[:path] = @scope[:path], Rack::Mount::Utils.normalize_path(@scope[:path].to_s + path.to_s)
249 250 251 252 253 254
          else
            path_set = false
          end

          if name_prefix = options.delete(:name_prefix)
            name_prefix_set = true
255
            name_prefix, @scope[:name_prefix] = @scope[:name_prefix], (@scope[:name_prefix] ? "#{@scope[:name_prefix]}_#{name_prefix}" : name_prefix)
256 257 258
          else
            name_prefix_set = false
          end
259

260 261
          if namespace = options.delete(:namespace)
            namespace_set = true
262
            namespace, @scope[:namespace] = @scope[:namespace], (@scope[:namespace] ? "#{@scope[:namespace]}/#{namespace}" : namespace)
263 264 265
          else
            namespace_set = false
          end
266 267 268

          if controller = options.delete(:controller)
            controller_set = true
269
            controller, @scope[:controller] = @scope[:controller], (@scope[:namespace] ? "#{@scope[:namespace]}/#{controller}" : controller)
270 271 272 273 274 275 276 277
          else
            controller_set = false
          end

          constraints = options.delete(:constraints) || {}
          unless constraints.is_a?(Hash)
            block, constraints = constraints, {}
          end
278

279 280 281 282 283 284 285
          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)

          yield
          self
        ensure
286
          @scope[:path]        = path        if path_set
287
          @scope[:name_prefix] = name_prefix if name_prefix_set
288
          @scope[:namespace]   = namespace   if namespace_set
289 290 291
          @scope[:controller]  = controller  if controller_set
          @scope[:options]     = options
          @scope[:blocks]      = blocks
292 293 294 295 296 297 298 299
          @scope[:constraints] = constraints
        end

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

        def namespace(path)
300
          scope("/#{path}", :name_prefix => path.to_s, :namespace => path.to_s) { yield }
301 302 303 304 305 306 307 308 309 310 311
        end

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

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

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

312 313
          if @scope[:name_prefix] && !options[:as].blank?
            options[:as] = "#{@scope[:name_prefix]}_#{options[:as]}"
314
          elsif @scope[:name_prefix] && options[:as] == ""
315
            options[:as] = @scope[:name_prefix].to_s
316 317 318 319 320 321 322
          end

          args.push(options)
          super(*args)
        end
      end

J
Joshua Peek 已提交
323
      module Resources
324 325
        CRUD_ACTIONS = [:index, :show, :new, :edit, :create, :update, :destroy]

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
        class Resource #:nodoc:
          attr_reader :plural, :singular

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

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

          def name
            plural
          end

          def controller
            plural
          end

          def member_name
345
            singular
346 347 348
          end

          def collection_name
349
            plural
350
          end
351 352 353 354

          def id_segment
            ":#{singular}_id"
          end
355 356 357 358
        end

        class SingletonResource < Resource #:nodoc:
          def initialize(entity, options = {})
359
            super
360 361 362 363 364 365 366
          end

          def name
            singular
          end
        end

J
Joshua Peek 已提交
367
        def resource(*resources, &block)
J
Joshua Peek 已提交
368
          options = resources.extract_options!
J
Joshua Peek 已提交
369 370 371 372 373 374

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

376
          resource = SingletonResource.new(resources.pop)
377

J
Joshua Peek 已提交
378
          if @scope[:scope_level] == :resources
379 380
            nested do
              resource(resource.name, options, &block)
381
            end
J
Joshua Peek 已提交
382
            return self
383 384
          end

J
Joshua Peek 已提交
385
          scope(:path => "/#{resource.name}", :controller => resource.controller) do
386 387 388
            with_scope_level(:resource, resource) do
              yield if block_given?

389 390 391 392 393 394
              get    "(.:format)",      :to => :show, :as => resource.member_name
              post   "(.:format)",      :to => :create
              put    "(.:format)",      :to => :update
              delete "(.:format)",      :to => :destroy
              get    "/new(.:format)",  :to => :new,  :as => "new_#{resource.singular}"
              get    "/edit(.:format)", :to => :edit, :as => "edit_#{resource.singular}"
395 396 397
            end
          end

J
Joshua Peek 已提交
398
          self
399 400
        end

J
Joshua Peek 已提交
401
        def resources(*resources, &block)
J
Joshua Peek 已提交
402
          options = resources.extract_options!
403

J
Joshua Peek 已提交
404 405 406 407
          if resources.length > 1
            raise ArgumentError if block_given?
            resources.each { |r| resources(r, options) }
            return self
408 409
          end

410
          resource = Resource.new(resources.pop)
411

J
Joshua Peek 已提交
412
          if @scope[:scope_level] == :resources
413 414
            nested do
              resources(resource.name, options, &block)
415
            end
J
Joshua Peek 已提交
416
            return self
417 418
          end

J
Joshua Peek 已提交
419
          scope(:path => "/#{resource.name}", :controller => resource.controller) do
420 421
            with_scope_level(:resources, resource) do
              yield if block_given?
J
Joshua Peek 已提交
422

423
              with_scope_level(:collection) do
424
                get  "(.:format)", :to => :index, :as => resource.collection_name
J
Joshua Peek 已提交
425
                post "(.:format)", :to => :create
426

427 428 429
                with_exclusive_name_prefix :new do
                  get "/new(.:format)", :to => :new, :as => resource.singular
                end
430
              end
431

432
              with_scope_level(:member) do
J
Joshua Peek 已提交
433
                scope("/:id") do
434 435
                  get    "(.:format)", :to => :show, :as => resource.member_name
                  put    "(.:format)", :to => :update
J
Joshua Peek 已提交
436
                  delete "(.:format)", :to => :destroy
437

438 439 440
                  with_exclusive_name_prefix :edit do
                    get "/edit(.:format)", :to => :edit, :as => resource.singular
                  end
J
Joshua Peek 已提交
441
                end
442 443 444 445
              end
            end
          end

J
Joshua Peek 已提交
446
          self
447 448
        end

J
Joshua Peek 已提交
449 450 451
        def collection
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use collection outside resources scope"
452 453
          end

J
Joshua Peek 已提交
454
          with_scope_level(:collection) do
455
            scope(:name_prefix => parent_resource.collection_name, :as => "") do
456 457
              yield
            end
J
Joshua Peek 已提交
458
          end
459
        end
J
Joshua Peek 已提交
460

J
Joshua Peek 已提交
461 462 463 464
        def member
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use member outside resources scope"
          end
J
Joshua Peek 已提交
465

J
Joshua Peek 已提交
466
          with_scope_level(:member) do
J
Joshua Peek 已提交
467
            scope("/:id", :name_prefix => parent_resource.member_name, :as => "") do
J
Joshua Peek 已提交
468 469 470
              yield
            end
          end
J
Joshua Peek 已提交
471 472
        end

473 474 475 476 477 478
        def nested
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use nested outside resources scope"
          end

          with_scope_level(:nested) do
J
Joshua Peek 已提交
479
            scope("/#{parent_resource.id_segment}", :name_prefix => parent_resource.member_name) do
480 481 482 483 484
              yield
            end
          end
        end

J
Joshua Peek 已提交
485
        def match(*args)
J
Joshua Peek 已提交
486
          options = args.extract_options!
487 488 489 490 491 492 493

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

          if args.first.is_a?(Symbol)
494 495 496 497 498 499 500
            action = args.first
            if CRUD_ACTIONS.include?(action)
              return match("(.:format)", options.merge(:to => action))
            else
              with_exclusive_name_prefix(action) do
                return match("/#{action}(.:format)", options.merge(:to => action))
              end
501 502 503
            end
          end

J
Joshua Peek 已提交
504
          args.push(options)
J
Joshua Peek 已提交
505

J
Joshua Peek 已提交
506 507 508 509 510 511
          case options.delete(:on)
          when :collection
            return collection { match(*args) }
          when :member
            return member { match(*args) }
          end
J
Joshua Peek 已提交
512

J
Joshua Peek 已提交
513 514 515
          if @scope[:scope_level] == :resources
            raise ArgumentError, "can't define route directly in resources scope"
          end
J
Joshua Peek 已提交
516

J
Joshua Peek 已提交
517
          super
J
Joshua Peek 已提交
518 519
        end

520 521 522 523 524
        protected
          def parent_resource
            @scope[:scope_level_resource]
          end

J
Joshua Peek 已提交
525
        private
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
          def with_exclusive_name_prefix(prefix)
            begin
              old_name_prefix = @scope[:name_prefix]

              if !old_name_prefix.blank?
                @scope[:name_prefix] = "#{prefix}_#{@scope[:name_prefix]}"
              else
                @scope[:name_prefix] = prefix.to_s
              end

              yield
            ensure
              @scope[:name_prefix] = old_name_prefix
            end
          end

542
          def with_scope_level(kind, resource = parent_resource)
J
Joshua Peek 已提交
543
            old, @scope[:scope_level] = @scope[:scope_level], kind
544
            old_resource, @scope[:scope_level_resource] = @scope[:scope_level_resource], resource
J
Joshua Peek 已提交
545 546 547
            yield
          ensure
            @scope[:scope_level] = old
548
            @scope[:scope_level_resource] = old_resource
J
Joshua Peek 已提交
549 550
          end
      end
J
Joshua Peek 已提交
551

552 553 554 555
      include Base
      include HttpHelpers
      include Scoping
      include Resources
J
Joshua Peek 已提交
556 557
    end
  end
J
Joshua Peek 已提交
558
end