module Hydra::Grouper

A namespace module for configuring and managing group and role adapters

Constants

VERSION

Current version of Hydra::Grouper

Public Class Methods

configuration() click to toggle source

@api public

Contains the Hydra::Grouper configuration information that is referenceable from wit

@return [Hydra::Group::Configuration] @see Hydra::Group::Configuration

# File lib/hydra/grouper.rb, line 28
def self.configuration
  @configuration ||= Configuration.new
end
configure(&block) click to toggle source

@api public

Capture the configuration information

@yield [Hydra::Group::Configuration] @see Hydra::Group::Configuration @see .configuration @see Hydra::Group::Railtie

# File lib/hydra/grouper.rb, line 40
def self.configure(&block)
  @configuration_block = block
  # The Rails load sequence means that some of the configured Targets may
  # not be loaded; As such I am not calling configure! instead relying on
  # Hydra::Group::Railtie to handle the configure! call
  configure! unless defined?(Rails)
end
configure!() click to toggle source

Responsible for performing the configuration operation.

@return [TrueClass] if configuration was performed @return [FalseClass] if configuration was not performed @api private

# File lib/hydra/grouper.rb, line 53
def self.configure!
  return false unless @configuration_block.respond_to?(:call)
  @configuration_block.call(configuration)
  @configuration_block = nil
  true
end
group_adapter() click to toggle source

@api public @return an object that conforms to the Hydra::Grouper::GroupAdapterInterface

# File lib/hydra/grouper.rb, line 12
def self.group_adapter
  configuration.group_adapter
end
institution_function_adapter() click to toggle source

@api public @return an object that conforms to the Hydra::Grouper::InstitutionFunctionAdapterInterface

# File lib/hydra/grouper.rb, line 18
def self.institution_function_adapter
  configuration.institution_function_adapter
end