active-fedora 3.1.6 → 3.2.0.pre1

data/.gitignore

@@ -26,6 +26,7 @@ pkg
 #/.rvmrc
 .yardoc
 doc
+tmp
 
 ## PROJECT::SPECIFIC
 hydra-jetty

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    active-fedora (3.1.6)
-      activeresource (~> 3.0.0)
-      activesupport (~> 3.0.0)
+    active-fedora (3.2.0.pre1)
+      activeresource (>= 3.0.0)
+      activesupport (>= 3.0.0)
       equivalent-xml
       facets
       mediashelf-loggable
@@ -13,7 +13,7 @@ PATH
       om (>= 1.4.4)
       rdf
       rdf-rdfxml
-      rubydora (~> 0.2.6)
+      rubydora (~> 0.3.0)
       solr-ruby (>= 0.0.6)
       solrizer (> 1.0.0)
       xml-simple (>= 1.0.12)
@@ -22,23 +22,24 @@ GEM
   remote: http://rubygems.org/
   specs:
     RedCloth (4.2.9)
-    activemodel (3.0.11)
-      activesupport (= 3.0.11)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activeresource (3.0.11)
-      activemodel (= 3.0.11)
-      activesupport (= 3.0.11)
-    activesupport (3.0.11)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
     addressable (2.2.6)
     akami (1.0.0)
       gyoku (>= 0.4.0)
     archive-tar-minitar (0.5.2)
-    builder (2.1.2)
+    builder (3.0.0)
     childprocess (0.2.3)
       ffi (~> 1.0.6)
-    columnize (0.3.5)
-    daemons (1.1.4)
+    columnize (0.3.6)
+    daemons (1.1.5)
     diff-lcs (1.1.3)
     equivalent-xml (0.2.8)
       nokogiri (>= 1.4.3)
@@ -49,7 +50,7 @@ GEM
       builder (>= 2.1.2)
     httpi (0.9.5)
       rack
-    i18n (0.5.0)
+    i18n (0.6.0)
     jettywrapper (1.2.0)
       activesupport (>= 3.0.0)
       childprocess
@@ -66,6 +67,7 @@ GEM
     mime-types (1.17.2)
     mocha (0.10.0)
       metaclass (~> 0.0.1)
+    multi_json (1.0.4)
     multipart-post (1.1.2)
     nokogiri (1.5.0)
     nori (1.0.2)
@@ -108,7 +110,7 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
-    rubydora (0.2.6)
+    rubydora (0.3.0)
       activemodel
       activesupport
       fastercsv
@@ -132,15 +134,13 @@ GEM
       om (>= 1.4.0)
       stomp
       xml-simple
-    solrizer-fedora (1.2.1)
-      active-fedora (~> 3.1.0)
-      activesupport
+    solrizer-fedora (1.1.3)
+      active-fedora (>= 2.3.0)
       fastercsv
-      jettywrapper (>= 1.1.0)
       rsolr
       solr-ruby (>= 0.0.6)
       solrizer (>= 1.0.0)
-    stomp (1.1.10)
+    stomp (1.2.0)
     wasabi (2.0.0)
       nokogiri (>= 1.4.0)
     xml-simple (1.1.1)

data/History.txt

@@ -1,6 +1,12 @@
-3.1.6
-
-HYDRA-733 When serializing, MetadataDatastream does not load the existing content, so it can overwrite with blank
+3.2.0
+
+Don't create pids until save
+inspect and equality methods
+Deprecate datastream_collections
+Rails 3.1 compatibility
+Disseminators have been added
+Adapt To
+ActiveFedora::Relationship is deprecated
 
 3.1.5
 HYDRA-722 updating AF::Base#label= and then saving doesn't persist the change

data/active-fedora.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |s|
   s.add_dependency('nokogiri')
   s.add_dependency('om', '>= 1.4.4')
   s.add_dependency('solrizer', '>1.0.0')
-  s.add_dependency("activeresource", '~> 3.0.0')
-  s.add_dependency("activesupport", '~> 3.0.0')
+  s.add_dependency("activeresource", '>= 3.0.0')
+  s.add_dependency("activesupport", '>= 3.0.0')
   s.add_dependency("mediashelf-loggable")
   s.add_dependency("equivalent-xml")
   s.add_dependency("facets")
-  s.add_dependency("rubydora", '~>0.2.6')
+  s.add_dependency("rubydora", '~>0.3.0')
   s.add_dependency("rdf")
   s.add_dependency("rdf-rdfxml")
   s.add_development_dependency("yard")

data/config/predicate_mappings.yml

@@ -41,5 +41,6 @@
     :is_topic_of: isTopicOf
   info:fedora/fedora-system:def/model#:
     :has_model: hasModel
+    :has_service: hasService
   http://www.openarchives.org/OAI/2.0/: 
     :oai_item_id: itemID

data/config/service_mappings.yml

@@ -0,0 +1,9 @@
+:service_mapping:
+ "fedora-system:3":
+   :object_profile: viewObjectProfile
+   :method_index: viewMethodIndex
+   :item_index: viewItemIndex
+   :dc_view: viewDublinCore
+ "test:12":
+   :document_style_1: getDocumentStyle1
+   :document_style_2: getDocumentStyle2

data/lib/active_fedora.rb

@@ -3,6 +3,7 @@ require 'active_fedora/railtie' if defined? Rails
 require 'active_support'
 require 'active_fedora/solr_service'
 require 'active_fedora/rubydora_connection'
