No commit activity in last 3 years
No release in over 3 years
A rails engine for managing Hydra Collections
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

Runtime

 Project Readme

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.

Installation

Add this line to your application's Gemfile:

gem 'hydra-collections'

And then execute:

$ bundle

Finally run: $ rails generate hydra:collections:install

Or install it yourself as:

$ gem install hydra-collections

Usage

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.

collections.new_collections_path

Make your Models Collectible

Add include Hydra::Works::WorkBehavior to the models for anything that you want to be able to add to collections (ie. GenericFile, Book, Article, etc.).

Example:

class GenericFile < ActiveFedora::Base
  include Hydra::Works::WorkBehavior
end

Any items that include the Hydra::Works::WorkBehavior module can look up which collections they belong to via .in_collections.

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.

Example:

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

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

end

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:

Examples

Display a selection checkbox in each document partial

include <%= button_for_add_to_batch document %>

Example:

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

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

Example:

<%= 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

Example:

<%= 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' %>

Contributing

  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
    $ bundle exec rake ci

License

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

Acknowledgements

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