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

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

Overview

:nodoc:

Direct Known Subclasses

SingletonResource

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Resource.


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1132

def initialize(entities, api_only, shallow, options = {})
  if options[:param].to_s.include?(":")
    raise ArgumentError, ":param option can't contain colons"
  end

  @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    = shallow
  @api_only   = api_only
  @only       = options.delete :only
  @except     = options.delete :except
end

Instance Attribute Details

#controllerObject (readonly)

Returns the value of attribute controller.


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

def controller
  @controller
end

#paramObject (readonly)

Returns the value of attribute param.


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

def param
  @param
end

#pathObject (readonly) Also known as: collection_scope

Returns the value of attribute path.


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

def path
  @path
end

Instance Method Details

#actionsObject


1157
1158
1159
1160
1161
1162
1163
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1157

def actions
  if @except
    available_actions - Array(@except).map(&:to_sym)
  else
    available_actions
  end
end

#available_actionsObject


1165
1166
1167
1168
1169
1170
1171
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1165

def available_actions
  if @only
    Array(@only).map(&:to_sym)
  else
    default_actions
  end
end

#collection_nameObject

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


1189
1190
1191
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1189

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

#default_actionsObject


1149
1150
1151
1152
1153
1154
1155
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1149

def default_actions
  if @api_only
    [:index, :create, :show, :update, :destroy]
  else
    [:index, :create, :new, :show, :update, :destroy, :edit]
  end
end

#member_scopeObject Also known as: shallow_scope


1199
1200
1201
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1199

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

#nameObject


1173
1174
1175
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1173

def name
  @as || @name
end

#nested_paramObject


1209
1210
1211
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1209

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

#nested_scopeObject


1213
1214
1215
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1213

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

#new_scope(new_path) ⇒ Object


1205
1206
1207
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1205

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

#pluralObject


1177
1178
1179
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1177

def plural
  @plural ||= name.to_s
end

#resource_scopeObject


1193
1194
1195
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1193

def resource_scope
  controller
end

#shallow?Boolean

Returns:

  • (Boolean)

1217
1218
1219
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1217

def shallow?
  @shallow
end

#singleton?Boolean

Returns:

  • (Boolean)

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

def singleton?; false; end

#singularObject Also known as: member_name


1181
1182
1183
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 1181

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