hyrax 2.5.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52ca5db4f8ce55b87305b9bfbbbe4bfc7464958f5070e3cb4911f04feed87352
-  data.tar.gz: 4f9977600707f112927aed03cc8f985f7b125ca04d13344a3effb66350755ca2
+  metadata.gz: 140c7caa34751f7a525eda269abcee6331a9e7d200863e2cbee29d315966de65
+  data.tar.gz: 7085c394edd0aa1e90baef7d13f90245d8fb0fb65659e54549cedda0487445e9
 SHA512:
-  metadata.gz: ea378dc6fb860157cf4330ed9d82d915123c89da7db61b44412fe44fc18da317806ad0716d08fec07d8b98cec963531607b828a6fab1a771a0576e2d8e649e52
-  data.tar.gz: 304be0cc47238943179bd32d1d843c7a7a7413c4daf4bcc58d9cdba5fcdb7a024e5cb4e7f55b4656872c4f352a36533b5f6d05b21cb6441ce1cdc084c9838d5c
+  metadata.gz: 691b84f363281552cbd84f85b767bb5b460ba749e0449aed0498594143767a6cd4dae187a5dd9c88bf3b7bd06a568375da70367b3b8faa674a59f39deaf4df06
+  data.tar.gz: e19605afaa51b569ea79e7e99d65fd0576b172cd6dfeb38f815c4dd3a7ac18678bb6b3ff4ac4a5af2b6358bf55c459baba0c4a98b393d20f7d64388f576c894f

data/.circleci/config.yml

@@ -1,195 +1,182 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
 version: 2.1
-executors:
-  ruby:
-    docker:
-      - image: circleci/ruby:2.5.3
-    working_directory: ~/hyrax
-    environment:
-      BUNDLE_PATH: vendor/bundle
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-
+orbs:
+  samvera: samvera/circleci-orb@0
 jobs:
   bundle:
-    executor: ruby
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.5.8
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+        default: '5.2.4.3'
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+    resource_class: medium+
+    environment:
+      RAILS_VERSION: << parameters.rails_version >>
+      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
     steps:
-    - restore_cache:
-        keys:
-        - v1-source-{{ .Branch }}-{{ .Revision }}
-        - v1-source-{{ .Branch }}-
-        - v1-source-
-
-    - checkout
-
-    - save_cache:
-        key: v1-source-{{ .Branch }}-{{ .Revision }}
-        paths:
-        - ".git"
-
-    - restore_cache:
-        keys:
-        - v1-bundle-{{ checksum "Gemfile" }}--{{ checksum "hyrax.gemspec" }}
-        - v1-bundle
-
-    - run:
-        name: Install dependencies
-        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/**/*
+      - samvera/cached_checkout
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          cache_version: '{{ checksum ".regen" }}'
+          project: hyrax
+      - persist_to_workspace:
+          root: ~/
+          paths:
+          - project/*
+          - project/**/*
 
   lint:
-    executor: ruby
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.5.5
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+    resource_class: medium+
     steps:
-    - attach_workspace:
-        at: ~/
-
-    - run:
-        name: Call Rubocop
-        command: bundle exec rubocop
+      - attach_workspace:
+          at: ~/
+      - samvera/rubocop
 
   build:
-    docker:
-    - image: circleci/ruby:2.5.3-node
-
-    working_directory: ~/hyrax
-
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.5.8
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+        default: '5.2.4.3'
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+    resource_class: medium+
     environment:
-      BUNDLE_PATH: vendor/bundle
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-      RAILS_ENV: test
-      RACK_ENV: test
-      FCREPO_TEST_PORT: 8080/fcrepo
+      RAILS_VERSION: << parameters.rails_version >>
       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: Ensure test app dependencies are installed
