blacklight-spotlight 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08801de0ceb8e82515d08ceaad4bab28feb4abaf
-  data.tar.gz: c3d7458402364cad94982cfac35232f036ec2b0c
+  metadata.gz: 0fca6298cd0b33b7047e4476caa703812750e677
+  data.tar.gz: 6eb41f57205d58a1728cfa00a12d65132762644a
 SHA512:
-  metadata.gz: 66909d964b55ce89b690f17232abc66a25f68900dcf1a52b79834d545fc5bf37bf437d13c58816af1e8dda25227384bfc1903dc713aadd8ab058a8f623759e00
-  data.tar.gz: c8dee63a79069cd5c797c94c5a9e9dcfd3576ff8882f7d04ef5e63343a384866f9402f6fe462b8abbd4e28bdb712a1708bc5fba06f6d95b4b4bc20fc090e7009
+  metadata.gz: 74e40b060f9ff6840fc5a8d3a6f6b0f9fba7a2dd44d38d42121a1311eee5281448e4205498f9801d7627d7a0d1bf363f11a085cde8caa39e1783db5b4c0d72cb
+  data.tar.gz: be19923238f9a87ee0717ccdd04261571c7757dbd62d413c3042cd6eb88246582b4f1a01e3a7dd66d0b08303fae41dfb62bff91d571ace2c0e18286aec939294

data/README.md

@@ -9,10 +9,10 @@ Read more about what Spotlight is, our motivations for creating it, and how to i
 
 ## Requirements
 
-1. Ruby (2.0.0 or greater)
+1. Ruby (2.2.0 or greater)
 2. Rails (4.2.0 or greater)
