aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/resources.rb
blob: 3cb9367fc2d66ed43ed62f02f5e8cadfb0305f33 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
module ActionController
  # == Overview
  #
  # ActionController::Resources are a way of defining RESTful resources.  A RESTful resource, in basic terms,
  # is something that can be pointed at and it will respond with a representation of the data requested.
  # In real terms this could mean a user with a browser requests an HTML page, or that a desktop application
  # requests XML data.
  #
  # RESTful design is based on the assumption that there are four generic verbs that a user of an
  # application can request from a resource (the noun).
  #
  # Resources can be requested using four basic HTTP verbs (GET, POST, PUT, DELETE), the method used
  # denotes the type of action that should take place.
  #
  # === The Different Methods and their Usage
  #
  # +GET+     Requests for a resource, no saving or editing of a resource should occur in a GET request
  # +POST+    Creation of resources
  # +PUT+     Editing of attributes on a resource
  # +DELETE+  Deletion of a resource
  #
  # === Examples
  #
  #   # A GET request on the Posts resource is asking for all Posts
  #   GET /posts
  #
  #   # A GET request on a single Post resource is asking for that particular Post
  #   GET /posts/1
  #
  #   # A POST request on the Posts resource is asking for a Post to be created with the supplied details
  #   POST /posts # with => { :title => "My Whizzy New Post", :body => "I've got a brand new combine harvester" }
  #
  #   # A PUT request on a single Post resource is asking for a Post to be updated
  #   PUT /posts # with => { :id => 1, :title => "Changed Whizzy Title" }
  #
  #   # A DELETE request on a single Post resource is asking for it to be deleted
  #   DELETE /posts # with => { :id => 1 }
  #
  # By using the REST convention, users of our application can assume certain things about how the data
  # is requested and how it is returned.  Rails simplifies the routing part of RESTful design by
  # supplying you with methods to create them in your routes.rb file.
  #
  # Read more about REST at http://en.wikipedia.org/wiki/Representational_State_Transfer
  module Resources
    class Resource #:nodoc:
      attr_reader :collection_methods, :member_methods, :new_methods
      attr_reader :path_prefix, :name_prefix
      attr_reader :plural, :singular
      attr_reader :options

      def initialize(entities, options)
        @plural   ||= entities
        @singular ||= options[:singular] || plural.to_s.singularize

        @options = options

        arrange_actions
        add_default_actions
        set_prefixes
      end

      def controller
        @controller ||= "#{options[:namespace]}#{(options[:controller] || plural).to_s}"
      end

      def requirements(with_id = false)
        @requirements   ||= @options[:requirements] || {}
        @id_requirement ||= { :id => @requirements.delete(:id) || /[^#{Routing::SEPARATORS.join}]+/ }

        with_id ? @requirements.merge(@id_requirement) : @requirements
      end

      def path
        @path ||= "#{path_prefix}/#{plural}"
      end

      def new_path
        @new_path ||= "#{path}/new"
      end

      def member_path
        @member_path ||= "#{path}/:id"
      end

      def nesting_path_prefix
        @nesting_path_prefix ||= "#{path}/:#{singular}_id"
      end

      def nesting_name_prefix
        "#{name_prefix}#{singular}_"
      end


      protected
        def arrange_actions
          @collection_methods = arrange_actions_by_methods(options.delete(:collection))
          @member_methods     = arrange_actions_by_methods(options.delete(:member))
          @new_methods        = arrange_actions_by_methods(options.delete(:new))
        end

        def add_default_actions
          add_default_action(member_methods, :get, :edit)
          add_default_action(new_methods, :get, :new)
        end

        def set_prefixes
          @path_prefix = options.delete(:path_prefix)
          @name_prefix = options.delete(:name_prefix)
        end

        def arrange_actions_by_methods(actions)
          (actions || {}).inject({}) do |flipped_hash, (key, value)|
            (flipped_hash[value] ||= []) << key
            flipped_hash
          end
        end

        def add_default_action(collection, method, action)
          (collection[method] ||= []).unshift(action)
        end
    end

    class SingletonResource < Resource #:nodoc:
      def initialize(entity, options)
        @singular = @plural = entity
        options[:controller] ||= @singular.to_s.pluralize
        super
      end

      alias_method :member_path,         :path
      alias_method :nesting_path_prefix, :path
    end

    # Creates named routes for implementing verb-oriented controllers
    # for a collection resource.
    #
    # For example:
    #
    #   map.resources :messages
    #
    # will map the following actions in the corresponding controller:
    #
    #   class MessagesController < ActionController::Base
    #     # GET messages_url
    #     def index
    #       # return all messages
    #     end
    #
    #     # GET new_message_url
    #     def new
    #       # return an HTML form for describing a new message
    #     end
    #
    #     # POST messages_url
    #     def create
    #       # create a new message
    #     end
    #
    #     # GET message_url(:id => 1)
    #     def show
    #       # find and return a specific message
    #     end
    #
    #     # GET edit_message_url(:id => 1)
    #     def edit
    #       # return an HTML form for editing a specific message
    #     end
    #
    #     # PUT message_url(:id => 1)
    #     def update
    #       # find and update a specific message
    #     end
    #
    #     # DELETE message_url(:id => 1)
    #     def destroy
    #       # delete a specific message
    #     end
    #   end
    #
    # Along with the routes themselves, #resources generates named routes for use in
    # controllers and views. <tt>map.resources :messages</tt> produces the following named routes and helpers:
    #
    #   Named Route   Helpers
    #   ============  =====================================================
    #   messages      messages_url, hash_for_messages_url,
    #                 messages_path, hash_for_messages_path
    #
    #   message       message_url(id), hash_for_message_url(id),
    #                 message_path(id), hash_for_message_path(id)
    #
    #   new_message   new_message_url, hash_for_new_message_url,
    #                 new_message_path, hash_for_new_message_path
    #
    #   edit_message  edit_message_url(id), hash_for_edit_message_url(id),
    #                 edit_message_path(id), hash_for_edit_message_path(id)
    #
    # You can use these helpers instead of #url_for or methods that take #url_for parameters. For example:
    #
    #   redirect_to :controller => 'messages', :action => 'index'
    #   # and
    #   <%= link_to "edit this message", :controller => 'messages', :action => 'edit', :id => @message.id %>
    #
    # now become:
    #
    #   redirect_to messages_url
    #   # and
    #   <%= link_to "edit this message", edit_message_url(@message) # calls @message.id automatically
    #
    # Since web browsers don't support the PUT and DELETE verbs, you will need to add a parameter '_method' to your
    # form tags. The form helpers make this a little easier. For an update form with a <tt>@message</tt> object:
    #
    #   <%= form_tag message_path(@message), :method => :put %>
    #
    # or
    #
    #   <% form_for :message, @message, :url => message_path(@message), :html => {:method => :put} do |f| %>
    #
    # The #resources method accepts the following options to customize the resulting
    # routes:
    # * <tt>:collection</tt> - add named routes for other actions that operate on the collection.
    #   Takes a hash of <tt>#{action} => #{method}</tt>, where method is <tt>:get</tt>/<tt>:post</tt>/<tt>:put</tt>/<tt>:delete</tt>
    #   or <tt>:any</tt> if the method does not matter.  These routes map to a URL like /messages/rss, with a route of rss_messages_url.
    # * <tt>:member</tt> - same as :collection, but for actions that operate on a specific member.
    # * <tt>:new</tt> - same as :collection, but for actions that operate on the new resource action.
    # * <tt>:controller</tt> - specify the controller name for the routes.
    # * <tt>:singular</tt> - specify the singular name used in the member routes.
    # * <tt>:path_prefix</tt> - set a prefix to the routes with required route variables.
    #   Weblog comments usually belong to a post, so you might use resources like:
    #
    #     map.resources :articles
    #     map.resources :comments, :path_prefix => '/articles/:article_id'
    #
    #   You can nest resources calls to set this automatically:
    #
    #     map.resources :articles do |article|
    #       article.resources :comments
    #     end
    #
    #   The comment resources work the same, but must now include a value for :article_id.
    #
    #     article_comments_url(@article)
    #     article_comment_url(@article, @comment)
    #
    #     article_comments_url(:article_id => @article)
    #     article_comment_url(:article_id => @article, :id => @comment)
    #
    # * <tt>:name_prefix</tt> - define a prefix for all generated routes, usually ending in an underscore.
    #   Use this if you have named routes that may clash.
    #
    #     map.resources :tags, :path_prefix => '/books/:book_id', :name_prefix => 'book_'
    #     map.resources :tags, :path_prefix => '/toys/:toy_id',   :name_prefix => 'toy_'
    #
    # You may also use :name_prefix to override the generic named routes in a nested resource:
    # 
    #   map.resources :articles do |article|
    #     article.resources :comments, :name_prefix => nil
    #   end 
    # 
    # This will yield named resources like so:
    # 
    #   comments_url(@article)
    #   comment_url(@article, @comment)
    #
    # If <tt>map.resources</tt> is called with multiple resources, they all get the same options applied.
    #
    # Examples:
    #
    #   map.resources :messages, :path_prefix => "/thread/:thread_id"
    #   # --> GET /thread/7/messages/1
    #
    #   map.resources :messages, :collection => { :rss => :get }
    #   # --> GET /messages/rss (maps to the #rss action)
    #   #     also adds a named route called "rss_messages"
    #
    #   map.resources :messages, :member => { :mark => :post }
    #   # --> POST /messages/1/mark (maps to the #mark action)
    #   #     also adds a named route called "mark_message"
    #
    #   map.resources :messages, :new => { :preview => :post }
    #   # --> POST /messages/new/preview (maps to the #preview action)
    #   #     also adds a named route called "preview_new_message"
    #
    #   map.resources :messages, :new => { :new => :any, :preview => :post }
    #   # --> POST /messages/new/preview (maps to the #preview action)
    #   #     also adds a named route called "preview_new_message"
    #   # --> /messages/new can be invoked via any request method
    #
    #   map.resources :messages, :controller => "categories",
    #         :path_prefix => "/category/:category_id",
    #         :name_prefix => "category_"
    #   # --> GET /categories/7/messages/1
    #   #     has named route "category_message"
    #
    # The #resources method sets HTTP method restrictions on the routes it generates. For example, making an
    # HTTP POST on <tt>new_message_url</tt> will raise a RoutingError exception. The default route in
    # <tt>config/routes.rb</tt> overrides this and allows invalid HTTP methods for resource routes.
    def resources(*entities, &block)
      options = entities.extract_options!
      entities.each { |entity| map_resource(entity, options.dup, &block) }
    end

    # Creates named routes for implementing verb-oriented controllers for a singleton resource.
    # A singleton resource is global to its current context.  For unnested singleton resources,
    # the resource is global to the current user visiting the application, such as a user's
    # /account profile.  For nested singleton resources, the resource is global to its parent
    # resource, such as a <tt>projects</tt> resource that <tt>has_one :project_manager</tt>.
    # The <tt>project_manager</tt> should be mapped as a singleton resource under <tt>projects</tt>:
    #
    #   map.resources :projects do |project|
    #     project.resource :project_manager
    #   end
    #
    # See map.resources for general conventions.  These are the main differences:
    # * A singular name is given to map.resource.  The default controller name is still taken from the plural name.
    # * To specify a custom plural name, use the :plural option.  There is no :singular option.
    # * No default index route is created for the singleton resource controller.
    # * When nesting singleton resources, only the singular name is used as the path prefix (example: 'account/messages/1')
    #
    # For example:
    #
    #   map.resource :account
    #
    # maps these actions in the Accounts controller:
    #
    #   class AccountsController < ActionController::Base
    #     # GET new_account_url
    #     def new
    #       # return an HTML form for describing the new account
    #     end
    #
    #     # POST account_url
    #     def create
    #       # create an account
    #     end
    #
    #     # GET account_url
    #     def show
    #       # find and return the account
    #     end
    #
    #     # GET edit_account_url
    #     def edit
    #       # return an HTML form for editing the account
    #     end
    #
    #     # PUT account_url
    #     def update
    #       # find and update the account
    #     end
    #
    #     # DELETE account_url
    #     def destroy
    #       # delete the account
    #     end
    #   end
    #
    # Along with the routes themselves, #resource generates named routes for
    # use in controllers and views. <tt>map.resource :account</tt> produces
    # these named routes and helpers:
    #
    #   Named Route   Helpers
    #   ============  =============================================
    #   account       account_url, hash_for_account_url,
    #                 account_path, hash_for_account_path
    #
    #   new_account   new_account_url, hash_for_new_account_url,
    #                 new_account_path, hash_for_new_account_path
    #
    #   edit_account  edit_account_url, hash_for_edit_account_url,
    #                 edit_account_path, hash_for_edit_account_path
    def resource(*entities, &block)
      options = entities.extract_options!
      entities.each { |entity| map_singleton_resource(entity, options.dup, &block) }
    end

    private
      def map_resource(entities, options = {}, &block)
        resource = Resource.new(entities, options)

        with_options :controller => resource.controller do |map|
          map_collection_actions(map, resource)
          map_default_collection_actions(map, resource)
          map_new_actions(map, resource)
          map_member_actions(map, resource)

          map_associations(resource, options)

          if block_given?
            with_options(:path_prefix => resource.nesting_path_prefix, :name_prefix => resource.nesting_name_prefix, &block)
          end
        end
      end

      def map_singleton_resource(entities, options = {}, &block)
        resource = SingletonResource.new(entities, options)

        with_options :controller => resource.controller do |map|
          map_collection_actions(map, resource)
          map_default_singleton_actions(map, resource)
          map_new_actions(map, resource)
          map_member_actions(map, resource)

          map_associations(resource, options)

          if block_given?
            with_options(:path_prefix => resource.nesting_path_prefix, :name_prefix => resource.nesting_name_prefix, &block)
          end
        end
      end

      def map_associations(resource, options)
        path_prefix = "#{options.delete(:path_prefix)}#{resource.nesting_path_prefix}"
        name_prefix = "#{options.delete(:name_prefix)}#{resource.nesting_name_prefix}"
        namespace = options.delete(:namespace)

        Array(options[:has_many]).each do |association|
          resources(association, :path_prefix => path_prefix, :name_prefix => name_prefix, :namespace => namespace)
        end

        Array(options[:has_one]).each do |association|
          resource(association, :path_prefix => path_prefix, :name_prefix => name_prefix, :namespace => namespace)
        end
      end

      def map_collection_actions(map, resource)
        resource.collection_methods.each do |method, actions|
          actions.each do |action|
            action_options = action_options_for(action, resource, method)

            # See http://dev.rubyonrails.org/ticket/8251
            map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.plural}", "#{resource.name_prefix}#{action}_#{resource.plural}", "#{resource.path}/#{action}", action_options)
            map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.plural}", "formatted_#{resource.name_prefix}#{action}_#{resource.plural}", "#{resource.path}/#{action}.:format", action_options)
          end
        end
      end

      def map_default_collection_actions(map, resource)
        index_action_options = action_options_for("index", resource)
        map.named_route("#{resource.name_prefix}#{resource.plural}", resource.path, index_action_options)
        map.named_route("formatted_#{resource.name_prefix}#{resource.plural}", "#{resource.path}.:format", index_action_options)

        create_action_options = action_options_for("create", resource)
        map.connect(resource.path, create_action_options)
        map.connect("#{resource.path}.:format", create_action_options)
      end

      def map_default_singleton_actions(map, resource)
        create_action_options = action_options_for("create", resource)
        map.connect(resource.path, create_action_options)
        map.connect("#{resource.path}.:format", create_action_options)
      end

      def map_new_actions(map, resource)
        resource.new_methods.each do |method, actions|
          actions.each do |action|
            action_options = action_options_for(action, resource, method)
            if action == :new
              # See http://dev.rubyonrails.org/ticket/8251
              map.deprecated_named_route("new_#{resource.name_prefix}#{resource.singular}", "#{resource.name_prefix}new_#{resource.singular}", resource.new_path, action_options)
              map.deprecated_named_route("formatted_new_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.name_prefix}new_#{resource.singular}", "#{resource.new_path}.:format", action_options)
            else
              # See http://dev.rubyonrails.org/ticket/8251
              map.deprecated_named_route("#{action}_new_#{resource.name_prefix}#{resource.singular}", "#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path}/#{action}", action_options)
              map.deprecated_named_route("formatted_#{action}_new_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path}/#{action}.:format", action_options)
            end
          end
        end
      end

      def map_member_actions(map, resource)
        resource.member_methods.each do |method, actions|
          actions.each do |action|
            action_options = action_options_for(action, resource, method)
            # See http://dev.rubyonrails.org/ticket/8251
            map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.singular}", "#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path}/#{action}", action_options)
            map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path}/#{action}.:format",action_options)
          end
        end

        show_action_options = action_options_for("show", resource)
        map.named_route("#{resource.name_prefix}#{resource.singular}", resource.member_path, show_action_options)
        map.named_route("formatted_#{resource.name_prefix}#{resource.singular}", "#{resource.member_path}.:format", show_action_options)

        update_action_options = action_options_for("update", resource)
        map.connect(resource.member_path, update_action_options)
        map.connect("#{resource.member_path}.:format", update_action_options)

        destroy_action_options = action_options_for("destroy", resource)
        map.connect(resource.member_path, destroy_action_options)
        map.connect("#{resource.member_path}.:format", destroy_action_options)
      end

      def conditions_for(method)
        { :conditions => method == :any ? {} : { :method => method } }
      end

      def action_options_for(action, resource, method = nil)
        default_options = { :action => action.to_s }
        require_id = !resource.kind_of?(SingletonResource)
        case default_options[:action]
          when "index", "new" : default_options.merge(conditions_for(method || :get)).merge(resource.requirements)
          when "create"       : default_options.merge(conditions_for(method || :post)).merge(resource.requirements)
          when "show", "edit" : default_options.merge(conditions_for(method || :get)).merge(resource.requirements(require_id))
          when "update"       : default_options.merge(conditions_for(method || :put)).merge(resource.requirements(require_id))
          when "destroy"      : default_options.merge(conditions_for(method || :delete)).merge(resource.requirements(require_id))
          else                  default_options.merge(conditions_for(method)).merge(resource.requirements)
        end
      end
  end
end

ActionController::Routing::RouteSet::Mapper.send :include, ActionController::Resources