hyrax 3.0.1 → 3.3.0

data/lib/generators/hyrax/work/templates/feature_spec.rb.erb

@@ -12,7 +12,7 @@ RSpec.feature 'Create a <%= class_name %>', js: false do
     let(:user) do
       User.new(user_attributes) { |u| u.save(validate: false) }
     end
-    let(:admin_set_id) { AdminSet.find_or_create_default_admin_set_id }
+    let(:admin_set_id) { Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
     let(:permission_template) { Hyrax::PermissionTemplate.find_or_create_by!(source_id: admin_set_id) }
     let(:workflow) { Sipity::Workflow.create!(active: true, name: 'test-workflow', permission_template: permission_template) }
 
@@ -31,11 +31,13 @@ RSpec.feature 'Create a <%= class_name %>', js: false do
     end
 
     scenario do
+      pending 'Changes may be required for this test to pass.  See TODO in test.'
+
       visit '/dashboard'
       click_link "Works"
       click_link "Add new work"
 
-      # If you generate more than one work uncomment these lines
+      # TODO: If you generate more than one work uncomment these lines
       # choose "payload_concern", option: "<%= class_name %>"
       # click_button "Create work"
 

data/lib/generators/hyrax/work_resource/templates/indexer_spec.rb.erb

@@ -7,6 +7,7 @@ require 'hyrax/specs/shared_specs/indexers'
 
 RSpec.describe <%= class_name %>Indexer do
   let(:indexer_class) { described_class }
+  let(:resource) { <%= class_name %>.new }
 
   it_behaves_like 'a Hyrax::Resource indexer'
 end

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # @api public
+  #
+  # Given a model class and an +id+, provides +ActiveModel+ style methods. This
+  # is a tool for providing route resolution and other +ActiveModel+ behavior
+  # for +ActiveFedora+ without loading the object from the fedora backend.
+  #
+  # @note this was originally implemented for +SolrDocument+ as
+  #   +Hyrax::SolrDocumentBehavior::ModelWrapper+, but is useful in the more
+  #   general case that we know the model class and id, but don't have a full
+  #   model object.
+  #
+  class ActiveFedoraDummyModel
+    ##
+    # @api public
+    #
+    # @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
+    #
+    # @note uses the @model's `._to_partial_path` if implemented, otherwise
+    #   constructs a default
+    def to_partial_path
+      return @model._to_partial_path if
+        @model.respond_to?(:_to_partial_path)
+
+      "hyrax/#{model_name.collection}/#{model_name.element}"
+    end
+
+    ##
+    # @api public
+    def to_global_id
+      URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
+    end
+  end
+end

data/lib/hyrax/collection_name.rb

@@ -8,8 +8,12 @@ module Hyrax
     def initialize(klass, namespace = nil, name = nil)
       super
 
-      @route_key          = Collection.model_name.route_key
-      @singular_route_key = Collection.model_name.singular_route_key
+      @human              = 'Collection'
+      @i18n_key           = :collection
+      @param_key          = 'collection'
+      @plural             = 'collections'
+      @route_key          = 'collections'
+      @singular_route_key = 'collection'
     end
   end
 end

data/lib/hyrax/configuration.rb

@@ -112,16 +112,46 @@ module Hyrax
         ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_ANALYTICS', false))
     end
 
-    attr_writer :google_analytics_id
-    def google_analytics_id
-      @google_analytics_id ||= nil
+    # Currently supports 'google' or 'matomo'
+    # google is default for backward compatability
+    attr_writer :analytics_provider
+    def analytics_provider
+      @analytics_provider ||=
+        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'google')
+    end
+
+    ##
+    # @!attribute [w] analytics_start_date
+    #   @note this can be set using the +ANALITICS_START_DATE+ environment variable (format is YYYY-MM-DD)
+    #   @return [String] date you wish to start collecting analytics for. used to compute the
+    #     "all-time" metrics.
+    # This is used to compute the "all-time" metrics
+    # Set this in your .env file (format is YYYY-MM-DD)
+    attr_writer :analytics_start_date
+    def analytics_start_date
+      @analytics_start_date ||=
+        ENV.fetch('ANALYTICS_START_DATE', Time.zone.today - 1.year)
     end
