blacklight 5.9.4 → 5.10.0

data/lib/blacklight/solr_repository.rb

@@ -1,16 +1,12 @@
 module Blacklight
-  class SolrRepository
-    attr_accessor :blacklight_config, :blacklight_solr
-
-    # ActiveSupport::Benchmarkable requires a logger method
-    attr_accessor :logger
-
-    include ActiveSupport::Benchmarkable
-
-    def initialize blacklight_config
-      @blacklight_config = blacklight_config
+  class SolrRepository < AbstractRepository
+    unless defined? RSolr
+      Deprecation.warn self, "RSolr should be in your gemfile. Blacklight 6.0 will not load rsolr by default"
+      require 'rsolr'
     end
 
+    extend Deprecation
+    self.deprecation_horizon = 'blacklight 6.0'
     ##
     # Find a single solr document result (by id) using the document configuration
     # @param [String] document's unique key value
@@ -19,9 +15,9 @@ module Blacklight
       doc_params = params.reverse_merge(qt: blacklight_config.document_solr_request_handler)
                          .reverse_merge(blacklight_config.default_document_solr_params)
                          .merge(blacklight_config.document_unique_id_param => id)
-      
+
       solr_response = send_and_receive blacklight_config.document_solr_path || blacklight_config.solr_path, doc_params
-      raise Blacklight::Exceptions::InvalidSolrID.new if solr_response.documents.empty?
+      raise Blacklight::Exceptions::RecordNotFound.new if solr_response.documents.empty?
       solr_response
     end
 
@@ -45,29 +41,39 @@ module Blacklight
     def send_and_receive(path, solr_params = {})
       benchmark("Solr fetch", level: :debug) do
         key = blacklight_config.http_method == :post ? :data : :params
-        res = blacklight_solr.send_and_receive(path, {key=>solr_params.to_hash, method:blacklight_config.http_method})
+        res = connection.send_and_receive(path, {key=>solr_params.to_hash, method:blacklight_config.http_method})
 
-        solr_response = blacklight_config.solr_response_model.new(res, solr_params, solr_document_model: blacklight_config.solr_document_model)
+        solr_response = blacklight_config.response_model.new(res, solr_params, document_model: blacklight_config.document_model)
 
-        Blacklight.logger.debug("Solr query: #{solr_params.inspect}")
-        Blacklight.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
+        Rails.logger.debug("Solr query: #{solr_params.inspect}")
+        Rails.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
         solr_response
       end
     rescue Errno::ECONNREFUSED => e
-      raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{blacklight_solr.inspect}")
+      raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{connection.inspect}")
+    rescue RSolr::Error::Http => e
+      raise Blacklight::Exceptions::InvalidRequest.new(e.message)
     end
 
     def blacklight_solr
-      @blacklight_solr ||= RSolr.connect(blacklight_solr_config)
+      connection
     end
+    deprecation_deprecate blacklight_solr: :connection
 
-    protected
-    def blacklight_solr_config
-      @blacklight_solr_config ||= Blacklight.solr_config
+    def blacklight_solr=(conn)
+      self.connection = conn
     end
+    deprecation_deprecate :blacklight_solr= => :connection=
 
-    def logger
-      @logger ||= Rails.logger if defined? Rails
+    def blacklight_solr_config
+      connection_config
     end
+    deprecation_deprecate blacklight_solr_config: :connection_config
+
+    protected
+
+      def build_connection
+        RSolr.connect(connection_config)
+      end
   end
-end
+end

data/lib/blacklight/solr_response.rb

@@ -16,12 +16,12 @@ class Blacklight::SolrResponse < HashWithIndifferentAccess
   include MoreLikeThis
 
   attr_reader :request_params
-  attr_accessor :solr_document_model
+  attr_accessor :document_model
 
   def initialize(data, request_params, options = {})
     super(force_to_utf8(data))
     @request_params = request_params
-    self.solr_document_model = options[:solr_document_model] || SolrDocument
+    self.document_model = options[:solr_document_model] || options[:document_model] || SolrDocument
   end
 
   def header
@@ -52,7 +52,7 @@ class Blacklight::SolrResponse < HashWithIndifferentAccess
   end
   
   def documents
-    docs.collect{|doc| solr_document_model.new(doc, self) }
+    docs.collect{|doc| document_model.new(doc, self) }
   end
 
   def grouped

data/lib/blacklight/user.rb

@@ -24,10 +24,9 @@ module Blacklight::User
   end
 
   def bookmarked_document_ids
-    Deprecation.warn self, "The User#bookmarked_document_ids method is deprecated and will be removed in Blacklight 6.0"
-
     self.bookmarks.pluck(:document_id)
   end
+  deprecation_deprecate bookmarked_document_ids: "use current_user.bookmarks.pluck(:document_id) instead"
 
   def document_is_bookmarked?(document)
     bookmarks_for_documents([document]).any?

data/lib/blacklight/utils.rb

@@ -1,28 +1,5 @@
 require 'ostruct'
 module Blacklight
