blacklight 6.0.0.pre3 → 6.0.0.pre4

data/app/views/catalog/_document.html.erb

@@ -1,4 +1,4 @@
 <% # container for a single doc -%>
-<div class="document <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
+<div class="document <%= render_document_class document %> document-position-<%= document_counter%> " data-document-counter="<%= document_counter %>" itemscope itemtype="<%= document.itemtype %>">
   <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, :document_counter => document_counter %>
 </div>

data/app/views/catalog/_document_default.atom.builder

@@ -3,7 +3,7 @@ xml.entry do
   xml.title presenter(document).render_document_index_label(document_show_link_field(document))
   
   # updated is required, for now we'll just set it to now, sorry
-  xml.updated Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")
+  xml.updated Time.current.iso8601
   
   xml.link    "rel" => "alternate", "type" => "text/html", "href" => polymorphic_url(url_for_document(document))
   # add other doc-specific formats, atom only lets us have one per
@@ -50,6 +50,4 @@ xml.entry do
     end
     
   end
-  
-  
-end
+end

data/app/views/catalog/facet.json.jbuilder

@@ -0,0 +1,3 @@
+json.response do
+  json.facets @pagination
+end

data/app/views/catalog/index.atom.builder

@@ -43,7 +43,7 @@ xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
   
   
   # updated is required, for now we'll just set it to now, sorry
-  xml.updated Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")
+  xml.updated Time.current.iso8601
   
   @document_list.each_with_index do |document, document_counter|
     xml << Nokogiri::XML.fragment(render_document_partials(document, blacklight_config.view_config(:atom).partials, document_counter: document_counter))

data/app/views/catalog/index.json.jbuilder

@@ -0,0 +1,6 @@
+json.response do
+  json.docs @presenter.documents
+  json.facets @presenter.search_facets_as_json
+  json.pages @presenter.pagination_info
+end
+

data/app/views/layouts/blacklight.html.erb

@@ -35,7 +35,7 @@
 
   <%= render partial: 'shared/ajax_modal' %>
 
-  <div id="main-container" class="container">
+  <div id="main-container" class="<%= container_classes %>">
     <%= content_tag :h1, application_name, class: 'sr-only application-heading' %>
 
     <%= render :partial=>'/flash_msg', layout: 'shared/flash_messages' %>

data/app/views/shared/_header_navbar.html.erb

@@ -1,5 +1,5 @@
 <div id="header-navbar" class="navbar navbar-inverse navbar-static-top" role="navigation">
-  <div class="container">
+  <div class="<%= container_classes %>">
     <div class="navbar-header">
     <button type="button" class="navbar-toggle btn collapsed" data-toggle="collapse" data-target="#user-util-collapse">
       <span class="sr-only">Toggle navigation</span>
@@ -17,7 +17,7 @@
 </div>
 
 <div id="search-navbar" class="navbar navbar-default navbar-static-top" role="navigation">
-  <div class="container">
+  <div class="<%= container_classes %>">
     <%= render_search_bar  %>
   </div>
 </div>

data/blacklight.gemspec

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), "lib/blacklight/version")
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blacklight/version'
 
 Gem::Specification.new do |s|
   s.name        = "blacklight"
@@ -12,11 +14,14 @@ Gem::Specification.new do |s|
   s.description = %{Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata.}
   s.license     = "Apache 2.0"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '~> 2.0'
+
   s.add_dependency "rails",     ">= 4.1", "< 5"
   s.add_dependency "globalid"
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser

data/db/migrate/20140202020201_create_searches.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class CreateSearches < ActiveRecord::Migration
   def self.up
     create_table :searches do |t|
@@ -6,7 +5,7 @@ class CreateSearches < ActiveRecord::Migration
       t.integer :user_id
       t.string :user_type
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :searches, :user_id

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class CreateBookmarks < ActiveRecord::Migration
   def self.up
     create_table :bookmarks do |t|
@@ -6,7 +5,7 @@ class CreateBookmarks < ActiveRecord::Migration
       t.string :user_type
       t.string :document_id
       t.string :title
-      t.timestamps
+      t.timestamps null: false
     end
   end
 

