hydra-head 4.0.3 → 4.1.0

data/lib/hydra/file_assets_helper.rb

@@ -1,139 +1,12 @@
 # will move to lib/hydra/controller / upload_behavior.rb in release 5.x
+require 'deprecation'
 module Hydra::FileAssetsHelper
-  
-  # Creates a File Asset, adding the posted blob to the File Asset's datastreams and saves the File Asset
-  #
-  # @return [FileAsset] the File Asset  
-  def create_and_save_file_assets_from_params
-    if params.has_key?(:Filedata)
-      @file_assets = []
-      params[:Filedata].each do |file|
-        @file_asset = create_asset_from_file(file)
-        add_posted_blob_to_asset(@file_asset,file)
-        @file_asset.save
-        @file_assets << @file_asset
-      end
-      return @file_assets
-    else
-      render :text => "400 Bad Request", :status => 400
-    end
-  end
-  
-  # Puts the contents of params[:Filedata] (posted blob) into a datastream within the given @asset
-  # Sets asset label and title to filename if they're empty
-  #
-  # @param [FileAsset] asset the File Asset to add the blob to
-  # @return [FileAsset] file the File Asset  
-  def add_posted_blob_to_asset(asset, file)
-    #file_name = filename_from_params
-    file_name = file.original_filename
-    options = {:label=>file_name, :mimeType=>mime_type(file_name)}
-    dsid = datastream_id #Only call this once so that it could be a sequence
-    options[:dsid] = dsid if dsid
-    asset.add_file_datastream(file, options)
-    asset.set_title_and_label( file_name, :only_if_blank=>true )
-  end
+  extend ActiveSupport::Concern
+  extend Deprecation
 
-  #Override this if you want to specify the datastream_id (dsID) for the created blob
-  def datastream_id
-    "content"
-  end
-  
-  # Associate the new file asset with its container
-  def associate_file_asset_with_container(file_asset=nil, container_id=nil)
-    if container_id.nil?
-      container_id = params[:asset_id]
-    end
-    if file_asset.nil?
-      file_asset = @file_asset
-    end
-    file_asset.add_relationship(:is_part_of, container_id)
-    file_asset.datastreams["RELS-EXT"].dirty = true
-    file_asset.save
-  end
-  
-  # Apply any posted file metadata to the file asset
-  def apply_posted_file_metadata         
-    @metadata_update_response = update_document(@file_asset, @sanitized_params)
-    @file_asset.save
-  end
-  
-  
-  # The posted File 
-  # @return [File] the posted file.  Defaults to nil if no file was posted.
-  def posted_file
-    params[:Filedata]
-  end
-  
-  # A best-guess filename based on POST params
-  # If Filename was submitted, it uses that.  Otherwise, it calls +original_filename+ on the posted file
-  def filename_from_params
-    if !params[:Filename].nil?
-      file_name = params[:Filename]      
-    else
-      file_name = posted_file.original_filename
-      params[:Filename] = file_name
-    end
+  included do
+    Deprecation.warn Hydra::FileAssetsHelper, "Hydra::FileAssetsHelper has been moved to Hydra::Controller::UploadBehavior"
+    include Hydra::Controller::UploadBehavior
   end
 
-  # Creates a File Asset and sets its label from params[:Filename]
-  #
-  # @return [FileAsset] the File Asset
-  def create_asset_from_params    
-    file_asset = FileAsset.new
-    file_asset.label = params[:Filename]
-    
-    return file_asset
-  end
-  
-  # Creates a File Asset and sets its label from filename
-  #
-  # @return [FileAsset] the File Asset
-  def create_asset_from_file(file)
-    file_asset = FileAsset.new
-    file_asset.label = file.original_filename
-
-    return file_asset
-  end
-  
-  
-  # This is pre-Hydra code that created an AudioAsset, VideoAsset or ImageAsset based on the
-  # current params in the controller.
-  #
-  # @return [Constant] the recommended Asset class 
-  def asset_class_from_params
-    if params.has_key?(:type)
-      chosen_type = case params[:type]
-      when "AudioAsset"
-        AudioAsset
-      when "VideoAsset"
-        VideoAsset
-      when "ImageAsset"
-        ImageAsset
-      else
-        FileAsset
-      end
-    elsif params.has_key?(:Filename)
-      chosen_type = choose_model_by_filename( params[:Filename] )
-    else
-      chosen_type = FileAsset
-    end
-    
-    return chosen_type
-  end
-  
-  def choose_model_by_filename(filename)
-    choose_model_by_filename_extension( File.extname(filename) )
-  end
-  
-
-  private
-  # Return the mimeType for a given file name
-  # @param [String] file_name The filename to use to get the mimeType
-  # @return [String] mimeType for filename passed in. Default: application/octet-stream if mimeType cannot be determined
-  def mime_type file_name
-    mime_types = MIME::Types.of(file_name)
-    mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
-  end
-  
 end

