active-fedora 6.8.0 → 7.0.0.pre1

data/lib/active_fedora/autosave_association.rb

@@ -0,0 +1,317 @@
+module ActiveFedora
+  # = Active Fedora Autosave Association
+  #
+  # +AutosaveAssociation+ is a module that takes care of automatically saving
+  # associacted records when their parent is saved. In addition to saving, it
+  # also destroys any associated records that were marked for destruction.
+  # (See +mark_for_destruction+ and <tt>marked_for_destruction?</tt>).
+  #
+  # Saving of the parent, its associations, and the destruction of marked
+  # associations, all happen inside a transaction. This should never leave the
+  # database in an inconsistent state.
+  #
+  # If validations for any of the associations fail, their error messages will
+  # be applied to the parent.
+  #
+  # Note that it also means that associations marked for destruction won't
+  # be destroyed directly. They will however still be marked for destruction.
+  #
+  # Note that <tt>:autosave => false</tt> is not same as not declaring <tt>:autosave</tt>.
+  # When the <tt>:autosave</tt> option is not present new associations are saved.
+  #
+  # === One-to-many Example
+  #
+  # When <tt>:autosave</tt> is not declared new children are saved when their parent is saved:
+  #
+  #   class Post
+  #     has_many :comments # :autosave option is no declared
+  #   end
+  #
+  #   post = Post.new(:title => 'ruby rocks')
+  #   post.comments.build(:body => 'hello world')
+  #   post.save # => saves both post and comment
+  #
+  #   post = Post.create(:title => 'ruby rocks')
+  #   post.comments.build(:body => 'hello world')
+  #   post.save # => saves both post and comment
+  #
+  #   post = Post.create(:title => 'ruby rocks')
+  #   post.comments.create(:body => 'hello world')
+  #   post.save # => saves both post and comment
+  #
+  # When <tt>:autosave</tt> is true all children is saved, no matter whether they are new records:
+  #
+  #   class Post
+  #     has_many :comments, :autosave => true
+  #   end
+  #
+  #   post = Post.create(:title => 'ruby rocks')
+  #   post.comments.create(:body => 'hello world')
+  #   post.comments[0].body = 'hi everyone'
+  #   post.save # => saves both post and comment, with 'hi everyone' as body
+  #
+  # Destroying one of the associated models as part of the parent's save action
+  # is as simple as marking it for destruction:
+  #
+  #   post.comments.last.mark_for_destruction
+  #   post.comments.last.marked_for_destruction? # => true
+  #   post.comments.length # => 2
+  #
+  # Note that the model is _not_ yet removed from the database:
+  #
+  #   id = post.comments.last.id
+  #   Comment.find_by_id(id).nil? # => false
+  #
+  #   post.save
+  #   post.reload.comments.length # => 1
+  #
+  # Now it _is_ removed from the database:
+  #
+  #   Comment.find_by_id(id).nil? # => true
+  #
+  # === Validation
+  #
+  # Children records are validated unless <tt>:validate</tt> is +false+.
+  module AutosaveAssociation
+    extend ActiveSupport::Concern
+
+    ASSOCIATION_TYPES = %w{ HasMany BelongsTo HasAndBelongsToMany }
+
+    module AssociationBuilderExtension #:nodoc:
+      def self.included(base)
+        base.valid_options << :autosave
+      end
+
+      def build
+        reflection = super
+        model.send(:add_autosave_association_callbacks, reflection)
+        reflection
+      end
+    end
+
+    included do
+      ASSOCIATION_TYPES.each do |type|
+        Associations::Builder.const_get(type).send(:include, AssociationBuilderExtension)
+      end
+    end
+
+    module ClassMethods
+      private
+
+      def define_non_cyclic_method(name, reflection, &block)
+        define_method(name) do |*args|
+          result = true; @_already_called ||= {}
+          # Loop prevention for validation of associations
+          unless @_already_called[[name, reflection.name]]
+            begin
+              @_already_called[[name, reflection.name]]=true
+              result = instance_eval(&block)
+            ensure
+              @_already_called[[name, reflection.name]]=false
+            end
+          end
+
+          result
+        end
+      end
+
+      # Adds validation and save callbacks for the association as specified by
+      # the +reflection+.
+      #
+      # For performance reasons, we don't check whether to validate at runtime.
+      # However the validation and callback methods are lazy and those methods
+      # get created when they are invoked for the very first time.  However,
+      # this can change, for instance, when using nested attributes, which is
+      # called _after_ the association has been defined. Since we don't want
+      # the callbacks to get defined multiple times, there are guards that
+      # check if the save or validation methods have already been defined
+      # before actually defining them.
+      def add_autosave_association_callbacks(reflection)
+        save_method = :"autosave_associated_records_for_#{reflection.name}"
+        validation_method = :"validate_associated_records_for_#{reflection.name}"
+        collection = reflection.collection?
+
+        unless method_defined?(save_method)
+          if collection
+            before_save :before_save_collection_association
+
+            define_non_cyclic_method(save_method, reflection) { save_collection_association(reflection) }
+            # Doesn't use after_save as that would save associations added in after_create/after_update twice
+            after_create save_method
+            after_update save_method
+          else
+            define_non_cyclic_method(save_method, reflection) { save_belongs_to_association(reflection) }
+            before_save save_method
+          end
+        end
+
+        if reflection.validate? && !method_defined?(validation_method)
+          method = (collection ? :validate_collection_association : :validate_single_association)
+          define_non_cyclic_method(validation_method, reflection) { send(method, reflection) }
+          validate validation_method
+        end
+      end
+    end
+
+    # Reloads the attributes of the object as usual and clears <tt>marked_for_destruction</tt> flag.
+    def reload(options = nil)
+      @marked_for_destruction = false
+      super
+    end
+
+    # Marks this record to be destroyed as part of the parents save transaction.
+    # This does _not_ actually destroy the record instantly, rather child record will be destroyed
+    # when <tt>parent.save</tt> is called.
+    #
+    # Only useful if the <tt>:autosave</tt> option on the parent is enabled for this associated model.
+    def mark_for_destruction
+      @marked_for_destruction = true
+    end
+
+    # Returns whether or not this record will be destroyed as part of the parents save transaction.
+    #
+    # Only useful if the <tt>:autosave</tt> option on the parent is enabled for this associated model.
+    def marked_for_destruction?
+      @marked_for_destruction
+    end
+
+    # Returns whether or not this record has been changed in any way (including whether
+    # any of its nested autosave associations are likewise changed)
+    def changed_for_autosave?
+      new_record? || changed? || marked_for_destruction? || nested_records_changed_for_autosave?
+    end
+
+    private
+
+    # Returns the record for an association collection that should be validated
+    # or saved. If +autosave+ is +false+ only new records will be returned,
+    # unless the parent is/was a new record itself.
+    def associated_records_to_validate_or_save(association, new_record, autosave)
+      if new_record
+        association && association.target
+      elsif autosave
+        association.target.find_all { |record| record.changed_for_autosave? }
+      else
+        association.target.find_all { |record| record.new_record? }
+      end
+    end
+
+    # go through nested autosave associations that are loaded in memory (without loading
+    # any new ones), and return true if is changed for autosave
+    def nested_records_changed_for_autosave?
+      self.class.reflect_on_all_autosave_associations.any? do |reflection|
+        association = association_instance_get(reflection.name)
+        association && Array(association.target).any? { |a| a.changed_for_autosave? }
+      end
+    end
+
+    # Validate the association if <tt>:validate</tt> or <tt>:autosave</tt> is
+    # turned on for the association.
+    def validate_single_association(reflection)
+      association = association_instance_get(reflection.name)
+      record      = association && association.target
+      association_valid?(reflection, record) if record
+    end
+
+    # Validate the associated records if <tt>:validate</tt> or
+    # <tt>:autosave</tt> is turned on for the association specified by
+    # +reflection+.
+    def validate_collection_association(reflection)
+      if association = association_instance_get(reflection.name)
+        if records = associated_records_to_validate_or_save(association, new_record?, reflection.options[:autosave])
+          records.each { |record| association_valid?(reflection, record) }
+        end
+      end
+    end
+
+    # Returns whether or not the association is valid and applies any errors to
+    # the parent, <tt>self</tt>, if it wasn't. Skips any <tt>:autosave</tt>
+    # enabled records if they're marked_for_destruction? or destroyed.
+    def association_valid?(reflection, record)
+      return true if record.destroyed? || record.marked_for_destruction?
+
+      unless valid = record.valid?
+        if reflection.options[:autosave]
+          record.errors.each do |attribute, message|
+            attribute = "#{reflection.name}.#{attribute}"
+            errors[attribute] << message
+            errors[attribute].uniq!
+          end
+        else
+          errors.add(reflection.name)
+        end
+      end
+      valid
+    end
+
+    # Is used as a before_save callback to check while saving a collection
+    # association whether or not the parent was a new record before saving.
+    def before_save_collection_association
+      @new_record_before_save = new_record?
+      true
+    end
+
+    # Saves any new associated records, or all loaded autosave associations if
+    # <tt>:autosave</tt> is enabled on the association.
+    #
+    # In addition, it destroys all children that were marked for destruction
+    # with mark_for_destruction.
+    #
+    # This all happens inside a transaction, _if_ the Transactions module is included into
+    # ActiveFedora::Base after the AutosaveAssociation module, which it does by default.
+    def save_collection_association(reflection)
+      if association = association_instance_get(reflection.name)
+        autosave = reflection.options[:autosave]
+
+        if records = associated_records_to_validate_or_save(association, @new_record_before_save, autosave)
+          records.each do |record|
+            next if record.destroyed?
+
+            saved = true
+
+            if autosave && record.marked_for_destruction?
+              association.proxy.destroy(record)
+            elsif autosave != false && (@new_record_before_save || record.new_record?)
+              if autosave
+                saved = association.insert_record(record, false)
+              else
+                association.insert_record(record)
+              end
+            elsif autosave
+              saved = record.save(:validate => false)
+            end
+
+            raise ActiveFedora::Rollback unless saved
+          end
+        end
+
+        # reconstruct the scope now that we know the owner's id
+        association.send(:construct_scope) if association.respond_to?(:construct_scope)
+      end
+    end
+
+    # Saves the associated record if it's new or <tt>:autosave</tt> is enabled.
+    #
+    # In addition, it will destroy the association if it was marked for destruction.
+    def save_belongs_to_association(reflection)
+      association = association_instance_get(reflection.name)
+      record      = association && association.load_target
+      if record && !record.destroyed?
+        autosave = reflection.options[:autosave]
+
+        if autosave && record.marked_for_destruction?
+          record.destroy
+        elsif autosave != false
+          saved = record.save(:validate => !autosave) if record.new_record? || (autosave && record.changed_for_autosave?)
+
+          if association.updated?
+            self[reflection.name.to_s + "_id"] = record.id
+            association.loaded!
+          end
+
+          saved if autosave
+        end
+      end
+    end
+  end
+end

