active-fedora 8.7.0 → 9.0.0.beta1

data/lib/active_fedora/attributes/primary_key.rb

@@ -0,0 +1,12 @@
+module ActiveFedora
+  module Attributes
+    module PrimaryKey
+
+      # If the id is "/foo:1" then to_key ought to return ["foo:1"]
+      def to_key
+        id && [id]
+      end
+
+    end
+  end
+end

data/lib/active_fedora/autosave_association.rb

@@ -154,7 +154,7 @@ module ActiveFedora
     end
 
     # Reloads the attributes of the object as usual and clears <tt>marked_for_destruction</tt> flag.
-    def reload(options = nil)
+    def reload
       @marked_for_destruction = false
       super
     end
@@ -305,7 +305,7 @@ module ActiveFedora
           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
+            self[reflection.name.to_s + "_id"] = record.id #TODO use primary_key here
             association.loaded!
           end
 

data/lib/active_fedora/base.rb

@@ -1,10 +1,10 @@
 SOLR_DOCUMENT_ID = "id" unless (defined?(SOLR_DOCUMENT_ID) && !SOLR_DOCUMENT_ID.nil?)
 ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
-require "digest"
 require 'active_support/descendants_tracker'
+require 'active_fedora/errors'
 
 module ActiveFedora
-  
+
   # This class ties together many of the lower-level modules, and
   # implements something akin to an ActiveRecord-alike interface to
   # fedora. If you want to represent a fedora object in the ruby
@@ -14,38 +14,39 @@ module ActiveFedora
   #   class Oralhistory < ActiveFedora::Base
   #     has_metadata "properties", type: ActiveFedora::SimpleDatastream do |m|
   #       m.field "narrator",  :string
-  #       m.field "bio",  :text
+  #       m.field "narrator",  :text
   #     end
   #   end
   #
-  # The above example creates a Fedora object with a metadata datastream named "properties", which is composed of a 
+  # The above example creates a Fedora object with a metadata datastream named "properties", which is composed of a
   # narrator and bio field.
   #
-  # Datastreams defined with +has_metadata+ are accessed via the +datastreams+ member hash.
+  # Attached files defined with +contains+ are accessed via the +attached_files+ member hash.
   #
   class Base
     extend ActiveModel::Naming
     extend ActiveSupport::DescendantsTracker
-    include SemanticNode
-    include Sharding
-    include ActiveFedora::Persistence
-    include Scoping
+
+    include Core
+    include Persistence
     include Indexing
+    include Scoping
     include ActiveModel::Conversion
-    include Validations
     include Callbacks
-    include Datastreams
+    include Validations
     extend Querying
     include Associations
     include AutosaveAssociation
     include NestedAttributes
     include Reflection
-    include Attributes
     include Serialization
-    include Core
+
+    include AttachedFiles
     include FedoraAttributes
-    include ReloadOnSave
-    include ActiveFedora::RDF::Identifiable
+    include AttributeMethods
+    include Attributes
+    include Versionable
+    include LoadableFromJson
   end
 
   ActiveSupport.run_load_hooks(:active_fedora, Base)

data/lib/active_fedora/callbacks.rb

@@ -232,16 +232,16 @@ module ActiveFedora
 
   private
 
-    def persist(should_update_index) #:nodoc:
-      run_callbacks(:save) { super }
-    end
-
-    def create(*) #:nodoc:
-      run_callbacks(:create) { super }
+    def create_record(*) #:nodoc:
+      run_callbacks(:create) {
+        run_callbacks(:save) { super }
+      }
     end
 
     def update_record(*) #:nodoc:
-      run_callbacks(:update) { super }
+      run_callbacks(:update) { 
+        run_callbacks(:save) { super }
+      }
     end
   end
 end

data/lib/active_fedora/change_set.rb

