Module: HasDynamicColumns::Model::ClassMethods

Defined in:
lib/has_dynamic_columns/model/class_methods.rb

Instance Method Summary collapse

Instance Method Details

#has_dynamic_columns(*args) ⇒ Object



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/has_dynamic_columns/model/class_methods.rb', line 4

def has_dynamic_columns(*args)
	options = args.extract_options!
	configuration = {
		:as => "dynamic_columns",
		:field_scope => nil,
	}
       configuration.update(options) if options.is_a?(Hash)

	class_eval <<-EOV
		alias_method :as_json_before_#{configuration[:as]}, :as_json

		# Store all our configurations for usage later
		@@has_dynamic_columns_configurations ||= []		        
        @@has_dynamic_columns_configurations << #{configuration}

		include ::HasDynamicColumns::Model::InstanceMethods

		has_many :activerecord_dynamic_columns,
					class_name: "HasDynamicColumns::DynamicColumn",
					as: :field_scope
		has_many :activerecord_dynamic_column_data,
					class_name: "HasDynamicColumns::DynamicColumnDatum",
					as: :owner,
					autosave: true

		# only add to attr_accessible
		# if the class has some mass_assignment_protection
		if defined?(accessible_attributes) and !accessible_attributes.blank?
			#attr_accessible :#{configuration[:column]}
		end

		validate do |field_scope|
			field_scope = self.get_#{configuration[:as]}_field_scope

			if field_scope
				# has_many association
				if field_scope.respond_to?(:select) && field_scope.respond_to?(:collect)

				# belongs_to association
				else
					# All the fields defined on the parent model
					dynamic_columns = field_scope.send("activerecord_dynamic_columns")

					self.send("activerecord_dynamic_column_data").each { |dynamic_column_datum|
						# Collect all validation errors
						validation_errors = []

						if dynamic_column_datum.dynamic_column_option_id == -1
							validation_errors << "invalid_option"
						end

						# Find the dynamic_column defined for this datum
						dynamic_column = nil
						dynamic_columns.each { |i|
							if i == dynamic_column_datum.dynamic_column
								dynamic_column = i
								break
							end
						}
						# We have a dynamic_column - validate
						if dynamic_column
							dynamic_column.dynamic_column_validations.each { |validation|
								if !validation.is_valid?(dynamic_column_datum.value.to_s)
									validation_errors << validation.error
								end
							}
						else
							# No field found - this is probably bad - should we throw an error?
							validation_errors << "not_found"
						end

						# If any errors exist - add them
						if validation_errors.length > 0
							if dynamic_column.nil?
								# TODO - fix  from the has_many - need to fix validations
								#errors.add(:dynamic_columns, { "unknown" => validation_errors })
							else
								errors.add(:dynamic_columns, { dynamic_column.key.to_s => validation_errors })
							end
						end
					}
				end
			end
		end

		public
			# Order by dynamic columns
			def self.dynamic_order(field_scope, key, direction = :asc)
				table = self.name.constantize.arel_table
				column_table = HasDynamicColumns::DynamicColumn.arel_table.alias("dynamic_order_"+key.to_s)
				column_datum_table = HasDynamicColumns::DynamicColumnDatum.arel_table.alias("dynamic_order_data_"+key.to_s)

				field_scope_id = (!field_scope.nil?) ? field_scope.id : nil
				field_scope_type = (!field_scope.nil?) ? field_scope.class.name.constantize.to_s : nil
				dynamic_type = self.name.constantize.to_s

				# Join on the column with the key
				on_query = column_table[:key].eq(key)
				if !field_scope_type.nil?
					on_query = on_query.and(
						column_table[:field_scope_type].eq(field_scope_type)
					)
				end
				if !field_scope_id.nil?
					on_query = on_query.and(
						column_table[:field_scope_id].eq(field_scope_id)
					)
				end

				column_table_join_on = column_table
										.create_on(
											on_query
										)

				column_table_join = table.create_join(column_table, column_table_join_on)
				query = joins(column_table_join)

				# Join on all the data with the provided key
				column_table_datum_join_on = column_datum_table
										.create_on(
											column_datum_table[:owner_id].eq(table[:id]).and(
												column_datum_table[:owner_type].eq(dynamic_type)
											).and(
												column_datum_table[:dynamic_column_id].eq(column_table[:id])
											)
										)

				column_table_datum_join = table.create_join(column_datum_table, column_table_datum_join_on)
				query = query.joins(column_table_datum_join)

				# Order
				query = query.order(column_datum_table[:value].send(direction))

				# Group required - we have many rows
				query = query.group(table[:id])

				query
			end

			# Depricated
			# Find by dynamic columns
			def self.dynamic_where(*args)
				field_scope = args[0].is_a?(Hash) ? nil : args[0]
				options = args.extract_options!

				field_scope_id = (!field_scope.nil?) ? field_scope.id : nil
				field_scope_type = (!field_scope.nil?) ? field_scope.class.name.constantize.to_s : nil

				dynamic_type = self.name.constantize.to_s

				table = self.name.constantize.arel_table
				query = nil

				# Need to join on each of the keys we are performing where on
				options.each { |key, value|
					# Don't bother with empty values
					next if value.to_s.empty?

					column_datum_store_table_type = "HasDynamicColumns::DynamicColumnStringDatum"
					if !field_scope.nil? && a = field_scope.activerecord_dynamic_columns.where(key: key.to_s).first
						column_datum_store_table_type = "HasDynamicColumns::DynamicColumn"+a.data_type.to_s.capitalize+"Datum"
					end

					column_table = HasDynamicColumns::DynamicColumn.arel_table.alias("dynamic_where_"+key.to_s)
					column_datum_table = HasDynamicColumns::DynamicColumnDatum.arel_table.alias("dynamic_where_data_"+key.to_s)
					column_datum_store_table = column_datum_store_table_type.constantize.arel_table.alias("dynamic_where_data_store_"+key.to_s)

					# Join on the column with the key
					on_query = column_table[:key].eq(key)
					if !field_scope_type.nil?
						on_query = on_query.and(
							column_table[:field_scope_type].eq(field_scope_type)
						)
					end
					if !field_scope_id.nil?
						on_query = on_query.and(
							column_table[:field_scope_id].eq(field_scope_id)
						)
					end

					column_table_join_on = column_table
											.create_on(
												on_query
											)

					column_table_join = table.create_join(column_table, column_table_join_on)
					query = (query.nil?)? joins(column_table_join) : query.joins(column_table_join)

					# Join on all the data with the provided key
					column_table_datum_join_on = column_datum_table
											.create_on(
												column_datum_table[:owner_id].eq(table[:id]).and(
													column_datum_table[:owner_type].eq(dynamic_type)
												).and(
													column_datum_table[:dynamic_column_id].eq(column_table[:id])
												)
											)

					column_table_datum_join = table.create_join(column_datum_table, column_table_datum_join_on)
					query = query.joins(column_table_datum_join)
					

					# Join on the actual data
					column_table_datum_store_join_on = column_datum_store_table
											.create_on(
												column_datum_table[:datum_id].eq(column_datum_store_table[:id]).and(
													column_datum_table[:datum_type].eq(column_datum_store_table_type)
												).and(
													column_datum_store_table[:value].matches("%"+value+"%")
												)
											)
		
					column_table_datum_store_join = table.create_join(column_datum_store_table, column_table_datum_store_join_on)

					query = query.joins(column_table_datum_store_join)
				}
				# Group required - we have many rows
				query = (query.nil?)? group(table[:id]) : query.group(table[:id])

				query
			end

			def as_json(*args)
				json = super(*args)
				options = args.extract_options!

				@@has_dynamic_columns_configurations.each { |config|
					if !options[:root].nil?
						json[options[:root]][config[:as].to_s] = self.send(config[:as].to_s, true)
					else
						json[config[:as].to_s] = self.send(config[:as].to_s, true)
					end
				}

				json
			end

			# Setter for dynamic field data
			def #{configuration[:as]}=data
				data.each_pair { |key, value|
					# We dont play well with this key
					raise NoMethodError.new "This key isn't storable" if !self.storable_#{configuration[:as].to_s.singularize}_key?(key)

					dynamic_column = self.#{configuration[:as].to_s.singularize}_key_to_dynamic_column(key)

					# Expecting array data type
					raise ArgumentError.new "Multiple columns must be passed arrays" if dynamic_column.multiple && !value.is_a?(Array)

					# Treat everything as an array - makes building easier
					value = [value] if !value.is_a?(Array)

					# Loop each value - sets existing data or builds a new data node
					existing = self.activerecord_dynamic_column_data.select { |i| i.dynamic_column == dynamic_column }
					value.each_with_index { |datum, datum_index|
						if existing[datum_index]
							# Undelete this node if its now needed
							existing[datum_index].reload if existing[datum_index].marked_for_destruction?
							existing[datum_index].value = datum
						# No existing placeholder - build a new one
						else
							self.activerecord_dynamic_column_data.build(:dynamic_column => dynamic_column, :value => datum)
						end
					}

					# Any record no longer needed should be marked for destruction
					existing.each_with_index { |i,index|
						if index > value.length
							i.mark_for_destruction
						end
					}
				}
			end

			def #{configuration[:as]}(as_json = false)
				h = {}
				self.field_scope_#{configuration[:as]}.each { |i|
					h[i.key] = (i.multiple)? [] : nil
				}

				self.activerecord_dynamic_column_data.each { |i|
					if i.dynamic_column && h.has_key?(i.dynamic_column.key)
						v = i.value
						v = v.as_json(:root => nil) if as_json && v.respond_to?(:as_json)

						# If a specific column is used, use it in the as_json method
						v = v[i.dynamic_column.column_name] if as_json && v && v.is_a?(Hash) && !i.dynamic_column.column_name.to_s.empty?

						if i.dynamic_column.multiple
							h[i.dynamic_column.key] << v
						else
							h[i.dynamic_column.key] = v
						end
					end
				}

				h
			end

			def #{configuration[:as].to_s.singularize}_keys
				self.field_scope_#{configuration[:as]}.collect { |i| i.key }
			end

			def field_scope_#{configuration[:as]}
				obj = self.get_#{configuration[:as]}_field_scope

				# has_many relationship
				if obj.respond_to?(:select) && obj.respond_to?(:collect)
					obj.collect { |i|
						i.send("activerecord_dynamic_columns") if i.respond_to?(:activerecord_dynamic_columns)
					}.flatten.select { |i|
						i.dynamic_type.to_s.empty? || i.dynamic_type.to_s == self.class.to_s
					}
				# belongs_to relationship
				elsif obj.respond_to?(:activerecord_dynamic_columns)
					obj.send("activerecord_dynamic_columns").select { |i|
						# Only get things with no dynamic type defined or dynamic types defined as this class
						i.dynamic_type.to_s.empty? || i.dynamic_type.to_s == self.class.to_s
					}
				else
					[]
				end
			end

		protected
			def get_#{configuration[:as]}_field_scope
				# Sometimes association doesnt exist
				begin
				#{configuration[:field_scope]}
				rescue
				end
			end

			# Whether this is storable
			def storable_#{configuration[:as].to_s.singularize}_key?(key)
				self.#{configuration[:as].to_s.singularize}_keys.include?(key.to_s)
			end

			# Figures out which dynamic_column has which key
			def #{configuration[:as].to_s.singularize}_key_to_dynamic_column(key)
				found = nil
				if record = self.send('field_scope_#{configuration[:as]}').select { |i| i.key == key.to_s }.first
					found = record
				end
				found
			end
	EOV
end