RubyGems - hydra-collections - Versions diffs - 4.0.0 → 5.0.0 - Mend

hydra-collections 4.0.0 → 5.0.0

Files changed (42) hide show

checksums.yaml +4 -4
data/.rspec +1 -0
data/.travis.yml +0 -3
data/Gemfile +6 -1
data/app/controllers/concerns/hydra/collections/selects_collections.rb +30 -33
data/app/controllers/concerns/hydra/collections_controller_behavior.rb +39 -17
data/app/models/concerns/hydra/collection.rb +5 -76
data/app/models/concerns/hydra/collections/actions.rb +22 -0
data/app/models/concerns/hydra/collections/metadata.rb +62 -0
data/app/models/concerns/hydra/collections/relations.rb +8 -0
data/app/search_builders/hydra/collections/search_builder.rb +31 -0
data/app/views/collections/_bookmark_control.html.erb +2 -0
data/app/views/collections/_document_list.html.erb +1 -1
data/app/views/collections/_index_default.html.erb +2 -0
data/app/views/collections/_index_header_default.html.erb +2 -0
data/app/views/collections/_paginate_compact.html.erb +1 -0
data/app/views/collections/_results_pagination.html.erb +9 -0
data/app/views/collections/_search_results.html.erb +23 -0
data/app/views/collections/_thumbnail_default.html.erb +2 -0
data/app/views/collections/index.html.erb +9 -0
data/app/views/collections/show.html.erb +3 -3
data/app/views/layouts/collections.html.erb +48 -0
data/config/routes.rb +3 -3
data/hydra-collections.gemspec +3 -2
data/lib/hydra/collections/collectible.rb +1 -0
data/lib/hydra/collections/search_service.rb +2 -2
data/lib/hydra/collections/version.rb +1 -1
data/spec/controllers/collections_controller_spec.rb +37 -51
data/spec/controllers/other_collections_controller_spec.rb +25 -57
data/spec/controllers/selects_collections_spec.rb +14 -30
data/spec/helpers/collections_helper_spec.rb +5 -5
data/spec/lib/collectible_spec.rb +1 -0
data/spec/models/collection_spec.rb +7 -34
data/spec/spec_helper.rb +7 -11
data/spec/test_app_templates/Gemfile.extra +1 -0
data/spec/test_app_templates/app/controllers/other_collections_controller.rb +8 -0
data/spec/test_app_templates/app/views/catalog/_sort_and_per_page.html.erb +3 -8
data/spec/test_app_templates/config/blacklight.yml +22 -0
data/spec/test_app_templates/lib/generators/test_app_generator.rb +17 -9
data/spec/views/collections/_thumbnail_default.html.erb_spec.rb +25 -0
data/spec/views/collections/show.html.erb_spec.rb +32 -0
metadata +44 -7

data/app/views/collections/_bookmark_control.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <%= render 'catalog/bookmark_control', document: document %>
2	+

data/app/views/collections/_document_list.html.erb CHANGED

	@@ -1 +1 @@
1	- <%= render ~~partial:~~'catalog/document_list', ~~locals:{~~documents: documents} %>
1	+ <%= render 'catalog/document_list', documents: documents %>

data/app/views/collections/_index_default.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <%= render 'catalog/index_default', document: document %>
2	+

data/app/views/collections/_index_header_default.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <%= render 'catalog/index_header_default', document: document, document_counter: document_counter %>
2	+

data/app/views/collections/_paginate_compact.html.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= paginate paginate_compact, page_entries_info: page_entries_info(paginate_compact), theme: :blacklight_compact, route_set: collections %>

data/app/views/collections/_results_pagination.html.erb ADDED

@@ -0,0 +1,9 @@
+<% if show_pagination? and @response.total_pages > 1 %>
+ <div class="row record-padding">
+  <div class="col-md-9">
+    <div class="pagination">
+      <%= paginate @response, :outer_window => 2, :theme => 'blacklight', route_set: collections %>
+    </div>
+  </div>
+ </div>
+<% end %>

data/app/views/collections/_search_results.html.erb ADDED

@@ -0,0 +1,23 @@
+<h2 class="sr-only top-content-title"><%= t('blacklight.search.search_results_header') %></h2>
+<% @page_title = t('blacklight.search.title', :application_name => application_name) %>
+<% content_for(:head) do -%>
+  <%= render_opensearch_response_metadata %>
+<% end -%>
+<%= render 'search_header' %>
+<h2 class="sr-only"><%= t('blacklight.search.search_results') %></h2>
+<%- if @response.empty? %>
+  <%= render "zero_results" %>
+<%- elsif render_grouped_response? %>
+  <%= render_grouped_document_index %>
+<%- else %>
+  <%= render_document_index %>
+<%- end %>
+<%= render 'results_pagination' %>

