hyrax 3.0.0.pre.rc1 → 3.0.0.pre.rc2

data/app/models/concerns/hyrax/solr_document/characterization.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module SolrDocument
     # TODO: aside from height and width, I don't think any of these other terms are indexed by default. - Justin 3/2016

data/app/models/concerns/hyrax/solr_document/export.rb

@@ -1,10 +1,29 @@
+# frozen_string_literal: true
 module Hyrax
   module SolrDocument
     module Export
+      END_NOTE_MAPPINGS =
+        { '%T' => [:title],
+          '%A' => [:creator],
+          '%C' => [:publication_place],
+          '%D' => [:date_created],
+          '%8' => [:date_uploaded],
+          '%E' => [:contributor],
+          '%I' => [:publisher],
+          '%J' => [:series_title],
+          '%@' => [:isbn],
+          '%U' => [:related_url],
+          '%7' => [:edition_statement],
+          '%R' => [:persistent_url],
+          '%X' => [:description],
+          '%G' => [:language],
+          '%[' => [:date_modified],
+          '%9' => [:resource_type] }.freeze
+
       # MIME: 'application/x-endnote-refer'
       def export_as_endnote
-        text = []
-        text << "%0 #{human_readable_type}"
+        text = ["%0 #{human_readable_type}"]
+
         end_note_format.each do |endnote_key, mapping|
           if mapping.is_a? String
             values = [mapping]
@@ -17,6 +36,7 @@ module Hyrax
           spaced_values = values.join("; ")
           text << "#{endnote_key} #{spaced_values}"
         end
+
         text.join("\n")
       end
 
@@ -31,27 +51,8 @@ module Hyrax
       end
 
       def end_note_format
-        {
-          '%T' => [:title],
-          # '%Q' => [:title, ->(x) { x.drop(1) }], # subtitles
-          '%A' => [:creator],
-          '%C' => [:publication_place],
-          '%D' => [:date_created],
-          '%8' => [:date_uploaded],
-          '%E' => [:contributor],
-          '%I' => [:publisher],
-          '%J' => [:series_title],
-          '%@' => [:isbn],
-          '%U' => [:related_url],
-          '%7' => [:edition_statement],
-          '%R' => [:persistent_url],
-          '%X' => [:description],
-          '%G' => [:language],
-          '%[' => [:date_modified],
-          '%9' => [:resource_type],
-          '%~' => I18n.t('hyrax.product_name'),
-          '%W' => Institution.name
-        }
+        END_NOTE_MAPPINGS.merge({ '%~' => I18n.t('hyrax.product_name'),
+                                  '%W' => Institution.name })
       end
     end
   end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module SolrDocument
     module Metadata
@@ -40,7 +41,7 @@ module Hyrax
       end
 
       included do
-        attribute :alt_title, Solr::Array, "alt_title_tesim"
+        attribute :alternative_title, Solr::Array, "alternative_title_tesim"
         attribute :identifier, Solr::Array, "identifier_tesim"
         attribute :based_near, Solr::Array, "based_near_tesim"
         attribute :based_near_label, Solr::Array, "based_near_label_tesim"
@@ -51,6 +52,7 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, "admin_set_tesim"
+        attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, "member_of_collection_ids_ssim"
         attribute :description, Solr::Array, "description_tesim"
         attribute :abstract, Solr::Array, "abstract_tesim"

data/app/models/concerns/hyrax/solr_document/ordered_members.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Hyrax
+  module SolrDocument
+    ##
+    # Decorates an object responding to `#id` with an `#ordered_member_ids` method.
+    #
+    # @note this decorator is intended for use with data representations other
+    #   than the core model objects, as an alternative to a direct query of the
+    #   canonical database. for example, it can be used with `SolrDocument` to
+    #   quickly retrieve member order in a way that is compatible with the
+    #   fast access required in Blacklight's search contexts.
+    #
+    # @example
+    #   base_document = SolrDocument.new(my_work.to_solr)
+    #   solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(base_document)
+    #
+    #   solr_document.ordered_member_ids # => ['abc', '123']
+    #
+    class OrderedMembers < Hyrax::ModelDecorator
+      ##
+      # @note the purpose of this method is to provide fast access to member
+      #   order. currently this is achieved by accessing indexed list proxies
+      #   from Solr. however, this strategy may change in the future.
+      #
+      # @return [Enumerable<String>] ids in the order of their membership,
+      #   only includes ids of ordered members.
+      def ordered_member_ids
+        return [] if id.blank?
+        @ordered_member_ids ||= query_for_ordered_ids
+      end
+
+      private
+
+      def query_for_ordered_ids(limit: 10_000,
+                                proxy_field: 'proxy_in_ssi',
+                                target_field: 'ordered_targets_ssim')
+        Hyrax::SolrService
+          .query("#{proxy_field}:#{id}", rows: limit, fl: target_field)
+          .flat_map { |x| x.fetch(target_field, nil) }
+          .compact
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module SolrDocumentBehavior
     extend ActiveSupport::Concern