+require 'active_support/core_ext/class/attribute'
 
 SOLR_DOCUMENT_ID = ActiveFedora::SolrService.id_field unless defined?(SOLR_DOCUMENT_ID)
 ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
@@ -16,11 +17,13 @@ module ActiveFedora #:nodoc:
     autoload :Base
     autoload :ContentModel
     autoload :Reflection
-    autoload :Relationship
+    #autoload :Relationship
+    autoload :RelationshipGraph
     autoload :RelationshipsHelper
     autoload :Datastream
     autoload :Delegating
     autoload :DigitalObject
+    autoload :UnsavedDigitalObject
     autoload :Model
     autoload :MetadataDatastream
     autoload :MetadataDatastreamHelper
@@ -29,10 +32,13 @@ module ActiveFedora #:nodoc:
     autoload :QualifiedDublinCoreDatastream
     autoload :RelsExtDatastream
     autoload :RelationshipsHelper
+    autoload :ServiceDefinitions
     autoload :SemanticNode
     autoload :NestedAttributes
     autoload :FixtureLoader
     autoload :DatastreamCollections
+    autoload :NamedRelationships
+    autoload :Predicates
 
   end
   

data/lib/active_fedora/base.rb

@@ -3,7 +3,7 @@ require 'nokogiri'
 require "loggable"
 require 'active_fedora/datastream_hash'
 
-require 'active_support/core_ext/class/inheritable_attributes'
+
 SOLR_DOCUMENT_ID = "id" unless (defined?(SOLR_DOCUMENT_ID) && !SOLR_DOCUMENT_ID.nil?)
 ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
 
@@ -32,7 +32,14 @@ module ActiveFedora
   class Base
     include RelationshipsHelper
     include SemanticNode
-    class_inheritable_accessor  :ds_specs
+
+    class_attribute  :ds_specs
+    
+   def self.inherited(p)
+      # each subclass should get a copy of the parent's datastream definitions, it should not add to the parent's definition table.
+      p.ds_specs = p.ds_specs.dup
+      super
+    end
     
     self.ds_specs = {'RELS-EXT'=> {:type=> ActiveFedora::RelsExtDatastream, :label=>"", :block=>nil}}
 
@@ -77,22 +84,19 @@ module ActiveFedora
     # we configure any defined datastreams.
     def initialize(attrs = nil)
       attrs = {} if attrs.nil?
-      unless attrs[:pid]
-        if attrs[:namespace]
-          attrs = attrs.merge!({:pid=>RubydoraConnection.instance.nextid({:namespace=>attrs[:namespace]})})
+      attributes = attrs.dup
+      @inner_object = attributes.delete(:inner_object)
+      unless @inner_object
+        if attributes[:pid]
+          @inner_object = DigitalObject.find(self.class, attributes[:pid])
         else
-          attrs = attrs.merge!({:pid=>RubydoraConnection.instance.nextid})  
+          @inner_object = UnsavedDigitalObject.new(self.class, attributes.delete(:namespace))
+          self.relationships_loaded = true
         end
-        self.relationships_loaded = true
-        @inner_object = DigitalObject.find(self.class, attrs[:pid])
-      else
-        @inner_object = DigitalObject.find(self.class, attrs[:pid])
-        load_datastreams_from_fedora
       end
-      configure_defined_datastreams
+      load_datastreams
 
-      attributes = attrs.dup
-      [:pid, :namespace, :new_object,:create_date, :modified_date].each { |k| attributes.delete(k)}
+      [:pid, :new_object,:create_date, :modified_date].each { |k| attributes.delete(k)}
       self.attributes=attributes
     end
 
@@ -108,6 +112,16 @@ module ActiveFedora
       ds_specs[args[:name]]= {:type => args[:type], :label =>  args.fetch(:label,""), :control_group => args.fetch(:control_group,"X"), :disseminator => args.fetch(:disseminator,""), :url => args.fetch(:url,""),:block => block}
     end
 
+    def self.method_missing (name, args)
+      if name == :has_datastream
+        ActiveSupport::Deprecation.warn("Deprecation: DatastreamCollections will not be included by default in the next version.   To use has_datastream add 'include ActiveFedora::DatastreamCollections' to your model")
+        include DatastreamCollections
+        has_datastream(args)
+      else 
+        super
+      end
+
+    end
 
     def method_missing(name, *args)
       dsid = corresponding_datastream_name(name)
@@ -142,7 +156,7 @@ module ActiveFedora
         result = update
       end
       self.update_index if @metadata_is_dirty == true && ENABLE_SOLR_UPDATES
-      @metadata_is_dirty == false
+      @metadata_is_dirty = false
       return result
     end
 
@@ -170,6 +184,7 @@ module ActiveFedora
       end
       
       #Fedora::Repository.instance.delete(@inner_object)
+      pid = self.pid ## cache so it's still available after delete
       begin
         @inner_object.delete
       rescue RestClient::ResourceNotFound =>e
@@ -202,21 +217,38 @@ module ActiveFedora
       datastreams
     end
 
-    def load_datastreams_from_fedora
-      inner_object.datastreams.each do |dsid, datastream|
-        ds_spec = self.class.ds_specs[dsid]
-        datastreams[dsid] = datastream
-        if (ds_spec)
-          klass = ds_spec[:type]
-          datastreams[dsid].model = self if klass == RelsExtDatastream
-
-          if ds_spec[:block].class == Proc
-            ds_spec[:block].call(datastreams[dsid])
-          end
+    def configure_datastream(ds, ds_spec=nil)
+      ds_spec ||= self.class.ds_specs[ds.instance_variable_get(:@dsid)]
+      if ds_spec
+        ds.model = self if ds_spec[:type] == RelsExtDatastream
+        # If you called has_metadata with a block, pass the block into the Datastream class
+        if ds_spec[:block].class == Proc
+          ds_spec[:block].call(ds)
         end
       end
     end
 
