hyrax 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0379fe162c5ff9207af59dc36af58aead2df14c
-  data.tar.gz: c5802ec9c6318be8056ff459a39441a80cc12b7c
+  metadata.gz: f12bc4422975b30df6990632d50bbd5b39bfa033
+  data.tar.gz: 1cbc32cf3989e372d2cff38780af758606fbaec3
 SHA512:
-  metadata.gz: cd7d19603b15aa26f5a8500f3f3249e71985e52ce8070b24d9a88d04efad6a239dc9b1d036d80e29c93774dc6839dd3366fdf497dbd6bf544de4f6e7d29e78b0
-  data.tar.gz: 29e50bbf459b2a8200d0adf473b6334cee516c8f4fb6f6ab6758ea8bdba86f257a7c9bd1cfde14ac323abf64438095331c0d8bde81a184a240c24e441c29e969
+  metadata.gz: 74c91fe48c1b7c981ae6c81201d3cbd8732c4efacdfbfb4dcb0652f799a6317efaafcb5171f8dc26a54577cfa834623f9fb2aae01ee62d52fcc41335519a8826
+  data.tar.gz: 577a72b3cfe93ba8b47d02da6d418a2dad6066ac9c874c92070a9d4d4beabaaaac5962d1860ecd5b2d60184023a406f859715869bcd8bab0aa158c160642cd3b

data/README.md

@@ -1,7 +1,7 @@
 ![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)
