hyrax 3.0.0.pre.rc4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684ca77fe907962abffc140cd9b96081584650df75282c35e0ccd6fc041473ca
-  data.tar.gz: 661b6c451fa1fbd7f25d91ab56331e88827a4f3e88fddb85bbcb1623a7d9f068
+  metadata.gz: ea0970bcb0ea485337ce206cd398d9ca95ce9f5dbd22bda820b6112e089ed624
+  data.tar.gz: c58183be603ec7ac6af52523412034f3b28332b2b8d5aa788239e7dabbf4c521
 SHA512:
-  metadata.gz: 2f884204185783729a1d7a8d00dfa41c27e592097749f773418cdecf033aff2804e853ccefadf48d7d0c7c18da7576d3d1fa30aba05a58e687814f6d337b8c7c
-  data.tar.gz: ae5b51cbb3949d03967a5d4aa1650aaf77c8776d799df5456db09ff4b615ed8665699277f092e50267277afb654ca09e75200863f02f91c92b0f8f08465c0a60
+  metadata.gz: af2b27f2c10d54ede9007a17f4a126bf408d92c163a924081658625212ff52edccb06bbc7edcf49fce1faa56c715bdf0454f687fbc284f93cfd8d30dbb26d46a
+  data.tar.gz: 85b38c0dc2628abbbb56dc8aed70461bb5fe6e9ce4444a2d61d6f972968efd1f9157881fc2a5f4443cb1bba85f0495b78e3bc2e7d0d7fe5ea9a8d4cb69d6946b

data/.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
         default: 1.17.3
       rails_version:
         type: string
-        default: '5.2.2'
+        default: '5.2.6'
     executor:
       name: 'samvera/ruby'
       ruby_version: << parameters.ruby_version >>
@@ -22,6 +22,17 @@ jobs:
       NOKOGIRI_USE_SYSTEM_LIBRARIES: true
     steps:
       - samvera/cached_checkout
+
+      - run:
+          name: Check for a branch named 'master'
+          command: |
+            git fetch --all --quiet --prune --prune-tags
+            if [[ -n "$(git branch --all --list master */master)" ]]; then
+              echo "A branch named 'master' was found. Please remove it."
+              echo "$(git branch --all --list master */master)"
+            fi
+            [[ -z "$(git branch --all --list master */master)" ]]
+
       - samvera/bundle_for_gem:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
@@ -63,7 +74,7 @@ jobs:
         default: 1.17.3
       rails_version:
         type: string
-        default: '5.2.2'
+        default: '5.2.6'
     executor:
       name: 'samvera/ruby_fcrepo_solr_redis_postgres'
       ruby_version: << parameters.ruby_version >>
@@ -125,16 +136,31 @@ 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:
     jobs:
       - bundle:
           ruby_version: "2.5.8"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
       - build:
           ruby_version: "2.5.8"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           requires:
             - bundle
       - test:
@@ -146,10 +172,10 @@ workflows:
     jobs:
       - bundle:
           ruby_version: "2.6.6"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
       - build:
           ruby_version: "2.6.6"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           requires:
             - bundle
       - test:
@@ -167,11 +193,11 @@ workflows:
     jobs:
       - bundle:
           ruby_version: "2.7.2"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           bundler_version: "2.1.4"
       - build:
           ruby_version: "2.7.2"
-          rails_version: "5.2.4.3"
+          rails_version: "5.2.6"
           bundler_version: "2.1.4"
           requires:
             - bundle
@@ -181,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/cable.yml

@@ -6,5 +6,5 @@ test:
 
 production:
   adapter: redis
-  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  url: <%= ENV.fetch("REDIS_URL") { sprintf "redis://%s%s:%s/1", (ENV['REDIS_PASSWORD'].present? ? ":#{ENV['REDIS_PASSWORD']}@" : ''), ENV.fetch('REDIS_HOST', 'localhost'), ENV.fetch('REDIS_PORT', '6379') } %>
   channel_prefix: _dassie_production

