blacklight_allmaps 0.1.0 → 0.2.0

data/lib/generators/blacklight/allmaps/config_generator.rb

@@ -16,31 +16,63 @@ module Blacklight
         copy_file "manifest.js", "app/assets/config/manifest.js", force: true
       end
 
+      def add_assets_initialier
+        append_to_file "config/initializers/assets.rb" do
+          "
+          # Blacklight Allmaps
+          Rails.application.config.assets.paths << Rails.root.join('vendor', 'assets', 'images')
+          Rails.application.config.assets.precompile += %w( blacklight/allmaps/allmaps-logo.svg )"
+        end
+      end
+
       def copy_rake_tasks
         append_to_file "Rakefile", "require 'blacklight/allmaps/rake_task'\n"
       end
 
       def prioritize_blacklight_allmaps_views
-        inject_into_file "config/application.rb", "\nrequire \"blacklight/allmaps/engine\"\n", after: "require \"action_cable/engine\""
-        inject_into_file "config/application.rb", "\nconfig.railties_order = [Blacklight::Allmaps::Engine, :main_app, :all]\n", after: "class Application < Rails::Application\n"
+        inject_into_file "config/application.rb", "\nrequire \"blacklight/allmaps/engine\"\n", before: "# Require the gems listed in Gemfile"
+        inject_into_file "config/application.rb", "\n    config.railties_order = [Blacklight::Allmaps::Engine, :main_app, :all]\n", after: "class Application < Rails::Application\n"
       end
 
       def add_importmap_pins
         append_to_file "config/importmap.rb" do
           <<~CONTENT
-            pin "leaflet" # @1.9.4
-            pin '@allmaps/leaflet', to: "@allmaps--leaflet.js"
+            pin "leaflet", to: "https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.js", preload: true
+            pin "leaflet-fullscreen", to: "https://cdn.jsdelivr.net/npm/leaflet-fullscreen@1.0.2/dist/Leaflet.fullscreen.min.js", preload: true
+            pin "@allmaps/leaflet", to: "https://cdn.jsdelivr.net/npm/@allmaps/leaflet/dist/bundled/allmaps-leaflet-1.9.umd.js", preload: true
           CONTENT
         end
       end
 
+      def add_javascript
+        inject_into_file "app/assets/javascripts/application.js", after: "//= require blacklight/blacklight" do
+          "\n
+    // Required by Blacklight::Allmaps
+    //= require blacklight/allmaps/blacklight-allmaps"
+        end
+      end
+
+      def add_bl_stylesheets
+        return unless ENV["LIGHT"] == "blacklight"
+        append_to_file "app/assets/stylesheets/blacklight.scss" do
+          "@import 'blacklight/allmaps/base';"
+        end
+      end
+
+      def add_gbl_stylesheets
+        return unless ENV["LIGHT"] == "geoblacklight"
+        append_to_file "app/assets/stylesheets/application.scss" do
+          "@import 'blacklight/allmaps/base';"
+        end
+      end
+
       def set_active_job_config
         inject_into_file "config/environments/development.rb", "  config.active_job.queue_adapter = :inline\n", after: "Rails.application.configure do\n"
       end
 
       def add_geoblacklight
         return unless ENV["LIGHT"] == "geoblacklight"
-        append_to_file "Gemfile", '"geoblacklight", "4.1"'
+        append_to_file "Gemfile", '"geoblacklight", "~> 4.4"'
       end
 
       def include_blacklight_allmaps_solrdocument
@@ -49,6 +81,36 @@ module Blacklight
           "\n include Blacklight::Allmaps::SolrDocument"
         end
       end
+
+      def add_gbl_tabbed_viewer
+        return unless ENV["LIGHT"] == "geoblacklight"
+        # Use the tabbed viewer
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.show.partials << \"show_default_viewer_container\"" do
+          "\n
+    # Blacklight::Allmaps Tabbed Viewer
+    config.show.partials << \"show_allmaps_tabbed_viewer_container\""
+        end
+
+        # Remove the default viewer
+        gsub_file("app/controllers/catalog_controller.rb", "config.show.partials << \"show_default_viewer_container\"", "#config.show.partials << \"show_default_viewer_container\"")
+      end
+
+      def add_bl_allmaps_viewer
+        return unless ENV["LIGHT"] == "blacklight"
+        # Use the allmaps viewer
+        inject_into_file "app/controllers/catalog_controller.rb", after: "#config.show.thumbnail_field = 'thumbnail_path_ss'" do
+          "\n
+    # Blacklight::Allmaps Viewer
+    config.show.partials.insert(1, :blacklight_allmaps)"
+        end
+      end
+
+      def add_bl_georeferenced_facet
+        return unless ENV["LIGHT"] == "blacklight"
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.add_facet_field 'subject_era_ssim', label: 'Era'" do
+          "\n    config.add_facet_field 'bl_georeferenced_bsi', label: 'Allmaps Georeferenced'"
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_allmaps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Larson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -34,16 +34,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +156,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of BlacklightAllmaps
+description: Description of Blacklight::Allmaps
 email:
 - ewlarson@gmail.com
 executables: []
