mapper.rb 35.6 KB
Newer Older
1
require 'erb'
2
require 'active_support/core_ext/hash/except'
3
require 'active_support/core_ext/object/blank'
4

J
Joshua Peek 已提交
5 6
module ActionDispatch
  module Routing
J
Joshua Peek 已提交
7
    class Mapper
8
      class Constraints #:nodoc:
9
        def self.new(app, constraints, request = Rack::Request)
10
          if constraints.any?
11
            super(app, constraints, request)
12 13 14 15 16
          else
            app
          end
        end

17 18
        attr_reader :app

19 20
        def initialize(app, constraints, request)
          @app, @constraints, @request = app, constraints, request
21 22 23
        end

        def call(env)
24
          req = @request.new(env)
25 26 27

          @constraints.each { |constraint|
            if constraint.respond_to?(:matches?) && !constraint.matches?(req)
J
Joshua Peek 已提交
28
              return [ 404, {'X-Cascade' => 'pass'}, [] ]
29
            elsif constraint.respond_to?(:call) && !constraint.call(*constraint_args(constraint, req))
J
Joshua Peek 已提交
30
              return [ 404, {'X-Cascade' => 'pass'}, [] ]
31 32 33 34 35
            end
          }

          @app.call(env)
        end
36 37 38 39 40

        private
          def constraint_args(constraint, request)
            constraint.arity == 1 ? [request] : [request.symbolized_path_parameters, request]
          end
41 42
      end

43
      class Mapping #:nodoc:
44
        IGNORE_OPTIONS = [:to, :as, :via, :on, :constraints, :defaults, :only, :except, :anchor, :shallow, :shallow_path, :shallow_prefix]
45

46
        def initialize(set, scope, path, options)
47 48
          @set, @scope = set, scope
          @options = (@scope[:options] || {}).merge(options)
49
          @path = normalize_path(path)
50
          normalize_options!
51
        end
J
Joshua Peek 已提交
52

53
        def to_route
54
          [ app, conditions, requirements, defaults, @options[:as], @options[:anchor] ]
55
        end
J
Joshua Peek 已提交
56

57
        private
58 59 60

          def normalize_options!
            path_without_format = @path.sub(/\(\.:format\)$/, '')
61

62 63 64
            if using_match_shorthand?(path_without_format, @options)
              to_shorthand    = @options[:to].blank?
              @options[:to] ||= path_without_format[1..-1].sub(%r{/([^/]*)$}, '#\1')
65 66
            end

67
            @options.merge!(default_controller_and_action(to_shorthand))
68
          end
69

70
          # match "account/overview"
71
          def using_match_shorthand?(path, options)
72
            path && options.except(:via, :anchor, :to, :as).empty? && path =~ %r{^/[\w\/]+$}
73
          end
74

75
          def normalize_path(path)
76 77
            raise ArgumentError, "path is required" if path.blank?
            path = Mapper.normalize_path(path)
78 79 80 81 82 83 84 85 86 87 88

            if path.match(':controller')
              raise ArgumentError, ":controller segment is not allowed within a namespace block" if @scope[:module]

              # Add a default constraint for :controller path segments that matches namespaced
              # controllers with default routes like :controller/:action/:id(.:format), e.g:
              # GET /admin/products/show/1
              # => { :controller => 'admin/products', :action => 'show', :id => '1' }
              @options.reverse_merge!(:controller => /.+?/)
            end

89 90 91 92
            if @options[:format] == false
              @options.delete(:format)
              path
            elsif path.include?(":format")
93 94 95 96
              path
            else
              "#{path}(.:format)"
            end
97
          end
98

99 100
          def app
            Constraints.new(
101
              to.respond_to?(:call) ? to : Routing::RouteSet::Dispatcher.new(:defaults => defaults),
102 103
              blocks,
              @set.request_class
104
            )
105 106
          end

107 108 109
          def conditions
            { :path_info => @path }.merge(constraints).merge(request_method_condition)
          end
J
Joshua Peek 已提交
110

111
          def requirements
112
            @requirements ||= (@options[:constraints].is_a?(Hash) ? @options[:constraints] : {}).tap do |requirements|
113 114
              requirements.reverse_merge!(@scope[:constraints]) if @scope[:constraints]
              @options.each { |k, v| requirements[k] = v if v.is_a?(Regexp) }
115 116 117 118 119 120 121 122 123

              requirements.each do |_, requirement|
                if requirement.source =~ %r{\A(\\A|\^)|(\\Z|\\z|\$)\Z}
                  raise ArgumentError, "Regexp anchor characters are not allowed in routing requirements: #{requirement.inspect}"
                end
                if requirement.multiline?
                  raise ArgumentError, "Regexp multiline option not allowed in routing requirements: #{requirement.inspect}"
                end
              end
