hydra-collections 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c5a786d66ac76371de611ba60c82a417cb7bf2e
+  data.tar.gz: d2aa7e948ff445d78cf8850a42cf3f1eb6c4f0bf
+SHA512:
+  metadata.gz: df8819b16d5c05fb2bba1c0d8ea75b7cdab1f4222a468c91c0ae72eafbe66ecd5ae06439d85b65241e5a5595d27bc3fb5ba11fe3966108b074724476ede2cf58
+  data.tar.gz: 0501175dc1e84dd91992945b8ae666355d2577e83bedcc692ba61211c5c738eefa6685ea3bdc87a6d27dff82785537c002247d7e98a6df77c70697608534edce

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.buildpath
+.project
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/internal

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "jetty"]
+	path = jetty
+	url = git://github.com/projecthydra/hydra-jetty.git
+ignore = dirty

data/.ruby-gemset

@@ -0,0 +1 @@
+hydra-collections

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - "2.0.0"
+notifications:
+  email:
+    recipients:
+      - "michael@psu.edu"
+      - "cam156@psu.edu"
+      - "dmc186@psu.edu"
+    on_success: "change"
+    on_failure: "always"
+  irc:
+    channels:
+      - "irc.freenode.org#scholarsphere"
+    template:
+      - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hydra-collections.gemspec
+gemspec
+
+group :development, :test do
+  gem 'sqlite3'
+  gem "factory_girl_rails", "~> 4.1.0"
+  gem 'devise'
+  gem 'capybara', '~>1.1.3'
+  gem 'jettywrapper'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Carolyn Cole
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Hydra::Collections [![Version](https://badge.fury.io/rb/hydra-collections.png)](http://badge.fury.io/rb/hydra-collections) [![Build Status](https://travis-ci.org/psu-stewardship/hydra-collections.png?branch=master)](https://travis-ci.org/psu-stewardship/hydra-collections) [![Dependency Status](https://gemnasium.com/psu-stewardship/hydra-collections.png)](https://gemnasium.com/psu-stewardship/hydra-collections)
+
+Add collections to your Hydra application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hydra-collections'
+
+And then execute:
+
+    $ bundle
+
+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.
+  We recommend putting it in catalog/_sort_and_per_page.html.erb which you will manually override in you app.
+
+    <%= button_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::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_pids` to the solrization logic (ie. put it in to_solr)
+
+Example:
+```ruby
+class GenericFile < ActiveFedora::Base
+  include Hydra::Collections::Collectible
+  ...
+  def to_solr(solr_doc={}, opts={})
+    super(solr_doc, opts)
+    index_collection_pids(solr_doc)
+    return solr_doc
+  end
+end
+```
+
+Any items that include the `Hydra::Collections::Collectible` module can look up which collections they belong to via `.collections`.  The `index_collection_pids` puts the pids of all associated collections into the `collection` facet.
+
+### 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:
+```ruby
+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
+
+include `//= require hydra/batch_select` in your application.js
+
+### Display a selection checkbox in each document partial
+
+include `<%= button_for_add_to_batch document %>'
+
+Example: views/catalog/_document_header.html.erb
+```ruby
+    <% # 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
+
+include 
+Add `submits-batches` class to your view input to initialize batch processing
+
+Example: 
+```ruby
+<%= button_to label, edit_batch_edits_path, :method=>:get, :class=>"btn submits-batches", 'data-behavior'=>'batch-edit', :id=>'batch-edit' %>
+```
+
+### Update you action view to submit changes to the batch
+
+Add `updates-batches` class to your 
+
+
+## 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
+    $ git submodule init
+    $ git submodule update
+    $ rake jetty:config
+    $ rake jetty:start
+    $ rake clean 
+    $ rake spec
+```
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+ENV["RAILS_ROOT"] ||= 'spec/internal'
+
+desc 'Run CI tests in e.g. Travis environment'
+task :travis => ['clean', 'ci']
+
+desc 'Default: run CI'
+task :default => [:travis]

data/app/assets/javascripts/hydra/batch_select.js

@@ -0,0 +1,41 @@
+$(function () {
+
+  // add the batch ids to any submit of a batch update
+  var batch_ids = null;
+  $('input.updates-batches').on('click', function() {  
+    var form = $(this).closest("form"); 
+    var hash, id;
+
+    // pull the ids from the url
+    if (!batch_ids) {
+      batch_ids = [];
+      // pull the ids from the url
+      var q = document.URL.split('?')[1];
+      if(q != undefined){
+          q = q.split('&');
+          for(var i = 0; i < q.length; i++){
+              hash = q[i].split('=');
+              if (hash[0] == "batch_document_ids%5B%5D")
+                 batch_ids.push(unescape(hash[1]));
+          }
+       }
+    }
+
+    // push the ids in the form
+    for(var j = 0; j < batch_ids.length; j++){
+      if (form.children("input[value='"+batch_ids[j]+"']").length == 0)
+        form.append('<input type="hidden" multiple="multiple" name="batch_document_ids[]" value="'+batch_ids[j]+'" />');
+    }
+      
+  });
+  $('input.submits-batches').on('click', function() {  
+      var form = $(this).closest("form"); 
+      $.map( $(".batch_document_selector:checked"), function(document, i) {
+         var id = document.id.substring("batch_document_".length);
+        form.append('<input type="hidden" multiple="multiple" name="batch_document_ids[]" value="'+id+'" />');
+      });
+  
+      
+  });
+
+});

data/app/assets/javascripts/hydra_collections.js

@@ -0,0 +1,12 @@
+$(function () {
+
+  // change the action based which collection is selected
+  $('input.submits-batches').on('click', function() {  
+ 
+      var form = $(this).closest("form"); 
+      var collection_id = $(".collection-selector:checked")[0].value;      
+      form[0].action = form[0].action.replace("collection_replace_id",collection_id);
+      
+  });
+
+});

data/app/controllers/collections_controller.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class CollectionsController < ApplicationController
+  include Hydra::CollectionsControllerBehavior
+end

data/app/helpers/batch_select_helper.rb

@@ -0,0 +1,25 @@
+# View Helpers for Hydra Batch Edit functionality
+module BatchSelectHelper 
+  
+  # determines if the given document id is in the batch
+  # def item_in_batch?(doc_id)
+  #   session[:batch_document_ids] && session[:batch_document_ids].include?(doc_id) ? true : false
+  # end
+
+  # Displays the batch edit tools.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+  def batch_select_tools
+    render :partial=>'/batch_select/tools'
+  end
+
+  # Displays the button to select/deselect items for your batch.  Call this in the index partial that's rendered for each search result.
+  # @param [Hash] document the Hash (aka Solr hit) for one Solr document
+  def button_for_add_to_batch(document)
+    render :partial=>'/batch_select/add_button', :locals=>{:document=>document}
+  end
+
+  # Displays the check all button to select/deselect items for your batch.  Put this in your search result page template.  We put it in catalog/index.html
+  def batch_check_all(label = 'Use all results')
+    render :partial=>'/batch_select/check_all', :locals=>{:label=>label}
+  end
+
+end

data/app/helpers/collections_helper.rb

@@ -0,0 +1,14 @@
+# View Helpers for Hydra Batch Edit functionality
+module CollectionsHelper 
+  
+ 
+  # Displays the Collections create collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+  def button_for_create_collection(label = 'Create Collection')
+    render :partial=>'/collections/button_create_collection', :locals=>{:label=>label}
+  end
+  
+  def button_for_add_batch_to_collection(label = 'Add Selected to a Collection')
+    render :partial=>'/collections/button_add_batch_to_collection', :locals=>{:label=>label}
+  end
+  
+end

data/app/models/collection.rb

@@ -0,0 +1,16 @@
+# Copyright © 2013 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+class Collection < ActiveFedora::Base
+  include Hydra::Collection
+end

data/app/views/batch_select/_add_button.html.erb

@@ -0,0 +1,3 @@
+<div data-behavior="batch-add-button">
+  <%= check_box_tag "batch_document_ids[]", document.id, false, class:"batch_document_selector", id: "batch_document_#{document.id}" %>
+</div>

data/app/views/batch_select/_check_all.html.erb

@@ -0,0 +1,4 @@
+<%= form_tag(all_batch_edits_path, :method => :put, :class=> "batch-select-all hidden", "data-behavior" => 'batch-select-all') do -%>  
+  <%= submit_tag(label, :class=>'batch-all-button btn') %>
+<% end %>
+

data/app/views/batch_select/_tools.html.erb

@@ -0,0 +1,10 @@
+  <div class="btn-group batch-tools hidden" data-behavior="batch-tools">
+    <button class="btn"><i class="icon-cog"></i> Tools</button>
+    <button class="btn dropdown-toggle" data-toggle="dropdown">
+      <span class="caret"></span>
+    </button>
+    <ul class="dropdown-menu">
+      <li data-behavior="batch-edit-activate" data-state="<%= batch_edit_state %>"><a href="#"><i class=""></i> Batch edit</a></li>
+    </ul>
+  </div>
+

data/app/views/collections/_button_create_collection.html.erb

@@ -0,0 +1,2 @@
+<%= button_to label, collections.new_collection_path, :method=>:get, :class=>"btn btn-primary collection-add", 'data-behavior'=>'hydra-collections', :id=>'hydra-collection-add' %>
+

data/app/views/collections/_form.html.erb

@@ -0,0 +1,36 @@
+<div class="container">
+<%-# This syntax [collections, @collection] tells form_for to use the routes from the engine named collections %>
+<%= form_for([collections, @collection]) do |f| %>
+  <% if @collection.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@collection.errors.count, "error") %> prohibited this topic from being saved:</h2>
+
+      <ul>
+      <% @collection.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  
+  <div class="field">
+    <%= f.label :description %><br />
+    <%= f.text_area :description %>
+  </div>
+  
+  <%- unless params[:batch_document_ids].nil? || params[:batch_document_ids].empty? %>
+    <%- params[:batch_document_ids].each do |batch_item| %>
+      <input type="hidden" name="batch_document_ids[]" value="<%= batch_item %>"/>
+    <%- end %>
+  <%- end %>
+  
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>
+</div>