hydra-head 4.0.0 → 4.0.1

data/app/helpers/hydra/facets_helper_behavior.rb

@@ -7,7 +7,7 @@ module Hydra
       content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected")
     end
 
-    # @override to remove the label class (easier integration with bootstrap)
+    # Override to remove the label class (easier integration with bootstrap)
     # and handles arrays
     def render_facet_value(facet_solr_field, item, options ={})    
       if item.is_a? Array

data/app/helpers/hydra/hydra_helper_behavior.rb

@@ -163,7 +163,7 @@ module Hydra::HydraHelperBehavior
   
 
   def render_all_workflow_steps
-    "#{all_edit_partials.map{|partial| render partial}}"
+    all_edit_partials.map{|partial| render partial}.join
   end
   
   def submit_name

data/app/helpers/hydra/javascript_includes_helper_behavior.rb

@@ -74,10 +74,6 @@ module Hydra::JavascriptIncludesHelperBehavior
     javascript_includes << ["jquery.jeditable.mini.js", "date-picker/js/datepicker", "jquery.form.js", 'custom', "catalog/edit", "jquery.hydraMetadata.js", "jquery.notice.js", {:plugin=>"hydra-head"}]
     # For DatePicker
     javascript_includes << ["jquery.ui.widget.js","jquery.ui.datepicker.js", "mediashelf.datepicker.js", {:plugin=>"hydra-head" }]
-    
-    # For Fancybox
-    javascript_includes << ["fancybox/jquery.fancybox-1.3.1.pack.js", {:plugin=>"hydra-head"}] 
-    stylesheet_links << ["/javascripts/fancybox/jquery.fancybox-1.3.1.css", {:plugin=>"hydra-head"}] 
 
     # For slider controls 
     javascript_includes << ["select_to_ui_slider/selectToUISlider.jQuery.js", {:plugin=>"hydra-head"}] 

data/app/models/ability.rb

@@ -1,3 +1,4 @@
+# Allows you to use CanCan to control access to Models
 class Ability
   include CanCan::Ability
   include Hydra::Ability

data/app/models/common_metadata_asset.rb

@@ -1,6 +1,12 @@
-# A Basic Model for Assets that conform to Hydra commonMetadata cModel and have basic MODS metadata (currently "Article" is the MODS exemplar)
+# @deprecated This is intended as an EXAMPLE of mixing in model behavior and will be moved to hydra-wiki documentation.  This will be removed no later than 6.x
+# EXAMPLE of a basic model that conforms to Hydra commonMetadata cModel and has basic MODS metadata (currently "Article" is the MODS exemplar)
 class CommonMetadataAsset < ActiveFedora::Base
   
+  def initialize
+    ActiveSupport::Deprecation.warn("CommonMetadataAsset is deprecated and will be removed in release 5 or 6;  this exemplar code has been moved into wiki documentation here:  https://github.com/projecthydra/hydra-head/wiki/Models---Some-Examples")
+    super
+  end
+  
   # declares a rightsMetadata datastream with type Hydra::Datastream::RightsMetadata
   #  basically, it is another expression of
   #  has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata

data/app/models/generic_content.rb

@@ -1,12 +1,16 @@
+# GenericContent:  EXAMPLE Model that conforms to the Hydra genericContent and genericMetadata cModels 
 class GenericContent < ActiveFedora::Base
 
   # Uses the Hydra Rights Metadata Schema for tracking access permissions & copyright
+  #  FIXME:  should this have   "include Hydra::ModelMixins::CommonMetadata" instead?
   has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata 
 
+  # Uses the GenericContent mixin to conform to the Hydra genericContent cModel
   include Hydra::GenericContent
+  
   has_metadata :name => "descMetadata", :type => Hydra::Datastream::ModsGenericContent
 
-  # A place to put extra metadata values
+  # A place to put extra metadata values, e.g. the user id of the object depositor (for permissions)
   has_metadata :name => "properties", :type => Hydra::Datastream::Properties
   
   # adds helpful methods for basic hydra objects.  

data/app/models/generic_image.rb

@@ -1,4 +1,5 @@
-# GenericImage
+# GenericImage: 
+#   EXAMPLE Model that conforms to the Hydra genericImage, genericMetadata and genericContent cModels
 #
 # Default content datastreams: content, original (optional), max, thumbnail, screen
 #
@@ -41,16 +42,19 @@ require 'hydra'
 
 class GenericImage < ActiveFedora::Base
 
