hyrax 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 675c6cf986dd38320e1f9c76caa0e707bfdfd34b
-  data.tar.gz: 21487889ed825af87053b8ca78ad9a629f5ea0f1
+SHA256:
+  metadata.gz: 07d676d225e5f0e4dcf90474785b25b46ba44433088bd4f939b30ac893018907
+  data.tar.gz: '098e92006e2286deb06fe494b56a725051f25076906887842c922706a6502ea2'
 SHA512:
-  metadata.gz: 2cc13e4c761febbcc6d71a5f2169695d8723878198458bb6c024de8e92820e8f83cbd2dd18def0bd4fdc848d2b3efd56854f1d93afb758c80044c0fe19c53580
-  data.tar.gz: 38ef4eca1f3c896f65bae3df9923a1d40888cc458d1bf1431858ac41c71474a2b250044cf4f33a227d7f512c45224a2f91bd5d16ea2367af7f55ad9147691b06
+  metadata.gz: 4f2d39f2437e74fa39d13c35e30a931822b61aca590a0fdabd4136df2b5af8ac1a4110398c33cb7f60b5a595dae4cabc55d002d64520625fab99ef2301485dfe
+  data.tar.gz: b2d0d871115bd3c2ba06265f59a47906511b69be05fba5152444bb0e01a9b07ed3df586e622bd91b176b9ee8b805e48a0107e394f178a93db4b69aa9ef7066be

data/.circleci/config.yml

@@ -2,100 +2,163 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
-jobs:
-  build:
+version: 2.1
+executors:
+  ruby:
     docker:
-    # legacy needed for phantomjs
-    - image: circleci/ruby:2.5.1-node-browsers-legacy
-    - image: circleci/redis:4
-    - image: ualbertalib/docker-fcrepo4:4.7
-      environment:
-        CATALINA_OPTS: "-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server -Xms512m -Xmx1024m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC"
-    - image: solr:7-alpine
-      command: bin/solr -cloud -noprompt -f -p 8985
-
-    # Specify service dependencies here if necessary
-    # CircleCI maintains a library of pre-built images
-    # documented at https://circleci.com/docs/2.0/circleci-images/
-    # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
-    parallelism: 2
-
+      - image: circleci/ruby:2.5.3
+    working_directory: ~/hyrax
     environment:
-      RAILS_ENV: test
-      RACK_ENV: test
-      FCREPO_TEST_PORT: 8080/fcrepo
+      BUNDLE_PATH: vendor/bundle
       BUNDLE_JOBS: 4
       BUNDLE_RETRY: 3
-      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
-      ENGINE_CART_RAILS_OPTIONS: --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test
-      SPEC_OPTS: --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
-      COVERALLS_PARALLEL: true
 
+jobs:
+  bundle:
+    executor: ruby
     steps:
     - restore_cache:
         keys:
-        - source-v1-{{ .Branch }}-{{ .Revision }}
-        - source-v1-{{ .Branch }}-
-        - source-v1-
+        - v1-source-{{ .Branch }}-{{ .Revision }}
+        - v1-source-{{ .Branch }}-
+        - v1-source-
 
     - checkout
 
     - save_cache:
-        key: source-v1-{{ .Branch }}-{{ .Revision }}
+        key: v1-source-{{ .Branch }}-{{ .Revision }}
         paths:
         - ".git"
 
-    # BUNDLE_PATH is unset to allow for `bundle config path` to take precedence.
-    - run:
-        name: Extra environment setup
-        command: |
-          echo 'unset BUNDLE_PATH' >> $BASH_ENV
-
-    - restore_cache:
-        keys:
-        - v1-internal-test-app-{{ .Branch }}
-        - v1-internal-test-app-
-
-    # Download and cache dependencies
     - restore_cache:
         keys:
-        - v1-dependencies-{{ .Branch }}-{{ checksum "./.internal_test_app/.generated_engine_cart" }}
-        - v1-dependencies-{{ .Branch }}
-        - v1-dependencies-
+        - v1-bundle-{{ checksum "Gemfile" }}--{{ checksum "hyrax.gemspec" }}
+        - v1-bundle
 
     - run:
         name: Install dependencies
-        command: |
-          gem update --system
-          gem update bundler
-          bundle config path $CIRCLE_WORKING_DIRECTORY/vendor/bundle
-          bundle install
+        command: bundle check || bundle install
+
+    - save_cache:
+        key: v1-bundle-{{ checksum "Gemfile.lock" }}--{{ checksum "hyrax.gemspec" }}
+        paths:
+        - ~/hyrax/vendor/bundle
+
+    - persist_to_workspace:
+        root: ~/
+        paths:
+        - hyrax/*
+        - hyrax/**/*
+
+  lint:
+    executor: ruby
+    steps:
+    - attach_workspace:
+        at: ~/
 
     - run:
         name: Call Rubocop
         command: bundle exec rubocop
 
