hydra-collections 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e408397139dfd38d3a70d30dd1384209a34cf8fe
-  data.tar.gz: b90ffd34c4127afc9dab4e7c29da30b26e874302
+  metadata.gz: ef2d245ae222f9d4aa4164e6e6293facd7ae8af7
+  data.tar.gz: 2e785a983145507e7ca33cf38b0deabd4bfd0f68
 SHA512:
-  metadata.gz: 175c87cf77a8d496a334cb4b3f510520ef51866706bb5105ee7a7640faa91e0a930cd6ab8049be1c402b4e994d2e33959e30428dcbbf4e0775c204c6b5c4bf2d
-  data.tar.gz: a35332501f69ce656560aaee963dc22d7643392b4f5984de22ef668229c8d9a6f1b57dc48205a8d70f191cd564e5cb2af9a8a0754b03592b7d5153490fccbec4
+  metadata.gz: 9975569dca4f4f8b6b7c5b426cb24045e0d8c07669af92982378f629cc02b8f2c56efeceb8101c7dcaf2a1dc8fd39f5aec8a059332ce5ad6c7bf1214ab4e68ba
+  data.tar.gz: 7c3d2f47293e9899e300fae0e5bbe82492518e7825a2565ba05a8c7c04ab43ec6e7d04ea8921ad6201214d88c8751cb05c371c5a883e4f1b3cca1656ca4b3d85

data/.rspec

@@ -1 +1,2 @@
 --colour
+--backtrace

data/.travis.yml

@@ -9,9 +9,6 @@ env:
   matrix:
   - "RAILS_VERSION=4.1.8"
   - "RAILS_VERSION=4.2.0"
-matrix:
-  allow_failures:
-    - env: "RAILS_VERSION=4.2.0"
 notifications:
   email:
     recipients:

data/Gemfile

@@ -3,16 +3,21 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hydra-collections.gemspec
 gemspec
 
+gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'
+
 group :development, :test do
   gem 'sqlite3'
   gem "factory_girl_rails"
   gem 'devise'
   gem 'capybara'
   gem 'jettywrapper'
-  gem 'byebug', require: false
+  gem 'byebug', require: false unless ENV['CI']
   gem 'coveralls', require: false
+  gem 'rspec-activemodel-mocks'
 end
 