data/lib/hydra/generic_content.rb

@@ -3,7 +3,10 @@
 # require "mime/types"
 
 # will move to lib/hydra/model/generic_content_behavior in release 5.x
+require 'deprecation'
 module Hydra::GenericContent
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
   
   def self.included(klass)
    klass.send :include, Hydra::ModelMethods
@@ -27,14 +30,17 @@ module Hydra::GenericContent
       def has_#{m}?
         self.datastreams.keys.include? "#{m}"
       end
+      deprecation_deprecate :has_#{m}?
 
       def #{m}
         datastreams["#{m}"].content if has_#{m}?
       end
+      deprecation_deprecate :#{m}
 
       def #{m}=(file)
         create_or_update_datastream( "#{m}", file )
       end
+      deprecation_deprecate :#{m}=
     EOM
   end
     
@@ -46,12 +52,14 @@ module Hydra::GenericContent
     add_datastream(ds)
     save
   end
+  deprecation_deprecate :from_url
   
   def from_binary binary_info, ds_name
     file =  binary_to_file(binary_info[:blob],ds_name,binary_info[:extension])
     add_file_datastream(file,:dsid=>ds_name,:label=>ds_name)
     save
   end
+  deprecation_deprecate :from_binary
   
   def binary_to_file blob, suffix, ext=nil
     file_name = Time.now.strftime("%Y%m%d-%H%M%S")
@@ -60,6 +68,7 @@ module Hydra::GenericContent
     f.close
     return f
   end
+  deprecation_deprecate :binary_to_file
   
   def create_or_update_datastream ds_name, file
     case file
@@ -76,6 +85,7 @@ module Hydra::GenericContent
       end
     end
   end
+  deprecation_deprecate :create_or_update_datastream
   
   # Returns a human readable filesize appropriate for the given number of bytes (ie. automatically chooses 'bytes','KB','MB','GB','TB')
   # Based on a bit of python code posted here: http://blogmag.net/blog/read/38/Print_human_readable_file_size
@@ -89,9 +99,11 @@ module Hydra::GenericContent
         end
       end
   end   
+  deprecation_deprecate :bits_to_human_readable
   
   # augments add_file_datastream to also put file size (in bytes/KB/MB/GB/TB) in mods:physicaldescription/mods:extent 
   def add_file_datastream(file, opts={})
+    Deprecation.warn(Hydra::GenericContent, "add_file_datastream is deprecated and will be removed in hydra-head 5.x")
     # label = opts.has_key?(:label) ? opts[:label] : ""
     # mimeType = opts.has_key?(:mimeType) ? opts[:mimeType] : ""
     # ds = ActiveFedora::Datastream.new(:dsLabel => label, :controlGroup => 'M', :blob => file, :mimeType => mimeType)
@@ -107,9 +119,12 @@ module Hydra::GenericContent
     end
     descMetadata.update_indexed_attributes( [:physical_description, :extent] => size )
   end
+ # deprecation_deprecate :add_file_datastream ## 'super' call breaks under ree.. ??
   
   def mime_type file_name
     mime_types = MIME::Types.of(file_name)
     mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
   end
+  deprecation_deprecate :mime_type
+
 end

data/lib/hydra/generic_image.rb

@@ -9,8 +9,12 @@
 # 
 # will move to lib/hydra/model/generic_image_behavior in release 5.x
 require "hydra"
+require 'deprecation'
 
 module Hydra::GenericImage
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
+
   def self.included klass
     klass.send(:include, Hydra::GenericContent)
   end