@@ -0,0 +1,34 @@
+module ActiveFedora
+  # a Hash of properties that have changed and their present values
+  class ChangeSet
+
+    attr_reader :object, :graph, :changed_attributes
+
+    # @param [ActiveFedora::Base] object The resource that has associations and properties
+    # @param [RDF::Graph] graph The RDF graph that holds the current state
+    # @param [Array] changed_attributes A list of properties that have changed
+    def initialize(object, graph, changed_attributes)
+      @object = object
+      @graph = graph
+      @changed_attributes = changed_attributes
+    end
+
+    def empty?
+      changes.empty?
+    end
+
+    def changes
+      @changes ||= changed_attributes.each_with_object({}) do |key, result|
+        if m = /^.*_ids?$/.match(key)
+          predicate = object.association(m[0].to_sym).reflection.predicate
+          result[predicate] = graph.query(predicate: predicate)
+        elsif object.class.properties.keys.include?(key)
+          predicate = graph.reflections.reflect_on_property(key).predicate
+          result[predicate] = graph.query(predicate: predicate)
+        elsif object.local_attributes.include?(key)
+          raise "Unable to find a graph predicate corresponding to the attribute: \"#{key}\""
+        end
+      end
+    end
+  end
+end

data/lib/active_fedora/cleaner.rb

@@ -0,0 +1,62 @@
+module ActiveFedora
+  module Cleaner
+    def self.clean!
+      cleanout_fedora
+      reinitialize_repo
+      cleanout_solr
+    end
+
+    def self.cleanout_fedora
+      begin
+        delete_root_resource
+        delete_tombstone
+      rescue Ldp::HttpError => exception
+        log "#cleanout_fedora in spec_helper.rb raised #{exception}"
+      end
+    end
+
+    def self.delete_root_resource
+      begin
+        connection.delete(root_resource_path)
+      rescue Ldp::Gone
+      end
+    end
+
+    def self.delete_tombstone
+      connection.delete(tombstone_path)
+    end
+
+    def self.tombstone_path
+      root_resource_path + "/fcr:tombstone"
+    end
+
+    def self.root_resource_path
+      ActiveFedora.fedora.base_path.sub('/', '')
+    end
+
+    def self.connection
+      ActiveFedora.fedora.connection
+    end
+
+    def self.solr_connection
+      ActiveFedora::SolrService.instance && ActiveFedora::SolrService.instance.conn
+    end
+
+    def self.cleanout_solr
+      restore_spec_configuration if solr_connection.nil?
+      solr_connection.delete_by_query('*:*', params: {'softCommit' => true})
+    end
+
+    def self.reinitialize_repo
+      begin
+        ActiveFedora.fedora.connection.put(root_resource_path, "")
+      rescue Ldp::HttpError => exception
+        log "#reinitialize_repo in spec_helper.rb raised #{exception}"
+      end
+    end
+
+    def self.log(message)
+      ActiveFedora::Base.logger.debug message if ActiveFedora::Base.logger
+    end
+  end
+end

data/lib/active_fedora/config.rb

@@ -1,29 +1,11 @@
-module ActiveFedora 
+module ActiveFedora
   class Config
     attr_reader :credentials
     def initialize(val)
-      if val.is_a? Array
-        init_shards(val)
-      else 
-        init_single(val)
+      @credentials = val.symbolize_keys
+      unless @credentials.has_key?(:url)
+        raise ActiveFedora::ConfigurationError, "Fedora configuration must provide :url."
       end
     end
-
-    def sharded?
-      credentials.is_a? Array
-    end
-
-    private
-
-    def init_shards(vals)
-        @credentials = vals.map(&:symbolize_keys)
-    end
-
-    def init_single(vals)
-        @credentials = vals.symbolize_keys
-        unless @credentials.has_key?(:user) && @credentials.has_key?(:password) && @credentials.has_key?(:url)
-          raise ActiveFedora::ConfigurationError, "Fedora configuration must provide :user, :password and :url."
-        end
-    end
   end
 end

data/lib/active_fedora/core.rb

@@ -1,8 +1,7 @@
 module ActiveFedora
   module Core
     extend ActiveSupport::Concern