-    alias google_analytics_id? google_analytics_id
 
     # Defaulting analytic start date to whenever the file was uploaded by leaving it blank
     attr_writer :analytic_start_date
     attr_reader :analytic_start_date
 
+    ##
+    # @deprecated use analytics_id from config/analytics.yml instead
+    def google_analytics_id=(value)
+      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
+      Hyrax::Analytics.config.analytics_id = value
+    end
+
+    ##
+    # @deprecated use analytics_id from config/analytics.yml instead
+    def google_analytics_id
+      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
+      Hyrax::Analytics.config.analytics_id
+    end
+    alias google_analytics_id? google_analytics_id
+
     # @!endgroup
     # @!group Groups
 
@@ -385,6 +415,18 @@ module Hyrax
     # @!endgroup
     # @!group Valkyrie
 
+    ##
+    # @return [Valkyrie::StorageAdapter]
+    def branding_storage_adapter
+      @branding_storage_adapter ||= Valkyrie::StorageAdapter.find(:branding_disk)
+    end
+
+    ##
+    # @param [#to_sym] adapter
+    def branding_storage_adapter=(adapter)
+      @branding_storage_adapter = Valkyrie::StorageAdapter.find(adapter.to_sym)
+    end
+
     ##
     # @return [#save, #save_all, #delete, #wipe!] an indexing adapter
     def index_adapter
@@ -442,6 +484,17 @@ module Hyrax
     # Override characterization runner
     attr_accessor :characterization_runner
 
+    ##
+    # @!attribute [rw] characterization_service
+    #   @return [#run] the service to use for charactaerization for Valkyrie
+    #     objects
+    #   @ see Hyrax::Characterization::ValkyrieCharacterizationService
+    attr_writer :characterization_service
+    def characterization_service
+      @characterization_service ||=
+        Hyrax::Characterization::ValkyrieCharacterizationService
+    end
+
     # Attributes for the lock manager which ensures a single process/thread is mutating a ore:Aggregation at once.
     # @!attribute [w] lock_retry_count
     #   How many times to retry to acquire the lock before raising UnableToAcquireLockError
@@ -631,6 +684,14 @@ module Hyrax
       @show_work_item_rows ||= 10 # rows on show view
     end
 
+    # This user is logged as the acting user for jobs and other processes that
+    # run without being attributed to a specific user (e.g. creation of the
+    # default admin set).
+    attr_writer :system_user_key
+    def system_user_key
+      @system_user_key ||= 'systemuser@example.com'
+    end
+
     attr_writer :batch_user_key
     def batch_user_key
       @batch_user_key ||= 'batchuser@example.com'
@@ -646,6 +707,55 @@ module Hyrax
       @collection_type_index_field ||= 'collection_type_gid_ssim'
     end
 
+    attr_writer :collection_model
+    ##
+    # @return [#constantize] a string representation of the collection
+    #   model
+    def collection_model
+      @collection_model ||= '::Collection'
+    end
+
+    ##
+    # @return [Class] the configured collection model class
+    def collection_class
+      collection_model.safe_constantize
+    end
+
+    attr_writer :admin_set_model
+    ##
+    # @return [#constantize] a string representation of the admin set
+    #   model
+    def admin_set_model
+      @admin_set_model ||= 'AdminSet'
+    end
+
+    ##
+    # @return [Class] the configured admin set model class
+    def admin_set_class
+      admin_set_model.constantize
+    end
+
+    ##
+    # @return [String] the default admin set id
+    def default_admin_set_id
+      default_admin_set.id.to_s
+    end
+
+    ##
+    # @return [Hyrax::AdministrativeSet] the default admin set
+    # @see Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+    def default_admin_set
+      @default_admin_set ||= Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+    end
+
+    ##
+    # If the default admin set is changed, call reset.  The next time one of the default
+    # admin set configs is checked, the default_admin_set variable will be updated.
+    # @see Hyrax::DefaultAdministrativeSet.update
+    def reset_default_admin_set
+      @default_admin_set = nil
+    end
+
     attr_writer :id_field
     def id_field
       @id_field || index_field_mapper.id_field

