blacklight 6.25.0 → 7.0.0.rc1

data/spec/views/catalog/index.json.jbuilder_spec.rb

@@ -1,30 +1,75 @@
 # frozen_string_literal: true
-describe "catalog/index.json" do
-  let(:response) { instance_double(Blacklight::Solr::Response) }
-  let(:docs) { [{ id: '123', title_t: 'Book1' }, { id: '456', title_t: 'Book2' }] }
+RSpec.describe "catalog/index.json" do
+  let(:response) { instance_double(Blacklight::Solr::Response, documents: docs, prev_page: nil, next_page: 2, total_pages: 3) }
+  let(:docs) { [SolrDocument.new(id: '123', title_tsim: 'Book1'), SolrDocument.new(id: '456', title_tsim: 'Book2')] }
   let(:facets) { double("facets") }
-  let(:config) { instance_double(Blacklight::Configuration) }
-  let(:presenter) { Blacklight::JsonPresenter.new(response, docs, facets, config) }
+  let(:config) { Blacklight::Configuration.new }
+  let(:presenter) { Blacklight::JsonPresenter.new(response, facets, config) }
 
-  it "renders index json" do
+  let(:hash) do
+    render template: "catalog/index.json", format: :json
+    JSON.parse(rendered).with_indifferent_access
+  end
+
+  before do
+    allow(view).to receive(:blacklight_config).and_return(config)
+    allow(view).to receive(:search_action_path).and_return('http://test.host/some/search/url')
+    allow(view).to receive(:search_facet_path).and_return('http://test.host/some/facet/url')
     allow(presenter).to receive(:pagination_info).and_return({ current_page: 1, next_page: 2,
                                                                prev_page: nil })
     allow(presenter).to receive(:search_facets_as_json).and_return(
-          [{ name: "format", label: "Format",
-             items: [{ value: 'Book', hits: 30, label: 'Book' }] }])
+          [{ 'name' => "format", 'label' => "Format",
+             'items' => [{ 'value' => 'Book', 'hits' => 30, 'label' => 'Book' }] }])
     assign :presenter, presenter
-    render template: "catalog/index.json", format: :json
-    hash = JSON.parse(rendered)
-    expect(hash).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 } }
-                      )
+    assign :response, response
+  end
+
+  it "has pagination links" do
+    expect(hash).to include(links: hash_including(
+      self: 'http://test.host/',
+      next: 'http://test.host/?page=2',
+      last: 'http://test.host/?page=3'))
+  end
+
+  it "has pagination information" do
+    expect(hash).to include(meta: hash_including(pages:
+      {
+        'current_page' =>  1,
+        'next_page' => 2,
+        'prev_page' => nil
+      }))
+  end
+
+  it "includes documents, links, and their attributes" do
+    expect(hash).to include(data: [
+      {
+        id: '123',
+        attributes: { 'id' => '123', 'title_tsim' => 'Book1' },
+        links: { self: 'http://test.host/catalog/123' }
+      },
+      {
+        id: '456',
+        attributes: { 'id' => '456', 'title_tsim' => 'Book2' },
+        links: { self: 'http://test.host/catalog/456' }
+      },
+    ])
+  end
+
+  it "has facet information and links" do
+    expect(hash).to include(:included)
+
+    facets = hash[:included].select { |x| x['type'] == 'facet' }
+    expect(facets).to be_present
+
+    expect(facets.map { |x| x['id'] }).to include 'format'
+
+    format = facets.find { |x| x['id'] == 'format' }
+
+    expect(format['links']).to include self: 'http://test.host/some/facet/url'
+    expect(format['attributes']).to include :items
+
+    format_items = format['attributes']['items'].map { |x| x['attributes'] }
+
+    expect(format_items).to match_array [{value: 'Book', hits: 30, label: 'Book'}]
   end
 end

data/spec/views/catalog/opensearch.xml.builder_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe 'catalog/opensearch.xml.builder' do
+RSpec.describe 'catalog/opensearch.xml.builder' do
   it "renders an OpenSearch description document" do
     render
     doc = Nokogiri::XML.parse(rendered)

data/spec/views/catalog/show.html.erb_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe "catalog/show.html.erb" do
+RSpec.describe "catalog/show.html.erb" do
   let(:document) { SolrDocument.new :id => 'xyz', :format => 'a' }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
@@ -8,7 +8,7 @@ describe "catalog/show.html.erb" do
     allow(view).to receive(:action_name).and_return('show')
     allow(view).to receive_messages(:has_user_authentication_provider? => false)
     allow(view).to receive_messages(:render_document_sidebar_partial => "Sidebar")
-    allow(view).to receive_messages(current_search_session: nil)
+    allow(view).to receive_messages(current_search_session: nil, search_session: {})
     assign :document, document
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
   end

data/spec/views/catalog/sms_success.html.erb_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe "catalog/sms_success.html.erb" do
+
+  it "includes the data-blacklight-modal properties" do
+    render
+    expect(rendered).to have_selector "div[data-blacklight-modal=container]"
+  end
+end

