hydra-head 4.0.3 → 4.1.0

data/lib/hydra/access_controls_evaluation.rb

@@ -1,38 +0,0 @@
-# will move to lib/hydra/access_control folder/namespace in release 5.x
-# Provides methods for determining permissions
-# If you include this into a Controller, it will also make a number of these methods available as view helpers.
-module Hydra::AccessControlsEvaluation
-  
-  def self.included(klass)
-    if klass.respond_to?(:helper_method)
-      klass.helper_method(:editor?)
-      klass.helper_method(:reader?)
-      klass.helper_method(:test_permission?)
-    end
-  end
-  
-  # Test the current user's permissions.  This method is used by the editor? and reader? methods
-  # @param [Symbol] permission_type valid options: :edit, :read
-  # This is available as a view helper method as well as within your controllers.
-  # @example
-  #   test_permission(:edit)
-  def test_permission(permission_type)    
-    ActiveSupport::Deprecation.warn("test_permission has been deprecated. Use can? instead") 
-    can? permission_type, @permissions_solr_document
-  end
-
-  # Test whether the the current user has edit permissions.  
-  # This is available as a view helper method as well as within your controllers.
-  def editor?
-    logger.warn("editor? has been deprecated. Use can? instead")
-    can? :edit, @permissions_solr_document
-  end
-  
-  # Test whether the the current user has read permissions.  
-  # This is available as a view helper method as well as within your controllers.
-  def reader?
-    logger.warn("reader? has been deprecated. Use can? instead")
-    can? :read, @permissions_solr_document
-  end
-
-end

data/lib/hydra/common_mods_index_methods.rb

@@ -1,46 +0,0 @@
-# Provides some helper methods for indexing compound or non-standard facets
-#
-# == Methods
-# 
-# extract_person_full_names
-#   This method returns a Hash of person_full_name_facet values which combine Lastname, Firstname
-# extract_person_organizations
-#   This method returns a Hash of person_full_name_facet values which extract the persons affiliation and puts it in an mods_organization_facet
-# will be removed in release 5.x
-module Hydra::CommonModsIndexMethods
-
-  def self.included(base)
-    ActiveSupport::Deprecation.warn("Hydra::CommonModsIndexMethods has been deprecated. Use Hydra::Datastream::CommonModsIndexMethods instead")
-  end
-
-  # Extracts the first and last names of persons and creates Solr::Field objects with for person_full_name_facet
-  #
-  # == Returns:
-  # An array of Solr::Field objects
-  #
-  def extract_person_full_names
-    names = {}
-    self.find_by_terms(:person).each do |person|
-      name_parts = person.children.inject({}) do |hash,child|
-        hash[child.get_attribute(:type)] = child.text if ["family","given"].include? child.get_attribute(:type)
-        hash
-      end
-      ::Solrizer::Extractor.insert_solr_field_value(names,  "person_full_name_facet", [name_parts["family"], name_parts["given"]].join(", ") ) if name_parts.keys.sort == ["family","given"]
-      names
-    end
-    return names
-  end
-
-  # Extracts the affiliations of persons and creates Solr::Field objects for them
-  #
-  # == Returns:
-  # An array of Solr::Field objects
-  #
-  def extract_person_organizations
-    orgs = {}
-    self.find_by_terms(:person,:affiliation).each do |org| 
-      ::Solrizer::Extractor.insert_solr_field_value(orgs, "mods_organization_facet", org.text) 
-    end
-    return orgs
-  end
-end

data/lib/hydra/model_mixins/mods_object.rb

@@ -1,17 +0,0 @@
-# Include this into models to specify that the descMetadata datastream contains basic MODS metadata
-# 
-# Explicitly declares:
-#   descMetadata datastream using Hydra::Datastream::ModsArticle Terminology
-#
-# will move to lib/hydra/model/mods_object_behavior in release 5.x
-module Hydra::ModelMixins::ModsObject
-  
-  def self.included(klazz)
-    # Uses the Hydra MODS Basic profile for tracking descriptive metadata
-    klazz.has_metadata :name => "descMetadata", :type => Hydra::Datastream::ModsArticle
-    
-    # Ensure that objects assert the modsObject cModel
-    # klazz.relationships << :has_model => "info:fedora/hydra-cModel:modsObject"
-  end
-  
-end

