This repository has been archived by the owner on Apr 17, 2018. It is now read-only.
/
model.rb
787 lines (682 loc) · 23.6 KB
/
model.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
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
# TODO: add Model#create!, Model#update, Model#update!, Model#destroy and Model#destroy!
# TODO: DRY up raise_on_save_failure with attr_accessor_with_default
# once AS branch is merged in
module DataMapper
module Model
extend Chainable
# Creates a new Model class with default_storage_name +storage_name+
#
# If a block is passed, it will be eval'd in the context of the new Model
#
# @param [Proc] block
# a block that will be eval'd in the context of the new Model class
#
# @return [Model]
# the newly created Model class
#
# @api semipublic
def self.new(storage_name = nil, &block)
model = Class.new
model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
include DataMapper::Resource
def self.name
to_s
end
RUBY
if storage_name
warn "Passing in +storage_name+ to #{name}.new is deprecated (#{caller[0]})"
model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
def self.default_storage_name
#{ActiveSupport::Inflector.classify(storage_name).inspect}.freeze
end
RUBY
end
model.instance_eval(&block) if block
model
end
# Return all models that extend the Model module
#
# class Foo
# include DataMapper::Resource
# end
#
# DataMapper::Model.descendants.first #=> Foo
#
# @return [DescendantSet]
# Set containing the descendant models
#
# @api semipublic
def self.descendants
@descendants ||= DescendantSet.new
end
# Return all models that inherit from a Model
#
# class Foo
# include DataMapper::Resource
# end
#
# class Bar < Foo
# end
#
# Foo.descendants.first #=> Bar
#
# @return [Set]
# Set containing the descendant classes
#
# @api semipublic
attr_reader :descendants
# Return if Resource#save should raise an exception on save failures (globally)
#
# This is false by default.
#
# DataMapper::Model.raise_on_save_failure # => false
#
# @return [Boolean]
# true if a failure in Resource#save should raise an exception
#
# @api public
def self.raise_on_save_failure
if defined?(@raise_on_save_failure)
@raise_on_save_failure
else
false
end
end
# Specify if Resource#save should raise an exception on save failures (globally)
#
# @param [Boolean]
# a boolean that if true will cause Resource#save to raise an exception
#
# @return [Boolean]
# true if a failure in Resource#save should raise an exception
#
# @api public
def self.raise_on_save_failure=(raise_on_save_failure)
@raise_on_save_failure = raise_on_save_failure
end
# Return if Resource#save should raise an exception on save failures (per-model)
#
# This delegates to DataMapper::Model.raise_on_save_failure by default.
#
# User.raise_on_save_failure # => false
#
# @return [Boolean]
# true if a failure in Resource#save should raise an exception
#
# @api public
def raise_on_save_failure
if defined?(@raise_on_save_failure)
@raise_on_save_failure
else
DataMapper::Model.raise_on_save_failure
end
end
# Specify if Resource#save should raise an exception on save failures (per-model)
#
# @param [Boolean]
# a boolean that if true will cause Resource#save to raise an exception
#
# @return [Boolean]
# true if a failure in Resource#save should raise an exception
#
# @api public
def raise_on_save_failure=(raise_on_save_failure)
@raise_on_save_failure = raise_on_save_failure
end
# Appends a module for inclusion into the model class after Resource.
#
# This is a useful way to extend Resource while still retaining a
# self.included method.
#
# @param [Module] inclusions
# the module that is to be appended to the module after Resource
#
# @return [Boolean]
# true if the inclusions have been successfully appended to the list
#
# @api semipublic
def self.append_inclusions(*inclusions)
extra_inclusions.concat inclusions
# Add the inclusion to existing descendants
descendants.each do |model|
inclusions.each { |inclusion| model.send :include, inclusion }
end
true
end
# The current registered extra inclusions
#
# @return [Set]
#
# @api private
def self.extra_inclusions
@extra_inclusions ||= []
end
# Extends the model with this module after Resource has been included.
#
# This is a useful way to extend Model while still retaining a self.extended method.
#
# @param [Module] extensions
# List of modules that will extend the model after it is extended by Model
#
# @return [Boolean]
# whether or not the inclusions have been successfully appended to the list
#
# @api semipublic
def self.append_extensions(*extensions)
extra_extensions.concat extensions
# Add the extension to existing descendants
descendants.each do |model|
extensions.each { |extension| model.extend(extension) }
end
true
end
# The current registered extra extensions
#
# @return [Set]
#
# @api private
def self.extra_extensions
@extra_extensions ||= []
end
# @api private
def self.extended(model)
descendants = self.descendants
descendants << model
model.instance_variable_set(:@valid, false)
model.instance_variable_set(:@base_model, model)
model.instance_variable_set(:@storage_names, {})
model.instance_variable_set(:@default_order, {})
model.instance_variable_set(:@descendants, descendants.class.new(model, descendants))
model.extend(Chainable)
extra_extensions.each { |mod| model.extend(mod) }
extra_inclusions.each { |mod| model.send(:include, mod) }
end
# @api private
chainable do
def inherited(model)
descendants = self.descendants
descendants << model
model.instance_variable_set(:@valid, false)
model.instance_variable_set(:@base_model, base_model)
model.instance_variable_set(:@storage_names, @storage_names.dup)
model.instance_variable_set(:@default_order, @default_order.dup)
model.instance_variable_set(:@descendants, descendants.class.new(model, descendants))
end
end
# Gets the name of the storage receptacle for this resource in the given
# Repository (ie., table name, for database stores).
#
# @return [String]
# the storage name (ie., table name, for database stores) associated with
# this resource in the given repository
#
# @api public
def storage_name(repository_name = default_repository_name)
storage_names[repository_name] ||= repository(repository_name).adapter.resource_naming_convention.call(default_storage_name).freeze
end
# the names of the storage receptacles for this resource across all repositories
#
# @return [Hash(Symbol => String)]
# All available names of storage recepticles
#
# @api public
def storage_names
@storage_names
end
# Grab a single record by its key. Supports natural and composite key
# lookups as well.
#
# Zoo.get(1) # get the zoo with primary key of 1.
# Zoo.get!(1) # Or get! if you want an ObjectNotFoundError on failure
# Zoo.get('DFW') # wow, support for natural primary keys
# Zoo.get('Metro', 'DFW') # more wow, composite key look-up
#
# @param [Object] *key
# The primary key or keys to use for lookup
#
# @return [Resource, nil]
# A single model that was found
# If no instance was found matching +key+
#
# @api public
def get(*key)
assert_valid_key_size(key)
repository = self.repository
key = self.key(repository.name).typecast(key)
repository.identity_map(self)[key] || first(key_conditions(repository, key))
end
# Grab a single record just like #get, but raise an ObjectNotFoundError
# if the record doesn't exist.
#
# @param [Object] *key
# The primary key or keys to use for lookup
# @return [Resource]
# A single model that was found
# @raise [ObjectNotFoundError]
# The record was not found
#
# @api public
def get!(*key)
get(*key) || raise(ObjectNotFoundError, "Could not find #{self.name} with key #{key.inspect}")
end
def [](*args)
all[*args]
end
alias slice []
def at(*args)
all.at(*args)
end
def reverse
all.reverse
end
# TODO: spec this
def entries
all.entries
end
alias to_a entries
# Find a set of records matching an optional set of conditions. Additionally,
# specify the order that the records are return.
#
# Zoo.all # all zoos
# Zoo.all(:open => true) # all zoos that are open
# Zoo.all(:opened_on => start..end) # all zoos that opened on a date in the date-range
# Zoo.all(:order => [ :tiger_count.desc ]) # Ordered by tiger_count
#
# @param [Hash] query
# A hash describing the conditions and order for the query
# @return [Collection]
# A set of records found matching the conditions in +query+
# @see Collection
#
# @api public
def all(query = nil)
# TODO: update this not to accept a nil value, and instead either
# accept a Hash/Query and nothing else
if query.nil? || (query.kind_of?(Hash) && query.empty?)
# TODO: after adding Enumerable methods to Model, try to return self here
new_collection(self.query.dup)
else
new_collection(scoped_query(query))
end
end
# Return the first Resource or the first N Resources for the Model with an optional query
#
# When there are no arguments, return the first Resource in the
# Model. When the first argument is an Integer, return a
# Collection containing the first N Resources. When the last
# (optional) argument is a Hash scope the results to the query.
#
# @param [Integer] limit (optional)
# limit the returned Collection to a specific number of entries
# @param [Hash] query (optional)
# scope the returned Resource or Collection to the supplied query
#
# @return [Resource, Collection]
# The first resource in the entries of this collection,
# or a new collection whose query has been merged
#
# @api public
def first(*args)
first_arg = args.first
last_arg = args.last
limit_specified = first_arg.kind_of?(Integer)
with_query = (last_arg.kind_of?(Hash) && !last_arg.empty?) || last_arg.kind_of?(Query)
limit = limit_specified ? first_arg : 1
query = with_query ? last_arg : {}
query = self.query.slice(0, limit).update(query)
if limit_specified
all(query)
else
query.repository.read(query).first
end
end
# Return the last Resource or the last N Resources for the Model with an optional query
#
# When there are no arguments, return the last Resource for the
# Model. When the first argument is an Integer, return a
# Collection containing the last N Resources. When the last
# (optional) argument is a Hash scope the results to the query.
#
# @param [Integer] limit (optional)
# limit the returned Collection to a specific number of entries
# @param [Hash] query (optional)
# scope the returned Resource or Collection to the supplied query
#
# @return [Resource, Collection]
# The last resource in the entries of this collection,
# or a new collection whose query has been merged
#
# @api public
def last(*args)
first_arg = args.first
last_arg = args.last
limit_specified = first_arg.kind_of?(Integer)
with_query = (last_arg.kind_of?(Hash) && !last_arg.empty?) || last_arg.kind_of?(Query)
limit = limit_specified ? first_arg : 1
query = with_query ? last_arg : {}
query = self.query.slice(0, limit).update(query).reverse!
if limit_specified
all(query)
else
query.repository.read(query).last
end
end
# Finds the first Resource by conditions, or initializes a new
# Resource with the attributes if none found
#
# @param [Hash] conditions
# The conditions to be used to search
# @param [Hash] attributes
# The attributes to be used to create the record of none is found.
# @return [Resource]
# The instance found by +query+, or created with +attributes+ if none found
#
# @api public
def first_or_new(conditions = {}, attributes = {})
first(conditions) || new(conditions.merge(attributes))
end
# Finds the first Resource by conditions, or creates a new
# Resource with the attributes if none found
#
# @param [Hash] conditions
# The conditions to be used to search
# @param [Hash] attributes
# The attributes to be used to create the record of none is found.
# @return [Resource]
# The instance found by +query+, or created with +attributes+ if none found
#
# @api public
def first_or_create(conditions = {}, attributes = {})
first(conditions) || create(conditions.merge(attributes))
end
# Initializes an instance of Resource with the given attributes
#
# @param [Hash(Symbol => Object)] attributes
# hash of attributes to set
#
# @return [Resource]
# the newly initialized Resource instance
#
# @api public
chainable do
def new(*args, &block)
assert_valid
super
end
end
# Create a Resource
#
# @param [Hash(Symbol => Object)] attributes
# attributes to set
#
# @return [Resource]
# the newly created Resource instance
#
# @api public
def create(attributes = {})
_create(attributes)
end
# Create a Resource, bypassing hooks
#
# @param [Hash(Symbol => Object)] attributes
# attributes to set
#
# @return [Resource]
# the newly created Resource instance
#
# @api public
def create!(attributes = {})
_create(attributes, false)
end
# Copy a set of records from one repository to another.
#
# @param [String] source_repository_name
# The name of the Repository the resources should be copied _from_
# @param [String] target_repository_name
# The name of the Repository the resources should be copied _to_
# @param [Hash] query
# The conditions with which to find the records to copy. These
# conditions are merged with Model.query
#
# @return [Collection]
# A Collection of the Resource instances created in the operation
#
# @api public
def copy(source_repository_name, target_repository_name, query = {})
target_properties = properties(target_repository_name)
query[:fields] ||= properties(source_repository_name).select do |property|
target_properties.include?(property)
end
repository(target_repository_name) do |repository|
resources = []
all(query.merge(:repository => source_repository_name)).each do |resource|
new_resource = new
query[:fields].each { |property| new_resource.__send__("#{property.name}=", property.get(resource)) }
resources << new_resource if new_resource.save
end
all(Query.target_query(repository, self, resources))
end
end
# Loads an instance of this Model, taking into account IdentityMap lookup,
# inheritance columns(s) and Property typecasting.
#
# @param [Enumerable(Object)] records
# an Array of Resource or Hashes to load a Resource with
#
# @return [Resource]
# the loaded Resource instance
#
# @api semipublic
def load(records, query)
repository = query.repository
repository_name = repository.name
fields = query.fields
discriminator = properties(repository_name).discriminator
no_reload = !query.reload?
field_map = fields.map { |property| [ property, property.field ] }.to_hash
records.map do |record|
identity_map = nil
key_values = nil
resource = nil
case record
when Hash
# remap fields to use the Property object
record = record.dup
field_map.each { |property, field| record[property] = record.delete(field) if record.key?(field) }
model = discriminator && discriminator.load(record[discriminator]) || self
model_key = model.key(repository_name)
resource = if model_key.valid?(key_values = record.values_at(*model_key))
identity_map = repository.identity_map(model)
identity_map[key_values]
end
resource ||= model.allocate
fields.each do |property|
next if no_reload && property.loaded?(resource)
value = record[property]
# TODO: typecasting should happen inside the Adapter
# and all values should come back as expected objects
value = property.load(value)
property.set!(resource, value)
end
when Resource
model = record.model
model_key = model.key(repository_name)
resource = if model_key.valid?(key_values = record.key)
identity_map = repository.identity_map(model)
identity_map[key_values]
end
resource ||= model.allocate
fields.each do |property|
next if no_reload && property.loaded?(resource)
property.set!(resource, property.get!(record))
end
end
resource.instance_variable_set(:@_repository, repository)
if identity_map
resource.persisted_state = Resource::State::Clean.new(resource) unless resource.persisted_state?
# defer setting the IdentityMap so second level caches can
# record the state of the resource after loaded
identity_map[key_values] = resource
else
resource.persisted_state = Resource::State::Immutable.new(resource)
end
resource
end
end
# @api semipublic
attr_reader :base_model
# @api semipublic
def default_repository_name
Repository.default_name
end
# @api semipublic
def default_order(repository_name = default_repository_name)
@default_order[repository_name] ||= key(repository_name).map { |property| Query::Direction.new(property) }.freeze
end
# Get the repository with a given name, or the default one for the current
# context, or the default one for this class.
#
# @param [Symbol] name
# the name of the repository wanted
# @param [Block] block
# block to execute with the fetched repository as parameter
#
# @return [Object, Respository]
# whatever the block returns, if given a block,
# otherwise the requested repository.
#
# @api private
def repository(name = nil, &block)
#
# There has been a couple of different strategies here, but me (zond) and dkubb are at least
# united in the concept of explicitness over implicitness. That is - the explicit wish of the
# caller (+name+) should be given more priority than the implicit wish of the caller (Repository.context.last).
#
DataMapper.repository(name || repository_name, &block)
end
# Get the current +repository_name+ for this Model.
#
# If there are any Repository contexts, the name of the last one will
# be returned, else the +default_repository_name+ of this model will be
#
# @return [String]
# the current repository name to use for this Model
#
# @api private
def repository_name
context = Repository.context
context.any? ? context.last.name : default_repository_name
end
# Gets the current Set of repositories for which
# this Model has been defined (beyond default)
#
# @return [Set]
# The Set of repositories for which this Model
# has been defined (beyond default)
#
# @api private
def repositories
[ repository ].to_set + @properties.keys.map { |repository_name| DataMapper.repository(repository_name) }
end
private
# @api private
def _create(attributes, execute_hooks = true)
resource = new(attributes)
resource.__send__(execute_hooks ? :save : :save!)
resource
end
# @api private
def const_missing(name)
if name == :DM
warn "#{name} prefix deprecated and no longer necessary (#{caller[0]})"
self
elsif name == :Resource
Resource
elsif DataMapper::Property.const_defined?(name)
DataMapper::Property.const_get(name)
elsif DataMapper::Types.const_defined?(name)
DataMapper::Types.const_get(name)
else
super
end
end
# @api private
def default_storage_name
base_model.name
end
# Initializes a new Collection
#
# @return [Collection]
# A new Collection object
#
# @api private
def new_collection(query, resources = nil, &block)
Collection.new(query, resources, &block)
end
# @api private
# TODO: move the logic to create relative query into Query
def scoped_query(query)
if query.kind_of?(Query)
query.dup
else
repository = if query.key?(:repository)
query = query.dup
repository = query.delete(:repository)
if repository.kind_of?(Symbol)
DataMapper.repository(repository)
else
repository
end
else
self.repository
end
query = self.query.merge(query)
if self.query.repository == repository
query
else
repository.new_query(self, query.options)
end
end
end
# @api private
def assert_valid(force = false) # :nodoc:
return if @valid && !force
@valid = true
name = self.name
repository_name = self.repository_name
if properties(repository_name).empty? &&
!relationships(repository_name).any? { |(relationship_name, relationship)| relationship.kind_of?(Associations::ManyToOne::Relationship) }
raise IncompleteModelError, "#{name} must have at least one property or many to one relationship to be valid"
end
if key(repository_name).empty?
raise IncompleteModelError, "#{name} must have a key to be valid"
end
# initialize join models and target keys
@relationships.values.each do |relationships|
relationships.values.each do |relationship|
relationship.child_key
relationship.through if relationship.respond_to?(:through)
relationship.via if relationship.respond_to?(:via)
end
end
end
# Raises an exception if #get receives the wrong number of arguments
#
# @param [Array] key
# the key value
#
# @return [undefined]
#
# @raise [UpdateConflictError]
# raise if the resource is dirty
#
# @api private
def assert_valid_key_size(key)
expected_key_size = self.key(repository_name).size
actual_key_size = key.size
if actual_key_size != expected_key_size
raise ArgumentError, "The number of arguments for the key is invalid, expected #{expected_key_size} but was #{actual_key_size}"
end
end
end # module Model
end # module DataMapper