-
-  module Utils
-    def self.needs_attr_accessible?
-      if rails_3?
-        !strong_parameters_enabled?
-      else
-        protected_attributes_enabled?
-      end
-    end
-
-    def self.rails_3?
-      Rails::VERSION::MAJOR == 3
-    end
-
-    def self.strong_parameters_enabled?
-      defined?(ActionController::StrongParameters)
-    end
-
-    def self.protected_attributes_enabled?
-      defined?(ActiveModel::MassAssignmentSecurity)
-    end
-  end
-
   ##
   # An OpenStruct that responds to common Hash methods
   class OpenStructWithHashAccess < OpenStruct

data/lib/generators/blacklight/controller_generator.rb

@@ -0,0 +1,38 @@
+module Blacklight
+  class ControllerGenerator < Rails::Generators::Base
+    
+    source_root File.expand_path('../templates', __FILE__)
+    
+    argument     :controller_name  , type: :string , default: "catalog"
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Injects behavior into your user application_controller.rb
+   2. Creates a Blacklight::Catalog-based controller
+   3. Adds routes for your controller
+
+  Thank you for Installing Blacklight.
+         """
+
+    # Add Blacklight to the application controller
+    def inject_blacklight_controller_behavior
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  # Adds a few additional behaviors into the application controller \n" +
+        "  include Blacklight::Controller\n" +
+        "  layout 'blacklight'\n\n"
+      end
+    end
+    
+    # Generate blacklight catalog controller
+    def create_blacklight_catalog
+      template "catalog_controller.rb", "app/controllers/#{controller_name}_controller.rb"
+    end
+
+    def inject_blacklight_routes
+      # These will end up in routes.rb file in reverse order
+      # we add em, since each is added at the top of file. 
+      # we want "root" to be FIRST for optimal url generation. 
+      route("blacklight_for :#{controller_name}")
+    end
+  end
+end

data/lib/generators/blacklight/document_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module Blacklight
+  class DocumentGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :model_name, :type => :string , :default => "solr_document"
+
+    desc """
+This generator makes the following changes to your application:
+ 1. Creates a blacklight document in your /app/models directory
+"""
+    def create_solr_document
+      template "solr_document.rb", "app/models/#{model_name}.rb"
+    end
+
+  end
+end

data/lib/generators/blacklight/install_generator.rb

@@ -4,6 +4,9 @@ module Blacklight
     source_root File.expand_path('../templates', __FILE__)
     
     argument     :model_name  , type: :string , default: "user"
+    argument     :controller_name, type: :string , default: "catalog"
+    argument     :document_name, type: :string , default: "solr_document"
+
     class_option :devise      , type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
     class_option :jettywrapper, type: :boolean, default: false, desc: "Use jettywrapper to download and control Jetty"
     class_option :marc        , type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo ."
@@ -11,11 +14,11 @@ module Blacklight
     desc """
   This generator makes the following changes to your application:
    1. Generates blacklight:models
-   2. Creates a number of public assets, including images, stylesheets, and javascript
-   3. Injects behavior into your user application_controller.rb
-   4. Adds example configurations for dealing with MARC-like data
-   5. Adds Blacklight routes to your ./config/routes.rb
-
+   2. Adds rsolr to the Gemfile
+   3. Creates a number of public assets, including images, stylesheets, and javascript
+   4. Injects behavior into your user application_controller.rb
+   5. Adds example configurations for dealing with MARC-like data
+   6. Adds Blacklight routes to your ./config/routes.rb
 
   Thank you for Installing Blacklight.
          """
@@ -31,6 +34,10 @@ module Blacklight
         "require 'jettywrapper'\n"
     end
 
+    def add_rsolr_gem
+      gem "rsolr", "~> 1.0.6"
+    end
+
     def bundle_install
       Bundler.with_clean_env do
         run "bundle install"
@@ -43,51 +50,31 @@ module Blacklight
     def copy_public_assets 
       generate "blacklight:assets"
     end
+    
+    def generate_blacklight_document
+      generate 'blacklight:document', document_name
+    end
 
     def generate_blacklight_models
+      generate 'blacklight:models'
+    end
+    
+    def generate_blacklight_user
 
-      generator_args = []
+      generator_args = [model_name]
       if options[:devise]
         generator_args << "--devise #{options[:devise]}"
       end
       
-      generate 'blacklight:models', generator_args.join(" ")
+      generate 'blacklight:user', generator_args.join(" ")
     end
 
-    # Add Blacklight to the application controller
-    def inject_blacklight_controller_behavior
-      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
-        "  # Adds a few additional behaviors into the application controller \n" +
-        "  include Blacklight::Controller\n" +
-        "  # Please be sure to impelement current_user and user_session. Blacklight depends on \n" +
-        "  # these methods in order to perform user specific actions. \n\n" +
-        "  layout 'blacklight'\n\n"
-      end
+    def generate_controller
+      generate 'blacklight:controller', controller_name
     end
     
-    # Generate blacklight catalog controller
-    def create_blacklight_catalog
-      copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
-    end 
-
-    def generate_blacklight_marc_demo
-      if options[:marc]
-        gem "blacklight-marc", "5.5.0"
-
-        Bundler.with_clean_env do
-          run "bundle install"
-        end
-
-        generate 'blacklight_marc:marc'
-      end
-    end
-
-    def inject_blacklight_routes
-      # These will end up in routes.rb file in reverse order
-      # we add em, since each is added at the top of file. 
-      # we want "root" to be FIRST for optimal url generation. 
-      route('blacklight_for :catalog')
-      route('root :to => "catalog#index"')
+    def add_default_catalog_route
+      route("root to: \"#{controller_name}#index\"")
     end
 
     def add_sass_configuration
@@ -107,5 +94,17 @@ EOF
     def add_blacklight_initializer
       template "config/initializers/blacklight_initializer.rb"
     end
+
+    def generate_blacklight_marc_demo
+      if options[:marc]
+        gem "blacklight-marc", "~> 5.0"
+
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+
+        generate 'blacklight_marc:marc'
+      end
+    end
   end
 end

data/lib/generators/blacklight/models_generator.rb

@@ -7,54 +7,14 @@ module Blacklight
 
     source_root File.expand_path('../templates', __FILE__)
 
-    argument     :model_name, :type => :string , :default => "user"
-    class_option :devise    , :type => :boolean, :default => false, :aliases => "-d", :desc => "Use Devise as authentication logic (this is default)."
-
     desc """
 This generator makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