data/lib/hyrax/engine.rb

@@ -3,25 +3,27 @@ module Hyrax
   class Engine < ::Rails::Engine
     isolate_namespace Hyrax
 
+    require 'almond-rails'
     require 'awesome_nested_set'
     require 'breadcrumbs_on_rails'
+    require 'clipboard/rails'
     require 'draper'
-    require 'dry/struct'
     require 'dry/equalizer'
     require 'dry/events'
+    require 'dry/struct'
     require 'dry/validation'
-    require 'jquery-ui-rails'
+    require 'flipflop'
     require 'flot-rails'
-    require 'almond-rails'
+    require 'hydra-file_characterization'
     require 'jquery-datatables-rails'
-    require 'flipflop'
+    require 'jquery-ui-rails'
+    require 'legato'
     require 'qa'
-    require 'clipboard/rails'
     require 'tinymce-rails'
-    require 'legato'
     require 'valkyrie'
 
     require 'hydra/derivatives'
+    require 'hyrax/active_fedora_dummy_model'
     require 'hyrax/controller_resource'
     require 'hyrax/form_fields'
     require 'hyrax/indexer'
@@ -31,6 +33,7 @@ module Hyrax
     require 'hyrax/search_state'
     require 'hyrax/transactions'
     require 'hyrax/errors'