data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class AddPolymorphicTypeToBookmarks < ActiveRecord::Migration
   def change
     add_column(:bookmarks, :document_type, :string)

data/lib/blacklight.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'kaminari'
 require 'deprecation'
 require 'blacklight/utils'
@@ -17,15 +16,6 @@ module Blacklight
 
   require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
-  
-  class << self
-    attr_accessor :solr, :solr_config
-  end
-
-  # Secret key used to share session information with
-  # other services (e.g. refworks callback urls)
-  mattr_accessor :secret_key
-  @@secret_key = nil
 
   def self.blacklight_config_file
     "#{::Rails.root}/config/blacklight.yml"

data/lib/blacklight/configuration.rb

@@ -15,7 +15,6 @@ module Blacklight
     # XXX this isn't very pretty, but it works.
     require_dependency 'blacklight/configuration/fields'
     require_dependency 'blacklight/configuration/field'
-    require_dependency 'blacklight/configuration/solr_field'
     require_dependency 'blacklight/configuration/search_field'
     require_dependency 'blacklight/configuration/facet_field'
     require_dependency 'blacklight/configuration/sort_field'

data/lib/blacklight/engine.rb

@@ -25,14 +25,6 @@ module Blacklight
         end
       end
     end
-    
-    initializer "blacklight.secret_key" do |app|
-      if app.respond_to?(:secrets)
-        Blacklight.secret_key ||= app.secrets.secret_key_base
-      elsif app.config.respond_to?(:secret_key_base)
-        Blacklight.secret_key ||= app.config.secret_key_base
-      end
-    end
 
     Blacklight::Engine.config.sms_mappings = {
       'Virgin' => 'vmobl.com',

data/lib/blacklight/exceptions.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight
   module Exceptions
 

data/lib/blacklight/routes.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight
   module Routes
     require 'blacklight/routes/exportable'

data/lib/blacklight/version.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight
   unless Blacklight.const_defined? :VERSION
     def self.version

data/lib/generators/blacklight/assets_generator.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight
   class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)

data/lib/generators/blacklight/install_generator.rb

@@ -7,6 +7,7 @@ module Blacklight
     argument     :controller_name, type: :string , default: "catalog"
     argument     :document_name, type: :string , default: "solr_document"
     argument     :search_builder_name, type: :string , default: "search_builder"
+    argument     :solr_version, type: :string , default: "latest"
 
     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"
@@ -15,7 +16,7 @@ module Blacklight
     desc """
   This generator makes the following changes to your application:
    1. Generates blacklight:models
-   2. Adds rsolr to the Gemfile
+   2. Generates utilities for working with solr 
    3. Adds globalid to the Gemfile
    4. Creates a number of public assets, including images, stylesheets, and javascript
    5. Injects behavior into your user application_controller.rb
@@ -25,19 +26,12 @@ module Blacklight
   Thank you for Installing Blacklight.
          """
 
-    def install_jettywrapper
-      return unless options[:jettywrapper]
-      gem "jettywrapper", ">= 2.0"
-
-      copy_file "config/jetty.yml"
-
-      append_to_file "Rakefile",
-        "\nZIP_URL = \"https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.3.zip\"\n" +
-        "require 'jettywrapper'\n"
-    end
-
-    def add_rsolr_gem
-      gem "rsolr", "~> 1.0.6"
+    def add_solr_wrapper
+      if solr_version == 'latest'
+        generate 'blacklight:solr5'
+      else
+        generate "blacklight:solr#{solr_version}"
+      end
     end
 
     def add_globalid_gem

data/lib/generators/blacklight/solr4_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+module Blacklight
+  class Solr4Generator < Rails::Generators::Base
+    desc """
+This generator makes the following changes to your application:
+ 1. Installs jettywrapper into your application
+ 2. Adds rsolr to your Gemfile
+"""
+
+    def install_jettywrapper
+      return unless options[:jettywrapper]
+      gem "jettywrapper", ">= 2.0"
+
+      copy_file "config/jetty.yml"
+
+      append_to_file "Rakefile",
+        "\nZIP_URL = \"https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip\"\n" +
+        "require 'jettywrapper'\n"
+    end
+
+    def add_rsolr_gem
+      gem "rsolr", "~> 1.0.6"
+    end
+
+  end
+end