+    def datastream_from_spec(ds_spec, name)
+      ds = ds_spec[:type].new(inner_object, name)
+      ds.dsLabel = ds_spec[:label] if ds_spec[:label].present?
+      ds.controlGroup = ds_spec[:control_group]
+      additional_attributes_for_external_and_redirect_control_groups(ds, ds_spec)
+      ds
+    end
+
+    def load_datastreams
+      ds_specs = self.class.ds_specs.dup
+      inner_object.datastreams.each do |dsid, ds|
+        self.add_datastream(ds)
+        configure_datastream(datastreams[dsid])
+        ds_specs.delete(dsid)
+      end
+      ds_specs.each do |name,ds_spec|
+        ds = datastream_from_spec(ds_spec, name)
+        self.add_datastream(ds)
+        configure_datastream(ds, ds_spec)
+      end
+    end      
 
     # Adds datastream to the object.  Saves the datastream to fedora upon adding.
     # If datastream does not have a DSID, a unique DSID is generated
@@ -241,7 +273,7 @@ module ActiveFedora
       results = []
       datastreams.each_value do |ds|
         if ds.kind_of?(ActiveFedora::MetadataDatastream) || ds.kind_of?(ActiveFedora::NokogiriDatastream)
-          results<<ds
+          results << ds
         end
       end
       return results
@@ -255,7 +287,7 @@ module ActiveFedora
         if !ds.kind_of?(ActiveFedora::MetadataDatastream) 
           dsid = ds.dsid
           if dsid != "DC" && dsid != "RELS-EXT"
-            results<<ds
+            results << ds
           end
         end
       end
@@ -426,7 +458,7 @@ module ActiveFedora
     # 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
-      @pid ||= @inner_object.pid
+       @inner_object.pid
 #      @inner_object ?  @inner_object.pid : @pid
     end
 
@@ -517,6 +549,17 @@ module ActiveFedora
       return xml.to_s
     end
 
+    def ==(comparison_object)
+         comparison_object.equal?(self) ||
+           (comparison_object.instance_of?(self.class) &&
+             comparison_object.pid == pid &&
+             !comparison_object.new_record?)
+    end
+  
+    def inspect
+      "#<#{self.class}:#{self.hash} @pid=\"#{pid}\" >"
+    end
+
     # Return a Hash representation of this object where keys in the hash are appropriate Solr field names.
     # @param [Hash] solr_doc (optional) Hash to insert the fields into
     # @param [Hash] opts (optional) 
@@ -551,6 +594,15 @@ module ActiveFedora
     end
 
     
+    # ** EXPERIMENTAL **
+    # 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.new({:inner_object=>inner_object})
+    end
     # ** EXPERIMENTAL **
     #
     # This method can be used instead of ActiveFedora::Model::ClassMethods.load_instance.  
@@ -734,6 +786,7 @@ module ActiveFedora
     
     # Deals with preparing new object to be saved to Fedora, then pushes it and its datastreams into Fedora. 
     def create
+      @inner_object = @inner_object.save #replace the unsaved digital object with a saved digital object
       assert_content_model
       @metadata_is_dirty = true
       update
@@ -767,7 +820,8 @@ module ActiveFedora
     include Associations
     include NestedAttributes
     include Reflection
-    include DatastreamCollections
+    include NamedRelationships
+#    include DatastreamCollections
   end
 
 end

data/lib/active_fedora/datastream.rb

@@ -3,6 +3,7 @@ module ActiveFedora
   #This class represents a Fedora datastream
   class Datastream < Rubydora::Datastream
     
+    attr_writer :digital_object
     attr_accessor :dirty, :last_modified, :fields
     before_create :add_mime_type
   
@@ -28,6 +29,7 @@ module ActiveFedora
     end
     
     # Test whether this datastream been modified since it was last saved?
+    # TODO deprecate this, just use changed?
     def dirty?
       @dirty || changed?
     end
@@ -37,7 +39,8 @@ module ActiveFedora
     end
 
     def save
-      raise "No content #{dsid}" if @content.nil?
+      #raise "No content #{dsid}" if @content.nil?
+      return if @content.nil?
       run_callbacks :save do
         return create if new?
         repository.modify_datastream to_api_params.merge({ :pid => pid, :dsid => dsid })

data/lib/active_fedora/datastream_collections.rb

@@ -1,326 +1,337 @@
-module DatastreamCollections
-  extend ActiveSupport::Concern
+require 'active_support/core_ext/module/aliasing'
+module ActiveFedora
+  module DatastreamCollections
+    extend ActiveSupport::Concern
 
-  included do
-    class_inheritable_accessor :class_named_datastreams_desc
-    self.class_named_datastreams_desc = {}
-  end
+    included do
+      class_attribute :class_named_datastreams_desc
+      self.class_named_datastreams_desc = {}
+      class << self
+        def inherited_with_datastream_collections(kls) #:nodoc:
+          ## Do some inheritance logic that doesn't override Base.inherited
+          inherited_without_datastream_collections kls
+          kls.class_named_datastreams_desc = kls.class_named_datastreams_desc.dup
+        end
+        alias_method_chain :inherited, :datastream_collections
+      end
+    end
 
