mapper.rb 36.2 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 330
        # For supported arguments, see +match+.
        #
        # Example:
        #
        # get 'bacon', :to => 'food#bacon'
331 332 333 334
        def get(*args, &block)
          map_method(:get, *args, &block)
        end

335
        # Define a route that only recognizes HTTP POST.
336 337 338 339 340
        # For supported arguments, see +match+.
        #
        # Example:
        #
        # post 'bacon', :to => 'food#bacon'
341 342 343 344
        def post(*args, &block)
          map_method(:post, *args, &block)
        end

345
        # Define a route that only recognizes HTTP PUT.
346 347 348 349 350
        # For supported arguments, see +match+.
        #
        # Example:
        #
        # put 'bacon', :to => 'food#bacon'
351 352 353 354
        def put(*args, &block)
          map_method(:put, *args, &block)
        end

355 356 357 358 359 360
        # Define a route that only recognizes HTTP PUT.
        # For supported arguments, see +match+.
        #
        # Example:
        #
        # delete 'broccoli', :to => 'food#broccoli'
361 362 363 364
        def delete(*args, &block)
          map_method(:delete, *args, &block)
        end

365 366 367
        # Redirect any path to another path:
        #
        #   match "/stories" => redirect("/posts")
368
        def redirect(*args)
369 370
          options = args.last.is_a?(Hash) ? args.pop : {}

371
          path      = args.shift || Proc.new
A
Aaron Patterson 已提交
372
          path_proc = path.is_a?(Proc) ? path : proc { |params| (params.empty? || !path.match(/%\{\w*\}/)) ? path : (path % params) }
373
          status    = options[:status] || 301
374 375

          lambda do |env|
376
            req = Request.new(env)
377 378 379 380 381

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

            uri = URI.parse(path_proc.call(*params))
382 383
            uri.scheme ||= req.scheme
            uri.host   ||= req.host
384
            uri.port   ||= req.port unless req.standard_port?
385

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

388 389 390 391 392
            headers = {
              'Location' => uri.to_s,
              'Content-Type' => 'text/html',
              'Content-Length' => body.length.to_s
            }
393

394
            [ status, headers, [body] ]
395
          end
396 397 398 399 400 401 402 403 404 405 406 407
        end

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

408 409 410 411 412 413 414 415 416
      # 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
417
      #
418 419
      # This will create a number of routes for each of the posts and comments
      # controller. For Admin::PostsController, Rails will create:
420
      #
421 422 423 424 425 426 427
      #   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
428
      #
429
      # If you want to route /posts (without the prefix /admin) to
430
      # Admin::PostsController, you could use
431
      #
432
      #   scope :module => "admin" do
433
      #     resources :posts
434 435 436
      #   end
      #
      # or, for a single case
437
      #
438
      #   resources :posts, :module => "admin"
439
      #
440
      # If you want to route /admin/posts to PostsController
441
      # (without the Admin:: module prefix), you could use
442
      #
443
      #   scope "/admin" do
444
      #     resources :posts
445 446 447
      #   end
      #
      # or, for a single case
448
      #
449 450 451 452 453
      #   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:
454
      #
455 456 457 458 459 460 461
      #   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
462
      module Scoping
463
        def initialize(*args) #:nodoc:
464 465 466 467
          @scope = {}
          super
        end

468 469 470
        # Used to route <tt>/photos</tt> (without the prefix <tt>/admin</tt>)
        # to Admin::PostsController:
        #
471 472
        # Examples:
        #
473 474 475
        #   scope :module => "admin" do
        #     resources :posts
        #   end
476 477
        def scope(*args)
          options = args.extract_options!
478
          options = options.dup
479

480
          options[:path] = args.first if args.first.is_a?(String)
481
          recover = {}
482

483 484 485
          options[:constraints] ||= {}
          unless options[:constraints].is_a?(Hash)
            block, options[:constraints] = options[:constraints], {}
486
          end
487