data/app/views/collections/_thumbnail_default.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <%= render 'catalog/thumbnail_default', document: document, document_counter: document_counter %>
2	+

data/app/views/collections/index.html.erb ADDED

@@ -0,0 +1,9 @@
+<div id="sidebar" class="col-md-3 col-sm-4">
+  <%= render 'search_sidebar' %>
+</div>
+<div id="content" class="col-md-9 col-sm-8">
+  <h2>Collections</h2>
+  <%= render 'search_results' %>
+</div>

data/app/views/collections/show.html.erb CHANGED

@@ -1,5 +1,5 @@
 <h1><%=@collection.title%><h1>
 <h3><%=@collection.description%> </h3>
-<h3> <u>Contained Files </u></h3>
-<%= render partial: 'search_form'%>
-<%= render partial:'document_list', locals:{documents: @member_docs} %>
+<h3><u>Contained Files</u></h3>
+<%= render 'search_form'%>
+<%= render 'document_list', documents: @member_docs %>

data/app/views/layouts/collections.html.erb ADDED

@@ -0,0 +1,48 @@
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <!-- Mobile viewport optimization h5bp.com/ad -->
+    <meta name="HandheldFriendly" content="True">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <!-- Internet Explorer use the highest version available -->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <!-- Mobile IE allows us to activate ClearType technology for smoothing fonts for easy reading -->
+    <!--[if IEMobile]>
+      <meta http-equiv="cleartype" content="on">
+    <![endif]-->
+    <title><%= render_page_title %></title>
+    <%= opensearch_description_tag application_name, opensearch_catalog_url(:format => 'xml') %>
+    <%= favicon_link_tag 'favicon.ico' %>
+    <%= stylesheet_link_tag "application", media: "all" %>
+    <%= javascript_include_tag "application" %>
+    <%= csrf_meta_tags %>
+    <%= content_for(:head) %>
+    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!--[if lt IE 9]>
+      <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body class="<%= render_body_class %>">
+  <%= render :partial => 'shared/header_navbar' %>
+  <%= render partial: 'shared/ajax_modal' %>
+  <div id="main-container" class="container">
+    <%= render :partial=>'/flash_msg', layout: 'shared/flash_messages' %>
+    <div class="row">
+      <%= yield %>
+    </div>
+  </div>
+  <%= render :partial => 'shared/footer' %>
+  </body>
+</html>

data/config/routes.rb CHANGED

@@ -1,3 +1,3 @@
-Hydra::Collections::Engine.routes.draw do
-  resources :collections, except: :index
-end
+Hydra::Collections::Engine.routes.draw do
+  resources :collections
+end

data/hydra-collections.gemspec CHANGED

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_dependency 'hydra-head', '~> 9.0.1'
-  spec.add_dependency 'deprecation', '~> 0.1.0'
+  spec.add_dependency 'hydra-head', '~> 9.1'
+  spec.add_dependency 'deprecation', '~> 0.1'
+  spec.add_dependency 'blacklight', '~> 5.10'
   spec.add_development_dependency 'engine_cart', '~> 0.5'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'

data/lib/hydra/collections/collectible.rb CHANGED

@@ -19,6 +19,7 @@ module Hydra::Collections::Collectible
   #    return solr_doc
   #   end
   def index_collection_ids(solr_doc={})
+    Deprecation.warn(Hydra::Collections::Collectible, 'index_collection_ids is deprecated and will be removed in version 5.0')
     # CollectionAssociation#ids_reader loads from solr on each call, so only call it once
     # see https://github.com/projecthydra/active_fedora/issues/644
     ids = collection_ids

data/lib/hydra/collections/search_service.rb CHANGED

@@ -2,7 +2,7 @@ module Hydra
   module Collections
     class SearchService
       include Blacklight::Configurable
-      include Blacklight::SolrHelper
+      include Blacklight::SearchHelper
       def initialize(session, user_key)
         @session = session
@@ -10,7 +10,7 @@ module Hydra
         self.class.copy_blacklight_config_from(::CatalogController)
       end
-      solr_search_params_logic << :apply_gated_search
+      self.search_params_logic << :apply_gated_search
       def last_search_documents
         return [] if @session[:history].blank?

data/lib/hydra/collections/version.rb CHANGED

@@ -1,5 +1,5 @@
 module Hydra
   module Collections
-    VERSION = "4.0.0"
+    VERSION = "5.0.0"
   end
 end