-    
-    attr_reader :inner_object
+
     included do
       ##
       # :singleton-method:
@@ -10,58 +9,66 @@ module ActiveFedora
       # Accepts a logger conforming to the interface of Log4r which can be
       # retrieved on both a class and instance level by calling +logger+.
       mattr_accessor :logger, instance_writer: false
+
+      ##
+      # :singleton-method
+      #
+      # Accepts a proc that takes an id and transforms it to a URI
+      mattr_accessor :translate_id_to_uri, instance_writer: false
+
+      ##
+      # :singleton-method
+      #
+      # Accepts a proc that takes a uri and transforms it to an id
+      mattr_accessor :translate_uri_to_id, instance_writer: false
+
     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
+    def ldp_source
+      @ldp_source
+    end
+
+    # Constructor.  You may supply a custom +:id+, or we call the Fedora Rest API for the
+    # next available Fedora id, and mark as new object.
+    # Also, if +attrs+ does not contain +:id+ but does contain +:namespace+ it will pass the
+    # +:namespace+ value to Fedora::Repository.nextid to generate the next id 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
+    def initialize(attributes_or_resource_or_url = nil, &block)
+      init_internals
+      attributes = initialize_resource_and_attributes(attributes_or_resource_or_url)
+      raise IllegalOperation, "Attempting to recreate existing ldp_source" unless ldp_source.new?
+      assert_content_model
+      load_attached_files
+      self.attributes = attributes if attributes
+
+      yield self if block_given?
       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?
+      check_persistence unless persisted?
       clear_association_cache
-      clear_relationships
-      init_with_object(self.class.find(self.pid).inner_object)
+      clear_attached_files
+      @ldp_source = LdpResource.new(conn, uri)
+      @resource = nil
+      load_attached_files
+      self
     end
 
-    # Initialize an empty model object and set the +inner_obj+
+    # Initialize an empty model object and set its +resource+
     # 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
+    #   post.init_with_resource(Ldp::Resource.new('http://example.com/post/1'))
+    #   post.title # => 'hello world'
+    def init_with_resource(rdf_resource)
+      init_internals
+      @ldp_source = rdf_resource
+      load_attached_files
       run_callbacks :find
       run_callbacks :initialize
       self
@@ -70,93 +77,160 @@ module ActiveFedora
     def ==(comparison_object)
          comparison_object.equal?(self) ||
            (comparison_object.instance_of?(self.class) &&
-             comparison_object.pid == pid &&
+             comparison_object.id == id &&
              !comparison_object.new_record?)
     end
 
-    def clone
-      new_object = self.class.create
-      clone_into(new_object)
+    def freeze
+      @resource.freeze
+      #@attributes = @attributes.clone.freeze
+      attached_files.freeze
+      self
     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
+    def frozen?
+      attached_files.frozen?
+    end
 
-      datastreams.each do |k, v|
-        next if k == 'RELS-EXT'
-        new_object.datastreams[k].content = v.content
-      end
-      new_object if new_object.save
+    # Returns +true+ if the record is read only. Records loaded through joins with piggy-back
+    # attributes will be marked as read only since they cannot be saved.
+    def readonly?
+      @readonly
     end
 
-    def freeze
-      datastreams.freeze
-      self
+    # Marks this record as read only.
+    def readonly!
+      @readonly = true
     end
 
-    def frozen?
-      datastreams.frozen?
+    def to_uri(id)
+      self.class.id_to_uri(id)
     end
 
-    def pretty_pid
-      if self.pid == UnsavedDigitalObject::PLACEHOLDER
-        nil
-      else
-        self.pid
+    protected
+
+      # This can be overriden to assert a different model
+      # It's normally called once in the lifecycle, by #create#
+      def assert_content_model
+        self.has_model = self.class.to_s
       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"
+    module ClassMethods
+      def generated_association_methods
+        @generated_association_methods ||= begin
+          mod = const_set(:GeneratedAssociationMethods, Module.new)
+          include mod
+          mod
+        end
       end
