mapper.rb 38.8 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
        # Used to route <tt>/photos</tt> (without the prefix <tt>/admin</tt>)
        # to Admin::PostsController:
470 471 472 473
        # === Supported options
        # [:module]
        #   If you want to route /posts (without the prefix /admin) to
        #   Admin::PostsController, you could use
474
        #
475 476 477 478 479
        #     scope :module => "admin" do
        #       resources :posts
        #     end
        # [:path]
        #  If you want to prefix the route, you could use
480
        #
481 482 483 484
        #     scope :path => "/admin" do
        #       resources :posts
        #     end
        # This will prefix all of the +posts+ resource's requests with '/admin'
485 486
        def scope(*args)
          options = args.extract_options!
487
          options = options.dup
488

489
          options[:path] = args.first if args.first.is_a?(String)
490
          recover = {}
491

492 493 494
          options[:constraints] ||= {}
          unless options[:constraints].is_a?(Hash)
            block, options[:constraints] = options[:constraints], {}
495
          end
496

497 498 499 500 501
          scope_options.each do |option|
            if value = options.delete(option)
              recover[option] = @scope[option]
              @scope[option]  = send("merge_#{option}_scope", @scope[option], value)
            end
502 503
          end

504 505
          recover[:block] = @scope[:blocks]
          @scope[:blocks] = merge_blocks_scope(@scope[:blocks], block)
506

507 508
          recover[:options] = @scope[:options]
          @scope[:options]  = merge_options_scope(@scope[:options], options)
509 510 511 512

          yield
          self
        ensure
513 514 515 516 517 518
          scope_options.each do |option|
            @scope[option] = recover[option] if recover.has_key?(option)
          end

          @scope[:options] = recover[:options]
          @scope[:blocks]  = recover[:block]
519 520
        end

521 522 523 524 525 526
        # Scopes routes to a specific controller
        #
        # Example:
        #   controller "food" do
        #     match "bacon", :action => "bacon"
        #   end
527 528 529
        def controller(controller, options={})
          options[:controller] = controller
          scope(options) { yield }
530 531
        end

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
        # Scopes routes to a specific namespace. For example:
        #
        #   namespace :admin do
        #     resources :posts
        #   end
        #
        # This generates the following routes:
        #
        #     admin_posts GET    /admin/posts(.:format)          {:action=>"index", :controller=>"admin/posts"}
        #     admin_posts POST   /admin/posts(.:format)          {:action=>"create", :controller=>"admin/posts"}
        #  new_admin_post GET    /admin/posts/new(.:format)      {:action=>"new", :controller=>"admin/posts"}
        # edit_admin_post GET    /admin/posts/:id/edit(.:format) {:action=>"edit", :controller=>"admin/posts"}
        #      admin_post GET    /admin/posts/:id(.:format)      {:action=>"show", :controller=>"admin/posts"}
        #      admin_post PUT    /admin/posts/:id(.:format)      {:action=>"update", :controller=>"admin/posts"}
        #      admin_post DELETE /admin/posts/:id(.:format)      {:action=>"destroy", :controller=>"admin/posts"}
547 548 549 550 551 552 553 554 555 556 557
        # === Supported options
        #
        # The +:path+, +:as+, +:module+, +:shallow_path+ and +:shallow_prefix+ all default to the name of the namespace.
        #
        # [:path]
        #   The path prefix for the routes.
        #
        #   namespace :admin, :path => "sekret" do
        #     resources :posts
        #   end
        #
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
        #   All routes for the above +resources+ will be accessible through +/sekret/posts+, rather than +/admin/posts+
        #
        # [:module]
        #   The namespace for the controllers.
        #
        #   namespace :admin, :module => "sekret" do
        #     resources :posts
        #   end
        #
        #   The +PostsController+ here should go in the +Sekret+ namespace and so it should be defined like this:
        #
        #   class Sekret::PostsController < ApplicationController
        #     # code go here
        #   end
        #