-  module ClassMethods
+    module ClassMethods
 
-    # ** EXPERIMENTAL **
-    #
-    # Allows for a datastream to be treated like any other attribute of a model class 
-    # while enforcing mimeType and/or datastream type (ie. external, managed, etc.) if defined. 
-    # ====Examples 
-    #                 
-    #  has_datastream :name=>"thumbnails",:prefix => "THUMB",:type=>ActiveFedora::Datastream, :mimeType=>"image/jpeg", :controlGroup=>'M'                     
-    #  has_datastream :name=>"EADs", :type=>ActiveFedora::Datastream, :mimeType=>"application/xml", :controlGroup=>'M' 
-    #  has_datastream :name=>"external_images", :type=>ActiveFedora::Datastream, :controlGroup=>'E' 
-    #
-    # Required Keys in args
-    #  :name  -  name to give this datastream (must be unique)
-    #
-    # Optional Keys in args
-    #  :prefix - used to create the DSID plus an index ie. THUMB1, THUMB2.  If :prefix is not specified, defaults to :name value in all uppercase 
-    #  :type - defaults to ActiveFedora::Datastream if you would like content specific class to be used supply it here
-    #  :mimeType - if supplied it will ensure any datastreams added are of this type, if not supplied any mimeType is acceptabl e
-    #  :controlGroup -  possible values "X", "M", "R", or "E" (InlineXML, Managed Content, Redirect, or External Referenced) If controlGroup is 'E' or 'R' it expects a dsLocation be defined when adding the datastream.
-    #
-    # You use the datastream attribute using helper methods created for each datastream name:
-    #
-    # ====Helper Method Examples
-    #  thumbnails_append -  Append a thumbnail datastream
-    #  thumbnails        -  Get array of thumbnail datastreams
-    #  thumbnails_ids    -  Get array of dsid's for thumbnail datastreams
-    #
-    # When loading the list of datastreams for a name from Fedora it uses the DSID prefix to find them in Fedora
-    def has_datastream(args)
-      unless args.has_key?(:name)
-        return false
-      end
-      unless args.has_key?(:prefix)
-        args.merge!({:prefix=>args[:name].to_s.upcase})
-      end
-      unless class_named_datastreams_desc.has_key?(args[:name]) 
-        class_named_datastreams_desc[args[:name]] = {} 
+      # ** EXPERIMENTAL **
+      #
+      # Allows for a datastream to be treated like any other attribute of a model class 
+      # while enforcing mimeType and/or datastream type (ie. external, managed, etc.) if defined. 
+      # ====Examples 
+      #                 
+      #  has_datastream :name=>"thumbnails",:prefix => "THUMB",:type=>ActiveFedora::Datastream, :mimeType=>"image/jpeg", :controlGroup=>'M'                     
+      #  has_datastream :name=>"EADs", :type=>ActiveFedora::Datastream, :mimeType=>"application/xml", :controlGroup=>'M' 
+      #  has_datastream :name=>"external_images", :type=>ActiveFedora::Datastream, :controlGroup=>'E' 
+      #
+      # Required Keys in args
+      #  :name  -  name to give this datastream (must be unique)
+      #
+      # Optional Keys in args
+      #  :prefix - used to create the DSID plus an index ie. THUMB1, THUMB2.  If :prefix is not specified, defaults to :name value in all uppercase 
+      #  :type - defaults to ActiveFedora::Datastream if you would like content specific class to be used supply it here
+      #  :mimeType - if supplied it will ensure any datastreams added are of this type, if not supplied any mimeType is acceptabl e
+      #  :controlGroup -  possible values "X", "M", "R", or "E" (InlineXML, Managed Content, Redirect, or External Referenced) If controlGroup is 'E' or 'R' it expects a dsLocation be defined when adding the datastream.
+      #
+      # You use the datastream attribute using helper methods created for each datastream name:
+      #
+      # ====Helper Method Examples
+      #  thumbnails_append -  Append a thumbnail datastream
+      #  thumbnails        -  Get array of thumbnail datastreams
+      #  thumbnails_ids    -  Get array of dsid's for thumbnail datastreams
+      #
+      # When loading the list of datastreams for a name from Fedora it uses the DSID prefix to find them in Fedora
+      def has_datastream(args)
+        unless args.has_key?(:name)
+          return false
+        end
+        unless args.has_key?(:prefix)
+          args.merge!({:prefix=>args[:name].to_s.upcase})
+        end
+        unless class_named_datastreams_desc.has_key?(args[:name]) 
+          class_named_datastreams_desc[args[:name]] = {} 
+        end
+            
+        args.merge!({:mimeType=>args[:mime_type]}) if args.has_key?(:mime_type)
+        
+        unless class_named_datastreams_desc[args[:name]].has_key?(:type) 
+          #default to type ActiveFedora::Datastream
+          args.merge!({:type => "ActiveFedora::Datastream"})
+        end
+        class_named_datastreams_desc[args[:name]]= args   
+        create_named_datastream_finders(args[:name],args[:prefix])
+        create_named_datastream_update_methods(args[:name])
       end
-          
-      args.merge!({:mimeType=>args[:mime_type]}) if args.has_key?(:mime_type)
       
