hydra-head 4.0.3 → 4.1.0

data/lib/hydra/assets.rb

@@ -1,137 +1,7 @@
-# @deprecated  Create Model-specific Controllers instead ie. ArticlesController, ETDController, etc.
-# Also see Hydra::Controller::AssetsControllerBehavior for more info.
-# will move to lib/hydra/controller / assets_controller_behavior.rb in release 5.x
-module Hydra::Assets
-  extend ActiveSupport::Concern
-  include Blacklight::SolrHelper
-  include Hydra::RepositoryController
-  include Hydra::AssetsControllerHelper
-  include ReleaseProcessHelper
-  include Blacklight::Catalog
-
-  included do
-    helper :hydra
-    include Hydra::UI::Controller
-    before_filter :search_session, :history_session
-    before_filter :load_document, :only => :update # allows other filters to operate on the document before the update method is called
-
-    include Hydra::SubmissionWorkflow
-    
-    
-    prepend_before_filter :sanitize_update_params, :only=>:update
-    before_filter :check_embargo_date_format, :only=>:update
-  end
-      
-  def show
-    if params.has_key?("field")
-      
-      @response, @document = get_solr_response_for_doc_id
-      result = @document["#{params["field"]}_t"]
-      unless result.nil?
-        if params.has_key?("field_index")
-          result = result[params["field_index"].to_i-1]
-        elsif result.kind_of?(Array)
-          result = result.first
-        end
-      end
-      respond_to do |format|
-        format.html     { render :text=>result }
-        format.textile  { render :text=> RedCloth.new(result, [:sanitize_html]).to_html  }
-      end
-    else
-      redirect_to catalog_path(params[:id])
-    end
-  end
-  
-  # Uses the update_indexed_attributes method provided by ActiveFedora::Base
-  # This should behave pretty much like the ActiveRecord update_indexed_attributes method
-  # For more information, see the ActiveFedora docs.
-  # 
-  # @example Appends a new "subject" value of "My Topic" to on the descMetadata datastream in in the _PID_ document.
-  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"subject"=>{"-1"=>"My Topic"}}
-  # @example Sets the 1st and 2nd "medium" values on the descMetadata datastream in the _PID_ document, overwriting any existing values.
-  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"medium"=>{"0"=>"Paper Document", "1"=>"Image"}}
-  def update
-    logger.debug("attributes submitted: #{@sanitized_params.inspect}")
-         
-    @response = update_document(@document, @sanitized_params)
-   
-    @document.save
-    flash[:notice] = "Your changes have been saved."
-    
-    #logger.debug("returning #{@response.inspect}")
-    
-    respond_to do |want| 
-      want.html {
-        redirect_to next_step(params[:id])
-      }
-      want.js {
-        render :json=> tidy_response_from_update(@response)  
-      }
-      want.textile {
-        if @response.kind_of?(Hash)
-          textile_response = tidy_response_from_update(@response).values.first
-        end
-        render :text=> RedCloth.new(textile_response, [:sanitize_html]).to_html
-      }
-    end
-  end
-  
-  def new
-    af_model = retrieve_af_model(params[:content_type])
-    raise "Can't find a model for #{params[:content_type]}" unless af_model
-    @asset = af_model.new
-    apply_depositor_metadata(@asset)
-    set_collection_type(@asset, params[:content_type])
-    @asset.save
-    model_display_name = af_model.to_s.camelize.scan(/[A-Z][^A-Z]*/).join(" ")
-    msg = "Created a #{model_display_name} with pid #{@asset.pid}. Now it's ready to be edited."
-    flash[:notice]= msg
-    session[:scripts] = params[:combined] == "true"
-
-    redirect_to edit_catalog_path(@asset.pid, :new_asset=>true)
-  end
-  
-  def destroy
-    af = ActiveFedora::Base.find(params[:id], :cast=>true)
-    assets = af.destroy_child_assets
-    af.delete
-    msg = "Deleted #{params[:id]}"
-    msg.concat(" and associated file_asset(s): #{assets.join(", ")}") unless assets.empty?
-    flash[:notice]= msg
-    redirect_to catalog_index_path()
-  end
-
-  
-  # This is a method to simply remove the item from SOLR but keep the object in fedora. 
-  alias_method :withdraw, :destroy
-  
-  protected
-
-
-  
-  def mods_assets_update_validation
-    desc_metadata = params[:asset][:descMetadata]
-    rights_metadata = params[:asset][:rightsMetadata]
-    if !rights_metadata.nil? and rights_metadata.has_key?(:embargo_embargo_release_date)
-      unless rights_metadata[:embargo_embargo_release_date]["0"].blank?
-        begin
-          parsed_date = Date.parse(rights_metadata[:embargo_embargo_release_date]["0"]).to_s
-          params[:asset][:rightsMetadata][:embargo_embargo_release_date]["0"] = parsed_date
-        rescue
-          flash[:error] = "You must enter a valid release date."
-          return false
-        end
-      end
-    end
-    
-    if !desc_metadata.nil? and desc_metadata.has_key?(:title_info_main_title) and desc_metadata.has_key?(:journal_0_title_info_main_title)
-      if desc_metadata[:title_info_main_title]["0"].blank? or desc_metadata[:journal_0_title_info_main_title]["0"].blank?
-        flash[:error] = "The title fields are required."
-        return false
-      end
-    end
-    
-    return true
+module Hydra
+  module Assets
+    extend ActiveSupport::Concern
+    require 'hydra/controller/assets_controller_behavior'
+    include Hydra::Controller::AssetsControllerBehavior
   end
 end

