blacklight-spotlight 3.6.0.beta1 → 3.6.0.beta3

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

@@ -33,7 +33,7 @@ $image-overlay-max-height: 300px;
     &::before {
       content: " \000B7 ";
       color: $text-muted;
-      padding-right: $spacer / 2;
+      padding-right: $spacer * 0.5;
     }
   }
 }

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

@@ -1,41 +1,39 @@
-@import "spotlight/variables";
-@import "spotlight/mixins";
-@import "bootstrap/variables";
-
-@import "spotlight/sir-trevor_overrides";
-@import "spotlight/attachments";
-@import "spotlight/pages";
-@import "spotlight/breadcrumbs";
-@import "spotlight/browse";
-@import "spotlight/browse_group_categories_block";
-@import "spotlight/header";
-@import "spotlight/footer";
-@import "spotlight/catalog";
-@import "spotlight/croppable";
-@import "spotlight/curation";
-@import "spotlight/exhibit_admin";
-@import "spotlight/exhibit_navbar";
-@import "spotlight/edit_in_place";
-@import "spotlight/featured_browse_categories_block";
-@import "spotlight/item_text_block";
-@import "spotlight/uploaded_items_block";
-@import "spotlight/modals";
-@import "spotlight/multi_image_selector";
-@import "spotlight/multi_up_item_grid";
-@import "spotlight/slideshow_block";
-@import "spotlight/upload";
-@import "spotlight/nestable";
-@import "spotlight/blacklight_configuration";
-@import "spotlight/typeahead";
-@import "spotlight/bootstrap_overrides";
-@import "spotlight/blacklight_overrides";
-@import "spotlight/report_a_problem";
-@import "spotlight/exhibits_index";
-@import "spotlight/collapse_toggle";
-@import "spotlight/translations";
-@import "spotlight/utilities";
-@import "spotlight/view_larger";
-@import "spotlight/accessibility";
+@import "variables";
+@import "mixins";
+@import "sir-trevor_overrides";
+@import "attachments";
+@import "pages";
+@import "breadcrumbs";
+@import "browse";
+@import "browse_group_categories_block";
+@import "header";
+@import "footer";
+@import "catalog";
+@import "croppable";
+@import "curation";
+@import "exhibit_admin";
+@import "exhibit_navbar";
+@import "edit_in_place";
+@import "featured_browse_categories_block";
+@import "item_text_block";
+@import "uploaded_items_block";
+@import "modals";
+@import "multi_image_selector";
+@import "multi_up_item_grid";
+@import "slideshow_block";
+@import "upload";
+@import "nestable";
+@import "blacklight_configuration";
+@import "typeahead";
+@import "bootstrap_overrides";
+@import "blacklight_overrides";
+@import "report_a_problem";
+@import "exhibits_index";
+@import "collapse_toggle";
+@import "translations";
+@import "utilities";
+@import "view_larger";
+@import "accessibility";
 
 
 

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

@@ -1,7 +1,5 @@
 $footer-top-margin: 3rem !default;
 $footer-height: 7.5rem !default;
-$white: #ffffff !default;
-$black: #000000 !default;
 
 $masthead-bg: $card-bg !default;
 $masthead-height: 11.25rem !default;
@@ -14,28 +12,9 @@ $exhibit-card-gutter: 30px !default;
 $exhibit-card-image-size: 269px !default;
 $exhibit-card-shadow: inset 2px 2px 5px -2px $exhibit-card-border !default;
 
-$navbar-transparent-color: $gray-400 !default;
-$navbar-transparent-bg: rgba(0, 0, 0, 0.2) !default;
 $navbar-transparent-border: $gray-500 !default;
