hydra-batch-edit 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aa49936aaad686723f8044b5fe5db62f0c20313
-  data.tar.gz: c1507a0f65638c70ee9a422c41bf07a860465d23
+  metadata.gz: 17d99ad991e18d8fd90baa75468017f65496ece8
+  data.tar.gz: 14778625a5af06ca4abeb453207a59fb13aa5947
 SHA512:
-  metadata.gz: bfe58a72a8093bb93f69916241586d9acab16909b7297cae386ad55ad2a9305a925bf11391824b9d2099efde6ee9cdc83ca0285859dbc5c87d7b0d1d202d2ffe
-  data.tar.gz: f20aa72493270f7c1a3a0ce9944e73869d09f12f156f04208b73ff487edb4bdbc48735aa0e8cb8768d7c84b3c0264f69bdefd054a22bcc13cf926b9dd62024cb
+  metadata.gz: f041d1f2f3b7b86a656a728898fcbb15eebb31883200d709a31badc40b87ed53daab06b1f98af22612c8f9766e7b34a9cf3e990aa36cf51f1a692608ae3e065f
+  data.tar.gz: af4af94ac779069f2cba5d00d446a330d55e2ec37e34d71c8d4274f8f39b09b3d7cddf22acb5acd4748f31b630473ecf5f91dcf2bcf2c9dc8933a9b1a54feaa2

data/README.textile

@@ -21,7 +21,9 @@ The main thrust of the re-usable functionality this gem aims to provide:
 # 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.
+*Note* As of version 1.0.0 The batches are tracke using the batches behavior in hydra-collections.  They are not persisted between page changes and only exist on the current page.
+
+*Note* Version 0.3.1 and previous The batches are tracked as a list of pids _in the user session_.  They are not persisted.
 
 h2. Installing
 
@@ -51,6 +53,7 @@ In your Gemfile, add
 h2. Dependencies
 
 hydra-head
+hydra-collections
 bootstrap
 blacklight.js
 coffeescript & scss
@@ -107,7 +110,8 @@ Example app/views/batch_edit/edit.html.erb
     <%= f.label :access_policy, "Access Policy:"  %>
     <%= f.select :access_policy, ... %>
 
-    <%= f.submit "Save changes", :class=>'btn btn-primary'%>
+    <%# note the class submits-batches causes the batch ids to be returned with the updates %>
+    <%= f.submit "Save changes", :class=>'submits-batches btn btn-primary'%>
 
   <% end %>
 </pre>

data/app/helpers/batch_edit_helper.rb

@@ -24,7 +24,7 @@ module BatchEditHelper
   # 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}
+    return button_for_add_to_batch 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

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

@@ -1 +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' %>
+<%= button_to label, batch_edit, :confirm => confirm, :method=>:delete, :class=>"btn btn-primary btn-delete hidden submits-batches", 'data-behavior'=>'batch-edit', :id=>'batch-edit-delete' %>

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

@@ -1 +1 @@
-<%= button_to label, edit_batch_edits_path, :method=>:get, :class=>"btn btn-update 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 submits-batches", 'data-behavior'=>'batch-edit', :id=>'batch-edit' %>

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

@@ -20,7 +20,7 @@
   </div>
 
   <div class="form-actions">
-    <%= f.submit "Save changes", :class=>'btn btn-primary'%>
+    <%= f.submit "Save changes", :class=>'btn btn-primary updates-batches'%>
   </div>
 
 <% end %>

data/hydra-batch-edit.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Hydra::BatchEdit::VERSION
 
   gem.add_dependency 'blacklight'
+  gem.add_dependency 'hydra-collections'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rails'

data/lib/hydra/batch_edit/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module BatchEdit
-    VERSION = "0.3.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/hydra/batch_edit_behavior.rb

@@ -1,13 +1,16 @@
+require 'hydra/collections'
+
 module Hydra
   module BatchEditBehavior
     extend ActiveSupport::Concern
     
     included do
+      include Hydra::Collections::AcceptsBatches
+
       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)
@@ -18,45 +21,9 @@ module Hydra
       render :json => {"OK" => "OK"}
     end
 
-    # 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
-    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
-
+    
     #pulled out to allow a user to override the default redirect
     def after_update
       redirect_to catalog_index_path
@@ -75,7 +42,6 @@ module Hydra
         obj.save
       end
       flash[:notice] = "Batch update complete"
-      clear_batch!
       after_update 
     end
 
@@ -98,48 +64,13 @@ module Hydra
           obj.destroy
         end
         flash[:notice] = "Batch delete complete"
