Module: ActionDispatch::Routing::Mapper::Resources

Included in:

ActionDispatch::Routing::Mapper

Defined in:

lib/action_dispatch/routing/mapper.rb

Defined Under Namespace

Classes: Resource, SingletonResource

Constant Summary

VALID_ON_OPTIONS =

CANONICAL_ACTIONS holds all actions that does not need a prefix or a path appended since they fit properly in their scope level.

[:new, :collection, :member]

RESOURCE_OPTIONS =

[:as, :controller, :path, :only, :except]

CANONICAL_ACTIONS =

%w(index create new show update destroy)

Instance Method Summary

• #collection ⇒ Object
• #initialize(*args) ⇒ Object

  :nodoc:.

• #match(*args) ⇒ Object
• #member ⇒ Object
• #namespace(path, options = {}) ⇒ Object
• #nested ⇒ Object
• #new ⇒ Object
• #resource(*resources, &block) ⇒ Object
• #resources(*resources, &block) ⇒ Object
• #resources_path_names(options) ⇒ Object
• #root(options = {}) ⇒ Object
• #shallow ⇒ Object
• #shallow? ⇒ Boolean

Instance Method Details

#collection ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 611

def collection
  unless @scope[:scope_level] == :resources
    raise ArgumentError, "can't use collection outside resources scope"
  end

  collection_scope do
    yield
  end
end

#initialize(*args) ⇒ Object

:nodoc:

# File 'lib/action_dispatch/routing/mapper.rb', line 543

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

#match(*args) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 681

def match(*args)
  options = args.extract_options!.dup
  options[:anchor] = true unless options.key?(:anchor)

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

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

  if @scope[:scope_level] == :resources
    args.push(options)
    return nested { match(*args) }
  elsif @scope[:scope_level] == :resource
    args.push(options)
    return member { match(*args) }
  end

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

  if action.to_s =~ /^[\w\/]+$/
    options[:action] ||= action unless action.to_s.include?("/")
    options[:as] = name_for_action(action, options[:as])
  else
    options[:as] = name_for_action(options[:as])
  end

  super(path, options)
end

#member ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 621

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

  member_scope do
    yield
  end
end

#namespace(path, options = {}) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 663

def namespace(path, options = {})
  if resource_scope?
    nested { super }
  else
    super
  end
end

#nested ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 641

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

  with_scope_level(:nested) do
    if shallow?
      with_exclusive_scope do
        if @scope[:shallow_path].blank?
          scope(parent_resource.nested_scope, nested_options) { yield }
        else
          scope(@scope[:shallow_path], :as => @scope[:shallow_prefix]) do
            scope(parent_resource.nested_scope, nested_options) { yield }
          end
        end
      end
    else
      scope(parent_resource.nested_scope, nested_options) { yield }
    end
  end
end

#new ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 631

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

  new_scope do
    yield
  end
end

#resource(*resources, &block) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 552

def resource(*resources, &block)
  options = resources.extract_options!

  if apply_common_behavior_for(:resource, resources, options, &block)
    return self
  end

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

    collection_scope do
      post :create
    end if parent_resource.actions.include?(:create)

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

    member_scope  do
      get    :edit if parent_resource.actions.include?(:edit)
      get    :show if parent_resource.actions.include?(:show)
      put    :update if parent_resource.actions.include?(:update)
      delete :destroy if parent_resource.actions.include?(:destroy)
    end
  end

  self
end

#resources(*resources, &block) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 581

def resources(*resources, &block)
  options = resources.extract_options!

  if apply_common_behavior_for(:resources, resources, options, &block)
    return self
  end

  resource_scope(Resource.new(resources.pop, options)) do
    yield if block_given?

    collection_scope do
      get  :index if parent_resource.actions.include?(:index)
      post :create if parent_resource.actions.include?(:create)
    end

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

    member_scope  do
      get    :edit if parent_resource.actions.include?(:edit)
      get    :show if parent_resource.actions.include?(:show)
      put    :update if parent_resource.actions.include?(:update)
      delete :destroy if parent_resource.actions.include?(:destroy)
    end
  end

  self
end

#resources_path_names(options) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 548

def resources_path_names(options)
  @scope[:path_names].merge!(options)
end

#root(options = {}) ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 719

def root(options={})
  if @scope[:scope_level] == :resources
    with_scope_level(:root) do
      scope(parent_resource.path) do
        super(options)
      end
    end
  else
    super(options)
  end
end

#shallow ⇒ Object

# File 'lib/action_dispatch/routing/mapper.rb', line 671

def shallow
  scope(:shallow => true) do
    yield
  end
end

#shallow? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/action_dispatch/routing/mapper.rb', line 677

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