data/.dassie/config/environments/development.rb

@@ -60,6 +60,8 @@ Rails.application.configure do
   # Suppress logger output for asset requests.
   config.assets.quiet = true
 
+  config.assets.prefix = '/dev-assets'
+
   # Raises error for missing translations
   config.action_view.raise_on_missing_translations = true
 

data/.dassie/config/environments/production.rb

@@ -23,7 +23,7 @@ Rails.application.configure do
   config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
   # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
+  config.assets.js_compressor = Uglifier.new(harmony: true)
   # config.assets.css_compressor = :sass
 
   # Do not fallback to assets pipeline if a precompiled asset is missed.

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/.dassie/config/initializers/riiif.rb

@@ -1,27 +1,29 @@
 # frozen_string_literal: true
-Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
-Riiif::Image.info_service = lambda do |id, _file|
-  # id will look like a path to a pcdm:file
-  # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
-  # but we just want the id for the FileSet it's attached to.
+ActiveSupport::Reloader.to_prepare do
+  Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+  Riiif::Image.info_service = lambda do |id, _file|
+    # id will look like a path to a pcdm:file
+    # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
+    # but we just want the id for the FileSet it's attached to.
 
-  # Capture everything before the first slash
-  fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
-  resp = Hyrax::SolrService.get("id:#{fs_id}")
-  doc = resp['response']['docs'].first
-  raise "Unable to find solr document with id:#{fs_id}" unless doc
-  { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
-end
+    # Capture everything before the first slash
+    fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
+    resp = Hyrax::SolrService.get("id:#{fs_id}")
+    doc = resp['response']['docs'].first
+    raise "Unable to find solr document with id:#{fs_id}" unless doc
+    { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
+  end
 
-Riiif::Image.file_resolver.id_to_uri = lambda do |id|
-  Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
-    Rails.logger.info "Riiif resolved #{id} to #{url}"
+  Riiif::Image.file_resolver.id_to_uri = lambda do |id|
+    Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
+      Rails.logger.info "Riiif resolved #{id} to #{url}"
+    end
   end
-end
 
-Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
+  Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
 
-Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
-Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
+  Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
+  Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
 
-Riiif::Engine.config.cache_duration = 365.days
+  Riiif::Engine.config.cache_duration = 365.days
+end

data/.dassie/config/redis.yml

@@ -7,3 +7,4 @@ test:
 production:
   host: <%= ENV.fetch('REDIS_HOST', 'localhost') %>
   port: <%= ENV.fetch('REDIS_PORT', 6379) %>
+  password: <%= ENV['REDIS_PASSWORD'] %>

data/.dassie/config/role_map.yml

@@ -1,4 +1,6 @@
 development:
+  admin:
+    - admin@example.com
   archivist:
     - archivist1@example.com
 

data/.dassie/db/seeds.rb

@@ -6,9 +6,17 @@
 #   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
 #   Character.create(name: 'Luke', movie: movies.first)
 
-Hyrax::Engine.load_seed
+Hyrax::Engine.load_seed unless ActiveModel::Type::Boolean.new.cast(ENV["SKIP_HYRAX_ENGINE_SEED"])
 
 puts "\n== Loading users"
 User.where(email: 'admin@example.com').first_or_create do |f|
   f.password = 'admin_password'
 end
+
+User.where(email: 'basic_user@example.com').first_or_create do |f|
+  f.password = 'password'
+end
+
+User.where(email: 'another_user@example.com').first_or_create do |f|
+  f.password = 'password'
+end

data/.dassie/package.json

@@ -8,10 +8,8 @@
 "scripts": {
   "preinstall": "rm -rf ./public/uv",
   "postinstall": "yarn run uv-install && yarn run uv-config",
-  "uv-install": "shx cp -r ./node_modules/universalviewer/dist ./public/uv",
-  "uv-config": "shx cp ./config/uv/uv.html ./public/uv/uv.html & shx cp ./config/uv/uv-config.json ./public/uv/"
+  "uv-install": "cp -r ./node_modules/universalviewer/dist ./public/uv",
+  "uv-config": "cp ./config/uv/uv.html ./public/uv/uv.html & cp ./config/uv/uv-config.json ./public/uv/"
   },
-  "devDependencies": {
-  "shx": "^0.3.2"
-  }
+  "devDependencies": {}
 }

data/.dockerignore

@@ -9,3 +9,7 @@ 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
@@ -7,7 +6,7 @@ DB_PORT=5432
 DB_HOST=postgres
 FCREPO_PORT=8080
 FCREPO_HOST=fcrepo
-FCREPO_REST_PATH=fcrepo/rest
+FCREPO_REST_PATH=rest
 FCREPO_TEST_BASE_PATH=/test
 HUB_URL=http://chrome:4444/wd/hub
 HYRAX_DERIVATIVES_PATH=/app/samvera/hyrax-webapp/derivatives/

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
@@ -107,6 +107,26 @@ I (Jeremy) find myself wanting to debug the application.  This requires a somewh
 
 This advice comes from [Debugging Rails App With Docker Compose: How to use Byebug in a dockerized rails app](https://medium.com/gogox-technology/debugging-rails-app-with-docker-compose-39a3767962f4).
 
+### Troubleshooting
+
+#### Bad Address SOLR
+
+With `docker-compose up` running, if you see the following, then there may be issues with file permissions:
+
+```
+db_migrate_1  | waiting for solr:8983
+db_migrate_1  | nc: bad address 'solr'
+```
+
+Check the Docker application logs and look for permission errors:
+
+```
+Executing /opt/docker-solr/scripts/precreate-core hyrax_test /opt/solr/server/configsets/hyraxconf
+cp: cannot create directory '/var/solr/data/hyrax_test': Permission denied
+```
+
+The solution that appears to work is to `docker-compose down --volumes`; This will tear down the docker instance, and remove the volumes.  You can then run `docker-compose up` to get back to work.  _**Note:** the `--volumes` switch will remove all custom data._
+
 <!-- NOTE: This title is referenced in the top-level documentation/developing-your-hyrax-based-app.md. Keep that in mind if you change it. -->
 ## Docker Image for Hyrax-based Applications
 

data/Dockerfile

@@ -7,10 +7,12 @@ ARG EXTRA_APK_PACKAGES="git"
 
 RUN apk --no-cache upgrade && \
   apk --no-cache add build-base \
+  curl \
   imagemagick \
   tzdata \
   nodejs \
   yarn \
+  zip \
   $DATABASE_APK_PACKAGE \
   $EXTRA_APK_PACKAGES
 
@@ -39,31 +41,19 @@ ARG BUNDLE_WITHOUT="development test"
 
 ONBUILD COPY --chown=1001:101 $APP_PATH /app/samvera/hyrax-webapp
 ONBUILD RUN bundle install --jobs "$(nproc)"
-ONBUILD RUN DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake assets:precompile
-
-FROM hyrax-base as hyrax-engine-dev
-
-ARG APP_PATH=.dassie
-ARG BUNDLE_WITHOUT=
-
-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 DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake yarn:install
+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-engine-dev as hyrax-engine-dev-worker
+FROM hyrax-base as hyrax-worker-base
 
 ENV MALLOC_ARENA_MAX=2
 
 USER root
 RUN apk --no-cache add bash \
+  ffmpeg \
+  mediainfo \
   openjdk11-jre \
-  perl \
-  mediainfo
+  perl
 USER app
 
 RUN mkdir -p /app/fits && \
@@ -75,3 +65,42 @@ RUN mkdir -p /app/fits && \
 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)"
+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
+
+ARG APP_PATH=.dassie
+ARG BUNDLE_WITHOUT=
+
+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 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-base as hyrax-engine-dev-worker
+
+ARG APP_PATH=.dassie
+ARG BUNDLE_WITHOUT=
+
+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 bundle install --jobs "$(nproc)"