-        clear_batch! 
         after_destroy_collection    
     end 
-
-    def check_for_empty?
-      return batch.empty?
-    end
-
-    protected
-
-    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
-      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?
+    def check_for_empty!
+       if check_for_empty_batch?
+         redirect_to :back
+         return false
       end
     end
     

data/spec/controllers/batch_edits_controller_spec.rb

@@ -13,52 +13,6 @@ describe BatchEditsController do
   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()
-    @mock_document2 = mock()
-    @mock_document.stub(:export_formats => {})
-    controller.stub(:get_solr_response_for_field_values => [@mock_response, [@mock_document, @mock_document2]])
-
-    put :add, :id =>"77826928"
-    session[:batch_document_ids].length.should == 1
-    put :add, :id => "94120425"
-    session[:batch_document_ids].length.should == 2
-    session[:batch_document_ids].should include("77826928")
-    get :index
-    assigns[:documents].length.should == 2
-    assigns[:documents].first.should == @mock_document
-  end
-  it "should delete an item from list" do
-    put :add, :id =>"77826928"
-    put :add, :id => "94120425"
-    delete :destroy, :id =>"77826928"
-    session[:batch_document_ids].length.should == 1
-    session[:batch_document_ids].should_not include("77826928")
-  end
-  it "should clear list" do
-    put :add, :id =>"77826928"
-    put :add, :id => "94120425"
-    put :clear
-    session[:batch_document_ids].length.should == 0
-  end
-
-  it "should generate flash messages for normal requests" do
-    put :add, :id => "77826928"
-    flash[:notice].length.should_not == 0
-  end
-  it "should clear flash messages after xhr request" 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
@@ -68,8 +22,7 @@ describe BatchEditsController do
       @two.save
     end
     it "should draw the form" do
-      put :add, :id =>@one.pid
-      put :add, :id =>@two.pid
+      controller.batch = [@one.pid, @two.pid]
       controller.should_receive(:can?).with(:edit, @one.pid).and_return(true)
       controller.should_receive(:can?).with(:edit, @two.pid).and_return(true)
       get :edit
@@ -95,8 +48,7 @@ describe BatchEditsController do
       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.batch = [@one.pid, @two.pid]
       controller.should_receive(:can?).with(:edit, @one.pid).and_return(false)
       controller.should_receive(:can?).with(:edit, @two.pid).and_return(false)
       put :update, :multiresimage=>{:titleSet_display=>'My title' } 
@@ -107,8 +59,7 @@ describe BatchEditsController do
       before do
         @one.save
         @two.save
-        put :add, :id =>@one.pid
-        put :add, :id => @two.pid
+        controller.batch = [@one.pid, @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)
@@ -145,8 +96,7 @@ describe BatchEditsController do
       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.batch = [@one.pid, @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 
@@ -157,8 +107,7 @@ describe BatchEditsController do
       before do
         @one.save
         @two.save
-        put :add, :id =>@one.pid
-        put :add, :id => @two.pid
+        controller.batch = [@one.pid, @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)
@@ -197,12 +146,12 @@ describe BatchEditsController do
     it "should add every document in the current resultset to the batch" do
       put :all
       response.should redirect_to edit_batch_edits_path
-      session[:batch_document_ids].should == [123, 456]
+      controller.batch = [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]
+      controller.batch = [123, 456]
     end
   end
 

data/spec/support/Gemfile

@@ -7,7 +7,7 @@ gem 'rails'
 
 gem 'sqlite3'
 gem 'hydra-head'
-
+gem 'hydra-collections'
 
 # Gems used only for assets and not required
 # in production environments by default.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-batch-edit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hydra-collections
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +97,6 @@ files:
 - app/assets/stylesheets/batch_edit.css.scss
 - app/controllers/batch_edits_controller.rb
 - 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

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

@@ -1,28 +0,0 @@
-<div data-behavior="batch-add-button">
-  <% if can? :edit, document.id %>
-
-    <%-   
-      # pass in local :document with a SolrDocument
-      if item_in_batch?(document.id)
-        method = :delete
-        label = 'remove from batch'
-        cssClass = "deleteBatch"
-        action = "destroy"
-      else
-        method = :put
-        label = 'add to batch'
-        cssClass = "addBatch"
-        action = "add"
-      end
-    -%>
-
-    <%= 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 %>
-
-  <% else %>
-    <br><span class="label label-warning">You don't have edit access</label>
-  <% end %>
-</div>
-