-3. Java (7 or greater) *for solr*
-4. ImageMagick
+3. Java (7 or greater) *for Solr*
+4. ImageMagick (http://www.imagemagick.org/script/index.php) due to [carrierwave](https://github.com/carrierwaveuploader/carrierwave#adding-versions)
 
 ## Installation
 
@@ -67,16 +67,30 @@ Spotlight introduces functionality that depends on being able to send emails to
 
 See the [Spotlight wiki](https://github.com/sul-dlss/spotlight/wiki) for more detailed information on configuring Spotlight.
 
-## To start the development/test application
+# Developing Spotlight
 
- 1. Clone this repo, `cd` in and run `$ bundle install`
- 2. Start jetty and the dev server: `$ bundle exec rake spotlight:server` (this task will build a Spotlight-based application, start Solr, and run the built-in rails server)
- 3. Visit [http://localhost:3000](http://localhost:3000)
+Spotlight:
+
+* is a Rails engine and needs to be used in the context of a Rails application. We use [engine_cart](https://github.com/cbeer/engine_cart) to create an internal test application at spec/internal.
+* uses Solr as part of its integration tests. We use [jettywrapper](https://github.com/projecthydra/jettywrapper) to manage the Solr instance used for development and test.
+
+Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing rails app automatically.
+
+##  More Information for Developers
+
+* [Contributing to Spotlight](https://github.com/sul-dlss/spotlight/wiki/Contributing-to-Spotlight)
+* [Testing](https://github.com/sul-dlss/spotlight/wiki/Testing)
 
 ## Tests
 
-Run tests:
+### Prerequisites
+
+PhantomJS (https://github.com/teampoltergeist/poltergeist#installing-phantomjs) is an addition requirement for testing javascript.
+
+### Run all the tests:
 
 ```
 $ rake
 ```
+
+This utilizes Solr and the testing rails app automatically.

data/Rakefile

@@ -4,13 +4,13 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
+ZIP_URL = 'https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip'
 
 require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Spotlight'
+  rdoc.title = 'Spotlight'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
@@ -21,6 +21,9 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
 require 'jettywrapper'
 
 require 'engine_cart/rake_task'
@@ -28,91 +31,89 @@ EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 require 'spotlight/version'
 
-task :ci => ['engine_cart:generate', 'jetty:clean', 'spotlight:configure_jetty'] do
-  ENV['environment'] = "test"
+task ci: ['engine_cart:generate', 'jetty:clean', 'spotlight:configure_jetty'] do
+  ENV['environment'] = 'test'
   jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait]= 60
+  jetty_params[:startup_wait] = 60
 
   Jettywrapper.wrap(jetty_params) do
-    Rake::Task["spotlight:fixtures"].invoke
+    Rake::Task['spotlight:fixtures'].invoke
 
     # run the tests
-    Rake::Task["spec"].invoke
+    Rake::Task['spec'].invoke
   end
 end
 
-
 namespace :spotlight do
-  desc "Copies the default SOLR config for the bundled Testing Server"
+  desc 'Copies the default SOLR config for the bundled Testing Server'
   task :configure_jetty do
-    FileList['solr_conf/conf/*'].each do |f|  
-      cp("#{f}", 'jetty/solr/blacklight-core/conf/', :verbose => true)
+    FileList['solr_conf/conf/*'].each do |f|
+      cp("#{f}", 'jetty/solr/blacklight-core/conf/', verbose: true)
     end
   end
 
-  desc "Load fixtures"
-  task :fixtures => ['engine_cart:generate'] do
+  desc 'Load fixtures'
+  task fixtures: ['engine_cart:generate'] do
     within_test_app do
-      system "rake spotlight_test:solr:seed RAILS_ENV=test"
-      abort "Error running fixtures" unless $?.success?
+      system 'rake spotlight_test:solr:seed RAILS_ENV=test'
+      abort 'Error running fixtures' unless $?.success?
     end
   end
 
+  desc 'Start the test application for Spotlight'
   task :server do
     Rake::Task['engine_cart:generate'].invoke
 
-    unless File.exists? 'jetty'
+    unless File.exist? 'jetty'
       Rake::Task['jetty:clean'].invoke
       Rake::Task['spotlight:configure_jetty'].invoke
     end
 
     jetty_params = Jettywrapper.load_config
-    jetty_params[:startup_wait]= 60
+    jetty_params[:startup_wait] = 60
 
     Jettywrapper.wrap(jetty_params) do
       within_test_app do
-        unless File.exists? '.initialized'
-          system "bundle exec rake spotlight:initialize"
-          system "bundle exec rake spotlight_test:solr:seed"
-          File.open('.initialized', "w") {}
+        unless File.exist? '.initialized'
+          system 'bundle exec rake spotlight:initialize'
+          system 'bundle exec rake spotlight_test:solr:seed'
+          File.open('.initialized', 'w') {}
         end
-        system "bundle exec rails s"
+        system 'bundle exec rails s'
       end
     end
   end
-  
+
   namespace :template do
+    desc 'Start a brand new Spotlight application using the Rails template'
     task :server do
       require 'tmpdir'
       require 'fileutils'
-      template_path = File.expand_path(File.join(File.dirname(__FILE__), "template.rb"))
+      template_path = File.expand_path(File.join(File.dirname(__FILE__), 'template.rb'))
 
       Dir.mktmpdir do |dir|
-
         Dir.chdir(dir) do
           Bundler.with_clean_env do
-            version = if Gem.loaded_specs["rails"]
-              "_#{Gem.loaded_specs["rails"].version}_"
-            end
+            version = "_#{Gem.loaded_specs['rails'].version}_" if Gem.loaded_specs['rails']
 
             Bundler.with_clean_env do
-              IO.popen({"SPOTLIGHT_GEM" => File.dirname(__FILE__)}, ["rails", version, "new", "internal", "--skip-spring", "-m", template_path] + [err: [:child, :out]]) do |io|
-                IO.copy_stream(io,$stderr)
-                
+              IO.popen({ 'SPOTLIGHT_GEM' => File.dirname(__FILE__) },
+                       ['rails', version, 'new', 'internal', '--skip-spring', '-m', template_path] +
+                          [err: [:child, :out]]) do |io|
+                IO.copy_stream(io, $stderr)
+
                 _, exit_status = Process.wait2(io.pid)
 
-                if exit_status != 0
-                  raise "Failed to generate spotlight"
-                end
+                fail 'Failed to generate spotlight' if exit_status != 0
               end
             end
-            
+
             Bundler.with_clean_env do
-              Dir.chdir("internal") do
+              Dir.chdir('internal') do
                 APP_ROOT = Dir.pwd
-                jetty_params = Jettywrapper.load_config   
+                jetty_params = Jettywrapper.load_config
                 Jettywrapper.wrap(jetty_params) do
-                  system "bundle exec rails s"
+                  system 'bundle exec rails s'
                 end
               end
             end
@@ -123,4 +124,4 @@ namespace :spotlight do
   end
 end
 
-task default: :ci
+task default: [:ci, :rubocop]

data/app/assets/javascripts/spotlight/blacklight_configuration.js

@@ -1,6 +1,7 @@
 Spotlight.onLoad(function() {
   // Add Select/Deselect all button behavior
   addCheckboxToggleBehavior();
+  addEnableToggleBehavior();
 });
 
 // Add Select/Deselect all button behavior
@@ -44,4 +45,19 @@ function addCheckboxToggleBehavior() {
       button.text(button.data('select-text'));
     }
   }
+}
+
+function addEnableToggleBehavior() {
+  $("[data-behavior='enable-feature']").each(function(){
+    var checkbox = $(this);
+    var target = $($(this).data('target'));
+
+    checkbox.on('change', function() {
+      if ($(this).is(':checked')) {
+        target.find('input:checkbox').not("[data-behavior='enable-feature']").prop('checked', true).attr('disabled', false);
+      } else {
+        target.find('input:checkbox').not("[data-behavior='enable-feature']").prop('checked', false).attr('disabled', true);
+      }
+    });
+  });
 }

data/app/assets/javascripts/spotlight/blocks/resources_block.js

@@ -19,8 +19,10 @@ Spotlight.Block.Resources = (function(){
 
     display_checkbox: "display-checkbox",
 
+    globalIndex: 0,
+
     _itemPanel: function(data) {
-      var index = data.id || this.$('.field').length;
+      var index = "item_" + this.globalIndex++;
       var checked;
       if (data.display == "true") {
         checked = "checked='checked'"

data/app/assets/stylesheets/spotlight/_blacklight_configuration.scss

@@ -64,11 +64,11 @@
   }
 }
 
-.disabled-sort-option {
+.disabled-sort-option, .disabled-search-option {
   .panel {margin-bottom: 0;}
 }
 
-.sort_fields_admin {
+.sort_fields_admin, .search_fields_admin {
   .panel-title {
     display: inline;
   }

data/app/assets/stylesheets/spotlight/_blacklight_overrides.scss

@@ -0,0 +1,24 @@
+.submit-search-text {
+  @extend .sr-only;
+}
+
+.search-query-form {
+  z-index: 1;
+
+  .input-group {
+    width: 100%;
+  }
+
+  .input-group-addon {
+    &.for-search-field {
+      background-color: $input-bg;
+      border-radius: $border-radius-base 0 0 $border-radius-base;
+      width: 15ch;
+    }
+  }
+
+  .search_field {
+    background: transparent;
+    border: none;
+  }
+}

data/app/assets/stylesheets/spotlight/_header.scss

@@ -1,5 +1,7 @@
-$masthead-height: 120px;
+$masthead-height: 180px;
 $masthead-image-blur: 1px;
+$menu-link-background-color-active: rgba(255, 255, 255, 0.3);
+$menu-link-background-color-hover: rgba(255, 255, 255, 0.15);
 
 @mixin masthead-background-containers() {
   position: absolute;
@@ -10,25 +12,92 @@ $masthead-image-blur: 1px;
   height: inherit;
 }
 
-#exhibit-masthead, #exhibit-navbar {
+@mixin masthead-navigation-menu() {
+  border: 0;
+  border-radius: 0;
+
+  ul.nav.navbar-nav {
+    > li {
+      text-transform: uppercase;
+
+      a {
+        color: $gray-lighter;
+        letter-spacing: 1.2px;
+      }
+    }
+
+    a:hover {
+      background-color: $menu-link-background-color-hover;
+    }
+
+    > .active > a {
+      background-color: $menu-link-background-color-active;
+      color: $white;
+    }
+
+    .dropdown-menu {
+      text-transform: none;
+
+      > li a {
+        color: $black;
+
+        &:hover {
+          background-color: $gray-lighter;
+        }
+      }
+    }
+  }
+
+  // Curated Features menu link when it has dropdown menu
+  .navbar-nav > .open > a,
+  .navbar-nav > .open > a:hover,
+  .navbar-nav > .open > a:focus {
+    background-color: $menu-link-background-color-hover;
+  }
+}
+
+#exhibit-masthead,
+#exhibit-navbar {
   z-index: 1;
 }
 
 #exhibit-navbar {
+  z-index: 100;
+
   &.page-masthead {
-    background-color: $gray;
+    @include masthead-navigation-menu();
+    background-color: rgba(0, 0, 0, 0.5);
+    border-bottom: 1px solid $gray;
     margin-bottom: 0;
-    border: 0;
-    border-radius: 0;
+    margin-top: 0;
+
     .navbar-nav {
       float: right;
     }
-    .navbar-brand, .navbar-nav li {
+
+    .navbar-brand,
+    .navbar-nav li {
       color: $gray-lighter;
-      &.active a {color: $gray;}
-      a {color: $gray-lighter;}
+
+      &.active a {
+        color: $gray;
+      }
+
+      a {
+        color: $gray-lighter;
+      }
     }
   }
+
+  .navbar-form {
+    text-align: right;
+  }
+}
+
+#exhibit-masthead.with-image + #exhibit-navbar.navbar-default {
+  @include masthead-navigation-menu();
+  background-color: rgba(0, 0, 0, 0.2);
+  border-top: 1px solid $gray;
 }
 
 .navbar + .navbar {
@@ -40,30 +109,44 @@ $masthead-image-blur: 1px;
 }
 
 #exhibit-masthead {
-  margin-bottom: 0;
-  padding: 0 0 24px 0;
-  position: static;
   height: $masthead-height;
+  margin-bottom: -50px;
+  padding: 0;
+  position: static;
+
   & > .container {
-    // Maintains the site title and subtitle at slightly below
-    // vertically-centered, even if height of masthead is changed.
     position: relative;
-    top: 60%;
+    top: 33%;
     -webkit-transform: translateY(-50%);
     transform: translateY(-50%);
   }
+
   &.with-page-masthead {
     margin-bottom: $padding-base-vertical;
+    margin-top: -51px;
+
+    > .container {
+      top: 60%;
+    }
+
+    .navbar-brand {
+      font-size: $font-size-large;
+      text-shadow: 1px 1px 0 $black;
+    }
+
     .search-title {
       text-align: center;
+
       small {
-        text-transform: uppercase ;
+        text-transform: uppercase;
       }
     }
   }
+
   .site-title {
     font-size: 30px;
   }
+
   small {
     display: block;
     padding-top: $padding-base-vertical;
@@ -71,49 +154,59 @@ $masthead-image-blur: 1px;
   }
 
   &.with-image {
-    .site-title, .search-title {
+    .site-title,
+    .search-title {
       color: $white;
-      text-shadow: 0 1px 0 $black;
+      text-shadow: 1px 1px 0 $black;
     }
+
     small {
       color: $white;
     }
-  }
 
-  .more-exhibits {
-    @extend .navbar-right;
-  }
+    .more-exhibits {
+      a {
+        color: $gray-lighter;
+        background: rgba(0, 0, 0, 0.4);
+        border-top-left-radius: $border-radius-base;
+        border-top-right-radius: $border-radius-base;
+      }
 
-  &.with-image .more-exhibits {
-    a {
-      color: $gray-lighter;
-      background: rgba(0, 0, 0, 0.4);
-      border-top-left-radius: $border-radius-base;
-      border-top-right-radius: $border-radius-base;
-    }
-    a:hover, a:focus, a:active {
-      background: rgba(0, 0, 0, 0.6);
-    }
+      a:hover,
+      a:focus,
+      a:active {
+        background: rgba(0, 0, 0, 0.6);
+      }
 
-    .dropdown-menu a {
-      background: none;
-      color: $gray;
-      &:hover, &:focus, &:active {
-        background-color: $gray-lighter;
+      .dropdown-menu a {
+        background: none;
+        color: $gray;
+
+        &:hover,
+        &:focus,
+        &:active {
+          background-color: $gray-lighter;
+        }
       }
     }
   }
 
+  .more-exhibits {
+    @extend .navbar-right;
+  }
+
   &.with-page-masthead {
-    .site-title {margin-top: $padding-large-vertical * 3;}
+    .site-title {
+      margin-top: $padding-large-vertical * 3;
+    }
 
     .more-exhibits {
       @extend .navbar-left;
       padding-top: $padding-base-vertical;
 
       .dropdown-menu {
-        right: auto;
         left: 0;
+        right: auto;
       }
     }
   }
@@ -135,6 +228,7 @@ $masthead-image-blur: 1px;
     // Add right border to image to hide lighter blurred edge
     border-right: 1px solid $black;
   }
+
   // Include gradient to improve text legibility,
   // especially on light background images.
   .background-container-gradient {
@@ -148,19 +242,28 @@ $masthead-image-blur: 1px;
   }
 }
 
+// Margin between bottom of masthead and start of page content.
+// Need to apply bottom margin to different element, depending on
+// whether it is a regular masthead or a browse category masthead
+#exhibit-masthead + #exhibit-navbar,
+#exhibit-navbar + #exhibit-masthead {
+  margin-bottom: $padding-large-vertical * 2.5;
+}
+
 .col-md-4 {
   .submit-search-text {
     // hide 'search' label
-      // copied from .sr-only, sadly can't seem to use @extend in a media
-      // query like this, have to copy.
-      position: absolute;
-      width: 1px;
-      height: 1px;
-      margin: -1px;
-      overflow: hidden;
-      clip: rect(0,0,0,0);
-      border: 0;
+    // copied from .sr-only, sadly can't seem to use @extend in a media
+    // query like this, have to copy.
+    border: 0;
+    clip: rect(0, 0, 0, 0);
+    height: 1px;
+    margin: -1px;
+    overflow: hidden;
+    position: absolute;
+    width: 1px;
   }
+
   .glyphicon-search {
     line-height: $line-height-computed;
   }