Contents

# -*- encoding : utf-8 -*-
module Blacklight::User

  extend Deprecation
  self.deprecation_horizon = 'blacklight 5.0'

  # This gives us an is_blacklight_user method that can be included in
  # the containing applications models. 
  # SEE ALSO:  The /lib/blacklight/engine.rb class for how when this 
  # is injected into the hosting application through ActiveRecord::Base extend
  def self.included(base)
    if base.respond_to? :has_many
      base.send :has_many, :bookmarks, :dependent => :destroy, :as => :user
      base.send :has_many, :searches,  :dependent => :destroy, :as => :user
    end
  end

  # This is left for backwards-compatibility
  # Remove this in Blacklight 5.x
  module InstanceMethods
    include Blacklight::User
  end

  def has_bookmarks?
    Deprecation.warn(Blacklight::User, "User#has_bookmarks? is deprecated; use User#bookmarks.any? instead")
    bookmarks.any?
  end
    
  def has_searches?
    Deprecation.warn(Blacklight::User, "User#has_searchs? is deprecated; use User#searches.any? instead")
    searches.any?
  end
    
  def bookmarked_document_ids
    self.bookmarks.pluck(:document_id)
  end

  def document_is_bookmarked?(document_id)
    bookmarked_document_ids.include? document_id.to_s
  end
    
  # returns a Bookmark object if there is one for document_id, else
  # nil. 
  def existing_bookmark_for(document_id)
    self.bookmarks.where(:document_id => document_id).first
  end
    
  def documents_to_bookmark=(docs)
    Deprecation.warn(Blacklight::User, "User#documents_to_bookmarks= is deprecated and will be removed in Blacklight 5.0")
    docs.reject { |doc| document_is_bookmarked?(doc[:document_id]) }.each do |doc|
      self.bookmarks.create(doc) 
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
blacklight-4.9.0	lib/blacklight/user.rb
blacklight-4.8.0	lib/blacklight/user.rb
blacklight-4.7.0	lib/blacklight/user.rb
blacklight-4.7.0.pre1	lib/blacklight/user.rb