-        command: |
-          cd .internal_test_app
-          bundle check || bundle install
-
-    - save_cache:
-        key: v1-test-app-{{ checksum "template.rb" }}--{{ checksum "Gemfile.lock" }}
-        paths:
-        - ".internal_test_app"
-
-    - persist_to_workspace:
-        root: ~/
-        paths:
-        - hyrax/*
-        - hyrax/**/*
+      - attach_workspace:
+          at: ~/
+      - samvera/engine_cart_generate:
+          cache_key: v1-2.x-internal-test-app-{{ checksum "hyrax.gemspec" }}-{{ checksum ".regen" }}-<< parameters.rails_version >>-<< parameters.ruby_version >>
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          cache_version: '{{ checksum ".regen" }}'
+          project: hyrax
+      - persist_to_workspace:
+          root: ~/
+          paths:
+          - project/*
+          - project/**/*
 
   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
-
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.5.8
+      bundler_version:
+        type: string
+        default: 1.17.3
+    executor:
+      name: 'samvera/ruby_fcrepo_solr_redis'
+      ruby_version: << parameters.ruby_version >>
+    resource_class: medium+
+    parallelism: 10
     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: Uninstall chromedriver Gems
-        command: gem uninstall -ax chromedriver-helper
-
-    - run:
-        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 ./*
-          curl -H "Content-type:application/octet-stream" --data-binary @solr_hyrax_config.zip "http://localhost:8985/solr/admin/configs?action=UPLOAD&name=hyrax"
-          curl -H 'Content-type: application/json' http://localhost:8985/api/collections/ -d '{create: {name: hydra-test, config: hyrax, numShards: 1}}'
-
-    - run:
-        name: Run rspec in parallel
-        command: |
-          mkdir /tmp/test-results
-          bundle exec rspec $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-
-    # collect reports
-    - store_test_results:
-        path: /tmp/test-results
-    - store_artifacts:
-        path: /tmp/test-results
-        destination: test-results
+      - attach_workspace:
+          at: ~/
+      - samvera/install_solr_core:
+          solr_config_path: .internal_test_app/solr/config
+      # Rerun bundler in case this is a different ruby version than bundle and build steps
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          cache_version: '{{ checksum ".regen" }}'
+          project: hyrax
+      - samvera/parallel_rspec
 
 workflows:
   version: 2
-  ci:
+  ruby2-5rails5-1:
     jobs:
-      - bundle
+      - bundle:
+          ruby_version: "2.5.8"
+          rails_version: "5.1.7"
       - lint:
+          ruby_version: "2.5.8"
           requires:
             - bundle
       - build:
+          ruby_version: "2.5.8"
+          rails_version: "5.1.7"
           requires:
             - bundle
       - test:
+          name: "rails5-1"
+          ruby_version: "2.5.8"
           requires:
             - build
             - lint
+  ruby2-5rails5-2:
+    jobs:
+      - bundle:
+          ruby_version: "2.5.8"
+          rails_version: "5.2.4.3"
+      - build:
+          ruby_version: "2.5.8"
+          rails_version: "5.2.4.3"
+          requires:
+            - bundle
+      - test:
+          name: "ruby2-5-8"
+          ruby_version: "2.5.8"
+          requires:
+            - build
+  ruby2-6rails5-2:
+    jobs:
+      - bundle:
+          ruby_version: "2.6.6"
+          rails_version: "5.2.4.3"
+      - build:
+          ruby_version: "2.6.6"
+          rails_version: "5.2.4.3"
+          requires:
+            - bundle
+      - test:
+          name: "ruby2-6-6"
+          ruby_version: "2.6.6"
+          requires:
+            - build
+  ruby2-7rails5-2:
+    jobs:
+      - bundle:
+          ruby_version: "2.7.1"
+          rails_version: "5.2.4.3"
+          bundler_version: "2.1.2"
+      - build:
+          ruby_version: "2.7.1"
+          rails_version: "5.2.4.3"
+          bundler_version: "2.1.2"
+          requires:
+            - bundle
+      - test:
+          name: "ruby2-7-1"
+          ruby_version: "2.7.1"
+          bundler_version: "2.1.2"
+          requires:
+            - build

data/.regen

@@ -0,0 +1 @@
+3

data/README.md

@@ -67,10 +67,6 @@ 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.
 
-## Quickstart
-
-If you're looking to spin up a vanilla Hyrax application very quickly for demonstration purposes, you may be interested in [the samvera-vagrant project](https://github.com/samvera-labs/samvera-vagrant) which may be used to "kick the tires" of Hyrax and [Hyku](https://github.com/samvera-labs/hyku). It requires VirtualBox and Vagrant.
-
 ## Prerequisites
 
 Prerequisites are required for both creating a Hyrax\-based app and contributing new features to Hyrax. After installing the prerequisites...
@@ -118,7 +114,7 @@ Hyrax includes support for transcoding audio and video files with ffmpeg > 1.0 i
 
 On OSX, you can use Homebrew to install ffmpeg:
 
-`brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis`
+`brew install libvpx ffmpeg`
 
 Otherwise, to compile ffmpeg yourself, see the [ffmpeg compilation guide](https://trac.ffmpeg.org/wiki/CompilationGuide).
 
@@ -132,7 +128,7 @@ Note here that the following commands assume you're setting up Hyrax in a develo
 
 First, you'll need a working Ruby installation. You can install this via your operating system's package manager -- you are likely to get farther with OSX, Linux, or UNIX than Windows but your mileage may vary -- but we recommend using a Ruby version manager such as [RVM](https://rvm.io/) or [rbenv](https://github.com/sstephenson/rbenv).
 
-Hyrax supports Ruby 2.3, 2.4 and 2.5. When starting a new project, we recommend using the latest Ruby 2.5 version.
+Hyrax supports Ruby 2.3 and up. When starting a new project, we recommend using the latest Ruby 2.7 version.
 
 ## Redis
 
@@ -142,11 +138,11 @@ Starting up Redis will depend on your operating system, and may in fact already
 
 ## Rails
 
-Hyrax requires Rails 5. We recommend the latest Rails 5.1 release.
+Hyrax 2.x supports Rails 5.1 and 5.2. We recommend the latest Rails 5.2 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.1.6
+gem install rails -v '5.2.4.3'
 ```
 
 ### JavaScript runtime
@@ -162,7 +158,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.5.1/template.rb
+rails _5.2.4.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.8.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/add_to_work_actor.rb

@@ -5,7 +5,8 @@ module Hyrax
       # @return [Boolean] true if create was successful
       def create(env)
         work_ids = env.attributes.delete(:in_works_ids)
-        next_actor.create(env) && add_to_works(env, work_ids)
+
+        can_edit_works?(env, work_ids) && next_actor.create(env) && add_to_works(env, work_ids)
       end
 
       # @param [Hyrax::Actors::Environment] env
@@ -21,6 +22,15 @@ module Hyrax
           env.current_ability.can?(:edit, work) && env.current_ability.can?(:edit, env.curation_concern)
         end
 
+        def can_edit_works?(env, work_ids)
+          unless Array(work_ids).all? { |work_id| env.current_ability.can?(:edit, work_id) }
+            add_permissions_error(env.curation_concern)
+            return false
+          end
+
+          true
+        end
+
         def add_to_works(env, new_work_ids)
           return true if new_work_ids.nil?
           cleanup_ids_to_remove_from_curation_concern(env, new_work_ids)
@@ -39,16 +49,25 @@ module Hyrax
 
         def add_new_work_ids_not_already_in_curation_concern(env, new_work_ids)
           # add to new so long as the depositor for the parent and child matches, otherwise inject an error
-          (new_work_ids - env.curation_concern.in_works_ids).each do |work_id|
-            work = ::ActiveFedora::Base.find(work_id)
+          new_works_for(env, new_work_ids).each do |work|
             if can_edit_both_works?(env, work)
               work.ordered_members << env.curation_concern
               work.save!
             else
-              env.curation_concern.errors[:in_works_ids] << "Works can only be related to each other if user has ability to edit both."
+              add_permissions_error(env.curation_concern)
             end
           end
         end
+
+        def new_works_for(env, new_work_ids)
+          (new_work_ids - env.curation_concern.in_works_ids).map do |work_id|
+            ::ActiveFedora::Base.find(work_id)
+          end
+        end
+
+        def add_permissions_error(work)
+          work.errors[:in_works_ids] << "Works can only be related to each other if user has ability to edit both."
+        end
     end
   end
 end