data/spec/controllers/collections_controller_spec.rb CHANGED

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe CollectionsController, :type => :controller do
   let(:collections) { Hydra::Collections::Engine.routes.url_helpers }
+  routes { Hydra::Collections::Engine.routes }
   before(:all) do
     CollectionsController.configure_blacklight do |config|
       config.default_solr_params = {:qf => 'label_tesim'}
@@ -15,7 +17,6 @@ describe CollectionsController, :type => :controller do
       def to_solr(solr_doc={})
         super.tap do |solr_doc|
-          solr_doc = index_collection_ids(solr_doc)
           solr_doc["label_tesim"] = self.title
         end
       end
@@ -26,15 +27,29 @@ describe CollectionsController, :type => :controller do
     Object.send(:remove_const, :GenericFile)
   end
+  let(:user) { FactoryGirl.create(:user) }
   before do
     allow(controller).to receive(:has_access?).and_return(true)
-    @user = FactoryGirl.find_or_create(:user)
-    sign_in @user
+    sign_in user
     allow_any_instance_of(User).to receive(:groups).and_return([])
     allow(controller).to receive(:clear_session_user) ## Don't clear out the authenticated session
   end
+  describe "#index" do
+    let!(:collection1) { Collection.create { |c| c.apply_depositor_metadata(user.user_key) } }
+    let!(:collection2) { Collection.create { |c| c.apply_depositor_metadata(user.user_key) } }
+    let!(:generic_file) { GenericFile.create }
+    it "should show a list of collections" do
+      get :index
+      expect(response).to be_successful
+      expect(assigns[:document_list].map(&:id)).not_to include generic_file.id
+      expect(assigns[:document_list].map(&:id)).to eq [collection1.id, collection2.id]
+    end
+  end
   describe '#new' do
     it 'should assign @collection' do
       get :new
@@ -49,7 +64,7 @@ describe CollectionsController, :type => :controller do
       }.to change { Collection.count }.by(1)
       expect(assigns[:collection].title).to eq("My First Collection ")
       expect(assigns[:collection].description).to eq("The Description\r\n\r\nand more")
-      expect(assigns[:collection].depositor).to eq(@user.user_key)
+      expect(assigns[:collection].depositor).to eq(user.user_key)
       expect(response).to redirect_to collections.collection_path(assigns[:collection])
     end
     it "should add docs to collection if batch ids provided" do
@@ -90,9 +105,7 @@ describe CollectionsController, :type => :controller do
   describe "#update" do
     before do
-      @collection = Collection.new
-      @collection.apply_depositor_metadata(@user.user_key)
-      @collection.save
+      @collection = Collection.create { |c| c.apply_depositor_metadata(user.user_key) }
       @asset1 = GenericFile.create!
       @asset2 = GenericFile.create!
       @asset3 = GenericFile.create!
@@ -116,7 +129,7 @@ describe CollectionsController, :type => :controller do
       it "should support adding batches of members" do
         @collection.members << @asset1
         @collection.save
-        put :update, id: @collection.id, collection: { members:"add" }, batch_document_ids: [@asset2, @asset3]
+        put :update, id: @collection, collection: { members:"add" }, batch_document_ids: [@asset2, @asset3]
         expect(response).to redirect_to collections.collection_path(@collection)
         expect(assigns[:collection].members).to match_array [@asset2, @asset3, @asset1]
       end
@@ -124,45 +137,26 @@ describe CollectionsController, :type => :controller do
       it "should support removing batches of members" do
         @collection.members = [@asset1, @asset2, @asset3]
         @collection.save
-        put :update, id: @collection.id, collection: { members: "remove" }, batch_document_ids: [@asset1, @asset3]
+        put :update, id: @collection, collection: { members: "remove" }, batch_document_ids: [@asset1, @asset3]
         expect(response).to redirect_to collections.collection_path(@collection)
         expect(assigns[:collection].members).to eq([@asset2])
       end
     end
     it "should support setting members array" do
-      put :update, id: @collection.id, collection: { members: "add" }, batch_document_ids: [@asset2, @asset3, @asset1]
+      put :update, id: @collection, collection: { members: "add" }, batch_document_ids: [@asset2, @asset3, @asset1]
       expect(response).to redirect_to collections.collection_path(@collection)
       expect(assigns[:collection].members).to match_array [@asset2, @asset3, @asset1]
     end
     it "should set/un-set collection on members" do
       # Add to collection (sets collection on members)
