curation_concerns 0.1.0 → 0.2.0

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

@@ -0,0 +1,236 @@
+class CatalogController < ApplicationController
+  include CurationConcerns::CatalogController
+  configure_blacklight do |config|
+    config.search_builder_class = CurationConcerns::SearchBuilder
+    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
+    config.default_solr_params = {
+      qf: search_config['qf'],
+      qt: search_config['qt'],
+      rows: search_config['rows']
+    }
+
+    # solr field configuration for search results/index views
+    config.index.title_field = solr_name('title', :stored_searchable)
+    config.index.display_type_field = solr_name('has_model', :symbol)
+
+    config.index.thumbnail_field = 'thumbnail_path_ss'
+    config.index.partials.delete(:thumbnail) # we render this inside _index_default.html.erb
+    config.index.partials += [:action_menu]
+
+    # solr field configuration for document/show views
+    # config.show.title_field = solr_name("title", :stored_searchable)
+    # config.show.display_type_field = solr_name("has_model", :symbol)
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    config.add_facet_field solr_name('human_readable_type', :facetable)
+    config.add_facet_field solr_name('creator', :facetable), limit: 5
+    config.add_facet_field solr_name('tag', :facetable), limit: 5
+    config.add_facet_field solr_name('subject', :facetable), limit: 5
+    config.add_facet_field solr_name('language', :facetable), limit: 5
+    config.add_facet_field solr_name('based_near', :facetable), limit: 5
+    config.add_facet_field solr_name('publisher', :facetable), limit: 5
+    config.add_facet_field solr_name('file_format', :facetable), limit: 5
+    config.add_facet_field 'generic_type_sim', show: false, single: true
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display
+    config.add_index_field solr_name('description', :stored_searchable)
+    config.add_index_field solr_name('tag', :stored_searchable)
+    config.add_index_field solr_name('subject', :stored_searchable)
+    config.add_index_field solr_name('creator', :stored_searchable)
+    config.add_index_field solr_name('contributor', :stored_searchable)
+    config.add_index_field solr_name('publisher', :stored_searchable)
+    config.add_index_field solr_name('based_near', :stored_searchable)
+    config.add_index_field solr_name('language', :stored_searchable)
+    config.add_index_field solr_name('date_uploaded', :stored_sortable)
+    config.add_index_field solr_name('date_modified', :stored_sortable)
+    config.add_index_field solr_name('date_created', :stored_searchable)
+    config.add_index_field solr_name('rights', :stored_searchable)
+    config.add_index_field solr_name('human_readable_type', :stored_searchable)
+    config.add_index_field solr_name('format', :stored_searchable)
+    config.add_index_field solr_name('identifier', :stored_searchable)
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different.
+    #
+    # 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|
+      title_name = solr_name('title', :stored_searchable, type: :string)
+      label_name = solr_name('title', :stored_searchable, type: :string)
+      contributor_name = solr_name('contributor', :stored_searchable, type: :string)
+      field.solr_parameters = {
+        qf: "#{title_name} #{label_name} file_format_tesim #{contributor_name}",
+        pf: "#{title_name}"
+      }
+    end
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields.
+    # creator, title, description, publisher, date_created,
+    # subject, language, resource_type, format, identifier, based_near,
+    config.add_search_field('contributor') do |field|
+      # solr_parameters hash are sent to Solr as ordinary url query params.
+
+      # :solr_local_parameters will be sent using Solr LocalParams
+      # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+      # Solr parameter de-referencing like $title_qf.
+      # See: http://wiki.apache.org/solr/LocalParams
+      solr_name = solr_name('contributor', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('creator') do |field|
+      solr_name = solr_name('creator', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('title') do |field|
+      solr_name = solr_name('title', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('description') do |field|
+      field.label = 'Abstract or Summary'
+      solr_name = solr_name('description', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('publisher') do |field|
+      solr_name = solr_name('publisher', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('date_created') do |field|
+      solr_name = solr_name('created', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('subject') do |field|
+      solr_name = solr_name('subject', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('language') do |field|
+      solr_name = solr_name('language', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('human_readable_type') do |field|
+      solr_name = solr_name('human_readable_type', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('format') do |field|
+      field.include_in_advanced_search = false
+      solr_name = solr_name('format', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('identifier') do |field|
+      field.include_in_advanced_search = false
+      solr_name = solr_name('id', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('based_near') do |field|
+      field.label = 'Location'
+      solr_name = solr_name('based_near', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('tag') do |field|
+      solr_name = solr_name('tag', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('depositor') do |field|
+      solr_name = solr_name('depositor', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    config.add_search_field('rights') do |field|
+      solr_name = solr_name('rights', :stored_searchable, type: :string)
+      field.solr_local_parameters = {
+        qf: solr_name,
+        pf: solr_name
+      }
+    end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    # label is key, solr field is value
+    config.add_sort_field "score desc, #{uploaded_field} desc", label: "relevance \u25BC"
+    config.add_sort_field "#{uploaded_field} desc", label: "date uploaded \u25BC"
+    config.add_sort_field "#{uploaded_field} asc", label: "date uploaded \u25B2"
+    config.add_sort_field "#{modified_field} desc", label: "date modified \u25BC"
+    config.add_sort_field "#{modified_field} asc", label: "date modified \u25B2"
+
+    # If there are more than this many search results, no spelling ("did you
+    # mean") suggestion is offered.
+    config.spell_max = 5
+  end
+end

data/lib/generators/curation_concerns/templates/config/authorities/rights.yml

@@ -0,0 +1,19 @@
+terms:
+    - id: http://creativecommons.org/licenses/by/3.0/us/
+      term: Attribution 3.0 United States
+    - id: http://creativecommons.org/licenses/by-sa/3.0/us/
+      term: Attribution-ShareAlike 3.0 United States
+    - id: http://creativecommons.org/licenses/by-nc/3.0/us/
+      term: Attribution-NonCommercial 3.0 United States
+    - id: http://creativecommons.org/licenses/by-nd/3.0/us/
+      term: Attribution-NoDerivs 3.0 United States
+    - id: http://creativecommons.org/licenses/by-nc-nd/3.0/us/
+      term: Attribution-NonCommercial-NoDerivs 3.0 United States
+    - id: http://creativecommons.org/licenses/by-nc-sa/3.0/us/
+      term: Attribution-NonCommercial-ShareAlike 3.0 United States
+    - id: http://creativecommons.org/publicdomain/mark/1.0/
+      term: Public Domain Mark 1.0
+    - id: http://creativecommons.org/publicdomain/zero/1.0/
+      term: CC0 1.0 Universal
+    - id: http://www.europeana.eu/portal/rights/rr-r.html
+      term: All rights reserved

data/lib/generators/curation_concerns/work/templates/actor_spec.rb.erb

@@ -3,7 +3,7 @@
 require 'rails_helper'
 
 describe CurationConcerns::<%= class_name %>Actor do
-  it "should have some tests" do
+  it "has tests" do
     skip "Add your tests here"
   end
 end

data/lib/generators/curation_concerns/work/templates/controller_spec.rb.erb

@@ -3,7 +3,7 @@
 require 'rails_helper'
 
 describe CurationConcerns::<%= class_name.pluralize %>Controller do
-  it "should have some tests" do
+  it "has tests" do
     skip "Add your tests here"
   end
 end

data/lib/generators/curation_concerns/work/templates/form.rb.erb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate curation_concerns:work <%= class_name %>`
+module CurationConcerns
+  class <%= class_name %>Form < CurationConcerns::Forms::WorkForm
+    self.model_class = ::<%= class_name %>
+  end
+end
+

data/lib/generators/curation_concerns/work/templates/form_spec.rb.erb

@@ -0,0 +1,10 @@
+# Generated via
+#  `rails generate curation_concerns:work <%= class_name %>`
+require 'rails_helper'
+
+describe CurationConcerns::<%= class_name %>Form do
+  it "has tests" do
+    skip "Add your tests here"
+  end
+end
+

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

@@ -1,7 +1,7 @@
 # Generated via
 #  `rails generate curation_concerns:work <%= class_name %>`
 class <%= class_name %> < ActiveFedora::Base
-  include ::CurationConcerns::GenericWorkBehavior
+  include ::CurationConcerns::WorkBehavior
   include ::CurationConcerns::BasicMetadata
-  validates_presence_of :title,  message: 'Your work must have a title.'
+  validates :title, presence: { message: 'Your work must have a title.' }
 end

data/lib/generators/curation_concerns/work/templates/model_spec.rb.erb

@@ -3,7 +3,7 @@
 require 'rails_helper'
 
 describe <%= class_name %> do
-  it "should have some tests" do
+  it "has tests" do
     skip "Add your tests here"
   end
 end

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

@@ -3,64 +3,71 @@ require 'rails/generators'
 
 class Rails::Generators::NamedBase
   private
-  def destroy(what, *args)
-    log :destroy, what
-    argument = args.map {|arg| arg.to_s }.flatten.join(" ")
 
-    in_root {
-      run_ruby_script("bin/rails destroy #{what} #{argument}", verbose: true)
-    }
-  end
+    def destroy(what, *args)
+      log :destroy, what
+      argument = args.map(&:to_s).flatten.join(' ')
+
+      in_root do
+        run_ruby_script("bin/rails destroy #{what} #{argument}", verbose: true)
+      end
+    end
 end
 
 class CurationConcerns::WorkGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path("../templates", __FILE__)
+  source_root File.expand_path('../templates', __FILE__)
 
-
-  argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+  argument :attributes, type: :array, default: [], banner: 'field:type field:type'
 
   # Why all of these antics with defining individual methods?
   # Because I want the output of CurationConcerns::WorkGenerator to include all the processed files.
   def create_model_spec
     return unless rspec_installed?
-    template "model_spec.rb.erb", "spec/models/#{file_name}_spec.rb"
+    template 'model_spec.rb.erb', "spec/models/#{file_name}_spec.rb"
   end
 
   def create_model
-    template("model.rb.erb", "app/models/#{file_name}.rb")
+    template('model.rb.erb', "app/models/#{file_name}.rb")
   end
+
   def create_controller_spec
     return unless rspec_installed?
-    template("controller_spec.rb.erb", "spec/controllers/curation_concerns/#{plural_file_name}_controller_spec.rb")
+    template('controller_spec.rb.erb', "spec/controllers/curation_concerns/#{plural_file_name}_controller_spec.rb")
   end
 
   def create_actor_spec
     return unless rspec_installed?
-    template("actor_spec.rb.erb", "spec/actors/curation_concerns/#{file_name}_actor_spec.rb")
+    template('actor_spec.rb.erb', "spec/actors/curation_concerns/#{file_name}_actor_spec.rb")
+  end
+
+  def create_form_spec
+    return unless rspec_installed?
+    template('form_spec.rb.erb', "spec/forms/curation_concerns/#{file_name}_form_spec.rb")
   end
 
   def create_controller
-    template("controller.rb.erb", "app/controllers/curation_concerns/#{plural_file_name}_controller.rb")
+    template('controller.rb.erb', "app/controllers/curation_concerns/#{plural_file_name}_controller.rb")
   end
 
   def create_actor
-    template("actor.rb.erb", "app/actors/curation_concerns/#{file_name}_actor.rb")
+    template('actor.rb.erb', "app/actors/curation_concerns/#{file_name}_actor.rb")
+  end
+
+  def create_form
+    template('form.rb.erb', "app/forms/curation_concerns/#{file_name}_form.rb")
   end
 
   def register_work
-    inject_into_file 'config/initializers/curation_concerns_config.rb', after: "CurationConcerns.configure do |config|\n" do
-      data = ""
-      data << "  # Injected via `rails g curation_concerns:work #{class_name}`\n"
-      data << "  config.register_curation_concern :#{file_name}\n"
-      data
+    inject_into_file 'config/initializers/curation_concerns.rb', after: "CurationConcerns.configure do |config|\n" do
+      "  # Injected via `rails g curation_concerns:work #{class_name}`\n" \
+      "  config.register_curation_concern :#{file_name}\n"
     end
   end
 
   def create_views
     create_file "app/views/curation_concerns/#{plural_file_name}/_#{file_name}.html.erb" do
-      data = "<%# This is a search result view %>\n"
-      data << "<%= render 'catalog/document', document: #{file_name}, document_counter: #{file_name}_counter  %>\n"
-      data
+      "<%# This is a search result view %>\n" \
+      "<%= render 'catalog/document', document: #{file_name}, document_counter: #{file_name}_counter  %>\n"
     end
   end
 
@@ -68,11 +75,9 @@ class CurationConcerns::WorkGenerator < Rails::Generators::NamedBase
     readme 'README'
   end
 
-
   private
 
     def rspec_installed?
       defined?(RSpec) && defined?(RSpec::Rails)
     end
-
 end

data/spec/abilities/collection_abilities_spec.rb

@@ -1,48 +1,48 @@
 require 'spec_helper'
-require "cancan/matchers"
+require 'cancan/matchers'
 
-describe "User" do
-  describe "Abilities" do
+describe 'User' do
+  describe 'Abilities' do
     subject { ability }
     let(:ability) { Ability.new(current_user) }
     let(:visibility) { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE }
-    let(:creating_user) { FactoryGirl.create(:user) }
-    let(:user) { FactoryGirl.create(:user) }
+    let(:creating_user) { create(:user) }
+    let(:user) { create(:user) }
     let(:current_user) { user }
-    let(:collection) {  FactoryGirl.create(:collection, visibility: visibility, user: creating_user) }
+    let(:collection) { create(:collection, visibility: visibility, user: creating_user) }
     before do
       collection.visibility = visibility
       collection.save
     end
     describe 'the collection creator' do
       let(:current_user) { creating_user }
-      it {
+      it do
         should be_able_to(:create, ::Collection.new)
         should be_able_to(:create, ::Collection)
         should be_able_to(:read, collection)
         should be_able_to(:update, collection)
         should be_able_to(:destroy, collection)
-      }
+      end
     end
 
     describe 'another authenticated user' do
-      it {
+      it do
         should be_able_to(:create, ::Collection.new)
         should be_able_to(:create, ::Collection)
         should_not be_able_to(:read, collection)
         should_not be_able_to(:update, collection)
         should_not be_able_to(:destroy, collection)
-      }
+      end
     end
 
     describe 'a nil user' do
       let(:current_user) { nil }
-      it {
-        should_not be_able_to(:create, GenericFile.new)
+      it do
+        should_not be_able_to(:create, ::Collection.new)
         should_not be_able_to(:read, collection)
         should_not be_able_to(:update, collection)
         should_not be_able_to(:destroy, collection)
-      }
+      end
     end
   end
 end

data/spec/abilities/embargo_and_lease_ability_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'cancan/matchers'
+
+describe "Ability on embargos and leases" do
+  subject { Ability.new(current_user) }
+
+  let(:current_user) { create(:user) }
+
+  describe "a regular user" do
+    it do
+      should_not be_able_to :index, Hydra::AccessControls::Embargo
+      should_not be_able_to :index, Hydra::AccessControls::Lease
+    end
+  end
+
+  describe "an admin user" do
+    before { allow(current_user).to receive(:groups).and_return(['admin']) }
+    it do
+      should be_able_to :index, Hydra::AccessControls::Embargo
+      should be_able_to :index, Hydra::AccessControls::Lease
+    end
+  end
+end

data/spec/abilities/file_set_abilities_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'cancan/matchers'
+
+describe 'User' do
+  describe 'Abilities' do
+    subject { ability }
+    let(:ability) { Ability.new(current_user) }
+    let(:visibility) { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE }
+    let(:creating_user) { create(:user) }
+    let(:user) { create(:user) }
+    let(:current_user) { user }
+    let(:generic_work) { create(:generic_work, visibility: visibility, user: creating_user) }
+    let(:file_set) { create(:file_set, visibility: visibility, user: creating_user) }
+
+    describe 'without embargo' do
+      describe 'creator of object' do
+        let(:creating_user) { user }
+        let(:current_user) { user }
+        it do
+          is_expected.to be_able_to(:create, FileSet.new)
+          is_expected.to be_able_to(:versions, file_set)
+          is_expected.to be_able_to(:read, file_set)
+          is_expected.to be_able_to(:update, file_set)
+          is_expected.to_not be_able_to(:delete, file_set)
+        end
+      end
+
+      describe 'as a repository manager' do
+        let(:manager_user) { FactoryGirl.create(:admin) }
+        let(:creating_user) { user }
+        let(:current_user) { manager_user }
+        it do
+          is_expected.to be_able_to(:create, FileSet.new)
+          is_expected.to be_able_to(:versions, file_set)
+          is_expected.to be_able_to(:read, file_set)
+          is_expected.to be_able_to(:update, file_set)
+          is_expected.to be_able_to(:destroy, file_set)
+        end
+      end
+
+      describe 'another authenticated user' do
+        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:current_user) { user }
+
+        it do
+          is_expected.to be_able_to(:create, FileSet.new)
+          is_expected.to_not be_able_to(:versions, file_set)
+          is_expected.to_not be_able_to(:read, file_set)
+          is_expected.to_not be_able_to(:update, file_set)
+          is_expected.to_not be_able_to(:delete, file_set)
+        end
+      end
+
+      describe 'a nil user' do
+        let(:creating_user) { FactoryGirl.create(:user) }
+        let(:current_user) { nil }
+        it do
+          is_expected.to_not be_able_to(:create, FileSet.new)
+          is_expected.to_not be_able_to(:versions, file_set)
+          is_expected.to_not be_able_to(:read, file_set)
+          is_expected.to_not be_able_to(:update, file_set)
+          is_expected.to_not be_able_to(:delete, file_set)
+        end
+      end
+    end
+  end
+end

data/spec/abilities/generic_work_abilities_spec.rb

@@ -1,57 +1,57 @@
 require 'spec_helper'
-require "cancan/matchers"
+require 'cancan/matchers'
 
-describe "User" do
-  describe "Abilities" do
+describe 'User' do
+  describe 'Abilities' do
     subject { Ability.new(current_user) }
 
-    let(:generic_work) { FactoryGirl.create(:private_generic_work, user: creating_user ) }
+    let(:generic_work) { FactoryGirl.create(:private_generic_work, user: creating_user) }
     let(:user) { FactoryGirl.create(:user) }
 
     describe 'without embargo' do
       describe 'creator of object' do
         let(:creating_user) { user }
         let(:current_user) { user }
-        it {
+        it do
           should be_able_to(:create, GenericWork.new)
           should be_able_to(:read, generic_work)
           should be_able_to(:update, generic_work)
           should be_able_to(:destroy, generic_work)
-        }
+        end
       end
 
       describe 'as a repository manager' do
         let(:manager_user) { FactoryGirl.create(:admin) }
         let(:creating_user) { user }
         let(:current_user) { manager_user }
-        it {
+        it do
           should be_able_to(:create, GenericWork.new)
           should be_able_to(:read, generic_work)
           should be_able_to(:update, generic_work)
           should be_able_to(:destroy, generic_work)
-        }
+        end
       end
 
       describe 'another authenticated user' do
         let(:creating_user) { FactoryGirl.create(:user) }
         let(:current_user) { user }
-        it {
+        it do
           should be_able_to(:create, GenericWork.new)
           should_not be_able_to(:read, generic_work)
           should_not be_able_to(:update, generic_work)
           should_not be_able_to(:destroy, generic_work)
-        }
+        end
       end
 
       describe 'a nil user' do
         let(:creating_user) { FactoryGirl.create(:user) }
         let(:current_user) { nil }
-        it {
+        it do
           should_not be_able_to(:create, GenericWork.new)
           should_not be_able_to(:read, generic_work)
           should_not be_able_to(:update, generic_work)
           should_not be_able_to(:destroy, generic_work)
-        }
+        end
       end
     end
   end