@@ -171,10 +171,17 @@ files:
 - app/assets/images/blacklight/allmaps/blacklight-logo.png
 - app/assets/images/blacklight/allmaps/geoblacklight-logo.png
 - app/assets/images/blacklight/allmaps/logo.svg
-- app/assets/stylesheets/blacklight_allmaps/application.css
+- app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.esm.js
+- app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.esm.js.map
+- app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.js
+- app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.js.map
+- app/assets/stylesheets/blacklight/allmaps/base.scss
 - app/controllers/blacklight/allmaps/application_controller.rb
 - app/helpers/blacklight/allmaps/application_helper.rb
-- app/javascripts/map_controller.js
+- app/javascript/blacklight/allmaps/index.js
+- app/javascript/blacklight/allmaps/initialize_blacklight_map.js
+- app/javascript/blacklight/allmaps/initialize_geoblacklight_map.js
+- app/javascript/blacklight/allmaps/leaflet_layer_opacity.js
 - app/jobs/blacklight/allmaps/application_job.rb
 - app/jobs/blacklight/allmaps/store_sidecar_annotation.rb
 - app/mailers/blacklight/allmaps/application_mailer.rb
@@ -184,13 +191,13 @@ files:
 - app/views/allmaps/show/_blacklight.html.erb
 - app/views/allmaps/show/_geoblacklight.html.erb
 - app/views/allmaps/sidebar/_allmaps.html.erb
-- app/views/catalog/_show_default_viewer_container.html.erb
-- app/views/catalog/_show_main_content.html.erb
+- app/views/catalog/_blacklight_allmaps.html.erb
+- app/views/catalog/_show_allmaps_tabbed_viewer_container.html.erb
 - app/views/catalog/_show_sidebar.html.erb
 - app/views/catalog/_show_sidebar_blacklight.html.erb
 - app/views/catalog/_show_sidebar_geoblacklight.html.erb
 - config/routes.rb
-- db/migrate/20240307155110_create_solr_document_sidecars.rb
+- db/migrate/20240307155110_create_solr_document_sidecar_allmaps.rb
 - lib/blacklight/allmaps.rb
 - lib/blacklight/allmaps/engine.rb
 - lib/blacklight/allmaps/rake_task.rb
@@ -225,5 +232,5 @@ requirements: []
 rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
-summary: Blacklight Allmaps plugin
+summary: Blacklight::Allmaps plugin
 test_files: []

data/app/assets/stylesheets/blacklight_allmaps/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/javascripts/map_controller.js

@@ -1,39 +0,0 @@
-// map_controller.js
-import { Controller } from "@hotwired/stimulus"
-import L from 'leaflet'
-import { WarpedMapLayer } from '@allmaps/leaflet'
-
-export default class extends Controller {
-  static targets = [ "placeholder" ]
-
-  connect(){
-
-    console.log("Map Controller Connected");
-    console.log(this.element);
-
-    // Grok: Allmaps annotation for center and zoom level?
-    this.map = L.map('allmaps-map', {
-      center: [43.063518, -89.3906863],
-      zoom: 10,
-      zoomAnimationThreshold: 1
-    })
-    
-    L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
-      maxZoom: 18,
-      attribution: '&copy; <a href=https://www.openstreetmap.org/copyright>OpenStreetMap</a> contributors'
-    }).addTo(this.map)
-    
-    const annotationUrl = 'https://annotations.allmaps.org/manifests/c2f9fc8490151424'
-    const warpedMapLayer = new WarpedMapLayer(annotationUrl)
-      .addTo(this.map)
-
-    const bounds = warpedMapLayer.getBounds();
-      this.map.fitBounds(bounds, {
-        padding
-      });
-  }
-
-  disconnect(){
-    this.map.remove()
-  }
-}

data/app/views/catalog/_show_default_viewer_container.html.erb