-      put :update, id: @collection.id, collection: { members: "add"}, batch_document_ids: [@asset2, @asset3]
+      put :update, id: @collection, collection: { members: "add" }, batch_document_ids: [@asset2, @asset3]
       expect(assigns[:collection].members).to match_array [@asset2, @asset3]
-      ## Check that member lists collection in its solr doc
-      @asset2.reload
-      expect(@asset2.to_solr[Solrizer.solr_name(:collection)]).to eq [@collection.id]
-      ## Check that member was re-indexed with collection info
-      asset_results = ActiveFedora::SolrService.instance.conn.get "select", params:{fq:["id:\"#{@asset2.id}\""],fl:['id',Solrizer.solr_name(:collection)]}
-      doc = asset_results["response"]["docs"].first
-      expect(doc["id"]).to eq(@asset2.id)
-      expect(doc[Solrizer.solr_name(:collection)]).to eq [@collection.id]
       # Remove from collection (un-sets collection on members)
       put :update, id: @collection, collection: { members:"remove" }, batch_document_ids: [@asset2]
       expect(assigns[:collection].members).to_not include(@asset2)
-      ## Check that member no longer lists collection in its solr doc
-      @asset2.reload
-      expect(@asset2.to_solr[Solrizer.solr_name(:collection)]).to eq([])
-      ## Check that member was re-indexed without collection info
-      asset_results = ActiveFedora::SolrService.instance.conn.get "select", params:{fq:["id:\"#{@asset2.id}\""],fl:['id',Solrizer.solr_name(:collection)]}
-      doc = asset_results["response"]["docs"].first
-      expect(doc["id"]).to eq(@asset2.id)
-      expect(doc[Solrizer.solr_name(:collection)]).to be_nil
     end
     context "when moving members between collections" do
@@ -171,14 +165,13 @@ describe CollectionsController, :type => :controller do
         @collection.save
       end
       let(:collection2) do
-        Collection.new.tap do |col|
-          col.apply_depositor_metadata(@user.user_key)
-          col.save
+        Collection.create do |col|
+          col.apply_depositor_metadata(user.user_key)
         end
       end
       it "moves the members" do
-        put :update, id: @collection, collection: {members: "move"},
+        put :update, id: @collection, collection: {members: "move"},
           destination_collection_id: collection2, batch_document_ids: [@asset2, @asset3]
         expect(@collection.reload.members).to eq [@asset1]
         expect(collection2.reload.members).to match_array [@asset2, @asset3]
@@ -189,20 +182,21 @@ describe CollectionsController, :type => :controller do
   describe "#destroy" do
     describe "valid collection" do
       before do
-        @collection = Collection.new
-        @collection.apply_depositor_metadata(@user.user_key)
-        @collection.save
+        @collection = Collection.create { |c| c.apply_depositor_metadata(user.user_key) }
         expect(controller).to receive(:authorize!).and_return(true)
       end
       it "should delete collection" do
-        delete :destroy, id: @collection.id
+        delete :destroy, id: @collection
         expect(response).to redirect_to Rails.application.routes.url_helpers.catalog_index_path
         expect(flash[:notice]).to eq("Collection was successfully deleted.")
       end
       it "should after_destroy" do
         expect(controller).to receive(:after_destroy).and_call_original
-        delete :destroy, id: @collection.id
+        delete :destroy, id: @collection
       end
       it "should call update members" do
         @asset1 = GenericFile.create!
         @collection.members << @asset1
@@ -210,20 +204,12 @@ describe CollectionsController, :type => :controller do
         @asset1 = @asset1.reload
         @asset1.update_index
         expect(@asset1.collections).to eq [@collection]
-        asset_results = ActiveFedora::SolrService.instance.conn.get "select", params:{fq:["id:\"#{@asset1.id}\""],fl:['id',Solrizer.solr_name(:collection)]}
-        expect(asset_results["response"]["numFound"]).to eq(1)
-        doc = asset_results["response"]["docs"].first
-        expect(doc[Solrizer.solr_name(:collection)]).to eq([@collection.id])
         delete :destroy, id: @collection
-        expect(@asset1.reload.collections).to eq([])
-        asset_results = ActiveFedora::SolrService.instance.conn.get "select", params:{fq:["id:\"#{@asset1.id}\""],fl:['id',Solrizer.solr_name(:collection)]}
-        expect(asset_results["response"]["numFound"]).to eq(1)
-        doc = asset_results["response"]["docs"].first
-        expect(doc[Solrizer.solr_name(:collection)]).to be_nil
-        @asset1.destroy
+        expect(@asset1.reload.collections).to eq []
       end
     end
     it "should not delete an invalid collection" do
        expect {delete :destroy, id: 'zz:-1'}.to raise_error
     end
