1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/actionpack/lib/action_dispatch/routing/mapper.rb

423 lines
12 KiB
Ruby
Raw Normal View History

2009-10-20 11:14:46 -04:00
module ActionDispatch
module Routing
2009-10-20 13:31:23 -04:00
class Mapper
module Resources
class Resource #:nodoc:
attr_reader :plural, :singular
def initialize(entities, options = {})
entities = entities.to_s
@plural = entities.pluralize
@singular = entities.singularize
end
def name
plural
end
def controller
plural
end
def member_name
singular
end
def collection_name
plural
end
end
class SingletonResource < Resource #:nodoc:
def initialize(entity, options = {})
super
end
def name
singular
end
end
2009-10-20 13:31:23 -04:00
def resource(*resources, &block)
2009-11-29 18:01:14 -05:00
options = resources.extract_options!
2009-10-20 13:31:23 -04:00
if resources.length > 1
raise ArgumentError if block_given?
resources.each { |r| resource(r, options) }
return self
end
resource = SingletonResource.new(resources.pop)
2009-10-20 13:31:23 -04:00
if @scope[:scope_level] == :resources
parent_resource = @scope[:scope_level_options][:name]
parent_named_prefix = @scope[:scope_level_options][:name_prefix]
with_scope_level(:member) do
scope(":#{parent_resource}_id", :name_prefix => parent_named_prefix) do
resource(resource.name, options, &block)
end
end
2009-10-20 13:31:23 -04:00
return self
end
controller(resource.controller) do
namespace(resource.name) do
2009-12-07 20:31:29 -05:00
with_scope_level(:resource, :name => resource.singular, :name_prefix => "#{resource.member_name}_") do
2009-10-20 13:31:23 -04:00
yield if block_given?
get "", :to => :show, :as => resource.member_name
2009-10-20 13:31:23 -04:00
post "", :to => :create
put "", :to => :update
delete "", :to => :destroy
get "new", :to => :new, :as => "new_#{resource.singular}"
get "edit", :to => :edit, :as => "edit_#{resource.singular}"
2009-10-20 13:31:23 -04:00
end
end
end
2009-10-20 13:31:23 -04:00
self
end
2009-10-20 13:31:23 -04:00
def resources(*resources, &block)
2009-11-29 18:01:14 -05:00
options = resources.extract_options!
2009-10-20 13:31:23 -04:00
if resources.length > 1
raise ArgumentError if block_given?
resources.each { |r| resources(r, options) }
return self
end
resource = Resource.new(resources.pop)
2009-10-20 13:31:23 -04:00
if @scope[:scope_level] == :resources
parent_resource = @scope[:scope_level_options][:name]
parent_named_prefix = @scope[:scope_level_options][:name_prefix]
with_scope_level(:member) do
scope(":#{parent_resource}_id", :name_prefix => parent_named_prefix) do
resources(resource.name, options, &block)
end
end
2009-10-20 13:31:23 -04:00
return self
end
controller(resource.controller) do
namespace(resource.name) do
2009-12-07 20:31:29 -05:00
with_scope_level(:resources, :name => resource.singular, :name_prefix => "#{resource.member_name}_") do
2009-10-20 13:31:23 -04:00
yield if block_given?
collection do
get "", :to => :index, :as => resource.collection_name
post "", :to => :create
get "new", :to => :new, :as => "new_#{resource.singular}"
end
2009-10-20 13:31:23 -04:00
member do
get "", :to => :show, :as => resource.member_name
2009-10-20 13:31:23 -04:00
put "", :to => :update
delete "", :to => :destroy
get "edit", :to => :edit, :as => "edit_#{resource.singular}"
2009-10-20 13:31:23 -04:00
end
end
end
end
2009-10-20 13:31:23 -04:00
self
end
2009-10-20 13:31:23 -04:00
def collection
unless @scope[:scope_level] == :resources
raise ArgumentError, "can't use collection outside resources scope"
end
2009-10-20 13:31:23 -04:00
with_scope_level(:collection) do
yield
end
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
def member
unless @scope[:scope_level] == :resources
raise ArgumentError, "can't use member outside resources scope"
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
with_scope_level(:member) do
scope(":id") do
yield
end
end
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def match(*args)
2009-11-29 18:01:14 -05:00
options = args.extract_options!
2009-10-20 13:31:23 -04:00
args.push(options)
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
case options.delete(:on)
when :collection
return collection { match(*args) }
when :member
return member { match(*args) }
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
if @scope[:scope_level] == :resources
raise ArgumentError, "can't define route directly in resources scope"
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
super
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
private
def with_scope_level(kind, options = {})
2009-10-20 13:31:23 -04:00
old, @scope[:scope_level] = @scope[:scope_level], kind
old_options, @scope[:scope_level_options] = @scope[:scope_level_options], options
2009-10-20 13:31:23 -04:00
yield
ensure
@scope[:scope_level] = old
@scope[:scope_level_options] = old_options
2009-10-20 13:31:23 -04:00
end
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
module Scoping
2009-11-29 18:39:37 -05:00
def self.extended(object)
object.instance_eval do
@scope = {}
end
end
2009-10-20 13:31:23 -04:00
def scope(*args)
2009-11-29 18:01:14 -05:00
options = args.extract_options!
2009-10-20 11:14:46 -04:00
case args.first
when String
options[:path] = args.first
when Symbol
options[:controller] = args.first
end
if path = options.delete(:path)
path_set = true
path, @scope[:path] = @scope[:path], "#{@scope[:path]}#{Rack::Mount::Utils.normalize_path(path)}"
else
path_set = false
end
if name_prefix = options.delete(:name_prefix)
name_prefix_set = true
2009-12-07 20:31:29 -05:00
name_prefix, @scope[:name_prefix] = @scope[:name_prefix], (@scope[:name_prefix] ? "#{@scope[:name_prefix]}#{name_prefix}" : name_prefix)
else
name_prefix_set = false
end
if controller = options.delete(:controller)
controller_set = true
controller, @scope[:controller] = @scope[:controller], controller
else
controller_set = false
end
2009-10-20 13:31:23 -04:00
constraints = options.delete(:constraints) || {}
unless constraints.is_a?(Hash)
block, constraints = constraints, {}
end
constraints, @scope[:constraints] = @scope[:constraints], (@scope[:constraints] || {}).merge(constraints)
blocks, @scope[:blocks] = @scope[:blocks], (@scope[:blocks] || []) + [block]
options, @scope[:options] = @scope[:options], (@scope[:options] || {}).merge(options)
yield
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
self
ensure
@scope[:path] = path if path_set
@scope[:name_prefix] = name_prefix if name_prefix_set
2009-10-20 13:31:23 -04:00
@scope[:controller] = controller if controller_set
@scope[:options] = options
@scope[:blocks] = blocks
@scope[:constraints] = constraints
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def controller(controller)
scope(controller.to_sym) { yield }
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def namespace(path)
scope(path.to_s) { yield }
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def constraints(constraints = {})
scope(:constraints => constraints) { yield }
2009-10-20 11:14:46 -04:00
end
2009-11-29 18:39:37 -05:00
def match(*args)
options = args.extract_options!
options = (@scope[:options] || {}).merge(options)
args.push(options)
super(*args)
end
2009-10-20 13:31:23 -04:00
end
2009-10-20 11:14:46 -04:00
2009-11-29 18:45:12 -05:00
module HttpHelpers
def get(*args, &block)
map_method(:get, *args, &block)
end
def post(*args, &block)
map_method(:post, *args, &block)
end
def put(*args, &block)
map_method(:put, *args, &block)
end
def delete(*args, &block)
map_method(:delete, *args, &block)
end
def redirect(path, options = {})
status = options[:status] || 301
lambda { |env|
req = Rack::Request.new(env)
url = req.scheme + '://' + req.host + path
[status, {'Location' => url, 'Content-Type' => 'text/html'}, ['Moved Permanently']]
}
end
private
def map_method(method, *args, &block)
options = args.extract_options!
options[:via] = method
args.push(options)
match(*args, &block)
self
end
end
2009-10-20 13:31:23 -04:00
class Constraints
2009-11-29 18:39:37 -05:00
def new(app, constraints = [])
if constraints.any?
super(app, constraints)
else
app
end
end
2009-10-20 13:31:23 -04:00
def initialize(app, constraints = [])
@app, @constraints = app, constraints
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def call(env)
req = Rack::Request.new(env)
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
@constraints.each { |constraint|
if constraint.respond_to?(:matches?) && !constraint.matches?(req)
2009-11-10 20:12:54 -05:00
return [417, {}, []]
2009-10-20 13:31:23 -04:00
elsif constraint.respond_to?(:call) && !constraint.call(req)
2009-11-10 20:12:54 -05:00
return [417, {}, []]
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
}
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
@app.call(env)
end
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
def initialize(set)
@set = set
2009-10-20 11:14:46 -04:00
2009-11-29 18:45:12 -05:00
extend HttpHelpers
2009-10-20 13:31:23 -04:00
extend Scoping
extend Resources
2009-10-20 11:14:46 -04:00
end
def root(options = {})
match '/', options.merge(:as => :root)
end
2009-10-20 13:31:23 -04:00
def match(*args)
2009-11-29 18:01:14 -05:00
options = args.extract_options!
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
if args.length > 1
args.each { |path| match(path, options.reverse_merge(:as => path.to_sym)) }
2009-10-20 13:31:23 -04:00
return self
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
if args.first.is_a?(Symbol)
return match(args.first.to_s, options.merge(:to => args.first.to_sym))
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
path = args.first
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
conditions, defaults = {}, {}
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
path = nil if path == ""
path = Rack::Mount::Utils.normalize_path(path) if path
path = "#{@scope[:path]}#{path}" if @scope[:path]
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
raise ArgumentError, "path is required" unless path
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
constraints = options[:constraints] || {}
unless constraints.is_a?(Hash)
block, constraints = constraints, {}
2009-10-20 11:14:46 -04:00
end
2009-10-20 13:31:23 -04:00
blocks = ((@scope[:blocks] || []) + [block]).compact
constraints = (@scope[:constraints] || {}).merge(constraints)
options.each { |k, v| constraints[k] = v if v.is_a?(Regexp) }
2009-10-20 11:14:46 -04:00
conditions[:path_info] = path
requirements = constraints.dup
2009-10-20 11:14:46 -04:00
path_regexp = Rack::Mount::Strexp.compile(path, constraints, SEPARATORS)
segment_keys = Rack::Mount::RegexpWithNamedGroups.new(path_regexp).names
2009-10-20 13:31:23 -04:00
constraints.reject! { |k, v| segment_keys.include?(k.to_s) }
conditions.merge!(constraints)
2009-10-20 11:14:46 -04:00
requirements[:controller] ||= @set.controller_constraints
2009-11-23 20:44:43 -05:00
2009-10-20 13:31:23 -04:00
if via = options[:via]
via = Array(via).map { |m| m.to_s.upcase }
conditions[:request_method] = Regexp.union(*via)
2009-10-20 11:14:46 -04:00
end
2009-11-29 18:39:37 -05:00
defaults[:controller] ||= @scope[:controller].to_s if @scope[:controller]
2009-10-20 11:14:46 -04:00
2009-11-29 18:39:37 -05:00
app = initialize_app_endpoint(options, defaults)
validate_defaults!(app, defaults, segment_keys)
app = Constraints.new(app, blocks)
2009-10-20 11:14:46 -04:00
2009-12-07 20:31:29 -05:00
name = @scope[:name_prefix] ? "#{@scope[:name_prefix]}#{options[:as]}" : options[:as]
@set.add_route(app, conditions, requirements, defaults, name)
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
self
end
2009-10-20 11:14:46 -04:00
2009-10-20 13:31:23 -04:00
private
2009-11-29 18:39:37 -05:00
def initialize_app_endpoint(options, defaults)
app = nil
if options[:to].respond_to?(:call)
app = options[:to]
defaults.delete(:controller)
defaults.delete(:action)
elsif options[:to].is_a?(String)
defaults[:controller], defaults[:action] = options[:to].split('#')
elsif options[:to].is_a?(Symbol)
defaults[:action] = options[:to].to_s
end
app || Routing::RouteSet::Dispatcher.new(:defaults => defaults)
end
def validate_defaults!(app, defaults, segment_keys)
return unless app.is_a?(Routing::RouteSet::Dispatcher)
unless defaults.include?(:controller) || segment_keys.include?("controller")
raise ArgumentError, "missing :controller"
end
unless defaults.include?(:action) || segment_keys.include?("action")
raise ArgumentError, "missing :action"
end
end
2009-10-20 11:14:46 -04:00
end
end
end