573
        def namespace(path, options = {})
574
          path = path.to_s
575 576 577
          options = { :path => path, :as => path, :module => path,
                      :shallow_path => path, :shallow_prefix => path }.merge!(options)
          scope(options) { yield }
578 579 580 581 582 583
        end

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

R
Ryan Bigg 已提交
584 585 586 587 588
        # Allows you to set default parameters for a route, such as this:
        # defaults :id => 'home' do
        #   match 'scoped_pages/(:id)', :to => 'pages#show'
        # end
        # Using this, the +:id+ parameter here will default to 'home'.
589 590 591 592
        def defaults(defaults = {})
          scope(:defaults => defaults) { yield }
        end

593 594 595 596 597 598
        private
          def scope_options
            @scope_options ||= private_methods.grep(/^merge_(.+)_scope$/) { $1.to_sym }
          end

          def merge_path_scope(parent, child)
599
            Mapper.normalize_path("#{parent}/#{child}")
600 601
          end

602 603 604 605
          def merge_shallow_path_scope(parent, child)
            Mapper.normalize_path("#{parent}/#{child}")
          end

606
          def merge_as_scope(parent, child)
607
            parent ? "#{parent}_#{child}" : child
608 609
          end

610 611 612 613
          def merge_shallow_prefix_scope(parent, child)
            parent ? "#{parent}_#{child}" : child
          end

614
          def merge_module_scope(parent, child)
615 616 617 618
            parent ? "#{parent}/#{child}" : child
          end

          def merge_controller_scope(parent, child)
619
            child
620 621
          end

622
          def merge_path_names_scope(parent, child)
623 624 625 626 627 628 629
            merge_options_scope(parent, child)
          end

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

630 631 632 633
          def merge_defaults_scope(parent, child)
            merge_options_scope(parent, child)
          end

634
          def merge_blocks_scope(parent, child)
635 636 637
            merged = parent ? parent.dup : []
            merged << child if child
            merged
638 639 640
          end

          def merge_options_scope(parent, child)
641
            (parent || {}).except(*override_keys(child)).merge(child)
642
          end
643 644 645 646

          def merge_shallow_scope(parent, child)
            child ? true : false
          end
647 648 649 650

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

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
      # 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 已提交
684
      module Resources
685 686
        # CANONICAL_ACTIONS holds all actions that does not need a prefix or
        # a path appended since they fit properly in their scope level.
687 688 689
        VALID_ON_OPTIONS  = [:new, :collection, :member]
        RESOURCE_OPTIONS  = [:as, :controller, :path, :only, :except]
        CANONICAL_ACTIONS = %w(index create new show update destroy)
690

691
        class Resource #:nodoc:
692
          DEFAULT_ACTIONS = [:index, :create, :new, :show, :update, :destroy, :edit]
693

694
          attr_reader :controller, :path, :options
695 696

          def initialize(entities, options = {})
697
            @name       = entities.to_s
698
            @path       = (options.delete(:path) || @name).to_s
699
            @controller = (options.delete(:controller) || @name).to_s
700
            @as         = options.delete(:as)
701
            @options    = options
702 703
          end

704
          def default_actions
705
            self.class::DEFAULT_ACTIONS
706 707
          end

708
          def actions
709
            if only = @options[:only]
710
              Array(only).map(&:to_sym)
711
            elsif except = @options[:except]
712 713 714 715 716 717
              default_actions - Array(except).map(&:to_sym)
            else
              default_actions
            end
          end

718
          def name
719
            @as || @name
720 721
          end

722
          def plural
723
            @plural ||= name.to_s
724 725 726
          end

          def singular
727
            @singular ||= name.to_s.singularize
728 729
          end

730
          alias :member_name :singular
731

732
          # Checks for uncountable plurals, and appends "_index" if they're.
733
          def collection_name
734
            singular == plural ? "#{plural}_index" : plural
735 736
          end

737
          def resource_scope
738
            { :controller => controller }
