-
Notifications
You must be signed in to change notification settings - Fork 121
/
resourceful.coffee
233 lines (196 loc) · 7.09 KB
/
resourceful.coffee
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
# @mixin
# @todo Most of this stuff is only really relevant for the server,
# so consider moving it to the server folder. The only reason you'd want
# this on the client is to demo what the server can do from the client
# (think in-browser console or something). In that case we need to figure
# out how to include specific files in the browser manually.
Tower.Controller.Resourceful =
ClassMethods:
# Set information about resource/model for this controller.
#
# @example Pass in a string
# class App.UsersController extends App.ApplicationController
# @resource 'person'
#
# @example Pass in an object
# class App.UsersController extends App.ApplicationController
# @resource name: 'person', type: 'User', collectionName: 'people'
#
# @return [Function] Return this controller.
resource: (options) ->
metadata = @metadata()
if typeof options == 'string'
options =
name: options
type: Tower.Support.String.camelize(options)
collectionName: _.pluralize(options)
metadata.resourceName = options.name if options.name
if options.type
metadata.resourceType = options.type
metadata.resourceName = @_compileResourceName(options.type) unless options.name
metadata.collectionName = options.collectionName if options.collectionName
@
# Specify the parent model for this resourceful controller,
# corresponding to a nested path.
#
# @example
# class App.CommentsController extends App.ApplicationController
# @belongsTo 'post' # /posts/1/comments
#
# @example With options
# class App.CommentsController extends App.ApplicationController
# @belongsTo 'article', type: 'Post'
#
# @return [Array<Object>] Returns belongsTo array
belongsTo: (key, options) ->
belongsTo = @metadata().belongsTo
return belongsTo unless key
options ||= {}
options.key = key
options.type ||= Tower.Support.String.camelize(options.key)
belongsTo.push(options)
hasParent: ->
belongsTo = @belongsTo()
belongsTo.length > 0
actions: ->
args = _.flatten(_.args(arguments))
options = _.extractOptions(args)
actions = ['index', 'new', 'create', 'show', 'edit', 'update', 'destroy']
actionsToRemove = _.difference(actions, args, options.except || [])
for action in actionsToRemove
@[action] = null
delete @[action]
@
# Helper method to give you the {Tower.Model.Scope} and a new record.
#
# @param [Function] callback
#
# @return [void] Requires a callback
respondWithScoped: (callback) ->
@scoped (error, scope) =>
return @failure(error, callback) if error
@respondWith scope.build(), callback
respondWithStatus: (success, callback) ->
options = records: (@resource || @collection)
if callback && callback.length > 1
successResponder = new Tower.Controller.Responder(@, options)
failureResponder = new Tower.Controller.Responder(@, options)
callback.call @, successResponder, failureResponder
if success
successResponder[format].call @
else
failureResponder[format].call @, error
else
Tower.Controller.Responder.respond(@, options, callback)
# Returns a new record for the scope.
#
# @param [Function] callback
#
# @return [void] Requires a callback.
buildResource: (callback) ->
@scoped (error, scope) =>
return callback.call @, error, null if error
resource = scope.build(@params[@resourceName])
@set 'resource', resource
@set @resourceName, resource
# @[@resourceName] = @resource = scope.build(@params[@resourceName])
callback.call @, null, resource if callback
resource
createResource: (callback) ->
@scoped (error, scope) =>
return callback.call @, error, null if error
resource = null
scope.insert @params[@resourceName], (error, resource) =>
@set 'resource', resource
@set @resourceName, resource
# @[@resourceName] = @resource = resource
callback.call(@, null, resource) if callback
resource
# Returns the single record for the scope.
#
# @param [Function] callback
#
# @return [void] Requires a callback.
findResource: (callback) ->
@scoped (error, scope) =>
return callback.call @, error, null if error
scope.find @params.id, (error, resource) =>
@set 'resource', resource
@set @resourceName, resource
#@[@resourceName] = @resource = resource
callback.call @, error, resource
# Returns the set of records for the scope.
#
# @param [Function] callback
#
# @return [void] Requires a callback.
findCollection: (callback) ->
@scoped (error, scope) =>
return callback.call @, error, null if error
scope.all (error, collection) =>
@set 'collection', collection
@set @collectionName, collection
#@[@collectionName] = @collection = collection
callback.call @, error, collection if callback
# Finds the parent if `belongsTo` was defined for this controller.
#
# It does this by looking through the parameters for keys defined
# by the relations in `belongsTo`.
#
# @param [Function] callback
findParent: (callback) ->
relation = @findParentRelation()
if relation
parentClass = Tower.constant(relation.type)
parentClass.find @params[relation.param], (error, parent) =>
throw error if error && !callback
unless error
@set 'parent', parent
@set relation.key, parent
#@parent = @[relation.key] = parent
callback.call @, error, parent if callback
else
callback.call @, null, false if callback
false
findParentRelation: ->
belongsTo = @constructor.belongsTo()
params = @params
if belongsTo.length > 0
for relation in belongsTo
param = relation.param || "#{relation.key}Id"
if params.hasOwnProperty(param)
relation = _.extend({}, relation)
relation.param = param
return relation
return null
else
null
# Builds the scope for the current action, based on the resource defined for this controller.
#
# @param [Function] callback
#
# @return [void] Requires a callback.
scoped: (callback) ->
callbackWithScope = (error, scope) =>
callback.call @, error, scope.where(@cursor())
if @hasParent
@findParent (error, parent) =>
if error || !parent
callbackWithScope error, Tower.constant(@resourceType)
else
callbackWithScope(error, parent.get(@collectionName))
else
callbackWithScope null, Tower.constant(@resourceType)
undefined
resourceKlass: ->
Tower.constant(Tower.namespaced(@resourceType))
# @todo Default failure implemtation for create, update, and destory.
#
# @param [Tower.Model] resource
# @param [Function] callback
#
# @return [void] Requires a callback.
failure: (resource, callback) ->
callback()
undefined
module.exports = Tower.Controller.Resourceful