@@ -35,30 +39,36 @@ module Hydra::GenericImage
       return DERIVATION_DEFAULTS
     end
   end
+  deprecation_deprecate :derivation_options
 
   DEFAULT_IMAGE_DATASTREAMS.each do |ds_name|
     class_eval <<-EOM
       def has_#{ds_name}?
         self.datastreams.keys.include? "#{ds_name}"
       end
+      deprecation_deprecate :has_#{ds_name}?
 
       def #{ds_name}
         datastreams["#{ds_name}"].content if has_#{ds_name}?
       end
+      deprecation_deprecate :#{ds_name}
       
       def #{ds_name}=(file)
         create_or_update_datastream("#{ds_name}",file)
       end
+      deprecation_deprecate :#{ds_name}=
       
       def derive_#{ds_name}
         derive_datastream "#{ds_name}"
       end
+      deprecation_deprecate :derive_#{ds_name}
     EOM
   end
   
   def derive_all
     DEFAULT_IMAGE_DATASTREAMS.each { |ds| self.send "derive_#{ds.to_sym}" }
   end
+  deprecation_deprecate :derive_all
 
 
   private

data/lib/hydra/global_configurable.rb

@@ -0,0 +1,46 @@
+module Hydra::GlobalConfigurable
+  
+  # The config environment name used by the #config method
+  #
+  # Example:
+  #   class MyThing
+  #     extend Hydra::GlobalConfigurable
+  #   end
+  # 
+  # Now MyThing.config will be the result of:
+  #   MyThing.configure(:production) {|config|}
+  #
+  # You set shared attributes by leaving the first argument blank or passing the :shared value:
+  #   MyThing.configure {|config|} 
+  # or
+  #   MyThing.configure(:shared) {|config|}
+  
+  # sets the @configs variable to a new Hash with empty Hash for :shared key and @config to nil
+  def reset_configs!
+    @config = nil
+    @configs = {:shared=>{}}
+  end
+  
+  # A hash of all environment configs
+  # The key is the environment name, the value a Hash
+  def configs
+    @configs ? @configs : (reset_configs! and @configs)
+  end
+  
+  # The main config accessor. It merges the current configs[::Rails.env] 
+  # with configs[:shared] and lazy-loads @config to the result.
+  def config
+    @config ||= configs[:shared].merge(configs[::Rails.env] ||= {})
+  end
+  alias_method :blacklight_config, :config
+  
+  # Accepts a value for the environment to configure and a block
+  # A hash is yielded to the block
+  # If the "env" != :shared,
+  # the hash is created by deep cloning the :shared environment config.
+  # This makes it possible to create defaults in the :shared config
+  def configure(env = :shared, &blk)
+    configs[env] = {}
+    yield configs[env]
+  end
+end

data/lib/hydra/model_methods.rb

@@ -16,10 +16,10 @@ module Hydra::ModelMethods
     prop_ds = self.datastreams["properties"]
     rights_ds = self.datastreams["rightsMetadata"]
   
-    if !prop_ds.nil? && prop_ds.respond_to?(:depositor_values)
-      prop_ds.depositor_values = depositor_id unless prop_ds.nil?
+    if prop_ds 
+      prop_ds.depositor = depositor_id unless prop_ds.nil?
     end
-    rights_ds.update_indexed_attributes([:edit_access, :person]=>depositor_id) unless rights_ds.nil?
+    rights_ds.permissions({:person=>depositor_id}, 'edit') unless rights_ds.nil?
     return true
   end
 

data/lib/hydra/model_mixins.rb

@@ -1,8 +1,8 @@
 module Hydra::ModelMixins
   extend ActiveSupport::Autoload
   eager_autoload do
-    autoload :ModsObject
     autoload :CommonMetadata
     autoload :RightsMetadata
+    autoload :SolrDocumentExtension
   end
 end

data/lib/hydra/model_mixins/solr_document_extension.rb