739 740
          end

741
          alias :collection_scope :path
742 743

          def member_scope
744
            "#{path}/:id"
745 746
          end

747
          def new_scope(new_path)
748
            "#{path}/#{new_path}"
749 750 751
          end

          def nested_scope
752
            "#{path}/:#{singular}_id"
753
          end
754

755 756 757
        end

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

760
          def initialize(entities, options)
761
            @as         = nil
762
            @name       = entities.to_s
763
            @path       = (options.delete(:path) || @name).to_s
764
            @controller = (options.delete(:controller) || plural).to_s
765 766 767 768
            @as         = options.delete(:as)
            @options    = options
          end

769 770
          def plural
            @plural ||= name.to_s.pluralize
771 772
          end

773 774
          def singular
            @singular ||= name.to_s
775
          end
776 777 778 779 780 781

          alias :member_name :singular
          alias :collection_name :singular

          alias :member_scope :path
          alias :nested_scope :path
782 783
        end

784
        def initialize(*args) #:nodoc:
785
          super
786
          @scope[:path_names] = @set.resources_path_names
787 788
        end

789 790 791 792
        def resources_path_names(options)
          @scope[:path_names].merge!(options)
        end

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
        # 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 已提交
811
        def resource(*resources, &block)
J
Joshua Peek 已提交
812
          options = resources.extract_options!
J
Joshua Peek 已提交
813

814
          if apply_common_behavior_for(:resource, resources, options, &block)
815 816 817
            return self
          end

818 819
          resource_scope(SingletonResource.new(resources.pop, options)) do
            yield if block_given?
820

821
            collection do
822
              post :create
823
            end if parent_resource.actions.include?(:create)
824

825
            new do
826
              get :new
827
            end if parent_resource.actions.include?(:new)
828

829
            member do
830
              get    :edit if parent_resource.actions.include?(:edit)
831 832 833
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
834 835 836
            end
          end

J
Joshua Peek 已提交
837
          self
838 839
        end

840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
        # 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 已提交
856
        def resources(*resources, &block)
J
Joshua Peek 已提交
857
          options = resources.extract_options!
858

859
          if apply_common_behavior_for(:resources, resources, options, &block)
860 861 862
            return self
          end

863
          resource_scope(Resource.new(resources.pop, options)) do
864
            yield if block_given?
J
Joshua Peek 已提交
865

866
            collection do
867 868
              get  :index if parent_resource.actions.include?(:index)
              post :create if parent_resource.actions.include?(:create)
869
            end
870

871
            new do
872
              get :new
873
            end if parent_resource.actions.include?(:new)
874

875
            member do
876
              get    :edit if parent_resource.actions.include?(:edit)
877 878 879
              get    :show if parent_resource.actions.include?(:show)
              put    :update if parent_resource.actions.include?(:update)
              delete :destroy if parent_resource.actions.include?(:destroy)
880 881 882
            end
          end

J
Joshua Peek 已提交
883
          self
884 885
        end

886 887 888 889 890 891 892 893 894 895 896 897
        # 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 已提交
898
        def collection
899 900
          unless resource_scope?
            raise ArgumentError, "can't use collection outside resource(s) scope"
901 902
          end

903 904 905 906
          with_scope_level(:collection) do
            scope(parent_resource.collection_scope) do
              yield
            end
J
Joshua Peek 已提交
907
          end
908
        end
J
Joshua Peek 已提交
909

910 911 912 913 914 915 916 917 918 919 920
        # 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 已提交
921
        def member
922 923
          unless resource_scope?
            raise ArgumentError, "can't use member outside resource(s) scope"
J
Joshua Peek 已提交
924
          end
J
Joshua Peek 已提交
925

926 927 928 929
          with_scope_level(:member) do
            scope(parent_resource.member_scope) do
              yield
            end
930 931 932 933 934 935 936
          end
        end

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

938 939 940 941
          with_scope_level(:new) do
            scope(parent_resource.new_scope(action_path(:new))) do
              yield
            end
