hydra-collections 0.0.1

data/spec/lib/collectible_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+class CollectibleThing < ActiveFedora::Base
+  include Hydra::Collections::Collectible
+end
+
+describe Hydra::Collections::Collectible do
+  before do
+    @collection1 = FactoryGirl.create(:collection)
+    @collection2 = FactoryGirl.create(:collection)
+    @collectible = CollectibleThing.new
+  end
+  describe "collections associations" do
+    it "should allow adding and removing" do
+      @collectible.save
+      @collection1.members << @collectible
+      @collection1.save
+      @collectible.collections << @collection2
+      reloaded = CollectibleThing.find(@collectible.pid)
+      @collection2.members.should == [@collectible]
+      reloaded.collections.should == [@collection1, @collection2]
+    end
+  end
+  describe "index_collection_pids" do
+    it "should add pids for all associated collections" do
+      @collectible.save
+      @collectible.collections << @collection1
+      @collectible.collections << @collection2
+      @collectible.index_collection_pids["collection_sim"].should == [@collection1.pid, @collection2.pid]
+    end
+  end
+end

data/spec/lib/search_service_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Hydra::Collections::SearchService do
+  before do
+    @login = 'vanessa'
+    @session = {:history => [17, 14, 12, 9]}
+    @service = Hydra::Collections::SearchService.new(@session, @login)
+  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
+
+  describe 'apply_gated_search' do
+    before(:each) do
+      RoleMapper.stub(:roles).with(@login).and_return(['umg/test.group.1'])
+      params = @service.apply_gated_search({}, {})
+      @group_query = params[:fq].first.split(' OR ')[1]
+    end
+    it "should escape slashes in groups" do
+      @group_query.should == 'edit_access_group_ssim:umg\/test.group.1'
+    end
+    it "should allow overriding Solr's access control suffix" do
+      module Hydra
+        module Collections
+          class SearchService
+            def solr_access_control_suffix(key)
+              "edit_#{key}_customfield"
+            end
+          end
+        end
+      end
+      @service = Hydra::Collections::SearchService.new({}, '')
+      params = @service.apply_gated_search({}, {})
+      @public_query = params[:fq].first.split(' OR ')[0]
+      @public_query.should == 'edit_group_customfield:public'
+    end
+  end
+end

data/spec/models/collection_spec.rb

@@ -0,0 +1,100 @@
+# 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.
+
+require 'spec_helper'
+
+describe Collection do
+  before(:all) do
+    @user = FactoryGirl.find_or_create(:user)
+    class GenericFile < ActiveFedora::Base
+    end
+  end
+  after(:all) do
+    @user.destroy
+    Object.send(:remove_const, :GenericFile)
+  end
+  before(:each) do
+    @collection = Collection.new
+    @collection.apply_depositor_metadata(@user.user_key)
+    @collection.save
+    @gf1 = GenericFile.create
+    @gf2 = GenericFile.create
+  end
+  after(:each) do
+    @collection.destroy rescue
+    @gf1.destroy
+    @gf2.destroy
+  end
+  it "should have a depositor" do
+    @collection.depositor.should == @user.user_key
+  end
+  it "should allow the depositor to edit and read" do
+    ability = Ability.new(@user)
+    ability.can?(:read, @collection).should  == true
+    ability.can?(:edit, @collection).should  == true
+  end
+  it "should be empty by default" do
+    @collection.members.should be_empty
+  end
+  it "should have many files" do
+    @collection.members = [@gf1, @gf2]
+    @collection.save
+    Collection.find(@collection.pid).members.should == [@gf1, @gf2]
+  end
+  it "should allow new files to be added" do
+    @collection.members = [@gf1]
+    @collection.save
+    @collection = Collection.find(@collection.pid)
+    @collection.members << @gf2
+    @collection.save
+    Collection.find(@collection.pid).members.should == [@gf1, @gf2]
+  end
+  it "should set the date uploaded on create" do
+    @collection.save
+    @collection.date_uploaded.should be_kind_of(Date)
+  end
+  it "should update the date modified on update" do
+    uploaded_date = Date.today
+    modified_date = Date.tomorrow
+    Date.stub(:today).and_return(uploaded_date, modified_date)
+    @collection.save
+    @collection.date_modified.should == uploaded_date
+    @collection.members = [@gf1]
+    @collection.save
+    @collection.date_modified.should == modified_date
+  end
+  it "should have a title" do
+    @collection.title = "title"
+    @collection.save
+    Collection.find(@collection.pid).title.should == @collection.title
+  end
+  it "should have a description" do
+    @collection.description = "description"
+    @collection.save
+    Collection.find(@collection.pid).description.should == @collection.description
+  end
+  it "should have the expected display terms" do
+    @collection.terms_for_display.should == [:title, :description, :date_uploaded, :date_modified]
+  end
+  it "should have the expected edit terms" do
+    @collection.terms_for_editing.should == [:title,:description]
+  end
+  it "should not delete member files when deleted" do
+    @collection.members = [@gf1, @gf2]
+    @collection.save
+    @collection.destroy
+    lambda {GenericFile.find(@gf1.pid)}.should_not raise_error ActiveFedora::ObjectNotFoundError
+    lambda {GenericFile.find(@gf2.pid)}.should_not raise_error ActiveFedora::ObjectNotFoundError
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("config/environment", ENV['RAILS_ROOT'] || File.expand_path("../internal", __FILE__))
+require 'rspec/rails'
+require 'hydra-collections'
+
+FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.include Devise::TestHelpers, :type => :controller
+  config.before(:each, :type=>"controller") { @routes = Hydra::Collections::Engine.routes }
+end
+
+module FactoryGirl
+  def self.find_or_create(handle, by=:email)
+    tmpl = FactoryGirl.build(handle)
+    tmpl.class.send("find_by_#{by}".to_sym, tmpl.send(by)) || FactoryGirl.create(handle)
+  end
+end
+

