hydra-head 4.0.3 → 4.1.0

data/app/helpers/hydra/generic_content_objects_helper_behavior.rb

@@ -1,11 +1,17 @@
+require 'deprecation'
 module Hydra::GenericContentObjectsHelperBehavior
+  extend Deprecation
+    
+  self.deprecation_horizon = 'hydra-head 5.x'
   
   def datastream_disseminator_url pid, datastream_name
     ActiveFedora::Base.connection_for_pid(pid).client.url + "/get/#{pid}/#{datastream_name}"
   end
+  #deprecation_deprecate :datastream_disseminator_url
   
   def disseminator_link pid, datastream_name
     link_to 'view', datastream_disseminator_url(pid, datastream_name), :class=>"fbImage"
   end
+  #deprecation_deprecate :disseminator_link
   
 end

data/app/helpers/hydra/hydra_assets_helper_behavior.rb

@@ -1,5 +1,8 @@
 require 'sanitize'
+require 'deprecation'
 module Hydra::HydraAssetsHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
 
   # Create a link for creating a new asset of the specified content_type
   # If user is not logged in, the link leads to the login page with appropriate redirect params for creating the asset after logging in
@@ -12,12 +15,14 @@ module Hydra::HydraAssetsHelperBehavior
       link_to link_label, new_user_session_path(:redirect_params => {:action => "new", :controller=> "assets", :content_type => content_type}), :class=>"create_asset"
     end
   end
+  deprecation_deprecate :link_to_create_asset
   
   # Render a link to delete the given asset from the repository.
   # Includes a confirmation message. 
   def delete_asset_link(pid, asset_type_display="asset")
     "<a href=\"#{ url_for(:action=>:delete, :controller=>:catalog, :id=>pid)}\" class=\"delete_asset_link\" >Delete this #{asset_type_display}</a>".html_safe
   end
+  deprecation_deprecate :delete_asset_link
 
   def document_type(document)
     if (document[blacklight_config.show.display_type]) 
@@ -25,6 +30,7 @@ module Hydra::HydraAssetsHelperBehavior
     else ""
     end
   end
+  deprecation_deprecate :document_type
 
   def get_person_from_role(doc,role,opts={})  
     i = 0
@@ -36,6 +42,7 @@ module Hydra::HydraAssetsHelperBehavior
       i += 1
     end
   end
+  deprecation_deprecate :get_person_from_role
 
   def get_file_asset_count(document)
     count = 0
@@ -44,6 +51,7 @@ module Hydra::HydraAssetsHelperBehavior
     count += obj.parts.length unless obj.nil?
     count
   end
+ # deprecation_deprecate :get_file_asset_count
   
   def get_file_asset_description(document)
     #TODO need test coverage
@@ -55,6 +63,7 @@ module Hydra::HydraAssetsHelperBehavior
        fobj.nil? ? "" : short_description(fobj.datastreams["descMetadata"].get_values("description").first)
     end
   end
+  deprecation_deprecate :get_file_asset_description
 
   def short_description(desc,max=150)
     if desc.length > max
@@ -62,5 +71,6 @@ module Hydra::HydraAssetsHelperBehavior
     end
     short_description = desc.capitalize
   end
+  deprecation_deprecate :short_description
   
 end

data/app/helpers/hydra/hydra_fedora_metadata_helper_behavior.rb

@@ -1,8 +1,11 @@
 require "inline_editable_metadata_helper"
 require "block_helpers"
 require "redcloth" # Provides textile parsing support for textile_area method
+require 'deprecation'
 
 module Hydra::HydraFedoraMetadataHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
   
   def fedora_text_field(resource, datastream_name, field_key, opts={})
     field_name = field_name_for(field_key)
@@ -26,10 +29,12 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     
     result
   end
+  deprecation_deprecate :fedora_text_field
   
   def fedora_text_area(resource, datastream_name, field_key, opts={})
     fedora_textile_text_area(resource, datastream_name, field_key, opts)
   end
+  deprecation_deprecate :fedora_text_area
   
   # Textile textarea varies from the other methods in a few ways
   # Since we're using jeditable with this instead of fluid, we need to provide slightly different hooks for the javascript
