hyrax 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e192b584ccacb1817682f20c3f92863142dcd6bb0f5cf3ad94510c9bfd8b6e
-  data.tar.gz: 0f4e5459438aa41d335cad94e3c4fa9167d5dbc7eb52323cbb56a532e91c76a3
+  metadata.gz: ea0970bcb0ea485337ce206cd398d9ca95ce9f5dbd22bda820b6112e089ed624
+  data.tar.gz: c58183be603ec7ac6af52523412034f3b28332b2b8d5aa788239e7dabbf4c521
 SHA512:
-  metadata.gz: bc71e039869a7b368cdeb864333683d3b9079fb2d4191d70c8bbdb1cd32c8686060814846590d5b418321c9f57b28ab8b35989a86b02282453761a2c90d26467
-  data.tar.gz: 6540b1bcb3b98e523cf5d1790ca160ccb39a1cc0ecec77e2747205727c699710cb67f063fafd3030f8433b8ce0ce85ecc3b075a8e744ad5a8519a8a61ecd4e34
+  metadata.gz: af2b27f2c10d54ede9007a17f4a126bf408d92c163a924081658625212ff52edccb06bbc7edcf49fce1faa56c715bdf0454f687fbc284f93cfd8d30dbb26d46a
+  data.tar.gz: 85b38c0dc2628abbbb56dc8aed70461bb5fe6e9ce4444a2d61d6f972968efd1f9157881fc2a5f4443cb1bba85f0495b78e3bc2e7d0d7fe5ea9a8d4cb69d6946b

data/.circleci/config.yml

@@ -136,6 +136,21 @@ jobs:
           command: bundle exec rake app:db:migrate
       - samvera/parallel_rspec
 
+# Trigger a workflow on the nurax repository that will deploy the most recent hyrax gem code to https://nurax-dev.curationexperts.com/
+  deploy:
+    docker:
+      - image: ubuntu
+    steps:
+      - run:
+          name: Install curl
+          command: apt-get update && apt-get install -y curl
+      - run:
+          name: "Trigger Nurax deploy"
+          command: |
+            curl -X POST https://circleci.com/api/v2/project/gh/curationexperts/nurax/pipeline \
+            --header "Circle-Token: $NURAX_CIRCLECI_TOKEN" \
+            --header 'Accept: text/plain'    \
+            --header 'Content-Type: application/json'
 workflows:
   version: 2
   ruby2-5-8:
@@ -192,3 +207,10 @@ workflows:
           bundler_version: "2.1.4"
           requires:
             - build
+  nurax-dev_deploy:
+    jobs:
+      - deploy:
+          filters:
+            branches:
+              only:
+                - main

data/.dassie/Gemfile

@@ -1,4 +1,11 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+# Attempts to determine if a global gem source has ready been added by another Gemfile
+if @sources.global_rubygems_source == Bundler::SourceList.new.global_rubygems_source
+  Bundler.ui.info '[Dassie] Adding global rubygems source.'
+  source 'https://rubygems.org'
+else
+  Bundler.ui.info "[Dassie] Global rubygems source already set: #{@sources.global_rubygems_source.inspect}"
+end
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '2.7.2'
@@ -8,7 +15,7 @@ gem 'rails', '~> 5.2.4', '>= 5.2.4.4'
 # Use postgresql as the database for Active Record
 gem 'pg', '>= 0.18', '< 2.0'
 # Use Puma as the app server
-gem 'puma', '~> 3.11'
+gem 'puma', '~> 4.3.8'
 # Use SCSS for stylesheets
 gem 'sass-rails', '~> 5.0'
 # Use Uglifier as compressor for JavaScript assets
@@ -43,9 +50,7 @@ end
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
-begin # this is a hack to allow `eval_gemfile` to work correctly
-  gem 'hyrax', path: ENV.fetch('HYRAX_ENGINE_PATH', '..')
-rescue; end
+gemspec name: 'hyrax', path: ENV.fetch('HYRAX_ENGINE_PATH', '..')
 
 gem 'rsolr', '>= 1.0', '< 3'
 gem 'bootstrap-sass', '~> 3.0'

data/.dassie/config/initializers/hyrax.rb

@@ -39,6 +39,11 @@ Hyrax.config do |config|
   ##
   # Set the system-wide virus scanner
   config.virus_scanner = Hyrax::VirusScanner
+
+  ##
+  # To index to the Valkyrie core, uncomment the following two lines.
+  # config.query_index_from_valkyrie = true
+  # config.index_adapter = :solr_index
 end
 
 Date::DATE_FORMATS[:standard] = "%m/%d/%Y"

