active-fedora 7.0.0.rc1 → 7.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155ad613119b5eb0ce0333d32c7bb0fb67009847
-  data.tar.gz: d02a5f3a7617168e35a90ff28dec878ef8ec46cf
+  metadata.gz: 7a37149e295c1dc3110b4fc70371e8bb25f980a8
+  data.tar.gz: b66fcc86fa8132818a1b40e8b1e9f06588d5d2a4
 SHA512:
-  metadata.gz: 0ce6042eaaeca85fc1d000a6fdb593e8ef30cf7fd614e5f9a0a973fa5e33ff3b3a4c9d85ad02e2e9f4d5be3a7742d63f3634181842910aad93efb5d223557bbd
-  data.tar.gz: 798590c4f7b93fe8b3cde0149162806bf7f6da20cbac133bdf11eb17ef18fce5cb3004a149c68243e29e3600b3c6ff1fbca9ddf126af320b1c6da4be1ac25702
+  metadata.gz: 2c50f3f783e44031480f8f284e6bb3c18ec480e391785cfb000e03856b047bdc0d0aa45b481e30500a2f98b23a571e75b7922080edd4085f7abbb4d72675704a
+  data.tar.gz: 8b70aa1d294dc6768a4e9e25c2d39835d6a73ff0e2ec7cce6101ca314837c7c87c8bc6366f3f909eb70d3a5c87131de96bf35d585740d43988a505b1e030f655

data/lib/active_fedora/attributes.rb

@@ -40,6 +40,18 @@ module ActiveFedora
       array_setter(key, value)
     end
 
+    # @return [Boolean] true if there is an reader method and it returns a
+    # value different from the new_value.
+    def value_has_changed?(field, new_value)
+      new_value != array_reader(field)
+    end
+
+    def mark_as_changed(field)
+      self.send("#{field}_will_change!")
+    end
+
+
+
     protected
 
     # override activemodel so it doesn't trigger a load of all the attributes.
@@ -57,11 +69,8 @@ module ActiveFedora
         return association.id_reader if association
       end
       raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.defined_attributes.key?(field)
-      if args.present?
-        instance_exec(*args, &self.class.defined_attributes[field].reader)
-      else
-        instance_exec &self.class.defined_attributes[field].reader
-      end
+
+      self.class.defined_attributes[field].reader(self, *args)
     end
 
     def array_setter(field, args)
@@ -71,21 +80,7 @@ module ActiveFedora
         return association.id_writer(args) if association
       end
       raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.defined_attributes.key?(field)
-      instance_exec(args, &self.class.defined_attributes[field].writer)
-    end
-
-    # @return [Boolean] true if there is an reader method and it returns a
-    # value different from the new_value.
-    def value_has_changed?(field, new_value)
-      new_value != array_reader(field)
-    end
-
-    def mark_as_changed(field)
-      self.send("#{field}_will_change!")
-    end
-
-    def datastream_for_attribute(dsid)
-      datastreams[dsid] || raise(ArgumentError, "Undefined datastream id: `#{dsid}' in has_attributes")
+      self.class.defined_attributes[field].writer(self, args)
     end
 
     module ClassMethods

data/lib/active_fedora/datastream.rb

@@ -35,10 +35,6 @@ module ActiveFedora
       false
     end
 
-    def validate_content_present
-      has_content?
-    end
-    
     def save
       super
       self
@@ -49,6 +45,15 @@ module ActiveFedora
       self
     end
 
+    # Freeze datastreams such that they can be loaded from Fedora, but can't be changed
+    def freeze
+      @frozen = true
+    end
+
+    def frozen?
+      !!@frozen
+    end
+
     # serializes any changed data into the content field
     def serialize!
     end

data/lib/active_fedora/datastream_attribute.rb

@@ -2,7 +2,7 @@ module ActiveFedora
   # Represents the mapping between a model attribute and a field in a datastream
   class DatastreamAttribute
     