-$navbar-transparent-link-color: $gray-600 !default;
-$navbar-transparent-link-hover-color: $gray-600 !default;
-$navbar-transparent-link-hover-bg: rgba(255, 255, 255, 0.15) !default;
-$navbar-transparent-link-active-color: $gray-600 !default;
-$navbar-transparent-link-active-bg: rgba(255, 255, 255, 0.3) !default;
-$navbar-transparent-link-disabled-color: #ccc !default;
-$navbar-transparent-link-disabled-bg: transparent !default;
-
 $navbar-transparent-page-bg: rgba(0, 0, 0, 0.5) !default;
 
-// Navbar brand label
-$navbar-transparent-brand-color: $navbar-transparent-link-color !default;
-$navbar-transparent-brand-hover-color: darken($navbar-transparent-brand-color, 10%) !default;
-$navbar-transparent-brand-hover-bg: transparent !default;
-
-// Navbar toggle
-$navbar-transparent-toggle-icon-bar-bg: $navbar-light-toggler-icon-bg !default;
-$navbar-transparent-toggle-border-color: $navbar-light-toggler-border-color !default;
-
 // Translations
 $translation-available-color: #80bf77;
 $translation-panel-bg: #f5f5f5;

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

@@ -1,4 +1,4 @@
-@import "tiny-slider";
+@import "../../../../vendor/assets/stylesheets/tiny-slider";
 
 .browse-group-categories-block {
   padding-bottom: $spacer * .75;

data/app/controllers/spotlight/browse_controller.rb

@@ -20,7 +20,11 @@ module Spotlight
     before_action :swap_actions_configuration, only: :show
 
     before_action do
-      blacklight_config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        blacklight_config.track_search_session.storage = false
+      else
+        blacklight_config.track_search_session = false
+      end
       blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' if blacklight_config.view.key? :gallery
       blacklight_config.action_mapping.default = blacklight_config.index
       blacklight_config.action_mapping.show = blacklight_config.index

data/app/controllers/spotlight/catalog_controller.rb

@@ -30,7 +30,11 @@ module Spotlight
     before_action only: :admin do
       blacklight_config.view.select! { |k, _v| k == :admin_table }
       blacklight_config.view.admin_table(partials: [:index_compact], document_actions: []) unless blacklight_config.view.key? :admin_table
-      blacklight_config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        blacklight_config.track_search_session.storage = false
+      else
+        blacklight_config.track_search_session = false
+      end
 
       unless blacklight_config.sort_fields.key? :timestamp
         blacklight_config.add_sort_field :timestamp, default: true,

data/app/controllers/spotlight/dashboards_controller.rb

@@ -14,7 +14,11 @@ module Spotlight
       blacklight_config.action_mapping&.delete(:show)
       blacklight_config.view.clear
       blacklight_config.view.admin_table(partials: ['index_compact'], document_actions: [])
-      blacklight_config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        blacklight_config.track_search_session.storage = false
+      else
+        blacklight_config.track_search_session = false
+      end
       blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 

data/app/javascript/spotlight/user/index.js

@@ -1,4 +1,3 @@
-import Analytics from 'analytics'
 import BrowseGroupCateogries from 'browse_group_categories'
 import Carousel from 'carousel'
 import ClearFormButton from 'clear_form_button'
@@ -7,11 +6,10 @@ import ZprLinks from 'zpr_links'
 
 export default class {
   connect() {
-    new Analytics().connect()
     new BrowseGroupCateogries().connect()
     new Carousel().connect()
     new ClearFormButton().connect()
     new ReportProblem().connect()
     new ZprLinks().connect()
   }
-}
+}

data/app/models/spotlight/blacklight_configuration.rb

@@ -46,14 +46,14 @@ module Spotlight
       model.search_fields&.each do |k, v|
         v[:enabled] &&= value_to_boolean(v[:enabled])
         v[:enabled] ||= true if v[:enabled].nil?
