hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/app/models/concerns/hyrax/ability/admin_set_ability.rb

@@ -24,11 +24,6 @@ module Hyrax
           can :view_admin_show, AdminSet do |admin_set| # admin show page # for test by solr_doc, see collection_ability.rb
             Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: admin_set.id)
           end
-
-          # TODO: I don't think these are needed anymore since there isn't a public show page.  Should be checking :view_admin_show ability
-          can :read, AdminSet do |admin_set| # for test by solr_doc, see solr_document_ability.rb
-            test_read(admin_set.id)
-          end
         end
 
         # TODO: I'm not sure why this is checked with AdminSet abilities.  It was before the refactor and since I'm not sure what the connection is, I left it here.

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

@@ -4,7 +4,6 @@ module Hyrax
     extend ActiveSupport::Concern
     include Hydra::AccessControls::WithAccessRight
     include Hydra::WithDepositor # for access to apply_depositor_metadata
-    include Hydra::AccessControls::Permissions
     include Hyrax::CoreMetadata
     include Hydra::Works::CollectionBehavior
     include Hyrax::Noid
@@ -30,17 +29,17 @@ module Hyrax
       validates :collection_type_gid, presence: true
 
       # Need to define here in order to override setter defined by ActiveTriples
-      def collection_type_gid=(new_collection_type_gid)
+      def collection_type_gid=(new_collection_type_gid, force: false)
         new_collection_type_gid = new_collection_type_gid&.to_s
-        raise "Can't modify collection type of this collection" if persisted? && !collection_type_gid_was.nil? && collection_type_gid_was != new_collection_type_gid
+        raise "Can't modify collection type of this collection" if !force && persisted? && !collection_type_gid_was.nil? && collection_type_gid_was != new_collection_type_gid
         new_collection_type = Hyrax::CollectionType.find_by_gid!(new_collection_type_gid)
-        super
+        super(new_collection_type_gid)
         @collection_type = new_collection_type
         collection_type_gid
       end
     end
 
-    delegate(*Hyrax::CollectionType.collection_type_settings_methods, to: :collection_type)
+    delegate(*Hyrax::CollectionType.settings_attributes, to: :collection_type)
 
     # Get the collection_type when accessed
     def collection_type
@@ -48,7 +47,7 @@ module Hyrax
     end
 
     def collection_type=(new_collection_type)
-      self.collection_type_gid = new_collection_type.gid
+      self.collection_type_gid = new_collection_type.to_global_id
     end
 
     # Add members using the members association.
@@ -61,8 +60,6 @@ module Hyrax
 
     # Add member objects by adding this collection to the objects' member_of_collection association.
     # @param [Enumerable<String>] the ids of the new child collections and works collection ids
-    # Valkyrie Version: Wings::CollectionBehavior#add_collections_and_works aliased to #add_member_objects
-    #                   lib/wings/models/concerns/collection_behavior.rb
     def add_member_objects(new_member_ids)
       Array(new_member_ids).collect do |member_id|
         member = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: member_id, use_valkyrie: false)
@@ -78,16 +75,12 @@ module Hyrax
     end
 
     # @return [Enumerable<ActiveFedora::Base>] an enumerable over the children of this collection
-    # Valkyrie Version: Wings::CollectionBehavior#child_collections_and_works aliased to #member_objects
-    #                   lib/wings/models/concerns/collection_behavior.rb
     def member_objects
       ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id}")
     end
 
     # Use this query to get the ids of the member objects (since the containment
     # association has been flipped)
-    # Valkyrie Version: Wings::CollectionBehavior#child_collections_and_works_ids aliased to #member_object_ids
-    #                   lib/wings/models/concerns/collection_behavior.rb
     def member_object_ids
       return [] unless id
       member_objects.map(&:id)
@@ -108,7 +101,8 @@ module Hyrax
       end
 
       def collection_type_gid_document_field_name
-        "collection_type_gid_ssim"
+        Deprecation.warn('use Hyrax.config.collection_type_index_field instead')
+        Hyrax.config.collection_type_index_field
       end
     end
 

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