data/lib/hydra/catalog.rb

@@ -1,49 +1,11 @@
-# *Using this Module is not necessary if you're writing Controllers in Rails3.*  
-# In a Rails3 app, simply define regular Rails Controllers to expose the Resources & Actions you need and use Hydra::Controller to add Hydra support.
-# For search & discovery in those apps, use Blacklight and customize the "index" partials for each type of content to include links to the show/edit actions of the corresponding Controllers.
-#
-# This Module extends Blacklight Catalog behaviors to give you a "Hydra" Catalog with edit and show behaviors on top of the Blacklight search behaviors.
-# Include this module into any of your Blacklight Catalog classes (ie. CatalogController) to add Hydra functionality.
-#
-# will move to lib/hydra/controller/catalog_controller_behavior in release 5.x
+require 'hydra/controller/catalog_controller_behavior'
+require 'deprecation'
 module Hydra::Catalog
   extend ActiveSupport::Concern
-  
-  
+  extend Deprecation
+
   included do
-    # Other modules to auto-include
-    include Hydra::Controller
-    include Hydra::UI::Controller
-    
-    # Controller filters
-    # Also see the generator (or generated CatalogController) to see more before_filters in action
-    before_filter :load_fedora_document, :only=>[:show,:edit]
-    
-    # View Helpers
-    helper :hydra_uploader
-    helper :article_metadata
-    rescue_from ActiveFedora::ObjectNotFoundError, :with => :nonexistent_document
-  end
-  
-  def edit
-    show
-    render "show"
-  end
-  
-  # This will render the "delete" confirmation page and a form to submit a destroy request to the assets controller
-  def delete
-    show
-    render "show"
-  end
-  
-  def nonexistent_document
-    if Rails.env == "development"
-      render
-    else
-      flash[:notice] = "Sorry, you have requested a record that doesn't exist."
-      params.delete(:id)
-      index
-      render "index", :status => 404
-    end
+    Deprecation.warn(Hydra::Catalog, "Hydra::Catalog is deprecated and is replaced by Hydra::Controller::CatalogControllerBehavior.")
+    include Hydra::Controller::CatalogControllerBehavior
   end
 end

data/lib/hydra/controller.rb

@@ -10,34 +10,17 @@
 #
 # will move to lib/hydra/controller/controller_behavior in release 5.x
 module Hydra::Controller