- 2. Creates config/solr.yml with a default solr configuration
- 3. Injects behavior into your user model
- 4. Creates a blacklight document in your /app/models directory
+ 2. Creates config/blacklight.yml with a default configuration
 """
-
-    def check_arguments
-      if File.exists?("app/models/#{model_name}.rb") and options[:devise]
-        puts "Because you have selected \"#{model_name}\", which is an existing class, you will need to install devise manually and then run this generator without the Devise option.  You can find additional information here: https://github.com/plataformatec/devise.  \n Please be sure to include a to_s method in #{model_name} that returns the users name or email, as this will be used by Blacklight to provide a link to user specific information."
-        exit
-      end
-    end
-
-    # Install Devise?
-    def generate_devise_assets
-      if options[:devise]
-        gem "devise"
-        gem "devise-guests", "~> 0.3"
-
-        Bundler.with_clean_env do
-          run "bundle install"
-        end
-
-        generate "devise:install"
-        generate "devise", model_name.classify
-        generate "devise_guests", model_name.classify
-
-        # add the #to_s to the model.
-        insert_into_file("app/models/#{model_name}.rb", before: /end(\n| )*$/) do
-          "\n  # Method added by Blacklight; Blacklight uses #to_s on your\n" +
-          "  # user class to get a user-displayable login/identifier for\n" +
-          "  # the account.\n" +
-          "  def to_s\n" +
-          "    email\n" +
-          "  end\n"
-        end
-        gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")
-      end
-    end
-
     # Copy all files in templates/config directory to host config
     def create_configuration_files
-      copy_file "config/solr.yml", "config/solr.yml"
+      copy_file "config/blacklight.yml", "config/blacklight.yml"
     end
 
 
@@ -64,25 +24,5 @@ This generator makes the following changes to your application:
     end
 
 
-    # Add Blacklight to the user model
-    def inject_blacklight_user_behavior
-      file_path = "app/models/#{model_name.underscore}.rb"
-      if File.exists?(file_path)
-        inject_into_class file_path, model_name.classify do
-          "\n  if Blacklight::Utils.needs_attr_accessible?\n" +
-          "\n    attr_accessible :email, :password, :password_confirmation" +
-          "\n  end\n" +
-            "# Connects this user object to Blacklights Bookmarks. " +
-            "\n  include Blacklight::User\n"
-        end
-      else
-        say_status("warning", "Blacklight authenticated user functionality not installed, as a user model could not be found at /app/models/user.rb. If you used a different name, please re-run the migration and provide that name as an argument. Such as `rails -g blacklight client`", :yellow)
-      end
-    end
-
-    def create_solr_document
-      copy_file "solr_document.rb", "app/models/solr_document.rb"
-    end
-
   end
 end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -1,11 +1,10 @@
 # -*- encoding : utf-8 -*-
-#
-class CatalogController < ApplicationController  
+class <%= controller_name.classify %>Controller < ApplicationController  
 
   include Blacklight::Catalog
 
   configure_blacklight do |config|
-    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
+    ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
     config.default_solr_params = { 
       :qt => 'search',
       :rows => 10 
@@ -17,7 +16,7 @@ class CatalogController < ApplicationController
     # items to show per page, each number in the array represent another option to choose from.
     #config.per_page = [10,20,50,100]
 
-    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or 
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SearchHelper#solr_doc_params) or
     ## parameters included in the Blacklight-jetty document requestHandler.
     #
     #config.default_document_solr_params = {

data/lib/generators/blacklight/templates/config/{solr.yml → blacklight.yml}

@@ -11,8 +11,11 @@
 # how to start up solr, generally for automated testing. 
 
 development:
+  adapter: solr
   url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>
 test: &test
+  adapter: solr
   url: <%= "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8888}/solr/blacklight-core" %>
 production:
+  adapter: solr
   url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>