-      unless class_named_datastreams_desc[args[:name]].has_key?(:type) 
-        #default to type ActiveFedora::Datastream
-        args.merge!({:type => "ActiveFedora::Datastream"})
-      end
-      class_named_datastreams_desc[args[:name]]= args   
-      create_named_datastream_finders(args[:name],args[:prefix])
-      create_named_datastream_update_methods(args[:name])
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Creates the following helper methods for a datastream name
-    #   [datastream_name]_append  - Add a named datastream
-    #
-    # ==== Examples for "thumbnails" datastream
-    #  thumbnails_append -  Append a thumbnail datastream
-    # TODO: Add [datastream_name]_remove
-    def create_named_datastream_update_methods(name)
-      append_file_method_name = "#{name.to_s.downcase}_file_append"
-      append_method_name = "#{name.to_s.downcase}_append"
-      #remove_method_name = "#{name.to_s.downcase}_remove"
-      self.send(:define_method,:"#{append_file_method_name}") do |*args| 
-        file,opts = *args
-        opts ||= {}
-        add_named_file_datastream(name,file,opts)
-      end
+      # ** EXPERIMENTAL **
+      #
+      # Creates the following helper methods for a datastream name
+      #   [datastream_name]_append  - Add a named datastream
+      #
+      # ==== Examples for "thumbnails" datastream
+      #  thumbnails_append -  Append a thumbnail datastream
+      # TODO: Add [datastream_name]_remove
+      def create_named_datastream_update_methods(name)
+        append_file_method_name = "#{name.to_s.downcase}_file_append"
+        append_method_name = "#{name.to_s.downcase}_append"
+        #remove_method_name = "#{name.to_s.downcase}_remove"
+        self.send(:define_method,:"#{append_file_method_name}") do |*args| 
+          file,opts = *args
+          opts ||= {}
+          add_named_file_datastream(name,file,opts)
+        end
+        
+        self.send(:define_method,:"#{append_method_name}") do |*args| 
+          #call add_named_datastream instead of add_file_named_datastream in case not managed datastream
+          add_named_datastream(name,*args)
+        end
+      end 
       
