hydra-head 4.0.1 → 4.0.2

data/.gitmodules

@@ -1,3 +1,4 @@
 [submodule "jetty"]
 	path = jetty
 	url = git://github.com/projecthydra/hydra-jetty.git
+	ignore = dirty

data/HISTORY.textile

@@ -1,3 +1,9 @@
+h3. 4.1.0
+* Upgrade to active fedora 4.1.0
+* Upgrade to solrizer-fedora 2.1.0
+* Upgrade to blacklight 3.4.1 
+* Improved access controls api
+
 h3. 4.0.0
 * Upgrade to active fedora 4.0.0
 * Upgrade to blacklight 3.3.0 

data/app/assets/stylesheets/hydra/styles.css

@@ -100,7 +100,7 @@ button.ui-button-icon-only {
 }
 
 a:link, a:visited, a:active, #uvalicense_read_all {
-    color: blue
+    color: blue;
     text-decoration: underline;
     border: none;
 }

data/app/controllers/user_sessions_controller.rb

@@ -4,7 +4,7 @@ class UserSessionsController < ApplicationController
   def superuser
     if session[:superuser_mode]
       session[:superuser_mode] = nil
-    elsif current_user.can_be_superuser?
+    elsif Deprecation.silence(Hydra::SuperuserAttributes) { current_user.can_be_superuser? }
       session[:superuser_mode] = true
     end
     redirect_to :back

data/app/helpers/hydra/application_helper_behavior.rb

@@ -1,7 +1,5 @@
-#require "hydra_helper"
 module Hydra
   module ApplicationHelperBehavior
-    include HydraHelper
     
     def application_name
       'A Hydra Head'

data/app/helpers/hydra/blacklight_helper_behavior.rb

@@ -1,14 +1,12 @@
-require "hydra_helper"
-require 'blacklight/blacklight_helper_behavior'
-
+require 'deprecation'
 module Hydra
   module BlacklightHelperBehavior
+    extend Deprecation
     include Blacklight::BlacklightHelperBehavior
-    include HydraHelper
+    
+    self.deprecation_horizon = 'hydra-head 5.x'
     
     def get_data_with_linked_label(doc, label, field_string, opts={})
-      ActiveSupport::Deprecation.warn("get_data_with_linked_label is deprecated and will be removed in the next release")
-     
       (opts[:default] and !doc[field_string]) ? field = opts[:default] : field = doc[field_string]
       delim = opts[:delimiter] ? opts[:delimiter] : "<br/>"
       if doc[field_string]
@@ -24,11 +22,12 @@ module Hydra
         text
       end
     end
+    deprecation_deprecate :get_data_with_linked_label
     
     def linked_label(field, field_string)
-      ActiveSupport::Deprecation.warn("linked_label is deprecated and will be removed in the next release")
       link_to(field, add_facet_params(field_string, field).merge!({"controller" => "catalog", :action=> "index"}))
     end
+    deprecation_deprecate :linked_label
 
     # currently only used by the render_document_partial helper method (below)
     def document_partial_name(document)
@@ -44,19 +43,17 @@ module Hydra
     end
     
     def render_complex_facet_value(facet_solr_field, item, options ={})    