@@ -236,7 +222,7 @@ describe CollectionsController, :type => :controller do
       @asset3 = GenericFile.create!(title: "Third of the Assets")
       @collection = Collection.new(id:"abc123")
       @collection.title = "My collection"
-      @collection.apply_depositor_metadata(@user.user_key)
+      @collection.apply_depositor_metadata(user.user_key)
       @collection.members = [@asset1, @asset2, @asset3]
       @collection.save!
       expect(controller).to receive(:authorize!).and_return(true)
@@ -248,7 +234,7 @@ describe CollectionsController, :type => :controller do
         @asset4 = GenericFile.create!(title: "#{@asset1.id}")
         @collection2 = Collection.new(id: "abc1234")
         @collection2.title = "Other collection"
-        @collection2.apply_depositor_metadata(@user.user_key)
+        @collection2.apply_depositor_metadata(user.user_key)
         @collection2.members = [@asset4]
         @collection2.save
       end

data/spec/controllers/other_collections_controller_spec.rb CHANGED

@@ -1,85 +1,53 @@
 require 'spec_helper'
-class OtherCollectionsController < ApplicationController
-  include Hydra::CollectionsControllerBehavior
-  def show
-    super
-    redirect_to root_path
-  end
-end
-class OtherCollection < ActiveFedora::Base
-  include Hydra::Collection
-  include Hydra::Collections::Collectible
-  def to_solr(solr_doc={})
-    super.tap do |solr_doc|
-      index_collection_ids(solr_doc)
+# make sure a collection by another name still assigns the @collection variable
+describe OtherCollectionsController, :type => :controller do
+  before(:all) do
+    class OtherCollection < ActiveFedora::Base
+      include Hydra::Collection
+      include Hydra::Collections::Collectible
     end
-  end
-end
-class Member < ActiveFedora::Base
-  include Hydra::Collections::Collectible
-  attr_accessor :title
-  def to_solr(solr_doc={})
-    super.tap do |solr_doc|
-      index_collection_ids(solr_doc)
+    class Member < ActiveFedora::Base
+      include Hydra::Collections::Collectible
+      attr_accessor :title
     end
   end
-end
-# make sure a collection by another name still assigns the @collection variable
-describe OtherCollectionsController, :type => :controller do
-  before(:all) do
-    @user = FactoryGirl.find_or_create(:user)
-  end
   after(:all) do
-    @user.destroy
-    Member.destroy_all
-    OtherCollection.destroy_all
     Object.send(:remove_const, :Member)
     Object.send(:remove_const, :OtherCollection)
-    Object.send(:remove_const, :OtherCollectionsController)
   end
+  let(:user) { FactoryGirl.find_or_create(:user) }
   before do
     allow(controller).to receive(:has_access?).and_return(true)
-    @user = FactoryGirl.find_or_create(:user)
-    sign_in @user
-    allow_any_instance_of(User).to receive(:groups).and_return([])
-    allow(controller).to receive(:clear_session_user) ## Don't clear out the authenticated session
+    sign_in user
+    # allow_any_instance_of(User).to receive(:groups).and_return([])
+    # allow(controller).to receive(:clear_session_user) ## Don't clear out the authenticated session
   end
   describe "#show" do
-    let(:asset1) {Member.create!(title: "First of the Assets")}
-    let(:asset2) {Member.create!(title: "Second of the Assets")}
-    let(:asset3) {Member.create!(title: "Third of the Assets")}
-    let(:collection) {OtherCollection.new}
+    let(:asset1) { Member.create!(title: "First of the Assets") }
+    let(:asset2) { Member.create!(title: "Second of the Assets") }
+    let(:asset3) { Member.create!(title: "Third of the Assets") }
+    let(:collection) do
+      OtherCollection.create(id: 'foo123', title: "My collection",
+                             members: [asset1, asset2, asset3]) do |collection|
+        collection.apply_depositor_metadata(user.user_key)
+      end
+    end
     before do
-      collection.title = "My collection"
-      collection.apply_depositor_metadata(@user.user_key)
-      collection.members = [asset1,asset2,asset3]
-      collection.save
       allow(controller).to receive(:apply_gated_search)
     end
-    after do
-      Rails.application.reload_routes!
-    end
     it "should show the collections" do
-      routes.draw { resources :other_collections, except: :index }
       get :show, id: collection
       expect(assigns[:collection].title).to eq collection.title
       ids = assigns[:member_docs].map(&:id)
       expect(ids).to include(asset1.id, asset2.id, asset3.id)
     end
   end
 end