-
Notifications
You must be signed in to change notification settings - Fork 27
/
crud_controller.rb
200 lines (165 loc) · 6.5 KB
/
crud_controller.rb
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
# Abstract controller providing basic CRUD actions.
# This implementation mainly follows the one of the Rails scaffolding
# controller and responses to HTML and JSON requests. Some enhancements were made to ease extendability.
# Several protected helper methods are there to be (optionally) overriden by subclasses.
# With the help of additional callbacks, it is possible to hook into the action procedures without
# overriding the entire method.
class CrudController < ListController
include ERB::Util
helper_method :entry, :full_entry_label
delegate :model_identifier, :to => 'self.class'
hide_action :model_identifier, :run_callbacks
# Defines before and after callback hooks for create, update, save and destroy actions.
define_model_callbacks :create, :update, :save, :destroy
# Defines before callbacks for the render actions. A virtual callback
# unifiying render_new and render_edit, called render_form, is defined further down.
define_render_callbacks :show, :new, :edit
############## ACTIONS ############################################
# Show one entry of this model.
# GET /entries/1
# GET /entries/1.json
def show(&block)
customizable_respond_with(entry, block)
end
# Display a form to create a new entry of this model.
# GET /entries/new
# GET /entries/new.json
def new(&block)
assign_attributes
customizable_respond_with(entry, block)
end
# Create a new entry of this model from the passed params.
# There are before and after create callbacks to hook into the action.
# To customize the response, you may overwrite this action and call
# super with a block that gets success and format parameters.
# POST /entries
# POST /entries.json
def create(&block)
assign_attributes
created = with_callbacks(:create, :save) { entry.save }
customizable_respond_to(created, block) do |format|
if created
format.html { redirect_to_show success_notice }
format.json { render :json => entry, :status => :created, :location => path_args(entry) }
else
format.html { render_with_callback 'new' }
format.json { render :json => entry.errors, :status => :unprocessable_entity }
end
end
end
# Display a form to edit an exisiting entry of this model.
# GET /entries/1/edit
def edit
render_with_callback 'edit'
end
# Update an existing entry of this model from the passed params.
# There are before and after update callbacks to hook into the action.
# To customize the response, you may overwrite this action and call
# super with a block that gets success and format parameters.
# PUT /entries/1
# PUT /entries/1.json
def update(&block)
assign_attributes
updated = with_callbacks(:update, :save) { entry.save }
customizable_respond_to(updated, block) do |format|
if updated
format.html { redirect_to_show success_notice }
format.json { head :ok }
else
format.html { render_with_callback 'edit' }
format.json { render :json => entry.errors, :status => :unprocessable_entity }
end
end
end
# Destroy an existing entry of this model.
# There are before and after destroy callbacks to hook into the action.
# To customize the response, you may overwrite this action and call
# super with a block that gets success and format parameters.
# DELETE /entries/1
# DELETE /entries/1.json
def destroy(&block)
destroyed = run_callbacks(:destroy) { entry.destroy }
customizable_respond_to(destroyed, block) do |format|
if destroyed
format.html { redirect_to_index success_notice }
format.json { head :ok }
else
format.html {
flash.alert = entry.errors.full_messages.join('<br/>')
request.env["HTTP_REFERER"].present? ? redirect_to(:back) : redirect_to_show
}
format.json { render :json => entry.errors, :status => :unprocessable_entity }
end
end
end
protected
############# CUSTOMIZABLE HELPER METHODS ##############################
# Main accessor method for the handled model entry.
def entry
@entry ||= set_model_ivar(params[:id] ? find_entry : build_entry)
end
# Creates a new model entry.
def build_entry
model_scope.new
end
# Sets an existing model entry from the given id.
def find_entry
model_scope.find(params[:id])
end
# Assigns the attributes from the params to the model entry.
def assign_attributes
entry.attributes = params[model_identifier]
end
# A label for the current entry, including the model name.
def full_entry_label
"#{models_label(false)} <i>#{h(entry)}</i>".html_safe
end
# Redirects to the show action of a single entry.
def redirect_to_show(options = {})
redirect_to path_args(entry), options
end
# Redirects to the main action of this controller.
def redirect_to_index(options = {})
redirect_to polymorphic_path(path_args(model_class), :returning => true), options
end
# Helper method the run the given block in between the before and after
# callbacks of the given kinds.
def with_callbacks(*kinds, &block)
kinds.reverse.inject(block) do |b, kind|
lambda { run_callbacks(kind, &b) }
end.call
end
private
# Convenience method to respond to various formats if the performed
# action may succeed or fail. It is possible to pass a custom_block and respond
# in custom ways for certain cases. If no response is performed in the
# given block, the default responses in the main block are executed.
def customizable_respond_to(success, custom_block = nil)
respond_to do |format|
custom_block.call(success, format) if custom_block
return if performed?
yield format
end
end
# Create an I18n flash notice if the action was successfull.
# Uses the key {controller_name}.{action_name}.flash.success
# or crud.{action_name}.flash.success as fallback.
def success_notice
key = "#{action_name}.flash.success"
{:notice => t(:"#{controller_name}.#{key}",
:model => full_entry_label,
:default => :"crud.#{key}")}
end
class << self
# The identifier of the model used for form parameters.
# I.e., the symbol of the underscored model name.
def model_identifier
@model_identifier ||= model_class.name.underscore.to_sym
end
# Convenience callback to apply a callback on both form actions (new and edit).
def before_render_form(*methods)
before_render_new *methods
before_render_edit *methods
end
end
end