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

data/app/models/hyrax/group.rb

@@ -1,5 +1,12 @@
+# frozen_string_literal: true
 module Hyrax
   class Group
+    DEFAULT_NAME_PREFIX = 'group/'
+
+    def self.name_prefix
+      DEFAULT_NAME_PREFIX
+    end
+
     def initialize(name)
       @name = name
     end
@@ -12,12 +19,12 @@ module Hyrax
 
     private
 
-      def sipity_agent
-        Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
-      end
+    def sipity_agent
+      Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
+    end
 
-      def create_sipity_agent!
-        Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
-      end
+    def create_sipity_agent!
+      Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
+    end
   end
 end

data/app/models/hyrax/operation.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Hyrax
   # The database storage of inter-related jobs and their states.
   class Operation < ActiveRecord::Base
-    PENDING = 'pending'.freeze
-    PERFORMING = 'performing'.freeze
-    FAILURE = 'failure'.freeze
-    SUCCESS = 'success'.freeze
+    PENDING = 'pending'
+    PERFORMING = 'performing'
+    FAILURE = 'failure'
+    SUCCESS = 'success'
 
     enum(
       status: {

data/app/models/hyrax/orcid_validator.rb

@@ -1,17 +1,25 @@
+# frozen_string_literal: true
 module Hyrax
   class OrcidValidator < ActiveModel::Validator
+    ORCID_REGEXP = %r{^(?<prefix>https?://orcid.org/)?(?<orcid>\d{4}-\d{4}-\d{4}-\d{3}[\dX])/?$}.freeze
     def validate(record)
       return if record.orcid.blank?
-      record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless self.class.match(record.orcid)
+      record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless ORCID_REGEXP.match?(record.orcid)
     end
 
+    # @deprecated
     def self.match(string)
-      Regexp.new(orcid_regex).match(string) { |m| m[:orcid] }
+      Deprecation.warn "Use 'Hyrax::OrcidValidator.extract_bare_orcid(from:)'"
+      extract_bare_orcid_from(from: string)
     end
 
-    def self.orcid_regex
-      '^(?<prefix>https?://orcid.org/)?(?<orcid>\d{4}-\d{4}-\d{4}-\d{3}[\dX])/?$'
+    # @api public
+    # @param [String] from
+    # @return nil if the given string is not in the Orcid form
+    # @return string of the form "0000-0000-0000-0000" if the given string conforms to Orcid's format
+    # @see ORCID_REGEXP
+    def self.extract_bare_orcid(from:)
+      ORCID_REGEXP.match(from) { |m| m[:orcid] }
     end
-    private_class_method :orcid_regex
   end
 end

data/app/models/hyrax/pageview.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class Pageview
     extend ::Legato::Model

data/app/models/hyrax/pcdm_collection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_dependency 'hyrax/collection_name'
+
+module Hyrax
+  ##
+  # Valkyrie model for Collection domain objects in the Hydra Works model.
+  class PcdmCollection < Hyrax::Resource
+    include Hyrax::Schema(:core_metadata)
+
+    attribute :collection_type_gid, Valkyrie::Types::String
+    attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)
+
+    ##
+    # @api private
+    #
+    # @return [Class] an ActiveModel::Name compatible class
+    def self._hyrax_default_name_class
+      Hyrax::CollectionName
+    end
+  end
+end

data/app/models/hyrax/permission.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Valkyrie native permissions (access policies) for Hyrax
+  #
+  # Permissions are persisted independently from `Hyrax::Resource`s (works,
+  # collections, file sets, etc...) since their scope is different. Access policies
+  # may be application-specific and tend to update more frequently than resource
+  # metadata. This approach also allows policies to be persisted using a
+  # different database or adapter than is used for curatorial objects.
+  class Permission < Valkyrie::Resource
+    include Dry::Equalizer(:access_to, :agent, :mode)
+
+    attribute :access_to, Valkyrie::Types::ID
+    attribute :agent,     Valkyrie::Types::String
+    attribute :mode,      Valkyrie::Types::String
+  end
+end

data/app/models/hyrax/permission_template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Defines behavior that is applied to objects added as members of an AdminSet
   #
@@ -23,24 +24,26 @@ module Hyrax
     end
 
     # The list of workflows that could be activated; It includes the active workflow
-    has_many :available_workflows, class_name: 'Sipity::Workflow', dependent: :destroy, foreign_key: :permission_template_id
+    has_many :available_workflows, class_name: 'Sipity::Workflow', dependent: :destroy
 
     # In a perfect world, there would be a join table that enforced uniqueness on the ID.
     has_one :active_workflow, -> { where(active: true) }, class_name: 'Sipity::Workflow', foreign_key: :permission_template_id
 
     # A bit of an analogue for a `belongs_to :source_model` as it crosses from Fedora to the DB
-    # @return [AdminSet | Collection]
+    # @return [AdminSet, ::Collection]
     # @raise [Hyrax::ObjectNotFoundError] when neither an AdminSet or Collection is found
     def source_model
-      admin_set
-    rescue Hyrax::ObjectNotFoundError
-      collection
+      ActiveFedora::Base.find(source_id)
+    rescue ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     end
 
     # A bit of an analogue for a `belongs_to :admin_set` as it crosses from Fedora to the DB
+    # @deprecated Use #source_model instead
     # @return [AdminSet]
     # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the AdminSet
     def admin_set
+      Deprecation.warn('Use #source_model instead')
       return AdminSet.find(source_id) if AdminSet.exists?(source_id)
       raise Hyrax::ObjectNotFoundError
     rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
@@ -48,26 +51,28 @@ module Hyrax
     end
 
     # A bit of an analogue for a `belongs_to :collection` as it crosses from Fedora to the DB
+    # @deprecated Use #source_model instead
     # @return [Collection]
     # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the Collection
     def collection
-      return Collection.find(source_id) if Collection.exists?(source_id)
+      Deprecation.warn('Use #source_model instead')
+      return ::Collection.find(source_id) if ::Collection.exists?(source_id)
       raise Hyrax::ObjectNotFoundError
     rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
       raise Hyrax::ObjectNotFoundError
     end
 
     # Valid Release Period values
-    RELEASE_TEXT_VALUE_FIXED = 'fixed'.freeze
-    RELEASE_TEXT_VALUE_NO_DELAY = 'now'.freeze
+    RELEASE_TEXT_VALUE_FIXED = 'fixed'
+    RELEASE_TEXT_VALUE_NO_DELAY = 'now'
 
     # Valid Release Varies sub-options
-    RELEASE_TEXT_VALUE_BEFORE_DATE = 'before'.freeze
-    RELEASE_TEXT_VALUE_EMBARGO = 'embargo'.freeze
-    RELEASE_TEXT_VALUE_6_MONTHS = '6mos'.freeze
-    RELEASE_TEXT_VALUE_1_YEAR = '1yr'.freeze
-    RELEASE_TEXT_VALUE_2_YEARS = '2yrs'.freeze
-    RELEASE_TEXT_VALUE_3_YEARS = '3yrs'.freeze
+    RELEASE_TEXT_VALUE_BEFORE_DATE = 'before'
+    RELEASE_TEXT_VALUE_EMBARGO = 'embargo'
+    RELEASE_TEXT_VALUE_6_MONTHS = '6mos'
+    RELEASE_TEXT_VALUE_1_YEAR = '1yr'
+    RELEASE_TEXT_VALUE_2_YEARS = '2yrs'
+    RELEASE_TEXT_VALUE_3_YEARS = '3yrs'
 
     # Key/value pair of valid embargo periods. Values are number of months embargoed.
     RELEASE_EMBARGO_PERIODS = {
@@ -136,22 +141,22 @@ module Hyrax
 
     private
 
-      # If template requires no delays, check if date is exactly today
-      def check_no_delay_requirements(date)
-        return true unless release_no_delay?
-        date == Time.zone.today
-      end
-
-      # If template requires a release before a specific date, check this date is valid
-      def check_before_date_requirements(date)
-        return true unless release_before_date? && release_date.present?
-        date <= release_date
-      end
-
-      # If template requires an exact date, check this date matches
-      def check_fixed_date_requirements(date)
-        return true unless release_fixed_date? && release_date.present?
-        date == release_date
-      end
+    # If template requires no delays, check if date is exactly today
+    def check_no_delay_requirements(date)
+      return true unless release_no_delay?
+      date == Time.zone.today
+    end
+
+    # If template requires a release before a specific date, check this date is valid
+    def check_before_date_requirements(date)
+      return true unless release_before_date? && release_date.present?
+      date <= release_date
+    end
+
+    # If template requires an exact date, check this date matches
+    def check_fixed_date_requirements(date)
+      return true unless release_fixed_date? && release_date.present?
+      date == release_date
+    end
   end
 end

data/app/models/hyrax/resource.rb

@@ -1,14 +1,99 @@
 # frozen_string_literal: true
 
+require_dependency 'hyrax/resource_name'
+
 module Hyrax
   ##
   # The base Valkyrie model for Hyrax.
+  #
+  # @note Hyrax permissions are managed via
+  #   [Access Control List](https://en.wikipedia.org/wiki/Access-control_list)
+  #   style permissions. Legacy Hyrax models powered by `ActiveFedora` linked
+  #   the ACLs from the repository object itself (as an `acl:accessControl` link
+  #   to a container). Valkyrie models jettison that approach in favor of relying
+  #   on links back from the permissions using `access_to`. As was the case in
+  #   the past implementation, we include an object to represent the access list
+  #   itself (`Hyrax::AccessControl`). This object's `#access_to` is the way
+  #   Hyrax discovers list entries--it MUST match between the `AccessControl`
+  #   and its individual `Permissions`.
+  #
+  #   The effect of this change is that our `AccessControl` objects are detached
+  #   from `Hyrax::Resource` they can (and usually should) be edited and
+  #   persisted independently from the resource itself.
+  #
+  #   Some utilitiy methods are provided for ergonomics in transitioning from
+  #   `ActiveFedora`: the `#visibility` accessor, and the `#*_users` and
+  #   `#*_group` accessors. The main purpose of these is to provide a cached
+  #   ACL attached to a given Resource instance. However, these will likely be
+  #   deprecated in the future, and it's advisable to avoid them in favor of
+  #   `Hyrax::AccessControlList`, `Hyrax::PermissionManager` and/or
+  #   `Hyrax::VisibilityWriter` (which provide their underlying
+  #   implementations).
+  #
   class Resource < Valkyrie::Resource
-    include Valkyrie::Resource::AccessControls
+    include Hyrax::Naming
+    include Hyrax::WithEvents
+
+    attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
+    attribute :embargo,       Hyrax::Embargo.optional
+    attribute :lease,         Hyrax::Lease.optional
+
+    delegate :edit_groups, :edit_groups=,
+             :edit_users,  :edit_users=,
+             :read_groups, :read_groups=,
+             :read_users,  :read_users=, to: :permission_manager
+
+    class << self
+      ##
+      # @return [String] a human readable name for the model
+      def human_readable_type
+        I18n.translate("hyrax.models.#{model_name.i18n_key}", default: model_name.human)
+      end
+
+      private
+
+      ##
+      # @api private
+      #
+      # @return [Class] an ActiveModel::Name compatible class
+      def _hyrax_default_name_class
+        Hyrax::ResourceName
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    def collection?
+      false
+    end
+
+    ##
+    # @return [Boolean]
+    def file?
+      false
+    end
+
+    ##
+    # @return [Boolean]
+    def file_set?
+      false
+    end
+
+    ##
+    # @return [Boolean]
+    def pcdm_object?
+      false
+    end
+
+    ##
+    # @return [Boolean]
+    def work?
+      false
+    end
 
-    attribute :alternate_ids, ::Valkyrie::Types::Array
-    attribute :embargo,       Hyrax::Embargo
-    attribute :lease,         Hyrax::Lease
+    def permission_manager
+      @permission_manager ||= Hyrax::PermissionManager.new(resource: self)
+    end
 
     def visibility=(value)
       visibility_writer.assign_access_for(visibility: value)
@@ -20,12 +105,12 @@ module Hyrax
 
     protected
 
-      def visibility_writer
-        Hyrax::VisibilityWriter.new(resource: self)
-      end
+    def visibility_writer
+      Hyrax::VisibilityWriter.new(resource: self)
+    end
 
-      def visibility_reader
-        Hyrax::VisibilityReader.new(resource: self)
-      end
+    def visibility_reader
+      Hyrax::VisibilityReader.new(resource: self)
+    end
   end
 end

data/app/models/hyrax/statistic.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class Statistic < ActiveRecord::Base
     self.abstract_class = true
@@ -42,25 +43,25 @@ module Hyrax
 
       private
 
-        def cached_stats(object, start_date, _method)
-          stats = statistics_for(object).order(date: :asc)
-          ga_start_date = stats.any? ? stats[stats.size - 1].date + 1.day : start_date.to_date
-          { ga_start_date: ga_start_date, cached_stats: stats.to_a }
-        end
+      def cached_stats(object, start_date, _method)
+        stats = statistics_for(object).order(date: :asc)
+        ga_start_date = stats.any? ? stats[stats.size - 1].date + 1.day : start_date.to_date
+        { ga_start_date: ga_start_date, cached_stats: stats.to_a }
+      end
 
-        def combined_stats(object, start_date, object_method, ga_key, user_id = nil)
-          stat_cache_info = cached_stats(object, start_date, object_method)
-          stats = stat_cache_info[:cached_stats]
-          if stat_cache_info[:ga_start_date] < Time.zone.today
-            ga_stats = ga_statistics(stat_cache_info[:ga_start_date], object)
-            ga_stats.each do |stat|
-              lstat = build_for(object, date: stat[:date], object_method => stat[ga_key], user_id: user_id)
-              lstat.save unless Date.parse(stat[:date]) == Time.zone.today
-              stats << lstat
-            end
+      def combined_stats(object, start_date, object_method, ga_key, user_id = nil)
+        stat_cache_info = cached_stats(object, start_date, object_method)
+        stats = stat_cache_info[:cached_stats]
+        if stat_cache_info[:ga_start_date] < Time.zone.today
+          ga_stats = ga_statistics(stat_cache_info[:ga_start_date], object)
+          ga_stats.each do |stat|
+            lstat = build_for(object, date: stat[:date], object_method => stat[ga_key], user_id: user_id)
+            lstat.save unless Date.parse(stat[:date]) == Time.zone.today
+            stats << lstat
           end
-          stats
         end
+        stats
+      end
     end
 
     def to_flot

data/app/models/hyrax/uploaded_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Store a file uploaded by a user. Eventually these files get
   # attached to FileSets and pushed into Fedora.
@@ -10,5 +11,15 @@ module Hyrax
              class_name: 'JobIoWrapper',
              dependent: :destroy
     belongs_to :user, class_name: '::User'
+
+    def add_file_set!(file_set)
+      uri = case file_set
+            when ActiveFedora::Base
+              file_set.uri
+            when Hyrax::Resource
+              file_set.id
+            end
+      update!(file_set_uri: uri)
+    end
   end
 end

data/app/models/hyrax/version_committer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class VersionCommitter < ActiveRecord::Base
     self.table_name = 'version_committers'

data/app/models/hyrax/virus_scanner.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # The default virus scanner Hyrax::Works, ported from hydra_works.
 # If ClamAV is present, it will be used to check for the presence of a virus. If ClamAV is not
 # installed or otherwise not available to your application, Hyrax::Works does no virus checking
 # add assumes files have no viruses.
 #
-# To use a virus checker other than ClamAV:
+# @example to use a virus checker other than Hyrax::VirusScanner:
 #   class MyScanner < Hyrax::Works::VirusScanner
 #     def infected?
 #       my_result = Scanner.check_for_viruses(file)
@@ -11,8 +12,8 @@
 #     end
 #   end
 #
-# Then set Hyrax::Works to use your scanner either in a config file or initializer:
-#   Hyrax::Works.default_system_virus_scanner = MyScanner
+#   # Then set Hyrax::Works to use your scanner either in a config file or initializer:
+#   Hyrax.config.virus_scanner = MyScanner
 module Hyrax
   class VirusScanner
     attr_reader :file
@@ -49,8 +50,8 @@ module Hyrax
 
     private
 
-      def warning(msg)
-        Hyrax.logger&.warn(msg)
-      end
+    def warning(msg)
+      Hyrax.logger&.warn(msg)
+    end
   end
 end