blacklight_heatmaps 1.4.0 → 2.1.0

data/lib/blacklight_heatmaps/engine.rb

@@ -7,11 +7,9 @@ module BlacklightHeatmaps
       end
 
       Mime::Type.register 'application/vnd.heatmaps+json', :heatmaps
-      if Blacklight::VERSION > '8'
-        Blacklight::Configuration.default_configuration do
-          Blacklight::Configuration.default_values[:search_state_fields] ||= []
-          Blacklight::Configuration.default_values[:search_state_fields] += %i[bbox]
-        end
+      Blacklight::Configuration.default_configuration do
+        Blacklight::Configuration.default_values[:search_state_fields] ||= []
+        Blacklight::Configuration.default_values[:search_state_fields] += %i[bbox]
       end
     end
 

data/lib/blacklight_heatmaps/version.rb

@@ -1,3 +1,3 @@
 module BlacklightHeatmaps
-  VERSION = '1.4.0'
+  VERSION = '2.1.0'
 end

data/lib/blacklight_heatmaps.rb

@@ -1,5 +1,3 @@
-require 'leaflet-rails'
-require 'leaflet-sidebar-rails'
 require 'blacklight'
 
 module BlacklightHeatmaps

data/lib/generators/blacklight_heatmaps/install_generator.rb

@@ -2,18 +2,51 @@ require 'rails/generators'
 
 module BlacklightHeatmaps
   class Install < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
+    class_option :test, type: :boolean, default: false, aliases: '-t', desc: 'Indicates that app will be installed in a test environment'
 
     def copy_styles
-      copy_file 'blacklight_heatmaps.scss', 'app/assets/stylesheets/blacklight_heatmaps.scss'
+      copy_file 'blacklight_heatmaps.css', 'app/assets/stylesheets/blacklight_heatmaps.css'
     end
 
     def inject_js
-      inject_into_file 'app/assets/javascripts/application.js', after: '//= require blacklight/blacklight' do
-        "\n// Required by BlacklightHeatmaps" \
-        "\n//= require leaflet" \
-        "\n//= require L.Control.Sidebar" \
-        "\n//= require blacklight_heatmaps/default"
+      return unless File.exist?('app/javascript/application.js')
+
+      inject_into_file 'app/javascript/application.js' do
+        <<~JS
+          import BlacklightHeatmaps from 'blacklight-heatmaps/app/assets/javascripts/blacklight_heatmaps/default.esm.js'
+          window.BlacklightHeatmaps = BlacklightHeatmaps
+
+          Blacklight.onLoad(function () {
+            BlacklightHeatmaps.init()
+          })
+
+        JS
+      end
+    end
+
+    def add_packages
+      run 'yarn add leaflet'
+      run 'yarn add leaflet-sidebar@"^0.2.4"'
+
+      if ENV['CI']
+        run "yarn add file:#{BlacklightHeatmaps::Engine.root}"
+      elsif options[:test]
+        run 'yarn link "blacklight-heatmaps"'
+      else
+        run 'yarn add "blacklight-heatmaps"'
+      end
+    end
+
+    def add_styles
+      return unless File.exist?('app/assets/stylesheets/application.bootstrap.scss')
+
+      append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+        <<~CONTENT
+          @import "leaflet/dist/leaflet";
+          @import "leaflet-sidebar/src/L.Control.Sidebar";
+          @import "./blacklight_heatmaps";
+        CONTENT
       end
     end
 
@@ -24,7 +57,7 @@ module BlacklightHeatmaps
         "\n    config.heatmap_distErrPct = 0.15 # Default Solr value" \
         "\n    # Basemaps configured include: 'positron', 'darkMatter', 'OpenStreetMap.HOT'" \
         "\n    config.basemap_provider = 'positron'" \
-        "\n    config.show.partials.insert(1, :show_leaflet_map)" \
+        "\n    config.show.partials = [*config.show.partials, :show_leaflet_map]" \
         "\n    config.index.respond_to.heatmaps = true" \
         "\n    config.view.heatmaps(partials: []," \
         "\n                         color_ramp: ['#ffffcc', '#a1dab4', '#41b6c4', '#2c7fb8', '#253494']," \