-      ActiveSupport::Deprecation.warn("render_complex_facet_value is deprecated and will be removed in the next release")
       link_to_unless(options[:suppress_link], format_item_value(item.value), add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " (" + format_num(item.hits) + ")" 
     end
+    deprecation_deprecate :render_complex_facet_value
 
     def render_journal_facet_value(facet_solr_field, item, options ={})
-      ActiveSupport::Deprecation.warn("render_journal_facet_value is deprecated and will be removed in the next release")
-
       val = item.value.strip.length > 12 ? item.value.strip[0..12].concat("...") : item.value.strip
       link_to_unless(options[:suppress_link], val, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " (" + format_num(item.hits) + ")" 
     end
+    deprecation_deprecate :render_journal_facet_value
 
     def render_complex_facet_image(facet_solr_field, item, options = {})
-      ActiveSupport::Deprecation.warn("render_complex_facet_image is deprecated and will be removed in the next release")
       computing_id = extract_computing_id(item.value)
       if File.exists?("#{Rails.root}/public/images/faculty_images/#{computing_id}.jpg")
         img = image_tag "/images/faculty_images/#{computing_id}.jpg", :width=> "100", :alt=>"#{item.value}"
@@ -65,9 +62,9 @@ module Hydra
       end
       link_to_unless(options[:suppress_link], img, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select facet_image") 
     end
+    deprecation_deprecate :render_complex_facet_image
 
     def render_journal_image(facet_solr_field, item, options = {})
-      ActiveSupport::Deprecation.warn("render_journal_image is deprecated and will be removed in the next release")
       if File.exists?("#{Rails.root}/public/images/journal_images/#{item.value.strip.downcase.gsub(/\s+/,'_')}.jpg")
         img = image_tag "/images/journal_images/#{item.value.strip.downcase.gsub(/\s+/,'_')}.jpg", :width => "100"
       else
@@ -76,9 +73,9 @@ module Hydra
 
       link_to_unless(options[:suppress_link], img, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") 
     end
+    deprecation_deprecate :render_journal_image
 
     def get_randomized_display_items items
-      ActiveSupport::Deprecation.warn("get_randomized_display_items is deprecated and will be removed in the next release")
       clean_items = items.each.inject([]) do |array, item|
         array << item unless item.value.strip.blank?
         array
@@ -90,17 +87,16 @@ module Hydra
         rdi = clean_items.sort_by {rand}.slice(0..5)
         return rdi.sort_by {|item| item.value.downcase}
       end
-
     end
+    deprecation_deprecate :get_randomized_display_items
 
     def extract_computing_id val
-      ActiveSupport::Deprecation.warn("extract_computing_id is deprecated and will be removed in the next release")
       cid = val.split(" ")[-1]
       cid[1..cid.length-2]
     end
+    deprecation_deprecate :extract_computing_id
 
     def format_item_value val
-      ActiveSupport::Deprecation.warn("format_item_value is deprecated and will be removed in the next release")
       begin
         last, f_c = val.split(", ")
         first = f_c.split(" (")[0]
@@ -109,6 +105,7 @@ module Hydra
       end
       [last, "#{first[0..0]}."].join(", ")
     end
+    deprecation_deprecate :format_item_value
 
   #   COPIED from vendor/plugins/blacklight/app/helpers/application_helper.rb
     # Used in catalog/facet action, facets.rb view, for a click

data/app/helpers/hydra/generic_content_objects_helper_behavior.rb

@@ -1,12 +1,7 @@
 module Hydra::GenericContentObjectsHelperBehavior
   
   def datastream_disseminator_url pid, datastream_name
-    begin
-      base_url = Fedora::Repository.instance.send(:connection).site.to_s
-    rescue
-      base_url = "http://localhost:8983/fedora"
-    end
-    "#{base_url}/get/#{pid}/#{datastream_name}"
+    ActiveFedora::Base.connection_for_pid(pid).client.url + "/get/#{pid}/#{datastream_name}"
   end
   
   def disseminator_link pid, datastream_name

data/app/helpers/hydra/hydra_fedora_metadata_helper_behavior.rb

@@ -44,13 +44,15 @@ module Hydra::HydraFedoraMetadataHelperBehavior
       field_values = [field_values.first]
       container_tag_type = :span
     end
+    required = opts.fetch(:required, true) ? "required" : ""
+    
     body = ""
     
     field_values.each_with_index do |current_value, z|
       base_id = generate_base_id(field_name, current_value, field_values, opts)
       name = "asset[#{datastream_name}][#{field_name}][#{z}]"
       processed_field_value = Sanitize.clean( RedCloth.new(current_value, [:sanitize_html]).to_html, Sanitize::Config::BASIC)
-        body << "<textarea class=\"editable-edit edit\" id=\"#{base_id}\" data-datastream-name=\"#{datastream_name}\" name=\"#{name}\" rows=\"10\" cols=\"25\">#{h(current_value.strip)}</textarea>"
+        body << "<textarea class=\"editable-edit edit\" id=\"#{base_id}\" data-datastream-name=\"#{datastream_name}\" name=\"#{name}\" #{required} rows=\"10\" cols=\"25\">#{h(current_value.strip)}</textarea>"
         body << "<a href=\"\" title=\"Delete '#{h(current_value)}'\" class=\"destructive field\">Delete</a>" unless z == 0
     end
     

data/app/helpers/hydra/personalization_helper_behavior.rb

@@ -35,7 +35,7 @@ module Hydra::PersonalizationHelperBehavior
 
   # Retrieves an attribute from the user
   # @param [string] login the login of the user
-  # @param [string] the name of the attribute: out of the box values are first_name, last_name, full_name, affiliation, and photo
+  # @param [string] attribute the name of the attribute: out of the box values are first_name, last_name, full_name, affiliation, and photo
   def get_user_attribute login, attribute
     user = User.find_by_login(login) 
     user.nil? ? "" : user.send(attribute.to_sym)

data/app/models/common_metadata_asset.rb

@@ -3,7 +3,7 @@
 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")
+    ActiveSupport::Deprecation.warn("CommonMetadataAsset is deprecated and will be removed from HydraHead 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
   

data/app/models/hydra/ability.rb

@@ -24,7 +24,7 @@ module Hydra::Ability
 
   def hydra_default_permissions(user, session)
     logger.debug("Usergroups are " + user_groups(user, session).inspect)
-    if user.is_being_superuser?(session)
+    if Deprecation.silence(Hydra::SuperuserAttributes) { user.is_being_superuser?(session) }
       can :manage, :all
     else
       edit_permissions(user, session)

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

@@ -7,9 +7,9 @@ module Hydra::Datastream
       # 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
+      # @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
+      # @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

@@ -122,14 +122,14 @@ module Hydra
       end
       
       # Updates permissions for all of the persons and groups in a hash
-      # @param ex. {"group"=>{"group1"=>"discover","group2"=>"edit"}, "person"=>{"person1"=>"read","person2"=>"discover"}}
+      # @param params ex. {"group"=>{"group1"=>"discover","group2"=>"edit"}, "person"=>{"person1"=>"read","person2"=>"discover"}}
       # Currently restricts actor type to group or person.  Any others will be ignored
       def update_permissions(params)
         params.fetch("group", {}).each_pair {|group_id, access_level| self.permissions({"group"=>group_id}, access_level)}
         params.fetch("person", {}).each_pair {|group_id, access_level| self.permissions({"person"=>group_id}, access_level)}
       end
       
-      # @param [Symbol] symbol (either :group or :person)
+      # @param [Symbol] type (either :group or :person)
       # @return 
       # This method limits the response to known access levels.  Probably runs a bit faster than .permissions().
       def quick_search_by_type(type)

data/app/models/mods_asset.rb

@@ -5,6 +5,9 @@ class ModsAsset < ActiveFedora::Base
   #  basically, it is another expression of
   #  has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata
   include Hydra::ModelMixins::CommonMetadata
+
+  ## Convenience methods for manipulating the rights metadata datastream
+  include Hydra::ModelMixins::RightsMetadata
   
   # declares a descMetadata datastream with type Hydra::Datastream::ModsArticle
   #  basically, it is another expression of

data/app/models/superuser.rb

@@ -5,7 +5,7 @@ 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.")
+    ActiveSupport::Deprecation.warn("Superuser is deprecated and will be removed from HydraHead in release 5 or 6; we are moving away from this approach.")
     super
   end
 

data/app/models/user_attribute.rb

@@ -3,7 +3,7 @@ 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.")
+    ActiveSupport::Deprecation.warn("UserAttribute is deprecated and will be removed from HydraHead in release 5 or 6;  this behavior should be implemented at the app level.")
     super
   end
 
@@ -12,6 +12,7 @@ class UserAttribute < ActiveRecord::Base
 # @param [sting] login the login of the user
 # @return the user attribute object or nil
  def self.find_by_login(login)
+    ActiveSupport::Deprecation.warn("UserAttribute.find_by_login is deprecated and will be removed from HydraHead in release 5 or 6;  this behavior should be implemented at the app level.")
     user = User.find_by_login(login)
     if user
       UserAttribute.find_by_user_id(user.id)

data/app/models/uses_default_partials.rb

@@ -12,9 +12,10 @@ class UsesDefaultPartials < ActiveFedora::Base
 
   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
+  # declares a rightsMetadata datastream with type Hydra::Datastream::RightsMetadata
+  #  basically, it is another expression of
+  #  has_metadata :name => "rightsMetadata", :type => Hydra::Datastream::RightsMetadata
+  include Hydra::ModelMixins::CommonMetadata
 
   # adds helpful methods for basic hydra objects.  
   include Hydra::ModelMethods

data/app/views/_user_util_links.html.erb

@@ -2,8 +2,8 @@
 
     <%= render :partial=>"/add_assets_links" %>
   
-    <% if current_user.can_be_superuser? %>
-      <% if current_user.is_being_superuser?(session) %>
+    <% if Deprecation.silence(Hydra::SuperuserAttributes) { current_user.can_be_superuser? } %>
+      <% if Deprecation.silence(Hydra::SuperuserAttributes) { current_user.is_being_superuser?(session) } %>
         <%= link_to "Stop being superuser", superuser_path %>
       <% else %>
         <%= link_to "Become superuser", superuser_path %>

data/config/fedora.yml

@@ -1,3 +1,4 @@
+# For given rails environment, what is the fedora url, admin user and password?
 development:
   user: fedoraAdmin
   password: fedoraAdmin

data/config/solr.yml

@@ -1,5 +1,4 @@
-# This is a sample config file that does not have multiple solr instances. You will also need to be sure to
-# edit the fedora.yml file to match the solr URL for active-fedora. 
+# For given rails environment, what is the Solr url?
 development:
   url: http://localhost:8983/solr/development
 test: &TEST

data/hydra-head.gemspec

@@ -12,14 +12,15 @@ Gem::Specification.new do |s|
   s.summary     = %q{Hydra-Head Rails Engine (requires Rails3) }
   s.description = %q{Hydra-Head is a Rails Engine containing the core code for a Hydra application. The full hydra stack includes: Blacklight, Fedora, Solr, active-fedora, solrizer, and om}
 
-  s.add_dependency "rails", '3.2.3' 
-  s.add_dependency "blacklight", '~>3.3.2'  
+  s.add_dependency "rails", '~>3.2.3' 
+  s.add_dependency "blacklight", '~>3.4.2'  
   s.add_dependency "devise"
-  s.add_dependency "active-fedora", '~>4.0.0'
+  s.add_dependency "active-fedora", '~>4.1'
   s.add_dependency 'RedCloth', '=4.2.9'
   s.add_dependency 'block_helpers'
   s.add_dependency 'sanitize'
   s.add_dependency 'cancan'
+  s.add_dependency 'deprecation'
   s.add_dependency 'jquery-rails'
   
   s.add_development_dependency 'sqlite3'
@@ -29,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'cucumber-rails', '>=1.2.0'
   s.add_development_dependency 'factory_girl', "~> 2.6.0"
-  s.add_development_dependency 'solrizer-fedora', '>=2.0.0'
+  s.add_development_dependency 'solrizer-fedora', '>=2.1.0'
 
 
   s.files         = `git ls-files`.split("\n")

data/lib/generators/hydra/head_generator.rb

@@ -100,7 +100,7 @@ EOF
         "\n include Hydra::User\n"        
       end
     else
-      puts "     \e[31mFailure\e[0m  Hydra requires a user object in order to apply access controls. This generators assumes that the model is defined in the file /app/models/user.rb, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g hydra:head client" 
+      puts "     \e[31mFailure\e[0m  Hydra requires a user object in order to apply access controls. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g hydra:head client" 
     end    
   end
   

data/lib/generators/hydra/hyhead_fixtures_generator.rb

@@ -1,27 +1,27 @@
 # -*- encoding : utf-8 -*-
 require 'rails/generators'
-require 'rails/generators/migration'     
+require 'rails/generators/migration'
 
 module Hydra
 class HyheadFixturesGenerator < Rails::Generators::Base
-  
+
   source_root File.expand_path('../../../../', __FILE__)
-        
+
   desc """
   This Generator copies the hydra-head sample/test objects into your application's test_support/fixtures directory
-  These objects are useful for getting a sense of how hydra works, but you will want to delete them and create your own 
+  These objects are useful for getting a sense of how hydra works, but you will want to delete them and create your own
   fixtures to run your application's tests against.
-  
+
   After running this generator, you can import your fixtures into fedora & solr by running
-  
+
   rake hydra:fixtures:refresh
   rake hydra:fixtures:refresh RAILS_ENV=test
-  
+
   """
-  
+
   def copy_hyhead_fixtures
-    directory("test_support/fixtures", "test_support/fixtures")
+    directory("test_support/fixtures", "spec/fixtures")
   end
-  
+
 end
 end

data/lib/hydra-head/engine.rb

@@ -1,7 +1,6 @@
 require "hydra-head"
 require "rails"
 require 'action_controller'
-require 'application_helper'
 module HydraHead
 
    class Engine < Rails::Engine

data/lib/hydra-head/version.rb

@@ -1,4 +1,4 @@
 module HydraHead
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 end
 

data/lib/hydra/access_controls_enforcement.rb

@@ -198,7 +198,7 @@ module Hydra::AccessControlsEnforcement
       permission_types.each do |type|
         user_access_filters << "#{type}_access_person_t:#{user_key}"        
       end
-      if current_user.is_being_superuser?(session)
+      if Deprecation.silence(Hydra::SuperuserAttributes) { current_user.is_being_superuser?(session) }
         permission_types.each do |type|
           user_access_filters << "#{type}_access_person_t:[* TO *]"        
         end

data/lib/hydra/file_assets_helper.rb

@@ -22,9 +22,9 @@ module Hydra::FileAssetsHelper
   # 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] the File Asset to add the blob to
-  # @return [FileAsset] the File Asset  
-  def add_posted_blob_to_asset(asset,file)
+  # @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)}

data/lib/hydra/generic_content.rb

@@ -79,7 +79,7 @@ module Hydra::GenericContent
   
   # 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
-  # @param [Numeric] file size in bits
+  # @param [Numeric] num file size in bits
   def bits_to_human_readable(num)
       ['bytes','KB','MB','GB','TB'].each do |x|
         if num < 1024.0

data/lib/hydra/generic_image.rb

@@ -92,11 +92,11 @@ module Hydra::GenericImage
   end
 
   def admin_site
-    @admin_site ||= Fedora::Repository.instance.send(:connection).site.to_s.gsub(/fedora$/,"")
+    @admin_site ||=  ActiveFedora::Base.connection_for_pid(pid).client.url.gsub(/[^\/]+$/,"")
   end
 
   def datastream_url ds_name="content"
-    "#{admin_site}fedora/objects/#{pid}/datastreams/#{ds_name}/content"
+    ActiveFedora::Base.connection_for_pid(pid).client.url + "/objects/#{pid}/datastreams/#{ds_name}/content"
   end
 
 end