488 489 490 491 492
          scope_options.each do |option|
            if value = options.delete(option)
              recover[option] = @scope[option]
              @scope[option]  = send("merge_#{option}_scope", @scope[option], value)
            end
493 494
          end

495 496
          recover[:block] = @scope[:blocks]
          @scope[:blocks] = merge_blocks_scope(@scope[:blocks], block)
497

498 499
          recover[:options] = @scope[:options]
          @scope[:options]  = merge_options_scope(@scope[:options], options)
500 501 502 503

          yield
          self
        ensure
504 505 506 507 508 509
          scope_options.each do |option|
            @scope[option] = recover[option] if recover.has_key?(option)
          end

          @scope[:options] = recover[:options]
          @scope[:blocks]  = recover[:block]
510 511
        end

512 513 514
        def controller(controller, options={})
          options[:controller] = controller
          scope(options) { yield }
515 516
        end

517
        def namespace(path, options = {})
518
          path = path.to_s
519 520 521
          options = { :path => path, :as => path, :module => path,
                      :shallow_path => path, :shallow_prefix => path }.merge!(options)
          scope(options) { yield }
522 523 524 525 526 527
        end

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

528 529 530 531
        def defaults(defaults = {})
          scope(:defaults => defaults) { yield }
        end

532 533 534 535 536 537
        private
          def scope_options
            @scope_options ||= private_methods.grep(/^merge_(.+)_scope$/) { $1.to_sym }
          end

          def merge_path_scope(parent, child)
538
            Mapper.normalize_path("#{parent}/#{child}")
539 540
          end

541 542 543 544
          def merge_shallow_path_scope(parent, child)
            Mapper.normalize_path("#{parent}/#{child}")
          end

545
          def merge_as_scope(parent, child)
546
            parent ? "#{parent}_#{child}" : child
547 548
          end

549 550 551 552
          def merge_shallow_prefix_scope(parent, child)
            parent ? "#{parent}_#{child}" : child
          end

553
          def merge_module_scope(parent, child)
554 555 556 557
            parent ? "#{parent}/#{child}" : child
          end

          def merge_controller_scope(parent, child)
558
            child
559 560
          end

561
          def merge_path_names_scope(parent, child)
562 563 564 565 566 567 568
            merge_options_scope(parent, child)
          end

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

569 570 571 572
          def merge_defaults_scope(parent, child)
            merge_options_scope(parent, child)
          end

573
          def merge_blocks_scope(parent, child)
574 575 576
            merged = parent ? parent.dup : []
            merged << child if child
            merged
577 578 579
          end

          def merge_options_scope(parent, child)
580
            (parent || {}).except(*override_keys(child)).merge(child)
581
          end
582 583 584 585

          def merge_shallow_scope(parent, child)
            child ? true : false
          end
586 587 588 589

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

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
      # 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 已提交
623
      module Resources
624 625
        # CANONICAL_ACTIONS holds all actions that does not need a prefix or
        # a path appended since they fit properly in their scope level.
626 627 628
        VALID_ON_OPTIONS  = [:new, :collection, :member]
        RESOURCE_OPTIONS  = [:as, :controller, :path, :only, :except]
        CANONICAL_ACTIONS = %w(index create new show update destroy)
629

630
        class Resource #:nodoc:
631
          DEFAULT_ACTIONS = [:index, :create, :new, :show, :update, :destroy, :edit]
632

633
          attr_reader :controller, :path, :options
634 635

          def initialize(entities, options = {})
636
            @name       = entities.to_s
637
            @path       = (options.delete(:path) || @name).to_s
638
            @controller = (options.delete(:controller) || @name).to_s
639
            @as         = options.delete(:as)
640
            @options    = options
641 642
          end

643
          def default_actions
644
            self.class::DEFAULT_ACTIONS
645 646
          end

647
          def actions
648
            if only = @options[:only]
649
              Array(only).map(&:to_sym)
650
            elsif except = @options[:except]
651 652 653 654 655 656
              default_actions - Array(except).map(&:to_sym)
            else
              default_actions
            end
          end