data/lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.css

@@ -0,0 +1,11 @@
+.blacklight-heatmaps-show-map {
+  height: 500px;
+}
+
+.blacklight-heatmaps-index-map {
+  height: 500px;
+}
+
+.view-icon-heatmaps {
+  &:before { content: "\e135"; }
+}

data/spec/examples.txt

@@ -1,31 +1,31 @@
 example_id                                                                              | status | run_time        |
 --------------------------------------------------------------------------------------- | ------ | --------------- |
-./spec/features/configurable_basemap_spec.rb[1:1]                                       | passed | 0.17827 seconds |
-./spec/features/configurable_basemap_spec.rb[1:2:1]                                     | passed | 0.13454 seconds |
-./spec/features/configurable_basemap_spec.rb[1:3:1]                                     | passed | 0.20226 seconds |
-./spec/features/index_page_map_spec.rb[1:1]                                             | passed | 6.44 seconds    |
-./spec/features/show_page_map_spec.rb[1:1]                                              | passed | 3.96 seconds    |
-./spec/features/show_page_map_spec.rb[1:2]                                              | passed | 0.3658 seconds  |
-./spec/helpers/blacklight/maps_helper_spec.rb[1:1:1]                                    | passed | 0.00472 seconds |
-./spec/helpers/blacklight/maps_helper_spec.rb[1:2:1]                                    | passed | 0.00154 seconds |
-./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:1:1]                  | passed | 0.00006 seconds |
+./spec/features/configurable_basemap_spec.rb[1:1]                                       | passed | 0.14694 seconds |
+./spec/features/configurable_basemap_spec.rb[1:2:1]                                     | passed | 0.11166 seconds |
+./spec/features/configurable_basemap_spec.rb[1:3:1]                                     | passed | 0.31798 seconds |
+./spec/features/index_page_map_spec.rb[1:1]                                             | passed | 1.49 seconds    |
+./spec/features/show_page_map_spec.rb[1:1]                                              | passed | 1.3 seconds     |
+./spec/features/show_page_map_spec.rb[1:2]                                              | passed | 0.0998 seconds  |
+./spec/helpers/blacklight/maps_helper_spec.rb[1:1:1]                                    | passed | 0.00343 seconds |
+./spec/helpers/blacklight/maps_helper_spec.rb[1:2:1]                                    | passed | 0.00095 seconds |
+./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:1:1]                  | passed | 0.00008 seconds |
 ./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:2:1]                  | passed | 0.00006 seconds |
-./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:3:1]                  | passed | 0.00011 seconds |
-./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:4:1]                  | passed | 0.00006 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:1:1]             | passed | 0.00008 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:2:1]             | passed | 0.00006 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:3:1]             | passed | 0.00099 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:1:1]        | passed | 0.00017 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:2:1]        | passed | 0.00007 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:3:1]        | passed | 0.00883 seconds |
-./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:4:1]        | passed | 0.00012 seconds |
-./spec/models/concerns/blacklight_heatmaps/point_spec.rb[1:1:1]                         | passed | 0.01197 seconds |
-./spec/models/concerns/blacklight_heatmaps/point_spec.rb[1:2:1]                         | passed | 0.00049 seconds |
-./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:1:1:1] | passed | 0.00126 seconds |
-./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:1:2:1] | passed | 0.02643 seconds |
-./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:2:1]   | passed | 0.00102 seconds |
-./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:3:1]   | passed | 0.001 seconds   |
-./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:4:1]   | passed | 0.00108 seconds |
-./spec/views/catalog/_document_heatmaps.html.erb_spec.rb[1:1]                           | passed | 0.02604 seconds |
-./spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb[1:1:1]                  | passed | 0.00276 seconds |
-./spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb[1:2:1]                  | passed | 0.00097 seconds |
+./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:3:1]                  | passed | 0.00007 seconds |
+./spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb[1:4:1]                  | passed | 0.0001 seconds  |
+./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:1:1]             | passed | 0.00009 seconds |
+./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:2:1]             | passed | 0.0001 seconds  |
+./spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb[1:1:3:1]             | passed | 0.0011 seconds  |
+./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:1:1]        | passed | 0.00044 seconds |
+./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:2:1]        | passed | 0.00017 seconds |
+./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:3:1]        | passed | 0.00017 seconds |
+./spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb[1:4:1]        | passed | 0.00013 seconds |
+./spec/models/concerns/blacklight_heatmaps/point_spec.rb[1:1:1]                         | passed | 0.00007 seconds |
+./spec/models/concerns/blacklight_heatmaps/point_spec.rb[1:2:1]                         | passed | 0.00039 seconds |
+./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:1:1:1] | passed | 0.00164 seconds |
+./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:1:2:1] | passed | 0.00347 seconds |
+./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:2:1]   | passed | 0.00153 seconds |
+./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:3:1]   | passed | 0.00214 seconds |
+./spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb[1:4:1]   | passed | 0.00146 seconds |
+./spec/views/catalog/_document_heatmaps.html.erb_spec.rb[1:1]                           | passed | 0.00188 seconds |
+./spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb[1:1:1]                  | passed | 0.01013 seconds |
+./spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb[1:2:1]                  | passed | 0.00161 seconds |

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -4,17 +4,25 @@ class TestAppGenerator < Rails::Generators::Base
   source_root './spec/test_app_templates'
 
   def add_gems