@@ -53,30 +54,40 @@ module Hyrax
       end
     end
     ##
-    # Offer the source (ActiveFedora-based) model to Rails for some of the
-    # Rails methods (e.g. link_to).
+    # Offer the source model to Rails for some of the Rails methods (e.g. link_to).
+    #
     # @example
     #   link_to '...', SolrDocument(:id => 'bXXXXXX5').new => <a href="/dams_object/bXXXXXX5">...</a>
     def to_model
       @model ||= ModelWrapper.new(hydra_model, id)
     end
 
+    ##
+    # @return [Boolean]
     def collection?
       hydra_model == ::Collection
     end
 
+    ##
+    # @return [Boolean]
+    def file_set?
+      hydra_model == ::FileSet
+    end
+
+    ##
+    # @return [Boolean]
     def admin_set?
       hydra_model == ::AdminSet
     end
 
-    # Method to return the ActiveFedora model
+    # Method to return the model
     def hydra_model
-      first("has_model_ssim").constantize
+      "::#{first('has_model_ssim')}".safe_constantize
     end
 
     def depositor(default = '')
       val = first("depositor_tesim")
-      val.present? ? val : default
+      val.presence || default
     end
 
     def creator

data/app/models/concerns/hyrax/suppressible.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # A work should be able to be filtered out of search results if it's inactive
   module Suppressible
@@ -14,14 +15,15 @@ module Hyrax
     #
     # Override this method if you have some criteria by which records should not display in the search results.
     def suppressed?
-      return false if state.nil?
-
-      state == Vocab::FedoraResourceStatus.inactive
+      Hyrax::ResourceStatus.new(resource: self).inactive?
     end
 
+    ##
+    # @deprecated Use `Sipity::Entity(entity)` instead.
     def to_sipity_entity
+      Deprecation.warn "Use `Sipity::Entity(entity)` instead."
       raise "Can't create an entity until the model has been persisted" unless persisted?
-      @sipity_entity ||= Sipity::Entity.find_by(proxy_for_global_id: to_global_id.to_s)
+      @sipity_entity ||= Sipity::Entity(to_global_id)
     end
   end
 end

data/app/models/concerns/hyrax/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'oauth'
 
 module Hyrax::User
@@ -106,7 +107,7 @@ module Hyrax::User
     #   2. the orcid field is blank
     #   3. the orcid is already in its normalized form
     return if errors[:orcid].first.present? || orcid.blank? || orcid.starts_with?('https://orcid.org/')
-    bare_orcid = Hyrax::OrcidValidator.match(orcid)
+    bare_orcid = Hyrax::OrcidValidator.extract_bare_orcid(from: orcid)
     self.orcid = "https://orcid.org/#{bare_orcid}"
   end
 

data/app/models/concerns/hyrax/user_usage_stats.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax::UserUsageStats
   def stats
     @stats ||= UserStat.where(user_id: id).order(date: :asc)

data/app/models/concerns/hyrax/virus_check.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module VirusCheck
     extend ActiveSupport::Concern

data/app/models/concerns/hyrax/with_events.rb

@@ -1,13 +1,23 @@
+# frozen_string_literal: true
 module Hyrax
+  # A mixin module intended to provide an interface into creating the paper trail
+  # of activity on the target model of the mixin.
+  #
+  # @see Hyrax::Event
   module WithEvents
     def stream
       Nest.new(event_class)[to_param]
     end
 
+    # @return [String]
     def event_class
-      self.class.name
+      model_name.name
     end
 
+    ##
+    # @param [Integer] size  the maximum number of events to fetch from the log.
+    #   Offset by 1; to get one event, use `0`, for two, use `1`, etc...
+    #   `-1` gives all events.
     def events(size = -1)
       event_stream.fetch(size)
     end
@@ -18,12 +28,12 @@ module Hyrax
 
     private
 
-      def event_store
-        RedisEventStore
-      end
+    def event_store
+      RedisEventStore
+    end
 
-      def event_stream
-        event_store.for(stream[:event])
-      end
+    def event_stream
+      event_store.for(stream[:event])
+    end
   end
 end

data/app/models/concerns/hyrax/with_file_sets.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   module WithFileSets
     extend ActiveSupport::Concern
+
+    ##
+    # @deprecated Use 'Hyrax::VisibilityPropagator' instead.
     def copy_visibility_to_files
+      Deprecation.warn "Use 'Hyrax::VisibilityPropagator' instead."
+
       file_sets.each do |fs|
         fs.visibility = visibility
         fs.save!

data/app/models/concerns/hyrax/work_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module WorkBehavior
     extend ActiveSupport::Concern
@@ -31,19 +32,13 @@ module Hyrax
       self.default_system_virus_scanner = Hyrax::VirusScanner
     end
 