@@ -14,8 +14,8 @@ module Hyrax
         class_attribute :paranoid_edit_permissions
         self.paranoid_edit_permissions =
           [
-            { key: :edit_groups, message: 'Public cannot have edit access', condition: ->(obj) { obj.edit_groups.include?('public') } },
-            { key: :edit_groups, message: 'Registered cannot have edit access', condition: ->(obj) { obj.edit_groups.include?('registered') } }
+            { key: :edit_groups, message: 'Public cannot have edit access', condition: ->(obj) { obj.edit_groups.include?(::Ability.public_group_name) } },
+            { key: :edit_groups, message: 'Registered cannot have edit access', condition: ->(obj) { obj.edit_groups.include?(::Ability.registered_group_name) } }
           ]
       end
 

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

@@ -1,28 +1,39 @@
 # 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
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def byte_order
         self["byte_order_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def capture_device
         self["capture_device_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def color_map
         self["color_map_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def color_space
         self["color_space_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def compression
         self["compression_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def gps_timestamp
         self["gps_timestamp_tesim"]
       end
@@ -31,30 +42,44 @@ module Hyrax
         self['height_is']
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def image_producer
         self["image_producer_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def latitude
         self["latitude_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def longitude
         self["longitude_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def orientation
         self["orientation_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def profile_name
         self["profile_name_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def profile_version
         self["profile_version_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def scanning_software
         self["scanning_software_tesim"]
       end
@@ -63,18 +88,24 @@ module Hyrax
         self['width_is']
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def format_label
         self["format_label_tesim"]
       end
 
       def file_size
-        self["file_size_tesim"]
+        self["file_size_lts"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def filename
         self["filename_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def well_formed
         self["well_formed_tesim"]
       end
@@ -95,6 +126,8 @@ module Hyrax
         self["sample_rate_tesim"]
       end
 
+      ##
+      # @todo this might not be indexed normally. deprecate?
       def last_modified
         self["last_modified_tesim"]
       end

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

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
+  # @api public
+  #
+  # Hyrax extensions for +Blacklight+'s generated +SolrDocument+.
+  #
+  # @example using with +Blacklight::Solr::Document+
+  #   class SolrDocument
+  #     include Blacklight::Solr::Document
+  #     include Hyrax::SolrDocumentBehavior
+  #   end
+  #
+  # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
   module SolrDocumentBehavior
     extend ActiveSupport::Concern
     include Hydra::Works::MimeTypes
@@ -23,32 +35,51 @@ module Hyrax
       id
     end
 
-    def to_s
-      title_or_label
+    def to_s # rubocop:disable Rails/Delegate
+      title_or_label.to_s
     end
 
+    ##
+    # Given a model class and an +id+, provides +ActiveModel+ style model methods.
+    #
+    # @note access this via {SolrDocumentBehavior#to_model}.
     class ModelWrapper
+      ##
+      # @api private
+      #
+      # @param [Class] model
+      # @param [String, nil] id
       def initialize(model, id)
         @model = model
         @id = id
       end
 
+      ##
+      # @api public
       def persisted?
         true
       end
 
+      ##
+      # @api public
       def to_param
         @id
       end
 
+      ##
+      # @api public
       def model_name
         @model.model_name
       end
 
+      ##
+      # @api public
       def to_partial_path
         @model._to_partial_path
       end
 
+      ##
+      # @api public
       def to_global_id
         URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
       end
@@ -81,8 +112,9 @@ module Hyrax
     end
 
     # Method to return the model
-    def hydra_model
-      "::#{first('has_model_ssim')}".safe_constantize
+    def hydra_model(classifier: ActiveFedora.model_mapper)
+      "::#{first('has_model_ssim')}".safe_constantize ||
+        classifier.classifier(self).best_model
     end
 
     def depositor(default = '')
@@ -110,7 +142,7 @@ module Hyrax
     end
 
     def collection_type_gid
-      first('collection_type_gid_ssim')
+      first(Hyrax.config.collection_type_index_field)
     end
   end
 end

data/app/models/hyrax/change_set.rb

@@ -7,10 +7,14 @@ module Hyrax
   # Build a changeset class for the given resource class. The ChangeSet will
   # have fields to match the resource class given.
   #
+  # To define a custom changeset with validations, use naming convention with "ChangeSet" appended to the end
+  # of the resource class name. (e.g. for BookResource, name the change set BookResourceChangeSet)
+  #
   # @example
   #   Hyrax::ChangeSet(Monograph)
   def self.ChangeSet(resource_class)
-    Class.new(Hyrax::ChangeSet) do
+    klass = (resource_class.to_s + "ChangeSet").safe_constantize || Hyrax::ChangeSet
+    Class.new(klass) do
       (resource_class.fields - resource_class.reserved_attributes).each do |field|
         property field, default: nil
       end

data/app/models/hyrax/collection_type.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 module Hyrax
-  class CollectionType < ActiveRecord::Base
+  class CollectionType < ActiveRecord::Base # rubocop:disable Metrics/ClassLength
+    # @!method id
+    #   @return [Integer]
+    # @!method description
+    #   @return [String]
+    # @!method machine_id
+    #   @return [String]
+    # @!method title
+    #   @return [String]
     self.table_name = 'hyrax_collection_types'
     validates :title, presence: true, uniqueness: true
     validates :machine_id, presence: true, uniqueness: true
@@ -10,21 +18,31 @@ module Hyrax
     before_destroy :ensure_no_collections
     has_many :collection_type_participants, class_name: 'Hyrax::CollectionTypeParticipant', foreign_key: 'hyrax_collection_type_id', dependent: :destroy
 
+    SETTINGS_ATTRIBUTES = # these need to updated in tandem with database migrations, use `.settings_attributes`
+      [:nestable?, :discoverable?, :brandable?, :sharable?, :share_applies_to_new_works?, :allow_multiple_membership?,
+       :require_membership?, :assigns_workflow?, :assigns_visibility?].freeze
+
     USER_COLLECTION_MACHINE_ID    = 'user_collection'
     USER_COLLECTION_DEFAULT_TITLE = I18n.t('hyrax.collection_type.default_title', default: 'User Collection').freeze
 
     ADMIN_SET_MACHINE_ID = 'admin_set'
     ADMIN_SET_DEFAULT_TITLE = I18n.t('hyrax.collection_type.admin_set_title', default: 'Admin Set').freeze
 
+    ##
+    # @note mints a #machine_id (?!)
+    # @return [void]
     def title=(value)
       super
       assign_machine_id
     end
 
+    # this class attribute is deprecated in favor of {.settings_attributes}
+    # these need to carefully align with boolean flag attributes/table columns,
+    # so making it settable is a liability. deprecating is challenging because
+    # +class_attribute+ calls +singleton_class.class_eval { redefine_method }+
+    # as the +name=+ implementation. there should be few callers outside hyrax.
     class_attribute :collection_type_settings_methods, instance_writer: false
-    self.collection_type_settings_methods = [:nestable?, :discoverable?, :brandable?, :sharable?, :share_applies_to_new_works?,
-                                             :allow_multiple_membership?, :require_membership?, :assigns_workflow?,
-                                             :assigns_visibility?]
+    self.collection_type_settings_methods = SETTINGS_ATTRIBUTES
 
     # These are provided as a convenience method based on prior design discussions.
     alias_attribute :discovery, :discoverable
@@ -39,15 +57,15 @@ module Hyrax
     # @return [Hyrax::CollectionType] if record matching gid is found, an instance of Hyrax::CollectionType with id = the model_id portion of the gid (e.g. 3)
     # @return [False] if record matching gid is not found
     def self.find_by_gid(gid)
-      find(GlobalID.new(gid).model_id)
+      find_by_gid!(gid)
     rescue ActiveRecord::RecordNotFound, URI::InvalidURIError
       false
     end
 
     # Return an array of global identifiers for collection types that do not allow multiple membership.
     # @return [Array<String>] an array of Global Identifiers
-    # @see {#gid}
-    # @see Hyrax::MultipleMembershipChecker for usage
+    # @see #gid
+    # @see Hyrax::MultipleMembershipChecker
     def self.gids_that_do_not_allow_multiple_membership
       where(allow_multiple_membership: false).map(&:gid)
     end
@@ -57,22 +75,44 @@ module Hyrax
     # @return [Hyrax::CollectionType] an instance of Hyrax::CollectionType with id = the model_id portion of the gid (e.g. 3)
     # @raise [ActiveRecord::RecordNotFound] if record matching gid is not found
     def self.find_by_gid!(gid)
-      find_by_gid(gid) ||
-        raise(ActiveRecord::RecordNotFound, "Couldn't find Hyrax::CollectionType matching GID '#{gid}'")
+      raise(URI::InvalidURIError) if gid.nil?
+      GlobalID::Locator.locate(gid)
+    rescue NameError
+      Rails.logger.warn "#{self.class}##{__method__} called with #{gid}, which is " \
+                        "a legacy collection type global id format. If this " \
+                        "collection type gid is attached to a collection in " \
+                        "your repository you'll want to run " \
+                        "`hyrax:collections:update_collection_type_global_ids` to " \
+                        "update references. see: https://github.com/samvera/hyrax/issues/4696"
+      find(GlobalID.new(gid).model_id)
+    end
+
+    ##
+    # @note this replaces the deprecated +.collection_type_settings_methods+
+    # @return [Array<Symbol>] the predicates for collection type settings flags
+    #   (e.g. {#nestable?})
+    def self.settings_attributes
+      SETTINGS_ATTRIBUTES
     end
 
+    ##
+    # @deprecation use #to_global_id
+    #
     # Return the Global Identifier for this collection type.
-    # @return [String] Global Identifier (gid) for this collection_type (e.g. gid://internal/hyrax-collectiontype/3)
+    # @return [String, nil] Global Identifier (gid) for this collection_type (e.g. gid://internal/hyrax-collectiontype/3)
+    #
+    # @see https://github.com/rails/globalid#usage
     def gid
-      URI::GID.build(app: GlobalID.app, model_name: model_name.name.parameterize.to_sym, model_id: id).to_s if id
+      Deprecation.warn('use #to_global_id.')
+      to_global_id.to_s if id
     end
 
     ##
     # @return [Enumerable<Collection, PcdmCollection>]
     def collections(use_valkyrie: false)
-      return [] unless gid
-      return Hyrax.custom_queries.find_collections_by_type(global_id: gid) if use_valkyrie
-      ActiveFedora::Base.where(collection_type_gid_ssim: gid.to_s)
+      return [] unless id
+      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id) if use_valkyrie
+      ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)
     end
 
     ##
@@ -127,7 +167,6 @@ module Hyrax
     private
 
     def assign_machine_id
-      # FIXME: This method allows for the possibility of collisions
       self.machine_id ||= title.parameterize.underscore.to_sym if title.present?
     end
 
@@ -138,15 +177,13 @@ module Hyrax
     end
 
     def ensure_no_settings_changes_for_admin_set_type
-      return true unless admin_set? && exists_for_machine_id?(ADMIN_SET_MACHINE_ID)
-      return true unless collection_type_settings_changed?
+      return true unless admin_set? && collection_type_settings_changed? && exists_for_machine_id?(ADMIN_SET_MACHINE_ID)
       errors[:base] << I18n.t('hyrax.admin.collection_types.errors.no_settings_change_for_admin_sets')
       throw :abort
     end
 
     def ensure_no_settings_changes_for_user_collection_type
-      return true unless user_collection? && exists_for_machine_id?(USER_COLLECTION_MACHINE_ID)
-      return true unless collection_type_settings_changed?
+      return true unless user_collection? && collection_type_settings_changed? && exists_for_machine_id?(USER_COLLECTION_MACHINE_ID)
       errors[:base] << I18n.t('hyrax.admin.collection_types.errors.no_settings_change_for_user_collections')
       throw :abort
     end
@@ -159,12 +196,12 @@ module Hyrax
     end
 
     def collection_type_settings_changed?
-      (changes.keys & ['nestable', 'brandable', 'discoverable', 'sharable', 'share_applies_to_new_works', 'allow_multiple_membership',
-                       'require_membership', 'assigns_workflow', 'assigns_visibility']).any?
+      (changes.keys & ['nestable', 'brandable', 'discoverable', 'sharable', 'share_applies_to_new_works',
+                       'allow_multiple_membership', 'require_membership', 'assigns_workflow', 'assigns_visibility']).any?
     end
 
     def exists_for_machine_id?(machine_id)
       self.class.exists?(machine_id: machine_id)
     end
-  end
+  end # rubocop:enable Metrics/ClassLength
 end