hyrax 1.1.1 → 2.0.0.beta1

data/lib/generators/hyrax/work/templates/feature_spec.rb.erb

@@ -7,7 +7,7 @@ include Warden::Test::Helpers
 RSpec.feature 'Create a <%= class_name %>', js: false do
   context 'a logged in user' do
     let(:user_attributes) do
-      { <%= Devise.authentication_keys.first %>: 'test@example.com' }
+      { <%= Hydra.config.user_key_field %>: 'test@example.com' }
     end
     let(:user) do
       User.new(user_attributes) { |u| u.save(validate: false) }

data/lib/generators/hyrax/work/templates/indexer.rb.erb

@@ -0,0 +1,19 @@
+# Generated via
+#  `rails generate hyrax:work <%= class_name %>`
+class <%= class_name %>Indexer < Hyrax::WorkIndexer
+  # This indexes the default metadata. You can remove it if you want to
+  # provide your own metadata and indexing.
+  include Hyrax::IndexesBasicMetadata
+
+  # Fetch remote labels for based_near. You can remove this if you don't want
+  # this behavior
+  include Hyrax::IndexesLinkedMetadata
+
+
+  # Uncomment this block if you want to add custom indexing behavior:
+  # def generate_solr_document
+  #  super.tap do |solr_doc|
+  #    solr_doc['my_custom_field_ssim'] = object.my_custom_property
+  #  end
+  # end
+end

data/lib/generators/hyrax/work/templates/locale.de.yml.erb

@@ -0,0 +1,8 @@
+de:
+  hyrax:
+    icons:
+      <%= file_name %>:     'fa fa-file-text-o'
+    select_type:
+      <%= file_name %>:
+        name:               "<%= human_name.titleize %>"
+        description:        "<%= human_name %> Werke"

data/lib/generators/hyrax/work/templates/locale.fr.yml.erb

@@ -0,0 +1,8 @@
+fr:
+  hyrax:
+    icons:
+      <%= file_name %>:     'fa fa-file-text-o'
+    select_type:
+      <%= file_name %>:
+        name:               "<%= human_name.titleize %>"
+        description:        "<%= human_name %> œuvres"

data/lib/generators/hyrax/work/templates/locale.it.yml.erb

@@ -0,0 +1,8 @@
+it:
+  hyrax:
+    icons:
+      <%= file_name %>:     'fa fa-file-text-o'
+    select_type:
+      <%= file_name %>:
+        name:               "<%= human_name.titleize %>"
+        description:        "<%= human_name %> opere"

data/lib/generators/hyrax/work/templates/locale.pt-BR.yml.erb

@@ -0,0 +1,8 @@
+pt-BR:
+  hyrax:
+    icons:
+      <%= file_name %>:     'fa fa-file-text-o'
+    select_type:
+      <%= file_name %>:
+        name:               "<%= human_name.titleize %>"
+        description:        "<%= human_name %> trabalhos"

data/lib/generators/hyrax/work/templates/model.rb.erb

@@ -2,10 +2,15 @@
 #  `rails generate hyrax:work <%= class_name %>`
 class <%= class_name %> < ActiveFedora::Base
   include ::Hyrax::WorkBehavior
-  include ::Hyrax::BasicMetadata
+
+  self.indexer = <%= class_name %>Indexer
   # Change this to restrict which works can be added as a child.
   # self.valid_child_concerns = []
   validates :title, presence: { message: 'Your work must have a title.' }
-  
+
   self.human_readable_type = '<%= name.underscore.titleize %>'
+
+  # This must be included at the end, because it finalizes the metadata
+  # schema (by adding accepts_nested_attributes)
+  include ::Hyrax::BasicMetadata
 end

data/lib/generators/hyrax/work/templates/presenter.rb.erb

@@ -0,0 +1,6 @@
+# Generated via
+#  `rails generate hyrax:work <%= class_name %>`
+module Hyrax
+  class <%= class_name %>Presenter < Hyrax::WorkShowPresenter
+  end
+end

data/lib/generators/hyrax/work/templates/presenter_spec.rb.erb

@@ -0,0 +1,9 @@
+# Generated via
+#  `rails generate hyrax:work <%= class_name %>`
+require 'rails_helper'
+
+RSpec.describe Hyrax::<%= class_name %>Presenter do
+  it "has tests" do
+    skip "Add your tests here"
+  end
+end

