Class: Spider::Model::Mapper
- Defined in:
- lib/spiderfw/model/mappers/mapper.rb
Overview
The Mapper connects a BaseModel to a Storage; it fetches data from the Storage and converts it to objects, and vice versa. It is not usually called directly; the BaseModel provides methods for interacting with the mapper. Its methods may be overridden with BaseModel#with_mapper, though.
Direct Known Subclasses
Spider::Model::Mappers::DbMapper, Spider::Model::Mappers::DocumentMapper, Spider::Model::Mappers::HashMapper, Test::MapperStub
Instance Attribute Summary collapse
-
#model ⇒ Object
readonly
Returns the value of attribute model.
-
#storage ⇒ Object
Returns the value of attribute storage.
-
#type ⇒ Object
readonly
Mapper type (:db, :hash, etc.).
Class Method Summary collapse
-
.write? ⇒ Boolean
Returns whether this Mapper can write to the storage.
Instance Method Summary collapse
-
#after_delete(objects) ⇒ Object
Hook to provide custom preprocessing.
-
#after_save(obj, mode) ⇒ Object
Called after a succesful save.
-
#associate_external(element, objects, result) ⇒ Object
Given the results of a query for an element, and a set of objects, associates the result with the corresponding objects.
-
#association_elements ⇒ Object
Elements that are associated to this one externally.
- #base_type(type) ⇒ Object
-
#basic_preprocess(condition) ⇒ Object
This handles integrated elements, junctions, and prepares types.
-
#before_delete(objects) ⇒ Object
Hook to provide custom preprocessing.
-
#before_insert(obj) ⇒ Object
Hook to provide custom preprocessing.
-
#before_save(obj, mode) ⇒ Object
This method is called before a save operation, normalizing and preparing the object.
-
#before_update(obj) ⇒ Object
Hook to provide custom preprocessing.
-
#bulk_update(values, conditon) ⇒ Object
FIXME: remove?.
- #children_for_unit_of_work(obj, action) ⇒ Object
-
#count(condition) ⇒ Object
Does a count query on the storage for given condition.
-
#delete(obj_or_condition, force = false) ⇒ Object
Deletes an object, or objects according to a condition.
-
#delete_all! ⇒ Object
Deletes all objects from the storage.
-
#delete_element_associations(obj, element, associated = nil) ⇒ Object
Deletes all associations from the given object to the element.
- #determine_save_mode(obj) ⇒ Object
-
#do_delete(obj, force = false) ⇒ Object
Actual interaction with the storage.
-
#do_insert(obj) ⇒ Object
Actual interaction with the storage.
-
#do_update(obj) ⇒ Object
Actual interaction with the storage.
-
#execute_action(action, object, params = {}) ⇒ Object
Calls the given action.
-
#expand_request(request, obj = nil) ⇒ Object
Adds lazy groups to request.
-
#fetch(query) ⇒ Object
Actual interaction with the storage.
-
#find(query, query_set = nil, options = {}) ⇒ Object
Finds objects according to a query, merging the results into a query_set if given.
-
#find_with_superclass(query, set = nil, options = {}) ⇒ Object
:nodoc:.
-
#get_dependencies(task) ⇒ Object
Returns task dependecies for the UnitOfWork.
-
#get_external(objects, query) ⇒ Object
Loads external elements, according to query, and merges them into an object or a QuerySet.
-
#get_external_element(element, query, objects) ⇒ Object
Loads an external element, according to query, and merges the result into an object or QuerySet.
-
#have_references?(element) ⇒ Boolean
Returns true if information to find the given element is accessible to the mapper.
-
#initialize(model, storage) ⇒ Mapper
constructor
Takes a BaseModel class and a storage instance.
-
#insert(obj) ⇒ Object
Inserts the object in the storage.
-
#load(objects, query, options = {}) ⇒ Object
Loads elements of given objects according to query.request.
-
#load_element(objects, element) ⇒ Object
Loads an element.
-
#load_element!(objects, element) ⇒ Object
Loads only the given element, ignoring lazy groups.
-
#lock(obj = nil, mode = :exclusive) ⇒ Object
Actual interaction with the storage.
-
#map(request, result, obj_or_model) ⇒ Object
Transforms a Storage result into an object.
-
#map_back_value(type, value) ⇒ Object
Converts a storage value back to the corresponding base type or DataType.
-
#map_condition_value(type, value) ⇒ Object
Prepares a value for a condition.
-
#map_elements ⇒ Object
An array of mapped elements.
-
#map_save_value(type, value, save_mode = :save) ⇒ Object
Prepares a value going to be bound to an insert or update statement.
-
#map_value(type, value, mode = nil) ⇒ Object
Converts a value in one accepted by the storage.
-
#mapped?(element) ⇒ Boolean
Returns whether the given element can be handled by the mapper.
-
#merge_object(set, obj, request) ⇒ Object
:nodoc:.
-
#no_map(*els) ⇒ Object
Sets that the given elements will not be processed.
-
#normalize(obj) ⇒ Object
Converts hashes and arrays to QuerySets and BaseModel instances.
- #prepare_delete_condition(obj) ⇒ Object
-
#prepare_query(query, obj = nil) ⇒ Object
Strategy #.
-
#prepare_query_request(request, obj = nil) ⇒ Object
Normalizes a request.
-
#preprocess_condition(condition) ⇒ Object
Preprocessing of the condition.
-
#queryset_siblings(obj) ⇒ Object
Returns the siblings, if any, of the object, in its ancestor QuerySet.
-
#save(obj, request = nil) ⇒ Object
Saves the object to the storage.
-
#save_all(root) ⇒ Object
Saves the given object and all objects reachable from it.
-
#save_associations(obj, mode) ⇒ Object
Saves object associations.
-
#save_done(obj, mode) ⇒ Object
Hook called after a succesful save: the object is not in save mode.
-
#save_element_associations(obj, element, mode) ⇒ Object
Saves the associations from the given object to the element.
- #save_extended_models(obj, mode) ⇒ Object
- #save_integrated(obj, mode) ⇒ Object
-
#sequence_next(name) ⇒ Object
Actual interaction with the storage.
-
#set_pks_condition(condition, el, val, prefix) ⇒ Object
Utility function to set conditions on.
-
#someone_have_references?(element) ⇒ Boolean
Returns true if information to find the given element is accessible to the mapper, or to an integrated model’s mapper.
- #sortable?(element) ⇒ Boolean
- #split_condition_polymorphs(condition, polymorphs) ⇒ Object
- #storage_value_to_mapper(type, value) ⇒ Object
- #truncate! ⇒ Object
-
#update(obj) ⇒ Object
Updates the object in the storage.
Constructor Details
#initialize(model, storage) ⇒ Mapper
Takes a BaseModel class and a storage instance.
20 21 22 23 24 25 26 27 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 20 def initialize(model, storage) @model = model @storage = storage @raw_data = {} @options = {} @no_map_elements = {} @sequences = [] end |
Instance Attribute Details
#model ⇒ Object (readonly)
Returns the value of attribute model.
9 10 11 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 9 def model @model end |
#storage ⇒ Object
Returns the value of attribute storage.
10 11 12 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 10 def storage @storage end |
#type ⇒ Object (readonly)
Mapper type (:db, :hash, etc.)
12 13 14 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 12 def type @type end |
Class Method Details
.write? ⇒ Boolean
Returns whether this Mapper can write to the storage.
15 16 17 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 15 def self.write? true end |
Instance Method Details
#after_delete(objects) ⇒ Object
Hook to provide custom preprocessing. Will be passed a QuerySet. The default implementation does nothing.
214 215 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 214 def after_delete(objects) end |
#after_save(obj, mode) ⇒ Object
Called after a succesful save. ‘mode’ can be :insert or :update.
203 204 205 206 207 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 203 def after_save(obj, mode) obj.reset_modified_elements save_associations(obj, mode) end |
#associate_external(element, objects, result) ⇒ Object
Given the results of a query for an element, and a set of objects, associates the result with the corresponding objects.
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 732 def associate_external(element, objects, result) # result.reindex objects.element_loaded(element.name) objects.each_current do |obj| search_params = {} @model.primary_keys.each do |key| search_params[:"#{element.attributes[:reverse]}.#{key.name}"] = obj.get(key) end sub_res = result.find(search_params) sub_res.each do |sub_obj| sub_obj.set_loaded_value(element.attributes[:reverse], obj) end sub_res = sub_res[0] if !element.multiple? sub_res.loadable = false if sub_res.respond_to?(:loadable=) obj.set_loaded_value(element, sub_res) end return objects end |
#association_elements ⇒ Object
Elements that are associated to this one externally.
267 268 269 270 271 272 273 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 267 def association_elements return [] if Spider::Model.unit_of_work_running? els = @model.elements_array.select{ |el| mapped?(el) && !el.integrated? && !have_references?(el) && !(el.attributes[:added_reverse] && el.type <= @model) } els end |
#base_type(type) ⇒ Object
53 54 55 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 53 def base_type(type) Spider::Model.base_type(type) end |
#basic_preprocess(condition) ⇒ Object
This handles integrated elements, junctions, and prepares types
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 928 def basic_preprocess(condition) # :nodoc: condition.conditions_array.each do |k, v, c| next if k.is_a?(Spider::QueryFuncs::Function) next unless element = model.elements[k] if (element.integrated?) condition.delete(k) integrated_from = element.integrated_from integrated_from_element = element.integrated_from_element condition.set("#{integrated_from.name}.#{integrated_from_element}", c, v) elsif (element.junction? && !v.is_a?(BaseModel) && !v.is_a?(Hash) && !v.nil?) # conditions on junction id don't make sense condition.delete(k) condition.set("#{k}.#{element.attributes[:junction_their_element]}", c, v) end if (element.type < Spider::DataType && !v.is_a?(element.type)) condition.delete(k) begin condition.set(k, c, element.type.from_value(v)) rescue TypeError => exc raise TypeError, "Can't convert #{v} to #{element.type} for element #{k} (#{exc.})" end elsif element.type == DateTime && v && !v.is_a?(Date) && !v.is_a?(Time) condition.delete(k) condition.set(k, c, DateTime.parse(v)) end end end |
#before_delete(objects) ⇒ Object
Hook to provide custom preprocessing. Will be passed a QuerySet. The default implementation does nothing.
199 200 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 199 def before_delete(objects) end |
#before_insert(obj) ⇒ Object
Hook to provide custom preprocessing. The default implementation does nothing.
191 192 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 191 def before_insert(obj) end |
#before_save(obj, mode) ⇒ Object
This method is called before a save operation, normalizing and preparing the object. ‘mode’ can be :insert or :update. This method is well suited for being overridden, to add custom preprocessing of the object; just remember to call #super, or use #before_insert and #before_update instead.
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 128 def before_save(obj, mode) obj.trigger(:before_save, mode) normalize(obj) if (mode == :insert) before_insert(obj) elsif (mode == :update) before_update(obj) end @model.elements_array.each do |el| if (el.attributes[:set_before_save]) set_data = el.attributes[:set_before_save] if (el.model? && set_data.is_a?(Hash)) if (obj.element_has_value?(el)) set_data.each{ |k, v| obj.get(el).set(k, v) } else obj.set(el, el.model.new(set_data)) end else obj.set(el, set_data) end end if (!el.integrated? && el.required? && (mode == :insert || obj.element_modified?(el)) && !obj.element_has_value?(el)) raise RequiredError.new(el) end if (el.unique? && !el.integrated? && obj.element_modified?(el) && curr_val = obj.get(el)) existent = @model.where(el.name => curr_val) if (mode == :insert && existent.length > 0) || (mode == :update && existent.length > 1) raise NotUniqueError.new(el) end end if mode == :insert && !el.integrated? obj.set(el.name, el.type.auto_value) if el.type < Spider::DataType && el.type.auto?(el) && !obj.element_has_value?(el) obj.set(el, obj.get(el)) if el.attributes[:default] && !obj.element_modified?(el) end end done_extended = [] unless Spider::Model.unit_of_work_running? save_extended_models(obj, mode) save_integrated(obj, mode) end end |
#before_update(obj) ⇒ Object
Hook to provide custom preprocessing. The default implementation does nothing.
195 196 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 195 def before_update(obj) end |
#bulk_update(values, conditon) ⇒ Object
FIXME: remove?
413 414 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 413 def bulk_update(values, conditon) # :nodoc: end |
#children_for_unit_of_work(obj, action) ⇒ Object
1032 1033 1034 1035 1036 1037 1038 1039 1040 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 1032 def children_for_unit_of_work(obj, action) children = [] obj.class.elements_array.each do |el| next unless obj.element_has_value?(el) next unless el.model? children << obj.get(el) end children end |
#count(condition) ⇒ Object
Does a count query on the storage for given condition
657 658 659 660 661 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 657 def count(condition) query = Query.new(condition) result = fetch(query) return result.length end |
#delete(obj_or_condition, force = false) ⇒ Object
Deletes an object, or objects according to a condition. Will not delete with null condition (i.e. all objects) unless force is true
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 418 def delete(obj_or_condition, force=false) def prepare_delete_condition(obj) condition = Condition.and @model.primary_keys.each do |key| condition[key.name] = map_condition_value(key.type, obj.get(key)) end return condition end curr = nil if (obj_or_condition.is_a?(BaseModel)) condition = prepare_delete_condition(obj_or_condition) curr = QuerySet.new(@model, obj_or_condition) elsif (obj_or_condition.is_a?(QuerySet)) qs = obj_or_condition condition = Condition.or qs.each{ |obj| condition << prepare_delete_condition(obj) } else condition = obj_or_condition.is_a?(Condition) ? obj_or_condition : Condition.new(obj_or_condition) end Spider::Logger.debug("Deleting with condition:") Spider::Logger.debug(condition) preprocess_condition(condition) cascade = @model.elements_array.select{ |el| !el.integrated? && el.attributes[:delete_cascade] } assocs = association_elements.select do |el| !storage.supports?(:delete_cascade) || !schema.cascade?(el.name) # TODO: implement end curr = @model.where(condition) unless curr before_delete(curr) vals = [] started_transaction = false unless cascade.empty? && assocs.empty? storage.in_transaction started_transaction = true curr.each do |curr_obj| obj_vals = {} cascade.each do |el| obj_vals[el] = curr_obj.get(el) end vals << obj_vals assocs.each do |el| delete_element_associations(curr_obj, el) end end end @model.referenced_by_junctions.each do |junction, element| curr.each do |curr_obj| junction_condition = Spider::Model::Condition.new junction_condition[element] = curr_obj junction.mapper.delete(junction_condition) end end do_delete(condition, force) vals.each do |obj_vals| obj_vals.each do |el, val| el.model.mapper.delete(val) end end after_delete(curr) storage.commit_or_continue if started_transaction end |
#delete_all! ⇒ Object
Deletes all objects from the storage.
482 483 484 485 486 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 482 def delete_all! all = @model.all #all.fetch_window = 100 delete(all, true) end |
#delete_element_associations(obj, element, associated = nil) ⇒ Object
Deletes all associations from the given object to the element.
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 283 def delete_element_associations(obj, element, associated=nil) if (element.attributes[:junction]) condition = {element.attributes[:reverse] => obj.primary_keys} condition[element.attributes[:junction_their_element]] = associated if associated element.mapper.delete(condition) else if (element.multiple?) condition = Condition.and if (associated) condition = associated.keys_to_condition else condition[element.reverse] = obj end # associated.each do |child| # condition_row = Condition.or # element.model.primary_keys.each{ |el| condition_row.set(el.name, '<>', child.get(el))} # condition << condition_row # end if (element.owned?) element.mapper.delete(condition) else element.mapper.bulk_update({element.reverse => nil}, condition) end end end end |
#determine_save_mode(obj) ⇒ Object
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 245 def determine_save_mode(obj) if @model.extended_models && !@model.extended_models.empty? is_insert = false # Load local primary keys if they exist @model.elements_array.select{ |el| el.attributes[:local_pk] }.each do |local_pk| if !obj.get(local_pk) is_insert = true break end end end save_mode = nil if obj.class.auto_primary_keys? && !obj._check_if_saved save_mode = (!is_insert && obj.primary_keys_set?) ? :update : :insert else save_mode = obj.in_storage? ? :update : :insert end end |
#do_delete(obj, force = false) ⇒ Object
Actual interaction with the storage. May be implemented by subclasses.
493 494 495 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 493 def do_delete(obj, force=false) raise MapperError, "Unimplemented" end |
#do_insert(obj) ⇒ Object
Actual interaction with the storage. May be implemented by subclasses.
498 499 500 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 498 def do_insert(obj) raise MapperError, "Unimplemented" end |
#do_update(obj) ⇒ Object
Actual interaction with the storage. May be implemented by subclasses.
503 504 505 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 503 def do_update(obj) raise MapperError, "Unimplemented" end |
#execute_action(action, object, params = {}) ⇒ Object
Calls the given action. Used by UnitOfWork tasks.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 65 def execute_action(action, object, params={}) # :nodoc: case action when :save if params[:force] == :insert insert(object) elsif params[:force] == :update update(object) else save(object) end when :keys # do nothing; keys will be set by save when :delete delete(object) else raise MapperError, "#{action} action not implemented" end end |
#expand_request(request, obj = nil) ⇒ Object
Adds lazy groups to request.
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 900 def (request, obj=nil) lazy_groups = [] request.each do |k, v| unless element = @model.elements[k] request.delete(k) next end grps = element.lazy_groups lazy_groups += grps if grps end lazy_groups.uniq! @model.elements.each do |name, element| next if (obj && obj.element_loaded?(name)) if (element.lazy_groups && (lazy_groups - element.lazy_groups).length < lazy_groups.length) if (element.attributes[:lazy_check_owner]) next unless have_references?(name) end request.request(name) end end end |
#fetch(query) ⇒ Object
Actual interaction with the storage. Should be implemented by subclasses.
664 665 666 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 664 def fetch(query) raise MapperError, "Unimplemented" end |
#find(query, query_set = nil, options = {}) ⇒ Object
Finds objects according to a query, merging the results into a query_set if given.
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 543 def find(query, query_set=nil, ={}) set = nil Spider::Model.with_identity_mapper do |im| im.put(query_set) query_set.update_loaded_elements if query_set set = query_set || QuerySet.new(@model) was_loaded = set.loaded set.loaded = true set.index_by(*@model.primary_keys) set.last_query = query if (query.request.with_superclass? && @model.superclass < BaseModel) return find_with_superclass(query, set, ) end if (@model.attributes[:condition]) query.condition = Condition.and(query.condition, @model.attributes[:condition]) end keys_loaded = true @model.primary_keys.each do |key| unless set.element_loaded?(key) keys_loaded = false break end end do_fetch = true if (keys_loaded) do_fetch = false query.request.each_key do |key| if (have_references?(key)) do_fetch = true break end end end if (do_fetch) @model.primary_keys.each{ |key| query.request[key] = true} (query.request, set) unless [:no_expand_request] || !query.request. query = prepare_query(query, query_set) query.request.total_rows = true unless query.request.total_rows == false result = fetch(query) if !result || result.empty? set.each_current do |obj| query.request.keys.each do |element_name| el = @model.elements[element_name] next if el.primary_key? next if el.integrated? || @model.extended_models[el.model] obj.set_loaded_value(element_name, nil) end end return false end set.total_rows = result.total_rows if (!was_loaded) merged = {} result.each do |row| obj = map(query.request, row, @model) # set.model ?!? next unless obj merged_obj = merge_object(set, obj, query.request) merged[merged_obj.object_id] = true @raw_data[obj.object_id] = row end query.request.keys.each do |k, v| set.element_loaded(k) if have_references?(k) end set.each_current do |obj| next if merged[obj.object_id] query.request.keys.each do |element_name| el = @model.elements[element_name] next if el.primary_key? next if el.integrated? || @model.extended_models[el.model] obj.set_loaded_value(element_name, nil) end end end set = get_external(set, query) end return set end |
#find_with_superclass(query, set = nil, options = {}) ⇒ Object
:nodoc:
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 637 def find_with_superclass(query, set=nil, ={}) # :nodoc: q = query.clone polym_request = Request.new polym_condition = Condition.new query.request.keys.each do |el_name| if (!@model.superclass.has_element?(el_name)) polym_request[el_name] = true query.request.delete(el_name) end end q.with_polymorph(@model, polym_request) res = @model.superclass.mapper.find(q) res.change_model(@model) res.each do |obj| merge_object(set, obj, query.request) end return set end |
#get_dependencies(task) ⇒ Object
Returns task dependecies for the UnitOfWork. May be implemented by subclasses.
1028 1029 1030 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 1028 def get_dependencies(task) return [] end |
#get_external(objects, query) ⇒ Object
Loads external elements, according to query, and merges them into an object or a QuerySet
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 675 def get_external(objects, query) objects = queryset_siblings(objects) unless objects.is_a?(QuerySet) return objects if objects.length < 1 got_external = {} get_integrated = {} query.request.each_key do |element_name| element = @model.elements[element_name] next unless element && (mapped?(element) || element.attributes[:element_query]) next if objects.element_loaded?(element_name) next unless element.reverse # FIXME if element.integrated? get_integrated[element.integrated_from] ||= Request.new get_integrated[element.integrated_from][element.integrated_from_element] = query.request[element_name] elsif element.model? next if query.request[element_name] == true && someone_have_references?(element) sub_query = Query.new sub_query.request = ( query.request[element_name].class == Request ) ? query.request[element_name] : nil sub_query.condition = element.attributes[:condition] if element.attributes[:condition] got_external[element] = true objects = get_external_element(element, sub_query, objects) end # no furter attempts to try; set as loaded objects.element_loaded(element_name) end get_integrated.each do |integrated, request| next if got_external[integrated] next if objects.element_loaded?(integrated.name) sub_query = Query.new(nil, request) objects = get_external_element(integrated, sub_query, objects) objects.element_loaded(integrated) end return objects end |
#get_external_element(element, query, objects) ⇒ Object
Loads an external element, according to query, and merges the result into an object or QuerySet.
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 710 def get_external_element(element, query, objects) # Spider::Logger.debug("Getting external element #{element.name} for #{@model}") return load_element(objects, element) if have_references?(element) return nil if objects.empty? index_by = [] @model.primary_keys.each{ |key| index_by << :"#{element.attributes[:reverse]}.#{key.name}" } result = objects.element_queryset(element).index_by(*index_by) @model.primary_keys.each{ |key| result.request[key.name] = true } result.request[element.attributes[:reverse]] = true if element.attributes[:polymorph] element.type.polymorphic_models.each do |mod, params| poly_req = Spider::Model::Request.new mod.primary_keys.each{ |k| poly_req.request(k) } result.request.with_polymorphs(mod, poly_req) end end result.load return associate_external(element, objects, result) end |
#have_references?(element) ⇒ Boolean
Returns true if information to find the given element is accessible to the mapper. (see for example DbMapper#have_references?)
109 110 111 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 109 def have_references?(element) raise MapperError, "Unimplemented" end |
#insert(obj) ⇒ Object
Inserts the object in the storage.
391 392 393 394 395 396 397 398 399 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 391 def insert(obj) prev_autoload = obj.save_mode() storage.in_transaction before_save(obj, :insert) do_insert(obj) after_save(obj, :insert) storage.commit_or_continue obj.autoload = prev_autoload end |
#load(objects, query, options = {}) ⇒ Object
Loads elements of given objects according to query.request.
532 533 534 535 536 537 538 539 540 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 532 def load(objects, query, ={}) objects = queryset_siblings(objects) unless objects.is_a?(QuerySet) request = query.request condition = Condition.or objects.each_current do |obj| condition << obj.keys_to_condition if obj.primary_keys_set? end return find(Query.new(condition, request), objects, ) end |
#load_element(objects, element) ⇒ Object
Loads an element. Other elements may be loaded as well, according to lazy groups.
522 523 524 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 522 def load_element(objects, element) load(objects, Query.new(nil, [element.name])) end |
#load_element!(objects, element) ⇒ Object
Loads only the given element, ignoring lazy groups.
527 528 529 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 527 def load_element!(objects, element) load(objects, Query.new(nil, [element.name]), :no_expand_request => true) end |
#lock(obj = nil, mode = :exclusive) ⇒ Object
Actual interaction with the storage. May be implemented by subclasses.
508 509 510 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 508 def lock(obj=nil, mode=:exclusive) raise MapperError, "Unimplemented" end |
#map(request, result, obj_or_model) ⇒ Object
Transforms a Storage result into an object. Should be implemented by subclasses.
670 671 672 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 670 def map(request, result, obj_or_model) raise MapperError, "Unimplemented" end |
#map_back_value(type, value) ⇒ Object
Converts a storage value back to the corresponding base type or DataType.
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 806 def map_back_value(type, value) value = value[0] if value.class == Array value = storage_value_to_mapper(Model.simplify_type(type), value) if type <= Spider::DataTypes::PK value = value.is_a?(Spider::DataTypes::PK) ? value.obj : value elsif type < Spider::DataType && type.maps_back_to type = type.maps_back_to end case type.name when 'Fixnum' return value ? value.to_i : nil when 'Float' return value ? value.to_f : nil end return nil unless value case type.name when 'Date', 'DateTime' return type.parse(value) unless value.is_a?(Date) end if type < Spider::DataType && type.force_wrap? value = type.from_value(value) end return value end |
#map_condition_value(type, value) ⇒ Object
Prepares a value for a condition.
776 777 778 779 780 781 782 783 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 776 def map_condition_value(type, value) if value.is_a?(Range) return Range.new(map_condition_value(type, value.first), map_condition_value(type, value.last)) end return value if ( type.class == Class && type.subclass_of?(Spider::Model::BaseModel) ) value = map_value(type, value, :condition) return @storage.value_for_condition(Model.simplify_type(type), value) end |
#map_elements ⇒ Object
An array of mapped elements.
60 61 62 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 60 def map_elements # :nodoc: @model.elements_array.select{ |el| !@no_map_elements[el.name] } end |
#map_save_value(type, value, save_mode = :save) ⇒ Object
Prepares a value going to be bound to an insert or update statement
770 771 772 773 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 770 def map_save_value(type, value, save_mode=:save) value = map_value(type, value, :save) return @storage.value_for_save(Model.simplify_type(type), value, save_mode) end |
#map_value(type, value, mode = nil) ⇒ Object
Converts a value in one accepted by the storage.
791 792 793 794 795 796 797 798 799 800 801 802 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 791 def map_value(type, value, mode=nil) return value if value.nil? if type == Spider::DataTypes::PK value = value.obj if value.is_a?(Spider::DataTypes::PK) elsif type < Spider::DataType value = type.from_value(value) unless value.is_a?(type) value = value.map(self.type) elsif type.class == Class && type.subclass_of?(Spider::Model::BaseModel) value = type.primary_keys.map{ |key| value.send(key.name) } end value end |
#mapped?(element) ⇒ Boolean
Returns whether the given element can be handled by the mapper.
38 39 40 41 42 43 44 45 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 38 def mapped?(element) element = element.name if (element.is_a? Element) element = @model.elements[element] return false if (element.attributes[:unmapped]) return false if (element.attributes[:computed_from]) return false if @no_map_elements[element.name] return true end |
#merge_object(set, obj, request) ⇒ Object
:nodoc:
622 623 624 625 626 627 628 629 630 631 632 633 634 635 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 622 def merge_object(set, obj, request) # :nodoc: search = {} @model.primary_keys.each{ |k| search[k.name] = obj.get(k.name) } obj_res = set.find(search) # FIXME: find a better way obj_res._no_parent = true if (obj_res && obj_res[0]) obj_res[0].set_parent(set, nil) obj_res[0].merge!(obj, request) obj_res[0] else set << obj obj end end |
#no_map(*els) ⇒ Object
Sets that the given elements will not be processed.
33 34 35 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 33 def no_map(*els) els.each{ |el| @no_map_elements[el] = true } end |
#normalize(obj) ⇒ Object
Converts hashes and arrays to QuerySets and BaseModel instances.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 85 def normalize(obj) obj.no_autoload do @model.elements.select{ |n, el| mapped?(el) && el.model? && obj.element_has_value?(el) }.each do |name, element| val = obj.get(name) next if (val.is_a?(BaseModel) || val.is_a?(QuerySet)) if (val.is_a? Array) val.each_index { |i| val[i] = Spider::Model.get(element.model, val[i]) unless val[i].is_a?(BaseModel) || val.is_a?(QuerySet) } obj.set(name, QuerySet.new(element.model, val)) else val = Spider::Model.get(element.model, val) obj.set(name, val) end end end end |
#prepare_delete_condition(obj) ⇒ Object
420 421 422 423 424 425 426 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 420 def prepare_delete_condition(obj) condition = Condition.and @model.primary_keys.each do |key| condition[key.name] = map_condition_value(key.type, obj.get(key)) end return condition end |
#prepare_query(query, obj = nil) ⇒ Object
Strategy #
836 837 838 839 840 841 842 843 844 845 846 847 848 849 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 836 def prepare_query(query, obj=nil) if (query.request.polymorphs?) conds = split_condition_polymorphs(query.condition, query.request.polymorphs.keys) conds.each{ |polym, c| query.condition << c } end @model.elements_array.select{ |el| el.attributes[:order] }.sort{ |a, b| a_order = a.attributes[:order]; b_order = b.attributes[:order] (a_order.is_a?(Fixnum) ? a_order : 100) <=> (b_order.is_a?(Fixnum) ? b_order : 100) }.each{ |order_el| query.order_by(order_el.name) } query = @model.prepare_query(query) prepare_query_request(query.request, obj) preprocess_condition(query.condition) return query end |
#prepare_query_request(request, obj = nil) ⇒ Object
Normalizes a request.
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 883 def prepare_query_request(request, obj=nil) @model.primary_keys.each do |key| request[key] = true end new_requests = [] request.each do |k, v| next unless element = @model.elements[k] if (element.integrated?) integrated_from = element.integrated_from integrated_from_element = element.integrated_from_element new_requests << "#{integrated_from.name}.#{integrated_from_element}" end end new_requests.each{ |r| request.request(r) } end |
#preprocess_condition(condition) ⇒ Object
Preprocessing of the condition
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 923 def preprocess_condition(condition) model = condition.polymorph ? condition.polymorph : @model condition.simplify # This handles integrated elements, junctions, and prepares types def basic_preprocess(condition) # :nodoc: condition.conditions_array.each do |k, v, c| next if k.is_a?(Spider::QueryFuncs::Function) next unless element = model.elements[k] if (element.integrated?) condition.delete(k) integrated_from = element.integrated_from integrated_from_element = element.integrated_from_element condition.set("#{integrated_from.name}.#{integrated_from_element}", c, v) elsif (element.junction? && !v.is_a?(BaseModel) && !v.is_a?(Hash) && !v.nil?) # conditions on junction id don't make sense condition.delete(k) condition.set("#{k}.#{element.attributes[:junction_their_element]}", c, v) end if (element.type < Spider::DataType && !v.is_a?(element.type)) condition.delete(k) begin condition.set(k, c, element.type.from_value(v)) rescue TypeError => exc raise TypeError, "Can't convert #{v} to #{element.type} for element #{k} (#{exc.})" end elsif element.type == DateTime && v && !v.is_a?(Date) && !v.is_a?(Time) condition.delete(k) condition.set(k, c, DateTime.parse(v)) end end end basic_preprocess(condition) if @model.respond_to?(:prepare_condition) condition = @model.prepare_condition(condition) basic_preprocess(condition) end if @model.attributes[:integrated_models] @model.attributes[:integrated_models].each do |im, iel| if im.respond_to?(:prepare_condition) condition = im.prepare_condition(condition) basic_preprocess(condition) end end end # Utility function to set conditions on def set_pks_condition(condition, el, val, prefix) # :nodoc: el.model.primary_keys.each do |primary_key| new_prefix = "#{prefix}.#{primary_key.name}" if (primary_key.model?) if (primary_key.model.primary_keys.length == 1) # FIXME: this should not be needed, see below condition.set(new_prefix, '=', val.get(primary_key).get(primary_key.model.primary_keys[0])) else # FIXME! does not work, the subcondition does not get processed raise "Subconditions on multiple key elements not supported yet" subcond = Condition.new set_pks_condition(subcond, primary_key, val.get(primary_key), new_prefix) condition << subcond end else condition.set(new_prefix, '=', val.get(primary_key)) end end end # normalize condition values; converts objects and primary key values to correct conditions on keys condition.conditions_array.each do |k, v, comp| next if k.is_a?(QueryFuncs::Function) element = model.get_element(k) if (v && !v.is_a?(Condition) && element.model?) condition.delete(element.name) if v.is_a?(BaseModel) set_pks_condition(condition, element, v, element.name) elsif element.model.primary_keys.length == 1 new_v = Condition.new if (model.mapper.have_references?(element.name)) new_v.set(element.model.primary_keys[0].name, comp, v) else new_v.set(element.reverse, comp, v) end condition.set(element.name, comp, new_v) else raise MapperError, "Value condition passed on #{k}, but #{element.model} has more then one primary key" end end end # Final sanity check condition.each_with_comparison do |k, v, comp| next if k.is_a?(QueryFuncs::Function) element = model.elements[k.to_sym] raise MapperError , "Condition for non-existent element #{model}.#{k} " unless element raise MapperError, "Condition for computed element #{model}.#{k}" if element.attributes[:computed_from] end # Process subconditions condition.subconditions.each do |sub| preprocess_condition(sub) end return condition end |
#queryset_siblings(obj) ⇒ Object
Returns the siblings, if any, of the object, in its ancestor QuerySet.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 752 def queryset_siblings(obj) return QuerySet.new(@model, obj) unless obj._parent orig_obj = obj path = [] seen = {obj => true} while (obj._parent && !seen[obj._parent]) path.unshift(obj._parent_element) if (obj._parent_element) # otherwise it's a query set obj = obj._parent seen[obj] = true end res = path.empty? ? obj : obj.all_children(path) raise RuntimeError, "Broken object path" if (obj && !path.empty? && res.length < 1) res = QuerySet.new(@model, res) unless res.is_a?(QuerySet) res = res.select{ |obj| obj.primary_keys_set? } return res end |
#save(obj, request = nil) ⇒ Object
Saves the object to the storage.
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 218 def save(obj, request=nil) prev_autoload = obj.autoload? obj.save_mode storage.in_transaction save_mode = determine_save_mode(obj) before_save(obj, save_mode) # @model.elements_array.select{ |el| el.attributes[:integrated_model] }.each do |el| # obj.get(el).save if obj.element_modified?(el) # end if (save_mode == :update) do_update(obj) else do_insert(obj) end after_save(obj, save_mode) storage.commit_or_continue obj.autoload = prev_autoload unless @doing_save_done @doing_save_done = true save_done(obj, save_mode) end @doing_save_done = false obj.trigger(:saved, save_mode) true end |
#save_all(root) ⇒ Object
Saves the given object and all objects reachable from it.
383 384 385 386 387 388 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 383 def save_all(root) UnitOfWork.new do |uow| uow.add(root) uow.run() end end |
#save_associations(obj, mode) ⇒ Object
Saves object associations.
276 277 278 279 280 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 276 def save_associations(obj, mode) association_elements.select{ |el| obj.element_has_value?(el) }.each do |el| save_element_associations(obj, el, mode) end end |
#save_done(obj, mode) ⇒ Object
Hook called after a succesful save: the object is not in save mode.
210 211 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 210 def save_done(obj, mode) end |
#save_element_associations(obj, element, mode) ⇒ Object
Saves the associations from the given object to the element.
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 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 311 def save_element_associations(obj, element, mode) our_element = element.attributes[:reverse] val = obj.get(element) if element.attributes[:junction] their_element = element.attributes[:junction_their_element] if val.model != element.model # dereferenced junction val = [val] unless val.is_a?(Enumerable) unless mode == :insert current = obj.get_new current_val = current.get(element) current_val = [current_val] unless current_val.is_a?(Enumerable) condition = Condition.and val_condition = Condition.or current_val.each do |row| next if val.include?(row) val_condition[their_element] = row end condition << val_condition unless condition.empty? condition[our_element] = obj element.model.mapper.delete(condition) end end val.each do |row| next if current_val && current_val.include?(row) junction = element.model.new({ our_element => obj, their_element => row }) junction.mapper.insert(junction) end else unless mode == :insert condition = Condition.and condition[our_element] = obj if element.attributes[:junction_id] val.each do |row| next unless row_id = row.get(element.attributes[:junction_id]) condition.set(:id, '<>', row_id) end end element.model.mapper.delete(condition) end val.set(our_element, obj) if element.attributes[:junction_id] val.save! else val.insert end end else if element.multiple? condition = Condition.and condition[our_element] = obj val.each do |row| condition_row = Condition.or element.model.primary_keys.each{ |el| condition_row.set(el.name, '<>', row.get(el))} condition << condition_row end if element.owned? element.mapper.delete(condition) else element.mapper.bulk_update({our_element => nil}, condition) end end val = [val] unless val.is_a?(Enumerable) # one to one relationships val.each do |v| v.set(our_element, obj) v.mapper.save(v) end end end |
#save_extended_models(obj, mode) ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 170 def save_extended_models(obj, mode) if @model.extended_models @model.extended_models.each do |m, el| sub = obj.get(el) if mode == :update || sub.class.auto_primary_keys? || sub._check_if_saved sub.save if (obj.element_modified?(el) || !obj.primary_keys_set?) && sub.mapper.class.write? else sub.insert unless sub.in_storage? end end end end |
#save_integrated(obj, mode) ⇒ Object
183 184 185 186 187 188 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 183 def save_integrated(obj, mode) @model.elements_array.select{ |el| !el.integrated? && el.attributes[:integrated_model] && !el.attributes[:extended_model] }.each do |el| sub_obj = obj.get(el) sub_obj.save if sub_obj && sub_obj.modified? && obj.element_modified?(el) && obj.get(el).mapper.class.write? end end |
#sequence_next(name) ⇒ Object
Actual interaction with the storage. May be implemented by subclasses.
513 514 515 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 513 def sequence_next(name) raise MapperError, "Unimplemented" end |
#set_pks_condition(condition, el, val, prefix) ⇒ Object
Utility function to set conditions on
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 970 def set_pks_condition(condition, el, val, prefix) # :nodoc: el.model.primary_keys.each do |primary_key| new_prefix = "#{prefix}.#{primary_key.name}" if (primary_key.model?) if (primary_key.model.primary_keys.length == 1) # FIXME: this should not be needed, see below condition.set(new_prefix, '=', val.get(primary_key).get(primary_key.model.primary_keys[0])) else # FIXME! does not work, the subcondition does not get processed raise "Subconditions on multiple key elements not supported yet" subcond = Condition.new set_pks_condition(subcond, primary_key, val.get(primary_key), new_prefix) condition << subcond end else condition.set(new_prefix, '=', val.get(primary_key)) end end end |
#someone_have_references?(element) ⇒ Boolean
Returns true if information to find the given element is accessible to the mapper, or to an integrated model’s mapper. (see for example DbMapper#someone_have_references?)
115 116 117 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 115 def someone_have_references?(element) raise MapperError, "Unimplemented" end |
#sortable?(element) ⇒ Boolean
47 48 49 50 51 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 47 def sortable?(element) element = element.name if (element.is_a? Element) element = @model.elements[element] mapped?(element) || element.attributes[:sortable] end |
#split_condition_polymorphs(condition, polymorphs) ⇒ Object
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 851 def split_condition_polymorphs(condition, polymorphs) conditions = {} return conditions if condition.polymorph && polymorphs.include?(condition.polymorph) model = condition.polymorph ? condition.polymorph : @model condition.conditions_array.each do |el, val, comp| if (!model.has_element?(el)) polymorphs.each do |polym| if (polym.has_element?(el)) conditions[polym] ||= Condition.new conditions[polym].polymorph = polym conditions[polym].set(el, comp, val) condition.delete(el) end end end end condition.subconditions.each do |sub| res = split_condition_polymorphs(sub, polymorphs) polymorphs.each do |polym| next unless res[polym] if (!conditions[polym]) conditions[polym] = res[polym] else conditions[polym] << res[polym] end end end return conditions end |
#storage_value_to_mapper(type, value) ⇒ Object
785 786 787 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 785 def storage_value_to_mapper(type, value) storage.value_to_mapper(type, value) end |
#truncate! ⇒ Object
488 489 490 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 488 def truncate! raise MapperError, "Unimplemented" end |
#update(obj) ⇒ Object
Updates the object in the storage.
402 403 404 405 406 407 408 409 410 |
# File 'lib/spiderfw/model/mappers/mapper.rb', line 402 def update(obj) prev_autoload = obj.save_mode() storage.in_transaction before_save(obj, :update) do_update(obj) after_save(obj, :update) storage.commit_or_continue obj.autoload = prev_autoload end |