+  autoload :AssetsControllerBehavior, 'hydra/controller/assets_controller_behavior'
+  autoload :CatalogControllerBehavior, 'hydra/controller/catalog_controller_behavior'
+  autoload :ControllerBehavior, 'hydra/controller/controller_behavior'
+  autoload :RepositoryControllerBehavior, 'hydra/controller/repository_controller_behavior'
+  autoload :UploadBehavior, 'hydra/controller/upload_behavior'
+  autoload :FileAssetsBehavior, 'hydra/controller/file_assets_behavior'
 
-  def self.included(klass)
-    # Other modules to auto-include
-    klass.send(:include, Hydra::AccessControlsEnforcement)
-    klass.send(:include, Hydra::RepositoryController)
+  extend ActiveSupport::Concern
   
-    # View Helpers
-    klass.helper :hydra
-    klass.helper :hydra_assets
+  included do
+    ActiveSupport::Deprecation.warn("Hydra::Controller has been renamed Hydra::Controller::ControllerBehavior.")
+    include Hydra::Controller::ControllerBehavior
   end
-  
-  # Use params[:id] to load an object from Fedora.  Inspects the object for known models and mixes in any of those models' behaviors.
-  # Sets @document_fedora with the loaded object
-  # Sets @file_assets with file objects that are children of the loaded object
-  def load_fedora_document
-    @document_fedora = ActiveFedora::Base.find(params[:id], :cast=>true)
-    unless @document_fedora.class.include?(Hydra::ModelMethods)
-      @document_fedora.class.send :include, Hydra::ModelMethods
-    end
-    
-    @file_assets = @document_fedora.parts(:response_format=>:solr)
-  end
-  
-  
-  # get the currently configured user identifier.  Can be overridden to return whatever (ie. login, email, etc)
-  # defaults to using whatever you have set as the Devise authentication_key
-  def user_key
-    current_user.send(Devise.authentication_keys.first)
-  end
-  
 end

data/lib/hydra/controller/assets_controller_behavior.rb

