geoblacklight_sidecar_images 0.9.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e5639a7fcc6c46a1279e6e6b14cb56dc63621039508d6c9df8f5543640c45fa
-  data.tar.gz: c66f6117ac38255d36421a82b178ee8271f381bc494b085ab93bf7a35d71a1f0
+  metadata.gz: 07e87a85df004575b8fe2b6c5527b6207fc680063d365cc90f344cf458c36d66
+  data.tar.gz: 943c20ab4215221cfcdef614d2e1d8874b1f74a538e04eb812ab252f50453dd1
 SHA512:
-  metadata.gz: b838949ffa7901dea148ff473387949df139a7c1e9106589f398cc1ca5bc447a4ba3d9b3eb813fd3dd6c8ebf473aca425cae716ca906b762d6200d70eb13e9e0
-  data.tar.gz: 58d63dd4f5182d9f4a0b2f8b4a448234fcc8a1897c4041f7fdac1d98a04e47591f2edafc667a335eb5da50cd74aa35715855a924d0fbb548253243c3e5627ac9
+  metadata.gz: 3946c6b696da98e7293414f8cc273051c4933f6584cd0cece3b5eb6dc1af1ebe042cd287e8ba57b6c0ac1f251634f1cb563f3695a452448d3a4a478465be3a35
+  data.tar.gz: d8e8b2886ad18358a55c992edf1d5cbfe43bf53e613115ad72f5908096f34f476d058387c97d9afc97f8c955b58c570f0dd534aecd7b6285c8b1f1d6793edac8

data/.github/workflows/ruby.yml

