active-fedora 5.0.0 → 5.1.0

data/History.txt

@@ -1,7 +1,20 @@
 5.0.0
 Depend on solrizer 2.0.0 (for HYDRA-827 DO NOT index terms by default)
 Lazily initialize solr, so that the message goes into the log, not the console
-
+Depend on om 1.8.0
+Require Ruby >= 1.9.3
+Support for ISO 8601 date formats
+New before_delete callback available on ActiveFedora objects
+HYDRA-883: RDFDatastreams should handle Literals as object values
+Zero argument constructors for datastreams
+Deprecated in this version:
+  * FileManagment
+  * named relationships
+Removed in this version:
+  * ruby-fedora
+  * MetadataDatastream
+  * methods: .field, .add, .to_xml, .file_streams, .new_object=
+  # rcov dependency
 
 4.5.1
 Removes .rvmrc and Gemfile.lock from version control (devs should deal with these themselves)

data/README.textile

@@ -17,6 +17,12 @@ h2. Getting Started
 
 The "ActiveFedora Console Tour":https://github.com/projecthydra/active_fedora/wiki/Getting-Started:-Console-Tour  gives you a brief tour through ActiveFedora's features on the command line.
 
+h2. Generators
+
+You can generate a model inheriting from ActiveFedora::Base.
+
+<pre>rails generate active_fedora:model Book</pre>
+
 h2. Testing (this Gem)
 
 In order to run the RSpec tests, you need to have a copy of the ActiveFedora source code, and then run bundle install in the source directory.

data/active-fedora.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency("activesupport", '>= 3.0.0')
   s.add_dependency("builder", '~> 3.0.0')
   s.add_dependency("mediashelf-loggable")
-  s.add_dependency("rubydora", '~>0.5.13')
+  s.add_dependency("rubydora", '~>0.8.0')
   s.add_dependency("rdf")
   s.add_dependency("rdf-rdfxml", '~>0.3.8')
   s.add_dependency("deprecation")

data/lib/active_fedora.rb

@@ -19,6 +19,7 @@ module ActiveFedora #:nodoc:
   class ConfigurationError < RuntimeError; end # :nodoc:
   class AssociationTypeMismatch < RuntimeError; end # :nodoc:
   class UnregisteredPredicateError < RuntimeError; end # :nodoc:
+  class RecordNotSaved < RuntimeError; end # :nodoc:
 
 
   eager_autoload do
@@ -153,3 +154,4 @@ end
 load File.join(File.dirname(__FILE__),"tasks/active_fedora.rake") if defined?(Rake)
 I18n.load_path << File.dirname(__FILE__) + '/active_fedora/locale/en.yml'
 
+require 'active_fedora/railtie' if defined?(Rails)

data/lib/active_fedora/associations.rb

@@ -77,8 +77,8 @@ module ActiveFedora
         reflection = create_belongs_to_reflection(association_id, options)
 
         association_accessor_methods(reflection, BelongsToAssociation)
-          # association_constructor_method(:build,  reflection, BelongsToAssociation)
-          # association_constructor_method(:create, reflection, BelongsToAssociation)
+        association_constructor_method(:build,  reflection, BelongsToAssociation)
+        association_constructor_method(:create, reflection, BelongsToAssociation)
         #configure_dependency_for_belongs_to(reflection)
       end
 
@@ -157,6 +157,7 @@ module ActiveFedora
 
         def create_has_many_reflection(association_id, options)
           create_reflection(:has_many, association_id, options, self)
+          #collection_accessor_methods(reflection, HasManyAssociation)
         end
 
         def create_belongs_to_reflection(association_id, options)
@@ -266,6 +267,25 @@ module ActiveFedora
             end
           end
         end
+
+        def association_constructor_method(constructor, reflection, association_proxy_class)
+          redefine_method("#{constructor}_#{reflection.name}") do |*params|
+            attributees      = params.first unless params.empty?
+            replace_existing = params[1].nil? ? true : params[1]
+            association      = association_instance_get(reflection.name)
+
+            unless association
+              association = association_proxy_class.new(self, reflection)
+              association_instance_set(reflection.name, association)
+            end
+
+            # if association_proxy_class == HasOneAssociation
+            #   association.send(constructor, attributees, replace_existing)
+            # else
+            association.send(constructor, attributees)
+            #end
+          end
+        end
     end
   end
 end