-    attr_accessor :dsid, :field, :datastream_class, :at, :reader, :writer, :multiple
+    attr_accessor :dsid, :field, :datastream_class, :at, :multiple
 
     def initialize(field, dsid, datastream_class, args={})
       self.field = field
@@ -10,9 +10,6 @@ module ActiveFedora
       self.datastream_class = datastream_class
       self.multiple = args[:multiple].nil? ? false : args[:multiple]
       self.at = args[:at]
-
-      initialize_reader!
-      initialize_writer!
     end
 
     # Gives the primary solr name for a column. If there is more than one indexer on the field definition, it gives the first 
@@ -33,48 +30,46 @@ module ActiveFedora
       end
     end
 
-    private
-
-    def initialize_writer!
-      this = self
-      self.writer = lambda do |v|
-        ds = datastream_for_attribute(this.dsid)
-        mark_as_changed(this.field) if value_has_changed?(this.field, v)
-        if ds.kind_of?(ActiveFedora::RDFDatastream)
-          ds.send("#{this.field}=", v)
-        else
-          terminology = this.at || [this.field]
-          ds.send(:update_indexed_attributes, {terminology => v})
-        end
+    def writer(obj, v)
+      ds = datastream_for_attribute(obj, dsid)
+      obj.mark_as_changed(field) if obj.value_has_changed?(field, v)
+      if ds.kind_of?(ActiveFedora::RDFDatastream)
+        ds.send("#{field}=", v)
+      else
+        terminology = at || [field]
+        ds.send(:update_indexed_attributes, {terminology => v})
       end
     end
 
-    def initialize_reader!
-      this = self
-      self.reader = lambda do |*opts|
-        if inner_object.is_a? SolrDigitalObject
-          begin
-            # Look in the cache
-            return inner_object.fetch(this.field)
-          rescue NoMethodError => e
-            # couldn't get it from solr, so try from fedora.
-            logger.info "Couldn't get #{this.field} out of solr, because #{e.message}. Trying another way."
-          end
+    def reader(obj, *opts)
+      if obj.inner_object.is_a? SolrDigitalObject
+        begin
+          # Look in the cache
+          return obj.inner_object.fetch(field)
+        rescue NoMethodError => e
+          # couldn't get it from solr, so try from fedora.
+          logger.info "Couldn't get #{field} out of solr, because #{e.message}. Trying another way."
         end
-        # Load from fedora
-        ds = datastream_for_attribute(this.dsid)
-        if ds.kind_of?(ActiveFedora::RDFDatastream)
-          ds.send(this.field)
+      end
+      # Load from fedora
+      ds = datastream_for_attribute(obj, dsid)
+      if ds.kind_of?(ActiveFedora::RDFDatastream)
+        ds.send(field)
+      else
+        terminology = at || [field]
+        if terminology.length == 1 && opts.present?
+          ds.send(terminology.first, *opts)
         else
-          terminology = this.at || [this.field]
-          if terminology.length == 1 && opts.present?
-            ds.send(terminology.first, *opts)
-          else
-            ds.send(:term_values, *terminology)
-          end
+          ds.send(:term_values, *terminology)
         end
       end
     end
 
+    private
+
+    def datastream_for_attribute(obj, dsid)
+      obj.datastreams[dsid] || raise(ArgumentError, "Undefined datastream id: `#{dsid}' in has_attributes")
+    end
+
   end
 end

data/lib/active_fedora/datastream_hash.rb

@@ -20,8 +20,8 @@ module ActiveFedora
     end 
 
     def freeze
-      each do |k, v|
-        v.freeze
+      each_value do |datastream|
+        datastream.freeze
       end
       super
     end

data/lib/active_fedora/datastreams.rb

@@ -2,6 +2,8 @@ module ActiveFedora
   module Datastreams
     extend ActiveSupport::Concern
 
+    autoload :NokogiriDatastreams,           'active_fedora/datastreams/nokogiri_datastreams'
+
     included do
       class_attribute :ds_specs
       self.ds_specs = {'RELS-EXT'=> {:type=> ActiveFedora::RelsExtDatastream, :label=>"Fedora Object-to-Object Relationship Metadata", :block=>nil}}