657
          def name
658
            @as || @name
659 660
          end

661
          def plural
662
            @plural ||= name.to_s
663 664 665
          end

          def singular
666
            @singular ||= name.to_s.singularize
667 668
          end

669
          alias :member_name :singular
670

671
          # Checks for uncountable plurals, and appends "_index" if they're.
672
          def collection_name
673
            singular == plural ? "#{plural}_index" : plural
674 675
          end

676
          def resource_scope
677
            { :controller => controller }
678 679
          end

680
          alias :collection_scope :path
681 682

          def member_scope
683
            "#{path}/:id"
684 685
          end

686
          def new_scope(new_path)
687
            "#{path}/#{new_path}"
688 689 690
          end

          def nested_scope
691
            "#{path}/:#{singular}_id"
692
          end
693

694 695 696
        end

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

699
          def initialize(entities, options)
700
            @as         = nil
701
            @name       = entities.to_s
702
            @path       = (options.delete(:path) || @name).to_s
703
            @controller = (options.delete(:controller) || plural).to_s
704 705 706 707
            @as         = options.delete(:as)
            @options    = options
          end

708 709
          def plural
            @plural ||= name.to_s.pluralize
710 711
          end

712 713
          def singular
            @singular ||= name.to_s
714
          end
715 716 717 718 719 720

          alias :member_name :singular
          alias :collection_name :singular

          alias :member_scope :path
          alias :nested_scope :path
721 722
        end

723
        def initialize(*args) #:nodoc:
724
          super
725
          @scope[:path_names] = @set.resources_path_names
726 727
        end

728 729 730 731
        def resources_path_names(options)
          @scope[:path_names].merge!(options)
        end

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
        # 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 已提交
750
        def resource(*resources, &block)
J
Joshua Peek 已提交
751
          options = resources.extract_options!
J
Joshua Peek 已提交
752

753
          if apply_common_behavior_for(:resource, resources, options, &block)
754 755 756
            return self
          end

757 758
          resource_scope(SingletonResource.new(resources.pop, options)) do
            yield if block_given?
759

760
            collection do
761
              post :create
762
            end if parent_resource.actions.include?(:create)
763

764
            new do
765
              get :new
766
            end if parent_resource.actions.include?(:new)
767

768
            member do
769
              get    :edit if parent_resource.actions.include?(:edit)
770 771 772
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
773 774 775
            end
          end

J
Joshua Peek 已提交
776
          self
777 778
        end

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
        # 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 已提交
795
        def resources(*resources, &block)
J
Joshua Peek 已提交
796
          options = resources.extract_options!
797

798
          if apply_common_behavior_for(:resources, resources, options, &block)
799 800 801
            return self
          end

802
          resource_scope(Resource.new(resources.pop, options)) do
803
            yield if block_given?
J
Joshua Peek 已提交
804

805
            collection do
806 807
              get  :index if parent_resource.actions.include?(:index)
              post :create if parent_resource.actions.include?(:create)
808
            end
809

810
            new do
811
              get :new
812
            end if parent_resource.actions.include?(:new)
813

814
            member do
815
              get    :edit if parent_resource.actions.include?(:edit)
816 817 818
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
819 820 821
            end
          end

J
Joshua Peek 已提交
822
          self
823 824
        end

825 826 827 828 829 830 831 832 833 834 835 836
        # 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 已提交
837
        def collection
838 839
          unless resource_scope?
            raise ArgumentError, "can't use collection outside resource(s) scope"
840 841
          end

842 843 844 845
          with_scope_level(:collection) do
            scope(parent_resource.collection_scope) do
              yield
            end
J
Joshua Peek 已提交
846
          end
847
        end
J
Joshua Peek 已提交
848

849 850 851 852 853 854 855 856 857 858 859
        # 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 已提交
860
        def member
861 862
          unless resource_scope?
            raise ArgumentError, "can't use member outside resource(s) scope"
J
Joshua Peek 已提交
863
          end
J
Joshua Peek 已提交
864