+  # Uses the GenericImage mixin to conform to the Hydra genericImage cModel (auto-includes on GenericContent behaviors)
+  include Hydra::GenericImage
+
   # adds helpful methods for basic hydra objects
   include Hydra::ModelMethods
   
   # Uses the Hydra Rights Metadata Schema for tracking access permissions & copyright
+  #  FIXME:  should this have   "include Hydra::ModelMixins::CommonMetadata" instead?
   has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata 
 
-  include Hydra::GenericImage
   has_metadata :name => "descMetadata", :type => Hydra::Datastream::ModsImage
   
-  # A place to put extra metadata values
+  # A place to put extra metadata values, e.g. the user id of the object depositor (for permissions)
   has_metadata :name => "properties", :type => Hydra::Datastream::Properties
   
   def initialize( attrs={} )

data/app/models/hydra/ability.rb

@@ -1,3 +1,5 @@
+# this code will move to lib/hydra/access_controls/ability.rb (with the appropriate namespace changes) in Hydra 5.0
+# Code for CanCan access to Hydra models
 module Hydra::Ability
   include Hydra::AccessControlsEnforcement
 

data/app/models/hydra/datastream/common_mods_index_methods.rb

@@ -1,5 +1,7 @@
 # Provides some helper methods for indexing compound or non-standard facets
 #
+# this code will move to lib/hydra/datastream/mods_name_behavior.rb (with the appropriate namespace changes) in Hydra 5.0
+#
 # == Methods
 # 
 # extract_person_full_names

data/app/models/hydra/datastream/mods_article.rb

@@ -1,3 +1,5 @@
+# @deprecated Leftover from Hydrangea.  Please use Hydra::Datastream::ModsGenericContent instead.  This will be removed no later than release 6.x
+# this should be moved to documentation as an EXAMPLE
 module Hydra
   module Datastream
     class ModsArticle < ActiveFedora::NokogiriDatastream       

data/app/models/hydra/datastream/mods_dataset.rb

@@ -1,7 +1,14 @@
+# @deprecated Leftover from Hydrangea work;  this should be moved to documentation as an EXAMPLE, and will be removed no later than release 6.x
 module Hydra
   module Datastream
     class ModsDataset < ActiveFedora::NokogiriDatastream
       include Hydra::Datastream::CommonModsIndexMethods