-      self.send(:define_method,:"#{append_method_name}") do |*args| 
-        #call add_named_datastream instead of add_file_named_datastream in case not managed datastream
-        add_named_datastream(name,*args)
-      end
-    end 
-    
-    # ** EXPERIMENTAL **
-    #
-    # Creates the following helper methods for a datastream name
-    #   [datastream_name]  - Returns array of named datastreams
-    #   [datastream_name]_ids - Returns array of named datastream dsids
-    #
-    # ==== Examples for "thumbnails" datastream
-    #  thumbnails        -  Get array of thumbnail datastreams
-    #  thumbnails_ids    -  Get array of dsid's for thumbnail datastreams
-    def create_named_datastream_finders(name, prefix)
-      class_eval <<-END,  __FILE__, __LINE__
-      def #{name}(opts={})
-        id_array = []
-        keys = datastreams.keys
-        id_array = keys.select {|v| v =~ /#{prefix}\d*/}
-        if opts[:response_format] == :id_array
-          return id_array
-        else
-          named_ds = []
-          id_array.each do |name|
-            if datastreams.has_key?(name)
-              named_ds.push(datastreams[name])
+      # ** EXPERIMENTAL **
+      #
+      # Creates the following helper methods for a datastream name
+      #   [datastream_name]  - Returns array of named datastreams
+      #   [datastream_name]_ids - Returns array of named datastream dsids
+      #
+      # ==== Examples for "thumbnails" datastream
+      #  thumbnails        -  Get array of thumbnail datastreams
+      #  thumbnails_ids    -  Get array of dsid's for thumbnail datastreams
+      def create_named_datastream_finders(name, prefix)
+        class_eval <<-END,  __FILE__, __LINE__
+        def #{name}(opts={})
+          id_array = []
+          keys = datastreams.keys
+          id_array = keys.select {|v| v =~ /#{prefix}\d*/}
+          if opts[:response_format] == :id_array
+            return id_array
+          else
+            named_ds = []
+            id_array.each do |name|
+              if datastreams.has_key?(name)
+                named_ds.push(datastreams[name])
+              end
             end
+            return named_ds
           end
-          return named_ds
         end
+        def #{name}_ids
+          #{name}(:response_format => :id_array)
+        end
+        END
       end
-      def #{name}_ids
-        #{name}(:response_format => :id_array)
-      end
-      END
-    end
-    
-
+      
 
-  end
 
-    # ** EXPERIMENTAL **
-    #
-    # Accessor for class variable for hash that stores arguments passed to has_datastream calls within an
-    # ActiveFedora::Base child class.    
-    #  
-    #  has_datastream :name=>"audio_file", :prefix=>"AUDIO", :type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav" 
-    #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
-    #
-    # The above examples result in the following hash
-    #  {"audio_file"=>{:prefix=>"AUDIO",:type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav", :controlGroup=>'M'},
-    #   "external_images=>{:prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'}}
-    #
-    # This hash is later used when adding a named datastream such as an "audio_file" as defined above.
-    def named_datastreams_desc
-      self.class_named_datastreams_desc ||= {}
     end
 
-    # ** EXPERIMENTAL **
-    #
-    # Returns array of datastream names defined for this object 
-    def datastream_names
-      named_datastreams_desc.keys
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Calls add_named_datastream while assuming it will be managed content and sets :blob and :controlGroup values accordingly
-    # ====Parameters
-    #  name: Datastream name
-    #  file: The file to add for this datastream
-    #  opts: Options hash.  See +add_named_datastream+ for expected keys and values
-    def add_named_file_datastream(name, file, opts={})
-      opts.merge!({:blob=>file,:controlGroup=>'M'})
-      add_named_datastream(name,opts)
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # This object is used by [datastream_name]_append helper to add a named datastream
-    # but can also be called directly.
-    # ====Parameters
-    #  name: name of datastream to add
-    #  opts: hash defining datastream attributes
-    # The following are expected keys in opts hash:
-    #   :label => Defaults to the file name
-    #   :blob or :file  => Required to point to the datastream file being added if managed content
-    #   :controlGroup => defaults to 'M' for managed, can also be 'E' external and 'R' for redirected
-    #   :content_type => required if the file does not respond to 'content_type' and should match :mimeType in has_datastream definition if defined
-    #   :dsLocation => holds uri location of datastream.  Required only if :controlGroup is type 'E' or 'R'.
-    #   :dsid or :dsId => Optional, and used to update an existing datastream with dsid supplied.  Will throw an error if dsid does not exist and does not match prefix pattern for datastream name
-    def add_named_datastream(name,opts={})
-      unless named_datastreams_desc.has_key?(name) && named_datastreams_desc[name].has_key?(:type) 
-        raise "Failed to add datastream. Named datastream #{name} not defined for object #{pid}." 
+      # ** EXPERIMENTAL **
+      #
+      # Accessor for class variable for hash that stores arguments passed to has_datastream calls within an
+      # ActiveFedora::Base child class.    
+      #  
+      #  has_datastream :name=>"audio_file", :prefix=>"AUDIO", :type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav" 
+      #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
+      #
+      # The above examples result in the following hash
+      #  {"audio_file"=>{:prefix=>"AUDIO",:type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav", :controlGroup=>'M'},
+      #   "external_images=>{:prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'}}
+      #
+      # This hash is later used when adding a named datastream such as an "audio_file" as defined above.
+      def named_datastreams_desc
+        self.class_named_datastreams_desc ||= {}
       end
 
-      if opts.has_key?(:mime_type)
-        opts.merge!({:content_type=>opts[:mime_type]})
-      elsif opts.has_key?(:mimeType)
-        opts.merge!({:content_type=>opts[:mimeType]})
+      # ** EXPERIMENTAL **
+      #
+      # Returns array of datastream names defined for this object 
+      def datastream_names
+        named_datastreams_desc.keys
       end
-      opts.merge!(named_datastreams_desc[name])
-        
-      label = opts.has_key?(:label) ? opts[:label] : ""
+      
+      # ** EXPERIMENTAL **
+      #
+      # Calls add_named_datastream while assuming it will be managed content and sets :blob and :controlGroup values accordingly
+      # ====Parameters
+      #  name: Datastream name
+      #  file: The file to add for this datastream
+      #  opts: Options hash.  See +add_named_datastream+ for expected keys and values
+      def add_named_file_datastream(name, file, opts={})
+        opts.merge!({:blob=>file,:controlGroup=>'M'})
+        add_named_datastream(name,opts)
+      end
+      
+      # ** EXPERIMENTAL **
+      #
+      # This object is used by [datastream_name]_append helper to add a named datastream
+      # but can also be called directly.
+      # ====Parameters
+      #  name: name of datastream to add
+      #  opts: hash defining datastream attributes
+      # The following are expected keys in opts hash:
+      #   :label => Defaults to the file name
+      #   :blob or :file  => Required to point to the datastream file being added if managed content
+      #   :controlGroup => defaults to 'M' for managed, can also be 'E' external and 'R' for redirected
+      #   :content_type => required if the file does not respond to 'content_type' and should match :mimeType in has_datastream definition if defined
+      #   :dsLocation => holds uri location of datastream.  Required only if :controlGroup is type 'E' or 'R'.
+      #   :dsid or :dsId => Optional, and used to update an existing datastream with dsid supplied.  Will throw an error if dsid does not exist and does not match prefix pattern for datastream name
+      def add_named_datastream(name,opts={})
+        unless named_datastreams_desc.has_key?(name) && named_datastreams_desc[name].has_key?(:type) 
+          raise "Failed to add datastream. Named datastream #{name} not defined for object #{pid}." 
+        end
 
-      #only do these steps for managed datastreams
-      unless (opts.has_key?(:controlGroup)&&opts[:controlGroup]!="M")
-        if opts.has_key?(:file)
-          opts.merge!({:blob => opts[:file]}) 
-          opts.delete(:file)
+        if opts.has_key?(:mime_type)
+          opts.merge!({:content_type=>opts[:mime_type]})
+        elsif opts.has_key?(:mimeType)
+          opts.merge!({:content_type=>opts[:mimeType]})
+        end
+        opts.merge!(named_datastreams_desc[name])
+          
+        label = opts.has_key?(:label) ? opts[:label] : ""
+
+        #only do these steps for managed datastreams
+        unless (opts.has_key?(:controlGroup)&&opts[:controlGroup]!="M")
+          if opts.has_key?(:file)
+            opts.merge!({:blob => opts[:file]}) 
+            opts.delete(:file)
+          end
+          
+          raise "You must define parameter blob for this managed datastream to load for #{pid}" unless opts.has_key?(:blob)
+          
+          #if no explicit label and is a file use original file name for label
+          if !opts.has_key?(:label)&&opts[:blob].respond_to?(:original_filename)
+            label = opts[:blob].original_filename
+          end
+          
+          if opts[:blob].respond_to?(:content_type)&&!opts[:blob].content_type.nil? && !opts.has_key?(:content_type)
+            opts.merge!({:content_type=>opts[:blob].content_type})
+          end
+
+          raise "The blob must respond to content_type or the hash must have :content_type or :mime_type property set" unless opts.has_key?(:content_type)
+          
+          #throw error for mimeType mismatch
+          if named_datastreams_desc[name].has_key?(:mimeType) && !named_datastreams_desc[name][:mimeType].eql?(opts[:content_type])
+            raise "Content type mismatch for add datastream #{name} to #{pid}.  Expected: #{named_datastreams_desc[name][:mimeType]}, Actual: #{opts[:content_type]}"
+          end
+        else 
+          label = opts[:dsLocation] if (opts.has_key?(:dsLocation)) 
         end
         
-        raise "You must define parameter blob for this managed datastream to load for #{pid}" unless opts.has_key?(:blob)
+        opts.merge!(:dsLabel => label)
         
-        #if no explicit label and is a file use original file name for label
-        if !opts.has_key?(:label)&&opts[:blob].respond_to?(:original_filename)
-          label = opts[:blob].original_filename
+        ds = create_datastream(named_datastreams_desc[name][:type], opts[:dsid], opts)
+        #Must be of type datastream
+        assert_kind_of 'datastream',  ds, ActiveFedora::Datastream
+        #make sure dsid is nil so that it uses the prefix for mapping purposes
+        #check dsid works for the prefix if it is set
+        if !ds.dsid.nil? && opts.has_key?(:prefix)
+          raise "dsid supplied does not conform to pattern #{opts[:prefix]}[number]" unless ds.dsid =~ /#{opts[:prefix]}[0-9]/
         end
         
-        if opts[:blob].respond_to?(:content_type)&&!opts[:blob].content_type.nil? && !opts.has_key?(:content_type)
-          opts.merge!({:content_type=>opts[:blob].content_type})
-        end
+        add_datastream(ds,opts)
+      end
 
-        raise "The blob must respond to content_type or the hash must have :content_type or :mime_type property set" unless opts.has_key?(:content_type)
-        
-        #throw error for mimeType mismatch
-        if named_datastreams_desc[name].has_key?(:mimeType) && !named_datastreams_desc[name][:mimeType].eql?(opts[:content_type])
-          raise "Content type mismatch for add datastream #{name} to #{pid}.  Expected: #{named_datastreams_desc[name][:mimeType]}, Actual: #{opts[:content_type]}"
-        end
-      else 
-        label = opts[:dsLocation] if (opts.has_key?(:dsLocation)) 
+      # ** EXPERIMENTAL **
+      #
+      # Update an existing named datastream.  It has same parameters as add_named_datastream
+      # except the :dsid key is now required.
+      #
+      # ====TODO
+      # Currently requires you to update file if a managed datastream 
+      # but could change to allow metadata only updates as well
+      def update_named_datastream(name, opts={})
+        #check that dsid provided matches existing datastream with that name
+        raise "You must define parameter dsid for datastream to update for #{pid}" unless opts.include?(:dsid)
+        raise "Datastream with name #{name} and dsid #{opts[:dsid]} does not exist for #{pid}" unless self.send("#{name}_ids").include?(opts[:dsid])
+        add_named_datastream(name,opts)
       end
       
-      opts.merge!(:dsLabel => label)
-      
-      ds = create_datastream(named_datastreams_desc[name][:type], opts[:dsid], opts)
-      #Must be of type datastream
-      assert_kind_of 'datastream',  ds, ActiveFedora::Datastream
-      #make sure dsid is nil so that it uses the prefix for mapping purposes
-      #check dsid works for the prefix if it is set
-      if !ds.dsid.nil? && opts.has_key?(:prefix)
-        raise "dsid supplied does not conform to pattern #{opts[:prefix]}[number]" unless ds.dsid =~ /#{opts[:prefix]}[0-9]/
+      # ** EXPERIMENTAL **
+      #
+      # Throws an assertion failure unless the object 'o' is kind_of? class 't'
+      # ====Parameters
+      #  n: Name of object
+      #  o: The object to test
+      #  t: The class type to check is kind_of?
+      def assert_kind_of(n, o,t)
+        raise "Assertion failure: #{n}: #{o} is not of type #{t}" unless o.kind_of?(t)
       end
       
-      add_datastream(ds,opts)
-    end
-
-    # ** EXPERIMENTAL **
-    #
-    # Update an existing named datastream.  It has same parameters as add_named_datastream
-    # except the :dsid key is now required.
-    #
-    # ====TODO
-    # Currently requires you to update file if a managed datastream 
-    # but could change to allow metadata only updates as well
-    def update_named_datastream(name, opts={})
-      #check that dsid provided matches existing datastream with that name
-      raise "You must define parameter dsid for datastream to update for #{pid}" unless opts.include?(:dsid)
-      raise "Datastream with name #{name} and dsid #{opts[:dsid]} does not exist for #{pid}" unless self.send("#{name}_ids").include?(opts[:dsid])
-      add_named_datastream(name,opts)
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Throws an assertion failure unless the object 'o' is kind_of? class 't'
-    # ====Parameters
-    #  n: Name of object
-    #  o: The object to test
-    #  t: The class type to check is kind_of?
-    def assert_kind_of(n, o,t)
-      raise "Assertion failure: #{n}: #{o} is not of type #{t}" unless o.kind_of?(t)
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Returns true if the name is a defined named datastream
-    def is_named_datastream?(name)
-      named_datastreams_desc.has_key?(name)
-    end
+      # ** EXPERIMENTAL **
+      #
+      # Returns true if the name is a defined named datastream
+      def is_named_datastream?(name)
+        named_datastreams_desc.has_key?(name)
+      end
 
-    # ** EXPERIMENTAL **
-    #
-    # Returns hash of datastream names defined by has_datastream calls mapped to 
-    # array of datastream objects that have been added
-    # ====Example
-    # For the following has_datastream entries and a datastream defined for minivan only would be
-    #  has_datastream :name=>"minivan", :prefix => "VAN", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'M'
-    #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
-    #
-    # Returns
-    #  {"external_images"=>[],"thumbnails"=>{#<ActiveFedora::Datastream:0x7ffd6512daf8 ...}} 
-    def named_datastreams
-      ds_values = {}
-      self.class.class_named_datastreams_desc.keys.each do |name|
-        ds_values.merge!({name=>self.send("#{name}")})
+      # ** EXPERIMENTAL **
+      #
+      # Returns hash of datastream names defined by has_datastream calls mapped to 
+      # array of datastream objects that have been added
+      # ====Example
+      # For the following has_datastream entries and a datastream defined for minivan only would be
+      #  has_datastream :name=>"minivan", :prefix => "VAN", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'M'
+      #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
+      #
+      # Returns
+      #  {"external_images"=>[],"thumbnails"=>{#<ActiveFedora::Datastream:0x7ffd6512daf8 ...}} 
+      def named_datastreams
+        ds_values = {}
+        self.class.class_named_datastreams_desc.keys.each do |name|
+          ds_values.merge!({name=>self.send("#{name}")})
+        end
+        return ds_values
       end
-      return ds_values
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Returns hash of datastream names mapped to an array
-    # of dsid's for named datastream objects
-    # === Example
-    # For the following has_datastream call, assume we have added two datastreams.
-    # 
-    #  has_datastream :name=>"thumbnails",:prefix => "THUMB",:type=>ActiveFedora::Datastream, :mimeType=>"image/jpeg", :controlGroup=>'M'                     
-    #
-    # It would then return
-    #  {"thumbnails=>["THUMB1", "THUMB2"]}
-    def named_datastreams_ids
-      dsids = {}
-      self.class.class_named_datastreams_desc.keys.each do |name|
-        dsid_array = self.send("#{name}_ids")
-        dsids[name] = dsid_array
+      
+      # ** EXPERIMENTAL **
+      #
+      # Returns hash of datastream names mapped to an array
+      # of dsid's for named datastream objects
+      # === Example
+      # For the following has_datastream call, assume we have added two datastreams.
+      # 
+      #  has_datastream :name=>"thumbnails",:prefix => "THUMB",:type=>ActiveFedora::Datastream, :mimeType=>"image/jpeg", :controlGroup=>'M'                     
+      #
+      # It would then return
+      #  {"thumbnails=>["THUMB1", "THUMB2"]}
+      def named_datastreams_ids
+        dsids = {}
+        self.class.class_named_datastreams_desc.keys.each do |name|
+          dsid_array = self.send("#{name}_ids")
+          dsids[name] = dsid_array
+        end
+        return dsids
+      end 
+      
+      # ** EXPERIMENTAL **
+      #
+      # Returns the hash that stores arguments passed to has_datastream calls within an
+      # ActiveFedora::Base child class.    
+      #  
+      #  has_datastream :name=>"audio_file", :prefix=>"AUDIO", :type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav" 
+      #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
+      #
+      # The above examples result in the following hash
+      #  {"audio_file"=>{:prefix=>"AUDIO",:type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav", :controlGroup=>'M'},
+      #   "external_images=>{:prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'}}
+      #
+      # This hash is later used when adding a named datastream such as an "audio_file" as defined above.
+      def named_datastreams_desc
+        @named_datastreams_desc ||= self.class.class_named_datastreams_desc
+      end
+      
+      # ** EXPERIMENTAL **
+      #
+      # Get class variable hash that stores has_datastream arguments.
+      # It is used to initialize the value returned by public named_datastreams_desc method
+      # Deprecated
+      def named_datastreams_desc_from_class
+        logger.warn "named_datastreams_desc_from_class is deprecated and will be removed in the next version"
+        self.class.class_named_datastreams_desc
       end
-      return dsids
-    end 
-    
-    # ** EXPERIMENTAL **
-    #
-    # Returns the hash that stores arguments passed to has_datastream calls within an
-    # ActiveFedora::Base child class.    
-    #  
-    #  has_datastream :name=>"audio_file", :prefix=>"AUDIO", :type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav" 
-    #  has_datastream :name=>"external_images", :prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'
-    #
-    # The above examples result in the following hash
-    #  {"audio_file"=>{:prefix=>"AUDIO",:type=>ActiveFedora::Datastream, :mimeType=>"audio/x-wav", :controlGroup=>'M'},
-    #   "external_images=>{:prefix=>"EXTIMG", :type=>ActiveFedora::Datastream,:mimeType=>"image/jpeg", :controlGroup=>'E'}}
-    #
-    # This hash is later used when adding a named datastream such as an "audio_file" as defined above.
-    def named_datastreams_desc
-      @named_datastreams_desc ||= self.class.class_named_datastreams_desc
-    end
-    
-    # ** EXPERIMENTAL **
-    #
-    # Get class variable hash that stores has_datastream arguments.
-    # It is used to initialize the value returned by public named_datastreams_desc method
-    # Deprecated
-    def named_datastreams_desc_from_class
-      logger.warn "named_datastreams_desc_from_class is deprecated and will be removed in the next version"
-      self.class.class_named_datastreams_desc
-    end
 
+  end
 end