data/lib/active_fedora/associations/association_collection.rb

@@ -97,6 +97,24 @@ module ActiveFedora
           _records.each { |record| @target.delete(record) }
         end
       end
+
+      def create(attrs = {})
+        if attrs.is_a?(Array)
+          attrs.collect { |attr| create(attr) }
+        else
+          create_record(attrs) do |record|
+            yield(record) if block_given?
+            record.save
+          end
+        end
+      end
+
+      def create!(attrs = {})
+        create_record(attrs) do |record|
+          yield(record) if block_given?
+          record.save!
+        end
+      end
       
 
       def load_target
@@ -167,6 +185,19 @@ module ActiveFedora
 
 
       private 
+        def create_record(attrs)
+          attrs.update(@reflection.options[:conditions]) if @reflection.options[:conditions].is_a?(Hash)
+          ensure_owner_is_not_new
+          record = @reflection.klass.create do
+            @reflection.build_association(attrs)
+          end
+          set_belongs_to_association_for(record)
+          if block_given?
+            add_record_to_target_with_callbacks(record) { |*block_args| yield(*block_args) }
+          else
+            add_record_to_target_with_callbacks(record)
+          end
+        end
 
         def build_record(attrs)
           #attrs.update(@reflection.options[:conditions]) if @reflection.options[:conditions].is_a?(Hash)
@@ -187,6 +218,12 @@ module ActiveFedora
           yield(records, old_records)
           #records.each { |record| callback(:after_remove, record) }
         end
+
+        def ensure_owner_is_not_new
+          if @owner.new_record?
+            raise ActiveFedora::RecordNotSaved, "You cannot call create unless the parent is saved"
+          end
+        end
       
     end
   end

data/lib/active_fedora/associations/belongs_to_association.rb

@@ -2,6 +2,14 @@ module ActiveFedora
   module Associations
     class BelongsToAssociation < AssociationProxy #:nodoc:
 
+      def create(attributes = {})
+        replace(@reflection.create_association(attributes))
+      end
+
+      def build(attributes = {})
+        replace(@reflection.build_association(attributes))
+      end
+
       def replace(record)
         if record.nil?
           @owner.clear_relationship(@reflection.options[:property])

data/lib/active_fedora/associations/has_many_association.rb

@@ -44,6 +44,8 @@ module ActiveFedora
             r.remove_relationship(@reflection.options[:property], @owner)
           end
         end
+
+        
     end
   end
 end

data/lib/active_fedora/base.rb

@@ -42,6 +42,10 @@ module ActiveFedora
       end
     end
 
+    def new?
+      new_object?
+    end
+
     # Has this object been saved?
     def new_object?
       inner_object.new?
@@ -73,6 +77,10 @@ module ActiveFedora
       run_callbacks :initialize
     end
 
+    # Reloads the object from Fedora.
+    def reload
+      init_with(self.class.find(self.pid).inner_object)
+    end
 
     # Initialize an empty model object and set the +inner_obj+
     # example:
@@ -91,7 +99,7 @@ module ActiveFedora
         ## 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].changed.include?('content') && @inner_object.datastreams[key].class != self.class.ds_specs[key][:type]
+          if !@inner_object.datastreams[key].content_changed? && @inner_object.datastreams[key].class != self.class.ds_specs[key][:type]
             @inner_object.datastreams.delete(key)
           end
         end
@@ -137,10 +145,37 @@ module ActiveFedora
       ds_specs[dsid] ? ds_specs[dsid].fetch(:type, ActiveFedora::Datastream) : ActiveFedora::Datastream
     end
 