@@ -12,14 +12,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        bundler_version: [2.1.1]
-        faraday_version: ['~> 1.0']
+        bundler_version: [2.2.8]
+        faraday_version: ['~> 2.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.3.1
     - name: Install bundler
       run: gem install bundler -v ${{ matrix.bundler_version }}
     - name: Install dependencies
@@ -33,10 +33,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby_version: ["3.0","2.7"]
-        rails_version: [7.0.4.2, 6.1.7.2]
-        bundler_version: [2.1.1]
-        faraday_version: ['~> 1.0']
+        ruby_version: [3.3.1]
+        rails_version: [7.1.3.2, 7.0.8.1]
+        bundler_version: [2.2.8]
+        faraday_version: ['~> 2.0']
 
     name: test ruby ${{ matrix.ruby_version }} / rails ${{ matrix.rails_version }} / faraday ${{ matrix.faraday_version }}
     steps:

data/.solr_wrapper.yml

@@ -1,4 +1,3 @@
-url: https://archive.apache.org/dist/lucene/solr/8.11.1/solr-8.11.1.tgz
 validate: false
 instance_dir: tmp/solr
 download_dir: tmp/solr

data/README.md

@@ -19,8 +19,8 @@ This GeoBlacklight plugin captures remote images from geographic web services an
 
 ## Requirements
 
-* [Ruby on Rails >= 5.2.5](https://weblog.rubyonrails.org/releases/)
-* [GeoBlacklight >= 3.3](https://github.com/geoblacklight/geoblacklight)
+* [Ruby on Rails >= 5.2, < 8.0](https://weblog.rubyonrails.org/releases/)
+* [GeoBlacklight v4 or v3](https://github.com/geoblacklight/geoblacklight)
 * [ImageMagick](https://github.com/ImageMagick/ImageMagick)
 
 ### Suggested
@@ -33,10 +33,15 @@ This GeoBlacklight plugin captures remote images from geographic web services an
 
 ### Existing GeoBlacklight Instance
 
-Add the gem to your Gemfile.
+GeoBlacklight v4 with Aardvark metadata / Add the gem to your Gemfile.
 
 ```ruby
-gem 'geoblacklight_sidecar_images'
+gem "geoblacklight_sidecar_images", "~> 1.0"
+```
+
+GeoBlacklight v3 with GBL v1.0 metadata / Add the gem to your Gemfile.
+```ruby
+gem "geoblacklight_sidecar_images", "~> 0.9.1", "< 1.0"
 ```
 
 Run the generator.
@@ -73,7 +78,7 @@ config.active_storage.service = :local
 Create a new GeoBlacklight instance with the GBLSI code
 
 ```bash
-$ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight_sidecar_images/master/template.rb
+$ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight_sidecar_images/develop/template.rb
 
 ```
 
@@ -215,7 +220,7 @@ document.sidecar.image.attached?
 document.sidecar.image.variable?
 
 # Example image_tag with resize
-<%= image_tag document.sidecar.image.variant(resize: "100x100"), {class: 'media-object'} %>
+<%= image_tag document.sidecar.image.variant(resize_to_fit: [100, 100]), {class: 'media-object'} %>
 
 ```
 
@@ -236,7 +241,7 @@ Example for adding a thumbnail to the show page sidebar.
     <div class="card">
       <div class="card-header">Thumbnail</div>
       <div class="card-body">
-        <%= image_tag @document.sidecar.image.variant(resize: "200"), {class: 'mr-3'} %>
+        <%= image_tag @document.sidecar.image.variant(resize_to_fit: [200, 200]), {class: 'mr-3'} %>
       </div>
     </div>
   <% end %>
@@ -261,21 +266,10 @@ bundle exec rake gblsci:sample_data:seed
 # Run harvest
 bundle exec rake gblsci:images:harvest_all
 
-# Tail log
+# Tail image service log file
 tail -f log/image_service_development.log
 
 ```
 
 [See Localhost Results](http://localhost:3000/?per_page=50&q=&search_field=all_fields)
 
-## TODOs
-
-* ~~0.0.1 - Initial gem~~
-* ~~0.1.0 - Prioritize local thumbnail solr field~~
-* ~~0.2.0 - Forgo attaching placeholder imagery~~
-* ~~0.3.0 - Add Statesman (state machine library)~~
-* ~~0.4.0 - Rails 5.2 branch / Switch to ActionStorage~~
-* ~~0.7.0 - Rails 5.2+ and 6+ / GeoBlacklight 2+ and 3+ support~~
-* ~~0.8.0 - GeoBlacklight Aardvark support~~
-* 0.7.0 to 0.9.0 - Feedback; Improve test coverage; Collect additional real-world issues
-* 1.0.0 - Final release

data/app/assets/stylesheets/geoblacklight_sidecar_images/modules/_results.scss

@@ -1,11 +1,35 @@
 // GBLSCI results
-.media {
-  img,span {
-    min-width: 100px;
-    max-width: 100px;
-    text-align: center;
+#documents {
+  .index_title {
+    font-size: 1rem;
   }
-  span.icon.square {
-    font-size:3rem;
+
+  .status-icons {
+    display: inline-block;
+
+    span {
+      min-width: 0px;
+    }
   }
-}
+
+  .thumbnail {
+    height: 100px;
+    width: 100px;
+    margin-left:auto;
+    margin-right: auto;
+    img {
+      max-height: 160px;
+      width: inherit;
+    }
+  }
+
+  .icon .blacklight-icons {
+    height: 4.5rem;
+    width: 4.5rem;
+
+    svg {
+      height:95%;
+      width:95%;
+    }
+  }
+}

data/app/models/concerns/wms_rewrite_concern.rb

@@ -17,6 +17,6 @@ module WmsRewriteConcern
   end
 
   def local?
-    fetch(Settings.FIELDS.PROVENANCE, "").casecmp(Settings.INSTITUTION_LOCAL_NAME).zero?
+    fetch(Settings.FIELDS.PROVIDER, "").casecmp(Settings.INSTITUTION_LOCAL_NAME).zero?
   end
 end

data/app/services/geoblacklight_sidecar_images/image_service/wms.rb

@@ -19,7 +19,7 @@ module GeoblacklightSidecarImages
         "#{endpoint}/reflect?" \
           "&FORMAT=image%2Fpng" \
           "&TRANSPARENT=TRUE" \
-          "&LAYERS=#{document["layer_id_s"]}" \
+          "&LAYERS=#{document["gbl_wxsIdentifier_s"]}" \
           "&WIDTH=#{size}" \
           "&HEIGHT=#{size}"
       end

data/app/services/geoblacklight_sidecar_images/image_service.rb

@@ -128,7 +128,7 @@ module GeoblacklightSidecarImages
       return nil unless uri.scheme.include?("http")
 
       conn = Faraday.new(url: uri.normalize.to_s) do |b|
-        b.use FaradayMiddleware::FollowRedirects
+        b.use Geoblacklight::FaradayMiddleware::FollowRedirects
         b.adapter :net_http
       end
 

data/geoblacklight_sidecar_images.gemspec

@@ -17,23 +17,23 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "faraday", ">= 1.0"
-  s.add_dependency "geoblacklight", "~> 3.3"
+  s.add_dependency "faraday", ">= 2.0"
+  s.add_dependency "geoblacklight", "~> 4.0"
   s.add_dependency "image_processing", "~> 1.6"
   s.add_dependency "mimemagic", "~> 0.3"
   s.add_dependency "mini_magick", "~> 4.9.4"
-  s.add_dependency "rails", ">= 5.2", "< 7.1"
+  s.add_dependency "rails", ">= 5.2", "< 8.0"
   s.add_dependency "statesman", ">= 3.4"
 
   s.add_development_dependency "byebug"
   s.add_development_dependency "capybara"
   s.add_development_dependency "webdrivers"
-  s.add_development_dependency "database_cleaner", "~> 1.3"
-  s.add_development_dependency "engine_cart", "~> 2.2"
-  s.add_development_dependency "rspec-rails", "~> 3.0"
+  s.add_development_dependency "database_cleaner", "~> 2.0"
+  s.add_development_dependency "engine_cart", "~> 2.0"
+  s.add_development_dependency "rspec-rails", "~> 6.0"
   s.add_development_dependency "selenium-webdriver"
   s.add_development_dependency "simplecov", "~> 0.22"
   s.add_development_dependency "solr_wrapper", "~> 4.0"
   s.add_development_dependency "sprockets", "< 4"
-  s.add_development_dependency "standard", "~> 1.24"
+  s.add_development_dependency "standard", "~> 1.0"
 end

data/lib/generators/geoblacklight_sidecar_images/config_generator.rb

@@ -12,7 +12,7 @@ module GeoblacklightSidecarImages
     DESCRIPTION
 
     def set_active_storage_processor
-      app_config = <<-"APP"
+      app_config = <<-APP
       
         config.active_storage.variant_processor = :mini_magick
       APP

data/lib/generators/geoblacklight_sidecar_images/helpers_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module GeoblacklightSidecarImages
+  class HelpersGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Creates an app/helpers/blacklight directory
+    DESCRIPTION
+
+    def create_views
+      copy_file(
+        "helpers/blacklight/layout_helper_behavior.rb",
+        "app/helpers/blacklight/layout_helper_behavior.rb"
+      )
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/install_generator.rb

@@ -17,7 +17,9 @@ GBLSI_THUMBNAIL_FIELD: 'thumbnail_path_ss'"
     end
 
     def generate_gblsci_assets
-      copy_file "gblsci.scss", "app/assets/stylesheets/gblsci.scss"
+      inject_into_file "app/assets/stylesheets/application.scss", after: "@import 'geoblacklight';\n" do
+        "@import 'geoblacklight_sidecar_images/gblsci';"
+      end
     end
 
     def generate_gblsci_example_docs
@@ -36,6 +38,10 @@ GBLSI_THUMBNAIL_FIELD: 'thumbnail_path_ss'"
       generate "geoblacklight_sidecar_images:views"
     end
 
+    def generate_gblsci_helpers
+      generate "geoblacklight_sidecar_images:helpers"
+    end
+
     def generate_action_storage
       rake "active_storage:install"
     end

data/lib/generators/geoblacklight_sidecar_images/jobs_generator.rb

@@ -12,7 +12,7 @@ module GeoblacklightSidecarImages
     DESCRIPTION
 
     def config_development_jobs_queue_adapter
-      job_config = <<-"JOBS"
+      job_config = <<-JOBS
         config.active_job.queue_adapter = :inline
       JOBS
 

data/lib/generators/geoblacklight_sidecar_images/models_generator.rb

@@ -22,7 +22,7 @@ module GeoblacklightSidecarImages
     end
 
     def include_sidecar_solrdocument
-      sidecar = <<-"SIDECAR"
+      sidecar = <<-SIDECAR
         def sidecar
           # Find or create, and set version
           sidecar = SolrDocumentSidecar.where(

data/lib/generators/geoblacklight_sidecar_images/templates/helpers/blacklight/layout_helper_behavior.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Methods added to this helper will be available to all templates in the hosting
+# application
+module Blacklight
+  # A module for useful methods used in layout configuration
+  module LayoutHelperBehavior
+    ##
+    # Classes added to a document's show content div
+    # @return [String]
+    def show_content_classes
+      "#{main_content_classes} show-document"
+    end
+
+    ##
+    # Attributes to add to the <html> tag (e.g. lang and dir)
+    # @return [Hash]
+    def html_tag_attributes
+      {lang: I18n.locale}
+    end
+
+    ##
+    # Classes added to a document's sidebar div
+    # @return [String]
+    def show_sidebar_classes
+      sidebar_classes
+    end
+
+    ##
+    # Classes used for sizing the main content of a Blacklight page
+    # @return [String]
+    def main_content_classes
+      "col-lg-9"
+    end
+
+    ##
+    # Classes used for sizing the sidebar content of a Blacklight page
+    # @return [String]
+    def sidebar_classes
+      "page-sidebar col-lg-3"
+    end
+
+    ##
+    # Class used for specifying main layout container classes. Can be
+    # overwritten to return 'container-fluid' for Bootstrap full-width layout
+    # @return [String]
+    def container_classes
+      "container-fluid"
+    end
+
+    ##
+    # Render "document actions" area for navigation header
+    # (normally renders "Saved Searches", "History", "Bookmarks")
+    # These things are added by add_nav_action
+    #
+    # @param [Hash] options
+    # @return [String]
+    def render_nav_actions(options = {}, &)
+      render_filtered_partials(blacklight_config.navbar.partials, options, &)
+    end
+
+    ##
+    # Open Search discovery tag for HTML <head> links
+    # @return [String]
+    def opensearch_description_tag title, href
+      tag :link, href: href, title: title, type: "application/opensearchdescription+xml", rel: "search"
+    end
+
+    ##
+    # Get the page's HTML title
+    #
+    # @return [String]
+    def render_page_title
+      (content_for(:page_title) if content_for?(:page_title)) || @page_title || application_name
+    end
+
+    ##
+    # Create <link rel="alternate"> links from a documents dynamically
+    # provided export formats.
+    #
+    # Returns empty string if no links available.
+    #
+    # @param [SolrDocument] document
+    # @param [Hash] options
+    # @option options [Boolean] :unique ensures only one link is output for every
+    #     content type, e.g. as required by atom
+    # @option options [Array<String>] :exclude array of format shortnames to not include in the output
+    # @return [String]
+    def render_link_rel_alternates(document = @document, options = {})
+      return if document.nil?
+
+      document_presenter(document).link_rel_alternates(options)
+    end
+
+    ##
+    # Render classes for the <body> element
+    # @return [String]
+    def render_body_class
+      extra_body_classes.join " "
+    end
+
+    ##
+    # List of classes to be applied to the <body> element
+    # @see render_body_class
+    # @return [Array<String>]
+    def extra_body_classes
+      @extra_body_classes ||= ["blacklight-#{controller.controller_name}", "blacklight-#{[controller.controller_name, controller.action_name].join("-")}"]
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/views/catalog/_index_split_default.html.erb

@@ -1,31 +1,32 @@
 <% # header bar for doc items in index view -%>
-<%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, geom: document.geometry.geojson } do %>
-  <div class='status-icons'>
-    <%= render partial: 'header_icons', locals: { document: document } %>
-  </div>
-  <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
-    <% counter = document_counter_with_offset(document_counter) %>
-    <span class="document-counter">
-      <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
-    </span>
-    <%= link_to_document document, counter: counter, title: document[blacklight_config.index.title_field] %>
-  </h3>
-
-  <div class='col-md-12 more-info-area'>
-    <div class='media'>
-      <% if document.sidecar.image.attached? %>
-        <% if document.sidecar.image.variable? %>
-          <%= image_tag document.sidecar.image.variant(resize: "200"), {class: 'mr-3'} %>
+<%= content_tag :div, class: 'documentHeader row mb-4', data: { layer_id: document.id, geom: document.geometry.geojson } do %>
+  <div class='col-md-12'>
+    <div class='row'>
+      <div class='col-2 thumbnail'>
+        <% if document.sidecar.image.attached? %>
+          <% if document.sidecar.image.variable? %>
+            <%= image_tag document.sidecar.image.variant(resize_to_fit: [200, 200]) %>
+          <% else %>
+            <%= image_tag document.sidecar.image %>
+          <% end %>
         <% else %>
-          <%= image_tag document.sidecar.image, {class: 'mr-3'} %>
+          <span class="icon square" title="<%=document[Settings.FIELDS.RESOURCE_CLASS]%>">
+            <%= geoblacklight_icon(document[Settings.FIELDS.RESOURCE_CLASS].first) %>
+          </span>
         <% end %>
-      <% else %>
-        <span class="icon square mr-3" title="<%=document[Settings.FIELDS.GEOM_TYPE]%>">
-          <%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE]) %>
-        </span>
-      <% end %>
-      <div class='media-body'>
+      </div>
+      <div class='col-9'>
+        <h3 class="index_title text-span">
+          <% counter = document_counter_with_offset(document_counter) %>
+          <span class="document-counter">
+            <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+          </span>
+          <%= link_to_document document, counter: counter, itemprop: "name" %>
+        </h3>
         <small>
+          <div class='status-icons'>
+            <%= render partial: 'header_icons', locals: { document: document } %>
+          </div>
           <%= geoblacklight_present(:index_fields_display, document) %>
         </small>
       </div>

data/lib/geoblacklight_sidecar_images/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightSidecarImages
-  VERSION = "0.9.1"
+  VERSION = "1.1.0"
 end

data/lib/tasks/geoblacklight_sidecar_images_tasks.rake

@@ -36,7 +36,7 @@ namespace :gblsci do
       results.docs.each do |document|
         sleep(1)
         begin
-          GeoblacklightSidecarImages::StoreImageJob.perform_later(document["layer_slug_s"])
+          GeoblacklightSidecarImages::StoreImageJob.perform_later(document["id"])
         rescue Blacklight::Exceptions::RecordNotFound
           next
         end