data/lib/generators/hyrax/work/work_generator.rb

@@ -5,7 +5,7 @@ class Hyrax::WorkGenerator < Rails::Generators::NamedBase
   # ActiveSupport can interpret models as plural which causes
   # counter-intuitive route paths. Pull in ModelHelpers from
   # Rails which warns users about pluralization when generating
-  # new models or scaffolds.  include Rails::Generators::ModelHelpers
+  # new models or scaffolds.
   include Rails::Generators::ModelHelpers
 
   source_root File.expand_path('../templates', __FILE__)
@@ -30,12 +30,20 @@ class Hyrax::WorkGenerator < Rails::Generators::NamedBase
     template('controller.rb.erb', File.join('app/controllers/hyrax', class_path, "#{plural_file_name}_controller.rb"))
   end
 
+  def create_indexer
+    template('indexer.rb.erb', File.join('app/indexers', class_path, "#{file_name}_indexer.rb"))
+  end
+
   def create_form
     template('form.rb.erb', File.join('app/forms/hyrax', class_path, "#{file_name}_form.rb"))
   end
 
+  def create_presenter
+    template('presenter.rb.erb', File.join('app/presenters/hyrax', class_path, "#{file_name}_presenter.rb"))
+  end
+
   def create_model
-    template('model.rb.erb', File.join('app/models', class_path, "#{file_name}.rb"))
+    template('model.rb.erb', File.join('app/models/', class_path, "#{file_name}.rb"))
   end
 
   def create_views
@@ -62,35 +70,42 @@ class Hyrax::WorkGenerator < Rails::Generators::NamedBase
     end
   end
 
+  LOCALES = %w[en es zh de fr it pt-BR].freeze
+
   def create_i18n
-    template('locale.en.yml.erb', File.join('config/locales/', class_path, "#{file_name}.en.yml"))
-    template('locale.es.yml.erb', File.join('config/locales/', class_path, "#{file_name}.es.yml"))
-    template('locale.zh.yml.erb', File.join('config/locales/', class_path, "#{file_name}.zh.yml"))
+    LOCALES.each do |locale|
+      template("locale.#{locale}.yml.erb", File.join('config/locales/', class_path, "#{file_name}.#{locale}.yml"))
+    end
   end
 
   def create_actor_spec
     return unless rspec_installed?
-    template('actor_spec.rb.erb', File.join('spec/actors/hyrax/actors', class_path, "#{file_name}_actor_spec.rb"))
+    template('actor_spec.rb.erb', File.join('spec/actors/hyrax/actors/', class_path, "#{file_name}_actor_spec.rb"))
   end
 
   def create_controller_spec
     return unless rspec_installed?
-    template('controller_spec.rb.erb', File.join('spec/controllers/hyrax', class_path, "#{plural_file_name}_controller_spec.rb"))
+    template('controller_spec.rb.erb', File.join('spec/controllers/hyrax/', class_path, "#{plural_file_name}_controller_spec.rb"))
   end
 
   def create_feature_spec
     return unless rspec_installed?
-    template('feature_spec.rb.erb', File.join('spec/features', class_path, "create_#{file_name}_spec.rb"))
+    template('feature_spec.rb.erb', File.join('spec/features/', class_path, "create_#{file_name}_spec.rb"))
   end
 
   def create_form_spec
     return unless rspec_installed?
-    template('form_spec.rb.erb', File.join('spec/forms/hyrax', class_path, "#{file_name}_form_spec.rb"))
+    template('form_spec.rb.erb', File.join('spec/forms/hyrax/', class_path, "#{file_name}_form_spec.rb"))
+  end
+
+  def presenter_spec
+    return unless rspec_installed?
+    template('presenter_spec.rb.erb', File.join('spec/presenters/hyrax/', class_path, "#{file_name}_presenter_spec.rb"))
   end
 
   def create_model_spec
     return unless rspec_installed?
-    template('model_spec.rb.erb', File.join('spec/models', class_path, "#{file_name}_spec.rb"))
+    template('model_spec.rb.erb', File.join('spec/models/', class_path, "#{file_name}_spec.rb"))
   end
 
   def display_readme

data/lib/hyrax.rb

@@ -6,7 +6,6 @@ require 'carrierwave'
 require 'rails_autolink'
 require 'font-awesome-rails'
 require 'tinymce-rails'