@@ -0,0 +1,142 @@
+# @deprecated  Create Model-specific Controllers instead ie. ArticlesController, ETDController, etc.
+# Also see Hydra::Controller::AssetsControllerBehavior for more info.
+# will move to lib/hydra/controller / assets_controller_behavior.rb in release 5.x
+require 'om'
+
+module Hydra::Controller::AssetsControllerBehavior
+  extend ActiveSupport::Concern
+
+  include Blacklight::SolrHelper
+  include Hydra::Controller::RepositoryControllerBehavior
+  include Hydra::AssetsControllerHelper
+  include ReleaseProcessHelper
+  include Blacklight::Catalog
+
+  included do
+    helper :hydra
+    include Hydra::UI::Controller
+    before_filter :search_session, :history_session
+    before_filter :load_document, :only => :update # allows other filters to operate on the document before the update method is called
+
+    include Hydra::SubmissionWorkflow
+    include Hydra::AccessControlsEnforcement
+    
+    
+    prepend_before_filter :sanitize_update_params, :only=>:update
+    before_filter :check_embargo_date_format, :only=>:update
+    before_filter :enforce_access_controls
+  end
+      
+  def show
+    if params.has_key?("field")
+      
+      @response, @document = get_solr_response_for_doc_id
+      result = @document["#{params["field"]}_t"]
+      unless result.nil?
+        if params.has_key?("field_index")
+          result = result[params["field_index"].to_i-1]
+        elsif result.kind_of?(Array)
+          result = result.first
+        end
+      end
+      respond_to do |format|
+        format.html     { render :text=>result }
+        format.textile  { render :text=> RedCloth.new(result, [:sanitize_html]).to_html  }
+      end
+    else
+      redirect_to catalog_path(params[:id])
+    end
+  end
+
+  # Uses the update_indexed_attributes method provided by ActiveFedora::Base
+  # This should behave pretty much like the ActiveRecord update_indexed_attributes method
+  # For more information, see the ActiveFedora docs.
+  # 
+  # @example Appends a new "subject" value of "My Topic" to on the descMetadata datastream in in the _PID_ document.
+  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"subject"=>{"-1"=>"My Topic"}}
+  # @example Sets the 1st and 2nd "medium" values on the descMetadata datastream in the _PID_ document, overwriting any existing values.
+  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"medium"=>{"0"=>"Paper Document", "1"=>"Image"}}
+  def update
+    logger.debug("attributes submitted: #{@sanitized_params.inspect}")
+         
+    @response = update_document(@document, @sanitized_params)
+   
+    @document.save
+    flash[:notice] = "Your changes have been saved."
+    
+    #logger.debug("returning #{@response.inspect}")
+    
+    respond_to do |want| 
+      want.html {
+        redirect_to next_step(params[:id])
+      }
+      want.js {
+        render :json=> tidy_response_from_update(@response)  
+      }
+      want.textile {
+        if @response.kind_of?(Hash)
+          textile_response = tidy_response_from_update(@response).values.first
+        end
+        render :text=> RedCloth.new(textile_response, [:sanitize_html]).to_html
+      }
+    end
+  end
+  
+  def new
+    af_model = retrieve_af_model(params[:content_type])
+    raise "Can't find a model for #{params[:content_type]}" unless af_model
+    @asset = af_model.new
+    apply_depositor_metadata(@asset)
+    set_collection_type(@asset, params[:content_type])
+    @asset.save
+    model_display_name = af_model.to_s.camelize.scan(/[A-Z][^A-Z]*/).join(" ")
+    msg = "Created a #{model_display_name} with pid #{@asset.pid}. Now it's ready to be edited."
+    flash[:notice]= msg
+    session[:scripts] = params[:combined] == "true"
+
+    redirect_to edit_catalog_path(@asset.pid, :new_asset=>true)
+  end
+  
+  def destroy
+    af = ActiveFedora::Base.find(params[:id], :cast=>true)
+    assets = af.destroy_child_assets
+    af.delete
+    msg = "Deleted #{params[:id]}"
+    msg.concat(" and associated file_asset(s): #{assets.join(", ")}") unless assets.empty?
+    flash[:notice]= msg
+    redirect_to catalog_index_path()
+  end
+
+  
+  # This is a method to simply remove the item from SOLR but keep the object in fedora. 
+  alias_method :withdraw, :destroy
+  
+  protected
+
+
+  
+  def mods_assets_update_validation
+    desc_metadata = params[:asset][:descMetadata]
+    rights_metadata = params[:asset][:rightsMetadata]
+    if !rights_metadata.nil? and rights_metadata.has_key?(:embargo_embargo_release_date)
+      unless rights_metadata[:embargo_embargo_release_date]["0"].blank?
+        begin
+          parsed_date = Date.parse(rights_metadata[:embargo_embargo_release_date]["0"]).to_s
+          params[:asset][:rightsMetadata][:embargo_embargo_release_date]["0"] = parsed_date
+        rescue
+          flash[:error] = "You must enter a valid release date."
+          return false
+        end
+      end
+    end
+    
+    if !desc_metadata.nil? and desc_metadata.has_key?(:title_info_main_title) and desc_metadata.has_key?(:journal_0_title_info_main_title)
+      if desc_metadata[:title_info_main_title]["0"].blank? or desc_metadata[:journal_0_title_info_main_title]["0"].blank?
+        flash[:error] = "The title fields are required."
+        return false
+      end
+    end
+    
+    return true
+  end
+end

data/lib/hydra/controller/catalog_controller_behavior.rb