+gem 'slop', '~> 3.6' # because rails installs byebug in the Gemfile
+
 file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
 if File.exists?(file)
   puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`

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

@@ -1,9 +1,15 @@
 module Hydra::Collections::SelectsCollections
   extend ActiveSupport::Concern
- 
+
+  included do
+    configure_blacklight do |config|
+      config.search_builder_class = Hydra::Collections::SearchBuilder
+    end
+  end
+
   def access_levels
     { read: [:read, :edit], edit: [:edit] }
-  end 
+  end
 
   # add one of the following methods as a before filter on any page that shows the form_for_select_collection
   def find_collections_with_read_access
@@ -13,44 +19,35 @@ module Hydra::Collections::SelectsCollections
   def find_collections_with_edit_access
     find_collections(:edit)
   end
-  
-  # 
-  def find_collections (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?
-    
-    # update the permission filters for the query of need be
-    original_permissions = discovery_permissions 
-    self.class.send(:define_method, "discovery_permissions")  { access_levels[access_level] } unless access_level.blank?
- 
-    # Blacklight doesn't let you explicitly pass your own solr_search_params_logic when running searches -- 
-    # You have to set the controller's solr_search_params_logic class attribute. So this method temporarily sets solr_search_params_logic to collection_search_params_logic then switches it back.
-    
-    # temporarily set solr_search_params_logic to collection_search_params_logic
-    orig_solr_search_params_logic = self.class.solr_search_params_logic
-    self.class.solr_search_params_logic = collection_search_params_logic
-    logger.debug "Collection Search logic: "+ self.class.solr_search_params_logic.inspect
+
     # run the solr query to find the collections
-    (resp, doc_list) = get_search_results({q: ''}, {rows: 100})
-    
-    #reset to original solr logic
-    self.class.send(:define_method, "discovery_permissions")  { original_permissions } unless access_level.blank?
-    self.class.solr_search_params_logic = orig_solr_search_params_logic
+    query = collections_search_builder(access_level).with({q: ''}).query
+    response = repository.search(query)
 
     # return the user's collections (or public collections if no access_level is applied)
-    @user_collections = doc_list
+    @user_collections = response.documents
   end
-      
-  def add_collection_filter(solr_parameters, user_parameters)
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] << "#{Solrizer.solr_name("has_model", :symbol)}:Collection"
+
+  def collections_search_builder_class
+    Hydra::Collections::SearchBuilder
+  end
+
+  def collections_search_builder(access_level = nil)
+    @collections_search_builder ||= collections_search_builder_class.new(collection_search_params_logic, self).tap do |builder|
+      builder.current_ability = current_ability
+      builder.discovery_perms = access_levels[access_level] if access_level
+    end
   end
-  
-  # Defines which solr_search_params_logic should be used when searching for Collections
+
+  # Defines which search_params_logic should be used when searching for Collections
   def collection_search_params_logic
-    base_logic = [:default_solr_parameters, :add_query_to_solr, :add_access_controls_to_solr_params]
-    base_logic += [:add_collection_filter]
-    base_logic
+    [:default_solr_parameters, :add_query_to_solr, :add_access_controls_to_solr_params,
+      :add_collection_filter, :some_rows]
   end
-  
+
 end

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

@@ -2,16 +2,16 @@ module Hydra
   module CollectionsControllerBehavior
     extend ActiveSupport::Concern
 
-    included do
-      include Blacklight::Configurable
-      include Blacklight::SolrHelper
+    include Blacklight::Base
+    include Hydra::Collections::SelectsCollections
 
+    included do
       include Hydra::Collections::AcceptsBatches
-      include Hydra::Collections::SelectsCollections
 
       # This is needed as of BL 3.7
       self.copy_blacklight_config_from(CatalogController)
 
+
       # Catch permission errors
       rescue_from Hydra::AccessDenied, CanCan::AccessDenied do |exception|
         if exception.action == :edit
@@ -28,8 +28,14 @@ module Hydra
       before_filter :authenticate_user!, :except => [:show]
       load_and_authorize_resource :except=>[:index], instance_name: :collection
 
-      #This includes only the collection members in the search
-      self.solr_search_params_logic += [:include_collection_ids]
+      layout 'collections'
+    end
+
+    def index
+      # run the solr query to find the collections
+      query = collections_search_builder.with(params).query
+      @response = repository.search(query)
+      @document_list = @response.documents
     end
 
     def new
@@ -88,8 +94,7 @@ module Hydra
 
     def update
       process_member_changes
-      @collection.update_attributes(collection_params.except(:members))
-      if @collection.save
+      if @collection.update(collection_params.except(:members))
         after_update
       else
         after_update_error
@@ -118,8 +123,17 @@ module Hydra
       end
     end
 
+    def collection
+      @collection
+    end
+
     protected
 
+    # Defines which search_params_logic should be used when searching for Collection members
+    def collection_member_search_logic
+      search_params_logic + [:include_collection_ids]
+    end
+
     def collection_params
       params.require(:collection).permit(:part_of, :contributor, :creator, :title,
         :description, :publisher, :date_created, :subject, :language, :rights,
@@ -129,13 +143,22 @@ module Hydra
     # Queries Solr for members of the collection.
     # Populates @response and @member_docs similar to Blacklight Catalog#index populating @response and @documents
     def query_collection_members
-      query = params[:cq]
+      solr_params =  params.symbolize_keys.merge(q: params[:cq])
+
+      # run the solr query to find the collection members
+      query = collection_member_search_builder.with(solr_params).query
+      @response = repository.search(query)
+      @member_docs = @response.documents
+    end
 
-      #default the rows to 100 if not specified then merge in the user parameters and the attach the collection query
-      solr_params =  { rows: 100 }.merge(params.symbolize_keys).merge(q: query)
+    def collection_member_search_builder_class
+      Hydra::Collections::SearchBuilder
+    end
 
-      # run the solr query to find the collections
-      (@response, @member_docs) = get_search_results(solr_params)
+    def collection_member_search_builder
+      @collection_member_search_builder ||= collection_member_search_builder_class.new(collection_member_search_logic, self).tap do |builder|
+        builder.current_ability = current_ability
+      end
     end
 
     def process_member_changes
@@ -172,10 +195,9 @@ module Hydra
       end
     end
 
-    # include filters into the query to only include the collection memebers
-    def include_collection_ids(solr_parameters, user_parameters)
-      solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << Solrizer.solr_name(:collection, :facetable)+':"'+@collection.id+'"'
+    # Override rails path for the views
+    def _prefixes
+      @_prefixes ||= super + ['catalog']
     end
   end # module CollectionsControllerBehavior
 end # module Hydra

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

@@ -1,96 +1,25 @@
 module Hydra
   module Collection
     extend ActiveSupport::Concern
-    extend ActiveSupport::Autoload
+    extend Deprecation
     include Hydra::WithDepositor # for access to apply_depositor_metadata
     include Hydra::AccessControls::Permissions
     include Hydra::Collections::Collectible
-
-    included do
-      has_and_belongs_to_many :members, predicate: ActiveFedora::RDF::Fcrepo::RelsExt.hasCollectionMember, class_name: "ActiveFedora::Base" , after_remove: :update_member
-
-      property :depositor, predicate: ::RDF::URI.new("http://id.loc.gov/vocabulary/relators/dpt"), multiple: false do |index|
-        index.as :symbol, :stored_searchable
-      end
-
-      property :part_of, predicate: RDF::DC.isPartOf
-      property :contributor, predicate: RDF::DC.contributor do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :creator, predicate: RDF::DC.creator do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :title, predicate: RDF::DC.title, multiple: false do |index|
-        index.as :stored_searchable
-      end
-      property :description, predicate: RDF::DC.description, multiple: false do |index|
-        index.type :text
-        index.as :stored_searchable
-      end
-      property :publisher, predicate: RDF::DC.publisher do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :date_created, predicate: RDF::DC.created do |index|
-        index.as :stored_searchable
-      end
-      property :date_uploaded, predicate: RDF::DC.dateSubmitted, multiple: false do |index|
-        index.type :date
-        index.as :stored_sortable
-      end
-      property :date_modified, predicate: RDF::DC.modified, multiple: false do |index|
-        index.type :date
-        index.as :stored_sortable
-      end
-      property :subject, predicate: RDF::DC.subject do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :language, predicate: RDF::DC.language do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :rights, predicate: RDF::DC.rights do |index|
-        index.as :stored_searchable
-      end
-      property :resource_type, predicate: RDF::DC.type do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :identifier, predicate: RDF::DC.identifier do |index|
-        index.as :stored_searchable
-      end
-      property :based_near, predicate: RDF::FOAF.based_near do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :tag, predicate: RDF::DC.relation do |index|
-        index.as :stored_searchable, :facetable
-      end
-      property :related_url, predicate: RDF::RDFS.seeAlso
-
-      before_create :set_date_uploaded
-      before_save :set_date_modified
-      before_destroy :update_all_members
-
-      after_save :update_all_members
-    end
+    include Hydra::Collections::Metadata
+    include Hydra::Collections::Relations
 
     def update_all_members
+      Deprecation.warn(Collection, 'update_all_members is deprecated and will be removed in version 5.0')
       self.members.collect { |m| update_member(m) }
     end
 
     # TODO: Use solr atomic updates to accelerate this process
     def update_member member
+      Deprecation.warn(Collection, 'update_member is deprecated and will be removed in version 5.0')
       # because the member may have its collections cached, reload that cache so that it indexes the correct fields.
       member.collections(true) if member.respond_to? :collections
       member.update_index
     end
 
-    private
-
-    def set_date_uploaded
-      self.date_uploaded = Date.today
-    end
-
-    def set_date_modified
-      self.date_modified = Date.today
-    end
-
  end
 end

data/app/models/concerns/hydra/collections/actions.rb

@@ -0,0 +1,22 @@
+module Hydra::Collections
+  module Actions
+    extend ActiveSupport::Concern
+
+    included do
+      Deprecation.warn(Actions, "Hydra::Collections::Actions is deprecated and will be removed in 6.0.0")
+      before_create :set_date_uploaded
+      before_save :set_date_modified
+    end
+
+    private
+
+      def set_date_uploaded
+        self.date_uploaded = Date.today
+      end
+
+      def set_date_modified
+        self.date_modified = Date.today
+      end
+  end
+end
+

data/app/models/concerns/hydra/collections/metadata.rb

@@ -0,0 +1,62 @@
+module Hydra::Collections
+  module Metadata
+    extend ActiveSupport::Concern
+    included do
+      property :depositor, predicate: ::RDF::URI.new("http://id.loc.gov/vocabulary/relators/dpt"), multiple: false do |index|
+        index.as :symbol, :stored_searchable
+      end
+
+      property :part_of, predicate: RDF::DC.isPartOf
+      property :contributor, predicate: RDF::DC.contributor do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :creator, predicate: RDF::DC.creator do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :title, predicate: RDF::DC.title, multiple: false do |index|
+        index.as :stored_searchable
+      end
+      property :description, predicate: RDF::DC.description, multiple: false do |index|
+        index.type :text
+        index.as :stored_searchable
+      end
+      property :publisher, predicate: RDF::DC.publisher do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :date_created, predicate: RDF::DC.created do |index|
+        index.as :stored_searchable
+      end
+      property :date_uploaded, predicate: RDF::DC.dateSubmitted, multiple: false do |index|
+        index.type :date
+        index.as :stored_sortable
+      end
+      property :date_modified, predicate: RDF::DC.modified, multiple: false do |index|
+        index.type :date
+        index.as :stored_sortable
+      end
+      property :subject, predicate: RDF::DC.subject do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :language, predicate: RDF::DC.language do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :rights, predicate: RDF::DC.rights do |index|
+        index.as :stored_searchable
+      end
+      property :resource_type, predicate: RDF::DC.type do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :identifier, predicate: RDF::DC.identifier do |index|
+        index.as :stored_searchable
+      end
+      property :based_near, predicate: RDF::FOAF.based_near do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :tag, predicate: RDF::DC.relation do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :related_url, predicate: RDF::RDFS.seeAlso
+
+    end
+  end
+end

data/app/models/concerns/hydra/collections/relations.rb

@@ -0,0 +1,8 @@
+module Hydra::Collections
+  module Relations
+    extend ActiveSupport::Concern
+    included do
+      has_and_belongs_to_many :members, predicate: ActiveFedora::RDF::Fcrepo::RelsExt.hasCollectionMember, class_name: "ActiveFedora::Base"
+    end
+  end
+end

data/app/search_builders/hydra/collections/search_builder.rb

@@ -0,0 +1,31 @@
+module Hydra::Collections
+  class SearchBuilder < Hydra::SearchBuilder
+
+    def collection
+      scope.collection
+    end
+
+    # include filters into the query to only include the collection memebers
+    def include_collection_ids(solr_parameters)
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "{!join from=hasCollectionMember_ssim to=id}id:#{collection.id}"
+    end
+
+    def some_rows(solr_parameters)
+      solr_parameters[:rows] = '100'
+    end
+
+    def add_collection_filter(solr_parameters)
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: ::Collection.to_class_uri)
+    end
+
+    def discovery_perms= perms
+      @discovery_perms = perms
+    end
+
+    def discovery_permissions
+      @discovery_perms || super
+    end
+  end
+end