Class: ActiveFedora::Associations::CollectionAssociation

Inherits:
Association
  • Object
show all
Defined in:
lib/active_fedora/associations/collection_association.rb

Overview

:nodoc:

Instance Attribute Summary collapse

Attributes inherited from Association

#inversed, #owner, #reflection, #target

Instance Method Summary collapse

Methods inherited from Association

#association_scope, #initialize, #initialize_attributes, #loaded!, #loaded?, #reload, #set_inverse_instance, #stale_target?, #target_scope

Constructor Details

This class inherits a constructor from ActiveFedora::Associations::Association

Instance Attribute Details

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



4
5
6
 
# File 'lib/active_fedora/associations/collection_association.rb', line 4

def proxy
  @proxy
end

Instance Method Details

#add_to_target(record, skip_callbacks = false) {|record| ... } ⇒ Object

Yields:

  • (record) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/active_fedora/associations/collection_association.rb', line 253

def add_to_target(record, skip_callbacks = false)
  #  transaction do
  callback(:before_add, record) unless skip_callbacks
  yield(record) if block_given?

  if @reflection.options[:uniq] && index = @target.index(record)
    @target[index] = record
  else
    @target << record
  end

  callback(:after_add, record) unless skip_callbacks
  set_inverse_instance(record)
  # end

  record
end

#any? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
124
125
126
127
 
# File 'lib/active_fedora/associations/collection_association.rb', line 121

def any?
  if block_given?
    load_target.any? { |*block_args| yield(*block_args) }
  else
    !empty?
  end
end

#build(attributes = {}, &block) ⇒ Object 



134
135
136
137
138
139
140
141
142
 
# File 'lib/active_fedora/associations/collection_association.rb', line 134

def build(attributes = {}, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| build(attr, &block) }
  else
    add_to_target(build_record(attributes)) do |record|
      yield(record) if block_given?
    end
  end
end

#concat(*records) ⇒ Object

Add records to this association. Returns self so method calls may be chained. Since << flattens its argument list and inserts each record, push and concat behave identically.



146
147
148
149
 
# File 'lib/active_fedora/associations/collection_association.rb', line 146

def concat(*records)
  load_target unless owner.new_record?
  concat_records(records)
end

#concat_records(*records) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/active_fedora/associations/collection_association.rb', line 151

def concat_records(*records)
  result = true

  records.flatten.each do |record|
    raise_on_type_mismatch(record)
    run_type_validator(record)
    add_to_target(record) do |_r|
      result &&= insert_record(record) unless owner.new_record?
    end
  end

  result && records
end

#count(_options = {}) ⇒ Object

Count all records using solr. Construct options and pass them with scope to the target class’s count.



227
228
229
 
# File 'lib/active_fedora/associations/collection_association.rb', line 227

def count(_options = {})
  @reflection.klass.count(conditions: construct_query)
end

#create(attrs = {}) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/active_fedora/associations/collection_association.rb', line 207

def create(attrs = {})
  if attrs.is_a?(Array)
    attrs.collect { |attr| create(attr) }
  else
    create_record(attrs) do |record|
      yield(record) if block_given?
      record.save
    end
  end
end

#create!(attrs = {}) ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/active_fedora/associations/collection_association.rb', line 218

def create!(attrs = {})
  create_record(attrs) do |record|
    yield(record) if block_given?
    record.save!
  end
end

#delete(*records) ⇒ Object

Removes records from this association calling before_remove and after_remove callbacks.

This method is abstract in the sense that delete_records has to be provided by descendants. Note this method does not imply the records are actually removed from the database, that depends precisely on delete_records. They are in any case removed from the collection.



193
194
195
 
# File 'lib/active_fedora/associations/collection_association.rb', line 193

def delete(*records)
  delete_or_destroy(records, options[:dependent])
end

#delete_all ⇒ Object

Remove all records from this association

See delete for more info.



168
169
170
171
172
173
174
 
# File 'lib/active_fedora/associations/collection_association.rb', line 168

def delete_all
  # TODO: load_target causes extra loads. Can't we just send delete requests?
  delete(load_target).tap do
    reset
    loaded!
  end
end

#destroy(*records) ⇒ Object

Destroy records and remove them from this association calling before_remove and after_remove callbacks.

Note that this method will always remove records from the database ignoring the :dependent option.



202
203
204
205
 
# File 'lib/active_fedora/associations/collection_association.rb', line 202

def destroy(*records)
  records = find(records) if records.any? { |record| record.is_a?(Fixnum) || record.is_a?(String) }
  delete_or_destroy(records, :destroy)
end

#destroy_all ⇒ Object

Remove all records from this association

See delete for more info.



179
180
181
182
183
184
 
# File 'lib/active_fedora/associations/collection_association.rb', line 179

def destroy_all
  destroy(load_target).tap do
    reset
    loaded!
  end
end

#empty? ⇒ Boolean

Returns true if the collection is empty.

If the collection has been loaded it is equivalent to collection. size.zero?. If the collection has not been loaded, it is equivalent to collection.count_records == 0. If the collection has not already been loaded and you are going to fetch the records anyway it is better to check collection.length.zero?.

Returns:

  • (Boolean) 


88
89
90
91
92
93
94
 
# File 'lib/active_fedora/associations/collection_association.rb', line 88

def empty?
  if loaded?
    size.zero?
  else
    @target.blank? && count_records == 0
  end
end

#find(*args) ⇒ Object 



50
51
52
 
# File 'lib/active_fedora/associations/collection_association.rb', line 50

def find(*args)
  scope.find(*args)
end

#first(*args) ⇒ Object 



54
55
56
 
# File 'lib/active_fedora/associations/collection_association.rb', line 54

