sufia 7.0.0.beta3 → 7.0.0.beta4

data/lib/generators/sufia/arkivo_api_generator.rb

@@ -1,6 +1,4 @@
-require_relative 'abstract_migration_generator'
-
-class Sufia::ArkivoApiGenerator < Sufia::AbstractMigrationGenerator
+class Sufia::ArkivoApiGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
   desc """
@@ -26,11 +24,6 @@ This generator sets up Zotero/Arkivo API integration for your application:
     copy_file 'config/arkivo_constraint.rb', 'config/initializers/arkivo_constraint.rb'
   end
 
-  # Copy the database migration
-  def copy_migration
-    better_migration_template 'add_arkivo_to_users.rb'
-  end
-
   # Copy the config files for Zotero and Arkivo
   def copy_config_files
     copy_file 'config/arkivo.yml', 'config/arkivo.yml'

data/lib/generators/sufia/config_generator.rb

@@ -14,21 +14,13 @@ class Sufia::ConfigGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
   def create_initializer_config_file
+    remove_file 'config/initializers/curation_concerns.rb'
     copy_file 'config/sufia.rb', 'config/initializers/sufia.rb'
   end
 
-  # Adds citations initialization
-  def citation_config
-    generate 'sufia:citation_config'
-  end
-
   # Add mini-magick configuration
-  def minimagic_config
-    generate 'sufia:minimagick_config'
-  end
-
-  def install_admin_stats
-    generate "sufia:admin_stat"
+  def minimagick_config
+    copy_file 'config/mini_magick.rb', 'config/initializers/mini_magick.rb'
   end
 
   def tinymce_config

data/lib/generators/sufia/install_generator.rb

@@ -1,7 +1,5 @@
-require_relative 'abstract_migration_generator'
-
 module Sufia
-  class Install < Sufia::AbstractMigrationGenerator
+  class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     argument :model_name, type: :string, default: "user", desc: "Model name for User model (primarily passed to devise, but also used elsewhere)"
     class_option :skip_curation_concerns, type: :boolean, default: false, desc: "whether to skip the curation_concerns:models installer"
@@ -14,11 +12,6 @@ module Sufia
      * Generates GenericWork model.
      * Creates the sufia.rb configuration file
      * Generates mailboxer
-     * Runs proxies generator
-     * Runs cached stats generator
-     * Runs ORCID field generator
-     * Runs user stats generator
-     * Runs upload_to_collection config generator
    3. Adds Sufia's abilities into the Ability class
    4. Adds controller behavior to the application controller
    5. Copies the catalog controller into the local app
@@ -44,22 +37,7 @@ module Sufia
 
     # Setup the database migrations
     def copy_migrations
-      [
-        "acts_as_follower_migration.rb",
-        "add_social_to_users.rb",
-        "add_ldap_attrs_to_user.rb",
-        "add_avatars_to_users.rb",
-        "create_local_authorities.rb",
-        "create_trophies.rb",
-        'add_linkedin_to_users.rb',
-        'create_tinymce_assets.rb',
-        'create_content_blocks.rb',
-        'create_featured_works.rb',
-        'add_external_key_to_content_blocks.rb',
-        'create_uploaded_files.rb'
-      ].each do |file|
-        better_migration_template file
-      end
+      rake 'sufia:install:migrations'
     end
 
     def install_config
@@ -97,12 +75,7 @@ module Sufia
     end
 
     def configure_usage_stats
-      generate 'sufia:usagestats'
-    end
-
-    # Sets up proxies and transfers
-    def proxies
-      generate "sufia:proxies"
+      copy_file 'config/analytics.yml', 'config/analytics.yml'
     end
 
     def solr_config
@@ -111,24 +84,17 @@ module Sufia
       copy_file source, 'solr/conf/solrconfig.xml', force: true
     end
 
-    # Sets up cached usage stats
-    def cached_stats
-      generate 'sufia:cached_stats'
-    end
-
-    # Adds orcid field to user model
-    def orcid_field
-      generate 'sufia:orcid_field'
-    end
-
-    # Adds user stats-related migration & methods
+    # Adds user stats-related methods
     def user_stats
-      generate 'sufia:user_stats'
-    end
+      file_path = "app/models/#{model_name.underscore}.rb"
 
-    # Sets up cached usage stats
-    def cached_work_stats
-      generate 'sufia:cached_work_stats'
+      if File.exist?(file_path)
+        inject_into_file file_path, after: /include Sufia\:\:User.*$/ do
+          "\n  include Sufia::UserUsageStats"
+        end
+      else
+        puts "     \e[31mFailure\e[0m  Sufia requires a user object. This generator assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails g sufia:user_stats client"
+      end
     end
 
     def insert_abilities

data/lib/generators/sufia/templates/catalog_controller.rb

@@ -63,22 +63,22 @@ class CatalogController < ApplicationController
     #   The ordering of the field names is the order of the display
     config.add_index_field solr_name("title", :stored_searchable), label: "Title", itemprop: 'name', if: false
     config.add_index_field solr_name("description", :stored_searchable), label: "Description", itemprop: 'description', helper_method: :iconify_auto_link
-    config.add_index_field solr_name("keyword", :stored_searchable), label: "Keyword", itemprop: 'keywords'
-    config.add_index_field solr_name("subject", :stored_searchable), label: "Subject", itemprop: 'about'
-    config.add_index_field solr_name("creator", :stored_searchable), label: "Creator", itemprop: 'creator'
-    config.add_index_field solr_name("contributor", :stored_searchable), label: "Contributor", itemprop: 'contributor'
+    config.add_index_field solr_name("keyword", :stored_searchable), label: "Keyword", itemprop: 'keywords', link_to_search: solr_name("keyword", :facetable)
+    config.add_index_field solr_name("subject", :stored_searchable), label: "Subject", itemprop: 'about', link_to_search: solr_name("subject", :facetable)
+    config.add_index_field solr_name("creator", :stored_searchable), label: "Creator", itemprop: 'creator', link_to_search: solr_name("creator", :facetable)
+    config.add_index_field solr_name("contributor", :stored_searchable), label: "Contributor", itemprop: 'contributor', helper_method: :index_field_link, field_name: 'contributor'
     config.add_index_field solr_name("proxy_depositor", :symbol), label: "Depositor", helper_method: :link_to_profile
     config.add_index_field solr_name("depositor"), label: "Owner", helper_method: :link_to_profile
-    config.add_index_field solr_name("publisher", :stored_searchable), label: "Publisher", itemprop: 'publisher'
-    config.add_index_field solr_name("based_near", :stored_searchable), label: "Location", itemprop: 'contentLocation'
-    config.add_index_field solr_name("language", :stored_searchable), label: "Language", itemprop: 'inLanguage'
+    config.add_index_field solr_name("publisher", :stored_searchable), label: "Publisher", itemprop: 'publisher', link_to_search: solr_name("publisher", :facetable)
+    config.add_index_field solr_name("based_near", :stored_searchable), label: "Location", itemprop: 'contentLocation', link_to_search: solr_name("based_near", :facetable)
+    config.add_index_field solr_name("language", :stored_searchable), label: "Language", itemprop: 'inLanguage', link_to_search: solr_name("language", :facetable)
     config.add_index_field solr_name("date_uploaded", :stored_sortable, type: :date), label: "Date Uploaded", itemprop: 'datePublished', helper_method: :human_readable_date
     config.add_index_field solr_name("date_modified", :stored_sortable, type: :date), label: "Date Modified", itemprop: 'dateModified', helper_method: :human_readable_date
     config.add_index_field solr_name("date_created", :stored_searchable), label: "Date Created", itemprop: 'dateCreated'
     config.add_index_field solr_name("rights", :stored_searchable), label: "Rights", helper_method: :rights_statement_links
-    config.add_index_field solr_name("resource_type", :stored_searchable), label: "Resource Type"
-    config.add_index_field solr_name("format", :stored_searchable), label: "File Format"
-    config.add_index_field solr_name("identifier", :stored_searchable), label: "Identifier"
+    config.add_index_field solr_name("resource_type", :stored_searchable), label: "Resource Type", link_to_search: solr_name("resource_type", :facetable)
+    config.add_index_field solr_name("file_format", :stored_searchable), label: "File Format", link_to_search: solr_name("file_format", :facetable)
+    config.add_index_field solr_name("identifier", :stored_searchable), label: "Identifier", helper_method: :index_field_link, field_name: 'identifier'
 
     # solr fields to be displayed in the show (single result) view
     #   The ordering of the field names is the order of the display

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

@@ -1,16 +1,17 @@
 Sufia.config do |config|
-  config.max_days_between_audits = 7
-  config.max_notifications_for_dashboard = 5
+  config.register_curation_concern :generic_work
 
-  config.permission_levels = {
-    "Choose Access" => "none",
-    "View/Download" => "read",
-    "Edit" => "edit"
-  }
+  # Email recipient of messages sent via the contact form
+  # config.contact_email = "repo-admin@example.org"
 
-  config.owner_permission_levels = {
-    "Edit" => "edit"
-  }
+  # Text prefacing the subject entered in the contact form
+  # config.subject_prefix = "Contact form:"
+
+  # How many notifications should be displayed on the dashboard
+  # config.max_notifications_for_dashboard = 5
+
+  # How frequently should a file be audited.
+  # config.max_days_between_audits = 7
 
   # Enable displaying usage statistics in the UI
   # Defaults to FALSE
@@ -46,10 +47,6 @@ Sufia.config do |config|
   # Store identifier minter's state in a file for later replayability
   # config.minter_statefile = '/tmp/minter-state'
 
-  # Process for translating Fedora URIs to identifiers and vice versa
-  # config.translate_uri_to_id = ActiveFedora::Noid.config.translate_uri_to_id
-  # config.translate_id_to_uri = ActiveFedora::Noid.config.translate_id_to_uri
-
   # Specify the prefix for Redis keys:
   # config.redis_namespace = "sufia"
 

data/lib/generators/sufia/upgrade700_generator.rb

@@ -1,6 +1,4 @@
-require_relative 'abstract_migration_generator'
-
-class Sufia::Upgrade700Generator < Sufia::AbstractMigrationGenerator
+class Sufia::Upgrade700Generator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
   argument :model_name, type: :string, default: "user"
@@ -21,19 +19,6 @@ This generator for upgrading sufia from 6.0.0 to 7.0 makes the following changes
     gsub_file 'app/controllers/catalog_controller.rb', '[:add_access_controls_to_solr_params, :add_advanced_parse_q_to_solr]', '[:add_advanced_parse_q_to_solr] + search_params_logic + [:add_access_controls_to_solr_params]'
   end
 
-  # Setup the database migrations
-  def copy_migrations
-    [
-      'change_trophy_generic_file_id_to_work_id.rb',
-      'change_proxy_deposit_generic_file_id_to_work_id.rb',
-      'change_audit_log_generic_file_id_to_file_set_id.rb',
-      'change_proxy_deposit_request_generic_file_id_to_work_id.rb',
-      'change_featured_work_generic_file_id_to_work_id.rb'
-    ].each do |file|
-      better_migration_template file
-    end
-  end
-
   def inject_sufia_work_controller_behavior
     file_path = "app/controllers/curation_concerns/generic_works_controller.rb"
     if File.exist?(file_path)

data/lib/sufia.rb

@@ -27,19 +27,15 @@ module Sufia
   extend ActiveSupport::Autoload
 
   eager_autoload do
-    autoload :RedisEventStore
     autoload :Arkivo
+    autoload :Configuration
+    autoload :RedisEventStore
+    autoload :ResourceSync
     autoload :Zotero
   end
 
-  attr_writer :queue
-
-  def self.queue
-    @queue ||= config.queue.new('sufia')
-  end
-
   def self.config(&block)
-    @config ||= Sufia::Engine::Configuration.new
+    @config ||= Sufia::Configuration.new
 
     yield @config if block
 

data/lib/sufia/configuration.rb

@@ -0,0 +1,132 @@
+module Sufia
+  class Configuration
+    def curation_concerns_config
+      @curation_concerns_config ||= CurationConcerns.config
+    end
+
+    delegate(*(CurationConcerns.config.methods - Object.methods),
+             to: :curation_concerns_config)
+
+    attr_writer :persistent_hostpath
+    def persistent_hostpath
+      @persistent_hostpath ||= "http://localhost/files/"
+    end
+
+    attr_writer :redis_namespace
+    def redis_namespace
+      @redis_namespace ||= "sufia"
+    end
+
+    # TODO: This should move to curation_concerns
+    attr_writer :libreoffice_path
+    def libreoffice_path
+      @libreoffice_path ||= "soffice"
+    end
+
+    attr_writer :browse_everything
+    def browse_everything
+      @browse_everything ||= nil
+    end
+
+    attr_writer :analytics
+    def analytics
+      @analytics ||= false
+    end
+    attr_writer :citations
+    def citations
+      @citations ||= false
+    end
+
+    attr_writer :max_notifications_for_dashboard
+    def max_notifications_for_dashboard
+      @max_notifications_for_dashboard ||= 5
+    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
+    end
+
+    attr_writer :arkivo_api
+    def arkivo_api
+      @arkivo_api ||= false
+    end
+
+    attr_writer :geonames_username
+    def geonames_username
+      @geonames_username ||= ""
+    end
+
+    attr_writer :active_deposit_agreement_acceptance
+    def active_deposit_agreement_acceptance
+      return true if @active_deposit_agreement_acceptance.nil?
+      @active_deposit_agreement_acceptance
+    end
+
+    attr_writer :batch_user_key
+    def batch_user_key
+      @batch_user_key ||= 'batchuser@example.com'
+    end
+
+    attr_writer :audit_user_key
+    def audit_user_key
+      @audit_user_key ||= 'audituser@example.com'
+    end
+
+    # TODO: this is called working_path in curation_concerns
+    attr_writer :upload_path
+    def upload_path
+      @upload_path ||= ->() { Rails.root + 'tmp' + 'uploads' }
+    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
+    end
+
+    # Defaulting analytic start date to whenever the file was uploaded by leaving it blank
+    attr_writer :analytic_start_date
+    attr_reader :analytic_start_date
+
+    attr_writer :display_media_download_link
+    def display_media_download_link
+      @display_media_download_link ||= false
+    end
+
+    attr_writer :permission_levels
+    def permission_levels
+      @permission_levels ||= { "Choose Access" => "none",
+                               "View/Download" => "read",
+                               "Edit" => "edit" }
+    end
+
+    attr_writer :owner_permission_levels
+    def owner_permission_levels
+      @owner_permission_levels ||= { "Edit Access" => "edit" }
+    end
+
+    # TODO: Delegate to curation_concerns when https://github.com/projecthydra/curation_concerns/pull/848 is merged
+    attr_writer :translate_uri_to_id
+    def translate_uri_to_id
+      @translate_uri_to_id ||= ActiveFedora::Noid.config.translate_uri_to_id
+    end
+
+    # TODO: Delegate to curation_concerns when https://github.com/projecthydra/curation_concerns/pull/848 is merged
+    attr_writer :translate_id_to_uri
+    def translate_id_to_uri
+      @translate_id_to_uri ||= ActiveFedora::Noid.config.translate_id_to_uri
+    end
+
+    attr_writer :contact_email
+    def contact_email
+      @contact_email ||= "repo-admin@example.org"
+    end
+
+    attr_writer :subject_prefix
+    def subject_prefix
+      @subject_prefix ||= "Contact form:"
+    end
+  end
+end

data/lib/sufia/engine.rb

@@ -39,6 +39,7 @@ module Sufia
         Hydra::Derivatives.enable_ffmpeg  = c.enable_ffmpeg
         Hydra::Derivatives.libreoffice_path = c.libreoffice_path
 
+        # TODO: Remove when https://github.com/projecthydra/curation_concerns/pull/848 is merged
         ActiveFedora::Base.translate_uri_to_id = c.translate_uri_to_id
         ActiveFedora::Base.translate_id_to_uri = c.translate_id_to_uri
         ActiveFedora::Noid.config.template = c.noid_template
@@ -46,7 +47,6 @@ module Sufia
       end
 
       CurationConcerns::CurationConcern.actor_factory = Sufia::ActorFactory
-      CurationConcerns.config.display_media_download_link = false
     end
 
     initializer 'sufia.assets.precompile' do |app|
@@ -68,52 +68,12 @@ module Sufia
 
     config.after_initialize do
       begin
-        Object.const_get(:GenericWork)
-        begin
-          LocalAuthority.register_vocabulary(GenericWork, "subject", "lc_subjects")
-          LocalAuthority.register_vocabulary(GenericWork, "language", "lexvo_languages")
-          LocalAuthority.register_vocabulary(GenericWork, "tag", "lc_genres")
-        rescue ActiveRecord::StatementInvalid
-          Rails.logger.error "tables for vocabularies missing #{e.class}"
-        end
-      rescue NameError
-        # nop, GenericWork hasn't been generated yet.
+        LocalAuthority.register_vocabulary('generic_works', "subject", "lc_subjects")
+        LocalAuthority.register_vocabulary('generic_works', "language", "lexvo_languages")
+        LocalAuthority.register_vocabulary('generic_works', "tag", "lc_genres")
+      rescue ActiveRecord::StatementInvalid => e
+        Rails.logger.error "tables for vocabularies missing #{e.class}"
       end
     end
-
-    # Set some configuration defaults
-    config.persistent_hostpath = "http://localhost/files/"
-    config.enable_ffmpeg = false
-    config.ffmpeg_path = 'ffmpeg'
-    config.fits_message_length = 5
-    config.temp_file_base = nil
-    config.redis_namespace = "sufia"
-    config.fits_path = "fits.sh"
-    config.libreoffice_path = "soffice"
-    config.enable_contact_form_delivery = false
-    config.browse_everything = nil
-    config.analytics = false
-    config.citations = false
-    config.max_notifications_for_dashboard = 5
-    config.activity_to_show_default_seconds_since_now = 24 * 60 * 60
-    config.arkivo_api = false
-    config.geonames_username = ""
-    config.active_deposit_agreement_acceptance = true
-    config.batch_user_key = 'batchuser@example.com'
-    config.audit_user_key = 'audituser@example.com'
-    config.upload_path = ->() { Rails.root + 'tmp' + 'uploads' }
-
-    # Should a button with "Share my work" show on the front page to all users (even those not logged in)?
-    config.always_display_share_button = true
-
-    # Noid identifiers
-    config.enable_noids = true
-    config.noid_template = '.reeddeeddk'
-    config.minter_statefile = '/tmp/minter-state'
-    config.translate_uri_to_id = ActiveFedora::Noid.config.translate_uri_to_id
-    config.translate_id_to_uri = ActiveFedora::Noid.config.translate_id_to_uri
-
-    # Defaulting analytic start date to whenever the file was uploaded by leaving it blank
-    config.analytic_start_date = nil
   end
 end