data/lib/hydra/model_mixins/rights_metadata.rb

@@ -1,357 +0,0 @@
-module Hydra
-  module ModelMixins
-    module RightsMetadata
-
-
-      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
-      # @example
-      #  obj.permissions= [{:name=>"group1", :access=>"discover", :type=>'group'},
-      #  {:name=>"group2", :access=>"discover", :type=>'group'}]
-      def permissions=(params)
-        perm_hash = {'person' => rightsMetadata.individuals, 'group'=> rightsMetadata.groups}
-
-        params.each do |row|
-          if row[:type] == 'user'
-            perm_hash['person'][row[:name]] = row[:access]
-          else
-            perm_hash['group'][row[:name]] = row[:access]
-          end
-        end
-        
-        rightsMetadata.update_permissions(perm_hash)
-      end
-
-
-      ## Returns a list with all the permissions on the object.
-      # @example
-      #  [{:name=>"group1", :access=>"discover", :type=>'group'},
-      #  {:name=>"group2", :access=>"discover", :type=>'group'},
-      #  {:name=>"user2", :access=>"read", :type=>'user'},
-      #  {:name=>"user1", :access=>"edit", :type=>'user'},
-      #  {:name=>"user3", :access=>"read", :type=>'user'}]
-      def permissions
-        (rightsMetadata.groups.map {|x| {:type=>'group', :access=>x[1], :name=>x[0] }} + 
-          rightsMetadata.individuals.map {|x| {:type=>'user', :access=>x[1], :name=>x[0]}})
-
-      end
-    
-      # Return a list of groups that have discover permission
-      def discover_groups
-        rightsMetadata.groups.map {|k, v| k if v == 'discover'}.compact
-      end
-
-      # Grant discover permissions to the groups specified. Revokes discover permission for all other groups.
-      # @param[Array] groups a list of group names
-      # @example
-      #  r.discover_groups= ['one', 'two', 'three']
-      #  r.discover_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def discover_groups=(groups)
-        set_discover_groups(groups, discover_groups)
-      end
-
-      # Grant discover permissions to the groups specified. Revokes discover permission for all other groups.
-      # @param[String] groups a list of group names
-      # @example
-      #  r.discover_groups_string= 'one, two, three'
-      #  r.discover_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def discover_groups_string=(groups)
-        self.discover_groups=groups.split(/[\s,]+/)
-      end
-
-      # Display the groups a comma delimeted string
-      def discover_groups_string
-        self.discover_groups.join(', ')
-      end
-
-      # Grant discover permissions to the groups specified. Revokes discover permission for
-      # any of the eligible_groups that are not in groups.
-      # This may be used when different users are responsible for setting different
-      # groups.  Supply the groups the current user is responsible for as the 
-      # 'eligible_groups'
-      # @param[Array] groups a list of groups
-      # @param[Array] eligible_groups the groups that are eligible to have their discover permssion revoked. 
-      # @example
-      #  r.discover_groups = ['one', 'two', 'three']
-      #  r.discover_groups 
-      #  => ['one', 'two', 'three']
-      #  r.set_discover_groups(['one'], ['three'])
-      #  r.discover_groups
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_discover_groups(groups, eligible_groups)
-        set_entities(:discover, :group, groups, eligible_groups)
-      end
-
-      def discover_users
-        rightsMetadata.individuals.map {|k, v| k if v == 'discover'}.compact
-      end
-
-      # Grant discover permissions to the users specified. Revokes discover permission for all other users.
-      # @param[Array] users a list of usernames
-      # @example
-      #  r.discover_users= ['one', 'two', 'three']
-      #  r.discover_users 
-      #  => ['one', 'two', 'three']
-      #
-      def discover_users=(users)
-        set_discover_users(users, discover_users)
-      end
-
-      # Grant discover permissions to the groups specified. Revokes discover permission for all other users.
-      # @param[String] users a list of usernames
-      # @example
-      #  r.discover_users_string= 'one, two, three'
-      #  r.discover_users 
-      #  => ['one', 'two', 'three']
-      #
-      def discover_users_string=(users)
-        self.discover_users=users.split(/[\s,]+/)
-      end
-
-      # Display the users as a comma delimeted string
-      def discover_users_string
-        self.discover_users.join(', ')
-      end
-
-      # Grant discover permissions to the users specified. Revokes discover permission for
-      # any of the eligible_users that are not in users.
-      # This may be used when different users are responsible for setting different
-      # users.  Supply the users the current user is responsible for as the 
-      # 'eligible_users'
-      # @param[Array] users a list of users
-      # @param[Array] eligible_users the users that are eligible to have their discover permssion revoked. 
-      # @example
-      #  r.discover_users = ['one', 'two', 'three']
-      #  r.discover_users 
-      #  => ['one', 'two', 'three']
-      #  r.set_discover_users(['one'], ['three'])
-      #  r.discover_users
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_discover_users(users, eligible_users)
-        set_entities(:discover, :person, users, eligible_users)
-      end
-
-      # Return a list of groups that have discover permission
-      def read_groups
-        rightsMetadata.groups.map {|k, v| k if v == 'read'}.compact
-      end
-
-      # Grant read permissions to the groups specified. Revokes read permission for all other groups.
-      # @param[Array] groups a list of group names
-      # @example
-      #  r.read_groups= ['one', 'two', 'three']
-      #  r.read_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def read_groups=(groups)
-        set_read_groups(groups, read_groups)
-      end
-
-      # Grant read permissions to the groups specified. Revokes read permission for all other groups.
-      # @param[String] groups a list of group names
-      # @example
-      #  r.read_groups_string= 'one, two, three'
-      #  r.read_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def read_groups_string=(groups)
-        self.read_groups=groups.split(/[\s,]+/)
-      end
-
-      # Display the groups a comma delimeted string
-      def read_groups_string
-        self.read_groups.join(', ')
-      end
-
-      # Grant read permissions to the groups specified. Revokes read permission for
-      # any of the eligible_groups that are not in groups.
-      # This may be used when different users are responsible for setting different
-      # groups.  Supply the groups the current user is responsible for as the 
-      # 'eligible_groups'
-      # @param[Array] groups a list of groups
-      # @param[Array] eligible_groups the groups that are eligible to have their read permssion revoked. 
-      # @example
-      #  r.read_groups = ['one', 'two', 'three']
-      #  r.read_groups 
-      #  => ['one', 'two', 'three']
-      #  r.set_read_groups(['one'], ['three'])
-      #  r.read_groups
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_read_groups(groups, eligible_groups)
-        set_entities(:read, :group, groups, eligible_groups)
-      end
-
-      def read_users
-        rightsMetadata.individuals.map {|k, v| k if v == 'read'}.compact
-      end
-
-      # Grant read permissions to the users specified. Revokes read permission for all other users.
-      # @param[Array] users a list of usernames
-      # @example
-      #  r.read_users= ['one', 'two', 'three']
-      #  r.read_users 
-      #  => ['one', 'two', 'three']
-      #
-      def read_users=(users)
-        set_read_users(users, read_users)
-      end
-
-      # Grant read permissions to the groups specified. Revokes read permission for all other users.
-      # @param[String] users a list of usernames
-      # @example
-      #  r.read_users_string= 'one, two, three'
-      #  r.read_users 
-      #  => ['one', 'two', 'three']
-      #
-      def read_users_string=(users)
-        self.read_users=users.split(/[\s,]+/)
-      end
-
-      # Display the users as a comma delimeted string
-      def read_users_string
-        self.read_users.join(', ')
-      end
-
-      # Grant read permissions to the users specified. Revokes read permission for
-      # any of the eligible_users that are not in users.
-      # This may be used when different users are responsible for setting different
-      # users.  Supply the users the current user is responsible for as the 
-      # 'eligible_users'
-      # @param[Array] users a list of users
-      # @param[Array] eligible_users the users that are eligible to have their read permssion revoked. 
-      # @example
-      #  r.read_users = ['one', 'two', 'three']
-      #  r.read_users 
-      #  => ['one', 'two', 'three']
-      #  r.set_read_users(['one'], ['three'])
-      #  r.read_users
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_read_users(users, eligible_users)
-        set_entities(:read, :person, users, eligible_users)
-      end
-
-
-      # Return a list of groups that have edit permission
-      def edit_groups
-        rightsMetadata.groups.map {|k, v| k if v == 'edit'}.compact
-      end
-
-      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
-      # @param[Array] groups a list of group names
-      # @example
-      #  r.edit_groups= ['one', 'two', 'three']
-      #  r.edit_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def edit_groups=(groups)
-        set_edit_groups(groups, edit_groups)
-      end
-
-      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
-      # @param[String] groups a list of group names
-      # @example
-      #  r.edit_groups_string= 'one, two, three'
-      #  r.edit_groups 
-      #  => ['one', 'two', 'three']
-      #
-      def edit_groups_string=(groups)
-        self.edit_groups=groups.split(/[\s,]+/)
-      end
-
-      # Display the groups a comma delimeted string
-      def edit_groups_string
-        self.edit_groups.join(', ')
-      end
-
-      # Grant edit permissions to the groups specified. Revokes edit permission for
-      # any of the eligible_groups that are not in groups.
-      # This may be used when different users are responsible for setting different
-      # groups.  Supply the groups the current user is responsible for as the 
-      # 'eligible_groups'
-      # @param[Array] groups a list of groups
-      # @param[Array] eligible_groups the groups that are eligible to have their edit permssion revoked. 
-      # @example
-      #  r.edit_groups = ['one', 'two', 'three']
-      #  r.edit_groups 
-      #  => ['one', 'two', 'three']
-      #  r.set_edit_groups(['one'], ['three'])
-      #  r.edit_groups
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_edit_groups(groups, eligible_groups)
-        set_entities(:edit, :group, groups, eligible_groups)
-      end
-
-      def edit_users
-        rightsMetadata.individuals.map {|k, v| k if v == 'edit'}.compact
-      end
-
-      # Grant edit permissions to the groups specified. Revokes edit permission for all other groups.
-      # @param[Array] users a list of usernames
-      # @example
-      #  r.edit_users= ['one', 'two', 'three']
-      #  r.edit_users 
-      #  => ['one', 'two', 'three']
-      #
-      def edit_users=(users)
-        set_edit_users(users, edit_users)
-      end
-
-      # Grant edit permissions to the users specified. Revokes edit permission for
-      # any of the eligible_users that are not in users.
-      # This may be used when different users are responsible for setting different
-      # users.  Supply the users the current user is responsible for as the 
-      # 'eligible_users'
-      # @param[Array] users a list of users
-      # @param[Array] eligible_users the users that are eligible to have their edit permssion revoked. 
-      # @example
-      #  r.edit_users = ['one', 'two', 'three']
-      #  r.edit_users 
-      #  => ['one', 'two', 'three']
-      #  r.set_edit_users(['one'], ['three'])
-      #  r.edit_users
-      #  => ['one', 'two']  ## 'two' was not eligible to be removed
-      #
-      def set_edit_users(users, eligible_users)
-        set_entities(:edit, :person, users, eligible_users)
-      end
-
-
-      private 
-
-      # @param  permission either :discover, :read or :edit
-      # @param  type either :person or :group
-      # @param  values  Values to set
-      # @param  changeable Values we are allowed to change
-      def set_entities(permission, type, values, changeable)
-        g = preserved(type, permission)
-        (changeable - values).each do |entity|
-          #Strip permissions from users not provided
-          g[entity] = 'none'
-        end
-        values.each { |name| g[name] = permission.to_s}
-        rightsMetadata.update_permissions(type.to_s=>g)
-      end
-
-      ## Get those permissions we don't want to change
-      def preserved(type, permission)
-        case permission
-        when :edit
-          g = {}
-        when :read
-          Hash[rightsMetadata.quick_search_by_type(type).select {|k, v| v == 'edit'}]
-        when :discover
-          Hash[rightsMetadata.quick_search_by_type(type).select {|k, v| v == 'discover'}]
-        end
-      end
-
-    end
-  end
-end