data/lib/generators/blacklight/solr5_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+module Blacklight
+  class Solr5Generator < Rails::Generators::Base
+    desc <<-EOF
+      This generator makes the following changes to your application:
+       1. Installs solr_wrapper into your application
+       2. Adds rsolr to your Gemfile
+    EOF
+
+    def install_solrwrapper
+      gem 'solr_wrapper', '>= 0.3' 
+   
+      append_to_file "Rakefile", "\nrequire 'solr_wrapper/rake_task'\n"
+    end
+
+    def add_rsolr_gem
+      gem 'rsolr', '~> 1.0.6'
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class AlternateController < CatalogController  
   configure_blacklight do |config|
     config.index.thumbnail_method = :xyz

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class <%= controller_name.classify %>Controller < ApplicationController
 
   include Blacklight::Catalog
@@ -69,9 +68,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_facet']
 
     config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
-       :years_5 => { label: 'within 5 Years', fq: "pub_date:[#{Time.now.year - 5 } TO *]" },
-       :years_10 => { label: 'within 10 Years', fq: "pub_date:[#{Time.now.year - 10 } TO *]" },
-       :years_25 => { label: 'within 25 Years', fq: "pub_date:[#{Time.now.year - 25 } TO *]" }
+       :years_5 => { label: 'within 5 Years', fq: "pub_date:[#{Time.zone.now.year - 5 } TO *]" },
+       :years_10 => { label: 'within 10 Years', fq: "pub_date:[#{Time.zone.now.year - 10 } TO *]" },
+       :years_25 => { label: 'within 25 Years', fq: "pub_date:[#{Time.zone.now.year - 25 } TO *]" }
     }
 
 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class <%= model_name.classify %> 
 
   include Blacklight::Solr::Document

data/lib/generators/blacklight/test_support_generator.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # Copy Blacklight test support material in place
 
 

data/lib/railties/blacklight.rake

@@ -22,13 +22,6 @@ namespace :blacklight do
     end
   end
 
-  namespace :solr do
-    task :seed do
-      Deprecation.warn Blacklight, "blacklight:solr:seed is deprecated; use blacklight:index:seed instead"
-      Rake::Task['blacklight:index:seed'].invoke
-    end
-  end
-
   namespace :check do
     desc "Check the Solr connection and controller configuration"
     task :solr, [:controller_name] => [:environment] do |_, args|

data/provision.sh

@@ -1,14 +1,24 @@
 #!/usr/bin/env bash
+
+# This script is used by the Vagrant file to provision the box
+
+# Install server dependencies
 sudo yum install -y epel-release
-sudo yum install -y curl git java-1.7.0-openjdk-devel nodejs yum-utils gcc bzip2 kernel-devel dkms
+sudo yum install -y curl git java-1.8.0-openjdk-devel nodejs yum-utils gcc bzip2 kernel-devel dkms
 
+# Install RVM and Ruby
 su - vagrant -c 'gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3'
 su - vagrant -c 'curl -sSL https://get.rvm.io | bash -s stable'
 su - vagrant -c 'rvm 2.2.3 --install --default'
+
+# Install bundler gem and bundle install
 su - vagrant -c 'gem install bundler'
 su - vagrant -c 'cd /home/vagrant/sync && bundle install'
+
+# Create the test application
 su - vagrant -c 'cd /home/vagrant/sync && rake engine_cart:generate'
 
+# Output some instructions on what to do next
 echo "
 Now to start Solr and Blacklight run the following from within the Blacklight directory:
 

data/spec/controllers/blacklight/search_helper_spec.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'spec_helper'
 
 # check the methods that do solr requests. Note that we are not testing if

data/spec/controllers/bookmarks_controller_spec.rb

@@ -43,5 +43,30 @@ describe BookmarksController do
       expect(response.code).to eq "500"
     end
   end