J
Joshua Peek 已提交
942
          end
J
Joshua Peek 已提交
943 944
        end

945
        def nested
946 947
          unless resource_scope?
            raise ArgumentError, "can't use nested outside resource(s) scope"
948 949 950
          end

          with_scope_level(:nested) do
951
            if shallow?
952
              with_exclusive_scope do
953
                if @scope[:shallow_path].blank?
954
                  scope(parent_resource.nested_scope, nested_options) { yield }
955
                else
956
                  scope(@scope[:shallow_path], :as => @scope[:shallow_prefix]) do
957
                    scope(parent_resource.nested_scope, nested_options) { yield }
958 959 960 961
                  end
                end
              end
            else
962
              scope(parent_resource.nested_scope, nested_options) { yield }
963 964 965 966
            end
          end
        end

967
        def namespace(path, options = {})
968
          if resource_scope?
969 970 971 972 973 974
            nested { super }
          else
            super
          end
        end

975 976 977 978 979 980
        def shallow
          scope(:shallow => true) do
            yield
          end
        end

981 982 983 984
        def shallow?
          parent_resource.instance_of?(Resource) && @scope[:shallow]
        end

J
Joshua Peek 已提交
985
        def match(*args)
986
          options = args.extract_options!.dup
987 988
          options[:anchor] = true unless options.key?(:anchor)

989
          if args.length > 1
990
            args.each { |path| match(path, options.dup) }
991 992 993
            return self
          end

994 995
          on = options.delete(:on)
          if VALID_ON_OPTIONS.include?(on)
996
            args.push(options)
997 998 999
            return send(on){ match(*args) }
          elsif on
            raise ArgumentError, "Unknown scope #{on.inspect} given to :on"
1000 1001
          end

1002 1003 1004 1005
          if @scope[:scope_level] == :resources
            args.push(options)
            return nested { match(*args) }
          elsif @scope[:scope_level] == :resource
1006
            args.push(options)
J
Joshua Peek 已提交
1007 1008
            return member { match(*args) }
          end
J
Joshua Peek 已提交
1009

1010
          action = args.first
1011
          path = path_for_action(action, options.delete(:path))
1012

1013 1014 1015
          if action.to_s =~ /^[\w\/]+$/
            options[:action] ||= action unless action.to_s.include?("/")
          else
1016 1017 1018 1019 1020 1021 1022
            action = nil
          end

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

1025
          super(path, options)
J
Joshua Peek 已提交
1026 1027
        end

1028
        def root(options={})
1029
          if @scope[:scope_level] == :resources
1030 1031
            with_scope_level(:root) do
              scope(parent_resource.path) do
1032 1033 1034 1035 1036 1037
                super(options)
              end
            end
          else
            super(options)
          end
1038 1039
        end

1040
        protected
1041

1042
          def parent_resource #:nodoc:
1043 1044 1045
            @scope[:scope_level_resource]
          end

1046
          def apply_common_behavior_for(method, resources, options, &block)
1047 1048 1049 1050 1051
            if resources.length > 1
              resources.each { |r| send(method, r, options, &block) }
              return true
            end

1052 1053 1054 1055 1056
            if resource_scope?
              nested { send(method, resources.pop, options, &block) }
              return true
            end

1057
            options.keys.each do |k|
1058 1059 1060
              (options[:constraints] ||= {})[k] = options.delete(k) if options[k].is_a?(Regexp)
            end

1061 1062 1063
            scope_options = options.slice!(*RESOURCE_OPTIONS)
            unless scope_options.empty?
              scope(scope_options) do
1064 1065 1066 1067 1068
                send(method, resources.pop, options, &block)
              end
              return true
            end

1069 1070 1071 1072
            unless action_options?(options)
              options.merge!(scope_action_options) if scope_action_options?
            end

1073 1074 1075
            false
          end

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
          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