124 125
            end
          end
126

127
          def defaults
128 129 130 131 132 133
            @defaults ||= (@options[:defaults] || {}).tap do |defaults|
              defaults.reverse_merge!(@scope[:defaults]) if @scope[:defaults]
              @options.each { |k, v| defaults[k] = v unless v.is_a?(Regexp) || IGNORE_OPTIONS.include?(k.to_sym) }
            end
          end

134
          def default_controller_and_action(to_shorthand=nil)
135
            if to.respond_to?(:call)
136 137
              { }
            else
138
              if to.is_a?(String)
139
                controller, action = to.split('#')
140 141
              elsif to.is_a?(Symbol)
                action = to.to_s
142
              end
J
Joshua Peek 已提交
143

144 145
              controller ||= default_controller
              action     ||= default_action
146

147 148 149
              unless controller.is_a?(Regexp) || to_shorthand
                controller = [@scope[:module], controller].compact.join("/").presence
              end
150

151 152 153 154
              if controller.is_a?(String) && controller =~ %r{\A/}
                raise ArgumentError, "controller name should not start with a slash"
              end

155 156
              controller = controller.to_s unless controller.is_a?(Regexp)
              action     = action.to_s     unless action.is_a?(Regexp)
157

158
              if controller.blank? && segment_keys.exclude?("controller")
159 160
                raise ArgumentError, "missing :controller"
              end
J
Joshua Peek 已提交
161

162
              if action.blank? && segment_keys.exclude?("action")
163 164
                raise ArgumentError, "missing :action"
              end
J
Joshua Peek 已提交
165

166 167 168 169
              { :controller => controller, :action => action }.tap do |hash|
                hash.delete(:controller) if hash[:controller].blank?
                hash.delete(:action)     if hash[:action].blank?
              end
170 171
            end
          end
172

173
          def blocks
A
Aaron Patterson 已提交
174 175
            block = @scope[:blocks] || []

176
            if @options[:constraints].present? && !@options[:constraints].is_a?(Hash)
A
Aaron Patterson 已提交
177
              block << @options[:constraints]
178
            end
J
Joshua Peek 已提交
179

A
Aaron Patterson 已提交
180
            block
181
          end
J
Joshua Peek 已提交
182

183 184 185
          def constraints
            @constraints ||= requirements.reject { |k, v| segment_keys.include?(k.to_s) || k == :controller }
          end
186

187 188 189 190 191 192
          def request_method_condition
            if via = @options[:via]
              via = Array(via).map { |m| m.to_s.upcase }
              { :request_method => Regexp.union(*via) }
            else
              { }
193
            end
194
          end
J
Joshua Peek 已提交
195

196 197
          def segment_keys
            @segment_keys ||= Rack::Mount::RegexpWithNamedGroups.new(
198 199
              Rack::Mount::Strexp.compile(@path, requirements, SEPARATORS)
            ).names
200
          end
201

202 203 204
          def to
            @options[:to]
          end
J
Joshua Peek 已提交
205

206
          def default_controller
207
            if @options[:controller]
208
              @options[:controller]
209
            elsif @scope[:controller]
210
              @scope[:controller]
211
            end
212
          end
213 214 215

          def default_action
            if @options[:action]
216
              @options[:action]
217 218
            elsif @scope[:action]
              @scope[:action]
219 220
            end
          end
221
      end
222

223
      # Invokes Rack::Mount::Utils.normalize path and ensure that
224 225
      # (:locale) becomes (/:locale) instead of /(:locale). Except
      # for root cases, where the latter is the correct one.
226 227
      def self.normalize_path(path)
        path = Rack::Mount::Utils.normalize_path(path)
