hyrax 3.0.0.pre.beta2 → 3.0.0.pre.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12ca8250128a0ea9333aacfe4a4b71832c0b1df954c5cd8299d2e8c9a897e097
-  data.tar.gz: ab169cfb14af7a7139e84070f1dce85532241b05654e20de78538799fbe6827a
+  metadata.gz: b731a39b621101c817e7f42e64698267274fd77331d2c121b9ac9a08260c50f1
+  data.tar.gz: d10cebe341c9acc25e99f1c41c4114aab2e2538270683ce926a8f55112cfaeda
 SHA512:
-  metadata.gz: 3568d5aa17c020e9baafd2e450fe2aeb7748c7a0e32a9e921d774607e9a9dbd9a042edd04c19e7b023578c9dc50f4f43c2f3379d9eb73d61552c610adfb2eaee
-  data.tar.gz: 00d6e736c3741544c4b627b7746ebc8e50cadfaadea9bc362c3b159c2ba5f57cc23fe2756423a29b48bf7ad7533c25922865a091940882734f5253b266674ed7
+  metadata.gz: 77dd20a9f9ded4e4d8dd1ae72b97f757a24a4a30b9a0f8ca5b2439f9d2d97e8c56685bad7aed892d48785cce0a72b9291d979f7009187a08b6578500ff357876
+  data.tar.gz: 48addfcb3e6657c6835c9f5ac215f8fd7164573334159e564a6689cb2adadd002ecb0418d391ca990df0b41d6588be3b1def3cf2163f54477c28d5ef88ac0be1

data/.circleci/config.yml

@@ -1,213 +1,150 @@
-# 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.5
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+        default: '5.2.2'
+    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 >>
+          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.5
+      bundler_version:
+        type: string
+        default: 1.17.3
+      rails_version:
+        type: string
+        default: '5.2.2'
+    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
-    - run: 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-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 >>
+          project: hyrax
+      - persist_to_workspace:
+          root: ~/
+          paths:
+          - project/*
+          - project/**/*
 
   test:
-    docker:
-    - image: circleci/ruby:2.6.0-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: 2
-
-    environment: &spec_env
-      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
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.5.5
+      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:
       COVERALLS_PARALLEL: true
-
-    steps: &run_specs
-    - 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
-
-  test-ruby-2-5:
-    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: 2
-    environment: *spec_env
-    steps:       *run_specs
+      VALKYRIE_SOLR_PORT: 8985
+    steps:
+      - attach_workspace:
+          at: ~/
+      - samvera/install_solr_core:
+          solr_config_path: .internal_test_app/solr/conf
+      - samvera/install_solr_core:
+          solr_config_path: .internal_test_app/solr/conf
+          core_name: hyrax-valkyrie-test
+      # 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 >>
+          project: hyrax
+      - samvera/parallel_rspec
 
 workflows:
   version: 2
-  ci:
+  ruby2-5-5:
     jobs:
-      - bundle
+      - bundle:
+          ruby_version: "2.5.5"
+          rails_version: "5.2.3"
       - lint:
+          ruby_version: "2.5.5"
           requires:
             - bundle
       - build:
+          ruby_version: "2.5.5"
+          rails_version: "5.2.3"
           requires:
             - bundle
       - test:
+          name: "ruby2-5-5"
+          ruby_version: "2.5.5"
           requires:
             - build
             - lint
-      - test-ruby-2-5:
+  ruby2-6-2:
+    jobs:
+      - bundle:
+          ruby_version: "2.6.2"
+          rails_version: "5.2.3"
+      - build:
+          ruby_version: "2.6.2"
+          rails_version: "5.2.3"
+          requires:
+            - bundle
+      - test:
+          name: "ruby2-6-2"
+          ruby_version: "2.6.2"
           requires:
             - build
-            - lint

data/.gitignore

@@ -25,6 +25,9 @@ tmtags
 ## VIM
 *.sw[pon]
 
+## VSCode
+.vscode
+
 ## OSX
 .DS_Store
 nohup.out

data/.regen

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

data/.rubocop_fixme.yml

@@ -129,7 +129,7 @@ RSpec/ExampleLength:
     - 'spec/services/hyrax/workflow/state_machine_generator_spec.rb'
     - 'spec/services/hyrax/workflow/workflow_importer_spec.rb'
     - 'spec/views/**/*'
-
+    - 'spec/wings/valkyrie/persister_spec.rb'
 RSpec/VerifiedDoubles:
   Enabled: false
 

data/README.md