-    gem 'blacklight', ENV.fetch('BLACKLIGHT_VERSION', '~> 7.0')
+    gem 'blacklight', ENV.fetch('BLACKLIGHT_VERSION', '~> 8.0')
 
-    Bundler.with_clean_env do
+    Bundler.with_unbundled_env do
       run 'bundle install'
     end
   end
 
+  # This makes the assets available in the test app so that changes made in
+  # local development can be picked up automatically
+  def link_frontend
+    inside('..') do
+      run 'yarn unlink ; yarn link'
+    end
+  end
+
   def run_blacklight_generator
     say_status('warning', 'GENERATING BL', :yellow)
 
-    generate 'blacklight:install', '--devise'
+    generate 'blacklight:install'
   end
 
   # if you need to generate any additional configuration
@@ -22,15 +30,6 @@ class TestAppGenerator < Rails::Generators::Base
   # after setting up the application
 
   def install_engine
-    generate 'blacklight_heatmaps:install'
-  end
-
-  # Temporarily force js assets to fall back to sprockets
-  def clean_up_js_builds
-    return unless File.exist?('app/assets/builds')
-
-    append_to_file 'app/assets/config/manifest.js', "\n//= link application.js\n" if File.exist?('app/assets/config/manifest.js')
-    gsub_file 'app/assets/config/manifest.js', '//= link_tree ../builds', ''
-    remove_dir 'app/assets/builds'
+    generate 'blacklight_heatmaps:install', '--test'
   end
 end

metadata

@@ -1,42 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_heatmaps
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jack Reed
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.4
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.4
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: blacklight
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.17.1
+        version: '8.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -46,52 +45,38 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.17.1
+        version: '8.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
 - !ruby/object:Gem::Dependency
-  name: leaflet-rails
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: leaflet-sidebar-rails
+  name: engine_cart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -107,19 +92,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: engine_cart
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.11'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +120,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,20 +133,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.11'
 description: Search and view Blacklight resources on a map.
 email:
 - phillipjreed@gmail.com
@@ -205,8 +176,7 @@ files:
 - lib/blacklight_heatmaps/engine.rb
 - lib/blacklight_heatmaps/version.rb
 - lib/generators/blacklight_heatmaps/install_generator.rb
-- lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.js
-- lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.scss
+- lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.css
 - lib/tasks/blacklight_heatmaps_tasks.rake
 - spec/examples.txt
 - spec/features/configurable_basemap_spec.rb
@@ -231,7 +201,6 @@ homepage: https://github.com/sul-dlss/blacklight_heatmaps
 licenses:
 - Apache
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,8 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Search and view Blacklight resources on a map.
 test_files:

data/lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.js

@@ -1 +0,0 @@
-//= require blacklight_heatmaps/default

data/lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.scss

@@ -1 +0,0 @@
-@import 'blacklight_heatmaps/default';