hydra-batch-edit 0.0.4 → 0.0.5

data/Rakefile

@@ -2,7 +2,7 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-ENV["RAILS_ROOT"] = 'spec/internal'
+ENV["RAILS_ROOT"] ||= 'spec/internal'
 
 desc 'Default: run specs.'
 task :default => :spec
@@ -28,6 +28,9 @@ task :generate do
     `bundle install`
     puts "running generator"
     puts `rails generate test_app`
+
+    puts "running migrations"
+    puts `rake db:migrate db:test:prepare`
     FileUtils.cd('../..')
   end
   puts "Running specs"

data/app/helpers/batch_edit_helper.rb

@@ -26,4 +26,9 @@ module BatchEditHelper
   def batch_edit_select(document)
     render :partial=>'/batch_edits/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
+    render :partial=>'/batch_edits/check_all'
+  end
 end

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

@@ -1,17 +1,26 @@
-<%-   
-  # 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
--%>
+<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"
+      else
+        method = "put"
+        label = 'add to batch'
+        cssClass = "addBatch"
+      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 -%>  
+      <%= 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>
 
-<%= 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/_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("Use all results", :class=>'batch-all-button btn') %>
+<% end %>
+

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

@@ -1,4 +1,4 @@
-  <div class="btn-group hidden" data-behavior="batch-tools">
+  <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>

data/hydra-batch-edit.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Hydra::BatchEdit::VERSION
 
+  gem.add_dependency 'blacklight'
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rails'
   gem.add_development_dependency 'rspec-rails'

data/lib/hydra-batch-edit.rb

@@ -1,14 +1,4 @@
-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
+require "hydra/batch_edit"
+require "bundler/setup"
+require "blacklight"

data/lib/hydra/batch_edit.rb

@@ -0,0 +1,14 @@
+module Hydra
+  module BatchEdit
+    extend ActiveSupport::Autoload
+    autoload :SearchService
+    autoload :Routes
+    autoload :Version
+    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

@@ -19,6 +19,7 @@ module Hydra
               put :update
               delete :clear
               put :state
+              put :all
             end
           end
           match 'batch_edits/:id' => 'batch_edits#add', :via=>:put

data/lib/hydra/batch_edit/search_service.rb

@@ -0,0 +1,50 @@
+module Hydra
+  module BatchEdit
+    class SearchService
+      include Blacklight::Configurable
+      include Blacklight::SolrHelper
+
+
+      def initialize(session, user_key)
+        @session = session
+        @user_key = user_key
+        self.class.copy_blacklight_config_from(::CatalogController)
+      end
+
+      solr_search_params_logic << :apply_gated_search
+
+      def last_search_documents 
+        return [] if @session[:history].blank?
+        last_search_id = @session[:history].first
+        search = Search.find(last_search_id) 
+        result, document_list = get_search_results(search.query_params, :fl=>'id', :rows=>1000)
+        document_list
+      end
+
+      # filter that sets up access-controlled lucene query in order to provide gated search behavior
+      # @param solr_parameters the current solr parameters
+      # @param user_parameters the current user-subitted parameters
+      def apply_gated_search(solr_parameters, user_parameters)
+        solr_parameters[:fq] ||= []
+        # Grant access to public content
+        user_access_filters = []
+        
+        user_access_filters << "edit_access_group_t:public"
+        
+        # Grant access based on user id & role
+        unless @user_key.nil?
+          # for roles
+          ::RoleMapper.roles(@user_key).each_with_index do |role, i|
+            user_access_filters << "edit_access_group_t:#{role}"
+          end
+          # for individual person access
+          user_access_filters << "edit_access_person_t:#{@user_key}"        
+        end
+        solr_parameters[:fq] << user_access_filters.join(" OR ")
+        logger.debug("Solr parameters: #{ solr_parameters.inspect }")
+    end
+
+    end
+  end
+end
+

data/lib/hydra/batch_edit/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module BatchEdit
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/hydra/batch_edit_behavior.rb

@@ -67,19 +67,29 @@ module Hydra::BatchEditBehavior
     
   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
+
   protected
 
   def batch
     session[:batch_document_ids] ||= []
   end
 
+  def batch=(val)
+    session[:batch_document_ids] = val
+  end
+
+
   def clear_batch!
-    session[:batch_document_ids] = []
+    self.batch = []
   end
 
   def check_for_empty!
     if batch.empty?
-      redirect_to catalog_index_path
+      redirect_to :back
       return false
     end
   end

data/spec/controllers/batch_edits_controller_spec.rb

@@ -75,10 +75,12 @@ describe BatchEditsController do
     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
       put :update, :multiresimage=>{:titleSet_display=>'My title' } 
-      response.should redirect_to '/catalog'
+      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
@@ -87,7 +89,7 @@ describe BatchEditsController do
       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' } 
-      response.should redirect_to '/catalog' 
+      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
@@ -124,5 +126,22 @@ describe BatchEditsController do
     end
   end
 
+  describe "select all" do
+    before do
+      doc1 = stub(:id=>123)
+      doc2 = stub(:id=>456)
+      Hydra::BatchEdit::SearchService.any_instance.should_receive(:last_search_documents).and_return([doc1, doc2])
+      controller.stub(:current_user=>stub(:user_key=>'vanessa'))
+    end
+    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]
+    end
+  end
+
+  describe "clear" do
+    it "should clear the batch"
+  end
 
 end

