sufia 7.2.0 → 7.3.0.rc1

data/config/routes.rb

@@ -144,7 +144,10 @@ Sufia::Engine.routes.draw do
 
   resource :admin, controller: 'sufia/admin', only: [:show]
   scope 'admin', module: 'sufia/admin', as: 'admin' do
-    resources :admin_sets
+    resources :admin_sets do
+      resource :permission_template
+    end
+    resources :permission_template_accesses, only: :destroy
     resource 'stats', only: [:show]
     resources :features, only: [:index] do
       resources :strategies, only: [:update, :destroy]

data/db/migrate/20161021175854_create_permission_template.rb

@@ -0,0 +1,11 @@
+class CreatePermissionTemplate < ActiveRecord::Migration
+  def change
+    create_table :permission_templates do |t|
+      t.string :admin_set_id
+      t.string :visibility
+      t.string :workflow_name
+      t.timestamps
+    end
+    add_index :permission_templates, :admin_set_id
+  end
+end

data/db/migrate/20161021180154_create_permission_template_access.rb

@@ -0,0 +1,11 @@
+class CreatePermissionTemplateAccess < ActiveRecord::Migration
+  def change
+    create_table :permission_template_accesses do |t|
+      t.references :permission_template, foreign_key: true
+      t.string :agent_type
+      t.string :agent_id
+      t.string :access
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20161116222307_add_release_to_permission_templates.rb

@@ -0,0 +1,6 @@
+class AddReleaseToPermissionTemplates < ActiveRecord::Migration
+  def change
+    add_column :permission_templates, :release_date, :date
+    add_column :permission_templates, :release_period, :string
+  end
+end

data/lib/generators/sufia/install_generator.rb

@@ -9,7 +9,6 @@ module Sufia
    2. Installs model-related concerns
      * Creates several database migrations if they do not exist in /db/migrate
      * Adds user behavior to the user model
-     * Generates GenericWork model.
      * Creates the sufia.rb configuration file
      * Generates mailboxer
    3. Adds Sufia's abilities into the Ability class
@@ -99,8 +98,8 @@ module Sufia
     def inject_routes
       gsub_file 'config/routes.rb', /root (:to =>|to:) "catalog#index"/, ''
       gsub_file 'config/routes.rb', /'welcome#index'/, "'sufia/homepage#index'" # Replace the root path injected by CurationConcerns
-      routing_code = "\n mount Sufia::Engine => '/'\n"
-      sentinel = /end\Z/
+      routing_code = "\n  mount Sufia::Engine, at: '/'\n"
+      sentinel = /\s+mount CurationConcerns::Engine/
       inject_into_file 'config/routes.rb', routing_code, before: sentinel, verbose: false
     end
 
@@ -125,6 +124,12 @@ module Sufia
       generate "sufia:assets"
     end
 
+    def add_sufia_collection_indexer
+      inject_into_file 'app/models/collection.rb', after: 'include CurationConcerns::BasicMetadata' do
+        "\n  self.indexer = Sufia::CollectionIndexer"
+      end
+    end
+
     def install_batch_edit
       generate "hydra_batch_edit:install"
     end
@@ -145,5 +150,9 @@ module Sufia
     def datatables
       generate 'jquery:datatables:install bootstrap3'
     end
+
+    def create_workflow
+      template('workflow.json.erb', "config/workflows/one_step_mediated_deposit_workflow.json")
+    end
   end
 end

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

@@ -2,7 +2,6 @@ class CatalogController < ApplicationController
   include Hydra::Catalog
   include Hydra::Controller::ControllerBehavior
   include Sufia::Catalog
-  include BlacklightAdvancedSearch::Controller
 
   # This filter applies the hydra access controls
   before_action :enforce_show_permissions, only: :show
@@ -16,13 +15,6 @@ class CatalogController < ApplicationController
   end
 
   configure_blacklight do |config|
-    # default advanced config values
-    config.advanced_search ||= Blacklight::OpenStructWithHashAccess.new
-    # config.advanced_search[:qt] ||= 'advanced'
-    config.advanced_search[:url_key] ||= 'advanced'
-    config.advanced_search[:query_parser] ||= 'dismax'
-    config.advanced_search[:form_solr_parameters] ||= {}
-
     config.search_builder_class = Sufia::SearchBuilder
 
     # Show gallery view
@@ -33,7 +25,7 @@ class CatalogController < ApplicationController
     config.default_solr_params = {
       qt: "search",
       rows: 10,
-      qf: "title_tesim name_tesim"
+      qf: "title_tesim description_tesim keyword_tesim"
     }
 
     # solr field configuration for document/show views