+[![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=1-0-stable)](https://travis-ci.org/samvera/hyrax/branches)
 [![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)
 [![Dependency Update Status](https://gemnasium.com/samvera/hyrax.png)](https://gemnasium.com/samvera/hyrax)
@@ -59,7 +59,7 @@ If you have questions or need help, please email [the Samvera community tech lis
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v1.0.5__. If you are looking for instructions on installing a different
+v1.1.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.
 
@@ -121,7 +121,7 @@ Hyrax requires Rails 5. We recommend the latest Rails 5.0 release.
 
 ```
 # If you don't already have Rails at your disposal...
-gem install rails -v 5.0.3
+gem install rails -v 5.0.4
 ```
 
 ### JavaScript runtime
@@ -133,7 +133,7 @@ Rails requires that you have a JavaScript runtime -- for example, nodejs -- inst
 Generate a new Rails application using the template.
 
 ```
-rails new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v1.0.5/template.rb
+rails new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v1.1.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/services/hyrax/file_set_derivatives_service.rb

@@ -49,8 +49,7 @@ module Hyrax
       def create_pdf_derivatives(filename)
         Hydra::Derivatives::PdfDerivatives.create(filename,
                                                   outputs: [{ label: :thumbnail, format: 'jpg', size: '338x493', url: derivative_url('thumbnail') }])
-        Hydra::Derivatives::FullTextExtract.create(filename,
-                                                   outputs: [{ url: uri, container: "extracted_text" }])
+        extract_full_text(filename, uri)
       end
 
       def create_office_document_derivatives(filename)
@@ -58,8 +57,7 @@ module Hyrax
                                                        outputs: [{ label: :thumbnail, format: 'jpg',
                                                                    size: '200x150>',
                                                                    url: derivative_url('thumbnail') }])
-        Hydra::Derivatives::FullTextExtract.create(filename,
-                                                   outputs: [{ url: uri, container: "extracted_text" }])
+        extract_full_text(filename, uri)
       end
 
       def create_audio_derivatives(filename)
@@ -83,5 +81,15 @@ module Hyrax
       def derivative_path_factory
         Hyrax::DerivativePath
       end
+
+      # Calls the Hydra::Derivates::FulltextExtraction unless the extract_full_text
+      # configuration option is set to false
+      # @param [String] filename of the object to be used for full text extraction
+      # @param [String] uri to the file set (deligated to file_set)
+      def extract_full_text(filename, uri)
+        return unless Hyrax.config.extract_full_text?
+        Hydra::Derivatives::FullTextExtract.create(filename,
+                                                   outputs: [{ url: uri, container: "extracted_text" }])
+      end
   end
 end

data/app/views/hyrax/collections/_collection_description.erb

@@ -1,3 +1,3 @@
-<% presenter.description.each do |description| %>
+<% presenter.description.try(:each) do |description| %>
     <p class="collection_description"><%= iconify_auto_link(description) %></p>
 <% end %>

data/hyrax.gemspec

@@ -80,7 +80,7 @@ EOF
   spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
   spec.add_development_dependency "capybara", '~> 2.4'
   spec.add_development_dependency "poltergeist", "~> 1.5"
-  spec.add_development_dependency "factory_girl_rails", '~> 4.4'
+  spec.add_development_dependency "factory_bot_rails", '~> 4.4'
   spec.add_development_dependency "equivalent-xml", '~> 0.5'
   spec.add_development_dependency "jasmine", '~> 2.3'
   spec.add_development_dependency 'rubocop', '~> 0.47.0'
@@ -90,4 +90,11 @@ EOF
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'i18n-debug' unless ENV['TRAVIS']
   spec.add_development_dependency 'i18n_yaml_sorter' unless ENV['TRAVIS']
+
+  ########################################################
+  # Temporarily pinned dependencies. INCLUDE EXPLANATIONS.
+  #
+  # 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'
 end

data/lib/generators/hyrax/templates/config/hyrax.rb

@@ -71,6 +71,10 @@ Hyrax.config do |config|
   # Path to the file derivatives creation tool
   # config.libreoffice_path = "soffice"
 
+  # Option to enable/disable full text extraction from PDFs
+  # Default is true, set to false to disable full text extraction
+  # config.extract_full_text = true
+
   # How many seconds back from the current time that we should show by default of the user's activity on the user's dashboard
   # config.activity_to_show_default_seconds_since_now = 24*60*60
 

data/lib/hyrax/configuration.rb

@@ -428,6 +428,12 @@ module Hyrax
       @subject_prefix ||= "Contact form:"
     end
 
+    attr_writer :extract_full_text
+    def extract_full_text?
+      return @extract_full_text unless @extract_full_text.nil?
+      @extract_full_text = true
+    end
+
     attr_writer :model_to_create
     # Returns a lambda that takes a hash of attributes and returns a string of the model
     # name. This is called by the batch upload process

data/lib/hyrax/version.rb

@@ -1,3 +1,3 @@
 module Hyrax
-  VERSION = '1.0.5'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/abilities/file_set_abilities_spec.rb

@@ -26,7 +26,7 @@ describe 'User' do
       end
 
       describe 'as a repository manager' do
-        let(:manager_user) { FactoryGirl.create(:admin) }
+        let(:manager_user) { FactoryBot.create(:admin) }
         let(:creating_user) { user }
         let(:current_user) { manager_user }
         it do
@@ -39,7 +39,7 @@ describe 'User' do
       end
 
       describe 'another authenticated user' do
-        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:creating_user) { FactoryBot.create(:user) }
         let(:current_user) { user }
 
         it do
@@ -52,7 +52,7 @@ describe 'User' do
       end
 
       describe 'a nil user' do
-        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:creating_user) { FactoryBot.create(:user) }
         let(:current_user) { nil }
         it do
           is_expected.not_to be_able_to(:create, FileSet.new)

data/spec/abilities/generic_work_abilities_spec.rb

@@ -5,8 +5,8 @@ describe 'User' do
   describe 'Abilities' do
     subject { Ability.new(current_user) }
 
-    let(:generic_work) { FactoryGirl.create(:private_generic_work, user: creating_user) }
-    let(:user) { FactoryGirl.create(:user) }
+    let(:generic_work) { FactoryBot.create(:private_generic_work, user: creating_user) }
+    let(:user) { FactoryBot.create(:user) }
 
     describe 'without embargo' do
       describe 'creator of object' do
@@ -21,7 +21,7 @@ describe 'User' do
       end
 
       describe 'as a repository manager' do
-        let(:manager_user) { FactoryGirl.create(:admin) }
+        let(:manager_user) { FactoryBot.create(:admin) }
         let(:creating_user) { user }
         let(:current_user) { manager_user }
         it do
@@ -33,7 +33,7 @@ describe 'User' do
       end
 
       describe 'another authenticated user' do
-        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:creating_user) { FactoryBot.create(:user) }
         let(:current_user) { user }
         it do
           is_expected.to be_able_to(:create, GenericWork.new)
@@ -45,7 +45,7 @@ describe 'User' do
       end
 
       describe 'a nil user' do
-        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:creating_user) { FactoryBot.create(:user) }
         let(:current_user) { nil }
         it do
           is_expected.not_to be_able_to(:create, GenericWork.new)

data/spec/actors/hyrax/actors/generic_work_actor_spec.rb

@@ -85,7 +85,7 @@ describe Hyrax::Actors::GenericWorkActor do
       context 'with in_work_ids' do
         let(:parent) { create(:generic_work, user: user) }
         let(:attributes) do
-          FactoryGirl.attributes_for(:generic_work, visibility: visibility, admin_set_id: admin_set.id).merge(
+          FactoryBot.attributes_for(:generic_work, visibility: visibility, admin_set_id: admin_set.id).merge(
             in_works_ids: [parent.id]
           )
         end
@@ -103,7 +103,7 @@ describe Hyrax::Actors::GenericWorkActor do
 
       context 'with a file' do
         let(:attributes) do
-          FactoryGirl.attributes_for(:generic_work, admin_set_id: admin_set.id, visibility: visibility).tap do |a|
+          FactoryBot.attributes_for(:generic_work, admin_set_id: admin_set.id, visibility: visibility).tap do |a|
             a[:files] = file
           end
         end
@@ -138,7 +138,7 @@ describe Hyrax::Actors::GenericWorkActor do
       context 'with multiple files' do
         let(:file_actor) { double }
         let(:attributes) do
-          FactoryGirl.attributes_for(:generic_work, admin_set_id: admin_set.id, visibility: visibility).tap do |a|
+          FactoryBot.attributes_for(:generic_work, admin_set_id: admin_set.id, visibility: visibility).tap do |a|
             a[:files] = [file, file]
           end
         end
@@ -168,7 +168,7 @@ describe Hyrax::Actors::GenericWorkActor do
 
       context 'with a present and a blank title' do
         let(:attributes) do
-          FactoryGirl.attributes_for(:generic_work, admin_set_id: admin_set.id, title: ['this is present', ''])
+          FactoryBot.attributes_for(:generic_work, admin_set_id: admin_set.id, title: ['this is present', ''])
         end
 
         it 'stamps each link with the access rights' do
@@ -204,7 +204,7 @@ describe Hyrax::Actors::GenericWorkActor do
       let(:parent) { create(:generic_work, user: user) }
       let(:old_parent) { create(:generic_work, user: user) }
       let(:attributes) do
-        FactoryGirl.attributes_for(:generic_work).merge(
+        FactoryBot.attributes_for(:generic_work).merge(
           in_works_ids: [parent.id]
         )
       end
@@ -219,9 +219,9 @@ describe Hyrax::Actors::GenericWorkActor do
       end
     end
     context 'without in_works_ids' do
-      let(:old_parent) { FactoryGirl.create(:generic_work) }
+      let(:old_parent) { FactoryBot.create(:generic_work) }
       let(:attributes) do
-        FactoryGirl.attributes_for(:generic_work).merge(
+        FactoryBot.attributes_for(:generic_work).merge(
           in_works_ids: []
         )
       end
@@ -239,9 +239,9 @@ describe Hyrax::Actors::GenericWorkActor do
       end
     end
     context 'with nil in_works_ids' do
-      let(:parent) { FactoryGirl.create(:generic_work) }
+      let(:parent) { FactoryBot.create(:generic_work) }
       let(:attributes) do
-        FactoryGirl.attributes_for(:generic_work).merge(
+        FactoryBot.attributes_for(:generic_work).merge(
           in_works_ids: nil
         )
       end
@@ -260,7 +260,7 @@ describe Hyrax::Actors::GenericWorkActor do
       let!(:collection1) { create(:collection, user: user) }
       let!(:collection2) { create(:collection, user: user) }
       let(:attributes) do
-        FactoryGirl.attributes_for(:generic_work, member_of_collection_ids: [collection2.id])
+        FactoryBot.attributes_for(:generic_work, member_of_collection_ids: [collection2.id])
       end
       before do
         curation_concern.apply_depositor_metadata(user.user_key)
@@ -288,7 +288,7 @@ describe Hyrax::Actors::GenericWorkActor do
       let(:file_set2) { create(:file_set) }
       let(:curation_concern) { create(:generic_work, user: user, ordered_members: [file_set1, file_set2], admin_set_id: admin_set.id) }
       let(:attributes) do
-        FactoryGirl.attributes_for(:generic_work, ordered_member_ids: [file_set2.id, file_set1.id])
+        FactoryBot.attributes_for(:generic_work, ordered_member_ids: [file_set2.id, file_set1.id])
       end
       it 'updates the order of file sets' do
         expect(curation_concern.ordered_members.to_a).to eq [file_set1, file_set2]
@@ -300,7 +300,7 @@ describe Hyrax::Actors::GenericWorkActor do
       ## Is this something we want to support?
       context "when told to stop ordering a file set" do
         let(:attributes) do
-          FactoryGirl.attributes_for(:generic_work, ordered_member_ids: [file_set2.id])
+          FactoryBot.attributes_for(:generic_work, ordered_member_ids: [file_set2.id])
         end
         it "works" do
           expect(curation_concern.ordered_members.to_a).to eq [file_set1, file_set2]

data/spec/actors/hyrax/actors/transactional_request_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Hyrax::Actors::TransactionalRequest do
   let(:good_actor) do
     Class.new(Hyrax::Actors::AbstractActor) do
       def create(_attributes)
-        FactoryGirl.create(:user)
+        FactoryBot.create(:user)
       end
     end
   end

data/spec/controllers/hyrax/admin/users_controller_spec.rb

@@ -1,12 +1,12 @@
 describe Hyrax::Admin::UsersController, type: :controller do
-  let!(:user) { FactoryGirl.create(:user) }
+  let!(:user) { FactoryBot.create(:user) }
   before do
     expect(controller).to receive(:authorize!).with(:read, :admin_dashboard).and_return(true)
   end
-  let!(:admin_user) { FactoryGirl.create(:user, groups: 'admin') }
+  let!(:admin_user) { FactoryBot.create(:user, groups: 'admin') }
   let!(:audit_user) { User.audit_user }
   let!(:batch_user) { User.batch_user }
-  let!(:guest_user) { FactoryGirl.create(:user, :guest) }
+  let!(:guest_user) { FactoryBot.create(:user, :guest) }
 
   describe "#index" do
     it "is successful" do

data/spec/controllers/hyrax/api/items_controller_spec.rb

@@ -20,7 +20,7 @@ describe Hyrax::API::ItemsController, type: :controller do
 
   context 'with an HTTP GET or HEAD' do
     let(:token) { user.arkivo_token }
-    let(:item) { FactoryGirl.json(:post_item, token: token) }
+    let(:item) { FactoryBot.json(:post_item, token: token) }
     let(:item_hash) { JSON.parse(item) }
 
     context 'with a missing token' do
@@ -115,7 +115,7 @@ describe Hyrax::API::ItemsController, type: :controller do
       let(:deposited_file) { FileSet.where(label: item_hash['file']['filename']).take }
       let(:a_work) { build :generic_work, id: '123' }
       let!(:token) { user.arkivo_token }
-      let(:item) { FactoryGirl.json(:post_item, token: token) }
+      let(:item) { FactoryBot.json(:post_item, token: token) }
       let(:item_hash) { JSON.parse(item) }
 
       before do
@@ -157,7 +157,7 @@ describe Hyrax::API::ItemsController, type: :controller do
       before { post :create, body: item, params: { format: :json } }
 
       let(:token) { 'unfamiliar_token' }
-      let(:item) { FactoryGirl.json(:post_item, token: token) }
+      let(:item) { FactoryBot.json(:post_item, token: token) }
 
       it "is unathorized" do
         expect(response).not_to be_success
@@ -168,7 +168,7 @@ describe Hyrax::API::ItemsController, type: :controller do
   end
 
   context 'with an HTTP PUT' do
-    let(:put_item) { FactoryGirl.json(:put_item, token: token) }
+    let(:put_item) { FactoryBot.json(:put_item, token: token) }
     let(:token) { user.arkivo_token }
     let(:gw) { build :generic_work, id: '123' }
     let(:relation) { double }
@@ -261,7 +261,7 @@ describe Hyrax::API::ItemsController, type: :controller do
 
     context 'with a valid item and unfamiliar token' do
       let(:bad_token) { 'unfamiliar_token' }
-      let(:bad_token_item) { FactoryGirl.json(:put_item, token: bad_token) }
+      let(:bad_token_item) { FactoryBot.json(:put_item, token: bad_token) }
 
       before do
         request.env['RAW_POST_DATA'] = bad_token_item
@@ -291,7 +291,7 @@ describe Hyrax::API::ItemsController, type: :controller do
 
   context 'with an HTTP DELETE' do
     let(:token) { user.arkivo_token }
-    let(:item) { FactoryGirl.json(:post_item, token: token) }
+    let(:item) { FactoryBot.json(:post_item, token: token) }
     let(:item_hash) { JSON.parse(item) }
     let(:gw) { build :generic_work, id: '123' }
     let(:relation) { double }

data/spec/controllers/hyrax/content_blocks_controller_spec.rb

@@ -1,6 +1,6 @@
 describe Hyrax::ContentBlocksController, type: :controller do
   describe "#update" do
-    let(:content_block) { FactoryGirl.create(:content_block) }
+    let(:content_block) { FactoryBot.create(:content_block) }
     before { request.env["HTTP_REFERER"] = "whence_i_came" }
 
     context "when not logged in" do
@@ -30,7 +30,7 @@ describe Hyrax::ContentBlocksController, type: :controller do
     end
 
     context "when logged in" do
-      let(:user) { FactoryGirl.create(:user) }
+      let(:user) { FactoryBot.create(:user) }
       before { allow(controller).to receive_messages(current_user: user) }
 
       context "as a user in the admin group" do

data/spec/controllers/hyrax/downloads_controller_spec.rb

@@ -4,9 +4,9 @@ describe Hyrax::DownloadsController do
   routes { Hyrax::Engine.routes }
 
   describe '#show' do
-    let(:user) { FactoryGirl.create(:user) }
+    let(:user) { FactoryBot.create(:user) }
     let(:file_set) do
-      FactoryGirl.create(:file_with_work, user: user, content: File.open(fixture_path + '/image.png'))
+      FactoryBot.create(:file_with_work, user: user, content: File.open(fixture_path + '/image.png'))
     end
     let(:default_image) { ActionController::Base.helpers.image_path 'default.png' }
     it 'calls render_404 if the object does not exist' do
@@ -15,7 +15,7 @@ describe Hyrax::DownloadsController do
     end
 
     context "when user doesn't have access" do
-      let(:another_user) { FactoryGirl.create(:user) }
+      let(:another_user) { FactoryBot.create(:user) }
       before { sign_in another_user }
 
       it 'redirects to the default image' do

data/spec/controllers/hyrax/featured_work_lists_controller_spec.rb

@@ -4,8 +4,8 @@ describe Hyrax::FeaturedWorkListsController, type: :controller do
       expect(controller).to receive(:authorize!).with(:update, FeaturedWork)
     end
 
-    let(:feature1) { FactoryGirl.create(:featured_work) }
-    let(:feature2) { FactoryGirl.create(:featured_work) }
+    let(:feature1) { FactoryBot.create(:featured_work) }
+    let(:feature2) { FactoryBot.create(:featured_work) }
 
     it "is successful" do
       post :create, params: {

data/spec/controllers/hyrax/homepage_controller_spec.rb

@@ -105,7 +105,7 @@ describe Hyrax::HomepageController, type: :controller do
     end
 
     context "with featured works" do
-      let!(:my_work) { FactoryGirl.create(:work, user: user) }
+      let!(:my_work) { FactoryBot.create(:work, user: user) }
 
       before do
         FeaturedWork.create!(work_id: my_work.id)

data/spec/controllers/hyrax/tinymce_assets_controller_spec.rb

@@ -2,7 +2,7 @@ describe Hyrax::TinymceAssetsController, type: :controller do
   let(:file) { fixture_file_upload('/world.png', 'image/png') }
 
   context "when logged in" do
-    let(:user) { FactoryGirl.create(:user) }
+    let(:user) { FactoryBot.create(:user) }
     before { sign_in user }
 
     context "as a user who can upload" do

data/spec/controllers/hyrax/users_controller_spec.rb

@@ -1,5 +1,5 @@
 describe Hyrax::UsersController, type: :controller do
-  let(:user) { FactoryGirl.create(:user) }
+  let(:user) { FactoryBot.create(:user) }
   before do
     sign_in user
     allow_any_instance_of(User).to receive(:groups).and_return([])
@@ -86,7 +86,7 @@ describe Hyrax::UsersController, type: :controller do
       end
 
       it "uses the base query" do
-        u3 = FactoryGirl.create(:user)
+        u3 = FactoryBot.create(:user)
         allow(controller).to receive(:base_query).and_return(["email == \"#{u3.email}\""])
         get :index
         expect(assigns[:users]).to include(u3)
@@ -105,7 +105,7 @@ describe Hyrax::UsersController, type: :controller do
     end
 
     context "when user attempts to edit another profile" do
-      let(:another_user) { FactoryGirl.create(:user) }
+      let(:another_user) { FactoryBot.create(:user) }
       context 'with default abilities' do
         it "redirects to show profile" do
           expect_any_instance_of(Ability).to receive(:can?).with(:edit, another_user).and_return(false)
@@ -146,7 +146,7 @@ describe Hyrax::UsersController, type: :controller do
 
   describe "#update" do
     context "the profile of another user" do
-      let(:another_user) { FactoryGirl.create(:user) }
+      let(:another_user) { FactoryBot.create(:user) }
       it "does not allow other users to update" do
         post :update, params: { id: another_user.user_key, user: { avatar: nil } }
         expect(response).to redirect_to(routes.url_helpers.profile_path(another_user.to_param, locale: 'en'))