865 866 867 868
          with_scope_level(:member) do
            scope(parent_resource.member_scope) do
              yield
            end
869 870 871 872 873 874 875
          end
        end

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

877 878 879 880
          with_scope_level(:new) do
            scope(parent_resource.new_scope(action_path(:new))) do
              yield
            end
J
Joshua Peek 已提交
881
          end
J
Joshua Peek 已提交
882 883
        end

884
        def nested
885 886
          unless resource_scope?
            raise ArgumentError, "can't use nested outside resource(s) scope"
887 888 889
          end

          with_scope_level(:nested) do
890
            if shallow?
891
              with_exclusive_scope do
892
                if @scope[:shallow_path].blank?
893
                  scope(parent_resource.nested_scope, nested_options) { yield }
894
                else
895
                  scope(@scope[:shallow_path], :as => @scope[:shallow_prefix]) do
896
                    scope(parent_resource.nested_scope, nested_options) { yield }
897 898 899 900
                  end
                end
              end
            else
901
              scope(parent_resource.nested_scope, nested_options) { yield }
902 903 904 905
            end
          end
        end

906
        def namespace(path, options = {})
907
          if resource_scope?
908 909 910 911 912 913
            nested { super }
          else
            super
          end
        end

914 915 916 917 918 919
        def shallow
          scope(:shallow => true) do
            yield
          end
        end

920 921 922 923
        def shallow?
          parent_resource.instance_of?(Resource) && @scope[:shallow]
        end

J
Joshua Peek 已提交
924
        def match(*args)
925
          options = args.extract_options!.dup
926 927
          options[:anchor] = true unless options.key?(:anchor)

928
          if args.length > 1
929
            args.each { |path| match(path, options.dup) }
930 931 932
            return self
          end

933 934
          on = options.delete(:on)
          if VALID_ON_OPTIONS.include?(on)
935
            args.push(options)
936 937 938
            return send(on){ match(*args) }
          elsif on
            raise ArgumentError, "Unknown scope #{on.inspect} given to :on"
939 940
          end

941 942 943 944
          if @scope[:scope_level] == :resources
            args.push(options)
            return nested { match(*args) }
          elsif @scope[:scope_level] == :resource
945
            args.push(options)
J
Joshua Peek 已提交
946 947
            return member { match(*args) }
          end
J
Joshua Peek 已提交
948

949
          action = args.first
950
          path = path_for_action(action, options.delete(:path))
951

952 953 954
          if action.to_s =~ /^[\w\/]+$/
            options[:action] ||= action unless action.to_s.include?("/")
          else
955 956 957 958 959 960 961
            action = nil
          end

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

964
          super(path, options)
J
Joshua Peek 已提交
965 966
        end

967
        def root(options={})
968
          if @scope[:scope_level] == :resources
969 970
            with_scope_level(:root) do
              scope(parent_resource.path) do
971 972 973 974 975 976
                super(options)
              end
            end
          else
            super(options)
          end
977 978
        end

979
        protected
980

981
          def parent_resource #:nodoc:
982 983 984
            @scope[:scope_level_resource]
          end

985
          def apply_common_behavior_for(method, resources, options, &block)
986 987 988 989 990
            if resources.length > 1
              resources.each { |r| send(method, r, options, &block) }
              return true
            end

991 992 993 994 995
            if resource_scope?
              nested { send(method, resources.pop, options, &block) }
              return true
            end

996
            options.keys.each do |k|
997 998 999
              (options[:constraints] ||= {})[k] = options.delete(k) if options[k].is_a?(Regexp)
            end

1000 1001 1002
            scope_options = options.slice!(*RESOURCE_OPTIONS)
            unless scope_options.empty?
              scope(scope_options) do
1003 1004 1005 1006 1007
                send(method, resources.pop, options, &block)
              end
              return true
            end

1008 1009 1010 1011
            unless action_options?(options)
              options.merge!(scope_action_options) if scope_action_options?
            end

1012 1013 1014
            false
          end

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
          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

