hydra-batch-edit 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hydra-batch-edit.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+##########################################################################
+# Copyright 2012 Northwestern University Libraries and MediaShelf, LLC
+#
+# 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.

data/README.textile

@@ -0,0 +1,114 @@
+h1. hydra-batch-edit
+
+Batch Editing Functionality for Hydra Heads
+
+*This is Alpha Software!*  While working on a specific Hydra Head with specific content & use cases, we added batch editing functionality.  We wrote the code as a separate gem so that others can use this as a starting point, but _you will have to modify the code_ to get this to work.  If other Hydra partners start using the gem, it will become more immediately useful & configurable out of the box.  At that point, someone will delete this message.
+
+As far as we can tell, the code is sufficiently "test-coveraged" and html/javascript is "fall-backable".
+
+The initial code for this gem was written by "MediaShelf":http://yourmediashelf.com on behalf of Northwestern University.  It is used in the NWU Digital Image Library (DIL) Hydra Head.  As with all Hydra code, this software is distributed under the "Apache 2 License":http://www.apache.org/licenses/LICENSE-2.0.
+
+h2. Features
+
+The main thrust of the re-usable functionality this gem aims to provide:
+
+# Jackie User constructs a batch of objects from Blacklight/Hydra search results
+# When Jackie has selected everything for the batch, she clicks a button to proceed to the next step
+# (Might want to have a sanity check page here where Jackie sees all of the objects she has selected.  We skipped that step for now.)
+# Before displaying the next step, a before_filter in the controller makes sure Jackie has edit permissions for each of the objects, filtering out the non-editable content and notifying Jackie that they've been removed from her batch
+# Jackie sees a form for specifying what changes to apply to the batch
+# Jackie submits her changes and they are applied to each of the objects in the batch
+# Before applying the submitted updates, the before_filter in the controller checks (again) that Jackie has edit permissions for everything in the batch
+# The BatchUpdatesController#update method applies Jackie's changes to each of the objects in the batch
+
+*Note* The batches are tracked as a list of pids _in the user session_.  They are not persisted.
+
+h2. Installing
+
+In your Gemfile, add
+
+<pre>gem 'hydra-batch-edit'</pre> 
+
+# Call batch_edit_tools view helper in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+# Call batch_edit_continue in the search result page template.  We put it in catalog/index.html
+# Call batch_edit_select(document) [passing in the solr document] on the index partial that's rendered for each search result
+# Add routes to config/routes.rb 
+<pre>
+  Hydra::BatchEdit.add_routes(self)
+</pre>
+# Add javascript to app/assets/javascripts/application.js
+<pre>
+  //= require batch_edit
+</pre>
+# Add css to app/assets/stylesheets/application.css
+<pre>
+  *= require batch_edit
+</pre>
+  
+
+
+
+h2. Dependencies
+
+hydra-head
+bootstrap
+blacklight.js
+coffeescript & scss
+
+  
+h2. Customizing
+
+*This is Alpha Software* These instructions assume that you know how to work with rails and are familiar with Hydra
+
+h3. What you will need to do
+
+You will *definitely* need to override the edit form.
+You will probably need to override BatchEditController#update 
+You might need to override BatchEditController#edit
+
+h3. Extend Hydra::BatchEditController update and/or edit methods
+
+Example app/controllers/batch_updates_controller.rb
+
+<pre>
+  class BatchEditController < ApplicationController
+    include Hydra::BatchEditBehavior
+    def update
+      batch.each do |doc_id|
+        obj = ActiveFedora::Base.find(doc_id, :cast=>true)
+        type = obj.class.to_s.underscore.to_sym
+        obj.update_attributes(params[type])
+        obj.do_something_special
+        obj.save
+      end
+      flash[:notice] = "Batch update complete"
+      clear_batch!
+      redirect_to catalog_index_path
+    end
+  end
+</pre>
+
+h3. Override Edit View
+
+Example app/views/batch_edit/edit.html.erb
+
+<pre>
+  <%= form_for MyModel.new, :url=>batch_edit_path, :method=>:put do |f| %>
+
+    <%= f.label :title, "Title:"  %>
+    <%= f.text_field :title %>
+
+    <%= f.label :description, "Description:"  %>
+    <%= f.text_field :description %>
+
+    <%= f.label :license, "License:"  %>
+    <%= f.text_field :license %>
+    
+    <%= f.label :access_policy, "Access Policy:"  %>
+    <%= f.select :access_policy, ... %>
+
+    <%= f.submit "Save changes", :class=>'btn btn-primary'%>
+
+  <% end %>
+</pre>
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/controllers/batch_edits_controller.rb

@@ -0,0 +1,4 @@
+class BatchEditsController < ApplicationController
+  include Hydra::BatchEditBehavior
+end
+

data/app/helpers/batch_edit_helper.rb