-    def self.create(args = {})
-      obj = self.new(args)
-      obj.save
-      obj
+    # Creates an object (or multiple objects) and saves it to the repository, if validations pass.
+    # The resulting object is returned whether the object was saved successfully to the repository or not.
+    #
+    # The +attributes+ parameter can be either be a Hash or an Array of Hashes.  These Hashes describe the
+    # attributes on the objects that are to be created.
+    #
+    # ==== Examples
+    #   # Create a single new object
+    #   User.create(:first_name => 'Jamie')
+    #
+    #   # Create an Array of new objects
+    #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
+    #
+    #   # Create a single object and pass it into a block to set other attributes.
+    #   User.create(:first_name => 'Jamie') do |u|
+    #     u.is_admin = false
+    #   end
+    #
+    #   # Creating an Array of new objects using a block, where the block is executed for each object:
+    #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
+    #     u.is_admin = false
+    #   end
+    def self.create(attributes = nil, &block)
+      if attributes.is_a?(Array)
+        attributes.collect { |attr| create(attr, &block) }
+      else
+        object = new(attributes)
+        yield(object) if block_given?
+        object.save
+        object
+      end
     end
 
     def clone
@@ -248,7 +283,9 @@ module ActiveFedora
              comparison_object.pid == pid &&
              !comparison_object.new_record?)
     end
-  
+
+
+
     def inspect
       "#<#{self.class}:#{self.hash} @pid=\"#{pid}\" >"
     end

data/lib/active_fedora/datastream.rb

@@ -2,32 +2,18 @@ module ActiveFedora
 
   #This class represents a Fedora datastream
   class Datastream < Rubydora::Datastream
-    
+    extend Deprecation
     attr_writer :digital_object
     attr_accessor :last_modified, :fields
-    before_create :add_mime_type, :add_ds_location, :validate_content_present
   
     def initialize(digital_object=nil, dsid=nil, options={})
       ## When you use the versions feature of rubydora (0.5.x), you need to have a 3 argument constructor
       self.fields={}
       super
     end
-    
-    def size
-      self.profile['dsSize']
-    end
-
-    def add_mime_type
-      self.mimeType = 'text/xml' unless self.mimeType
-    end
-
-    def add_ds_location
-      if self.controlGroup == 'E'
-      end
-    end
 
     def inspect
-      "#<#{self.class}:#{self.hash} @pid=\"#{digital_object ? pid : nil}\" @dsid=\"#{dsid}\" @controlGroup=\"#{controlGroup}\" @dirty=\"#{dirty}\" @mimeType=\"#{mimeType}\" >"
+      "#<#{self.class}:#{self.hash} @pid=\"#{digital_object ? pid : nil}\" @dsid=\"#{dsid}\" @controlGroup=\"#{controlGroup}\" changed=\"#{changed?}\" @mimeType=\"#{mimeType}\" >"
     end
 
     #compatibility method for rails' url generators. This method will 
@@ -42,6 +28,7 @@ module ActiveFedora
     def dirty?
       changed?
     end
+    deprecation_deprecate :dirty?
     
     # @abstract Override this in your concrete datastream class. 
     # @return [boolean] does this datastream contain metadata (not file data)
@@ -53,49 +40,37 @@ module ActiveFedora
     def dirty
       changed?
     end
+    deprecation_deprecate :dirty
     
     # Deprecated
     def dirty=(value)
       if value
-        lastModifiedDate_will_change! # an innocent hack to pretend something has changed
+        content_will_change! # an innocent hack to pretend something has changed
       else
         changed_attributes.clear
       end
     end
+    deprecation_deprecate :dirty=
 
     def new_object?
       new?
     end
+    deprecation_deprecate :new_object?
 
     def validate_content_present
-      case controlGroup
-      when 'X','M'
-        @content.present?
-      when 'E','R'
-        dsLocation.present?
-      else
-        raise "Invalid control group: #{controlGroup.inspect}"
-      end      
+      has_content?
     end
     
     def save
-      run_callbacks :save do
-        return create if new?
-        repository.modify_datastream to_api_params.merge({ :pid => pid, :dsid => dsid })
-        reset_profile_attributes
-        self
-      end
+      super
+      self
     end
 
     def create