+    require 'hyrax/valkyrie_simple_path_generator'
 
     # Force these models to be added to Legato's registry in development mode
     config.eager_load_paths += %W[

data/lib/hyrax/errors.rb

@@ -12,5 +12,7 @@ module Hyrax
 
   class SingleUseError < HyraxError; end
 
+  class SingleMembershipError < HyraxError; end
+
   class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
 end

data/lib/hyrax/form_fields.rb

@@ -49,6 +49,7 @@ module Hyrax
 
       form_field_definitions.each do |field_name, options|
         descendant.property field_name.to_sym, options.merge(display: true, default: [])
+        descendant.validates field_name.to_sym, presence: true if options.fetch(:required, false)
       end
     end
   end

data/lib/hyrax/publisher.rb

@@ -94,6 +94,18 @@ module Hyrax
     # @macro a_registered_event
     register_event('batch.created')
 
+    # @since 3.0.0
+    # @macro a_registered_event
+    register_event('collection.metadata.updated')
+
+    # @since 3.0.0
+    # @macro a_registered_event
+    register_event('collection.membership.updated')
+
+    # @since 3.3.0
+    # @macro a_registered_event
+    register_event('file.downloaded')
+
     # @since 3.0.0
     # @macro a_registered_event
     register_event('file.set.audited')
@@ -129,5 +141,9 @@ module Hyrax
     # @since 3.0.0
     # @macro a_registered_event
     register_event('object.metadata.updated')
+
+    # @since 3.2.0
+    # @macro a_registered_event
+    register_event('object.file.uploaded')
   end
 end

data/lib/hyrax/resource_name.rb

@@ -7,6 +7,7 @@ module Hyrax
   class ResourceName < Name
     def initialize(klass, namespace = nil, name = nil)
       super
+      return unless defined?(Wings::ModelRegistry)
 
       legacy_model = Wings::ModelRegistry.lookup(klass)
       return unless legacy_model

data/lib/hyrax/resource_sync/change_list_writer.rb

@@ -61,8 +61,8 @@ module Hyrax
 
       def build_resources(xml, doc_set)
         doc_set.each do |doc|
-          model = doc.fetch('has_model_ssim', []).first.constantize
-          if model == ::Collection
+          model = doc.fetch('has_model_ssim', []).first.safe_constantize
+          if model.try(:collection?) || model == Hyrax.config.collection_class
             build_resource(xml, doc, model, hyrax_routes)
           else
             build_resource(xml, doc, model, main_app_routes)

data/lib/hyrax/resource_sync/resource_list_writer.rb

@@ -32,8 +32,8 @@ module Hyrax
         end
       end
 
-      def build_collections(xml)
-        ::Collection.search_in_batches(public_access) do |doc_set|
+      def build_collections(xml, searcher: AbstractTypeRelation.new(allowable_types: [::Collection, Hyrax.config.collection_class]))
+        searcher.search_in_batches(public_access) do |doc_set|
           build_resources(xml, doc_set, hyrax_routes)
         end
       end

data/lib/hyrax/specs/capybara.rb

@@ -15,9 +15,9 @@ require 'capybara/rspec'
 require 'capybara/rails'
 require 'capybara-screenshot/rspec'
 require 'selenium-webdriver'
-require 'webdrivers'
+require 'webdrivers' unless ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
-if ENV['IN_DOCKER'].present?
+if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
 
@@ -40,7 +40,9 @@ if ENV['IN_DOCKER'].present?
 
   Capybara.server_host = '0.0.0.0'
   Capybara.server_port = 3010
-  Capybara.app_host = ENV['CAPYBARA_SERVER'] || 'http://127.0.0.1:3010'
+
+  ip = IPSocket.getaddress(Socket.gethostname)
+  Capybara.app_host = "http://#{ip}:#{Capybara.server_port}"
 else
   TEST_HOST = 'localhost:3000'.freeze
   # @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux

data/lib/hyrax/specs/shared_specs/hydra_works.rb

@@ -152,6 +152,8 @@ end
 RSpec.shared_examples 'a Hyrax::AdministrativeSet' do
   subject(:admin_set) { described_class.new }
 
+  it_behaves_like 'a model with core metadata'
+
   it 'has an #alternative_title' do
     expect { admin_set.alternative_title = ['Moomin'] }
       .to change { admin_set.alternative_title }

data/lib/hyrax/specs/shared_specs/indexers.rb

@@ -188,5 +188,11 @@ RSpec.shared_examples 'a Collection indexer' do
       expect(indexer.to_solr)
         .to include(thumbnail_path_ss: include('assets/collection', '.png'))
     end
+
+    it 'indexes depositor' do
+      expect(indexer.to_solr)
+        .to include(depositor_ssim: [resource.depositor],
+                    depositor_tesim: [resource.depositor])
+    end
   end
 end

data/lib/hyrax/specs/shared_specs/valkyrie_storage_versions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a Valkyrie::StorageAdapter with versioning support' do
+  describe '#supports?' do
+    it 'supports versions' do
+      expect(storage_adapter.supports?(:versions)).to eq true
+    end
+  end
+end

data/lib/hyrax/transactions/admin_set_create.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Creates a Hyrax::AdministrativeSet from a ChangeSet
+    #
+    # @since 3.2.0
+    class AdminSetCreate < Transaction
+      DEFAULT_STEPS = ['change_set.apply',
+                       'admin_set_resource.apply_collection_type_permissions',
+                       'admin_set_resource.save_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/collection_create.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Creates a Collection from a ChangeSet
+    #
+    # @since 3.2.0
+    class CollectionCreate < Transaction
+      DEFAULT_STEPS = ['change_set.set_user_as_depositor',
+                       'change_set.set_collection_type_gid',
+                       'change_set.add_to_collections',
+                       'change_set.apply',
+                       'collection_resource.apply_collection_type_permissions',
+                       'collection_resource.save_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/collection_update.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Creates a Collection from a ChangeSet
+    #
+    # @since 3.2.0
+    class CollectionUpdate < Transaction
+      DEFAULT_STEPS = ['change_set.apply'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/container.rb

@@ -18,21 +18,29 @@ module Hyrax
     #
     # @see https://dry-rb.org/gems/dry-container/
     class Container # rubocop:disable Metrics/ClassLength
+      require 'hyrax/transactions/admin_set_create'
       require 'hyrax/transactions/apply_change_set'
+      require 'hyrax/transactions/collection_create'
+      require 'hyrax/transactions/collection_update'
       require 'hyrax/transactions/create_work'
       require 'hyrax/transactions/destroy_work'
+      require 'hyrax/transactions/file_set_destroy'
       require 'hyrax/transactions/work_create'
       require 'hyrax/transactions/work_destroy'
       require 'hyrax/transactions/update_work'
       require 'hyrax/transactions/steps/add_file_sets'
       require 'hyrax/transactions/steps/add_to_collections'
+      require 'hyrax/transactions/steps/add_to_parent'
       require 'hyrax/transactions/steps/apply_collection_permission_template'
+      require 'hyrax/transactions/steps/apply_collection_type_permissions'
       require 'hyrax/transactions/steps/apply_permission_template'
       require 'hyrax/transactions/steps/apply_visibility'
       require 'hyrax/transactions/steps/delete_resource'
       require 'hyrax/transactions/steps/destroy_work'
       require 'hyrax/transactions/steps/ensure_admin_set'
+      require 'hyrax/transactions/steps/set_collection_type_gid'
       require 'hyrax/transactions/steps/ensure_permission_template'
+      require 'hyrax/transactions/steps/remove_file_set_from_work'
       require 'hyrax/transactions/steps/save'
       require 'hyrax/transactions/steps/save_work'
       require 'hyrax/transactions/steps/save_access_control'
@@ -55,6 +63,14 @@ module Hyrax
           ApplyChangeSet.new
         end
 
+        ops.register 'create_collection' do
+          CollectionCreate.new
+        end
+
+        ops.register 'update_collection' do
+          CollectionUpdate.new
+        end
+
         ops.register 'create_work' do
           WorkCreate.new
         end
@@ -67,6 +83,10 @@ module Hyrax
           Steps::Save.new
         end
 
+        ops.register 'set_collection_type_gid' do
+          Steps::SetCollectionTypeGid.new
+        end
+
         ops.register 'set_default_admin_set' do
           Steps::SetDefaultAdminSet.new
         end
@@ -92,11 +112,49 @@ module Hyrax
         end
       end
 
+      namespace 'file_set' do |ops| # Hyrax::FileSet
+        ops.register 'delete' do
+          Steps::DeleteResource.new
+        end
+
+        ops.register 'destroy' do
+          FileSetDestroy.new
+        end
+
+        ops.register 'remove_from_work' do
+          Steps::RemoveFileSetFromWork.new
+        end
+      end
+
+      namespace 'admin_set_resource' do |ops| # valkyrie administrative set
+        ops.register 'apply_collection_type_permissions' do
+          Steps::ApplyCollectionTypePermissions.new
+        end
+
+        ops.register 'save_acl' do
+          Steps::SaveAccessControl.new
+        end
+      end
+
+      namespace 'collection_resource' do |ops| # valkyrie collection
+        ops.register 'apply_collection_type_permissions' do
+          Steps::ApplyCollectionTypePermissions.new
+        end
+
+        ops.register 'save_acl' do
+          Steps::SaveAccessControl.new
+        end
+      end
+
       namespace 'work_resource' do |ops| # valkyrie works
         ops.register 'add_file_sets' do
           Steps::AddFileSets.new
         end
 
+        ops.register 'add_to_parent' do
+          Steps::AddToParent.new
+        end
+
         ops.register 'delete' do
           Steps::DeleteResource.new
         end

data/lib/hyrax/transactions/file_set_destroy.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # destroys a FileSet resource.
+    #
+    # @since 3.1.0
+    class FileSetDestroy < Transaction
+      DEFAULT_STEPS = ['file_set.remove_from_work',
+                       'file_set.delete'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/add_file_sets.rb

@@ -20,10 +20,11 @@ module Hyrax
         ##
         # @param [Hyrax::Work] obj
         # @param [Enumerable<UploadedFile>] uploaded_files
+        # @param [Enumerable<Hash>] file_set_params
         #
         # @return [Dry::Monads::Result]
-        def call(obj, uploaded_files: [])
-          if @handler.new(work: obj).add(files: uploaded_files).attach
+        def call(obj, uploaded_files: [], file_set_params: [])
+          if @handler.new(work: obj).add(files: uploaded_files, file_set_params: file_set_params).attach
             Success(obj)
           else
             Failure[:failed_to_attach_file_sets, uploaded_files]