1027 1028 1029 1030
          def resource_scope?
            [:resource, :resources].include?(@scope[:scope_level])
          end

1031 1032 1033 1034
          def resource_method_scope?
            [:collection, :member, :new].include?(@scope[:scope_level])
          end

1035
          def with_exclusive_scope
1036
            begin
1037 1038
              old_name_prefix, old_path = @scope[:as], @scope[:path]
              @scope[:as], @scope[:path] = nil, nil
1039

1040 1041 1042
              with_scope_level(:exclusive) do
                yield
              end
1043
            ensure
1044
              @scope[:as], @scope[:path] = old_name_prefix, old_path
1045 1046 1047
            end
          end

1048
          def with_scope_level(kind, resource = parent_resource)
J
Joshua Peek 已提交
1049
            old, @scope[:scope_level] = @scope[:scope_level], kind
1050
            old_resource, @scope[:scope_level_resource] = @scope[:scope_level_resource], resource
J
Joshua Peek 已提交
1051 1052 1053
            yield
          ensure
            @scope[:scope_level] = old
1054
            @scope[:scope_level_resource] = old_resource
J
Joshua Peek 已提交
1055
          end
1056 1057 1058

          def resource_scope(resource)
            with_scope_level(resource.is_a?(SingletonResource) ? :resource : :resources, resource) do
1059
              scope(parent_resource.resource_scope) do
1060 1061 1062 1063 1064
                yield
              end
            end
          end

1065 1066 1067 1068 1069 1070 1071 1072
          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?
1073
            @scope[:constraints] && @scope[:constraints][:id].is_a?(Regexp)
1074 1075 1076
          end

          def id_constraint
1077
            @scope[:constraints][:id]
1078 1079
          end

1080
          def canonical_action?(action, flag)
1081
            flag && resource_method_scope? && CANONICAL_ACTIONS.include?(action.to_s)
1082 1083 1084
          end

          def shallow_scoping?
1085
            shallow? && @scope[:scope_level] == :member
1086 1087
          end

1088
          def path_for_action(action, path)
1089
            prefix = shallow_scoping? ?
1090 1091
              "#{@scope[:shallow_path]}/#{parent_resource.path}/:id" : @scope[:path]

1092 1093
            path = if canonical_action?(action, path.blank?)
              prefix.to_s
1094
            else
1095
              "#{prefix}/#{action_path(action, path)}"
1096 1097 1098
            end
          end

1099 1100
          def action_path(name, path = nil)
            path || @scope[:path_names][name.to_sym] || name.to_s
1101 1102
          end

1103 1104
          def prefix_name_for_action(as, action)
            if as
1105
              as.to_s
1106
            elsif !canonical_action?(action, @scope[:scope_level])
1107
              action.to_s
1108
            end
1109 1110
          end

1111 1112
          def name_for_action(as, action)
            prefix = prefix_name_for_action(as, action)
1113
            prefix = Mapper.normalize_name(prefix) if prefix
1114 1115 1116 1117 1118
            name_prefix = @scope[:as]

            if parent_resource
              collection_name = parent_resource.collection_name
              member_name = parent_resource.member_name
1119
            end
1120

1121
            name = case @scope[:scope_level]
1122 1123
            when :nested
              [member_name, prefix]
1124
            when :collection
1125
              [prefix, name_prefix, collection_name]
1126
            when :new
1127 1128 1129 1130 1131
              [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]
1132
            else
1133
              [name_prefix, member_name, prefix]
1134
            end
1135

1136
            candidate = name.select(&:present?).join("_").presence
1137
            candidate unless as.nil? && @set.routes.find { |r| r.name == candidate }
1138
          end
J
Joshua Peek 已提交
1139
      end
J
Joshua Peek 已提交
1140

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
      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

1154 1155 1156 1157
      include Base
      include HttpHelpers
      include Scoping
      include Resources
1158
      include Shorthand
J
Joshua Peek 已提交
1159 1160
    end
  end
J
Joshua Peek 已提交
1161
end