-      run_callbacks :create do
-        repository.add_datastream to_api_params.merge({ :pid => pid, :dsid => dsid })
-        reset_profile_attributes
-        self
-      end
+      super
+      self
     end
 
-
     # serializes any changed data into the content field
     def serialize!
     end
@@ -103,6 +78,7 @@ module ActiveFedora
     # @param [ActiveFedora::Datastream] tmpl the Datastream object that you are building
     # @param [Nokogiri::XML::Node] node the "foxml:datastream" node from a FOXML file
     def self.from_xml(tmpl, node)
+      Deprecation.deprecated_method_warning(self, :from_xml)
       tmpl.controlGroup= node['CONTROL_GROUP']
       tmpl
     end

data/lib/active_fedora/datastreams.rb

@@ -21,10 +21,6 @@ module ActiveFedora
 
     def serialize_datastreams
       datastreams.each {|k, ds| ds.serialize! }
-      self.metadata_is_dirty = datastreams.any? do |k,ds| 
-        ds.changed? && ds.metadata?
-      end
-      true
     end
 
     # Adds the disseminator location to the datastream after the pid has been established
@@ -225,7 +221,7 @@ module ActiveFedora
       # @option args [Boolean] :versionable Should versioned datastreams be stored
       # @yield block executed by some kinds of datastreams
       def has_metadata(args, &block)
-        spec = {:autocreate => args.fetch(:autocreate, true), :type => args[:type], :label =>  args.fetch(:label,""), :control_group => args[:control_group], :disseminator => args.fetch(:disseminator,""), :url => args.fetch(:url,""),:block => block}
+        spec = {:autocreate => args.fetch(:autocreate, false), :type => args[:type], :label =>  args.fetch(:label,""), :control_group => args[:control_group], :disseminator => args.fetch(:disseminator,""), :url => args.fetch(:url,""),:block => block}
         spec[:versionable] = args[:versionable] if args.has_key? :versionable
         ds_specs[args[:name]]= spec
       end
@@ -240,7 +236,7 @@ module ActiveFedora
       # @option args [Boolean] :autocreate Always create this datastream on new objects
       # @option args [Boolean] :versionable Should versioned datastreams be stored
       def has_file_datastream(args = {})