228
        path.gsub!(%r{/(\(+)/?}, '\1/') unless path =~ %r{^/\(+[^/]+\)$}
229 230 231
        path
      end

232 233 234 235
      def self.normalize_name(name)
        normalize_path(name)[1..-1].gsub("/", "_")
      end

236
      module Base
237
        def initialize(set) #:nodoc:
238 239
          @set = set
        end
240

241 242 243 244 245
        # You can specify what Rails should route "/" to with the root method:
        #
        #   root :to => 'pages#main'
        #
        # You should put the root route at the end of <tt>config/routes.rb</tt>.
246 247 248
        def root(options = {})
          match '/', options.reverse_merge(:as => :root)
        end
249

250 251 252 253 254 255 256 257 258
        # When you set up a regular route, you supply a series of symbols that
        # Rails maps to parts of an incoming HTTP request.
        #
        #   match ':controller/:action/:id/:user_id'
        #
        # Two of these symbols are special: :controller maps to the name of a
        # controller in your application, and :action maps to the name of an
        # action within that controller. Anything other than :controller or
        # :action will be available to the action as part of params.
259 260
        def match(path, options=nil)
          mapping = Mapping.new(@set, @scope, path, options || {}).to_route
261
          @set.add_route(*mapping)
262 263
          self
        end
264

265 266 267 268 269 270 271 272 273 274 275
        def mount(app, options = nil)
          if options
            path = options.delete(:at)
          else
            options = app
            app, path = options.find { |k, v| k.respond_to?(:call) }
            options.delete(app) if app
          end

          raise "A rack application must be specified" unless path

276 277
          options[:as] ||= app_name(app)

278
          match(path, options.merge(:to => app, :anchor => false, :format => false))
279 280

          define_generate_prefix(app, options[:as])
281 282 283
          self
        end

284 285 286 287
        def default_url_options=(options)
          @set.default_url_options = options
        end
        alias_method :default_url_options, :default_url_options=
288

289 290 291 292 293 294
        def with_default_scope(scope, &block)
          scope(scope) do
            instance_exec(&block)
          end
        end

295 296 297
        private
          def app_name(app)
            return unless app.respond_to?(:routes)
298 299 300 301 302 303 304

            if app.respond_to?(:railtie_name)
              app.railtie_name
            else
              class_name = app.class.is_a?(Class) ? app.name : app.class.name
              ActiveSupport::Inflector.underscore(class_name).gsub("/", "_")
            end
305 306 307 308 309 310
          end

          def define_generate_prefix(app, name)
            return unless app.respond_to?(:routes)

            _route = @set.named_routes.routes[name.to_sym]
P
Piotr Sarnacki 已提交
311 312
            _routes = @set
            app.routes.define_mounted_helper(name)
313 314
            app.routes.class_eval do
              define_method :_generate_prefix do |options|
P
Piotr Sarnacki 已提交
315
                prefix_options = options.slice(*_route.segment_keys)
316 317
                # we must actually delete prefix segment keys to avoid passing them to next url_for
                _route.segment_keys.each { |k| options.delete(k) }
P
Piotr Sarnacki 已提交
318
                _routes.url_helpers.send("#{name}_path", prefix_options)
319 320 321
              end
            end
          end
322 323 324
      end

      module HttpHelpers
325
        # Define a route that only recognizes HTTP GET.
326 327 328 329
        def get(*args, &block)
          map_method(:get, *args, &block)
        end

330
        # Define a route that only recognizes HTTP POST.
331 332 333 334
        def post(*args, &block)
          map_method(:post, *args, &block)
        end

335
        # Define a route that only recognizes HTTP PUT.
336 337 338 339
        def put(*args, &block)
          map_method(:put, *args, &block)
        end

340
        # Define a route that only recognizes HTTP DELETE.
341 342 343 344
        def delete(*args, &block)
          map_method(:delete, *args, &block)
        end

345 346 347
        # Redirect any path to another path:
        #
        #   match "/stories" => redirect("/posts")
348
        def redirect(*args)
349 350
          options = args.last.is_a?(Hash) ? args.pop : {}

351
          path      = args.shift || Proc.new
A
Aaron Patterson 已提交
352
          path_proc = path.is_a?(Proc) ? path : proc { |params| (params.empty? || !path.match(/%\{\w*\}/)) ? path : (path % params) }
353
          status    = options[:status] || 301
354 355

          lambda do |env|
356
            req = Request.new(env)
357 358 359 360 361

            params = [req.symbolized_path_parameters]
            params << req if path_proc.arity > 1

            uri = URI.parse(path_proc.call(*params))
362 363
            uri.scheme ||= req.scheme
            uri.host   ||= req.host
364
            uri.port   ||= req.port unless req.standard_port?
365

366 367
            body = %(<html><body>You are being <a href="#{ERB::Util.h(uri.to_s)}">redirected</a>.</body></html>)

368 369 370 371 372
            headers = {
              'Location' => uri.to_s,
              'Content-Type' => 'text/html',
              'Content-Length' => body.length.to_s
            }
373

374
            [ status, headers, [body] ]
375
          end
376 377 378 379 380 381 382 383 384 385 386 387
        end

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

388 389 390 391 392 393 394 395 396
      # You may wish to organize groups of controllers under a namespace.
      # Most commonly, you might group a number of administrative controllers
      # under an +admin+ namespace. You would place these controllers under
      # the app/controllers/admin directory, and you can group them together
      # in your router:
      #
      #   namespace "admin" do
      #     resources :posts, :comments
      #   end
397
      #
398 399
      # This will create a number of routes for each of the posts and comments
      # controller. For Admin::PostsController, Rails will create:
400
      #
401 402 403 404 405 406 407
      #   GET	    /admin/photos
      #   GET	    /admin/photos/new
      #   POST	  /admin/photos
      #   GET	    /admin/photos/1
      #   GET	    /admin/photos/1/edit
      #   PUT	    /admin/photos/1
      #   DELETE  /admin/photos/1
408
      #
409 410
      # If you want to route /photos (without the prefix /admin) to
      # Admin::PostsController, you could use
411
      #
412 413 414 415 416
      #   scope :module => "admin" do
      #     resources :posts, :comments
      #   end
      #
      # or, for a single case
417
      #
418
      #   resources :posts, :module => "admin"
419
      #
420 421
      # If you want to route /admin/photos to PostsController
      # (without the Admin:: module prefix), you could use
422
      #
423 424 425 426 427
      #   scope "/admin" do
      #     resources :posts, :comments
      #   end
      #
      # or, for a single case
428
      #
429 430 431 432 433
      #   resources :posts, :path => "/admin"
      #
      # In each of these cases, the named routes remain the same as if you did
      # not use scope. In the last case, the following paths map to
      # PostsController:
434
      #
435 436 437 438 439 440 441
      #   GET	    /admin/photos
      #   GET	    /admin/photos/new
      #   POST	  /admin/photos
      #   GET	    /admin/photos/1
      #   GET	    /admin/photos/1/edit
      #   PUT	    /admin/photos/1
      #   DELETE  /admin/photos/1
442
      module Scoping
443
        def initialize(*args) #:nodoc:
444 445 446 447
          @scope = {}
          super
        end

448 449 450 451 452 453
        # Used to route <tt>/photos</tt> (without the prefix <tt>/admin</tt>)
        # to Admin::PostsController:
        #
        #   scope :module => "admin" do
        #     resources :posts
        #   end
454 455
        def scope(*args)
          options = args.extract_options!
456
          options = options.dup
457

458
          options[:path] = args.first if args.first.is_a?(String)
459
          recover = {}
460

461 462 463
          options[:constraints] ||= {}
          unless options[:constraints].is_a?(Hash)
            block, options[:constraints] = options[:constraints], {}
464
          end
465

466 467 468 469 470
          scope_options.each do |option|
            if value = options.delete(option)
              recover[option] = @scope[option]
              @scope[option]  = send("merge_#{option}_scope", @scope[option], value)
            end
471 472
          end

473 474
          recover[:block] = @scope[:blocks]
          @scope[:blocks] = merge_blocks_scope(@scope[:blocks], block)
475

476 477
          recover[:options] = @scope[:options]
          @scope[:options]  = merge_options_scope(@scope[:options], options)
478 479 480 481

          yield
          self
        ensure
482 483 484 485 486 487
          scope_options.each do |option|
            @scope[option] = recover[option] if recover.has_key?(option)
          end

          @scope[:options] = recover[:options]
          @scope[:blocks]  = recover[:block]
488 489
        end

490 491 492
        def controller(controller, options={})
          options[:controller] = controller
          scope(options) { yield }
493 494
        end

495
        def namespace(path, options = {})
496
          path = path.to_s
497 498 499
          options = { :path => path, :as => path, :module => path,
                      :shallow_path => path, :shallow_prefix => path }.merge!(options)
          scope(options) { yield }
500 501 502 503 504 505
        end

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

506 507 508 509
        def defaults(defaults = {})
          scope(:defaults => defaults) { yield }
        end

510 511 512 513 514 515
        private
          def scope_options
            @scope_options ||= private_methods.grep(/^merge_(.+)_scope$/) { $1.to_sym }
          end

          def merge_path_scope(parent, child)
516
            Mapper.normalize_path("#{parent}/#{child}")
517 518
          end

519 520 521 522
          def merge_shallow_path_scope(parent, child)
            Mapper.normalize_path("#{parent}/#{child}")
          end

523
          def merge_as_scope(parent, child)
524
            parent ? "#{parent}_#{child}" : child
525 526
          end

527 528 529 530
          def merge_shallow_prefix_scope(parent, child)
            parent ? "#{parent}_#{child}" : child
          end

531
          def merge_module_scope(parent, child)
532 533 534 535
            parent ? "#{parent}/#{child}" : child
          end

          def merge_controller_scope(parent, child)
536
            child
537 538
          end

539
          def merge_path_names_scope(parent, child)
540 541 542 543 544 545 546
            merge_options_scope(parent, child)
          end

          def merge_constraints_scope(parent, child)
            merge_options_scope(parent, child)
          end

547 548 549 550
          def merge_defaults_scope(parent, child)
            merge_options_scope(parent, child)
          end

551
          def merge_blocks_scope(parent, child)
552 553 554
            merged = parent ? parent.dup : []
            merged << child if child
            merged
555 556 557
          end

          def merge_options_scope(parent, child)
558
            (parent || {}).except(*override_keys(child)).merge(child)
559
          end
560 561 562 563

          def merge_shallow_scope(parent, child)
            child ? true : false
          end
564 565 566 567

          def override_keys(child)
            child.key?(:only) || child.key?(:except) ? [:only, :except] : []
          end
568 569
      end

570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
      # Resource routing allows you to quickly declare all of the common routes
      # for a given resourceful controller. Instead of declaring separate routes
      # for your +index+, +show+, +new+, +edit+, +create+, +update+ and +destroy+
      # actions, a resourceful route declares them in a single line of code:
      #
      #  resources :photos
      #
      # Sometimes, you have a resource that clients always look up without
      # referencing an ID. A common example, /profile always shows the profile of
      # the currently logged in user. In this case, you can use a singular resource
      # to map /profile (rather than /profile/:id) to the show action.
      #
      #  resource :profile
      #
      # It's common to have resources that are logically children of other
      # resources:
      #
      #   resources :magazines do
      #     resources :ads
      #   end
      #
      # You may wish to organize groups of controllers under a namespace. Most
      # commonly, you might group a number of administrative controllers under
      # an +admin+ namespace. You would place these controllers under the
      # app/controllers/admin directory, and you can group them together in your
      # router:
      #
      #   namespace "admin" do
      #     resources :posts, :comments
      #   end
      #
J
Joshua Peek 已提交
601
      module Resources
602 603
        # CANONICAL_ACTIONS holds all actions that does not need a prefix or
        # a path appended since they fit properly in their scope level.
604 605 606
        VALID_ON_OPTIONS  = [:new, :collection, :member]
        RESOURCE_OPTIONS  = [:as, :controller, :path, :only, :except]
        CANONICAL_ACTIONS = %w(index create new show update destroy)
607

608
        class Resource #:nodoc:
609
          DEFAULT_ACTIONS = [:index, :create, :new, :show, :update, :destroy, :edit]
610

611
          attr_reader :controller, :path, :options
612 613

          def initialize(entities, options = {})
614
            @name       = entities.to_s
615
            @path       = (options.delete(:path) || @name).to_s
616
            @controller = (options.delete(:controller) || @name).to_s
617
            @as         = options.delete(:as)
618
            @options    = options
619 620
          end

621
          def default_actions
622
            self.class::DEFAULT_ACTIONS
623 624
          end

625
          def actions
626
            if only = @options[:only]
627
              Array(only).map(&:to_sym)
628
            elsif except = @options[:except]
629 630 631 632 633 634
              default_actions - Array(except).map(&:to_sym)
            else
              default_actions
            end
          end

635
          def name
636
            @as || @name
637 638
          end

639
          def plural
640
            @plural ||= name.to_s
641 642 643
          end

          def singular
644
            @singular ||= name.to_s.singularize
645 646
          end

647
          alias :member_name :singular
648

649
          # Checks for uncountable plurals, and appends "_index" if they're.
650
          def collection_name
651
            singular == plural ? "#{plural}_index" : plural
652 653
          end

654
          def resource_scope
655
            { :controller => controller }
656 657
          end

658
          alias :collection_scope :path
659 660

          def member_scope
661
            "#{path}/:id"
662 663
          end

664
          def new_scope(new_path)
665
            "#{path}/#{new_path}"
666 667 668
          end

          def nested_scope
669
            "#{path}/:#{singular}_id"
670
          end
671

672 673 674
        end

        class SingletonResource < Resource #:nodoc:
675
          DEFAULT_ACTIONS = [:show, :create, :update, :destroy, :new, :edit]
676

677
          def initialize(entities, options)
678
            @as         = nil
679
            @name       = entities.to_s
680
            @path       = (options.delete(:path) || @name).to_s
681
            @controller = (options.delete(:controller) || plural).to_s
682 683 684 685
            @as         = options.delete(:as)
            @options    = options
          end

686 687
          def plural
            @plural ||= name.to_s.pluralize
688 689
          end

690 691
          def singular
            @singular ||= name.to_s
692
          end
693 694 695 696 697 698

          alias :member_name :singular
          alias :collection_name :singular

          alias :member_scope :path
          alias :nested_scope :path
699 700
        end

701
        def initialize(*args) #:nodoc:
702
          super
703
          @scope[:path_names] = @set.resources_path_names
704 705
        end

706 707 708 709
        def resources_path_names(options)
          @scope[:path_names].merge!(options)
        end

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
        # Sometimes, you have a resource that clients always look up without
        # referencing an ID. A common example, /profile always shows the
        # profile of the currently logged in user. In this case, you can use
        # a singular resource to map /profile (rather than /profile/:id) to
        # the show action:
        #
        #   resource :geocoder
        #
        # creates six different routes in your application, all mapping to
        # the GeoCoders controller (note that the controller is named after
        # the plural):
        #
        #   GET     /geocoder/new
        #   POST    /geocoder
        #   GET     /geocoder
        #   GET     /geocoder/edit
        #   PUT     /geocoder
        #   DELETE  /geocoder
J
Joshua Peek 已提交
728
        def resource(*resources, &block)
J
Joshua Peek 已提交
729
          options = resources.extract_options!
J
Joshua Peek 已提交
730

731
          if apply_common_behavior_for(:resource, resources, options, &block)
732 733 734
            return self
          end

735 736
          resource_scope(SingletonResource.new(resources.pop, options)) do
            yield if block_given?
737

738
            collection do
739
              post :create
740
            end if parent_resource.actions.include?(:create)
741

742
            new do
743
              get :new
744
            end if parent_resource.actions.include?(:new)
745

746
            member do
747
              get    :edit if parent_resource.actions.include?(:edit)
748 749 750
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
751 752 753
            end
          end

J
Joshua Peek 已提交
754
          self
755 756
        end

757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
        # In Rails, a resourceful route provides a mapping between HTTP verbs
        # and URLs and controller actions. By convention, each action also maps
        # to particular CRUD operations in a database. A single entry in the
        # routing file, such as
        #
        #   resources :photos
        #
        # creates seven different routes in your application, all mapping to
        # the Photos controller:
        #
        #   GET     /photos/new
        #   POST    /photos
        #   GET     /photos/:id
        #   GET     /photos/:id/edit
        #   PUT     /photos/:id
        #   DELETE  /photos/:id
J
Joshua Peek 已提交
773
        def resources(*resources, &block)
J
Joshua Peek 已提交
774
          options = resources.extract_options!
775

776
          if apply_common_behavior_for(:resources, resources, options, &block)
777 778 779
            return self
          end

780
          resource_scope(Resource.new(resources.pop, options)) do
781
            yield if block_given?
J
Joshua Peek 已提交
782

783
            collection do
784 785
              get  :index if parent_resource.actions.include?(:index)
              post :create if parent_resource.actions.include?(:create)
786
            end
787

788
            new do
789
              get :new
790
            end if parent_resource.actions.include?(:new)
791

792
            member do
793
              get    :edit if parent_resource.actions.include?(:edit)
794 795 796
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
797 798 799
            end
          end

J
Joshua Peek 已提交
800
          self
801 802
        end

803 804 805 806 807 808 809 810 811 812 813 814
        # To add a route to the collection:
        #
        #   resources :photos do
        #     collection do
        #       get 'search'
        #     end
        #   end
        #
        # This will enable Rails to recognize paths such as <tt>/photos/search</tt>
        # with GET, and route to the search action of PhotosController. It will also
        # create the <tt>search_photos_url</tt> and <tt>search_photos_path</tt>
        # route helpers.
J
Joshua Peek 已提交
815
        def collection
816 817
          unless resource_scope?
            raise ArgumentError, "can't use collection outside resource(s) scope"
818 819
          end

820 821 822 823
          with_scope_level(:collection) do
            scope(parent_resource.collection_scope) do
              yield
            end
J
Joshua Peek 已提交
824
          end
825
        end
J
Joshua Peek 已提交
826

827 828 829 830 831 832 833 834 835 836 837
        # To add a member route, add a member block into the resource block:
        #
        #   resources :photos do
        #     member do
        #       get 'preview'
        #     end
        #   end
        #
        # This will recognize <tt>/photos/1/preview</tt> with GET, and route to the
        # preview action of PhotosController. It will also create the
        # <tt>preview_photo_url</tt> and <tt>preview_photo_path</tt> helpers.
J
Joshua Peek 已提交
838
        def member
839 840
          unless resource_scope?
            raise ArgumentError, "can't use member outside resource(s) scope"
J
Joshua Peek 已提交
841
          end
J
Joshua Peek 已提交
842

843 844 845 846
          with_scope_level(:member) do
            scope(parent_resource.member_scope) do
              yield
            end
847 848 849 850 851 852 853
          end
        end

        def new
          unless resource_scope?
            raise ArgumentError, "can't use new outside resource(s) scope"
          end
854

855 856 857 858
          with_scope_level(:new) do
            scope(parent_resource.new_scope(action_path(:new))) do
              yield
            end
J
Joshua Peek 已提交
859
          end
J
Joshua Peek 已提交
860 861
        end

862
        def nested
863 864
          unless resource_scope?
            raise ArgumentError, "can't use nested outside resource(s) scope"
865 866 867
          end

          with_scope_level(:nested) do
868
            if shallow?
869
              with_exclusive_scope do
870
                if @scope[:shallow_path].blank?
871
                  scope(parent_resource.nested_scope, nested_options) { yield }
872
                else
873
                  scope(@scope[:shallow_path], :as => @scope[:shallow_prefix]) do
874
                    scope(parent_resource.nested_scope, nested_options) { yield }
875 876 877 878
                  end
                end
              end
            else
879
              scope(parent_resource.nested_scope, nested_options) { yield }
880 881 882 883
            end
          end
        end

884
        def namespace(path, options = {})
885
          if resource_scope?
886 887 888 889 890 891
            nested { super }
          else
            super
          end
        end

892 893 894 895 896 897
        def shallow
          scope(:shallow => true) do
            yield
          end
        end

898 899 900 901
        def shallow?
          parent_resource.instance_of?(Resource) && @scope[:shallow]
        end

J
Joshua Peek 已提交
902
        def match(*args)
903
          options = args.extract_options!.dup
904 905
          options[:anchor] = true unless options.key?(:anchor)

906
          if args.length > 1
907
            args.each { |path| match(path, options.dup) }
908 909 910
            return self
          end

911 912
          on = options.delete(:on)
          if VALID_ON_OPTIONS.include?(on)
913
            args.push(options)
914 915 916
            return send(on){ match(*args) }
          elsif on
            raise ArgumentError, "Unknown scope #{on.inspect} given to :on"
917 918
          end

919 920 921 922
          if @scope[:scope_level] == :resources
            args.push(options)
            return nested { match(*args) }
          elsif @scope[:scope_level] == :resource
923
            args.push(options)
J
Joshua Peek 已提交
924 925
            return member { match(*args) }
          end
J
Joshua Peek 已提交
926

927
          action = args.first
928
          path = path_for_action(action, options.delete(:path))
929

930 931 932
          if action.to_s =~ /^[\w\/]+$/
            options[:action] ||= action unless action.to_s.include?("/")
          else
933 934 935 936 937 938 939
            action = nil
          end

          if options.key?(:as) && !options[:as]
            options.delete(:as)
          else
            options[:as] = name_for_action(options[:as], action)
J
Joshua Peek 已提交
940
          end
J
Joshua Peek 已提交
941

942
          super(path, options)
J
Joshua Peek 已提交
943 944
        end

945
        def root(options={})
946
          if @scope[:scope_level] == :resources
947 948
            with_scope_level(:root) do
              scope(parent_resource.path) do
949 950 951 952 953 954
                super(options)
              end
            end
          else
            super(options)
          end
955 956
        end

957
        protected
958

959
          def parent_resource #:nodoc:
960 961 962
            @scope[:scope_level_resource]
          end

963
          def apply_common_behavior_for(method, resources, options, &block)
964 965 966 967 968
            if resources.length > 1
              resources.each { |r| send(method, r, options, &block) }
              return true
            end

969 970 971 972 973
            if resource_scope?
              nested { send(method, resources.pop, options, &block) }
              return true
            end

974
            options.keys.each do |k|
975 976 977
              (options[:constraints] ||= {})[k] = options.delete(k) if options[k].is_a?(Regexp)
            end

978 979 980
            scope_options = options.slice!(*RESOURCE_OPTIONS)
            unless scope_options.empty?
              scope(scope_options) do
981 982 983 984 985
                send(method, resources.pop, options, &block)
              end
              return true
            end

986 987 988 989
            unless action_options?(options)
              options.merge!(scope_action_options) if scope_action_options?
            end

990 991 992
            false
          end

993 994 995 996 997 998 999 1000 1001 1002 1003 1004
          def action_options?(options)
            options[:only] || options[:except]
          end

          def scope_action_options?
            @scope[:options].is_a?(Hash) && (@scope[:options][:only] || @scope[:options][:except])
          end

          def scope_action_options
            @scope[:options].slice(:only, :except)
          end

1005 1006 1007 1008
          def resource_scope?
            [:resource, :resources].include?(@scope[:scope_level])
          end

1009 1010 1011 1012
          def resource_method_scope?
            [:collection, :member, :new].include?(@scope[:scope_level])
          end

1013
          def with_exclusive_scope
1014
            begin
1015 1016
              old_name_prefix, old_path = @scope[:as], @scope[:path]
              @scope[:as], @scope[:path] = nil, nil
1017

1018 1019 1020
              with_scope_level(:exclusive) do
                yield
              end
1021
            ensure
1022
              @scope[:as], @scope[:path] = old_name_prefix, old_path
1023 1024 1025
            end
          end

1026
          def with_scope_level(kind, resource = parent_resource)
J
Joshua Peek 已提交
1027
            old, @scope[:scope_level] = @scope[:scope_level], kind
1028
            old_resource, @scope[:scope_level_resource] = @scope[:scope_level_resource], resource
J
Joshua Peek 已提交
1029 1030 1031
            yield
          ensure
            @scope[:scope_level] = old
1032
            @scope[:scope_level_resource] = old_resource
J
Joshua Peek 已提交
1033
          end
1034 1035 1036

          def resource_scope(resource)
            with_scope_level(resource.is_a?(SingletonResource) ? :resource : :resources, resource) do
1037
              scope(parent_resource.resource_scope) do
1038 1039 1040 1041 1042
                yield
              end
            end
          end

1043 1044 1045 1046 1047 1048 1049 1050
          def nested_options
            {}.tap do |options|
              options[:as] = parent_resource.member_name
              options[:constraints] = { "#{parent_resource.singular}_id".to_sym => id_constraint } if id_constraint?
            end
          end

          def id_constraint?
1051
            @scope[:constraints] && @scope[:constraints][:id].is_a?(Regexp)
1052 1053 1054
          end

          def id_constraint
1055
            @scope[:constraints][:id]
1056 1057
          end

1058
          def canonical_action?(action, flag)
1059
            flag && resource_method_scope? && CANONICAL_ACTIONS.include?(action.to_s)
1060 1061 1062
          end

          def shallow_scoping?
1063
            shallow? && @scope[:scope_level] == :member
1064 1065
          end

1066
          def path_for_action(action, path)
1067
            prefix = shallow_scoping? ?
1068 1069
              "#{@scope[:shallow_path]}/#{parent_resource.path}/:id" : @scope[:path]

1070 1071
            path = if canonical_action?(action, path.blank?)
              prefix.to_s
1072
            else
1073
              "#{prefix}/#{action_path(action, path)}"
1074 1075 1076
            end
          end

1077 1078
          def action_path(name, path = nil)
            path || @scope[:path_names][name.to_sym] || name.to_s
1079 1080
          end

1081 1082
          def prefix_name_for_action(as, action)
            if as
1083
              as.to_s
1084
            elsif !canonical_action?(action, @scope[:scope_level])
1085
              action.to_s
1086
            end
1087 1088
          end

1089 1090
          def name_for_action(as, action)
            prefix = prefix_name_for_action(as, action)
1091
            prefix = Mapper.normalize_name(prefix) if prefix
1092 1093 1094 1095 1096
            name_prefix = @scope[:as]

            if parent_resource
              collection_name = parent_resource.collection_name
              member_name = parent_resource.member_name
1097
            end
1098

1099
            name = case @scope[:scope_level]
1100 1101
            when :nested
              [member_name, prefix]
1102
            when :collection
1103
              [prefix, name_prefix, collection_name]
1104
            when :new
1105 1106 1107 1108 1109
              [prefix, :new, name_prefix, member_name]
            when :member
              [prefix, shallow_scoping? ? @scope[:shallow_prefix] : name_prefix, member_name]
            when :root
              [name_prefix, collection_name, prefix]
1110
            else
1111
              [name_prefix, member_name, prefix]
1112
            end
1113

1114
            candidate = name.select(&:present?).join("_").presence
1115
            candidate unless as.nil? && @set.routes.find { |r| r.name == candidate }
1116
          end
J
Joshua Peek 已提交
1117
      end
J
Joshua Peek 已提交
1118

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
      module Shorthand
        def match(*args)
          if args.size == 1 && args.last.is_a?(Hash)
            options  = args.pop
            path, to = options.find { |name, value| name.is_a?(String) }
            options.merge!(:to => to).delete(path)
            super(path, options)
          else
            super
          end
        end
      end

1132 1133 1134 1135
      include Base
      include HttpHelpers
      include Scoping
      include Resources
1136
      include Shorthand
J
Joshua Peek 已提交
1137 1138
    end
  end
J
Joshua Peek 已提交
1139
end