blacklight-spotlight 3.5.0.4 → 3.6.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2b5e2ecd48de319a43b16c29e60ab1fcff2936525f54241c8a338eb94f73f3
-  data.tar.gz: 673c1ecde408e6406c34db51e29f00c56364ba999b584e9f68ad4c3849fc86cc
+  metadata.gz: e2927aab38386efc1ea68faecdb9ff77a34627be7043af2af6cdd74138b97c1a
+  data.tar.gz: fed9d37c445c5bcd83322512df975c47e3a7fef417e630ae11400f6585af6156
 SHA512:
-  metadata.gz: f682bd13aa9a3584da448b68da13b45de241d04c42acfa7e45104013c4d0ae666e6927fbdddb9b85364ccaf85634b7d0c35b3f2f86c3096f1c293ebf2821a6bb
-  data.tar.gz: eccb8a8e6fe2caea9986018c2c0524159d7d7862c27d57a0419fc9208f34c0d7c3779e311601cc5f7e6426ad5176a3fb120a17eafe70f0e20b4cb5179f31117d
+  metadata.gz: b172562a48d02cfc9b1733b52dff0a21b2dd242a7d58016357f7d5c762699747b0aa768c89d3b97a3c7b704d3a4d8fd96a3aa76c47ab48f67e8d8660551402a4
+  data.tar.gz: d65ea82b172aa7aea0a580bb1e5239a99d2fe62bc9da1dbe8514f1c54129dfe811271abd87d7099c9198eeaa3e1f82b339b3093e62aebf707bcd06476a32783d

data/README.md

@@ -75,6 +75,14 @@ Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing
 
 See more detailed instructions for development environment setup at ["Contributing to Spotlight"](https://github.com/projectblacklight/spotlight/wiki/Contributing-to-Spotlight)
 
+## With Docker
+
+```sh
+# because of how docker-compose handles named images, running `docker-compose up --build` will error when the Rails images have not been built locally
+docker-compose build
+docker-compose up
+```
+
 ## Tests
 
 ### Run all the tests:
@@ -104,3 +112,15 @@ See [developer-facing instructions for enabling translation](https://github.com/
 - Google Groups
   - [Blacklight Development Google group](https://groups.google.com/forum/#!forum/blacklight-development)
   - [Spotlight Community Group](https://groups.google.com/forum/#!forum/spotlight-community) (equivalent to #spotlight-service)
+
+
+## Building the javascript
+The javascript is built by npm from sources in `app/javascript` into a bundle
+in `app/assets/javascripts/spotlight/spotlight.js`. This file should not be edited
+by hand as any changes would be overwritten.  When any of the javascript
+components in the gem are changed, this bundle should be rebuild with the
+following steps:
+1. [Install npm](https://www.npmjs.com/get-npm)
+1. run `npm install` to download dependencies
+1. run `npm run prepare` to build the bundle
+1. run `npm publish` to push the javascript package to https://npmjs.org/package/spotlight-frontend

data/Rakefile

@@ -34,10 +34,10 @@ task ci: ['engine_cart:generate'] do
   ENV['environment'] = 'test'
 
   SolrWrapper.wrap(port: '8983') do |solr|
-    solr.with_collection(name: 'blacklight-core', dir: File.join(__dir__, 'solr_conf', 'conf')) do
+    solr.with_collection(name: 'blacklight-core', dir: 'lib/generators/spotlight/templates/solr/conf') do
       within_test_app do
         system 'bundle install'
-        system 'bundle exec rake db:migrate'
+        system 'bin/rails db:migrate'
       end
 
       Rake::Task['spotlight:fixtures'].invoke
@@ -62,14 +62,13 @@ namespace :spotlight do
     Rake::Task['engine_cart:generate'].invoke
 
     SolrWrapper.wrap(port: '8983') do |solr|
-      solr.with_collection(name: 'blacklight-core', dir: File.join(__dir__, 'solr_conf', 'conf')) do
+      solr.with_collection(name: 'blacklight-core', dir: 'lib/generators/spotlight/templates/solr/conf') do
         within_test_app do
           unless File.exist? '.initialized'
-            system 'bundle exec rake spotlight:initialize'
-            system 'bundle exec rake spotlight_test:solr:seed'
+            system 'bin/rails spotlight:initialize spotlight_test:solr:seed'
             File.open('.initialized', 'w') {}
           end
-          system 'bundle exec rails s'
+          system 'bin/rails s'
         end
       end
     end
@@ -104,7 +103,7 @@ namespace :spotlight do
                 APP_ROOT = Dir.pwd
                 SolrWrapper.wrap(port: '8983') do |solr|
                   solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path('..', File.dirname(__FILE__)), 'solr', 'conf')) do
-                    system 'bundle exec rails s'
+                    system 'bin/rails s'
                   end
                 end
               end

data/app/assets/config/spotlight/manifest.js

@@ -0,0 +1 @@
+//= link spotlight/blocks/sir-trevor-icons.svg

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

@@ -1,14 +1,14 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require spotlight/user/index
-//= require spotlight/admin/index
+// This is the sprockets entrypoint.
+//= require bootstrap/util
+//= require bootstrap/tab
+//= require bootstrap/tooltip
+//= require bootstrap/popover
+//= require bootstrap/carousel
+//= require leaflet
+//= require sir-trevor
+//= require clipboard
+//= require handlebars
+//= require tiny-slider
+//= require typeahead.bundle.min.js
+
+//= require spotlight/spotlight