@@ -1,52 +0,0 @@
-<% document ||= @document %>
-<div class='row'>
-  <div id='viewer-container' class="col-md-12">
-
-    <span class="sr-only">Georeferenced: <%= document.sidecar_allmaps.georeferenced? %></span>
-
-    <ul class="nav nav-tabs mt-3" id="myTab" role="tablist">
-      <li class="nav-item" role="presentation">
-        <button class="nav-link active" id="item-viewer" data-toggle="tab" data-target="#item-viewer-tab" type="button" role="tab" aria-controls="home" aria-selected="true">Item Viewer</button>
-      </li>
-      <% if document.sidecar_allmaps.georeferenced? %>
-        <li class="nav-item" role="presentation">
-          <button class="nav-link" id="georeferenced-viewer" data-toggle="tab" data-target="#georeferenced-tab" type="button" role="tab" aria-controls="profile" aria-selected="false">Georeferenced Map</button>
-        </li>
-      <% end %>
-    </ul>
-
-    <div class="tab-content mt-3">
-      <div class="tab-pane fade show active" id="item-viewer-tab" role="tabpanel" aria-labelledby="item-viewer-tab">
-        <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
-          <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
-        <% end %>
-
-        <% if document.item_viewer.index_map %>
-          <div class="index-map-legend">
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-default"></span>
-              <p><span class="sr-only">Green tile indicates </span>Map held by collection</p>
-            </div>
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-unavailable"></span>
-              <p><span class="sr-only">Yellow tile indicates </span>Map not held by collection</p>
-            </div>
-            <div class="index-map-legend-info">
-              <span class="index-map-legend-selected"></span>
-              <p><span class="sr-only">Blue tile indicates </span>Selected map tile</p>
-            </div>
-          </div>
-        <% end %>
-
-        <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-geom' => document.geometry.geojson, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
-        <% end %>
-      </div>
-      
-      <% if document.sidecar_allmaps.georeferenced? %>
-        <div class="tab-pane fade" id="georeferenced-tab" role="tabpanel" aria-labelledby="georeferenced-tab">
-          <%= render partial: 'allmaps/show/geoblacklight', locals: { document: document } %>
-        </div>
-      <% end %>
-    </div>
-  </div>
-</div>

data/app/views/catalog/_show_main_content.html.erb

@@ -1,58 +0,0 @@
-<% if Blacklight::VERSION.to_i > 8 %>
-  <%= render blacklight_config.track_search_session.item_pagination_component.new(search_context: @search_context, search_session: search_session, current_document: @document) if blacklight_config.track_search_session.item_pagination_component %>
-  <% @page_title = t('blacklight.search.show.title', document_title: document_presenter(@document).html_title, application_name: application_name).html_safe %>
-  <% content_for(:head) { render_link_rel_alternates } %>
-
-  <% document_component = blacklight_config.view_config(:show).document_component -%>
-  <%= render (document_component).new(document_component.collection_parameter => document_presenter(@document), component: :div, show: true, partials: blacklight_config.view_config(:show).partials) do |component| %>
-    <% component.with_title(as: 'h1', classes: '', link_to_document: false, actions: false) %>
-    <% component.with_footer do %>
-
-      <% unless defined?(Geoblacklight) %>
-        <% if @document.sidecar_allmaps.georeferenced? %>
-          <%= render partial: 'allmaps/show/blacklight', locals: { document: @document } %>
-        <% end %>
-      <% end %>
-      
-      <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
-        <!-- COinS, for Zotero among others. -->
-        <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_presenter(@document).display_type) %>"></span>
-      <% end %>
-    <% end %>
-  <% end %>
-
-<% else %>
-  <%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) if search_session['document_id'] == @document.id %>
-
-  <% @page_title = t('blacklight.search.show.title', document_title: Deprecation.silence(Blacklight::BlacklightHelperBehavior) { document_show_html_title }, application_name: application_name).html_safe %>
-  <% content_for(:head) { render_link_rel_alternates } %>
-
-  <%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), component: :div, title_component: :h1, show: true) do |component| %>
-    <% component.with_footer do %>
-
-      <% unless defined?(Geoblacklight) %>
-        <% if @document.sidecar_allmaps.georeferenced? %>
-          <%= render partial: 'allmaps/show/blacklight', locals: { document: @document } %>
-        <% end %>
-      <% end %>
-
-      <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
-        <!--
-            // COinS, for Zotero among others.
-            // This document_partial_name(@document) business is not quite right,
-            // but has been there for a while.
-        -->
-        <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(Deprecation.silence(Blacklight::RenderPartialsHelperBehavior) { document_partial_name(@document) }) %>"></span>
-      <% end %>
-    <%  end %>
-
-    <%# Use :body for complete backwards compatibility (overriding the component body markup),
-          but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
-    <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :with_body : :with_partial) do %>
-      <div id="doc_<%= @document.id.to_s.parameterize %>">
-        <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
-      </div>
-    <% end %>
-  <% end %>
-<% end %>
-