+  build:
+    docker:
+    - image: circleci/ruby:2.5.3-node
+
+    working_directory: ~/hyrax
+
+    environment:
+      BUNDLE_PATH: vendor/bundle
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+      RAILS_ENV: test
+      RACK_ENV: test
+      FCREPO_TEST_PORT: 8080/fcrepo
+      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+      ENGINE_CART_RAILS_OPTIONS: --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test
+      SPEC_OPTS: --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
+      COVERALLS_PARALLEL: true
+
+    steps:
+    - attach_workspace:
+        at: ~/
+
+    # Update to the latest release of Chrome
+    - run: wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+    - run: sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+    - run: sudo apt-get update && sudo apt-get -y install google-chrome-stable
+
+    - restore_cache:
+        keys:
+        - v1-test-app-{{ checksum "template.rb" }}--{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: Check dependencies
+        command: bundle check || bundle install
+
+    - run:
+        name: Generate test app
+        command: (git diff --name-only master | grep -qG 'generators\/hyrax') || bundle exec rake engine_cart:generate
+
     - run:
-        name: Generate test app, ensure top-level Gemfile.lock is valid
+        name: Ensure test app dependencies are installed
         command: |
-          bundle exec rake engine_cart:generate
-          bundle install
+          cd .internal_test_app
+          bundle check || bundle install
 
     - save_cache:
+        key: v1-test-app-{{ checksum "template.rb" }}--{{ checksum "Gemfile.lock" }}
         paths:
-        - ./.internal_test_app
-        key: v1-internal-test-app-{{ .Branch }}-{{ checksum "./.internal_test_app/.generated_engine_cart" }}
+        - ".internal_test_app"
+
+    - persist_to_workspace:
+        root: ~/
+        paths:
+        - hyrax/*
+        - hyrax/**/*
+
+  test:
+    docker:
+    - image: circleci/ruby:2.5.3-node-browsers-legacy
+    - image: circleci/redis:4
+    - image: ualbertalib/docker-fcrepo4:4.7
+      environment:
+        CATALINA_OPTS: "-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server -Xms512m -Xmx1024m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC"
+    - image: solr:7-alpine
+      command: bin/solr -cloud -noprompt -f -p 8985
+
+    working_directory: ~/hyrax
+    parallelism: 4
+
+    environment:
+      BUNDLE_PATH: vendor/bundle
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+      RAILS_ENV: test
+      RACK_ENV: test
+      FCREPO_TEST_PORT: 8080/fcrepo
+      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+      ENGINE_CART_RAILS_OPTIONS: --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test
+      SPEC_OPTS: --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
+      COVERALLS_PARALLEL: true
+
+    steps:
+    - attach_workspace:
+        at: ~/
+
+    - run:
+        name: Ensure top-level Gemfile.lock is valid
+        command: bundle check || bundle install
 
     - run:
-        name: Start headless Chrome
-        command: google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost
-        background: true
+        name: Uninstall chromedriver Gems
+        command: gem uninstall -ax chromedriver-helper
 
     - run:
-        name: Load config into SolrCloud
+        name: Install chromedriver Gems
+        command: gem install chromedriver-helper
+
+    - run:
+        name: Load config into solr
         command: |
           cd .internal_test_app/solr/config
           zip -1 -r solr_hyrax_config.zip ./*
@@ -108,18 +171,25 @@ jobs:
           mkdir /tmp/test-results
           bundle exec rspec $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
 
-    - run:
-        name: Clean dependencies
-        command: bundle clean
-
-    - save_cache:
-        paths:
-        - ./vendor/bundle
-        key: v1-dependencies-{{ .Branch }}-{{ checksum "./.internal_test_app/.generated_engine_cart" }}
-
     # collect reports
     - store_test_results:
         path: /tmp/test-results
     - store_artifacts:
         path: /tmp/test-results
         destination: test-results
+
+workflows:
+  version: 2
+  ci:
+    jobs:
+      - bundle
+      - lint:
+          requires:
+            - bundle
+      - build:
+          requires:
+            - bundle
+      - test:
+          requires:
+            - build
+            - lint

data/.travis.yml

@@ -3,7 +3,9 @@ sudo: required
 dist: trusty
 
 addons:
-  chrome: stable
+  apt:
+    packages:
+      - chromium-chromedriver
 cache:
   bundler: true
 
@@ -31,3 +33,4 @@ services:
   - redis-server
 before_script:
   - jdk_switcher use oraclejdk8
+  - ln -s /usr/lib/chromium-browser/chromedriver ~/bin/chromedriver

data/README.md

@@ -64,7 +64,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v2.4.1__. If you are looking for instructions on installing a different
+v2.5.0__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -163,7 +163,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.4.1/template.rb
+rails _5.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.5.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/app/actors/hyrax/actors/transactional_request.rb

@@ -1,24 +1,24 @@
 module Hyrax
   module Actors
-    # Wrap the stack in a database transaction.
-    # This will roll back any database actions (particularly workflow) if there
+    # Used to wrap the stack in a database transaction.
+    # This would have rolled back any database actions (particularly workflow) if there
     # is an error elsewhere in the actor stack.
+    # This was problematic, is removed in v3.0, and is currently a no-op
+    # Backport of https://github.com/samvera/hyrax/pull/3482
     class TransactionalRequest < Actors::AbstractActor
+      # rubocop:disable Rails/Delegate
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
-        ActiveRecord::Base.transaction do
-          next_actor.create(env)
-        end
+        next_actor.create(env)
       end
 
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if update was successful
       def update(env)
-        ActiveRecord::Base.transaction do
-          next_actor.update(env)
-        end
+        next_actor.update(env)
       end
+      # rubocop:enable Rails/Delegate
     end
   end
 end

data/app/services/hyrax/default_middleware_stack.rb

@@ -3,8 +3,10 @@ module Hyrax
     # rubocop:disable Metrics/MethodLength
     def self.build_stack
       ActionDispatch::MiddlewareStack.new.tap do |middleware|
-        # Wrap everything in a database transaction, if the save of the resource
-        # fails then roll back any database AdminSetChangeSet
+        # Used to wrap everything in a database transaction, if the save of the resource
+        # failed then rolled back any database AdminSetChangeSet
+        # This was problematic, is removed in v3.0, and is currently a no-op
+        # Backport of https://github.com/samvera/hyrax/pull/3482
         middleware.use Hyrax::Actors::TransactionalRequest
 
         # Ensure you are mutating the most recent version

data/app/views/catalog/_thumbnail_list_collection.html.erb

@@ -1,3 +1,4 @@
 <div class="col-md-2">
-  <span class="<%= Hyrax::ModelIcon.css_class_for(Collection) %> collection-icon-search" aria-hidden="true"></span>
-</div>
+  <%= render_thumbnail_tag document, {}, suppress_link: true %>
+</div> 
+

data/hyrax.gemspec

@@ -51,7 +51,7 @@ SUMMARY
   spec.add_dependency 'font-awesome-rails', '~> 4.2'
   spec.add_dependency 'hydra-derivatives', '~> 3.3'
   spec.add_dependency 'hydra-editor', '>= 3.3', '< 5.0'
-  spec.add_dependency 'hydra-head', '>= 10.5.0'
+  spec.add_dependency 'hydra-head', '>= 10.6.1'
   spec.add_dependency 'hydra-works', '>= 0.16', '< 2.0'
   spec.add_dependency 'iiif_manifest', '>= 0.3', '< 0.6'
   spec.add_dependency 'jquery-datatables-rails', '~> 3.4'
@@ -83,8 +83,9 @@ SUMMARY
   # temporary pin to 2.17 due to failures caused in 2.18.0
   spec.add_development_dependency "capybara", '~> 2.4', '< 2.18.0'
   spec.add_development_dependency 'capybara-maleficent', '~> 0.3.0'
+  spec.add_development_dependency 'chromedriver-helper', '~> 2.1'
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
-  spec.add_development_dependency 'engine_cart', '~> 2.0'
+  spec.add_development_dependency 'engine_cart', '~> 2.2'
   spec.add_development_dependency "equivalent-xml", '~> 0.5'
   spec.add_development_dependency "factory_bot", '~> 4.4'
   spec.add_development_dependency 'fcrepo_wrapper', '~> 0.5', '>= 0.5.1'
@@ -112,8 +113,4 @@ SUMMARY
   # simple_form 3.5.1 broke hydra-editor for certain model types;
   #   see: https://github.com/plataformatec/simple_form/issues/1549
   spec.add_dependency 'simple_form', '~> 3.2', '<= 3.5.0'
-  # chromedriver-helper 2.0 broke the chromedriver used by capybara
-  #   see: https://github.com/flavorjones/chromedriver-helper/issues/62
-  #        and https://github.com/flavorjones/chromedriver-helper/issues/57
-  spec.add_development_dependency 'chromedriver-helper', '< 2.0'
 end

data/lib/hyrax/version.rb

@@ -1,3 +1,3 @@
 module Hyrax
-  VERSION = '2.4.1'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/spec/abilities/collection_ability_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'CollectionAbility' do
 
   context 'when admin user' do
     let(:user) { FactoryBot.create(:admin) }
-    let!(:collection) { create(:collection, id: 'col_au', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_au', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     it 'allows all abilities' do # rubocop:disable RSpec/ExampleLength
@@ -34,7 +34,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection manager' do
-    let!(:collection) { create(:collection, id: 'col_mu', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_mu', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -69,7 +69,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection depositor' do
-    let!(:collection) { create(:collection, id: 'col_du', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_du', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -104,7 +104,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection viewer' do
-    let!(:collection) { create(:collection, id: 'col_vu', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_vu', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -139,7 +139,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when user has no special access' do
-    let!(:collection) { create(:collection, id: 'as', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { create(:collection_lw, id: 'as', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     it 'denies all abilities' do # rubocop:disable RSpec/ExampleLength

data/spec/abilities/permission_template_ability_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe 'PermissionTemplateAbility' do
   let(:current_user) { user }
   let(:collection_type_gid) { create(:collection_type).gid }
 
-  let!(:collection) { create(:collection, with_permission_template: true, collection_type_gid: collection_type_gid) }
+  let!(:collection) { create(:collection_lw, with_permission_template: true, collection_type_gid: collection_type_gid) }
   let(:permission_template) { collection.permission_template }
   let!(:permission_template_access) do
     create(:permission_template_access,