Class: ActionDispatch::Routing::Mapper::Resources::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/routing/mapper.rb

Overview

:nodoc:

Direct Known Subclasses

SingletonResource

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entities, options = {}) ⇒ Resource

Returns a new instance of Resource.



1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1061

def initialize(entities, options = {})
  @name       = entities.to_s
  @path       = (options[:path] || @name).to_s
  @controller = (options[:controller] || @name).to_s
  @as         = options[:as]
  @param      = (options[:param] || :id).to_sym
  @options    = options
  @shallow    = false
end

Instance Attribute Details

#controller ⇒ Object (readonly)

Returns the value of attribute controller.



1059
1060
1061
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1059

def controller
  @controller
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



1059
1060
1061
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1059

def options
  @options
end

#param ⇒ Object (readonly)

Returns the value of attribute param.



1059
1060
1061
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1059

def param
  @param
end

#path ⇒ Object (readonly) Also known as: collection_scope

Returns the value of attribute path.



1059
1060
1061
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1059

def path
  @path
end

Instance Method Details

#actions ⇒ Object 



1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1075

def actions
  if only = @options[:only]
    Array(only).map(&:to_sym)
  elsif except = @options[:except]
    default_actions - Array(except).map(&:to_sym)
  else
    default_actions
  end
end

#collection_name ⇒ Object

Checks for uncountable plurals, and appends “_index” if the plural and singular form are the same.



1101
1102
1103
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1101

def collection_name
  singular == plural ? "#{plural}_index" : plural
end

#default_actions ⇒ Object 



1071
1072
1073
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1071

def default_actions
  [:index, :create, :new, :show, :update, :destroy, :edit]
end

#member_scope ⇒ Object Also known as: shallow_scope 



1111
1112
1113
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1111

def member_scope
  "#{path}/:#{param}"
end

#name ⇒ Object 



1085
1086
1087
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1085

def name
  @as || @name
end

#nested_param ⇒ Object 



1121
1122
1123
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1121

def nested_param
  :"#{singular}_#{param}"
end

#nested_scope ⇒ Object 



1125
1126
1127
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1125

def nested_scope
  "#{path}/:#{nested_param}"
end

#new_scope(new_path) ⇒ Object 



1117
1118
1119
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1117

def new_scope(new_path)
  "#{path}/#{new_path}"
end

#plural ⇒ Object 



1089
1090
1091
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1089

def plural
  @plural ||= name.to_s
end

#resource_scope ⇒ Object 



1105
1106
1107
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1105

def resource_scope
  { :controller => controller }
end

#shallow=(value) ⇒ Object 



1129
1130
1131
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1129

def shallow=(value)
  @shallow = value
end

#shallow? ⇒ Boolean

Returns:

  • (Boolean) 


1133
1134
1135
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1133

def shallow?
  @shallow
end

#singular ⇒ Object Also known as: member_name 



1093
1094
1095
 
# File 'lib/action_dispatch/routing/mapper.rb', line 1093

def singular
  @singular ||= name.to_s.singularize
end