+      
+      def initialize
+        ActiveSupport::Deprecation.warn("Hydra:Datastream:ModsDataset is deprecated and will be removed in release 5 or 6.  It has been moved into wiki documentation here:  https://github.com/projecthydra/hydra-head/wiki/Models---Some-Examples")
+        super
+      end
+      
       set_terminology do |t|
         t.root(:path=>"mods", :xmlns=>"http://www.loc.gov/mods/v3", :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd")
 

data/app/models/hydra/datastream/mods_generic_content.rb

@@ -1,3 +1,5 @@
+# Datastream that uses a Generic MODS Terminology;  essentially an exemplar.
+# this class will be renamed to Hydra::Datastream::ModsBasic in Hydra 5.0
 module Hydra
   module Datastream
   class ModsGenericContent < ActiveFedora::NokogiriDatastream       

data/app/models/hydra/datastream/mods_image.rb

@@ -1,3 +1,4 @@
+# @deprecated Leftover app-specific code from Hydrangea or Hydra at Hull.  Please use Hydra::Datastream::ModsGenericContent instead.
 module Hydra
   module Datastream
     class ModsImage < ActiveFedora::NokogiriDatastream       

data/app/models/hydra/datastream/properties.rb

@@ -1,10 +1,15 @@
+# properties datastream: catch-all for info that didn't have another home.  Particularly depositor.
 module Hydra::Datastream
   class Properties < ActiveFedora::NokogiriDatastream
     set_terminology do |t|
       t.root(:path=>"fields", :xmlns => '', :namespace_prefix => nil) 
 
-      t.collection :xmlns => '', :namespace_prefix => nil
+      # This is where we put the user id of the object depositor -- impacts permissions/access controls
       t.depositor :xmlns => '', :namespace_prefix => nil
+
+      # @deprecated:  Collection should be tracked in RELS-EXT RDF.  collection term will be removed no later than release 6.x
+      t.collection :xmlns => '', :namespace_prefix => nil
+      # @deprecated:  Title should be tracked in descMetadata.  title term will be removed no later than release 6.x
       t.title :xmlns => '', :namespace_prefix => nil
     end
 

data/app/models/hydra/datastream/rights_metadata.rb

@@ -1,5 +1,6 @@
 module Hydra
   module Datastream
+    # Implements Hydra RightsMetadata XML terminology for asserting access permissions
     class RightsMetadata < ActiveFedora::NokogiriDatastream       
       
       set_terminology do |t|

data/app/models/hydra/role_mapper_behavior.rb

@@ -1,3 +1,4 @@
+# this code will be moved/renamed to Hydra::AccessControl::RoleMapperBehavior (with the appropriate namespace changes) in Hydra 5.0
 require 'yaml'
 module Hydra::RoleMapperBehavior
   extend ActiveSupport::Concern

data/app/models/mods_asset.rb

@@ -1,4 +1,4 @@
-# A Basic Model for Assets that conform to Hydra commonMetadata cModel and have basic MODS metadata (currently "Article" is the MODS exemplar)
+# An EXAMPLE   Basic Model for Assets that conform to Hydra commonMetadata cModel and have basic MODS metadata (currently "Article" is the MODS exemplar)
 class ModsAsset < ActiveFedora::Base
   
   # declares a rightsMetadata datastream with type Hydra::Datastream::RightsMetadata

data/app/models/role_mapper.rb

@@ -1,3 +1,6 @@
+# RoleMapper This is used by AccessControlsEnforcement to get users' Roles (used in access permissions)
+# If you are using something like Shibboleth or LDAP to get users' Roles, you should override this Class.  
+# Your override should include a Module that implements the same behaviors as Hydra::RoleMapperBehavior 
 class RoleMapper
   include Hydra::RoleMapperBehavior
 end

data/app/models/superuser.rb

@@ -1,6 +1,12 @@
+# @deprecated - we are moving away from this approach; this code will be removed no later than release 6.x 
 # To make a superuser record, look up the ID (not the login) of a previously created user,
 # and then insert that id into the superusers table
 class Superuser < ActiveRecord::Base
   belongs_to :user
     
+  def initialize
+    ActiveSupport::Deprecation.warn("Superuser is deprecated and will be removed in release 5 or 6; we are moving away from this approach.")
+    super
+  end
+
 end

data/app/models/user_attribute.rb

@@ -1,6 +1,12 @@
+# @deprecated - from the original implementation of UVA's Libra.  This type of behavior should be application-specific.  This will be removed no later than release 6.x
 class UserAttribute < ActiveRecord::Base
   belongs_to :user
 
+  def initialize
+    ActiveSupport::Deprecation.warn("UserAttribute is deprecated and will be removed in release 5 or 6;  this behavior should be implemented at the app level.")
+    super
+  end
+
 
 # Finds the user_attributes based on login
 # @param [sting] login the login of the user

data/app/models/uses_default_partials.rb

@@ -1,11 +1,19 @@
+# TODO: Move TO test_support
 # this model exists largely to exercise the default partials for models that don't have their own
 #   that is, if an (active)fedora object uses the ModsAsset model, then hydra-head will use partials in views/mods_assets to display those objects
 #   however, if an (active)fedora object uses a model without its own partials in the views folder, then hydra-head will use views/catalog/xxx  to display those objects.
 # a Fedora object for the Hypatia SET hydra content type
 class UsesDefaultPartials < ActiveFedora::Base
   
+  def initialize
+    ActiveSupport::Deprecation.warn("UsesDefaultPartials is for testing only.  It will be moved into test_support")
+    super
+  end
+
   has_metadata :name => "descMetadata", :type => Hydra::Datastream::ModsGenericContent
   
+  # Uses the Hydra Rights Metadata Schema for tracking access permissions & copyright
+  #  FIXME:  should this have   "include Hydra::ModelMixins::CommonMetadata" instead?
   has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata
 
   # adds helpful methods for basic hydra objects.  

data/app/views/catalog/_delete_partials/_default.html.erb

@@ -1,12 +1,5 @@
 <%# default partial to delete display solr document fields in catalog show view -%>
 
-<%- stylesheet_links << "../plugin_assets/hydra-head/javascripts/date-picker/css/datepicker" %>
-<%- stylesheet_links << "../plugin_assets/hydra-head/javascripts/fancybox/jquery.fancybox-1.3.1.css" %>
-<%- stylesheet_links << ["../plugin_assets/hydra-head/javascripts/select_to_ui_slider/css/ui.slider.extras.css"] %>
-<%- stylesheet_links << ["slider", {:plugin=>"hydra-head"}] %>
-
-
-
 <div class="document_viewer" id="cover_container">
 	<div id="delete_dialog">
 		<div id="delete_dialog_container">
@@ -18,8 +11,8 @@
 	      </div>
 				
 					<div>
-					<%= button_to("Delete", {:action => :destroy, :controller => :assets, :id => @document['id'] }, :confirm => 'Are you sure?', :method => :delete )%>
-					 <%= button_to("Withdraw", :action=>"withdraw", :controller => :assets, :id => @document['id'] ) %>
+					<%= button_to("Delete", hydra_asset_path(@document['id']), :confirm => 'Are you sure?', :method => :delete )%>
+					 <%= button_to("Withdraw", withdraw_path(:id => @document['id']) ) %>
 					 <%= button_to("Cancel", :action=>:edit, :controller => :catalog, :id => @document['id'] ) %>
 					
 	      </div>

data/app/views/catalog/_edit_partials/_default.html.erb

@@ -1,7 +1,6 @@
 <%# default partial to display solr document fields in catalog show view -%>
 
 <%- stylesheet_links << "../plugin_assets/hydra-head/javascripts/date-picker/css/datepicker" %>
-<%- stylesheet_links << "../plugin_assets/hydra-head/javascripts/fancybox/jquery.fancybox-1.3.1.css" %>
 <%- stylesheet_links << ["../plugin_assets/hydra-head/javascripts/select_to_ui_slider/css/ui.slider.extras.css"] %>
 <%- stylesheet_links << ["../plugin_assets/hydra-head/stylesheets/slider.css"] %>
 

data/app/views/catalog/show.html.erb

@@ -35,6 +35,6 @@
 </div>
 <% if controller.action_name == "edit" %>
   <div class="delete-asset">
-    <%= button_to("Delete This Item", {:action => :destroy, :controller => :assets, :id => @document_fedora.pid}, :confirm => 'Are you sure?', :method => :delete )%>
+    <%= button_to("Delete This Item", {:action => :destroy, :controller => :"hydra/assets", :id => @document_fedora.pid}, :confirm => 'Are you sure?', :method => :delete )%>
   </div>
 <% end %>

data/app/views/generic_content_objects/_edit_description.html.erb

@@ -1,7 +1,7 @@
   <input type="hidden" name="_method" value="put"/>
   <input class="content_type" type="hidden" name="content_type" value="mods_asset" />
   
-  <p id="title_field" class="fedora-text-field"><%= fedora_field_label("descMetadata", [:title_info, :main_title], "Title:") %>
+  <p id="title_field" class="fedora-text-field"><%= fedora_field_label("descMetadata", [:title_info, :main_title], "Title: <span class=\"required-note\">required</span>".html_safe) %>
     <%= fedora_text_field(@document_fedora,"descMetadata", [:title_info, :main_title], :multiple=>false, :required=>true) %></p>
   <p id="language_field" class="fedora-text-field"><%= fedora_field_label("descMetadata", [:title_info, :language], "Language:") %>
     <%= fedora_text_field(@document_fedora, "descMetadata", [:title_info, :language], :multiple=>false, :required=>false ) %></p>  

data/app/views/generic_content_objects/_show_description.html.erb

@@ -39,5 +39,3 @@
   <% end %>
 
 </dl>
-
-</form>

data/app/views/generic_contents/_edit.html.erb

@@ -1 +1,10 @@
-<%= render_submission_workflow_step -%>
+<% if !session[:scripts] %>
+  <%= render_previous_workflow_steps.html_safe %>
+  <%= render_submission_workflow_step -%>
+<% else %>
+  <%= render_all_workflow_steps.html_safe %>
+  <div class="all-steps-actions">
+    <button id="all_save_continue" name="all_save_continue">Save and Continue Editing</button>
+    <button id="all_save_finish" name="all_save_finish">Save and Finish</button>
+  </div>
+<% end %>

data/app/views/generic_contents/_show.html.erb

@@ -1,5 +1,3 @@
-<% stylesheet_links << "/plugin_assets/hydra-head/javascripts/fancybox/jquery.fancybox-1.3.1.css" %>
-
 <div class="document_viewer" id="cover_container">
   
   <h2 class="section-title">Description</h2>

data/app/views/generic_images/_edit.html.erb

@@ -32,7 +32,5 @@
     </form>
   </div>
 </div>
-<% sidebar_items << capture do %>
-  <%= delete_asset_link(params[:id], "GenericImage") %>
-<% end %>
+
 <%= async_load_tag(generic_content_object_path(params[:id], :layout=>"false", :method => ":get"), 'uploads') %>

data/app/views/generic_images/_show.html.erb

@@ -1,5 +1,3 @@
-<% stylesheet_links << "/plugin_assets/hydra-head/javascripts/fancybox/jquery.fancybox-1.3.1.css" %>
-
 <div class="document_viewer" id="cover_container">
 
 		<h2 class="section-title">Description</h2>

data/app/views/hydra/file_assets/_result.html.erb

@@ -5,8 +5,7 @@
   <td>
 	
    <% if can? :edit, @document %>
-    	<%= button_to("Delete", "/file_assets/" + result["id"] + "?container_id=" + @document[:id], :confirm => "Are you sure you want to delete this file?", :method => :delete, :class => "delete-button") %>
-
+    	<%= button_to("Delete", "/hydra/assets/#{result["id"]}/file_assets/#{result["id"]}?container_id=#{@document[:id]}", :confirm => "Are you sure you want to delete this file?", :method => :delete, :class => "delete-button") %>
    <% end %>
   </td>
 </tr>

data/config/fedora.yml

@@ -5,7 +5,7 @@ development:
 test: &TEST  
   user: fedoraAdmin
   password: fedoraAdmin
-  url: http://127.0.0.1:8983/fedora
+  url: http://127.0.0.1:8983/fedora-test
 production:
   user: fedoraAdmin
   password: fedoraAdmin

data/fedora_conf/conf/development/fedora.fcfg

@@ -156,7 +156,7 @@
     	context-appropriate DOReaders and DOWriters for reflecting on and 
     	writing to the objects stored in the repository. It also provides 
     	methods for reflecting on the contents of the repository as a whole..</comment>
-    <param name="pidNamespace" value="hydrangea">
+    <param name="pidNamespace" value="hydra">
       <comment>This is the namespace id for pids of newly-created objects. 
 	    	This should be unique for a repository. It can be from 1 to 17 
 	    	characters, and may only contain A-Z, a-z, 0-9, &apos;.&apos;, or &apos;-&apos; (dash).</comment>

data/fedora_conf/conf/test/fedora.fcfg

@@ -156,7 +156,7 @@
     	context-appropriate DOReaders and DOWriters for reflecting on and 
     	writing to the objects stored in the repository. It also provides 
     	methods for reflecting on the contents of the repository as a whole..</comment>
-    <param name="pidNamespace" value="hydrangea">
+    <param name="pidNamespace" value="hydra">
       <comment>This is the namespace id for pids of newly-created objects. 
 	    	This should be unique for a repository. It can be from 1 to 17 
 	    	characters, and may only contain A-Z, a-z, 0-9, &apos;.&apos;, or &apos;-&apos; (dash).</comment>

data/hydra-head.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'block_helpers'
   s.add_dependency 'sanitize'
   s.add_dependency 'cancan'
+  s.add_dependency 'jquery-rails'
   
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'yard'
@@ -27,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'cucumber-rails', '>=1.2.0'
-  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'factory_girl', "~> 2.6.0"
   s.add_development_dependency 'solrizer-fedora', '>=2.0.0'
 
 

data/lib/application_helper.rb

@@ -1,2 +1,3 @@
+# Needed for testing
 module ApplicationHelper
 end

data/lib/generators/hydra/templates/config/fedora.yml

@@ -5,7 +5,7 @@ development:
 test: &TEST  
   user: fedoraAdmin
   password: fedoraAdmin
-  url: http://127.0.0.1:8983/fedora
+  url: http://127.0.0.1:8983/fedora-test
 production:
   user: fedoraAdmin
   password: fedoraAdmin

data/lib/generators/hydra/templates/config/initializers/hydra_config.rb

@@ -13,18 +13,7 @@ User.send(:include, Hydra::GenericUserAttributes)
 
 if Hydra.respond_to?(:configure)
   Hydra.configure(:shared) do |config|
-  
-    # This is used as a reference by choose_model_by_filename in FileAssetsHelper
-    config[:file_asset_types] = {
-      # MZ -This can only be enabled if/when we adopt replacements for ImageAsset, AudioAsset, etc. as default primitives.
-      # :default => FileAsset, 
-      # :extension_mappings => {
-      #   AudioAsset => [".wav", ".mp3", ".aiff"] ,
-      #   VideoAsset => [".mov", ".flv", ".mp4", ".m4v"] ,
-      #   ImageAsset => [".jpeg", ".jpg", ".gif", ".png"] 
-      # }
-    }
-    
+
     config[:submission_workflow] = {
         :mods_assets =>      [{:name => "contributor",     :edit_partial => "mods_assets/contributor_form",     :show_partial => "mods_assets/show_contributors"},
                               {:name => "publication",     :edit_partial => "mods_assets/publication_form",     :show_partial => "mods_assets/show_publication"},