hydra-batch-edit 0.0.6 → 0.0.7

data/Rakefile

@@ -13,7 +13,7 @@ RSpec::Core::RakeTask.new(:spec => :generate) do |t|
 end
 
 
-describe "Create the test rails app"
+desc "Create the test rails app"
 task :generate do
   unless File.exists?('spec/internal/Rakefile')
     puts "Generating rails app"
@@ -36,7 +36,7 @@ task :generate do
   puts "Running specs"
 end
 
-describe "Clean out the test rails app"
+desc "Clean out the test rails app"
 task :clean do
   puts "Removing sample rails app"
   `rm -rf spec/internal`

data/app/helpers/batch_edit_helper.rb

@@ -17,8 +17,8 @@ module BatchEditHelper
   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' 
+  def batch_edit_continue(label = 'Update Selected') 
+    render :partial => '/batch_edits/next_page', :locals=>{:label=>label} 
   end
 
   # Displays the button to select/deselect items for your batch.  Call this in the index partial that's rendered for each search result.
@@ -28,7 +28,12 @@ module BatchEditHelper
   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
-    render :partial=>'/batch_edits/check_all'
+  def batch_check_all(label = 'Use all results')
+    render :partial=>'/batch_edits/check_all', :locals=>{:label=>label}
+  end
+
+  # Displays the button that users click when they are done selecting items for a batch to Remove those items from the repository.  Put this in your search result page template.  We put it in catalog/index.html
+  def batch_edit_delete_batch(label = 'Delete Selected', confirm = 'Are you sure?') 
+    render :partial => '/batch_edits/delete_batch', :locals=>{:label=>label, :confirm=>confirm} 
   end
 end

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

@@ -4,17 +4,19 @@
     <%-   
       # pass in local :document with a SolrDocument
       if item_in_batch?(document.id)
-        method = "delete"
+        method = :delete
         label = 'remove from batch'
         cssClass = "deleteBatch"
+        action = "destroy"
       else
-        method = "put"
+        method = :put
         label = 'add to batch'
         cssClass = "addBatch"
+        action = "add"
       end
     -%>
 
-    <%= form_tag(batch_edit_path(document), :method => method, :class=> "batch_toggle #{cssClass}", "data-doc-id" => document.id, "data-behavior" => 'batch-add-form', :title=>h(document[document_show_link_field])) do -%>  
+    <%= form_tag({:controller => "batch_edits", :action => action, :id => document.id}, :method => method, :class=> "batch_toggle #{cssClass}", "data-doc-id" => document.id, "data-behavior" => 'batch-add-form', :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/_check_all.html.erb

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

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

@@ -0,0 +1 @@
+<%= button_to label, batch_edit, :confirm => confirm, :method=>:delete, :class=>"btn btn-primary btn-delete hidden", 'data-behavior'=>'batch-edit', :id=>'batch-edit-delete' %>

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

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

data/lib/hydra/batch_edit/routes.rb

@@ -15,6 +15,7 @@ module Hydra
               delete :destroy
             end
             collection do
+              match 'destroy' => 'batch_edits#destroy_collection', :via=>:delete
               get :edit
               put :update
               delete :clear

data/lib/hydra/batch_edit/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module BatchEdit
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/hydra/batch_edit_behavior.rb

@@ -1,112 +1,147 @@
-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
+module Hydra
+  module BatchEditBehavior
+    extend ActiveSupport::Concern
+    
+    included do
+      before_filter :filter_docs_with_access!, :only=>[:edit, :update, :destroy_collection]
+      before_filter :check_for_empty!, :only=>[:edit, :update, :destroy_collection]
+    end
 
-  
-  # fetch the documents that match the ids in the folder
-  def index
-    @response, @documents = get_solr_response_for_field_values("id", batch)
-  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
+    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"
+    # add a document_id to the batch. :id of action is solr doc id 
+    def add
+      id = params[:id]
+      raise "Too many items in batch!" if ((batch.to_s.length+id.to_s.length) > 2200) # we are going to overflow our cookie
+      batch << id if ! batch.include? 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
-      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"
+   
+    # 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
-      format.js do
-        render :json => {"OK" => "OK"}
+            
+    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
-          
-  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 }
+
+    def edit
     end
-  end
 
-  def edit
-  end
+    #pulled out to allow a user to override the default redirect
+    def after_update
+      redirect_to catalog_index_path
+    end
+
+    #called before the save of the document on update to do addition processes on the document beyond update_attributes
+    def update_document(obj)
+        type = obj.class.to_s.underscore.to_sym
+        obj.update_attributes(params[type].reject{|k, v| v.blank?})
+    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].reject{|k, v| v.blank?})
-      obj.save
+    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"
+      clear_batch!
+      after_update 
+    end
+
+    def all 
+      self.batch = Hydra::BatchEdit::SearchService.new(session, current_user.user_key).last_search_documents.map(&:id)
+      respond_to do |format|
+        format.html { redirect_to edit_batch_edits_path }
+        format.js { render :json => batch }
+      end
     end