-  
+
+  describe 'token based users' do
+    let(:user) { User.find_or_create_by(email: 'user1@example.com') { |u| u.password = 'password' } }
+    let(:current_time) { nil }
+    let(:token) { controller.send(:encrypt_user_id, user.id, current_time) }
+
+    before do
+      allow(controller).to receive(:fetch).and_return([])
+    end
+
+    it 'finds the user from the encrypted token' do
+      get :index, encrypted_user_id: token
+      expect(controller.send(:token_user).id).to eq user.id
+    end
+
+    context 'created over an hour ago' do
+      let(:current_time) { Time.zone.now - 2.hours }
+
+      it 'is expired' do
+        get :index, encrypted_user_id: token
+        expect do
+          controller.send(:token_user)
+        end.to raise_error(Blacklight::Exceptions::ExpiredSessionToken)
+      end
+    end
+  end
 end

data/spec/controllers/catalog_controller_spec.rb

@@ -119,6 +119,7 @@ describe CatalogController do
     end
 
     describe "with format :json" do
+      render_views
       before do
         get :index, :format => 'json'
         expect(response).to be_success
@@ -128,18 +129,18 @@ describe CatalogController do
       let(:docs) { json["docs"] }
       let(:facets) { json["facets"] }
 
-      it "should get the pages" do
-        expect(pages["total_count"]).to eq 30 
+      it "gets the pages" do
+        expect(pages["total_count"]).to eq 30
         expect(pages["current_page"]).to eq 1
         expect(pages["total_pages"]).to eq 3
       end
 
-      it "should get the documents" do
+      it "gets the documents" do
         expect(docs).to have(10).documents
         expect(docs.first.keys).to match_array(["published_display", "author_display", "lc_callnum_display", "pub_date", "subtitle_display", "format", "material_type_display", "title_display", "id", "subject_topic_facet", "language_facet", "score"])
       end
 
-      it "should get the facets" do
+      it "gets the facets" do
         expect(facets).to have(9).facets
         expect(facets.first).to eq({"name"=>"format", "label" => "Format", "items"=>[{"value"=>"Book", "hits"=>30, "label"=>"Book"}]})
       end
@@ -147,7 +148,7 @@ describe CatalogController do
       describe "facets" do
         let(:query_facet_items) { facets.last['items'] }
         let(:regular_facet_items) { facets.first['items'] }
-        it "should have items with labels and values" do
+        it "has items with labels and values" do
           expect(query_facet_items.first['label']).to eq 'within 10 Years'
           expect(query_facet_items.first['value']).to eq 'years_10'
           expect(regular_facet_items.first['label']).to eq "Book"
@@ -562,7 +563,8 @@ describe CatalogController do
       end
     end
     describe "requesting json" do
-      it "should be successful" do
+      render_views
+      it "is successful" do
         get :facet, id: 'format', format: 'json'
         expect(response).to be_successful
         json = JSON.parse(response.body)
@@ -571,35 +573,6 @@ describe CatalogController do
     end
   end
 
-  describe 'render_search_results_as_json' do
-    before do
-      controller.instance_variable_set :@document_list, [{id: '123', title_t: 'Book1'}, {id: '456', title_t: 'Book2'}]
-      allow(controller).to receive(:pagination_info).and_return({current_page: 1, next_page: 2, prev_page: nil})
-      allow(controller).to receive(:search_facets_as_json).and_return(
-          [{name: "format", label: "Format", items: [{value: 'Book', hits: 30, label: 'Book'}]}])
-    end
-
-    it "should be a hash" do
-       expect(controller.send(:render_search_results_as_json)).to eq (
-         {response: {docs: [{id: '123', title_t: 'Book1'}, {id: '456', title_t: 'Book2'}],
-                     facets: [{name: "format", label: "Format", items: [{value: 'Book', hits: 30, label: 'Book'}]}],
-                     pages: {current_page: 1, next_page: 2, prev_page: nil}}}
-       )
-    end
-  end
-
-  describe 'render_facet_list_as_json' do
-    before do
-      controller.instance_variable_set :@pagination, {items: [{value: 'Book'}]}
-    end
-
-    it "should be a hash" do
-       expect(controller.send(:render_facet_list_as_json)).to eq (
-         {response: {facets: {items: [{value: 'Book'}]}}}
-       )
-    end
-  end
-
   describe "#add_to_search_history" do
     it "should prepend the current search to the list" do
       session[:history] = []