@@ -60,6 +65,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     result << body.html_safe
     result
   end
+  deprecation_deprecate :fedora_textile_text_area
   
   # Expects :choices option.  Option tags for the select are generated from the :choices option using Rails "options_for_select":http://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/options_for_select helper
   # If no :choices option is provided, returns a regular fedora_text_field
@@ -85,6 +91,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     result
   end
+  deprecation_deprecate :fedora_select
   
   def fedora_date_select(resource, datastream_name, field_key, opts={})
     field_name = field_name_for(field_key)
@@ -137,6 +144,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     result << body.html_safe
     result
   end
+  deprecation_deprecate :fedora_date_select
 
   def fedora_submit(resource, datastream_name, field_key, opts={})
     result = ""
@@ -146,6 +154,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     return result.html_safe
   end
+  deprecation_deprecate :fedora_submit
   
   def fedora_checkbox(resource, datastream_name, field_key, opts={})
     result = ""
@@ -172,6 +181,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     return result.html_safe
   end
+  deprecation_deprecate :fedora_checkbox
   
   # Expects :choices option. 
   # :choices should be a hash with value/label pairs
@@ -209,6 +219,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     return result.html_safe
   end
+  deprecation_deprecate :fedora_radio_button
   
   
   def fedora_text_field_insert_link(datastream_name, field_key, opts={})
@@ -218,6 +229,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     result = "<a class='addval #{field_type}' href='#' data-datastream-name=\"#{datastream_name}\" title='#{link_text}'>#{link_text}</a>"
     return result.html_safe
   end
+  deprecation_deprecate :fedora_text_field_insert_link
   
   def fedora_text_area_insert_link(datastream_name, field_key, opts={})
     field_name = field_name_for(field_key)
@@ -225,6 +237,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     result = "<a class='addval textarea' href='#' data-datastream-name=\"#{datastream_name}\" title='#{link_text}'>#{link_text}</a>"    
     return result.html_safe
   end
+  deprecation_deprecate :fedora_text_area_insert_link
   
   def fedora_field_label(datastream_name, field_key, label=nil)
     field_name = field_name_for(field_key)
@@ -237,6 +250,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
       return content_tag("label", label, :for=>field_name).html_safe
     end
   end
+  deprecation_deprecate :fedora_field_label
   
   # Generate hidden inputs to handle mapping field names to server-side metadata mappings
   # this allows us to round-trip OM metadata mappings
@@ -259,62 +273,76 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     result.html_safe
   end
+  deprecation_deprecate :field_selectors_for
   
   # hydra_form_for block helper 
   # allows you to construct an entire hydra form by passing a block into this method
   class HydraFormFor < BlockHelpers::Base
+    extend Deprecation
 
     def initialize(resource, opts={})