@@ -0,0 +1,56 @@
+# *Using this Module is not necessary if you're writing Controllers in Rails3.*  
+# In a Rails3 app, simply define regular Rails Controllers to expose the Resources & Actions you need and use Hydra::Controller to add Hydra support.
+# For search & discovery in those apps, use Blacklight and customize the "index" partials for each type of content to include links to the show/edit actions of the corresponding Controllers.
+#
+# This Module extends Blacklight Catalog behaviors to give you a "Hydra" Catalog with edit and show behaviors on top of the Blacklight search behaviors.
+# Include this module into any of your Blacklight Catalog classes (ie. CatalogController) to add Hydra functionality.
+#
+# will move to lib/hydra/controller/catalog_controller_behavior in release 5.x
+require 'deprecation'
+module Hydra::Controller::CatalogControllerBehavior
+  extend ActiveSupport::Concern
+  extend Deprecation
+
+  self.deprecation_horizon = 'hydra-head 5.x'
+  
+  
+  included do
+    Deprecation.warn(Hydra::Controller::CatalogControllerBehavior, "CatalogControllerBehavior is deprecated. You should make your own controllers using the Hydra::Controller::ControllerBehavior")
+    # Other modules to auto-include
+    include Hydra::UI::Controller
+    
+    # Controller filters
+    # Also see the generator (or generated CatalogController) to see more before_filters in action
+    before_filter :load_fedora_document, :only=>[:show,:edit]
+    
+    # View Helpers
+    helper :hydra_uploader
+    helper :article_metadata
+    rescue_from ActiveFedora::ObjectNotFoundError, :with => :nonexistent_document
+  end
+  
+  def edit
+    show
+    render "show"
+  end
+  #deprecation_deprecate :edit
+  
+  # This will render the "delete" confirmation page and a form to submit a destroy request to the assets controller
+  def delete
+    show
+    render "show"
+  end
+  #deprecation_deprecate :delete
+  
+  def nonexistent_document *args
+    if Rails.env == "development"
+      render "nonexistent_document"
+    else
+      flash[:notice] = "Sorry, you have requested a record that doesn't exist."
+      params.delete(:id)
+      index
+      render "index", :status => 404
+    end
+  end
+  #deprecation_deprecate :nonexistent_document
+end

data/lib/hydra/controller/controller_behavior.rb

@@ -0,0 +1,59 @@
+# Include this module into any of your Controller classes to add Hydra functionality
+#
+# The primary function of this module is to mix in a number of other Hydra Modules, including 
+#   Hydra::AccessControlsEnforcement
+#
+# @example 
+#  class CustomHydraController < ApplicationController  
+#    include Hydra::Controller
+#  end
+#
+# will move to lib/hydra/controller/controller_behavior in release 5.x
+require 'deprecation'
+module Hydra::Controller::ControllerBehavior
+  extend ActiveSupport::Concern
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
+
+  included do
+    # Other modules to auto-include
+    include Hydra::AccessControlsEnforcement
+    include Hydra::Controller::RepositoryControllerBehavior
+  
+    helper :hydra
+    helper :hydra_assets
+
+    # Catch permission errors
+    rescue_from Hydra::AccessDenied do |exception|
+      if (exception.action == :edit)
+        redirect_to({:action=>'show'}, :alert => exception.message)
+      elsif current_user and current_user.persisted?
+        redirect_to root_url, :alert => exception.message
+      else
+        session["user_return_to"] = request.url
+        redirect_to new_user_session_url, :alert => exception.message
+      end
+    end
+  end
+  
+  # Use params[:id] to load an object from Fedora.  Inspects the object for known models and mixes in any of those models' behaviors.
+  # Sets @document_fedora with the loaded object
+  # Sets @file_assets with file objects that are children of the loaded object
+  def load_fedora_document
+    @document_fedora = ActiveFedora::Base.find(params[:id], :cast=>true)
+    unless @document_fedora.class.include?(Hydra::ModelMethods)
+      @document_fedora.class.send :include, Hydra::ModelMethods
+    end
+    
+    @file_assets = @document_fedora.parts(:response_format=>:solr)
+  end
+  deprecation_deprecate :load_fedora_document
+  
+  
+  # get the currently configured user identifier.  Can be overridden to return whatever (ie. login, email, etc)
+  # defaults to using whatever you have set as the Devise authentication_key
+  def user_key
+    current_user.user_key if current_user
+  end
+  
+end