hyrax 2.8.0 → 3.0.0.pre.rc2

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

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

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

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

data/app/models/concerns/hyrax/permissions/readable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Permissions
     module Readable

data/app/models/concerns/hyrax/permissions/writable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Permissions
     module Writable

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

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Serializers
     def to_s
@@ -6,7 +7,7 @@ module Hyrax
       elsif label.present?
         label
       else
-        'No Title'
+        I18n.t('hyrax.works.missing_title')
       end
     end
   end

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

@@ -1,29 +1,30 @@
+# 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
     module Characterization
       def byte_order
-        self[Solrizer.solr_name("byte_order")]
+        self["byte_order_tesim"]
       end
 
       def capture_device
-        self[Solrizer.solr_name("capture_device")]
+        self["capture_device_tesim"]
       end
 
       def color_map
-        self[Solrizer.solr_name("color_map")]
+        self["color_map_tesim"]
       end
 
       def color_space
-        self[Solrizer.solr_name("color_space")]
+        self["color_space_tesim"]
       end
 
       def compression
-        self[Solrizer.solr_name("compression")]
+        self["compression_tesim"]
       end
 
       def gps_timestamp
-        self[Solrizer.solr_name("gps_timestamp")]
+        self["gps_timestamp_tesim"]
       end
 
       def height
@@ -31,31 +32,31 @@ module Hyrax
       end
 
       def image_producer
-        self[Solrizer.solr_name("image_producer")]
+        self["image_producer_tesim"]
       end
 
       def latitude
-        self[Solrizer.solr_name("latitude")]
+        self["latitude_tesim"]
       end
 
       def longitude
-        self[Solrizer.solr_name("longitude")]
+        self["longitude_tesim"]
       end
 
       def orientation
-        self[Solrizer.solr_name("orientation")]
+        self["orientation_tesim"]
       end
 
       def profile_name
-        self[Solrizer.solr_name("profile_name")]
+        self["profile_name_tesim"]
       end
 
       def profile_version
-        self[Solrizer.solr_name("profile_version")]
+        self["profile_version_tesim"]
       end
 
       def scanning_software
-        self[Solrizer.solr_name("scanning_software")]
+        self["scanning_software_tesim"]
       end
 
       def width
@@ -63,39 +64,39 @@ module Hyrax
       end
 
       def format_label
-        self[Solrizer.solr_name("format_label")]
+        self["format_label_tesim"]
       end
 
       def file_size
-        self[Solrizer.solr_name("file_size")]
+        self["file_size_tesim"]
       end
 
       def filename
-        self[Solrizer.solr_name("filename")]
+        self["filename_tesim"]
       end
 
       def well_formed
-        self[Solrizer.solr_name("well_formed")]
+        self["well_formed_tesim"]
       end
 
       def page_count
-        self[Solrizer.solr_name("page_count")]
+        self["page_count_tesim"]
       end
 
       def file_title
-        self[Solrizer.solr_name("file_title")]
+        self["file_title_tesim"]
       end
 
       def duration
-        self[Solrizer.solr_name("duration")]
+        self["duration_tesim"]
       end
 
       def sample_rate
-        self[Solrizer.solr_name("sample_rate")]
+        self["sample_rate_tesim"]
       end
 
       def last_modified
-        self[Solrizer.solr_name("last_modified")]
+        self["last_modified_tesim"]
       end
 
       def original_checksum

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
@@ -8,10 +9,6 @@ module Hyrax
             type.coerce(self[field])
           end
         end
-
-        def solr_name(*args)
-          Solrizer.solr_name(*args)
-        end
       end
 
       module Solr
@@ -37,45 +34,48 @@ module Hyrax
             begin
               ::Date.parse(field)
             rescue ArgumentError
-              Rails.logger.info "Unable to parse date: #{field.first.inspect}"
+              Hyrax.logger.info "Unable to parse date: #{field.first.inspect}"
             end
           end
         end
       end
 
       included do