data/.dockerignore

@@ -10,3 +10,6 @@ Dockerfile
 artifacts/*
 coverage/*
 chart/*
+
+Gemfile.lock
+.dassie/Gemfile.lock

data/.env

@@ -1,4 +1,3 @@
-CAPYBARA_SERVER=http://app:3010
 CHROME_HEADLESS_MODE=false
 DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
 DATABASE_TEST_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax_test?pool=5

data/.rubocop.yml

@@ -41,6 +41,10 @@ Metrics/BlockLength:
 Style/AsciiComments:
   Enabled: false
 
+# rubocop suggests !thing.nil? instead, but that is NOT equivalent
+Style/DoubleNegation:
+  Enabled: false
+
 Style/CollectionMethods:
   PreferredMethods:
     collect: 'map'

data/CONTAINERS.md

@@ -8,7 +8,7 @@ providing better guidance around deployment.
 Where are we at?  It's complicated.  What we have below is experimental support, but one that we want to push
 towards.  We need your help to keep pushing in this direction.  So dig in and prepare to get your hands dirty.
 
-The [Hyrax Engine Development](#hyrax-engine-development) is further along than the [Docker Image for Hyrax-based Applications](docker-image-for-hyrax-based-applications) which is further along than [Deploying to Production](#deploying-to-production).
+The [Hyrax Engine Development](#hyrax-engine-development) is further along than the [Docker Image for Hyrax-based Applications](#docker-image-for-hyrax-based-applications) which is further along than [Deploying to Production](#deploying-to-production).
 
 <!-- NOTE: This title is referenced in the top-level README.md. Keep that in mind if you change it. -->
 ## Hyrax Engine Development

data/Dockerfile

@@ -44,7 +44,7 @@ ONBUILD RUN bundle install --jobs "$(nproc)"
 ONBUILD RUN RAILS_ENV=production SECRET_KEY_BASE=`bin/rake secret` DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake assets:precompile
 
 
-FROM hyrax-base as hyrax-worker
+FROM hyrax-base as hyrax-worker-base
 
 ENV MALLOC_ARENA_MAX=2
 
@@ -64,13 +64,17 @@ RUN mkdir -p /app/fits && \
     chmod a+x /app/fits/fits.sh
 ENV PATH="${PATH}:/app/fits"
 
+CMD bundle exec sidekiq
+
+
+FROM hyrax-worker-base as hyrax-worker
+
 ARG APP_PATH=.
 ARG BUNDLE_WITHOUT="development test"
 
 ONBUILD COPY --chown=1001:101 $APP_PATH /app/samvera/hyrax-webapp
 ONBUILD RUN bundle install --jobs "$(nproc)"
-
-CMD bundle exec sidekiq
+ONBUILD RUN RAILS_ENV=production SECRET_KEY_BASE=`bin/rake secret` DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake assets:precompile
 
 
 FROM hyrax-base as hyrax-engine-dev
@@ -83,11 +87,13 @@ ENV HYRAX_ENGINE_PATH /app/samvera/hyrax-engine
 COPY --chown=1001:101 $APP_PATH /app/samvera/hyrax-webapp
 COPY --chown=1001:101 . /app/samvera/hyrax-engine
 
-RUN cd /app/samvera/hyrax-engine && bundle install --jobs "$(nproc)"
+RUN gem update bundler && gem cleanup bundler && bundle -v && \
+  bundle install --jobs "$(nproc)" && \
+  cd $HYRAX_ENGINE_PATH && bundle install --jobs "$(nproc)"
 RUN RAILS_ENV=production SECRET_KEY_BASE='fakesecret1234' DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake assets:precompile
 
 
-FROM hyrax-worker as hyrax-engine-dev-worker
+FROM hyrax-worker-base as hyrax-engine-dev-worker
 
 ARG APP_PATH=.dassie
 ARG BUNDLE_WITHOUT=
@@ -97,4 +103,4 @@ ENV HYRAX_ENGINE_PATH /app/samvera/hyrax-engine
 COPY --chown=1001:101 $APP_PATH /app/samvera/hyrax-webapp
 COPY --chown=1001:101 . /app/samvera/hyrax-engine
 
-RUN cd /app/samvera/hyrax-engine && bundle install --jobs "$(nproc)"
+RUN bundle install --jobs "$(nproc)"

data/Gemfile

@@ -1,44 +1,38 @@
 # frozen_string_literal: true
-source 'https://rubygems.org' do
-  # Please see hyrax.gemspec for dependency information.
-  gemspec
+source 'https://rubygems.org'
+# Please see hyrax.gemspec for dependency information.
+gemspec
 
-  group :development, :test do
-    gem 'benchmark-ips'
-    gem 'easy_translate'
-    gem 'i18n-tasks'
-    gem 'okcomputer'
-    gem 'pry' unless ENV['CI']
-    gem 'pry-byebug' unless ENV['CI']
-    gem 'ruby-prof', require: false
-    gem "simplecov", require: false
-  end
+group :development, :test do
+  gem 'benchmark-ips'
+  gem 'easy_translate'
+  gem 'i18n-tasks'
+  gem 'okcomputer'
+  gem 'pry' unless ENV['CI']
+  gem 'pry-byebug' unless ENV['CI']
+  gem 'ruby-prof', require: false
+  gem "simplecov", require: false
 end
 
 test_app_path = ENV['RAILS_ROOT'] ||
                 ENV.fetch('ENGINE_CART_DESTINATION', File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 test_app_gemfile = File.expand_path('Gemfile', test_app_path)
 
+# rubocop:disable Bundler/DuplicatedGem
 if File.exist?(test_app_gemfile)
   begin
+    Bundler.ui.info "[Hyrax] Including test application dependencies from #{test_app_gemfile}"
     eval_gemfile test_app_gemfile
   rescue Bundler::GemfileError => e
     Bundler.ui.warn '[Hyrax] Skipping Rails application dependencies:'
     Bundler.ui.warn e.message
   end
+elsif ENV['RAILS_VERSION'] == 'edge'
+  gem 'rails', github: 'rails/rails', source: 'https://rubygems.org'
+  ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+elsif ENV['RAILS_VERSION']
+  gem 'rails', ENV['RAILS_VERSION'], source: 'https://rubygems.org'
 else
-  Bundler.ui.warn "[Hyrax] Unable to find test application dependencies in #{test_app_gemfile}, using placeholder dependencies"
-
-  # rubocop:disable Bundler/DuplicatedGem
-  if ENV['RAILS_VERSION']
-    if ENV['RAILS_VERSION'] == 'edge'
-      gem 'rails', github: 'rails/rails', source: 'https://rubygems.org'
-      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
-    else
-      gem 'rails', ENV['RAILS_VERSION'], source: 'https://rubygems.org'
-    end
-  end
-  # rubocop:enable Bundler/DuplicatedGem
-
-  eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__))
+  Bundler.ui.warn '[Hyrax] Skipping all Rails dependency injection'
 end
+# rubocop:enable Bundler/DuplicatedGem

data/app/actors/hyrax/actors/base_actor.rb

@@ -95,7 +95,7 @@ module Hyrax
       def clean_attributes(attributes)
         attributes[:license] = Array(attributes[:license]) if attributes.key? :license
         attributes[:rights_statement] = Array(attributes[:rights_statement]) if attributes.key? :rights_statement
-        remove_blank_attributes!(attributes)
+        remove_blank_attributes!(attributes).except('file_set')
       end
 
       # If any attributes are blank remove them

data/app/actors/hyrax/actors/create_with_remote_files_actor.rb

@@ -26,90 +26,112 @@ module Hyrax
 
       private
 
-      def registered_ingest_dirs
-        Hyrax.config.registered_ingest_dirs
+      def attach_files(env, remote_files)
+        ingest_remote_files_service_class.new(user: env.user,
+                                              curation_concern: env.curation_concern,
+                                              remote_files: remote_files,
+                                              file_set_actor_class: file_set_actor_class).attach!
       end
 
-      # @param uri [URI] the uri fo the resource to import
-      def validate_remote_url(uri)
-        if uri.scheme == 'file'
-          path = File.absolute_path(CGI.unescape(uri.path))
-          registered_ingest_dirs.any? do |dir|
-            path.start_with?(dir) && path.length > dir.length
+      class IngestRemoteFilesService
+        ##
+        # @parm user [User]
+        # @parm curation_concern [Hyrax::Work]
+        # @param remote_files [HashWithIndifferentAccess]
+        # @param file_set_actor_class
+        # @param ordered_members [Array]
+        # @param ordered [Boolean]
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(user:, curation_concern:, remote_files:, file_set_actor_class:, ordered_members: [], ordered: false)
+          @remote_files = remote_files
+          @user = user
+          @curation_concern = curation_concern
+          @file_set_actor_class = file_set_actor_class
+          @ordered_members = ordered_members
+          @ordered = ordered
+        end
+        # rubocop:enable Metrics/ParameterLists
+        attr_reader :remote_files, :user, :curation_concern, :ordered_members, :ordered, :file_set_actor_class
+
+        ##
+        # @return true
+        def attach!
+          return true unless remote_files
+          remote_files.each do |file_info|
+            next if file_info.blank? || file_info[:url].blank?
+            # Escape any space characters, so that this is a legal URI
+            uri = URI.parse(Addressable::URI.escape(file_info[:url]))
+            unless self.class.validate_remote_url(uri)
+              Rails.logger.error "User #{user.user_key} attempted to ingest file from url #{file_info[:url]}, which doesn't pass validation"
+              return false
+            end
+            auth_header = file_info.fetch(:auth_header, {})
+            create_file_from_url(uri, file_info[:file_name], auth_header)
           end
-        else
-          Rails.logger.debug "Assuming #{uri.scheme} uri is valid without a serious attempt to validate: #{uri}"
+          add_ordered_members! if ordered
           true
         end
-      end
 
-      # @param [HashWithIndifferentAccess] remote_files
-      # @return [TrueClass]
-      def attach_files(env, remote_files)
-        return true unless remote_files
-        remote_files.each do |file_info|
-          next if file_info.blank? || file_info[:url].blank?
-          # Escape any space characters, so that this is a legal URI
-          uri = URI.parse(Addressable::URI.escape(file_info[:url]))
-          unless validate_remote_url(uri)
-            Rails.logger.error "User #{env.user.user_key} attempted to ingest file from url #{file_info[:url]}, which doesn't pass validation"
-            return false
+        def self.registered_ingest_dirs
+          Hyrax.config.registered_ingest_dirs
+        end
+
+        # @param uri [URI] the uri fo the resource to import
+        def self.validate_remote_url(uri)
+          if uri.scheme == 'file'
+            path = File.absolute_path(CGI.unescape(uri.path))
+            registered_ingest_dirs.any? do |dir|
+              path.start_with?(dir) && path.length > dir.length
+            end
+          else
+            Rails.logger.debug "Assuming #{uri.scheme} uri is valid without a serious attempt to validate: #{uri}"
+            true
           end
-          auth_header = file_info.fetch(:auth_header, {})
-          create_file_from_url(env, uri, file_info[:file_name], auth_header)
         end
-        true
-      end
 
-      def create_file_from_url(env, uri, file_name, auth_header)
-        case env.curation_concern
-        when Valkyrie::Resource
-          create_file_from_url_through_valkyrie(env, uri, file_name, auth_header)
-        else
-          create_file_from_url_through_active_fedora(env, uri, file_name, auth_header)
+        private
+
+        def create_file_from_url(uri, file_name, auth_header)
+          import_url = URI.decode_www_form_component(uri.to_s)
+          use_valkyrie = false
+          case curation_concern
+          when Valkyrie::Resource
+            file_set = Hyrax.persister.save(resource: Hyrax::FileSet.new(import_url: import_url, label: file_name))
+            use_valkyrie = true
+          else
+            file_set = ::FileSet.new(import_url: import_url, label: file_name)
+          end
+          __create_file_from_url(file_set: file_set, uri: uri, auth_header: auth_header, use_valkyrie: use_valkyrie)
         end
-      end
 
-      # Generic utility for creating FileSet from a URL
-      # Used in to import files using URLs from a file picker like browse_everything
-      def create_file_from_url_through_active_fedora(env, uri, file_name, auth_header)
-        import_url = URI.decode_www_form_component(uri.to_s)
-        ::FileSet.new(import_url: import_url, label: file_name) do |fs|
-          actor = Hyrax::Actors::FileSetActor.new(fs, env.user)
-          actor.create_metadata(visibility: env.curation_concern.visibility)
-          actor.attach_to_work(env.curation_concern)
-          fs.save!
+        def __create_file_from_url(file_set:, uri:, auth_header:, use_valkyrie: Hyrax.config.use_valkyrie?)
+          actor = file_set_actor_class.new(file_set, user, use_valkyrie: use_valkyrie)
+          actor.create_metadata(visibility: curation_concern.visibility)
+          actor.attach_to_work(curation_concern)
+          file_set.save! if file_set.respond_to?(:save!)
+          # We'll remember the order, but if it's not `@ordered` we won't do anything.
+          ordered_members << file_set
           if uri.scheme == 'file'
             # Turn any %20 into spaces.
             file_path = CGI.unescape(uri.path)
-            IngestLocalFileJob.perform_later(fs, file_path, env.user)
+            IngestLocalFileJob.perform_later(file_set, file_path, user)
           else
-            ImportUrlJob.perform_later(fs, operation_for(user: actor.user), auth_header)
+            ImportUrlJob.perform_later(file_set, operation_for(user: user), auth_header)
           end
         end
-      end
 
-      # Generic utility for creating Hyrax::FileSet from a URL
-      # Used in to import files using URLs from a file picker like browse_everything
-      def create_file_from_url_through_valkyrie(env, uri, file_name, auth_header)
-        import_url = URI.decode_www_form_component(uri.to_s)
-        fs = Hyrax.persister.save(resource: Hyrax::FileSet.new(import_url: import_url, label: file_name))
-        actor = Hyrax::Actors::FileSetActor.new(fs, env.user, use_valkyrie: true)
-        actor.create_metadata(visibility: env.curation_concern.visibility)
-        actor.attach_to_work(env.curation_concern)
-        if uri.scheme == 'file'
-          # Turn any %20 into spaces.
-          file_path = CGI.unescape(uri.path)
-          IngestLocalFileJob.perform_later(fs, file_path, env.user)
-        else
-          ImportUrlJob.perform_later(fs, operation_for(user: actor.user), auth_header)
+        def operation_for(user:)
+          Hyrax::Operation.create!(user: user,
+                                   operation_type: "Attach Remote File")
         end
-      end
 
-      def operation_for(user:)
-        Hyrax::Operation.create!(user: user,
-                                 operation_type: "Attach Remote File")
+        def add_ordered_members!
+          actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
+          actor.attach_ordered_members_to_work(curation_concern)
+        end
       end
+      class_attribute :file_set_actor_class, default: ::Hyrax::Actors::FileSetActor
+      class_attribute :ingest_remote_files_service_class, default: ::Hyrax::Actors::CreateWithRemoteFilesActor::IngestRemoteFilesService
     end
   end
 end

data/app/actors/hyrax/actors/create_with_remote_files_ordered_members_actor.rb

@@ -39,54 +39,19 @@ module Hyrax
     # url property, it may have spaces, and not be a valid URI.
     class CreateWithRemoteFilesOrderedMembersActor < CreateWithRemoteFilesActor
       attr_reader :ordered_members
+      self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
 
       # @param [HashWithIndifferentAccess] remote_files
       # @return [TrueClass]
       def attach_files(env, remote_files)
-        return true unless remote_files
         @ordered_members = env.curation_concern.ordered_members.to_a
-        remote_files.each do |file_info|
-          next if file_info.blank? || file_info[:url].blank?
-          # Escape any space characters, so that this is a legal URI
-          uri = URI.parse(Addressable::URI.escape(file_info[:url]))
-          unless validate_remote_url(uri)
-            Rails.logger.error "User #{env.user.user_key} attempted to ingest file from url #{file_info[:url]}, which doesn't pass validation"
-            return false
-          end
-          auth_header = file_info.fetch(:auth_header, {})
-          create_file_from_url(env, uri, file_info[:file_name], auth_header)
-        end
-        add_ordered_members(env.user, env.curation_concern)
-        true
-      end
-
-      # Generic utility for creating FileSet from a URL
-      # Used in to import files using URLs from a file picker like browse_everything
-      def create_file_from_url(env, uri, file_name, auth_header = {})
-        ::FileSet.new(import_url: uri.to_s, label: file_name) do |fs|
-          actor = file_set_actor_class.new(fs, env.user)
-          actor.create_metadata(visibility: env.curation_concern.visibility)
-          actor.attach_to_work(env.curation_concern)
-          fs.save!
-          ordered_members << fs
-          if uri.scheme == 'file'
-            # Turn any %20 into spaces.
-            file_path = CGI.unescape(uri.path)
-            IngestLocalFileJob.perform_later(fs, file_path, env.user)
-          else
-            ImportUrlJob.perform_later(fs, operation_for(user: actor.user), auth_header)
-          end
-        end
+        ingest_remote_files_service_class.new(user: env.user,
+                                              curation_concern: env.curation_concern,
+                                              remote_files: remote_files,
+                                              ordered_members: @ordered_members,
+                                              ordered: true,
+                                              file_set_actor_class: file_set_actor_class).attach!
       end
-
-      # Add all file_sets as ordered_members in a single action
-      def add_ordered_members(user, work)
-        actor = Hyrax::Actors::OrderedMembersActor.new(ordered_members, user)
-        actor.attach_ordered_members_to_work(work)
-      end
-
-      class_attribute :file_set_actor_class
-      self.file_set_actor_class = Hyrax::Actors::FileSetOrderedMembersActor
     end
   end
 end