-      klass.allocate.init_with_object(inner_object)
-    end
 
-    # Adapts the inner object to the best known model
-    # Raise ActiveFedora::ModelNotAsserted if unable to adapt object
-    # (i.e, best model is nil)
-    def adapt_to_cmodel
-      best_model_match = ActiveFedora::ContentModel.best_model_for(self)
+      # Returns a suitable uri object for :has_model
+      # Should reverse Model#from_class_uri
+      # TODO this is a poorly named method
+      def to_class_uri(attrs = {})
+        name
+      end
 
-      if best_model_match.nil?
-        raise ActiveFedora::ModelNotAsserted, "Unable to adapt #{self.inspect} to a model asserted for the resource."
+      ##
+      # Transforms an id into a uri
+      # if translate_id_to_uri is set it uses that proc, otherwise just the default
+      def id_to_uri(id)
+        if translate_id_to_uri
+          translate_id_to_uri.call(id)
+        else
+          id = "/#{id}" unless id.start_with? '/'
+          id = ActiveFedora.fedora.base_path + id unless id.start_with? "#{ActiveFedora.fedora.base_path}/"
+          ActiveFedora.fedora.host + id
+        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"
+      ##
+      # Transforms a uri into an id
+      # if translate_uri_to_id is set it uses that proc, otherwise just the default
+      def uri_to_id(uri)
+        if translate_uri_to_id
+          translate_uri_to_id.call(uri)
+        else
+          id = uri.to_s.sub(ActiveFedora.fedora.host + ActiveFedora.fedora.base_path, '')
+          id.start_with?('/') ? id[1..-1] : id
+        end
       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"
+
+      ##
+      # Provides the common interface for ActiveTriples::Identifiable
+      def from_uri(uri,_)
+        begin
+          self.find(uri_to_id(uri))
+        rescue ActiveFedora::ObjectNotFoundError, Ldp::Gone
+          ActiveTriples::Resource.new(uri)
+        end
       end
-      self.init_with_object DigitalObject.find(self.class,self.pid)
-    end
-    
-    module ClassMethods
+
       private
+
       def relation
         Relation.new(self)
       end
     end
+
+    private
+
+      def init_internals
+        @resource          = nil
+        @readonly          = false
+        @association_cache = {}
+      end
+
+      def conn
+        ActiveFedora.fedora.connection
+      end
+
+      def build_ldp_resource(id=nil)
+        if id
+          LdpResource.new(conn, to_uri(id))
+        else
+          LdpResource.new(conn, nil, nil, ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
+        end
+      end
+
+      def check_persistence
+        if destroyed?
+          raise ActiveFedora::ObjectNotFoundError, "Can't reload an object that has been destroyed"
+        else
+          raise ActiveFedora::ObjectNotFoundError, "Can't reload an object that hasn't been saved"
+        end
+      end
+
+      def initialize_resource_and_attributes attributes_or_resource_or_url
+        case attributes_or_resource_or_url
+          when String
+            @ldp_source = build_ldp_resource(attributes_or_resource_or_url)
+            @attributes = {}.with_indifferent_access
+          when Hash
+            attributes = attributes_or_resource_or_url
+
+            id = attributes.delete(:id)
+
+            # TODO: Remove when we decide using 'pid' is no longer supported.
+            if !id && attributes.has_key?(:pid)
+              Deprecation.warn Core, 'Initializing with :pid is deprecated and will be removed in active-fedora 10.0. Use :id instead'
+              id = attributes.delete(:pid)
+            end
+
+            attributes = attributes.with_indifferent_access if attributes
+            @ldp_source = if id
+              build_ldp_resource(id)
+            else
+              build_ldp_resource
+            end
+          when NilClass
+            @ldp_source = build_ldp_resource
+            attributes = {}.with_indifferent_access
+          else
+            raise ArgumentError, "#{attributes_or_resource_or_url.class} is not acceptable"
+        end
+        return attributes
+      end
+
   end
 end