@@ -0,0 +1,29 @@
+# View Helpers for Hydra Batch Edit functionality
+module BatchEditHelper 
+  
+  # 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
+
+  # Returns true if user has activated batch edit mode in session
+  def batch_edit_active?
+    session[:batch_edit_state] == 'on'
+  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_edit_tools
+    render :partial=>'/batch_edits/tools'
+  end
+  
+  # Displays the button that users click when they are done selecting items for a batch.  Put this in your search result page template.  We put it in catalog/index.html
+  def batch_edit_continue 
+    render :partial => '/batch_edits/next_page' 
+  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 batch_edit_select(document)
+    render :partial=>'/batch_edits/add_button', :locals=>{:document=>document}
+  end
+end

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

@@ -0,0 +1,17 @@
+<%-   
+  # pass in local :document with a SolrDocument
+  if item_in_batch?(document.id)
+    method = "delete"
+    label = 'remove from batch'
+    cssClass = "deleteBatch"
+  else
+    method = "put"
+    label = 'add to batch'
+    cssClass = "addBatch"
+  end
+-%>
+
+<%= form_tag(batch_edit_path(document), :method => method, :class=> "batch_toggle #{cssClass} hidden", "data-doc-id" => document.id, "data-behavior" => 'batch-add-button', :title=>h(document[document_show_link_field])) do -%>  
+  <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field]) %>
+  <%= submit_tag(label, :class=>"batch_submit", :id => "batch_submit_#{document.id}") %>
+<% end %>

data/app/views/batch_edits/_next_page.html.erb

@@ -0,0 +1 @@
+<%= button_to "Update Selected", edit_batch_edits_path, :method=>:get, :class=>"btn btn-primary hidden", 'data-behavior'=>'batch-edit', :id=>'batch-edit' %>

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

@@ -0,0 +1,10 @@
+  <div class="btn-group 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="off"><a href="#"><i class=""></i> Batch edit</a></li>
+    </ul>
+  </div>
+

data/app/views/batch_edits/edit.html.erb

@@ -0,0 +1,26 @@
+<%= form_for Multiresimage.new, :url=>batch_edits_path, :method=>:put do |f| %>
+
+  <div class="control-group">
+    <%= f.label :titleSet_display, "Title:"  %>
+    <div class="controls">
+      <%= f.text_field :titleSet_display %>
+    </div>
+  </div>
+  <div class="control-group">
+    <%= f.label :agentSet_display, "Agent:"  %>
+    <div class="controls">
+      <%= f.text_field :agentSet_display %>
+    </div>
+  </div>
+  <div class="control-group">
+    <%= f.label :dateSet_display, "Date:"  %>
+    <div class="controls">
+      <%= f.text_field :dateSet_display %>
+    </div>
+  </div>
+
+  <div class="form-actions">
+    <%= f.submit "Save changes", :class=>'btn btn-primary'%>
+  </div>
+
+<% end %>

data/app/views/batch_edits/index.html.erb

@@ -0,0 +1,2 @@
+Yo:w
+

data/config/routes.rb

@@ -0,0 +1,15 @@
+Hydra::BatchEdit::Engine.routes.draw do
+###NOTE this isn't used
+  
+  match 'batch_edits/:id' => 'batch_edits#add', :via=>:put
+  resources :batch_edits, :only=>[:index] do
+    member do
+      delete :destroy
+    end
+    collection do
+      get :edit
+      put :update
+      delete :clear
+    end
+  end
+end

data/hydra-batch-edit.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hydra/batch_edit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Coyne", "Matt Zumwalt"]
+  gem.email         = ["justin.coyne@yourmediashelf.com"]
+  gem.description   = %q{Rails engine to do batch editing with hydra-head}
+  gem.summary       = %q{Rails engine to do batch editing with hydra-head}
+  gem.homepage      = "https://github.com/projecthydra/hydra-batch-edit"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hydra-batch-edit"
+  gem.require_paths = ["lib"]
+  gem.version       = Hydra::BatchEdit::VERSION
+end

data/lib/hydra-batch-edit.rb

@@ -0,0 +1,14 @@
+require "hydra/batch_edit/version"
+require "hydra/batch_edit/routes"
+require "hydra/batch_edit_behavior"
+
+module Hydra
+  module BatchEdit
+    def self.add_routes(router, options = {})
+       Routes.new(router, options).draw
+    end
+    class Engine < ::Rails::Engine
+        # Make rails look at the vendored assets
+    end
+  end
+end

data/lib/hydra/batch_edit/routes.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+module Hydra
+  module BatchEdit
+    class Routes
+
+      def initialize(router, options)
+        @router = router
+        @options = options
+      end
+
+      def draw
+        add_routes do |options|
+          match 'batch_edits/:id' => 'batch_edits#add', :via=>:put
+          resources :batch_edits, :only=>[:index] do
+            member do
+              delete :destroy
+            end
+            collection do
+              get :edit
+              put :update
+              delete :clear
+            end
+          end
+        end
+      end
+
+      protected
+
+      def add_routes &blk
+        @router.instance_exec(@options, &blk)
+      end
+    end
+  end
+end
+

data/lib/hydra/batch_edit/version.rb

@@ -0,0 +1,5 @@
+module Hydra
+  module BatchEdit
+    VERSION = "0.0.1"
+  end
+end