-require 'tinymce-rails-imageupload'
 require 'blacklight'
 require 'blacklight/gallery'
 require 'active_fedora/noid'

data/lib/hyrax/arkivo/actor.rb

@@ -18,9 +18,10 @@ module Hyrax
 
       def create_work_from_item
         work = Hyrax.primary_work_type.new
-        work_actor = Hyrax::CurationConcern.actor(work, user)
+        work_actor = Hyrax::CurationConcern.actor
         create_attrs = attributes.merge(arkivo_checksum: item['file']['md5'])
-        raise "Unable to create work. #{work.errors.messages}" unless work_actor.create(create_attrs)
+        env = Actors::Environment.new(work, current_ability, create_attrs)
+        raise "Unable to create work. #{work.errors.messages}" unless work_actor.create(env)
 
         file_set = ::FileSet.new
 
@@ -28,15 +29,17 @@ module Hyrax
         file_actor.create_metadata
         file_set.label = item['file']['filename']
         file_actor.create_content(file) # item['file']['contentType']
-        file_actor.attach_file_to_work(work)
+        file_actor.attach_to_work(work)
 
         work
       end
 
       def update_work_from_item(work)
-        work_actor = Hyrax::CurationConcern.actor(work, user)
+        work_actor = Hyrax::CurationConcern.actor
         work_attributes = default_attributes.merge(attributes).merge(arkivo_checksum: item['file']['md5'])
-        work_actor.update(work_attributes)
+        env = Actors::Environment.new(work, current_ability, work_attributes)
+        work_actor.update(env)
+
         file_set = work.file_sets.first
         file_actor = ::Hyrax::Actors::FileSetActor.new(file_set, user)
         file_actor.update_content(file)
@@ -49,7 +52,12 @@ module Hyrax
 
       private
 
+        def current_ability
+          @current_ability ||= ::Ability.new(user)
+        end
+
         # @return [Hash<String, Array>] a list of properties to set on the work. Keys must be strings in order for them to correctly merge with the values from arkivio (in `@item`)
+        # rubocop:disable Metrics/MethodLength
         def default_attributes
           {
             "resource_type" => [],
@@ -67,6 +75,7 @@ module Hyrax
             "contributor" => []
           }
         end
+        # rubocop:enable Metrics/MethodLength
 
         def default_visibility
           Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC

data/lib/hyrax/arkivo/create_subscription_job.rb

@@ -3,7 +3,7 @@ module Hyrax
     class SubscriptionError < RuntimeError
     end
 
-    class CreateSubscriptionJob < ActiveJob::Base
+    class CreateSubscriptionJob < Hyrax::ApplicationJob
       attr_reader :user
 
       def perform(user_key)

data/lib/hyrax/arkivo/schema_validator.rb