-    # TODO: This can be removed when we upgrade to ActiveFedora 12.0
-    def etag
-      raise "Unable to produce an etag for a unsaved object" unless persisted?
-      ldp_source.head.etag
-    end
-
     module ClassMethods
       # This governs which partial to draw when you render this type of object
       def _to_partial_path #:nodoc:
         @_to_partial_path ||= begin
           element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
           collection = ActiveSupport::Inflector.tableize(name)
-          "hyrax/#{collection}/#{element}".freeze
+          "hyrax/#{collection}/#{element}"
         end
       end
     end

data/app/models/concerns/hyrax/works/metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax::Works
   module Metadata
     extend ActiveSupport::Concern

data/app/models/content_block.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class ContentBlock < ActiveRecord::Base
   # The keys in this registry are "public" names for collaborator
   # objects, and the values are reserved names of ContentBlock
@@ -18,12 +19,18 @@ class ContentBlock < ActiveRecord::Base
   # `for` is a reserved word in Ruby.
   def self.for(key)
     key = key.respond_to?(:to_sym) ? key.to_sym : key
-    raise ArgumentError, "#{key} is not a ContentBlock name" unless whitelisted?(key)
+    raise ArgumentError, "#{key} is not a ContentBlock name" unless registered?(key)
     ContentBlock.public_send(NAME_REGISTRY[key])
   end
 
   class << self
+    # @deprecated
     def whitelisted?(key)
+      Deprecation.warn(self, "Samvera is deprecating '#{self}.whitelisted?' in Hyrax 3.0. Use #{self}.registered? instead.")
+      registered?(key)
+    end
+
+    def registered?(key)
       NAME_REGISTRY.include?(key)
     end
 

data/app/models/featured_work.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FeaturedWork < ActiveRecord::Base
   FEATURE_LIMIT = 5
   validate :count_within_limit, on: :create

data/app/models/featured_work_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FeaturedWorkList
   include ActiveModel::Model
 
@@ -26,24 +27,24 @@ class FeaturedWorkList
 
   private
 
-    def add_solr_document_to_works
-      work_presenters.each do |presenter|
-        work_with_id(presenter.id).presenter = presenter
-      end
+  def add_solr_document_to_works
+    work_presenters.each do |presenter|
+      work_with_id(presenter.id).presenter = presenter
     end
+  end
 
-    def ids
-      @works.pluck(:work_id)
-    end
+  def ids
+    @works.pluck(:work_id)
+  end
 
-    def work_presenters
-      ability = nil
-      Hyrax::PresenterFactory.build_for(ids: ids,
-                                        presenter_class: Hyrax::WorkShowPresenter,
-                                        presenter_args: ability)
-    end
+  def work_presenters
+    ability = nil
+    Hyrax::PresenterFactory.build_for(ids: ids,
+                                      presenter_class: Hyrax::WorkShowPresenter,
+                                      presenter_args: ability)
+  end
 
-    def work_with_id(id)
-      @works.find { |w| w.work_id == id }
-    end
+  def work_with_id(id)
+    @works.find { |w| w.work_id == id }
+  end
 end

data/app/models/file_download_stat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FileDownloadStat < Hyrax::Statistic
   self.cache_column = :downloads
   self.event_type = :totalEvents

data/app/models/file_view_stat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FileViewStat < Hyrax::Statistic
   self.cache_column = :views
   self.event_type = :pageviews

data/app/models/hyrax/access_control.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A list of permissions pertaining to a specific object.
+  #
+  # `AccessControl`s consist of a set of permissions and an `#access_to`
+  # reference to the object that set governs.
+  #
+  # @see Hyrax::AccessControlList for a low level DSL for managing
+  #   `AccessControl` and `Permission` relationships for `Hyrax::Resource`
+  # @see Hyrax::PermissionManager for `read_groups`/`read_users` style setters
+  #   and getters
+  # @see Hyrax::VisibilityWriter, Hyrax::VisibilityReader for
+  #   "open"/"restricted" style visibility management
+  class AccessControl < Valkyrie::Resource
+    ##
+    # @!attribute [rw] access_to
+    #   Supports query for ACLs at the resource level. Permissions should be
+    #   grouped under an AccessControl with a matching `#access_to` so they can
+    #   be retrieved in batch.
+    #
+    #   @return [Valkyrie::ID] the id of the Resource these permissions apply to
+    # @!attribute [rw] permissions
+    #   @return [Enumerable<Hyrax::Permission>]
+    attribute :access_to,   Valkyrie::Types::ID
+    attribute :permissions, Valkyrie::Types::Set.of(Hyrax::Permission)
+
+    ##
+    # A finder/factory method for getting an appropriate ACL for a given
+    # resource.
+    #
+    # @param resource [Valkyrie::Resource]
+    # @param query_service [#find_inverse_references_by]
+    #
+    # @return [AccessControl]
+    # @raise [ArgumentError] if the resource is not persisted
+    def self.for(resource:, query_service: Hyrax.query_service)
+      query_service.custom_queries.find_access_control_for(resource: resource)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      new(access_to: resource.id)
+    end
+  end
+end