hydra-collections 6.0.0.alpha → 6.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a55e2a03471e0659271fbbbc73f0dd6233119390
-  data.tar.gz: 872f3f1d0fc426e335b870b1384ebd71d0c8ba78
+  metadata.gz: f660059815d3e4687d927cbfebc290aa43b1c029
+  data.tar.gz: 3eec16c408c10c7f08d9f4c77a52ec6ea9555619
 SHA512:
-  metadata.gz: 4a029879709867b6df79503628696e37bcdb5e68ef69abbae331266ffdc2b604a66c6632c9f53dae9f0b7441b6441228866b868c6551d60c606e3abef51929bc
-  data.tar.gz: de9b2cbbe3e68940bf208d8ff90db132ddfecd6adc1a8f3f785514b614d63078041125d2b959baa7d1a6dfde7d1b82d1057a4f7e9b0970398aba52248085b383
+  metadata.gz: 61d400608b2fb3b865dfbee6c14d73d39f5aa70172bd5d88c9ab379207798f36065bf22d9d1a08fc2ec85ff61a3ed92ca7793b26cbf7b5b112e9c355162e75c6
+  data.tar.gz: e4f3c3ef0120f0734ab46fc6d76f67767f6b2965235cca7f3008635ef2b73043fb8dd961e17dadf72002db15dd6b5d47018a153dedca079158608bb3231bb5cf

data/Changelog.md

@@ -1,3 +1,21 @@
+# 6.0.0.rc1
+Hydra::Collections 6.0.0 is the first release that sits atop the Portland Common Data Model. It includes the following changes:
+
+* Update for hydra-works 0.2.0 [Justin Coyne]
+* add instructions to list of editable collections; add_members to
+collection [E. Lynette Rayle]
+* Pass the document_counter to index_default [Justin Coyne]
+* Update changelog with v6.0.0.alpha entry [Michael J. Giarlo]
+
+# 6.0.0.alpha
+
+* Depend upon hydra-works 0.1.0, which brings PCDM-related dependencies. Collections defined by Hydra::Collections are now PCDM collections.
+* Add ParentCollectionAssociation#count_records to calculate the number of a collection's members.
+* Change the default join column for querying members of a collection (was `hasCollectionMember_ssim`, is now `member_ids_ssim`)
+* Deprecate the Hydra::Collections::Collectible module (in favor of Hydra::Works::GenericWorkBehavior).
+* Update rails to 4.2.1, blacklight to 5.14.0, and kaminari to the latest in Justin Coyne's fork
+* Pull latest hydra-jetty (was pinned to 8.1.0)
+
 # 5.0.2
 
 * Using new Hydra::Catalog module and Hydra::Collections::SearchBehaviors

data/README.md

@@ -24,46 +24,27 @@ Or install it yourself as:
 
 ### Call button_create_collection view helper in your search result page template.
   First add `helper :collections` to your `catalog_controller.rb`
-  
+
   Next, we recommend putting the view helper in catalog/[_sort_and_per_page.html.erb](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/_sort_and_per_page.html.erb) which you will manually override in you app.
 ```erb
 <%= button_for_create_collection %>
-```    
+```
 
 ### Any time you want to refer to the routes from hydra-collections use collections.
     collections.new_collections_path
 
 ### Make your Models Collectible
 
-Add `include Hydra::Collections::Collectible` to the models for anything that you want to be able to add to collections (ie. GenericFile, Book, Article, etc.), then add `index_collection_ids` to the solrization logic (ie. put it in to_solr)
+Add `include Hydra::Works::GenericWorkBehavior` to the models for anything that you want to be able to add to collections (ie. GenericFile, Book, Article, etc.).
 
 Example:
 ```ruby
 class GenericFile < ActiveFedora::Base