def first(*args)
  first_or_last(:first, *args)
end

#ids_reader ⇒ Object

Implements the ids reader method, e.g. foo.item_ids for Foo.has_many :items



26
27
28
29
30
31
32
33
34
 
# File 'lib/active_fedora/associations/collection_association.rb', line 26

def ids_reader
  if loaded?
    load_target.map(&:id)
  else
    load_from_solr.map do |solr_record|
      solr_record['id']
    end
  end
end

#ids_writer(ids) ⇒ Object

Implements the ids writer method, e.g. foo.item_ids= for Foo.has_many :items



37
38
39
40
41
42
43
 
# File 'lib/active_fedora/associations/collection_association.rb', line 37

def ids_writer(ids)
  ids = Array(ids).reject(&:blank?)
  replace(klass.find(ids)) # .index_by { |r| r.id }.values_at(*ids))
  # TODO, like this when find() can return multiple records
  # send("#{reflection.name}=", reflection.klass.find(ids))
  # send("#{reflection.name}=", ids.collect { |id| reflection.klass.find(id)})
end

#include?(record) ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/active_fedora/associations/collection_association.rb', line 109

def include?(record)
  if record.is_a?(reflection.klass)
    if record.new_record?
      target.include?(record)
    else
      loaded? ? target.include?(record) : scope.exists?(record)
    end
  else
    false
  end
end

#last(*args) ⇒ Object 



58
59
60
 
# File 'lib/active_fedora/associations/collection_association.rb', line 58

def last(*args)
  first_or_last(:last, *args)
end

#load_from_solr(opts = {}) ⇒ Object

Parameters:

  • opts (Hash) (defaults to: {}) —

    Options that will be passed through to ActiveFedora::SolrService.query.



245
246
247
248
249
250
251
 
# File 'lib/active_fedora/associations/collection_association.rb', line 245

def load_from_solr(opts = {})
  finder_query = construct_query
  return [] if finder_query.empty?
  rows = opts.delete(:rows) { count }
  return [] if rows == 0
  SolrService.query(finder_query, { rows: rows }.merge(opts))
end

#load_target ⇒ Object 



237
238
239
240
241
242
 
# File 'lib/active_fedora/associations/collection_association.rb', line 237

def load_target
  @target = merge_target_lists(find_target, @target) if find_target?

  loaded!
  target
end

#null_scope? ⇒ Boolean

Returns:

  • (Boolean) 


277
278
279
 
# File 'lib/active_fedora/associations/collection_association.rb', line 277

def null_scope?
  owner.new_record? && !foreign_key_present?
end

#reader(opts = false) ⇒ Object

Implements the reader method, e.g. foo.items for Foo.has_many :items

Parameters:

  • opts (Boolean, Hash) (defaults to: false) —

    if true, force a reload

Options Hash (opts):

  • :response_format (Symbol) —

    can be ‘:solr’ to return a solr result.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/active_fedora/associations/collection_association.rb', line 9

def reader(opts = false)
  if opts.is_a?(Hash)
    return load_from_solr(opts) if opts.delete(:response_format) == :solr
    raise ArgumentError, "Hash parameter must include :response_format=>:solr (#{opts.inspect})"
  else
    force_reload = opts
  end
  reload if force_reload || stale_target?
  @proxy ||= CollectionProxy.new(self)
end

#replace(other_array) ⇒ Object

Replace this collection with other_array This will perform a diff and delete/add only records that have changed.



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/active_fedora/associations/collection_association.rb', line 98

def replace(other_array)
  other_array.each { |val| raise_on_type_mismatch(val) }

  load_target
  other   = other_array.size < 100 ? other_array : other_array.to_set
  current = @target.size < 100 ? @target : @target.to_set

  delete(@target.select { |v| !other.include?(v) })
  concat(other_array.select { |v| !current.include?(v) })
end

#reset ⇒ Object 



45
46
47
48
 
# File 'lib/active_fedora/associations/collection_association.rb', line 45

def reset
  super
  @target = []
end

#scope(opts = {}) ⇒ Object 



271
272
273
274
275
 
# File 'lib/active_fedora/associations/collection_association.rb', line 271

def scope(opts = {})
  scope = super()
  scope.none! if opts.fetch(:nullify, true) && null_scope?
  scope
end

#select(_select = nil, &block) ⇒ Object 



281
282
283
 
# File 'lib/active_fedora/associations/collection_association.rb', line 281

def select(_select = nil, &block)
  to_a.select(&block)
end

#size ⇒ Object

Returns the size of the collection

If the collection has been already loaded size and length are equivalent. If not and you are going to need the records anyway length will take one less query. Otherwise size is more efficient.

This method is abstract in the sense that it relies on count_records, which is a method descendants have to provide.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/active_fedora/associations/collection_association.rb', line 70

def size
  if @owner.new_record? && @target
    @target.size
  elsif !loaded? && @target.is_a?(Array)
    unsaved_records = @target.select(&:new_record?)
    unsaved_records.size + count_records
  else
    count_records
  end
end

#target=(target) ⇒ Object

Sets the target of this proxy to \target, and the loaded flag to true.



232
233
234
235
 
# File 'lib/active_fedora/associations/collection_association.rb', line 232

def target=(target)
  @target = [target]
  loaded!
end

#to_ary ⇒ Object Also known as: to_a 



129
130
131
 
# File 'lib/active_fedora/associations/collection_association.rb', line 129

def to_ary
  load_target.dup
end

#writer(records) ⇒ Object

Implements the writer method, e.g. foo.items= for Foo.has_many :items



21
22
23
 
# File 'lib/active_fedora/associations/collection_association.rb', line 21

def writer(records)
  replace(records)
end