-        attribute :identifier, Solr::Array, solr_name('identifier')
-        attribute :based_near, Solr::Array, solr_name('based_near')
-        attribute :based_near_label, Solr::Array, solr_name('based_near_label')
-        attribute :related_url, Solr::Array, solr_name('related_url')
-        attribute :resource_type, Solr::Array, solr_name('resource_type')
+        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"
+        attribute :related_url, Solr::Array, "related_url_tesim"
+        attribute :resource_type, Solr::Array, "resource_type_tesim"
         attribute :edit_groups, Solr::Array, ::Ability.edit_group_field
         attribute :edit_people, Solr::Array, ::Ability.edit_user_field
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
-        attribute :admin_set, Solr::Array, solr_name('admin_set')
-        attribute :member_of_collection_ids, Solr::Array, solr_name('member_of_collection_ids', :symbol)
-        attribute :description, Solr::Array, solr_name('description')
-        attribute :title, Solr::Array, solr_name('title')
-        attribute :contributor, Solr::Array, solr_name('contributor')
-        attribute :subject, Solr::Array, solr_name('subject')
-        attribute :publisher, Solr::Array, solr_name('publisher')
-        attribute :language, Solr::Array, solr_name('language')
-        attribute :keyword, Solr::Array, solr_name('keyword')
-        attribute :license, Solr::Array, solr_name('license')
-        attribute :source, Solr::Array, solr_name('source')
-        attribute :date_created, Solr::Array, solr_name('date_created')
-        attribute :rights_statement, Solr::Array, solr_name('rights_statement')
-
-        attribute :mime_type, Solr::String, solr_name('mime_type', :stored_sortable)
-        attribute :workflow_state, Solr::String, solr_name('workflow_state_name', :symbol)
-        attribute :human_readable_type, Solr::String, solr_name('human_readable_type', :stored_searchable)
-        attribute :representative_id, Solr::String, solr_name('hasRelatedMediaFragment', :symbol)
+        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"
+        attribute :title, Solr::Array, "title_tesim"
+        attribute :contributor, Solr::Array, "contributor_tesim"
+        attribute :subject, Solr::Array, "subject_tesim"
+        attribute :publisher, Solr::Array, "publisher_tesim"
+        attribute :language, Solr::Array, "language_tesim"
+        attribute :keyword, Solr::Array, "keyword_tesim"
+        attribute :license, Solr::Array, "license_tesim"
+        attribute :source, Solr::Array, "source_tesim"
+        attribute :date_created, Solr::Array, "date_created_tesim"
+        attribute :rights_statement, Solr::Array, "rights_statement_tesim"
+        attribute :rights_notes, Solr::Array, "rights_notes_tesim"
+        attribute :access_right, Solr::Array, "access_right_tesim"
+        attribute :mime_type, Solr::String, "mime_type_ssi"
+        attribute :workflow_state, Solr::String, "workflow_state_name_ssim"
+        attribute :human_readable_type, Solr::String, "human_readable_type_tesim"
+        attribute :representative_id, Solr::String, "hasRelatedMediaFragment_ssim"
         # extract the term name from the rendering_predicate (it might be after the final / or #)
-        attribute :rendering_ids, Solr::Array, solr_name(Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last, :symbol)
-        attribute :thumbnail_id, Solr::String, solr_name('hasRelatedImage', :symbol)
+        attribute :rendering_ids, Solr::Array, Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last + "_ssim"
+        attribute :thumbnail_id, Solr::String, "hasRelatedImage_ssim"
         attribute :thumbnail_path, Solr::String, CatalogController.blacklight_config.index.thumbnail_field
-
         attribute :label, Solr::String, "label_tesim"
         attribute :file_format, Solr::String, "file_format_tesim"
         attribute :suppressed?, Solr::String, "suppressed_bsi"

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,39 +54,45 @@ 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(Solrizer.solr_name('has_model', :symbol)).constantize
+      "::#{first('has_model_ssim')}".safe_constantize
     end
 
     def depositor(default = '')
-      val = first(Solrizer.solr_name('depositor'))
-      val.present? ? val : default
+      val = first("depositor_tesim")
+      val.presence || default
     end
 
     def creator
-      descriptor = if hydra_model == AdminSet
-                     hydra_model.index_config[:creator].behaviors.first
-                   else
-                     :stored_searchable
-                   end
-      fetch(Solrizer.solr_name('creator', descriptor), [])
+      solr_term = hydra_model == AdminSet ? "creator_ssim" : "creator_tesim"
+      fetch(solr_term, [])
     end
 
     def visibility

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