-        v[:label] = default_blacklight_config.search_fields[k][:label] if default_blacklight_config.search_fields[k] && !v[:label].present?
+        v[:label] = default_blacklight_config.search_fields[k][:label] if default_blacklight_config.search_fields[k] && v[:label].blank?
         v.reject! { |_k, v1| v1.blank? && v1 != false }
       end
 
       model.sort_fields&.each do |k, v|
         v[:enabled] &&= value_to_boolean(v[:enabled])
         v[:enabled] ||= true if v[:enabled].nil?
-        v[:label] = default_blacklight_config.sort_fields[k][:label] if default_blacklight_config.sort_fields[k] && !v[:label].present?
+        v[:label] = default_blacklight_config.sort_fields[k][:label] if default_blacklight_config.sort_fields[k] && v[:label].blank?
         v.reject! { |_k, v1| v1.blank? && v1 != false }
       end
 

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

@@ -1,13 +1,14 @@
 <% if Spotlight::Engine.config.ga_web_property_id %>
+<!-- Google tag (gtag.js) -->
+<% if Spotlight::Engine.config.ga_debug_mode %>
+<script>window.analyticsDebug = true;</script>
+<% end %>
+<script async src="https://www.googletagmanager.com/gtag/js?id=<%= Spotlight::Engine.config.ga_web_property_id %>"></script>
 <script>