@@ -118,7 +110,7 @@ class CatalogController < ApplicationController
     # This one uses all the defaults set by the solr request handler. Which
     # solr request handler? The one set in config[:default_solr_parameters][:qt],
     # since we aren't specifying it otherwise.
-    config.add_search_field('all_fields', label: 'All Fields', include_in_advanced_search: false) do |field|
+    config.add_search_field('all_fields', label: 'All Fields') do |field|
       all_names = config.show_fields.values.map(&:field).join(" ")
       title_name = solr_name("title", :stored_searchable)
       field.solr_parameters = {
@@ -212,7 +204,6 @@ class CatalogController < ApplicationController
     end
 
     config.add_search_field('format') do |field|
-      field.include_in_advanced_search = false
       solr_name = solr_name("format", :stored_searchable)
       field.solr_local_parameters = {
         qf: solr_name,
@@ -221,7 +212,6 @@ class CatalogController < ApplicationController
     end
 
     config.add_search_field('identifier') do |field|
-      field.include_in_advanced_search = false
       solr_name = solr_name("id", :stored_searchable)
       field.solr_local_parameters = {
         qf: solr_name,
@@ -247,7 +237,7 @@ class CatalogController < ApplicationController
     end
 
     config.add_search_field('depositor') do |field|
-      solr_name = solr_name("depositor", :stored_searchable)
+      solr_name = solr_name("depositor", :symbol)
       field.solr_local_parameters = {
         qf: solr_name,
         pf: solr_name

data/lib/generators/sufia/templates/workflow.json.erb

@@ -0,0 +1,65 @@
+{
+    "workflows": [
+        {
+            "name": "one_step_mediated_deposit",
+            "label": "One-step mediated deposit workflow",
+            "description": "A single-step workflow for mediated deposit in which all deposits must be approved by a reviewer. Reviewer may also send deposits back to the depositor.",
+            "actions": [
+                {
+                    "name": "deposit",
+                    "from_states": [],
+                    "transition_to": "pending_review",
+                    "notifications": [
+                        {
+                            "notification_type": "email",
+                            "name": "Sufia::Workflow::PendingReviewNotification",
+                            "to": ["approving"]
+                        }
+                    ],
+                    "methods": [
+                        "CurationConcerns::Workflow::DeactivateObject"
+                    ]
+                }, {
+                    "name": "request_changes",
+                    "from_states": [{"names": ["complete", "pending_review"], "roles": ["approving"]}],
+                    "transition_to": "changes_required",
+                    "notifications": [
+                        {
+                            "notification_type": "email",
+                            "name": "Sufia::Workflow::ChangesRequiredNotification",
+                            "to": ["approving"]
+                        }
+                    ],
+                    "methods": [
+                        "CurationConcerns::Workflow::DeactivateObject"
+                    ]
+                }, {
+                    "name": "approve",
+                    "from_states": [{"names": ["pending_review"], "roles": ["approving"]}],
+                    "transition_to": "complete",
+                    "notifications": [
+                        {
+                            "notification_type": "email",
+                            "name": "Sufia::Workflow::CompleteNotification",
+                            "to": ["approving"]
+                        }
+                    ],
+                    "methods": [
+                        "CurationConcerns::Workflow::ActivateObject"
+                    ]
+                }, {
+                    "name": "request_review",
+                    "from_states": [{"names": ["changes_required"], "roles": ["depositing"]}],
+                    "transition_to": "pending_review",
+                    "notifications": [
+                        {
+                            "notification_type": "email",
+                            "name": "Sufia::Workflow::PendingReviewNotification",
+                            "to": ["approving"]
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}

data/lib/generators/sufia/upgrade700_generator.rb

@@ -16,7 +16,7 @@ This generator for upgrading sufia from 6.0.0 to 7.0 makes the following changes
   # The engine routes have to come after the devise routes so that /users/sign_in will work
   def update_catalog_controller
     # Nuke old search_params_logic
-    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]'
+    gsub_file 'app/controllers/catalog_controller.rb', '[:add_access_controls_to_solr_params, :add_advanced_parse_q_to_solr]', 'search_params_logic + [:add_access_controls_to_solr_params]'
   end
 
   def qa_routes

data/lib/generators/sufia/work/templates/locale.en.yml.erb

@@ -0,0 +1,37 @@
+en:
+  sufia:
+    icons:
+      <%= file_name %>:     'fa fa-file-text-o'
+    select_type:
+      <%= file_name %>:
+        name:               "<%= human_name.titleize %>"
+        description:        "<%= human_name %> works"
+  simple_form:
+    labels:
+      <%= file_name %>:
+        based_near:       "Location"
+        description:      "Abstract or Summary"
+        keyword:          "Keyword"
+        date_created:     "Date Created"
+        related_url:      "Related URL"
+        files:            "Upload a new version of this file from your computer"
+        collection_ids:   "Add as member of collection"
+        admin_set_id:     "Add as member of administrative set"
+
+    hints:
+      <%= file_name %>:
+        resource: "Pre-defined categories to describe the type of content being uploaded, such as &quot;article&quot; or &quot;dataset.&quot;  More than one type may be selected."
+        title: "A name to aid in identifying a work."
+        keyword: "Words or phrases you select to describe what the work is about. These are used to search for content."
+        subject: "Headings or index terms describing what the work is about; these do need to conform to an existing vocabulary."
+        creator: "The person or group responsible for the work. Usually this is the author of the content. Personal names should be entered with the last name first, e.g. &quot;Smith, John.&quot;."
+        related_url: "A link to a website or other specific content (audio, video, PDF document) related to the work. An example is the URL of a research project from which the work was derived."
+        based_near: "A place name related to the work, such as its site of publication, or the city, state, or country the work contents are about. Calls upon the <a href='http://www.geonames.org'>GeoNames web service</a>."
+        contributor: "A person or group you want to recognize for playing a role in the creation of the work, but not the primary role."
+        date_created: "The date on which the work was generated."
+        description: "Free-text notes about the work. Examples include abstracts of a paper or citation information for a journal article."
+        identifier: "A unique handle identifying the work. An example would be a DOI for a journal article, or an ISBN or OCLC number for a book."
+        language: "The language of the work's content."
+        publisher: "The person or group making the work available. Generally this is the institution."
+        rights: "Licensing and distribution information governing access to the work. Select from the provided drop-down list."
+

data/lib/generators/sufia/{work_generator.rb → work/work_generator.rb}

@@ -3,6 +3,12 @@ require 'generators/curation_concerns/work/work_generator'
 module Sufia
   class WorkGenerator < CurationConcerns::WorkGenerator
     source_root CurationConcerns::WorkGenerator.source_root
+
+    # Allows us to pull templates from sufia as well as from curation_concerns
+    def self.source_paths
+      [File.expand_path('../templates/', __FILE__)]
+    end
+
     desc """
   This generator makes the following changes to your application:
    1. Generates work model
@@ -15,17 +21,31 @@ module Sufia
       super
     end
 
+    def create_i18n
+      template 'locale.en.yml.erb', "config/locales/#{file_name}.en.yml"
+    end
+
+    # Inserts after the last registering work, or at the top of the config block
     def register_work
-      inject_into_file 'config/initializers/sufia.rb', after: "Sufia.config do |config|\n" do
-        "  # Injected via `rails g sufia:work #{class_name}`\n" \
-        "  config.register_curation_concern :#{file_name}\n"
+      config = 'config/initializers/sufia.rb'
+      lastmatch = nil
+      File.open(config).each_line do |line|
+        lastmatch = line if line =~ /^\s*config.register_curation_concern :.*\n$/
+      end
+      content = "  # Injected via `rails g sufia:work #{class_name}`\n" \
+                "  config.register_curation_concern :#{file_name}\n"
+      content = "  # Note: order of registration affects Zotero/Arkivo\n#{content}" unless lastmatch
+      anchor = lastmatch || "Sufia.config do |config|\n"
+      inject_into_file config, after: anchor do
+        content
       end
     end
 
     def inject_sufia_work_behavior
-      insert_into_file "app/models/#{name.underscore}.rb", after: 'include ::CurationConcerns::BasicMetadata' do
+      underscored_name = name.underscore
+      insert_into_file "app/models/#{underscored_name}.rb", after: 'include ::CurationConcerns::BasicMetadata' do
         "\n  include Sufia::WorkBehavior" \
-        "\n  self.human_readable_type = 'Work'"
+        "\n  self.human_readable_type = '#{underscored_name.titleize}'"
       end
     end
 

data/lib/sufia.rb

@@ -8,7 +8,6 @@ require 'font-awesome-rails'
 require 'tinymce-rails'
 require 'tinymce-rails-imageupload'
 require 'blacklight'
-require 'blacklight_advanced_search'
 require 'blacklight/gallery'
 require 'active_fedora/noid'
 require 'hydra/head'

data/lib/sufia/engine.rb

@@ -53,6 +53,13 @@ module Sufia
       end
 
       CurationConcerns::CurationConcern.actor_factory = Sufia::ActorFactory
+      CurationConcerns::Workflow::WorkflowFactory.workflow_strategy = Sufia::Workflow::WorkflowByAdminSetStrategy
+      CurationConcerns::MemberPresenterFactory.file_presenter_class = Sufia::FileSetPresenter
+
+      # Don't try to load this class until the application has been generated
+      if defined? ::SearchBuilder
+        CurationConcerns::AdminSetService.default_search_builder = Sufia::AdminSetSearchBuilder
+      end
     end
 
     initializer 'sufia.assets.precompile' do |app|

data/lib/sufia/move_all_works_to_admin_set.rb

@@ -0,0 +1,8 @@
+# If you want to move all your works to an admin set run this.
+class MoveAllWorksToAdminSet
+  def self.run(admin_set)
+    CurationConcerns::WorkRelation.new.find_each do |w|
+      w.update(admin_set: admin_set)
+    end
+  end
+end

data/lib/sufia/version.rb

@@ -1,3 +1,3 @@
 module Sufia
-  VERSION = '7.2.0'.freeze
+  VERSION = '7.3.0.rc1'.freeze
 end

data/lib/tasks/migrate.rake

@@ -0,0 +1,8 @@
+namespace :sufia do
+  namespace :migrate do
+    task move_all_works_to_admin_set: :environment do
+      require 'sufia/move_all_works_to_admin_set'
+      MoveAllWorksToAdminSet.run(AdminSet.find(Sufia::DefaultAdminSetActor::DEFAULT_ID))
+    end
+  end
+end

data/spec/actors/sufia/apply_permission_template_actor_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe Sufia::ApplyPermissionTemplateActor do
+  let(:create_actor) do
+    double('create actor', create: true,
+                           curation_concern: work,
+                           update: true,
+                           user: depositor)
+  end
+  let(:actor) do
+    CurationConcerns::Actors::ActorStack.new(work, depositor, [described_class])
+  end
+  let(:depositor) { create(:user) }
+  let(:work) { build(:generic_work) }
+  let(:attributes) { { admin_set_id: admin_set.id } }
+  let(:admin_set) { create(:admin_set) }
+  let(:permission_template) { create(:permission_template, admin_set_id: admin_set.id) }
+
+  describe "create" do
+    context "when admin_set_id is blank" do
+      let(:attributes) { { admin_set_id: '' } }
+
+      it "returns true" do
+        expect(actor.create(attributes)).to be true
+      end
+    end
+
+    context "when admin_set_id is provided" do
+      let(:attributes) { { admin_set_id: admin_set.id } }
+      before do
+        create(:permission_template_access,
+               permission_template: permission_template,
+               agent_type: 'user',
+               agent_id: 'hannah',
+               access: 'manage')
+        create(:permission_template_access,
+               permission_template: permission_template,
+               agent_type: 'group',
+               agent_id: 'librarians',
+               access: 'manage')
+        create(:permission_template_access,
+               permission_template: permission_template,
+               agent_type: 'user',
+               agent_id: 'gary',
+               access: 'view')
+        create(:permission_template_access,
+               permission_template: permission_template,
+               agent_type: 'group',
+               agent_id: 'readers',
+               access: 'view')
+        allow(CurationConcerns::Actors::RootActor).to receive(:new).and_return(create_actor)
+        allow(create_actor).to receive(:create).and_return(true)
+      end
+
+      it "adds the template users to the work" do
+        expect(actor.create(attributes)).to be true
+        expect(work.edit_users).to include 'hannah'
+        expect(work.edit_groups).to include 'librarians'
+        expect(work.read_users).to include 'gary'
+        expect(work.read_groups).to include 'readers'
+      end
+    end
+  end
+end

data/spec/actors/sufia/create_with_remote_files_actor_spec.rb

@@ -55,5 +55,13 @@ describe Sufia::CreateWithRemoteFilesActor do
       expect(IngestLocalFileJob).to receive(:perform_later).with(FileSet, "/local/file/here.txt", user)
       expect(actor.create(attributes)).to be true
     end
+
+    context "with spaces" do
+      let(:file) { "file:///local/file/ pigs .txt" }
+      it "attaches files" do
+        expect(IngestLocalFileJob).to receive(:perform_later).with(FileSet, "/local/file/ pigs .txt", user)
+        expect(actor.create(attributes)).to be true
+      end
+    end
   end
 end