data/spec/views/{_user_util_links.html.erb_spec.rb → shared/_user_util_links.html.erb_spec.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-describe "_user_util_links" do
+RSpec.describe "shared/_user_util_links" do
 
-  let :blacklight_config do
+  let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.navbar.partials = { bookmark: Blacklight::Configuration::ToolConfig.new(partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?) }
     end
@@ -15,8 +15,8 @@ describe "_user_util_links" do
     allow(controller).to receive(:render_bookmarks_control?).and_return true
     allow(view).to receive(:has_user_authentication_provider?).and_return false
     allow(view).to receive_message_chain(:current_or_guest_user, :bookmarks, :count).and_return(count)
-    render :partial => "user_util_links"
-    expect(rendered).to have_selector('#bookmarks_nav span[data-role=bookmark-counter]', text: "#{count}")
+    render "shared/user_util_links"
+    expect(rendered).to have_selector('#bookmarks_nav span.badge[data-role=bookmark-counter]', text: "#{count}")
   end
 
 end

data/tasks/blacklight.rake

@@ -1,5 +1,4 @@
-# frozen_string_literal: true
-
+require 'solr_wrapper'
 require 'engine_cart/rake_task'
 
 require 'rspec/core/rake_task'
@@ -10,42 +9,17 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-require 'solr_wrapper'
-require 'open3'
-
-def system_with_error_handling(*args)
-  Open3.popen3(*args) do |_stdin, stdout, stderr, thread|
-    puts stdout.read
-    raise "Unable to run #{args.inspect}: #{stderr.read}" unless thread.value.success?
-  end
-end
-
-def with_solr(&block)
-  # We're being invoked by the app entrypoint script and solr is already up via docker-compose
-  if ENV['SOLR_ENV'] == 'docker-compose'
-    yield
-  elsif system('docker-compose -v')
-    # We're not running docker-compose up but still want to use a docker instance of solr.
-    begin
-      puts "Starting Solr"
-      system_with_error_handling "docker-compose up -d solr"
-      yield
-    ensure
-      puts "Stopping Solr"
-      system_with_error_handling "docker-compose stop solr"
-    end
-  else
-    SolrWrapper.wrap do |solr|
-      solr.with_collection(&block)
-    end
-  end
-end
+EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 desc "Run test suite"
-task :ci do
-  with_solr do
-    Rake::Task['blacklight:internal:seed'].invoke
-    Rake::Task['blacklight:coverage'].invoke
+task ci: ['blacklight:generate'] do
+  SolrWrapper.wrap(version: '7.1.0') do |solr|
+    solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path("..", File.dirname(__FILE__)), '.internal_test_app', 'solr', 'conf')) do
+      within_test_app do
+        system "RAILS_ENV=test rake blacklight:index:seed"
+      end
+      Rake::Task['blacklight:coverage'].invoke
+    end
   end
 end
 
@@ -56,28 +30,35 @@ namespace :blacklight do
     Rake::Task["spec"].invoke
   end
 
+  desc "Create the test rails app"
+  task generate: ['engine_cart:generate'] do
+  end
+
   namespace :internal do
-    desc 'Index seed data in test app'
     task seed: ['engine_cart:generate'] do
       within_test_app do
-        system "bin/rake blacklight:index:seed"
+        system "bundle exec rake blacklight:index:seed"
       end
     end
   end
 
   desc 'Run Solr and Blacklight for interactive development'
-  task :server, [:rails_server_args] => ['engine_cart:generate'] do |_t, args|
-    with_solr do
-      Rake::Task['blacklight:internal:seed'].invoke
+  task :server, [:rails_server_args] do |_t, args|
+    if File.exist? EngineCart.destination
+      within_test_app do
+        system "bundle update"
+      end
+    else
+      Rake::Task['engine_cart:generate'].invoke
+    end
+
+    SolrWrapper.wrap(port: '8983') do |solr|
+      solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path("..", File.dirname(__FILE__)), "solr", "conf")) do
+        Rake::Task['blacklight:internal:seed'].invoke
 
-      begin
         within_test_app do
-          puts "Starting Blacklight (Rails server)"
-          system "bin/rails s #{args[:rails_server_args]}"
+          system "bundle exec rails s #{args[:rails_server_args]}"
         end
-      rescue Interrupt
-        # We expect folks to Ctrl-c to stop the server so don't barf at them
-        puts "\nStopping Blacklight (Rails server)"
       end
     end
   end

data/template.demo.rb

@@ -1,21 +1,11 @@
 gem "blacklight", ">= 6.1"
-gem "jettywrapper", ">= 2.0"
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
 
 run "bundle install"
 
 # run the blacklight install generator
-options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc --jettywrapper')
+options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc --solr_version=latest')
 
 generate 'blacklight:install', options
 
 # run the database migrations
 rake "db:migrate"
-
-# index some data
-if options =~ /jettywrapper/
-  rake "jetty:clean"
-  rake "jetty:start"
-  rake "blacklight:index:seed"
-  rake "jetty:stop"
-end