-    flash[:notice] = "Batch update complete"
-    clear_batch!
-    redirect_to catalog_index_path
     
-  end
+    #pulled out to allow a user to override the default redirect
+    def after_destroy_collection
+      redirect_to catalog_index_path
+    end    
 
-  def all 
-    self.batch = Hydra::BatchEdit::SearchService.new(session, current_user.user_key).last_search_documents.map(&:id)
-    redirect_to edit_batch_edits_path
-  end
+    def destroy_collection
+        batch.each do |doc_id|
+          obj = ActiveFedora::Base.find(doc_id, :cast=>true)
+          obj.destroy
+        end
+        flash[:notice] = "Batch delete complete"
+        clear_batch! 
+        after_destroy_collection    
+    end 
 
-  protected
+    def check_for_empty?
+      return batch.empty?
+    end
 
-  def batch
-    session[:batch_document_ids] ||= []
-  end
+    protected
 
-  def batch=(val)
-    session[:batch_document_ids] = val
-  end
+    def batch
+      session[:batch_document_ids] ||= []
+    end
 
+    def batch=(val)
+      session[:batch_document_ids] = val
+    end
 
-  def clear_batch!
-    self.batch = []
-  end
 
-  def check_for_empty!
-    if batch.empty?
-      redirect_to :back
-      return false
+    def clear_batch!
+      self.batch = []
     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
+
+    def check_for_empty!
+      if batch.empty?
+        redirect_to :back
+        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
-      flash[:notice] = "You do not have permission to edit the documents: #{no_permissions.join(', ')}" unless no_permissions.empty?
     end
+    
   end
-
 end

data/spec/controllers/batch_edits_controller_spec.rb

@@ -9,7 +9,15 @@ describe BatchEditsController do
   before(:each) do
     request.env["HTTP_REFERER"] = "/"
   end
-  
+  it "should respond to after_update" do
+    controller.respond_to? "after_update"
+  end
+  it "should respond to update_document" do
+    controller.respond_to? "update_document"
+  end
+  it "should respond to after_delete" do
+    controller.respond_to? "after_delete"
+  end
   it "should add items to list" do
     @mock_response = mock()
     @mock_document = mock()
@@ -48,6 +56,14 @@ describe BatchEditsController do
     xhr :put, :add, :id => "77826928"
     flash[:notice].should == nil
   end
+  
+  it "should check for empty" do
+    put :add, :id =>"77826928"
+    put :add, :id => "94120425"
+    controller.check_for_empty?.should == false
+    put :clear
+    controller.check_for_empty?.should == true
+  end
 
   describe "edit" do
     before do
@@ -119,6 +135,49 @@ describe BatchEditsController do
     end
   end
 
+  describe "delete_collection" do
+    before :all do
+      @one = Sample.create
+      @two = Sample.create
+    end
+    before do
+      controller.stub(:catalog_index_path).and_return('/catalog')
+      request.env["HTTP_REFERER"] = "where_i_came_from"      
+    end
+    it "should complain when none are in the batch " do
+      delete :destroy_collection 
+      response.should redirect_to 'where_i_came_from'
+      flash[:notice].should == "Select something first"
+    end
+    it "should not update when the user doesn't have permissions" do
+      put :add, :id =>@one.pid
+      put :add, :id => @two.pid
+      controller.should_receive(:can?).with(:edit, @one.pid).and_return(false)
+      controller.should_receive(:can?).with(:edit, @two.pid).and_return(false)
+      delete :destroy_collection 
+      response.should redirect_to 'where_i_came_from'
+      flash[:notice].should == "You do not have permission to edit the documents: #{@one.pid}, #{@two.pid}"
+    end
+    describe "when current user has access to the documents" do
+      before do
+        @one.save
+        @two.save
+        put :add, :id =>@one.pid
+        put :add, :id => @two.pid
+        controller.should_receive(:can?).with(:edit, @one.pid).and_return(true)
+        controller.should_receive(:can?).with(:edit, @two.pid).and_return(true)
+        ActiveFedora::Base.should_receive(:find).with( @one.pid, :cast=>true).and_return(@one)
+        ActiveFedora::Base.should_receive(:find).with( @two.pid, :cast=>true).and_return(@two)
+      end
+      it "should update all the field" do
+        delete :destroy_collection 
+        response.should redirect_to '/catalog'
+        flash[:notice].should == "Batch delete complete"
+        Sample.find(@one.pid).should be_nil
+        Sample.find(@two.pid).should be_nil
+      end
+    end
+  end
 
   describe "state" do
     it "should save state on" do
@@ -145,6 +204,11 @@ describe BatchEditsController do
       response.should redirect_to edit_batch_edits_path
       session[:batch_document_ids].should == [123, 456]
     end
+    it "ajax should add every document in the current resultset to the batch but not redirect" do
+      xhr :put, :all
+      response.should_not redirect_to edit_batch_edits_path
+      session[:batch_document_ids].should == [123, 456]
+    end
   end
 
   describe "clear" do