@@ -11,7 +11,7 @@ module Hyrax
           required: true,
           properties: {
             title: { type: 'string', required: true },
-            rights: { type: 'string', required: true },
+            license: { type: 'string', required: true },
             resourceType: { type: 'string' },
             description: { type: 'string' },
             publisher: { type: 'string' },

data/lib/hyrax/configuration.rb

@@ -87,26 +87,26 @@ module Hyrax
       return @display_microdata unless @display_microdata.nil?
       @display_microdata = true
     end
-    alias display_microdata display_microdata?
-    deprecation_deprecate display_microdata: "use display_microdata? instead"
 
     attr_writer :microdata_default_type
     def microdata_default_type
       @microdata_default_type ||= 'http://schema.org/CreativeWork'
     end
 
-    attr_writer :max_days_between_audits
-    def max_days_between_audits
-      @max_days_between_audits ||= 7
+    attr_writer :max_days_between_fixity_checks
+    def max_days_between_fixity_checks
+      @max_days_between_fixity_checks ||= 7
     end
+    alias max_days_between_audits max_days_between_fixity_checks
+    deprecation_deprecate max_days_between_audits: "use max_days_between_fixity_checks instead"
+    alias max_days_between_audits= max_days_between_fixity_checks=
+    deprecation_deprecate :max_days_between_audits= => "use max_days_between_fixity_checks= instead"
 
     attr_writer :enable_noids
     def enable_noids?
       return @enable_noids unless @enable_noids.nil?
       @enable_noids = true
     end
-    alias enable_noids enable_noids?
-    deprecation_deprecate enable_noids: "use enable_noids? instead"
 
     attr_writer :noid_template
     def noid_template
@@ -128,8 +128,6 @@ module Hyrax
       return @display_media_download_link unless @display_media_download_link.nil?
       @display_media_download_link = true
     end
-    alias display_media_download_link display_media_download_link?
-    deprecation_deprecate display_media_download_link: "use display_media_download_link? instead"
 
     attr_writer :fits_path
     def fits_path
@@ -175,73 +173,17 @@ module Hyrax
       @import_export_jar_file_path ||= "tmp/fcrepo-import-export.jar"
     end
 
-    # @!attribute [w] descriptions_directory
-    #   Location where description files are exported
-    attr_writer :descriptions_directory
-    def descriptions_directory
-      @descriptions_directory ||= "tmp/descriptions"
-    end
-
-    # @!attribute [w] binaries_directory
-    #   Location where binary files are exported
-    attr_writer :binaries_directory
-    def binaries_directory
-      @binaries_directory ||= "tmp/binaries"
-    end
-
-    # @!attribute [w] dashboard_configuration
-    #   Configuration for dashboard rendering.
-    attr_writer :dashboard_configuration
-    # rubocop:disable Metrics/MethodLength
-    def dashboard_configuration
-      @dashboard_configuration ||= {
-        menu: {
-          index: {},
-          resource_details: {},
-          workflow: {},
-          workflow_roles: {}
-        },
-        actions: {
-          index: {
-            partials: [
-              "total_objects_charts",
-              "total_embargo_visibility"
-            ]
-          },
-          resource_details: {
-            partials: [
-              "total_objects"
-            ]
-          },
-          workflow: {
-            partials: [
-              "workflow"
-            ]
-          }
-        },
-        data_sources: {
-          resource_stats: Hyrax::ResourceStatisticsSource
-        }
-      }
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    # @!attribute [w] whitelisted_ingest_dirs
-    #   List of directories which can be used for local file system ingestion.
-    attr_writer :whitelisted_ingest_dirs
-    def whitelisted_ingest_dirs
-      @whitelisted_ingest_dirs ||= \
-        if defined? BrowseEverything
-          Array.wrap(BrowseEverything.config['file_system'].try(:[], :home)).compact
-        else
-          []
-        end
+    # @!attribute [w] bagit_dir
+    #   Location where BagIt files are exported
+    attr_writer :bagit_dir
+    def bagit_dir
+      @bagit_dir ||= "tmp/descriptions"
     end
 
     callback.enable :after_create_concern, :after_create_fileset,
                     :after_update_content, :after_revert_content,
                     :after_update_metadata, :after_import_local_file_success,
-                    :after_import_local_file_failure, :after_audit_failure,
+                    :after_import_local_file_failure, :after_fixity_check_failure,
                     :after_destroy, :after_import_url_success,
                     :after_import_url_failure
 
@@ -280,7 +222,8 @@ module Hyrax
 
     attr_writer :banner_image
     def banner_image
-      @banner_image ||= "https://cloud.githubusercontent.com/assets/92044/18370978/88ecac20-75f6-11e6-8399-6536640ef695.jpg"
+      # This image can be used for free and without attribution. See here for source and license: https://github.com/samvera/hyrax/issues/1551#issuecomment-326624909
+      @banner_image ||= 'https://user-images.githubusercontent.com/101482/29949206-ffa60d2c-8e67-11e7-988d-4910b8787d56.jpg'
     end
 
     attr_writer :persistent_hostpath
@@ -302,28 +245,27 @@ module Hyrax
     def browse_everything?
       @browse_everything ||= nil
     end
-    alias browse_everything browse_everything?
-    deprecation_deprecate browse_everything: "use browse_everything? instead"
 
     attr_writer :analytics
     def analytics?
       @analytics ||= false
     end
-    alias analytics analytics?
-    deprecation_deprecate analytics: "use analytics? instead"
 
     attr_writer :citations
     def citations?
       @citations ||= false
     end
-    alias citations citations?
-    deprecation_deprecate citations: "use citations? instead"
 
     attr_writer :max_notifications_for_dashboard
     def max_notifications_for_dashboard
       @max_notifications_for_dashboard ||= 5
     end
 
+    attr_writer :notifications_update_poll_interval
+    def notifications_update_poll_interval
+      @notifications_update_poll_interval ||= 30.seconds
+    end
+
     attr_writer :activity_to_show_default_seconds_since_now
     def activity_to_show_default_seconds_since_now
       @activity_to_show_default_seconds_since_now ||= 24 * 60 * 60
@@ -333,8 +275,6 @@ module Hyrax
     def arkivo_api?
       @arkivo_api ||= false
     end
-    alias arkivo_api arkivo_api?
-    deprecation_deprecate arkivo_api: "use arkivo_api? instead"
 
     def geonames_username=(username)
       Qa::Authorities::Geonames.username = username
@@ -345,16 +285,12 @@ module Hyrax
       return true if @active_deposit_agreement_acceptance.nil?
       @active_deposit_agreement_acceptance
     end
-    alias active_deposit_agreement_acceptance active_deposit_agreement_acceptance?
-    deprecation_deprecate active_deposit_agreement_acceptance: "use active_deposit_agreement_acceptance? instead"
 
     attr_writer :work_requires_files
     def work_requires_files?
       return true if @work_requires_files.nil?
       @work_requires_files
     end
-    alias work_requires_files work_requires_files?
-    deprecation_deprecate work_requires_files: "use work_requires_files? instead"
 
     attr_writer :batch_user_key
     def batch_user_key
@@ -377,14 +313,18 @@ module Hyrax
       @cache_path ||= ->() { Rails.root + 'tmp' + 'uploads' + 'cache' }
     end
 
-    # Should a button with "Share my work" show on the front page to all users (even those not logged in)?
-    attr_writer :always_display_share_button
-    def always_display_share_button?
-      return true if @always_display_share_button.nil?
-      @always_display_share_button
+    # Should a button with "Share my work" show on the front page to users who are not logged in?
+    attr_writer :display_share_button_when_not_logged_in
+    def display_share_button_when_not_logged_in?
+      return true if @display_share_button_when_not_logged_in.nil?
+      @display_share_button_when_not_logged_in
     end
-    alias always_display_share_button always_display_share_button?
-    deprecation_deprecate always_display_share_button: "use always_display_share_button? instead"
+
+    alias always_display_share_button= display_share_button_when_not_logged_in=
+    deprecation_deprecate :always_display_share_button= => "use display_share_button_when_not_logged_in= instead"
+
+    alias always_display_share_button? display_share_button_when_not_logged_in?
+    deprecation_deprecate always_display_share_button?: "use display_share_button_when_not_logged_in? instead"
 
     attr_writer :google_analytics_id
     def google_analytics_id
@@ -398,14 +338,20 @@ module Hyrax
 
     attr_writer :permission_levels
     def permission_levels
-      @permission_levels ||= { "Choose Access" => "none",
-                               "View/Download" => "read",
-                               "Edit" => "edit" }
+      @permission_levels ||= { "View/Download" => "read",
+                               "Edit access" => "edit" }
     end
 
     attr_writer :owner_permission_levels
     def owner_permission_levels
-      @owner_permission_levels ||= { "Edit Access" => "edit" }
+      @owner_permission_levels ||= { "Edit access" => "edit" }
+    end
+
+    attr_writer :permission_options
+    def permission_options
+      @permission_options ||= { "Choose Access" => "none",
+                                "View/Download" => "read",
+                                "Edit" => "edit" }
     end
 
     attr_writer :translate_uri_to_id
@@ -434,11 +380,14 @@ module Hyrax
       @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
-    def model_to_create
-      @model_to_create ||= ->(_attributes) { Hyrax.primary_work_type.model_name.name }
+    attr_writer :uploader
+    def uploader
+      @uploader ||= if Rails.env.development?
+                      # use sequential uploads in development to avoid database locking problems with sqlite3.
+                      default_uploader_config.merge(limitConcurrentUploads: 1, sequentialUploads: true)
+                    else
+                      default_uploader_config
+                    end
     end
 
     private
@@ -448,5 +397,14 @@ module Hyrax
       def normalize_concern_name(model_name)
         model_name.to_s.camelize
       end
+
+      # @return [Hash] config options for the uploader
+      def default_uploader_config
+        {
+          limitConcurrentUploads: 6,
+          maxNumberOfFiles: 100,
+          maxFileSize: 500.megabytes
+        }
+      end
   end
 end