data/spec/support/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'rails'
+gem 'sqlite3'
+gem 'devise'
+gem 'hydra-head'
+gem 'hydra-collections', :path=>'../../'
+
+gem 'rspec-rails'
+gem 'factory_girl'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'jquery-rails'
+  gem 'uglifier', '>= 1.0.3'
+end

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

@@ -0,0 +1,37 @@
+class Sample
+  # This is a stub model for testing.
+
+  cattr_accessor :objects
+  self.objects = {}
+
+  def self.create(params={})
+    obj = Sample.new
+    obj.save
+    obj
+  end
+
+  def save()
+    @pid ||= "sample:#{(rand * 1000).to_i}"
+    self.class.objects[@pid] = self
+  end
+
+  def update_attributes(attributes)
+    attributes.each do |k, v|
+      instance_variable_set "@#{k.to_s}".to_sym, v
+      
+      self.class.send :attr_accessor, k
+    end
+  end
+
+  def self.find(pid)
+    objects[pid]
+  end
+
+  def pid
+    @pid
+  end
+  
+  def destroy
+    self.class.objects.delete(@pid)
+  end
+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/app/views/catalog/_document_header.html.erb

@@ -0,0 +1,11 @@
+     
+    <% # header bar for doc items in index view -%>
+    <div class="documentHeader clearfix">
+      <%= button_for_add_to_batch(document) %>
+      <% # main title container for doc partial view -%>
+        <h5 class="index_title"><%= t('blacklight.search.documents.counter', :counter => (document_counter + 1 + @response.params[:start].to_i)) %><%= link_to_document document, :label=>document_show_link_field(document), :counter => (document_counter + 1 + @response.params[:start].to_i) %></h5>
+
+  
+      <% # bookmark functions for items/docs -%>
+      <%= render_index_doc_actions document, :wrapping_class => "documentFunctions span2" %>
+    </div>

data/spec/support/app/views/catalog/_sort_and_per_page.html.erb

@@ -0,0 +1,20 @@
+<div id="sortAndPerPage">
+   <div class="page_links">
+     <%= render :partial => "paginate_compact" %>
+   </div>
+    <%= render :partial => 'sort_widget' %>
+
+    <%= render :partial => 'per_page_widget' %>
+
+    <%= button_for_create_collection %>
+
+
+    <% c1 = Collection.new(title:"title1") %>
+    <% c1.apply_depositor_metadata("cam156@psu.edu") %>
+    <% c1.save %>
+    <% c2  = Collection.new(title:"title2") %>
+    <% c2.apply_depositor_metadata("cam156@psu.edu") %>
+    <% c2.save %>
+    <%= render partial: 'collections/form_for_select_collection', locals: {user_collections: [c1,c2]}  %>
+
+</div>

data/spec/support/config/initializers/hydra_config.rb