@@ -62,7 +64,7 @@ module ActiveFedora
     end
 
     def datastream_from_spec(ds_spec, name)
-      inner_object.datastream_object_for name, ds_spec
+      inner_object.datastream_object_for name, {}, ds_spec
     end
 
     def load_datastreams
@@ -197,23 +199,16 @@ module ActiveFedora
       # @option args [Boolean] :versionable Should versioned datastreams be stored
       # @yield block executed by some kinds of datastreams
       def has_metadata(*args, &block)
-
-        if args.first.is_a? String 
-          name = args.first
-          args = args[1] || {}
-          args[:name] = name
-        else
-          args = args.first
-        end
-        
-        
-        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}
-        name = args[:name]
-        raise ArgumentError, "You must provide a name (dsid) for the metadata datastream" unless name
-        raise ArgumentError, "You must provide a :type property for the metadata datastream '#{name}'" unless spec[:type]
-        spec[:versionable] = args[:versionable] if args.has_key? :versionable
-        build_datastream_accessor(name)
-        ds_specs[name]= spec
+        @metadata_ds_defaults ||= {
+          :autocreate => false,
+          :type=>nil,
+          :label=>"",
+          :control_group=>nil,
+          :disseminator=>"",
+          :url=>"",
+          :name=>nil
+        }
+        spec_datastream(args, @metadata_ds_defaults, &block)
       end
 
       
@@ -236,19 +231,14 @@ 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)
-        if args.first.is_a? String 
-          name = args.first
-          args = args[1] || {}
-          args[:name] = name
-        else
-          args = args.first || {}
-        end
-        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
-        name = args.fetch(:name, "content")
-        build_datastream_accessor(name)
-        ds_specs[name]= spec
+        @file_ds_defaults ||= {
+          :autocreate => false,
+          :type=>ActiveFedora::Datastream,
+          :label=>"File Datastream",
+          :control_group=>"M",
+          :name=>"content"
+        }
+        spec_datastream(args, @file_ds_defaults)
       end
 
       def build_datastream_accessor(dsid)
@@ -261,6 +251,28 @@ module ActiveFedora
 
       private
 
+      # Creates a datastream spec combining the given args and default values
+      # @param args [Array] either [String, Hash] or [Hash]; the latter must .has_key? :name
+      # @param defaults [Hash] the default values for the datastream spec
+      # @yield block executed by some kinds of datastreams
+      def spec_datastream(args, defaults, &block)
+        if args.first.is_a? String 
+          name = args.first
+          args = args[1] || {}
+          args[:name] = name
+        else
+          args = args.first || {}
+        end
+        spec = defaults.merge(args.select {|key, value| defaults.has_key? key})
+        name = spec.delete(:name)
+        raise ArgumentError, "You must provide a name (dsid) for the datastream" unless name
+        raise ArgumentError, "You must provide a :type property for the datastream '#{name}'" unless spec[:type]
+        spec[:versionable] = args[:versionable] if args.has_key? :versionable
+        spec[:block] = block if block
+        build_datastream_accessor(name)
+        ds_specs[name]= spec
+      end
+
         ## Given a dsid return a standard name
         def name_for_dsid(dsid)
           dsid.gsub('-', '_')

data/lib/active_fedora/datastreams/nokogiri_datastreams.rb