data/spec/routing/batch_edit_routes_spec.rb

@@ -10,6 +10,9 @@ describe "Routes for batch_update" do
   it "should route update" do 
     { :put => batch_edits_path }.should route_to( :controller => "batch_edits", :action => "update")
   end
+  it "should route delete batch" do 
+    { :delete => batch_edits_path }.should route_to( :controller => "batch_edits", :action => "destroy_collection")
+  end
   it "should route add" do 
     { :put => '/batch_edits/7'}.should route_to( :controller => "batch_edits", :action => "add", :id=>'7')
   end

data/spec/support/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.6'
+gem 'rails'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
@@ -15,7 +15,7 @@ group :assets do
   gem 'coffee-rails', '~> 3.2.1'
 
   # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  # gem 'therubyracer', :platforms => :ruby
+  gem 'therubyracer', :platforms => :ruby
 
   gem 'uglifier', '>= 1.0.3'
 end

data/spec/support/app/models/sample.rb

@@ -30,4 +30,8 @@ class Sample
   def pid
     @pid
   end
+  
+  def destroy
+    self.class.objects.delete(@pid)
+  end
 end

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

@@ -1,11 +1,15 @@
 $ ->
   $("[data-behavior='batch-tools']").removeClass('hidden')     
 
-  $("[data-behavior='batch-add-form']").bl_checkbox_submit({
+  window.batch_edits_options = {}  if typeof window.batch_edits_options is "undefined"
+  default_options = 
           checked_label: "Selected",
           unchecked_label: "Select",
-          css_class: "batch_toggle"
-      })
+          css_class: "batch_toggle"      
+
+  options = $.extend({}, default_options, window.batch_edits_options)
+      
+  $("[data-behavior='batch-add-form']").bl_checkbox_submit(options)
 
   setState = (obj) ->
     activate = ->
@@ -45,3 +49,80 @@ $ ->
     });
     # TODO check-all
 
+  # ajax manager to queue ajax calls so all adds or removes are done in sequence
+  queue = ->
+    requests = []
+    addReq: (opt) ->
+      requests.push opt
+  
+    removeReq: (opt) ->
+      requests.splice $.inArray(opt, requests), 1  if $.inArray(opt, requests) > -1
+  
+    run: ->
+      self = this
+      orgSuc = undefined
+      if requests.length
+        oriSuc = requests[0].complete
+        requests[0].complete = ->
+          oriSuc()  if typeof oriSuc is "function"
+          requests.shift()
+          self.run.apply self, []
+  
+        $.ajax requests[0]
+      else
+        self.tid = setTimeout(->
+          self.run.apply self, []
+        , 1000)
+  
+    stop: ->
+      requests = []
+      clearTimeout @tid
+  
+  ajaxManager = (queue())
+  
+  ajaxManager.run()
+
+  #override the default blacklight checkbox behavior to queue ajax calls
+  $("input[type='checkbox'].batch_toggle").click ->
+    checked = not this["checked"]
+    checkbox = $(this)
+    form = $(checkbox.parent()[0])
+    label = $(checkbox.parent().children("label")[0])
+    label.text(options.progress_label).attr "disabled", "disabled"
+    checkbox.attr "disabled", "disabled"
+    ajaxManager.addReq
+      queue: "add_doc"
+      url: form.attr("action")
+      dataType: "json"
+      type: form.attr("method").toUpperCase()
+      data: form.serialize()
+      error: ->
+        alert "Error  Too Many results Selected"
+        update_state_for checked, checkbox, label, form
+        label.removeAttr "disabled"
+        checkbox.removeAttr "disabled"
+  
+      success: (data, status, xhr) ->
+        unless xhr.status is 0
+          checked = not checked
+          update_state_for checked, checkbox, label, form
+          label.removeAttr "disabled"
+          checkbox.removeAttr "disabled"
+        else
+          alert "Error Too Many results Selected"
+          update_state_for checked, checkbox, label, form
+          label.removeAttr "disabled"
+          checkbox.removeAttr "disabled"
+  
+    false
+  
+  # complete the override by overriding update_state_for  
+  update_state_for = (state, checkbox, label, form) ->
+    checkbox.attr "checked", state
+    label.toggleClass "checked", state
+    if state
+      form.find("input[name=_method]").val "delete"
+      label.text options.progress_label
+    else
+      form.find("input[name=_method]").val "put"
+      label.text options.progress_label

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-batch-edit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -92,6 +92,7 @@ files:
 - app/helpers/batch_edit_helper.rb
 - app/views/batch_edits/_add_button.html.erb
 - app/views/batch_edits/_check_all.html.erb
+- app/views/batch_edits/_delete_batch.html.erb
 - app/views/batch_edits/_next_page.html.erb
 - app/views/batch_edits/_tools.html.erb
 - app/views/batch_edits/edit.html.erb