1088 1089 1090 1091
          def resource_scope?
            [:resource, :resources].include?(@scope[:scope_level])
          end

1092 1093 1094 1095
          def resource_method_scope?
            [:collection, :member, :new].include?(@scope[:scope_level])
          end

1096
          def with_exclusive_scope
1097
            begin
1098 1099
              old_name_prefix, old_path = @scope[:as], @scope[:path]
              @scope[:as], @scope[:path] = nil, nil
1100

1101 1102 1103
              with_scope_level(:exclusive) do
                yield
              end
1104
            ensure
1105
              @scope[:as], @scope[:path] = old_name_prefix, old_path
1106 1107 1108
            end
          end

1109
          def with_scope_level(kind, resource = parent_resource)
J
Joshua Peek 已提交
1110
            old, @scope[:scope_level] = @scope[:scope_level], kind
1111
            old_resource, @scope[:scope_level_resource] = @scope[:scope_level_resource], resource
J
Joshua Peek 已提交
1112 1113 1114
            yield
          ensure
            @scope[:scope_level] = old
1115
            @scope[:scope_level_resource] = old_resource
J
Joshua Peek 已提交
1116
          end
1117 1118 1119

          def resource_scope(resource)
            with_scope_level(resource.is_a?(SingletonResource) ? :resource : :resources, resource) do
1120
              scope(parent_resource.resource_scope) do
1121 1122 1123 1124 1125
                yield
              end
            end
          end

1126 1127 1128 1129 1130 1131 1132 1133
          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?
1134
            @scope[:constraints] && @scope[:constraints][:id].is_a?(Regexp)
1135 1136 1137
          end

          def id_constraint
1138
            @scope[:constraints][:id]
1139 1140
          end

1141
          def canonical_action?(action, flag)
1142
            flag && resource_method_scope? && CANONICAL_ACTIONS.include?(action.to_s)
1143 1144 1145
          end

          def shallow_scoping?
1146
            shallow? && @scope[:scope_level] == :member
1147 1148
          end

1149
          def path_for_action(action, path)
1150
            prefix = shallow_scoping? ?
1151 1152
              "#{@scope[:shallow_path]}/#{parent_resource.path}/:id" : @scope[:path]

1153 1154
            path = if canonical_action?(action, path.blank?)
              prefix.to_s
1155
            else
1156
              "#{prefix}/#{action_path(action, path)}"
1157 1158 1159
            end
          end

1160 1161
          def action_path(name, path = nil)
            path || @scope[:path_names][name.to_sym] || name.to_s
1162 1163
          end

1164 1165
          def prefix_name_for_action(as, action)
            if as
1166
              as.to_s
1167
            elsif !canonical_action?(action, @scope[:scope_level])
1168
              action.to_s
1169
            end
1170 1171
          end

1172 1173
          def name_for_action(as, action)
            prefix = prefix_name_for_action(as, action)
1174
            prefix = Mapper.normalize_name(prefix) if prefix
1175 1176 1177 1178 1179
            name_prefix = @scope[:as]

            if parent_resource
              collection_name = parent_resource.collection_name
              member_name = parent_resource.member_name
1180
            end
1181

1182
            name = case @scope[:scope_level]
1183 1184
            when :nested
              [member_name, prefix]
1185
            when :collection
1186
              [prefix, name_prefix, collection_name]
1187
            when :new
1188 1189 1190 1191 1192
              [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]
1193
            else
1194
              [name_prefix, member_name, prefix]
1195
            end
1196

1197
            candidate = name.select(&:present?).join("_").presence
1198
            candidate unless as.nil? && @set.routes.find { |r| r.name == candidate }
1199
          end
J
Joshua Peek 已提交
1200
      end
J
Joshua Peek 已提交
1201

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
      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

1215 1216 1217 1218
      include Base
      include HttpHelpers
      include Scoping
      include Resources
1219
      include Shorthand
J
Joshua Peek 已提交
1220 1221
    end
  end
J
Joshua Peek 已提交
1222
end