data/lib/active_fedora/base.rb

@@ -12,7 +12,7 @@ module ActiveFedora
   #
   # =The Basics
   #   class Oralhistory < ActiveFedora::Base
-  #     has_metadata :name => "properties", :type => ActiveFedora::SimpleDatastream do |m|
+  #     has_metadata "properties", type: ActiveFedora::SimpleDatastream do |m|
   #       m.field "narrator",  :string
   #       m.field "narrator",  :text
   #     end
@@ -24,344 +24,27 @@ module ActiveFedora
   # Datastreams defined with +has_metadata+ are accessed via the +datastreams+ member hash.
   #
   class Base
+    extend ActiveModel::Naming
+    extend ActiveSupport::DescendantsTracker
     include SemanticNode
-
-    class_attribute :fedora_connection, :profile_solr_name
-    self.fedora_connection = {}
-    self.profile_solr_name = ActiveFedora::SolrService.solr_name("object_profile", :displayable)
-
-    delegate :state=,:label=, to: :inner_object
-
-    def method_missing(name, *args)
-      dsid = corresponding_datastream_name(name)
-      if dsid
-        ### Create and invoke a proxy method 
-        self.class.send :define_method, name do
-            datastreams[dsid]
-        end
-        self.send(name)
-      else 
-        super
-      end
-    end
-
-    def new?
-      new_object?
-    end
-
-    # Has this object been saved?
-    def new_object?
-      inner_object.new?
-    end
-    
-    ## Required by associations
-    def new_record?
-      self.new_object?
-    end
-
-    def persisted?
-      !new_object?
-    end
-
-    def mark_for_destruction
-      @marked_for_destruction = true
-    end
-
-    def marked_for_destruction?
-      @marked_for_destruction
-    end
-
-    # Constructor.  You may supply a custom +:pid+, or we call the Fedora Rest API for the
-    # next available Fedora pid, and mark as new object.
-    # Also, if +attrs+ does not contain +:pid+ but does contain +:namespace+ it will pass the
-    # +:namespace+ value to Fedora::Repository.nextid to generate the next pid available within
-    # the given namespace.
-    def initialize(attrs = nil)
-      attrs = {} if attrs.nil?
-      @association_cache = {}
-      attributes = attrs.dup
-      @inner_object = UnsavedDigitalObject.new(self.class, attributes.delete(:namespace), attributes.delete(:pid))
-      self.relationships_loaded = true
-      load_datastreams
-
-      [:new_object,:create_date, :modified_date].each { |k| attributes.delete(k)}
-      self.attributes=attributes
-      run_callbacks :initialize
-    end
-
-    # Reloads the object from Fedora.
-    def reload
-      raise ActiveFedora::ObjectNotFoundError, "Can't reload an object that hasn't been saved" unless persisted?
-      clear_association_cache
-      init_with_object(self.class.find(self.pid, cast: false).inner_object)
-    end
-
-    # Initialize an empty model object and set the +inner_obj+
-    # example:
-    #
-    #   class Post < ActiveFedora::Base
-    #     has_metadata :name => "properties", :type => ActiveFedora::SimpleDatastream
-    #   end
-    #
-    #   post = Post.allocate
-    #   post.init_with_object(DigitalObject.find(pid))
-    #   post.properties.title # => 'hello world'
-    def init_with_object(inner_obj)
-      @association_cache = {}
-      @inner_object = inner_obj
-      unless @inner_object.is_a? SolrDigitalObject
-        @inner_object.original_class = self.class
-        ## Replace existing unchanged datastreams with the definitions found in this class if they have a different type.
-        ## Any datastream that is deleted here will cause a reload from fedora, so avoid it whenever possible
-        ds_specs.keys.each do |key|
-          if @inner_object.datastreams[key] != nil && !@inner_object.datastreams[key].content_changed? && @inner_object.datastreams[key].class != self.class.ds_specs[key][:type]
-            @inner_object.datastreams.delete(key)
-          end
-        end
-      end
-      load_datastreams
-      run_callbacks :find
-      run_callbacks :initialize
-      self
-    end
-
-    # Uses {shard_index} to find or create the rubydora connection for this pid
-    # @param [String] pid the identifier of the object to get the connection for
-    # @return [Rubydora::Repository] The repository that the identifier exists in.
-    def self.connection_for_pid(pid)
-      idx = shard_index(pid)
-      unless fedora_connection.has_key? idx
-        if ActiveFedora.config.sharded?
-          fedora_connection[idx] = RubydoraConnection.new(ActiveFedora.config.credentials[idx])
-        else
-          fedora_connection[idx] = RubydoraConnection.new(ActiveFedora.config.credentials)
-        end
-      end
-      fedora_connection[idx].connection
-    end
-
-    # This is where your sharding strategy is implemented -- it's how we figure out which shard an object will be (or was) written to.
-    # Given a pid, it decides which shard that pid will be written to (and thus retrieved from).
-    # For a given pid, as long as your shard configuration remains the same it will always return the same value.
-    # If you're not using sharding, this will always return 0, meaning use the first/only Fedora Repository in your configuration.
-    # Default strategy runs a modulo of the md5 of the pid against the number of shards.
-    # If you want to use a different sharding strategy, override this method.  Make sure that it will always return the same value for a given pid and shard configuration.
-    #@return [Integer] the index of the shard this object is stored in
-    def self.shard_index(pid)
-      if ActiveFedora.config.sharded?
-        Digest::MD5.hexdigest(pid).hex % ActiveFedora.config.credentials.length
-      else
-        0
-      end
-    end
-    
-
-    def self.datastream_class_for_name(dsid)
-      ds_specs[dsid] ? ds_specs[dsid].fetch(:type, ActiveFedora::Datastream) : ActiveFedora::Datastream
-    end
-
-    def clone
-      new_object = self.class.create
-      clone_into(new_object)
-    end
-
-    # Clone the datastreams from this object into the provided object, while preserving the pid of the provided object
-    # @param [Base] new_object clone into this object
-    def clone_into(new_object)
-      rels = Nokogiri::XML( rels_ext.content)
-      rels.xpath("//rdf:Description/@rdf:about").first.value = new_object.internal_uri
-      new_object.rels_ext.content = rels.to_xml
-
-      datastreams.each do |k, v|
-        next if k == 'RELS-EXT'
-        new_object.datastreams[k].content = v.content
-      end
-      new_object if new_object.save
-    end
-
-    ### if you are doing sharding, override this method to do something other than use a sequence
-    # @return [String] the unique pid for a new object
-    def self.assign_pid(obj)
-      args = {}
-      args[:namespace] = obj.namespace if obj.namespace
-      # TODO: This juggling of Fedora credentials & establishing connections should be handled by 
-      # an establish_fedora_connection method,possibly wrap it all into a fedora_connection method - MZ 06-05-2012
-      if ActiveFedora.config.sharded?
-        credentials = ActiveFedora.config.credentials[0]
-      else
-        credentials = ActiveFedora.config.credentials
-      end
-      fedora_connection[0] ||= ActiveFedora::RubydoraConnection.new(credentials)
-      fedora_connection[0].connection.mint(args)
-    end
-
-    def inner_object # :nodoc
-      @inner_object
-    end
-
-    #return the pid of the Fedora Object
-    # if there is no fedora object (loaded from solr) get the instance var
-    # TODO make inner_object a proxy that can hold the pid
-    def pid
-       @inner_object.pid
-    end
-
-
-    def id   ### Needed for the nested form helper
-      self.pid
-    end
-    
-    def to_param
-      persisted? ? to_key.join('-') : nil
-    end
-
-    def to_key
-      persisted? ? [pid] : nil
-    end
-
-    #return the internal fedora URI
-    def internal_uri
-      "info:fedora/#{pid}"
-    end
-
-    #return the owner id
-    def owner_id
-      Array(@inner_object.ownerId).first
-    end
-    
-    def owner_id=(owner_id)
-      @inner_object.ownerId=(owner_id)
-    end
-
-    def label
-      Array(@inner_object.label).first
-    end
-
-    def state
-      Array(@inner_object.state).first
-    end
-
-    #return the create_date of the inner object (unless it's a new object)
-    def create_date
-      if @inner_object.new?
-        Time.now
-      elsif @inner_object.respond_to? :createdDate
-        Array(@inner_object.createdDate).first
-      else
-        @inner_object.profile['objCreateDate']
-      end
-    end
-
-    #return the modification date of the inner object (unless it's a new object)
-    def modified_date
-      @inner_object.new? ? Time.now : Array(@inner_object.lastModifiedDate).first
-    end
-
-    def ==(comparison_object)
-         comparison_object.equal?(self) ||
-           (comparison_object.instance_of?(self.class) &&
-             comparison_object.pid == pid &&
-             !comparison_object.new_record?)
-    end
-
-
-    def pretty_pid
-      if self.pid == UnsavedDigitalObject::PLACEHOLDER
-        nil
-      else
-        self.pid
-      end
-    end
-
-    # This method adapts the inner_object to a new ActiveFedora::Base implementation
-    # This is intended to minimize redundant interactions with Fedora
-    def adapt_to(klass)
-      unless klass.ancestors.include? ActiveFedora::Base
-        raise "Cannot adapt #{self.class.name} to #{klass.name}: Not a ActiveFedora::Base subclass"
-      end
-      klass.allocate.init_with_object(inner_object)
-    end
-
-    # Examines the :has_model assertions in the RELS-EXT.
-    #
-    # If the object is of type ActiveFedora::Base, then use the first :has_model
-    # in the RELS-EXT for this object. Due to how the RDF writer works, this is
-    # currently just the first alphabetical model.
-    #
-    # If the object was instantiated with any other class, then use that class
-    # as the base of the type the user wants rather than casting to the first
-    # :has_model found on the object.
-    #
-    # In either case, if an extended model of that initial base model of the two
-    # cases above exists in the :has_model, then instantiate as that extended
-    # model type instead.
-    def adapt_to_cmodel
-      best_model_match = self.class unless self.instance_of? ActiveFedora::Base
-
-      ActiveFedora::ContentModel.known_models_for( self ).each do |model_value|
-        # If this is of type ActiveFedora::Base, then set to the first found :has_model.
-        best_model_match ||= model_value
-
-        # If there is an inheritance structure, use the most specific case.
-        if best_model_match > model_value
-          best_model_match = model_value
-        end
-      end
-
-      self.instance_of?(best_model_match) ? self : self.adapt_to(best_model_match)
-    end
-    
-    # ** EXPERIMENTAL **
-    # This method returns a new object of the same class, with the internal SolrDigitalObject
-    # replaced with an actual DigitalObject.
-    def reify
-      if self.inner_object.is_a? DigitalObject
-        raise "#{self.inspect} is already a full digital object"
-      end
-      self.class.find self.pid
-    end
-    
-    # ** EXPERIMENTAL **
-    # This method reinitializes a lightweight, loaded-from-solr object with an actual
-    # DigitalObject inside.
-    def reify!
-      if self.inner_object.is_a? DigitalObject
-        raise "#{self.inspect} is already a full digital object"
-      end
-      self.init_with_object DigitalObject.find(self.class,self.pid)
-    end
-    
-    def self.pids_from_uris(uris) 
-      if uris.class == String
-        return uris.gsub("info:fedora/", "")
-      elsif uris.class == Array
-        arr = []
-        uris.each do |uri|
-          arr << uri.gsub("info:fedora/", "")
-        end
-        return arr
-      end
-    end
-  end
-
-  Base.class_eval do
+    include Sharding
     include ActiveFedora::Persistence
-    extend ActiveSupport::DescendantsTracker
-    extend Model
+    include Scoping
     include Loggable
     include Indexing
     include ActiveModel::Conversion
     include Validations
     include Callbacks
-    include Attributes
     include Datastreams
-    extend ActiveModel::Naming
-    include Delegating
     extend Querying
     include Associations
+    include AutosaveAssociation
     include NestedAttributes
     include Reflection
-    include ActiveModel::Dirty
+    include Attributes
+    include Serialization
+    include Core
+    include FedoraAttributes
   end
 
 end