mapper.rb 36.0 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
              @options[:as] ||= Mapper.normalize_name(path_without_format)
66 67
            end

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

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

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

            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

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

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

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

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

119
          def defaults
120 121 122 123 124 125
            @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

126
          def default_controller_and_action(to_shorthand=nil)
127
            if to.respond_to?(:call)
128 129
              { }
            else
130
              if to.is_a?(String)
131
                controller, action = to.split('#')
132 133
              elsif to.is_a?(Symbol)
                action = to.to_s
134
              end
J
Joshua Peek 已提交
135

136 137
              controller ||= default_controller
              action     ||= default_action
138

139 140 141
              unless controller.is_a?(Regexp) || to_shorthand
                controller = [@scope[:module], controller].compact.join("/").presence
              end
142

143 144
              controller = controller.to_s unless controller.is_a?(Regexp)
              action     = action.to_s     unless action.is_a?(Regexp)
145

146
              if controller.blank? && segment_keys.exclude?("controller")
147 148
                raise ArgumentError, "missing :controller"
              end
J
Joshua Peek 已提交
149

150
              if action.blank? && segment_keys.exclude?("action")
151 152
                raise ArgumentError, "missing :action"
              end
J
Joshua Peek 已提交
153

154 155 156 157
              { :controller => controller, :action => action }.tap do |hash|
                hash.delete(:controller) if hash[:controller].blank?
                hash.delete(:action)     if hash[:action].blank?
              end
158 159
            end
          end
160

161 162 163 164 165 166
          def blocks
            if @options[:constraints].present? && !@options[:constraints].is_a?(Hash)
              block = @options[:constraints]
            else
              block = nil
            end
J
Joshua Peek 已提交
167 168

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

171 172 173
          def constraints
            @constraints ||= requirements.reject { |k, v| segment_keys.include?(k.to_s) || k == :controller }
          end
174

175 176 177 178 179 180
          def request_method_condition
            if via = @options[:via]
              via = Array(via).map { |m| m.to_s.upcase }
              { :request_method => Regexp.union(*via) }
            else
              { }
181
            end
182
          end
J
Joshua Peek 已提交
183

184 185
          def segment_keys
            @segment_keys ||= Rack::Mount::RegexpWithNamedGroups.new(
186 187
              Rack::Mount::Strexp.compile(@path, requirements, SEPARATORS)
            ).names
188
          end
189

190 191 192
          def to
            @options[:to]
          end
J
Joshua Peek 已提交
193

194
          def default_controller
195
            if @options[:controller]
196
              @options[:controller]
197
            elsif @scope[:controller]
198
              @scope[:controller]
199
            end
200
          end
201 202 203

          def default_action
            if @options[:action]
204
              @options[:action]
205 206
            elsif @scope[:action]
              @scope[:action]
207 208
            end
          end
209
      end
210

211
      # Invokes Rack::Mount::Utils.normalize path and ensure that
212 213
      # (:locale) becomes (/:locale) instead of /(:locale). Except
      # for root cases, where the latter is the correct one.
214 215
      def self.normalize_path(path)
        path = Rack::Mount::Utils.normalize_path(path)