@@ -0,0 +1,28 @@
+# The following lines determine which user attributes your hydrangea app will use
+# This configuration allows you to use the out of the box ActiveRecord associations between users and user_attributes
+# It also allows you to specify your own user attributes
+# The easiest way to override these methods would be to create your own module to include in User
+# For example you could create a module for your local LDAP instance called MyLocalLDAPUserAttributes:
+#   User.send(:include, MyLocalLDAPAttributes)
+# As long as your module includes methods for full_name, affiliation, and photo the personalization_helper should function correctly
+#
+
+# windows doesn't properly require hydra-head (from the gemfile), so we need to require it explicitly here:
+require 'hydra/head' unless defined? Hydra
+
+if Hydra.respond_to?(:configure)
+  Hydra.configure(:shared) do |config|
+    # This specifies the solr field names of permissions-related fields.
+    # You only need to change these values if you've indexed permissions by some means other than the Hydra's built-in tooling.
+    # If you change these, you must also update the permissions request handler in your solrconfig.xml to return those values
+    indexer = Solrizer::Descriptor.new(:string, :stored, :indexed, :multivalued)
+    config[:permissions] = {
+      :discover => {:group =>ActiveFedora::SolrService.solr_name("discover_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("discover_access_person", indexer)},
+      :read => {:group =>ActiveFedora::SolrService.solr_name("read_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("read_access_person", indexer)},
+      :edit => {:group =>ActiveFedora::SolrService.solr_name("edit_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("edit_access_person", indexer)},
+      :owner => ActiveFedora::SolrService.solr_name("depositor", indexer),
+      :embargo_release_date => ActiveFedora::SolrService.solr_name("embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
+    }
+    
+  end
+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

@@ -0,0 +1,54 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../support", __FILE__)
+
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)       
+
+    generate 'blacklight', '--devise'
+  end
+
+  def run_hydra_head_generator
+    say_status("warning", "GENERATING HH", :yellow)       
+
+    generate 'hydra:head', '-f'
+  end
+  
+  def run_migrations
+    rake("db:migrate")
+  end
+
+  # Inject call to Hydra::Collections.add_routes in config/routes.rb
+  def inject_routes
+    insert_into_file "config/routes.rb", :after => '.draw do' do
+      "\n  # Add Collections routes."
+      "\n  mount Hydra::Collections::Engine => '/'"
+    end
+  end
+
+  def copy_rspec_rake_task
+    copy_file "lib/tasks/rspec.rake"
+  end
+
+  def copy_hydra_config
+    copy_file "config/initializers/hydra_config.rb"
+  end
+  
+  def delete_generated_noise
+    remove_file("public/index.html")
+    remove_file("spec/models/user_spec.rb")
+  end
+  
+  def copy_view_overrides
+    directory("app/views/catalog")
+  end
+  
+  # Inject call to Hydra::Collections.add_routes in config/routes.rb
+  def inject_javascript
+    insert_into_file "app/assets/javascripts/application.js", :after => '/= require_tree .' do
+      "\n  #include javascript for batches and collections\n//= require hydra/batch_select\n//=  require hydra_collections"
+    end
+  end
+
+end

data/spec/support/lib/tasks/rspec.rake

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+desc "run the hydra-collections gem spec"
+gem_home = File.expand_path('../../../../..', __FILE__)
+RSpec::Core::RakeTask.new(:myspec) do |t|
+  t.pattern = gem_home + '/spec/**/*_spec.rb'
+  t.rspec_opts = "--colour"
+  t.ruby_opts = "-I#{gem_home}/spec"
+end
+

data/tasks/hydra-collections-dev.rake

@@ -0,0 +1,68 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+APP_ROOT="." # for jettywrapper
+require 'jettywrapper'
+ENV["RAILS_ROOT"] ||= 'spec/internal'
+
+desc 'Spin up hydra-jetty and run specs'
+task :ci => ['jetty:config'] do
+  puts 'running continuous integration'
+  jetty_params = Jettywrapper.load_config
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
+
+desc "Run specs"
+# Note: this is _not_ an RSpec::Core::RakeTask.  
+# It's a regular rake task that calls the RSpec RakeTask that's defined in spec/support/lib/tasks/rspec.rake
+task :spec => [:generate] do |t|
+  focused_spec = ENV['SPEC'] ? " SPEC=#{File.join(GEM_ROOT, ENV['SPEC'])}" : ''
+  within_test_app do
+    system "rake myspec#{focused_spec}"
+    abort "Error running hydra-collections" unless $?.success?
+  end
+end
+
+desc "Create the test rails app"
+task :generate do
+  unless File.exists?('spec/internal/Rakefile')
+    puts "Generating rails app"
+    `rails new spec/internal`
+    puts "Copying gemfile"
+    `cp spec/support/Gemfile spec/internal`
+    puts "Copying generator"
+    `cp -r spec/support/lib/generators spec/internal/lib`
+    Bundler.with_clean_env do
+      within_test_app do
+        puts "Bundle install"
+        `bundle install`
+        puts "running test_app_generator"
+        system "rails generate test_app"
+
+        puts "running migrations"
+        puts `rake db:migrate db:test:prepare`
+      end
+    end
+  end
+  puts "Done generating test app"
+end
+
+desc "Clean out the test rails app"
+task :clean do
+  puts "Removing sample rails app"
+  `rm -rf spec/internal`
+end
+
+def within_test_app
+  FileUtils.cd('spec/internal')
+  yield
+  FileUtils.cd('../..')
+end
+
+namespace :meme do
+  desc "configure jetty to generate checksums"
+  task :config do
+  end
+end