@@ -1,7 +1,6 @@
 ![Logo](https://raw.githubusercontent.com/samvera/hyrax/gh-pages/assets/images/hyrax_logo_horizontal_white_background.png)
 
 Code: [![Version](https://badge.fury.io/rb/hyrax.png)](http://badge.fury.io/rb/hyrax)
-[![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=master)](https://travis-ci.org/samvera/hyrax)
 [![CircleCI](https://circleci.com/gh/samvera/hyrax.svg?style=svg)](https://circleci.com/gh/samvera/hyrax)
 [![Coverage Status](https://coveralls.io/repos/github/samvera/hyrax/badge.svg?branch=master)](https://coveralls.io/github/samvera/hyrax?branch=master)
 [![Code Climate](https://codeclimate.com/github/samvera/hyrax/badges/gpa.svg)](https://codeclimate.com/github/samvera/hyrax)
@@ -51,11 +50,12 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
 
 Hyrax is a front-end based on the robust [Samvera](http://samvera.org) framework, providing a user interface for common repository features. Hyrax offers the ability to create repository object types on demand, to deposit content via multiple configurable workflows, and to describe content with flexible metadata. Numerous optional features may be turned on in the administrative dashboard or added through plugins. It is implemented as a Rails engine, so it may be the base of, or added to, a Rails application. Hyrax is the consolidation of Sufia and the CurationConcerns gems and behaves in much the same way.
 
-## Feature list
+# Feature Documentation
 
-Hyrax has many features. [Read more about what they are and how to turn them on](https://github.com/samvera/hyrax/wiki/Feature-matrix). See the [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide) to learn more.
-
-For non-technical documentation about Hyrax, see the Hyrax [documentation site](http://hyr.ax/).
+* List of features: [Feature Matrix](https://github.com/samvera/hyrax/wiki/Feature-matrix)
+* Configuration and enabling features: [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide)
+* Walk-through on using features: [Hyrax Feature Guides](https://samvera.github.io/intro-to.html)
+* For general information about Hyrax: [Hyrax Site](https://hyrax.samvera.org/)
 
 # Help
 
@@ -64,14 +64,10 @@ 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
-v3.0.0-beta2__. If you are looking for instructions on installing a different
+v3.0.0-beta3__. 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...
@@ -119,7 +115,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).
 
@@ -143,11 +139,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 requires Rails 5. 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.3
 ```
 
 ### JavaScript runtime
@@ -163,7 +159,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/v3.0.0-beta2/template.rb
+rails _5.2.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.0.pre.beta3/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
@@ -326,7 +322,7 @@ If you'd like to help the development effort and you're not sure where to get st
 
 # Development
 
-The [Hyrax Development Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide) is for people who want to modify Hyrax itself, not an application that uses Hyrax.
+The [Hyrax Development Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide) is for people who want to modify Hyrax itself, not an application that uses Hyrax. See especially the [Quick Start](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#quick-start-for-hyrax-development) guide and instructions for running the [Hyrax test suite](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#run-the-test-suite).
 
 ## Reporting Security Issues
 

data/app/actors/hyrax/actors/active_fedora_to_valkyrie.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Actors
+    ##
+    # Casts `env.curation_concern` from a `ActiveFedora::Base` model to a
+    # `Valkyrie::Resource` resource.
+    #
+    # If the curation concern is not an `ActiveFedora::Base` this is a
+    # no-op.
+    #
+    # This can be used in conjunction with `ValkyrieToActiveFedora` to create a
+    # vertical boundary in the actor stack between actors that deal with
+    # `ActiveFedora` models and those that work on `Valkyrie::Resource` objects.
+    #
+    # @example defining a stack using both ActiveFedora and Valkyrie actors
+    #   stack = ActionDispatch::MiddlewareStack.new.tap do |middleware|
+    #     middleware.use ActorThatUsesActiveFedora
+    #     middleware.use AnotherActorThatUsesActiveFedora
+    #     middleware.use ValkyrieToActiveFedora # casts on the way up
+    #     middleware.use ActiveFedoraToValkyrie # casts on the way down
+    #     middleware.use ActorThatUsesValkyrie
+    #     middleware.use AnotherActorThatUsesValkyrie
+    #   end
+    #
+    #   actor = stack.build(Hyrax::Actors::Terminator.new)
+    #
+    # @see ValkyrieToActiveFedora
+    class ActiveFedoraToValkyrie < AbstractActor
+      # @param [Hyrax::Actors::Environment] env
+      # @return [Boolean] true
+      def create(env)
+        cast(env) && next_actor.create(env)
+      end
+
+      # @param [Hyrax::Actors::Environment] env
+      # @return [Boolean] true
+      def update(env)
+        cast(env) && next_actor.update(env)
+      end
+
+      # @param [Hyrax::Actors::Environment] env
+      # @return [Boolean] true
+      def destroy(env)
+        cast(env) && next_actor.destroy(env)
+      end
+
+      private
+
+        def cast(env)
+          return true unless env.curation_concern.is_a? ActiveFedora::Base
+
+          env.curation_concern = env.curation_concern.valkyrie_resource
+
+          true
+        end
+    end
+  end
+end