@@ -0,0 +1,24 @@
+module Hydra::ModelMixins
+  module SolrDocumentExtension
+    def document_type display_type = CatalogController.blacklight_config.show.display_type
+      type = self.fetch(:medium_t, nil)
+
+      type ||= self.fetch(display_type, nil) if display_type
+
+      type.first.to_s.gsub("info:fedora/afmodel:","").gsub("Hydrangea","").gsub(/^Generic/,"")
+    end
+
+    def get_person_from_role(role, opts={})
+      i = 0
+      while i < 10
+        persons_roles = self["person_#{i}_role_t"].map{|w|w.strip.downcase} unless self["person_#{i}_role_t"].nil?
+        if persons_roles and persons_roles.include?(role.downcase)
+          return {:first=>self["person_#{i}_first_name_t"], :last=>self["person_#{i}_last_name_t"]}
+        end
+        i += 1
+      end
+    end
+  end
+end
+
+SolrDocument.use_extension Hydra::ModelMixins::SolrDocumentExtension

data/lib/hydra/repository_controller.rb

@@ -18,102 +18,11 @@
 # end
 #
 module Hydra::RepositoryController
-  
-  def self.included(c)
-    if c.respond_to?(:helper_method)
-      c.helper_method :solr_name
-      c.helper_method :format_pid
-    end
-  end
-  
-  
-  #
-  # This method converts pid strings into xhtml safe IDs, since xhmlt expects namespaces to be defined. 
-  # I.E. hydrus:123 = hydrus_123
-  def format_pid(pid)
-    pid.gsub(":", "_")
-  end
-  
-  
-  
-  def solr_name(field_name, field_type = :text)
-    ::ActiveFedora::SolrService.solr_name(field_name, field_type)
-  end
-  
-  
-  # Returns a list of datastreams for download.
-  # Uses user's roles and "mime_type" value in submitted params to decide what to return.
-  # if you pass the optional argument of :canonical=>true, it will return the canonical datastream for this object (a single object not a hash of datastreams)
-  def downloadables(fedora_object=@fedora_object, opts={})
-    if opts[:canonical]
-      mime_type = opts[:mime_type] ? opts[:mime_type] : "application/pdf"
-      result = filter_datastreams_for_mime_type(fedora_object.datastreams, mime_type).sort.first[1]
-    elsif can? :edit, fedora_object
-      if params["mime_type"] == "all"
-        result = fedora_object.datastreams
-      else
-        result = Hash[]
-        fedora_object.datastreams.each_pair do |dsid,ds|
-          if !ds.new_object?
-            mime_type = ds.mimeType ? ds.mimeType : ""
-            if mime_type.include?("pdf") || ds.label.include?("_TEXT.xml") || ds.label.include?("_METS.xml")
-             result[dsid] = ds
-            end 
-          end 
-        end
-      end
-    else
-      result = Hash[]
-      fedora_object.datastreams.each_pair do |dsid,ds|
-         if ds.mimeType.include?("pdf")
-           result[dsid] = ds
-         end  
-       end
-    end 
-    # puts "downloadables result: #{result}"
-    return result    
-  end
-
-  protected 
-  def load_document
-    @document = load_document_from_params
-  end
+  extend ActiveSupport::Concern
 
-  # Uses submitted params Hash to figure out what Model to load
-  # params should contain :content_type and :id
-  def load_document_from_params
-    af_model = retrieve_af_model(params[:content_type])
-    unless af_model 
-      af_model = ModsAsset
-    end
-    return af_model.find(params[:id])
+  included do
+    ActiveSupport::Deprecation.warn "Hydra::RepositoryController has moved to Hydra::Controller::RepositoryControllerBehavior"
+    include Hydra::Controller::RepositoryControllerBehavior
   end
   
-  def retrieve_af_model(class_name, opts={})
-    if !class_name.nil?
-      klass = Module.const_get(class_name.camelcase)
-    else
-      klass = nil
-    end
-    if klass.is_a?(Class) && klass.superclass == ActiveFedora::Base
-      return klass
-    else
-      return opts.fetch(:default, false)
-    end
-    rescue NameError
-      return false
-  end
-
-  private
-  
-  def filter_datastreams_for_mime_type(datastreams_hash, mime_type)
-    result = Hash[]
-    datastreams_hash.each_pair do |dsid,ds|
-      ds_mime_type = ds.mimeType ? ds.mimeType : ""
-      if ds_mime_type == mime_type
-       result[dsid] = ds
-      end  
-    end
-    return result
-  end
 end