Fetching contributors…
Cannot retrieve contributors at this time
179 lines (126 sloc) 5.65 KB

Hydra::Collections Version Build Status Dependency Status

Add collections to your Hydra application. These collections are typically created by depositors (instead of librarians or curators). Any collectible item can belong to many different collections. The collection does not confer access rights onto any of the members of the collections.


Add this line to your application's Gemfile:

gem 'hydra-collections'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hydra-collections


Mount the engine to get the routes in config/routes.rb

mount Hydra::Collections::Engine => '/'

Call button_create_collection view helper in your search result page template.

First add helper :collections to your catalog_controller.rb

Next, we recommend putting the view helper in catalog/_sort_and_per_page.html.erb which you will manually override in you app.

<%= button_for_create_collection %>

Any time you want to refer to the routes from hydra-collections use collections.


Make your Models Collectible

Add include Hydra::Collections::Collectible to the models for anything that you want to be able to add to collections (ie. GenericFile, Book, Article, etc.), then add index_collection_ids to the solrization logic (ie. put it in to_solr)


class GenericFile < ActiveFedora::Base
  include Hydra::Collections::Collectible
  def to_solr(solr_doc={}, opts={})
    super(solr_doc, opts)
    return solr_doc

Any items that include the Hydra::Collections::Collectible module can look up which collections they belong to via .collections. The index_collection_ids puts the ids of all associated collections into the collection facet.

Make the Collection show as a facet in your CatalogController

class CatalogController < ApplicationController
    include Blacklight::Catalog
    configure_blacklight do |config|
        config.add_facet_field solr_name("collection", :facetable), label: "Collection", helper_method: :collection_name

Make your Controller Accept a Batch

Add include Hydra::Collections::AcceptsBatches to the collections you would like to process batches of models

You can access the batch in your update.


class BatchEditsController < ApplicationController
    include Hydra::Collections::AcceptsBatches

    def update
      batch.each do |doc_id|
        obj = ActiveFedora::Base.find(doc_id, :cast=>true)
      flash[:notice] = "Batch update complete"


Include the javascript to discover checked batch items

add to your application.js

  //= require hydra/batch_select
  //= require hydra_collections

Display Hydra-collections in you views

Take a look at the helpers located in:


Display a selection checkbox in each document partial

include <%= button_for_add_to_batch document %>


    <% # views/catalog/_document_header.html.erb -%>
    <% # header bar for doc items in index view -%>
    <div class="documentHeader clearfix">
      <%= button_for_add_to_batch(document) %>
Update your view to submit a Batch

Add submits-batches class to your view input to initialize batch processing


<%= button_to label, edit_batch_edits_path, method: :get, class: "btn submits-batches", 
      'data-behavior'=>'batch-edit', id: 'batch-edit' %>
Update your action view to submit changes to the batch

Add updates-batches class to your button for submitting the batch


<%= button_to label, collections.collection_path(collection_id), method: :put,
      class: "btn btn-primary updates-collection submits-batches collection-update", 
      'data-behavior'=>'hydra-collections', id: 'hydra-collection-update' %>


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Setup instructions for Contributors

In order to make modifications to the gem code and run the tests, clone the repository then

    $ bundle install
    $ rake jetty:unzip
    $ rake jetty:config
    $ rake jetty:start
    $ rake engine_cart:clean
    $ rake engine_cart:generate
    $ rake spec


The hydra-collections source code is freely available under the Apache 2.0 license. Read the copyright statement and license.


This software has been developed by and is brought to you by the Hydra community. Learn more at the Project Hydra website

Project Hydra Logo