-        spec = {:autocreate => args.fetch(:autocreate, true), :type => args.fetch(:type,ActiveFedora::Datastream),
+        spec = {:autocreate => args.fetch(:autocreate, false), :type => args.fetch(:type,ActiveFedora::Datastream),
                 :label =>  args.fetch(:label,"File Datastream"), :control_group => args.fetch(:control_group,"M")}
         spec[:versionable] = args[:versionable] if args.has_key? :versionable
         ds_specs[args.fetch(:name, "content")]= spec

data/lib/active_fedora/digital_object.rb

@@ -33,9 +33,16 @@ module ActiveFedora
     def self.find(original_class, pid)
       conn = original_class.connection_for_pid(pid)
       obj = Deprecation.silence(Rubydora::DigitalObject) do
-        super(pid, conn)
+        begin
+          super(pid, conn)
+        rescue Rubydora::FedoraInvalidRequest => e
+          # PID is nil
+          raise ActiveFedora::ObjectNotFoundError, "Unable to find '#{pid}' in fedora. See logger for details."
+        end
       end
       obj.original_class = original_class
+      # PID is not found, but was "well-formed" for its Fedora request. So
+      # an object is instantiated with that PID.
       raise ActiveFedora::ObjectNotFoundError, "Unable to find '#{pid}' in fedora" if obj.new?
       obj
     end

data/lib/active_fedora/metadata_datastream_helper.rb

@@ -30,8 +30,8 @@ module ActiveFedora::MetadataDatastreamHelper
   end
   
   def serialize! # :nodoc:
-    if dirty?
-      return unless xml_loaded 
+    if changed?
+      return unless xml_loaded or new?
       self.content = self.to_xml 
     end
   end

data/lib/active_fedora/nokogiri_datastream.rb

@@ -6,14 +6,18 @@ require "solrizer/xml"
 module ActiveFedora
   class NokogiriDatastream < Datastream
       
-    include MetadataDatastreamHelper
+    before_save do
+      return unless xml_loaded
+      content_will_change! if ng_xml_changed?
+    end  
+
     include OM::XML::Document
     include Solrizer::XML::TerminologyBasedSolrizer # this adds support for calling .to_solr
     
     alias_method(:om_term_values, :term_values) unless method_defined?(:om_term_values)
     alias_method(:om_update_values, :update_values) unless method_defined?(:om_update_values)
     
-    attr_accessor :internal_solr_doc
+    attr_accessor :internal_solr_doc, :xml_loaded
 
     def self.default_attributes
       super.merge(:controlGroup => 'X', :mimeType => 'text/xml')
@@ -32,8 +36,10 @@ module ActiveFedora
         tmpl.ng_xml = xml
       else
         tmpl.ng_xml = Nokogiri::XML::Document.parse(xml)
-      end    
-      tmpl.send(:dirty=, false)
+      end
+
+      tmpl.ng_xml_doesnt_change!
+
       return tmpl
     end
     
@@ -49,34 +55,59 @@ module ActiveFedora
         ## Load up the template
         self.class.xml_template
       else
-        Nokogiri::XML::Document.parse(content)
+        Nokogiri::XML::Document.parse(datastream_content)
       end
       end
     end
     
     def ng_xml=(new_xml)
-      ng_xml_will_change!
-      self.xml_loaded=true
-      case new_xml 
+
+      nokogiri_document = case new_xml 
       when Nokogiri::XML::Document
-        @ng_xml = new_xml
+        new_xml
       when  Nokogiri::XML::Node 
-        @ng_xml = Nokogiri::XML(new_xml.to_s) ## Cast a fragment to a document
+        Nokogiri::XML(new_xml.to_s) ## Cast a fragment to a document
       when String 
-        @ng_xml = Nokogiri::XML::Document.parse(new_xml)
+        Nokogiri::XML::Document.parse(new_xml)
       else
         raise TypeError, "You passed a #{new_xml.class} into the ng_xml of the #{self.dsid} datastream. NokogiriDatastream.ng_xml= only accepts Nokogiri::XML::Document, Nokogiri::XML::Element, Nokogiri::XML::Node, or raw XML (String) as inputs."
       end
+
+
+      new_xml_string = nokogiri_document.to_xml {|config| config.no_declaration}
+
+      ng_xml_will_change! unless (xml_loaded && (new_xml_string.to_s.strip == datastream_content.strip))
+      self.xml_loaded=true
+
+      @ng_xml = nokogiri_document
+
     end
     
     # don't want content eagerly loaded by proxy, so implementing methods that would be implemented by define_attribute_methods 
     def ng_xml_will_change!
       changed_attributes['ng_xml'] = nil
     end
+
+    def ng_xml_doesnt_change!
+      changed_attributes.delete('ng_xml')
+    end
     
     # don't want content eagerly loaded by proxy, so implementing methods that would be implemented by define_attribute_methods 
     def ng_xml_changed?
-      changed_attributes.has_key? 'ng_xml'
+      changed_attributes.has_key? 'ng_xml' ||
+       (xml_loaded && (to_xml != datastream_content) )
+    end
+
+    def changed?
+     ng_xml_changed? || super
+    end
+
+    def content_changed?
+      ng_xml_changed? || super
+    end
+
+    def has_content?
+      xml_loaded || super
     end
 
     # Indicates that this datastream has metadata content. 
@@ -84,13 +115,21 @@ module ActiveFedora
     def metadata?
       true
     end
-    
+
     def content=(content)
-      super
+      content_will_change! unless (xml_loaded && (content == datastream_content))
+      @content = content
       self.xml_loaded=true
-      @ng_xml = Nokogiri::XML::Document.parse(content)
+      self.ng_xml = Nokogiri::XML::Document.parse(datastream_content)
+    end
+
+    alias :datastream_content :content
+
+    def content
+      return to_xml if xml_loaded or new?
+      
+      datastream_content
     end
-    
     
     def to_xml(xml = nil)
       xml = self.ng_xml if xml.nil?