+      Deprecation.warn self.class.name, "HydraFormFor is deprecated and will be removed from hydra-head 5.x"
       @resource = resource
     end
     
     def fedora_label(datastream_name, field_key, opts={})
       helper.fedora_label(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_label
     
     def fedora_text_field(datastream_name, field_key, opts={})
       helper.fedora_label(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_text_field
 
     def fedora_text_area(datastream_name, field_key, opts={})
       helper.fedora_text_area(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_text_area
     
     def fedora_select(datastream_name, field_key, opts={})
       helper.fedora_select(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_select
 
     def fedora_submit(datastream_name, field_key, opts={})
       helper.fedora_submit(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_submit
     
     def fedora_checkbox(datastream_name, field_key, opts={})
       helper.fedora_checkbox(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_checkbox
     
     def fedora_radio_button(datastream_name, field_key, opts={})
       helper.fedora_radio_button(@resource, datastream_name, field_key, opts)
     end    
+    deprecation_deprecate :fedora_radio_button
     
     def fedora_text_field_insert_link(datastream_name, field_key, opts={})
       helper.fedora_text_field_insert_link(@resource, datastream_name, field_key, opts={})
     end
+    deprecation_deprecate :fedora_text_field_insert_link
     
     def fedora_field_label(datastream_name, field_key, opts={})
       helper.fedora_field_label(@resource, datastream_name, field_key, opts)
     end
+    deprecation_deprecate :fedora_field_label
 
     def display(body)
       inner_html = content_tag :input, :type=>"hidden", :name=>"content_type", :value=>@resource.class.to_s.underscore
       inner_html = inner_html << body
       content_tag :form, inner_html
     end
+    deprecation_deprecate :display
 
   end
   
   #
   # Internal helper methods
   #
+  protected
   
   # retrieve field values from datastream.
   # If :values is provided, skips accessing the datastream and returns the contents of :values instead.
@@ -328,6 +356,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
     end
     return values
   end
+  #deprecation_deprecate :get_values_from_datastream
   
   def field_name_for(field_key)
     if field_key.kind_of?(Array)
@@ -336,6 +365,7 @@ module Hydra::HydraFedoraMetadataHelperBehavior
       field_key.to_s
     end
   end
+  #deprecation_deprecate :field_name_for
   
   def generate_base_id(field_name, current_value, values, opts)
     if opts.fetch(:multiple, true)
@@ -344,5 +374,6 @@ module Hydra::HydraFedoraMetadataHelperBehavior
       return field_name
     end
   end
+  #deprecation_deprecate :generate_base_id
   
 end

data/app/helpers/hydra/hydra_helper_behavior.rb

@@ -1,16 +1,20 @@
 require "hydra/submission_workflow"
+require 'deprecation'
+
 module Hydra::HydraHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
   include Hydra::SubmissionWorkflow
   
+  ## Deprecation functionality provided by Blacklight
   # collection of stylesheet links to be rendered in the <head>
-  def stylesheet_links
-    @stylesheet_links ||= []
-  end
-  
+  # def stylesheet_links
+  #   @stylesheet_links ||= []
+  # end
   # collection of javascript includes to be rendered in the <head>
-  def javascript_includes
-    @javascript_includes ||= []
-  end
+  # def javascript_includes
+  #  @javascript_includes ||= []
+  # end
   
   def async_load_tag( url, tag )
     # Commenting out becasue async_load is provieded by a JS file that we're not currently loading.
@@ -19,6 +23,8 @@ module Hydra::HydraHelperBehavior
     #   "async_load('#{url}', '\##{tag}');"
     # end
   end
+  deprecation_deprecate :async_load_tag
+
   
   def link_to_multifacet( name, args={} )
     facet_params = {}
@@ -36,6 +42,7 @@ module Hydra::HydraHelperBehavior
 
     link_to(name, catalog_index_path(facet_params), options).html_safe
   end
+  deprecation_deprecate :link_to_multifacet
   
   def edit_and_browse_links
     result = ""
@@ -57,6 +64,7 @@ module Hydra::HydraHelperBehavior
     end
     pluralize(count, 'document')
   end
+  deprecation_deprecate :grouped_result_count
   
   def grouping_facet
     fields = Hash[sort_fields]
@@ -87,6 +95,7 @@ module Hydra::HydraHelperBehavior
       return default_response
     end
   end
+  deprecation_deprecate :facet_value_hits
   
   def get_html_data_with_label(doc, label, field_string, opts={})
      if opts[:default] && !doc[field_string]
@@ -125,6 +134,7 @@ module Hydra::HydraHelperBehavior
        text
       end
    end
+  deprecation_deprecate :get_html_data_with_label
    
    def get_textile_data_with_label(doc, label, field_string, opts={})
       if opts[:default] && !doc[field_string]
@@ -148,6 +158,7 @@ module Hydra::HydraHelperBehavior
         text
        end
     end
+   deprecation_deprecate :get_textile_data_with_label
   
   def render_previous_workflow_steps
     previous_show_partials(params[:wf_step]).map{|partial| render partial}.join

data/app/helpers/hydra/hydra_uploader_helper_behavior.rb

@@ -1,10 +1,14 @@
+require 'deprecation'
 module Hydra::HydraUploaderHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
   
   # Generate the appropriate url for posting uploads to
   # Uses the +container_id+ method to figure out what container uploads should go into
   def upload_url
     upload_url = hydra_asset_file_assets_path(:asset_id=>container_id)
   end
+  deprecation_deprecate :upload_url
   
   # The id of the container that uploads should be posted into
   # If params[:container_id] is not set, it uses params[:id] (assumes that you're uploading items into the current object)
@@ -15,4 +19,5 @@ module Hydra::HydraUploaderHelperBehavior
       return params[:id]
     end
   end
+  deprecation_deprecate :container_id
 end

data/app/helpers/hydra/inline_editable_metadata_helper_behavior.rb

@@ -1,15 +1,21 @@
+require 'deprecation'
 module Hydra::InlineEditableMetadataHelperBehavior
+  extend Deprecation
   
   def inline_editable_text_field(object_name, method, options = {})
   end
+  deprecation_deprecate :inline_editable_text_field
   
   def inline_editable_text_area(object_name, method, options = {})
   end
+  deprecation_deprecate :inline_editable_text_area
   
   def inline_editable_select(object_name, method, options = {})
   end
+  deprecation_deprecate :inline_editable_select
   
   def inline_editable_checkbox(object_name, method, options = {})
   end
+  deprecation_deprecate :inline_editable_checkbox
   
 end

data/app/helpers/hydra/javascript_includes_helper_behavior.rb

@@ -11,7 +11,10 @@
 #     include_javascript_for_catalog_edit
 #     javascript_includes << ['hydrangeaArticleBehaviors.js', {:plugin=>:hydrangea_articles}]
 #   end
+require 'deprecation'
 module Hydra::JavascriptIncludesHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
   
   # Add the appropriate javascripts for the specified content type & action into the Controller's javascript_includes array
   # If you have defined custom javascript includes for that content_type & action, they will be used.
@@ -29,6 +32,7 @@ module Hydra::JavascriptIncludesHelperBehavior
       include_default_javascript( action )
     end
   end
+  deprecation_deprecate :include_javascript_for
   
   # Add the default javascript to the controller's javascript_includes
   # Takes a method argument (ie. show or edit) to decide which defaults to use.
@@ -44,6 +48,7 @@ module Hydra::JavascriptIncludesHelperBehavior
       logger.debug "No default javascript includes defined for #{method} views.  Doing nothing."
     end
   end
+  deprecation_deprecate :include_default_javascript
   
   #
   #   Helpers for Catalog Show & Edit Javascript Includes
@@ -57,6 +62,7 @@ module Hydra::JavascriptIncludesHelperBehavior
     # This file contains the page initialization scripts for catalog show views
     javascript_includes << ["catalog/show", {:plugin=>"hydra-head"}]
   end
+  deprecation_deprecate :include_javascript_for_catalog_show
   
   # Adds the appropriate javascripts to javascript_includes for CatalogController edit views
   # Override this if you want to change the set of javascript_includes for CatalogController edit views
@@ -83,5 +89,6 @@ module Hydra::JavascriptIncludesHelperBehavior
     # This file contains the page initialization scripts for catalog edit views
     javascript_includes << ["catalog/edit", {:plugin=>"hydra-head"}]
   end
+  deprecation_deprecate :include_javascript_for_catalog_edit
   
 end

data/app/helpers/hydra/personalization_helper_behavior.rb

@@ -1,4 +1,7 @@
+require 'deprecation'
 module Hydra::PersonalizationHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'hydra-head 5.x'
 
   DEFAULT_USER_ATTRIBUTES = ['full_name', 'affiliation', 'photo']
 
@@ -20,6 +23,7 @@ module Hydra::PersonalizationHelperBehavior
       def #{m}_from_login login
         get_user_attribute(login, '#{m}')
       end
+      deprecation_deprecate :#{m}_from_login
     EOC
   end
 
@@ -30,6 +34,7 @@ module Hydra::PersonalizationHelperBehavior
     path = photo_from_login login
     path == "" ? "" : image_tag(path)
   end
+  deprecation_deprecate :user_photo_tag
 
   private