data/spec/lib/search_service_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Hydra::BatchEdit::SearchService do
+
+  before do
+    @session = {:history => [17, 14, 12, 9]}
+    @service = Hydra::BatchEdit::SearchService.new(@session, 'vanessa')
+  end
+
+  it "should get the documents for the first history entry" do
+    Search.should_receive(:find).with(17).and_return(Search.new(:query_params=>{:q=>"World Peace"}))
+    @service.should_receive(:get_search_results).and_return([:one, [:doc1, :doc2]])
+    @service.last_search_documents.should == [:doc1, :doc2]
+
+  end
+
+end

data/spec/routing/batch_edit_routes_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "Routes for batch_update" do
+  it "should route index" do 
+    { :get => '/batch_edits' }.should route_to( :controller => "batch_edits", :action => "index")
+  end
+  it "should route edit" do 
+    { :get => edit_batch_edits_path }.should route_to( :controller => "batch_edits", :action => "edit")
+  end
+  it "should route update" do 
+    { :put => batch_edits_path }.should route_to( :controller => "batch_edits", :action => "update")
+  end
+  it "should route add" do 
+    { :put => '/batch_edits/7'}.should route_to( :controller => "batch_edits", :action => "add", :id=>'7')
+  end
+  it "should route delete" do 
+    { :delete => '/batch_edits/7' }.should route_to( :controller => "batch_edits", :action => "destroy", :id=>'7')
+    batch_edit_path(7).should == "/batch_edits/7"
+  end
+
+  it "should route all" do 
+    { :put => '/batch_edits/all'}.should route_to( :controller => "batch_edits", :action => "all")
+    all_batch_edits_path.should == "/batch_edits/all"
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ require 'rspec/rails'
 require 'hydra-batch-edit'
 
 
-
 RSpec.configure do |config|
   config.use_transactional_fixtures = true
 end

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

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+class SolrDocument 
+
+  include Blacklight::Solr::Document
+end

data/spec/support/db/migrate/20111101221803_create_searches.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+class CreateSearches < ActiveRecord::Migration
+  def self.up
+    create_table :searches do |t|
+      t.text  :query_params
+      t.integer :user_id
+
+      t.timestamps
+    end
+    add_index :searches, :user_id
+  end
+
+  def self.down
+    drop_table :searches
+  end
+end

data/spec/support/lib/generators/test_app_generator.rb

@@ -13,5 +13,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def copy_test_models
     copy_file "app/models/sample.rb"
+    copy_file "app/models/solr_document.rb"
+    copy_file "db/migrate/20111101221803_create_searches.rb"
   end
 end

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

@@ -1,7 +1,7 @@
 $ ->
   $("[data-behavior='batch-tools']").removeClass('hidden')     
 
-  $("[data-behavior='batch-add-button']").bl_checkbox_submit({
+  $("[data-behavior='batch-add-form']").bl_checkbox_submit({
           checked_label: "Selected",
           unchecked_label: "Select",
           css_class: "batch_toggle"
@@ -12,11 +12,13 @@ $ ->
       obj.find('a i').addClass('icon-ok')
       $("[data-behavior='batch-edit']").removeClass('hidden')
       $("[data-behavior='batch-add-button']").removeClass('hidden')
+      $("[data-behavior='batch-select-all']").removeClass('hidden')
 
     deactivate = ->
       obj.find('a i').removeClass('icon-ok')
       $("[data-behavior='batch-edit']").addClass('hidden')
       $("[data-behavior='batch-add-button']").addClass('hidden')
+      $("[data-behavior='batch-select-all']").addClass('hidden')
 
     if obj.attr("data-state") == 'off'
       deactivate(obj)

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

@@ -1,4 +1,11 @@
+.batch-select-all {
+  display: inline;
+}
 .hidden {
-  display: none;
+  visibility: hidden;
 
 }
+.batch-tools {
+  display: inline-block;
+}
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-batch-edit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-18 00:00:00.000000000 Z
+date: 2012-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,7 @@ files:
 - 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/_next_page.html.erb
 - app/views/batch_edits/_tools.html.erb
 - app/views/batch_edits/edit.html.erb
@@ -82,15 +99,21 @@ files:
 - config/routes.rb
 - hydra-batch-edit.gemspec
 - lib/hydra-batch-edit.rb
+- lib/hydra/batch_edit.rb
 - lib/hydra/batch_edit/routes.rb
+- lib/hydra/batch_edit/search_service.rb
 - lib/hydra/batch_edit/version.rb
 - lib/hydra/batch_edit_behavior.rb
 - spec/.gitignore
 - spec/controllers/batch_edits_controller_spec.rb
 - spec/helpers/batch_edit_helper_spec.rb
+- spec/lib/search_service_spec.rb
+- spec/routing/batch_edit_routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/Gemfile
 - spec/support/app/models/sample.rb
+- spec/support/app/models/solr_document.rb
+- spec/support/db/migrate/20111101221803_create_searches.rb
 - spec/support/lib/generators/test_app_generator.rb
 - vendor/assets/javascripts/batch_edit.js.coffee
 - vendor/assets/stylesheets/batch_edit.css.scss
@@ -114,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rails engine to do batch editing with hydra-head
@@ -122,7 +145,11 @@ test_files:
 - spec/.gitignore
 - spec/controllers/batch_edits_controller_spec.rb
 - spec/helpers/batch_edit_helper_spec.rb
+- spec/lib/search_service_spec.rb
+- spec/routing/batch_edit_routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/Gemfile
 - spec/support/app/models/sample.rb
+- spec/support/app/models/solr_document.rb
+- spec/support/db/migrate/20111101221803_create_searches.rb
 - spec/support/lib/generators/test_app_generator.rb