-  include Hydra::Collections::Collectible
-  ...
-  def to_solr(solr_doc={}, opts={})
-    super(solr_doc, opts)
-    index_collection_ids(solr_doc)
-    return solr_doc
-  end
+  include Hydra::Works::GenericWorkBehavior
 end
 ```
 
-Any items that include the `Hydra::Collections::Collectible` module can look up which collections they belong to via `.collections`.  The `index_collection_ids` puts the ids of all associated collections into the `collection` facet.
-
-### Make the Collection show as a facet in your CatalogController
-
-```ruby
-class CatalogController < ApplicationController
-    include Blacklight::Catalog
-  ...
-    configure_blacklight do |config|
-  ...     
-        config.add_facet_field solr_name("collection", :facetable), label: "Collection", helper_method: :collection_name
-    end
-end
-```
+Any items that include the `Hydra::Works::GenericWorkBehavior` module can look up which collections they belong to via `.in_collections`.
 
 ### Make your Controller Accept a Batch
 

data/app/controllers/concerns/hydra/collections/selects_collections.rb

@@ -11,16 +11,35 @@ module Hydra::Collections::SelectsCollections
     { read: [:read, :edit], edit: [:edit] }
   end
 
-  # add one of the following methods as a before filter on any page that shows the form_for_select_collection
+  ##
+  # Return list of collections for which the current user has read access.
+  # Add this or find_collections_with_edit_access as a before filter on any page that shows the form_for_select_collection
+  #
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has read access
   def find_collections_with_read_access
     find_collections(:read)
   end
 
-  def find_collections_with_edit_access
+  ##
+  # Return list of collections for which the current user has edit access.  Optionally prepend with default
+  # that can be used in a select menu to instruct user to select a collection.
+  # Add this or find_collections_with_read_access as a before filter on any page that shows the form_for_select_collection
+  #
+  # @param [TrueClass|FalseClass] :include_default if true, prepends the default_option; otherwise, if false, returns only collections
+  # @param [Fixnum] :default_id for select menus, this is the id of the first selection representing the instructions
+  # @param [String] :default_title for select menus, this is the text displayed as the first item serving as instructions
+  #
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has edit access, plus optional instructions
+  def find_collections_with_edit_access(include_default=false, default_id=-1, default_title="Select collection...")
     find_collections(:edit)
+    default_option = SolrDocument.new(id: default_id, title_tesim: default_title)
+    @user_collections.unshift(default_option) if include_default
   end
 
-  #
+  ##
+  # Return list of collections matching the passed in access_level for the current user.
+  # @param [Symbol] :access_level one of :read or :edit
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has the appropriate access level
   def find_collections (access_level = nil)
     # need to know the user if there is an access level applied otherwise we are just doing public collections
     authenticate_user! unless access_level.blank?

data/app/controllers/concerns/hydra/collections_controller_behavior.rb

@@ -172,10 +172,7 @@ module Hydra
 
     def add_members_to_collection collection = nil
       collection ||= @collection
-      batch.each do |id|
-        collection.child_generic_works << ActiveFedora::Base.find(id)
-      end
-      #TODO this old way was more efficient #collection.member_ids = batch.concat(collection.member_ids)
+      collection.add_members batch
     end
 
     def remove_members_from_collection

data/app/models/concerns/hydra/collection.rb

@@ -7,5 +7,12 @@ module Hydra
     include Hydra::AccessControls::Permissions
     include Hydra::Collections::Metadata
     include Hydra::Works::CollectionBehavior
+
+
+    def add_members new_member_ids
+      return if new_member_ids.nil? || new_member_ids.size < 1
+      self.members << ActiveFedora::Base.find(new_member_ids)
+    end
+
   end
 end

data/app/views/collections/_index_default.html.erb

@@ -1,2 +1,2 @@
-<%= render 'catalog/index_default', document: document %>
+<%= render 'catalog/index_default', document: document, document_counter: document_counter %>
 

data/hydra-collections.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hydra-head', '~> 9.1'
   spec.add_dependency 'deprecation', '~> 0.1'
   spec.add_dependency 'blacklight', '~> 5.10'
-  spec.add_dependency 'hydra-works', '~> 0.1'
+  spec.add_dependency 'hydra-works', '~> 0.2'
 
   spec.add_development_dependency 'engine_cart', '~> 0.5'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'

data/lib/hydra/collections/collectible.rb

@@ -12,13 +12,13 @@ module Hydra::Collections
     end
 
     def collection_ids
-      Deprecation.warn(Collectible, "collection_ids is deprecated and will be removed in Hydra::Collections 7.0. Use parent_collections.map(&:id) instead.")
-      parent_collections.map(&:id)
+      Deprecation.warn(Collectible, "collection_ids is deprecated and will be removed in Hydra::Collections 7.0. Use in_collections.map(&:id) instead.")
+      in_collections.map(&:id)
     end
 
     def collections
-      Deprecation.warn(Collectible, "collections is deprecated and will be removed in Hydra::Collections 7.0. Use parent_collections instead.")
-      parent_collections
+      Deprecation.warn(Collectible, "collections is deprecated and will be removed in Hydra::Collections 7.0. Use in_collections instead.")
+      in_collections
     end
 
   end

data/lib/hydra/collections/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Collections
-    VERSION = "6.0.0.alpha"
+    VERSION = "6.0.0.rc1"
   end
 end

data/spec/controllers/collections_controller_spec.rb

@@ -202,10 +202,10 @@ describe CollectionsController, :type => :controller do
         asset1 = GenericWork.create!
         @collection.members << asset1
         @collection.save!
-        expect(asset1.parent_collections).to eq [@collection]
+        expect(asset1.in_collections).to eq [@collection]
 
         delete :destroy, id: @collection
-        expect(asset1.parent_collections).to eq []
+        expect(asset1.in_collections).to eq []
       end
     end
 

data/spec/controllers/other_collections_controller_spec.rb

@@ -8,7 +8,7 @@ describe OtherCollectionsController, :type => :controller do
     end
 
     class Member < ActiveFedora::Base
-      include Hydra::Collections::Collectible
+      include Hydra::Works::GenericWorkBehavior
       include Hydra::AccessControls::Permissions
     end
   end

data/spec/controllers/selects_collections_spec.rb

@@ -90,6 +90,11 @@ describe SelectsCollectionsController, :type => :controller do
           subject.find_collections_with_edit_access
           expect(assigns[:user_collections].map(&:id)).to match_array [@collection.id, @collection3.id]
         end
+
+        it "should return only public or editable collections & instructions" do
+          subject.find_collections_with_edit_access(true)
+          expect(assigns[:user_collections].map(&:id)).to match_array [-1, @collection.id, @collection3.id]
+        end
       end
     end
   end

data/spec/helpers/collections_helper_spec.rb

@@ -62,7 +62,7 @@ describe CollectionsHelper, :type => :helper do
       before(:all) do
         class OtherCollection < ActiveFedora::Base
           include Hydra::Collection
-          include Hydra::Collections::Collectible
+          include Hydra::Works::GenericWorkBehavior
         end
 
         @collection = OtherCollection.create

data/spec/lib/collectible_spec.rb

@@ -17,6 +17,7 @@ describe Hydra::Collections::Collectible do
 
   describe "collections associations" do
     before do
+      allow(Deprecation).to receive(:warn)
       collection1.members << collectible
       collection1.save
       collection2.members << collectible

data/spec/models/collection_spec.rb

@@ -4,7 +4,7 @@ describe Collection, :type => :model do
   before(:all) do
     @user = FactoryGirl.find_or_create(:user)
     class GenericFile < ActiveFedora::Base
-      include Hydra::Collections::Collectible
+      include Hydra::Works::GenericWorkBehavior
     end
   end
   after(:all) do
@@ -14,6 +14,7 @@ describe Collection, :type => :model do
 
   let(:gf1) { GenericFile.create }
   let(:gf2) { GenericFile.create }
+  let(:gf3) { GenericFile.create }
 
   let(:user) { @user }
 
@@ -82,6 +83,13 @@ describe Collection, :type => :model do
           subject.save
           expect(subject.reload.members).to eq [gf1, gf2]
         end
+
+        it "should allow multiple files to be added" do
+          subject.reload
+          subject.add_members [gf2.id, gf3.id]
+          subject.save
+          expect(subject.reload.members).to eq [gf1, gf2, gf3]
+        end
       end
     end
 
@@ -93,8 +101,8 @@ describe Collection, :type => :model do
       end
 
       it "allows files to be removed" do
-        # force the "parent_collections" to be cached:
-        expect(gf1.parent_collections).to eq [subject]
+        # force the "in_collections" to be cached:
+        expect(gf1.in_collections).to eq [subject]
 
         # We need to ensure that deleting causes the collection to be flushed.
         subject.reload.members.delete(gf1)
@@ -136,7 +144,7 @@ describe Collection, :type => :model do
       end
 
       class Member < ActiveFedora::Base
-        include Hydra::Collections::Collectible
+        include Hydra::Works::GenericWorkBehavior
       end
     end
     after do
@@ -154,7 +162,7 @@ describe Collection, :type => :model do
 
     it "have members that know about the collection" do
       member.reload
-      expect(member.collections).to eq [collection]
+      expect(member.in_collections).to eq [collection]
     end
   end
 end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +1,2 @@
 gem 'kaminari', github: 'jcoyne/kaminari', branch: 'sufia'
+gem 'active-fedora', github: 'projecthydra/active_fedora'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-collections
 version: !ruby/object:Gem::Version
-  version: 6.0.0.alpha
+  version: 6.0.0.rc1
 platform: ruby
 authors:
 - Carolyn Cole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-head
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A rails engine for managing Hydra Collections