-(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-ga('create', '<%= j(Spotlight::Engine.config.ga_web_property_id) %>', 'auto');
-ga('set', 'anonymizeIp', <%= Spotlight::Engine.config.ga_anonymize_ip %>)
-ga('send', 'pageview');
-
+  window.dataLayer = window.dataLayer || [];
+  function gtag() { dataLayer.push(arguments); }
+  var opts = window.analyticsDebug ? {'debug_mode': true} : {};
+  gtag("js", new Date());
+  gtag("config", "<%= Spotlight::Engine.config.ga_web_property_id %>", opts);
 </script>
 <% end %>

data/lib/generators/spotlight/templates/config/initializers/spotlight_initializer.rb

@@ -64,13 +64,20 @@
 # Spotlight::Engine.config.featured_image_square_size = [400, 400]
 
 # ==> Google Analytics integration
-# Spotlight::Engine.config.analytics_provider = Spotlight::Analytics::Ga
-# Spotlight::Engine.config.ga_pkcs12_key_path = nil
-# Spotlight::Engine.config.ga_web_property_id = nil
-# Spotlight::Engine.config.ga_email = nil
-# Spotlight::Engine.config.ga_analytics_options = {}
-# Spotlight::Engine.config.ga_page_analytics_options = config.ga_analytics_options.merge(limit: 5)
-# Spotlight::Engine.config.ga_anonymize_ip = false # false for backwards compatibility
+# After creating a property for your site on Google Analytics, you need to:
+# a) register an OAuth service account with access to your analytics property:
+#     (https://github.com/tpitale/legato/wiki/OAuth2-and-Google#registering-for-api-access)
+# b) download the pkcs12 key and make it accessible to your application
+# c) set ga_web_property_id below to your site's property id
+# Rails.application.config.to_prepare do
+#   Spotlight::Engine.config.analytics_provider = Spotlight::Analytics::Ga
+#   Spotlight::Engine.config.ga_pkcs12_key_path = nil
+#   Spotlight::Engine.config.ga_web_property_id = 'G-XXXXXXXXXX'
+#   Spotlight::Engine.config.ga_email = 'test@example.com'
+#   Spotlight::Engine.config.ga_analytics_options = {}
+#   Spotlight::Engine.config.ga_page_analytics_options = Spotlight::Engine.config.ga_analytics_options.merge(limit: 5)
+#   Spotlight::Engine.config.ga_debug_mode = false
+# end
 
 # ==> Sir Trevor Widget Configuration
 # These are set by default by Spotlight's configuration,

data/lib/spotlight/engine.rb

@@ -38,7 +38,7 @@ module Spotlight
     end
 
     require 'carrierwave'
-    require 'redcarpet'
+    require 'redcarpet' # required for markdown support in github/markup https://github.com/github/markup#markups
     require 'github/markup'
     require 'openseadragon'
     require 'handlebars_assets'
@@ -181,11 +181,7 @@ module Spotlight
       end
     end
 
-    # If you use Google Analytics, you need to wire your site to report to a Google Analytics property.
-    # Adding Google Analytics to your site is left as an excersize for the implementor (you could
-    # consider overriding the layout to inject GA code..)
-    #
-    # After getting your site to report to Google Analytics, you need to:
+    # After creating a property for your site on Google Analytics, you need to:
     # a) register an OAuth service account with access to your analytics property:
     #     (https://github.com/tpitale/legato/wiki/OAuth2-and-Google#registering-for-api-access)
     # b) download the pkcs12 key and make it accessible to your application
@@ -196,7 +192,8 @@ module Spotlight
     config.ga_email = nil
     config.ga_analytics_options = {}
     config.ga_page_analytics_options = config.ga_analytics_options.merge(limit: 5)
-    config.ga_anonymize_ip = false # false for backwards compatibility
+    config.ga_debug_mode = false
+
     config.max_pages = 1000
 
     Blacklight::Engine.config.inject_blacklight_helpers = false
@@ -251,17 +248,30 @@ module Spotlight
 
     config.spambot_honeypot_email_field = :email_address
 
-    config.to_prepare do
-      Blacklight::Configuration.try(:initialize_default_configuration) unless Blacklight::Configuration.try(:initialized_default_configuration?)
+    if Blacklight::VERSION > '8'
+      Blacklight::Configuration.default_configuration do
+        # Field containing the last modified date for a Solr document
+        Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
+
+        # Default configuration for the browse view
+        Blacklight::Configuration.property :browse, default: Blacklight::OpenStructWithHashAccess.new(document_actions: [])
 
-      # Field containing the last modified date for a Solr document
-      Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
+        Blacklight::Configuration.default_values[:search_state_fields] ||= []
+        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
+      end
+    else
+      config.to_prepare do
+        Blacklight::Configuration.try(:initialize_default_configuration) unless Blacklight::Configuration.try(:initialized_default_configuration?)
 
-      # Default configuration for the browse view
-      Blacklight::Configuration.default_values[:browse] ||= Blacklight::OpenStructWithHashAccess.new(document_actions: [])
+        # Field containing the last modified date for a Solr document
+        Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
 
-      Blacklight::Configuration.default_values[:search_state_fields] ||= []
-      Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
+        # Default configuration for the browse view
+        Blacklight::Configuration.default_values[:browse] ||= Blacklight::OpenStructWithHashAccess.new(document_actions: [])
+
+        Blacklight::Configuration.default_values[:search_state_fields] ||= []
+        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
+      end
     end
 
     # make blacklight configuration play nice with bootstrap_form

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '3.6.0.beta1'
+  VERSION = '3.6.0.beta3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 3.6.0.beta1
+  version: 3.6.0.beta3
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-status
@@ -557,20 +557,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sprockets
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: tophat
   requirement: !ruby/object:Gem::Requirement
@@ -1055,7 +1041,6 @@ files:
 - app/javascript/spotlight/admin/visibility_toggle.es6
 - app/javascript/spotlight/index.js
 - app/javascript/spotlight/spotlight.js
-- app/javascript/spotlight/user/analytics.es6
 - app/javascript/spotlight/user/browse_group_categories.es6
 - app/javascript/spotlight/user/carousel.es6
 - app/javascript/spotlight/user/clear_form_button.es6

data/app/javascript/spotlight/user/analytics.es6

@@ -1,9 +0,0 @@
-export default class {
-  connect() {
-    if (window._gaq != null) {
-      return _gaq.push(['_trackPageview']);
-    } else if (window.pageTracker != null) {
-      return pageTracker._trackPageview();
-    }
-  }
-}