216
        path.gsub!(%r{/(\(+)/?}, '\1/') unless path =~ %r{^/\(+[^/]+\)$}
217 218 219
        path
      end

220 221 222 223
      def self.normalize_name(name)
        normalize_path(name)[1..-1].gsub("/", "_")
      end

224
      module Base
225
        def initialize(set) #:nodoc:
226 227
          @set = set
        end
228

229 230 231 232 233
        # 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>.
234 235 236
        def root(options = {})
          match '/', options.reverse_merge(:as => :root)
        end
237

238 239 240 241 242 243 244 245 246
        # 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.
247 248
        def match(path, options=nil)
          mapping = Mapping.new(@set, @scope, path, options || {}).to_route
249
          @set.add_route(*mapping)
250 251
          self
        end
252

253 254 255 256 257 258 259 260 261 262 263
        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

264 265
          options[:as] ||= app_name(app)

266
          match(path, options.merge(:to => app, :anchor => false, :format => false))
267 268

          define_generate_prefix(app, options[:as])
269 270 271
          self
        end

272 273 274 275
        def default_url_options=(options)
          @set.default_url_options = options
        end
        alias_method :default_url_options, :default_url_options=
276

277 278 279 280 281 282
        def with_default_scope(scope, &block)
          scope(scope) do
            instance_exec(&block)
          end
        end

283 284 285
        private
          def app_name(app)
            return unless app.respond_to?(:routes)
286 287 288 289 290 291 292

            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
293 294 295 296 297 298
          end

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

            _route = @set.named_routes.routes[name.to_sym]
P
Piotr Sarnacki 已提交
299 300
            _routes = @set
            app.routes.define_mounted_helper(name)
301 302
            app.routes.class_eval do
              define_method :_generate_prefix do |options|
P
Piotr Sarnacki 已提交
303
                prefix_options = options.slice(*_route.segment_keys)
304 305
                # 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 已提交
306
                _routes.url_helpers.send("#{name}_path", prefix_options)
307 308 309
              end
            end
          end
310 311 312
      end

      module HttpHelpers
313
        # Define a route that only recognizes HTTP GET.
314 315 316 317
        def get(*args, &block)
          map_method(:get, *args, &block)
        end

318
        # Define a route that only recognizes HTTP POST.
319 320 321 322
        def post(*args, &block)
          map_method(:post, *args, &block)
        end

323
        # Define a route that only recognizes HTTP PUT.
324 325 326 327
        def put(*args, &block)
          map_method(:put, *args, &block)
        end

328
        # Define a route that only recognizes HTTP DELETE.
329 330 331 332
        def delete(*args, &block)
          map_method(:delete, *args, &block)
        end

333 334 335
        # Redirect any path to another path:
        #
        #   match "/stories" => redirect("/posts")
336 337 338
        def redirect(*args, &block)
          options = args.last.is_a?(Hash) ? args.pop : {}

339 340 341
          path      = args.shift || block
          path_proc = path.is_a?(Proc) ? path : proc { |params| path % params }
          status    = options[:status] || 301
342 343

          lambda do |env|
344
            req = Request.new(env)
345 346 347 348 349

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

            uri = URI.parse(path_proc.call(*params))
350 351
            uri.scheme ||= req.scheme
            uri.host   ||= req.host
352
            uri.port   ||= req.port unless req.standard_port?
353

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

356 357 358 359 360
            headers = {
              'Location' => uri.to_s,
              'Content-Type' => 'text/html',
              'Content-Length' => body.length.to_s
            }
361

362
            [ status, headers, [body] ]
363
          end
364 365 366 367 368 369 370 371 372 373 374 375
        end

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

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
      # 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
      # 
      # This will create a number of routes for each of the posts and comments
      # controller. For Admin::PostsController, Rails will create:
      # 
      #   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
      # 
      # If you want to route /photos (without the prefix /admin) to
      # Admin::PostsController, you could use
      # 
      #   scope :module => "admin" do
      #     resources :posts, :comments
      #   end
      #
      # or, for a single case
      # 
      #   resources :posts, :module => "admin"
      # 
      # If you want to route /admin/photos to PostsController
      # (without the Admin:: module prefix), you could use
      # 
      #   scope "/admin" do
      #     resources :posts, :comments
      #   end
      #
      # or, for a single case
      # 
      #   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:
      # 
      #   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
430
      module Scoping
431
        def initialize(*args) #:nodoc:
432 433 434 435
          @scope = {}
          super
        end

436 437 438 439 440 441
        # Used to route <tt>/photos</tt> (without the prefix <tt>/admin</tt>)
        # to Admin::PostsController:
        #
        #   scope :module => "admin" do
        #     resources :posts
        #   end
442 443
        def scope(*args)
          options = args.extract_options!
444
          options = options.dup
445

446
          options[:path] = args.first if args.first.is_a?(String)
447
          recover = {}
448

449 450 451
          options[:constraints] ||= {}
          unless options[:constraints].is_a?(Hash)
            block, options[:constraints] = options[:constraints], {}
452
          end
453

454 455 456 457 458
          scope_options.each do |option|
            if value = options.delete(option)
              recover[option] = @scope[option]
              @scope[option]  = send("merge_#{option}_scope", @scope[option], value)
            end
459 460
          end

461 462
          recover[:block] = @scope[:blocks]
          @scope[:blocks] = merge_blocks_scope(@scope[:blocks], block)
463

464 465
          recover[:options] = @scope[:options]
          @scope[:options]  = merge_options_scope(@scope[:options], options)
466 467 468 469

          yield
          self
        ensure
470 471 472 473 474 475
          scope_options.each do |option|
            @scope[option] = recover[option] if recover.has_key?(option)
          end

          @scope[:options] = recover[:options]
          @scope[:blocks]  = recover[:block]
476 477
        end

478 479 480
        def controller(controller, options={})
          options[:controller] = controller
          scope(options) { yield }
481 482
        end

483
        def namespace(path, options = {})
484
          path = path.to_s
485 486 487
          options = { :path => path, :as => path, :module => path,
                      :shallow_path => path, :shallow_prefix => path }.merge!(options)
          scope(options) { yield }
488 489 490 491 492 493
        end

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

494 495 496 497
        def defaults(defaults = {})
          scope(:defaults => defaults) { yield }
        end

498 499 500 501 502 503
        private
          def scope_options
            @scope_options ||= private_methods.grep(/^merge_(.+)_scope$/) { $1.to_sym }
          end

          def merge_path_scope(parent, child)
504
            Mapper.normalize_path("#{parent}/#{child}")
505 506
          end

507 508 509 510
          def merge_shallow_path_scope(parent, child)
            Mapper.normalize_path("#{parent}/#{child}")
          end

511
          def merge_as_scope(parent, child)
512
            parent ? "#{parent}_#{child}" : child
513 514
          end

515 516 517 518
          def merge_shallow_prefix_scope(parent, child)
            parent ? "#{parent}_#{child}" : child
          end

519
          def merge_module_scope(parent, child)
520 521 522 523
            parent ? "#{parent}/#{child}" : child
          end

          def merge_controller_scope(parent, child)
524
            child
525 526
          end

527
          def merge_path_names_scope(parent, child)
528 529 530 531 532 533 534
            merge_options_scope(parent, child)
          end

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

535 536 537 538
          def merge_defaults_scope(parent, child)
            merge_options_scope(parent, child)
          end

539
          def merge_blocks_scope(parent, child)
540 541 542
            merged = parent ? parent.dup : []
            merged << child if child
            merged
543 544 545
          end

          def merge_options_scope(parent, child)
546
            (parent || {}).except(*override_keys(child)).merge(child)
547
          end
548 549 550 551

          def merge_shallow_scope(parent, child)
            child ? true : false
          end
552 553 554 555

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

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
      # 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 已提交
589
      module Resources
590 591
        # CANONICAL_ACTIONS holds all actions that does not need a prefix or
        # a path appended since they fit properly in their scope level.
592 593 594
        VALID_ON_OPTIONS  = [:new, :collection, :member]
        RESOURCE_OPTIONS  = [:as, :controller, :path, :only, :except]
        CANONICAL_ACTIONS = %w(index create new show update destroy)
595

596
        class Resource #:nodoc:
597
          DEFAULT_ACTIONS = [:index, :create, :new, :show, :update, :destroy, :edit]
598

599
          attr_reader :controller, :path, :options
600 601

          def initialize(entities, options = {})
602
            @name       = entities.to_s
603
            @path       = (options.delete(:path) || @name).to_s
604
            @controller = (options.delete(:controller) || @name).to_s
605
            @as         = options.delete(:as)
606
            @options    = options
607 608
          end

609
          def default_actions
610
            self.class::DEFAULT_ACTIONS
611 612
          end

613
          def actions
614 615 616 617 618 619 620 621 622 623
            only, except = @options.values_at(:only, :except)
            if only == :all || except == :none
              only = nil
              except = []
            elsif only == :none || except == :all
              only = []
              except = nil
            end

            if only
624
              Array(only).map(&:to_sym)
625
            elsif except
626 627 628 629 630 631
              default_actions - Array(except).map(&:to_sym)
            else
              default_actions
            end
          end

632
          def name
633
            @as || @name
634 635
          end

636
          def plural
637
            @plural ||= name.to_s
638 639 640
          end

          def singular
641
            @singular ||= name.to_s.singularize
642 643
          end

644
          alias :member_name :singular
645

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

651
          def resource_scope
652
            { :controller => controller }
653 654
          end

655
          alias :collection_scope :path
656 657

          def member_scope
658
            "#{path}/:id"
659 660
          end

661
          def new_scope(new_path)
662
            "#{path}/#{new_path}"
663 664 665
          end

          def nested_scope
666
            "#{path}/:#{singular}_id"
667
          end
668

669 670 671
        end

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

674 675
          def initialize(entities, options)
            @name       = entities.to_s
676
            @path       = (options.delete(:path) || @name).to_s
677
            @controller = (options.delete(:controller) || plural).to_s
678 679 680 681
            @as         = options.delete(:as)
            @options    = options
          end

682 683
          def plural
            @plural ||= name.to_s.pluralize
684 685
          end

686 687
          def singular
            @singular ||= name.to_s
688
          end
689 690 691 692 693 694

          alias :member_name :singular
          alias :collection_name :singular

          alias :member_scope :path
          alias :nested_scope :path
695 696
        end

697
        def initialize(*args) #:nodoc:
698
          super
699
          @scope[:path_names] = @set.resources_path_names
700 701
        end

702 703 704 705
        def resources_path_names(options)
          @scope[:path_names].merge!(options)
        end

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
        # 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 已提交
724
        def resource(*resources, &block)
J
Joshua Peek 已提交
725
          options = resources.extract_options!
J
Joshua Peek 已提交
726

727
          if apply_common_behavior_for(:resource, resources, options, &block)
728 729 730
            return self
          end

731 732
          resource_scope(SingletonResource.new(resources.pop, options)) do
            yield if block_given?
733

734
            collection_scope do
735
              post :create
736
            end if parent_resource.actions.include?(:create)
737 738 739

            new_scope do
              get :new
740
            end if parent_resource.actions.include?(:new)
741

742
            member_scope  do
743
              get    :edit if parent_resource.actions.include?(:edit)
744 745 746
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
747 748 749
            end
          end

J
Joshua Peek 已提交
750
          self
751 752
        end

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
        # 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 已提交
769
        def resources(*resources, &block)
J
Joshua Peek 已提交
770
          options = resources.extract_options!
771

772
          if apply_common_behavior_for(:resources, resources, options, &block)
773 774 775
            return self
          end

776
          resource_scope(Resource.new(resources.pop, options)) do
777
            instance_eval(&block) if block_given?
J
Joshua Peek 已提交
778

779
            collection_scope do
780 781
              get  :index if parent_resource.actions.include?(:index)
              post :create if parent_resource.actions.include?(:create)
782
            end
783

784 785
            new_scope do
              get :new
786
            end if parent_resource.actions.include?(:new)
787

788
            member_scope  do
789
              get    :edit if parent_resource.actions.include?(:edit)
790 791 792
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
793 794 795
            end
          end

J
Joshua Peek 已提交
796
          self
797 798
        end

799 800 801 802 803 804 805 806 807 808 809 810
        # 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 已提交
811 812 813
        def collection
          unless @scope[:scope_level] == :resources
            raise ArgumentError, "can't use collection outside resources scope"
814 815
          end

816 817
          collection_scope do
            yield
J
Joshua Peek 已提交
818
          end
819
        end
J
Joshua Peek 已提交
820

821 822 823 824 825 826 827 828 829 830 831
        # 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 已提交
832
        def member
833 834
          unless resource_scope?
            raise ArgumentError, "can't use member outside resource(s) scope"
J
Joshua Peek 已提交
835
          end
J
Joshua Peek 已提交
836

837 838
          member_scope do
            yield
839 840 841 842 843 844 845
          end
        end

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

847 848
          new_scope do
            yield
J
Joshua Peek 已提交
849
          end
J
Joshua Peek 已提交
850 851
        end

852
        def nested
853 854
          unless resource_scope?
            raise ArgumentError, "can't use nested outside resource(s) scope"
855 856 857
          end

          with_scope_level(:nested) do
858
            if shallow?
859
              with_exclusive_scope do
860
                if @scope[:shallow_path].blank?
861
                  scope(parent_resource.nested_scope, nested_options) { yield }
862
                else
863
                  scope(@scope[:shallow_path], :as => @scope[:shallow_prefix]) do
864
                    scope(parent_resource.nested_scope, nested_options) { yield }
865 866 867 868
                  end
                end
              end
            else
869
              scope(parent_resource.nested_scope, nested_options) { yield }
870 871 872 873
            end
          end
        end

874
        def namespace(path, options = {})
875
          if resource_scope?
876 877 878 879 880 881
            nested { super }
          else
            super
          end
        end

882 883 884 885 886 887
        def shallow
          scope(:shallow => true) do
            yield
          end
        end

888 889 890 891
        def shallow?
          parent_resource.instance_of?(Resource) && @scope[:shallow]
        end

J
Joshua Peek 已提交
892
        def match(*args)
893
          options = args.extract_options!.dup
894 895
          options[:anchor] = true unless options.key?(:anchor)

896
          if args.length > 1
897
            args.each { |path| match(path, options.dup) }
898 899 900
            return self
          end

901 902 903 904 905 906 907 908 909
          via = Array.wrap(options[:via]).map(&:to_sym)
          if via.include?(:head)
            raise ArgumentError, "HTTP method HEAD is invalid in route conditions. Rails processes HEAD requests the same as GETs, returning just the response headers"
          end

          unless (invalid = via - HTTP_METHODS).empty?
            raise ArgumentError, "Invalid HTTP method (#{invalid.join(', ')}) specified in :via"
          end

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

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

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

929 930
          if action.to_s =~ /^[\w\/]+$/
            options[:action] ||= action unless action.to_s.include?("/")
931
            options[:as] = name_for_action(action, options[:as])
932 933
          else
            options[:as] = name_for_action(options[:as])
J
Joshua Peek 已提交
934
          end
J
Joshua Peek 已提交
935

936
          super(path, options)
J
Joshua Peek 已提交
937 938
        end

939
        def root(options={})
940
          if @scope[:scope_level] == :resources
941 942
            with_scope_level(:root) do
              scope(parent_resource.path) do
943 944 945 946 947 948
                super(options)
              end
            end
          else
            super(options)
          end
949 950
        end

951
        protected
952

953
          def parent_resource #:nodoc:
954 955 956
            @scope[:scope_level_resource]
          end

957
          def apply_common_behavior_for(method, resources, options, &block)
958 959 960 961 962
            if resources.length > 1
              resources.each { |r| send(method, r, options, &block) }
              return true
            end

963 964 965 966 967
            if resource_scope?
              nested { send(method, resources.pop, options, &block) }
              return true
            end

968
            options.keys.each do |k|
969 970 971
              (options[:constraints] ||= {})[k] = options.delete(k) if options[k].is_a?(Regexp)
            end

972 973 974
            scope_options = options.slice!(*RESOURCE_OPTIONS)
            unless scope_options.empty?
              scope(scope_options) do
975 976 977 978 979
                send(method, resources.pop, options, &block)
              end
              return true
            end

980 981 982 983
            unless action_options?(options)
              options.merge!(scope_action_options) if scope_action_options?
            end

984 985 986
            false
          end

987 988 989 990 991 992 993 994 995 996 997 998
          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

999 1000 1001 1002
          def resource_scope?
            [:resource, :resources].include?(@scope[:scope_level])
          end

1003 1004 1005 1006
          def resource_method_scope?
            [:collection, :member, :new].include?(@scope[:scope_level])
          end

1007
          def with_exclusive_scope
1008
            begin
1009 1010
              old_name_prefix, old_path = @scope[:as], @scope[:path]
              @scope[:as], @scope[:path] = nil, nil
1011

1012 1013 1014
              with_scope_level(:exclusive) do
                yield
              end
1015
            ensure
1016
              @scope[:as], @scope[:path] = old_name_prefix, old_path
1017 1018 1019
            end
          end

1020
          def with_scope_level(kind, resource = parent_resource)
J
Joshua Peek 已提交
1021
            old, @scope[:scope_level] = @scope[:scope_level], kind
1022
            old_resource, @scope[:scope_level_resource] = @scope[:scope_level_resource], resource
J
Joshua Peek 已提交
1023 1024 1025
            yield
          ensure
            @scope[:scope_level] = old
1026
            @scope[:scope_level_resource] = old_resource
J
Joshua Peek 已提交
1027
          end
1028 1029 1030

          def resource_scope(resource)
            with_scope_level(resource.is_a?(SingletonResource) ? :resource : :resources, resource) do
1031
              scope(parent_resource.resource_scope) do
1032 1033 1034 1035 1036
                yield
              end
            end
          end

1037 1038
          def new_scope
            with_scope_level(:new) do
1039
              scope(parent_resource.new_scope(action_path(:new))) do
1040 1041 1042 1043 1044
                yield
              end
            end
          end

1045 1046
          def collection_scope
            with_scope_level(:collection) do
1047
              scope(parent_resource.collection_scope) do
1048 1049 1050 1051 1052 1053 1054
                yield
              end
            end
          end

          def member_scope
            with_scope_level(:member) do
1055
              scope(parent_resource.member_scope) do
1056 1057 1058 1059 1060
                yield
              end
            end
          end

1061 1062 1063 1064 1065 1066 1067 1068
          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?
1069
            @scope[:constraints] && @scope[:constraints][:id].is_a?(Regexp)
1070 1071 1072
          end

          def id_constraint
1073
            @scope[:constraints][:id]
1074 1075
          end

1076
          def canonical_action?(action, flag)
1077
            flag && resource_method_scope? && CANONICAL_ACTIONS.include?(action.to_s)
1078 1079 1080
          end

          def shallow_scoping?
1081
            shallow? && @scope[:scope_level] == :member
1082 1083
          end

1084
          def path_for_action(action, path)
1085
            prefix = shallow_scoping? ?
1086 1087
              "#{@scope[:shallow_path]}/#{parent_resource.path}/:id" : @scope[:path]

1088 1089
            path = if canonical_action?(action, path.blank?)
              prefix.to_s
1090
            else
1091
              "#{prefix}/#{action_path(action, path)}"
1092 1093 1094
            end
          end

1095 1096
          def action_path(name, path = nil)
            path || @scope[:path_names][name.to_sym] || name.to_s
1097 1098
          end

1099 1100
          def prefix_name_for_action(action, as)
            if as.present?
1101
              as.to_s
1102
            elsif as
1103
              nil
1104
            elsif !canonical_action?(action, @scope[:scope_level])
1105
              action.to_s
1106
            end
1107 1108
          end

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

            if parent_resource
              collection_name = parent_resource.collection_name
              member_name = parent_resource.member_name
1117
            end
1118

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

1134
            name.select(&:present?).join("_").presence
1135
          end
J
Joshua Peek 已提交
1136
      end
J
Joshua Peek 已提交
1137

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
      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

1151 1152 1153 1154
      include Base
      include HttpHelpers
      include Scoping
      include Resources
1155
      include Shorthand
J
Joshua Peek 已提交
1156 1157
    end
  end
J
Joshua Peek 已提交
1158
end