@@ -0,0 +1,146 @@
+module ActiveFedora
+  module Datastreams
+    module NokogiriDatastreams
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # Create an instance of this class based on xml content
+        # @param [String, File, Nokogiri::XML::Node] xml the xml content to build from
+        # @param [ActiveFedora::OmDatastream] tmpl the Datastream object that you are building @default a new instance of this class
+        # Careful! If you call this from a constructor, be sure to provide something 'ie. self' as the @tmpl. Otherwise, you will get an infinite loop!
+        def from_xml(xml, tmpl=nil)
+          tmpl = self.new if tmpl.nil?  ## This path is used only for unit testing (e.g. MarpaDCDatastream.from_xml(fixture("data.xml")) )
+
+          if !xml.present?
+            tmpl.ng_xml = self.xml_template
+          elsif xml.kind_of? Nokogiri::XML::Node || xml.kind_of?(Nokogiri::XML::Document)
+            tmpl.ng_xml = xml
+          else
+            tmpl.ng_xml = Nokogiri::XML::Document.parse(xml)
+          end
+
+          tmpl.ng_xml_doesnt_change!
+
+          return tmpl
+        end
+        
+        def xml_template
+          Nokogiri::XML::Document.parse("<xml/>")
+        end
+
+        def decorate_ng_xml(xml)
+          xml
+        end
+      end
+
+
+      def ng_xml 
+        @ng_xml ||= begin
+          if new?
+            ## Load up the template
+            xml = self.class.xml_template
+          else
+            xml = Nokogiri::XML::Document.parse(datastream_content)
+          end
+          self.class.decorate_ng_xml xml
+        end
+      end
+      
+      def ng_xml=(new_xml)
+        # before we set ng_xml, we load the datastream so we know if the new value differs.
+        local_or_remote_content(true)
+
+        case new_xml 
+        when Nokogiri::XML::Document
+          self.content=new_xml.to_xml
+        when  Nokogiri::XML::Node 
+          ## Cast a fragment to a document
+          self.content=new_xml.to_s
+        when String 
+          self.content=new_xml
+        else
+          raise TypeError, "You passed a #{new_xml.class} into the ng_xml of the #{self.dsid} datastream. OmDatastream.ng_xml= only accepts Nokogiri::XML::Document, Nokogiri::XML::Element, Nokogiri::XML::Node, or raw XML (String) as inputs."
+        end
+      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'
+      end
+
+      def datastream_content
+        @datastream_content ||= Nokogiri::XML(super).to_xml  {|config| config.no_declaration}.strip
+      end
+      
+      def content=(new_content)
+        if inline?
+          # inline datastreams may be transformed by fedora 3, so we test for equivalence instead of equality
+          if !EquivalentXml.equivalent?(datastream_content, new_content)
+            ng_xml_will_change! 
+            @ng_xml = Nokogiri::XML::Document.parse(new_content)
+            super(@ng_xml.to_s)
+          end
+        else
+          if datastream_content != new_content
+            ng_xml_will_change! 
+            @ng_xml = Nokogiri::XML::Document.parse(new_content)
+            super(@ng_xml.to_s)
+          end
+        end
+        self.class.decorate_ng_xml @ng_xml
+      end
+
+      def content_changed?
+        return false if !xml_loaded
+        super
+      end
+
+      def to_xml(xml = nil)
+        xml = self.ng_xml if xml.nil?
+        ng_xml = self.ng_xml
+        if ng_xml.respond_to?(:root) && ng_xml.root.nil? && self.class.respond_to?(:root_property_ref) && !self.class.root_property_ref.nil?
+          ng_xml = self.class.generate(self.class.root_property_ref, "")
+          if xml.root.nil?
+            xml = ng_xml
+          end
+        end
+
+        unless xml == ng_xml || ng_xml.root.nil?
+          if xml.kind_of?(Nokogiri::XML::Document)
+              xml.root.add_child(ng_xml.root)
+          elsif xml.kind_of?(Nokogiri::XML::Node)
+              xml.add_child(ng_xml.root)
+          else
+              raise "You can only pass instances of Nokogiri::XML::Node into this method.  You passed in #{xml}"
+          end
+        end
+        
+        return xml.to_xml {|config| config.no_declaration}.strip
+      end
+
+      def local_or_remote_content(ensure_fetch = true)
+        @content = to_xml if ng_xml_changed? || autocreate?
+        super
+      end
+
+      def autocreate?
+        changed_attributes.has_key? :profile
+      end
+
+      def xml_loaded
+        instance_variable_defined? :@ng_xml
+      end
+    
+    end
+  end
+end