data/lib/hydra/batch_edit_behavior.rb

@@ -0,0 +1,102 @@
+module Hydra::BatchEditBehavior
+  extend ActiveSupport::Concern
+  
+  included do
+    before_filter :filter_docs_with_access!, :only=>[:edit, :update]
+    before_filter :check_for_empty!, :only=>[:edit, :update]
+  end
+
+  
+  # fetch the documents that match the ids in the folder
+  def index
+    @response, @documents = get_solr_response_for_field_values("id", batch)
+  end
+
+  def state
+    session[:batch_edit_state] = params[:state]
+    render :json => {"OK" => "OK"}
+  end
+
+  # add a document_id to the batch. :id of action is solr doc id 
+  def add
+    batch << params[:id] 
+    respond_to do |format|
+      format.html do
+        redirect_to :back, :notice =>  "#{params[:title] || "Item"} successfully added to batch"
+      end
+      format.js { render :json => batch }
+    end
+  end
+ 
+  # remove a document_id from the batch. :id of action is solr_doc_id
+  def destroy
+    batch.delete(params[:id])
+    respond_to do |format|
+      format.html do
+        redirect_to :back, :notice => "#{params[:title] || "Item"} successfully removed from batch"
+      end
+      format.js do
+        render :json => {"OK" => "OK"}
+      end
+    end
+          
+  end
+ 
+  # get rid of the items in the batch
+  def clear
+    clear_batch!
+    respond_to do |format|
+      format.html { redirect_to :back, :notice=> "Batch has been cleared" }
+      format.js { render :json => batch }
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    batch.each do |doc_id|
+      obj = ActiveFedora::Base.find(doc_id, :cast=>true)
+      type = obj.class.to_s.underscore.to_sym
+      obj.update_attributes(params[type])
+      obj.save
+    end
+    flash[:notice] = "Batch update complete"
+    clear_batch!
+    redirect_to catalog_index_path
+    
+  end
+
+  protected
+
+  def batch
+    session[:batch_document_ids] ||= []
+  end
+
+  def clear_batch!
+    session[:batch_document_ids] = []
+  end
+
+  def check_for_empty!
+    if batch.empty?
+      redirect_to catalog_index_path
+      return false
+    end
+  end
+  
+  def filter_docs_with_access!
+    no_permissions = []
+    if batch.empty?
+      flash[:notice] = "Select something first"
+    else
+      batch.dup.each do |doc_id|
+        unless can?(:edit, doc_id)
+          session[:batch_document_ids].delete(doc_id)
+          no_permissions << doc_id
+        end
+      end
+      flash[:notice] = "You do not have permission to edit the documents: #{no_permissions.join(', ')}" unless no_permissions.empty?
+    end
+  end
+
+end

data/vendor/assets/javascripts/batch_edit.js.coffee

@@ -0,0 +1,23 @@
+$ ->
+  $("[data-behavior='batch-tools']").removeClass('hidden')     
+
+  $("[data-behavior='batch-add-button']").bl_checkbox_submit({
+          checked_label: "Selected",
+          unchecked_label: "Select",
+          css_class: "batch_toggle"
+      })
+
+  $("[data-behavior='batch-edit-activate']").click (e) ->
+    e.preventDefault()
+    if $(this).attr("data-state") == 'off'
+      $(this).attr("data-state", 'on')
+      $(this).find('a i').addClass('icon-ok')
+      $("[data-behavior='batch-edit']").removeClass('hidden')
+      $("[data-behavior='batch-add-button']").removeClass('hidden')
+    else
+      $(this).attr("data-state", 'off')
+      $(this).find('a i').removeClass('icon-ok')
+      $("[data-behavior='batch-edit']").addClass('hidden')
+      $("[data-behavior='batch-add-button']").addClass('hidden')
+    # TODO check-all
+

data/vendor/assets/stylesheets/batch_edit.css.scss

@@ -0,0 +1,4 @@
+#batch-edit {
+  clear: all;
+  display: block;
+}

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: hydra-batch-edit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Coyne
+- Matt Zumwalt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-15 00:00:00.000000000 Z
+dependencies: []
+description: Rails engine to do batch editing with hydra-head
+email:
+- justin.coyne@yourmediashelf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- app/controllers/batch_edits_controller.rb
+- app/helpers/batch_edit_helper.rb
+- app/views/batch_edits/_add_button.html.erb
+- app/views/batch_edits/_next_page.html.erb
+- app/views/batch_edits/_tools.html.erb
+- app/views/batch_edits/edit.html.erb
+- app/views/batch_edits/index.html.erb
+- config/routes.rb
+- hydra-batch-edit.gemspec
+- lib/hydra-batch-edit.rb
+- lib/hydra/batch_edit/routes.rb
+- lib/hydra/batch_edit/version.rb
+- lib/hydra/batch_edit_behavior.rb
+- vendor/assets/javascripts/batch_edit.js.coffee
+- vendor/assets/stylesheets/batch_edit.css.scss
+homepage: https://github.com/projecthydra/hydra-batch-edit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails engine to do batch editing with hydra-head
+test_files: []