geoblacklight_sidecar_images 0.6.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e89b436bb5ef1c4905c614eb923397f8837fe7169095e5ec784c8631cfe04e1
-  data.tar.gz: 18b958b4b4b274ae213281220f00f8557ccc2249807799d467a09fdce33e1986
+  metadata.gz: dc1fb2b7358b4783e0275b47a341170fa2e252bf19eae91c735bc97e562fb5e9
+  data.tar.gz: 73f43cd9d9aaef743bff32e888ca7be68e7a5b216b69fb69e5defd1ac1a73070
 SHA512:
-  metadata.gz: bda9efbc7d361c8c171ff39179f63f8b7046d4aff1892c38a58d92a4cede4c6314838778a07a179809ce7c223a4996b910ba48446f6d6405e012dc3332ed9b99
-  data.tar.gz: 8b0a0b1a0e2a6a6de19b441e192656f0a224505b19f5130f998668084b3698476afbec31b55320609adca7ef16b3967f0a63a7f6b9b7dcebebcd7cb22b4b743a
+  metadata.gz: 489500acdc7152c6efffce9d82fe3c5368f155a9f653984cab5226c3977b24c6d4814cbc23c8ddde48293a243901cd3a50681ecd626525b8f601ac351fc5a3d7
+  data.tar.gz: 37bea86e335908b5a9bb7301028c9a11f6c9f9e637de0b8d93699a30604ddad0f2ad74e4ddfe4d8d86d4bac8d17de91c7781e7d2b7e4d27e2518f15bada3e34f

data/.rubocop.yml

@@ -1,4 +1,5 @@
 require: rubocop-rspec
+require: rubocop-rails
 
 Rails:
   Enabled: true

data/.solr_wrapper.yml

@@ -0,0 +1,5 @@
+validate: false
+download_dir: tmp/solr
+collection:
+  dir: solr/conf/
+  name: blacklight-core

data/Gemfile

@@ -16,7 +16,7 @@ group :development, :test do
   # Peg simplecov to < 0.8 until this is resolved:
   # https://github.com/colszowka/simplecov/issues/281
   gem 'coveralls', require: false
-  gem 'rubocop', '0.60.0', require: false
+  gem 'rubocop', '~> 1.9', require: false
 end
 
 # To use a debugger
@@ -37,11 +37,11 @@ if File.exist?(file)
   end
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
-  gem 'geoblacklight', '~> 2.0'
+  gem 'geoblacklight', '>= 2.0'
   gem 'mini_magick', '~> 4.9.4'
   gem 'image_processing', '~> 1.6'
-  gem 'mimemagic', '~> 0.3'
-  gem 'statesman', '~> 3.4'
-  gem 'rails', '~> 5.2.0', '< 6'
+  gem 'statesman', '>= 3.4'
+  gem 'marcel', '>= 1.0'
+  gem 'rails', '>= 5.2.5', '< 6.2'
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -3,10 +3,16 @@
 [![Build Status](https://travis-ci.org/geoblacklight/geoblacklight_sidecar_images.svg?branch=master)](https://travis-ci.org/geoblacklight/geoblacklight_sidecar_images)
 [![Maintainability](https://api.codeclimate.com/v1/badges/88c14165af5459963011/maintainability)](https://codeclimate.com/github/geoblacklight/geoblacklight_sidecar_images/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/geoblacklight/geoblacklight_sidecar_images/badge.svg?branch=master)](https://coveralls.io/github/geoblacklight/geoblacklight_sidecar_images?branch=master)
-[![Gem Version](https://badge.fury.io/rb/geoblacklight_sidecar_images.svg)](https://badge.fury.io/rb/geoblacklight_sidecar_images)
+[![rubygem](https://badgen.net/rubygems/v/geoblacklight_sidecar_images)](https://badgen.net/rubygems/v/geoblacklight_sidecar_images)
 
 Store local copies of remote imagery in GeoBlacklight.
 
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Rake Tasks](#rake-tasks)
+* [View Customization](#view-customization)
+* [Development](#development)
+
 ## Description
 This GeoBlacklight plugin captures remote images from geographic web services and saves them locally. It borrows the concept of a [SolrDocumentSidecar](https://github.com/projectblacklight/spotlight/blob/master/app/models/spotlight/solr_document_sidecar.rb) from [Spotlight](https://github.com/projectblacklight/spotlight), to have an ActiveRecord-based "sidecar" to match each non-AR SolrDocument. This allows us to use [ActiveStorage](https://github.com/rails/rails/tree/master/activestorage) to attach images to our solr documents.
 
@@ -15,11 +21,11 @@ This GeoBlacklight plugin captures remote images from geographic web services an
 
 ## Requirements
 
-* [Ruby on Rails 5.2](https://weblog.rubyonrails.org/releases/)
-* [GeoBlacklight](https://github.com/geoblacklight/geoblacklight)
+* [Ruby on Rails >= 5.2.5](https://weblog.rubyonrails.org/releases/)
+* [GeoBlacklight >= 3.3](https://github.com/geoblacklight/geoblacklight)
 * [ImageMagick](https://github.com/ImageMagick/ImageMagick)
 
-## Suggested
+### Suggested
 
 * Background Job Processor
 
@@ -47,6 +53,23 @@ Run the database migration.
 $ bin/rails db:migrate
 ```
 
+Complete any necessary [Active Storage setup](https://edgeguides.rubyonrails.org/active_storage_overview.html#setup) steps, for example:
+
+1. Add a config/storage.yml file
+
+```
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+```
+
+2. Add config/environments declarations, development.rb for example:  
+
+```
+# Store uploaded files on the local file system (see config/storage.yml for options)
+config.active_storage.service = :local
+```
+
 ### New GeoBlacklight Instance
 
 Create a new GeoBlacklight instance with the GBLSI code
@@ -182,7 +205,9 @@ Then you can edit your GeoBlacklight settings.yml file to point at that solr fie
 
 ## View customization
 
-This GBL plugin includes a custom catalog/_index_split_default.html.erb file. Look there for examples on calling the image method.
+Use basic Active Storage patterns to display imagery in your application.
+
+### Example Methods
 
 ```ruby
 # Is there an image?
@@ -196,7 +221,30 @@ document.sidecar.image.variable?
 
 ```
 
-You'll definitely want to update this file to fit your own design's needs.
+### Search results
+
+This GBL plugin includes a custom [catalog/_index_split_default.html.erb file](https://github.com/geoblacklight/geoblacklight_sidecar_images/blob/develop/lib/generators/geoblacklight_sidecar_images/templates/views/catalog/_index_split_default.html.erb). Look there for examples on calling the image method.
+
+### Show pages
+
+Example for adding a thumbnail to the show page sidebar.
+
+*catalog/_show_sidebar.html.erb*
+
+```ruby
+# Add to end of file
+<% if @document.sidecar.image.attached? %>
+  <% if @document.sidecar.image.variable? %>
+    <div class="card">
+      <div class="card-header">Thumbnail</div>
+      <div class="card-body">
+        <%= image_tag @document.sidecar.image.variant(resize: "200"), {class: 'mr-3'} %>
+      </div>
+    </div>
+  <% end %>
+<% end %>
+
+```
 
 ## Development
 
@@ -229,5 +277,7 @@ tail -f log/image_service_development.log
 * ~~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.5.0 to 0.9.0 - Feedback; Improve test coverage; Collect additional real-world issues
-* 1.0.0 - Final 5.2 release
+* ~~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/Rakefile

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require 'rails'
 begin
   require 'bundler/setup'
+  require 'bundler/gem_tasks'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
@@ -16,17 +18,14 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
+require 'solr_wrapper/rake_task'
 require 'engine_cart/rake_task'
 require 'geoblacklight_sidecar_images/version'
 
 task ci: ['engine_cart:generate'] do
   ENV['environment'] = 'test'
-
-  SolrWrapper.wrap(port: '8983') do |solr|
+  SolrWrapper.wrap do |solr|
     solr.with_collection(name: 'blacklight-core', dir: File.join(__dir__, 'solr', 'conf')) do
-      # Fixtures here
-      # Rake::Task['spotlight:fixtures'].invoke
-
       # run the tests
       Rake::Task['spec'].invoke
     end

data/app/models/concerns/wms_rewrite_concern.rb

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

data/app/models/solr_document_sidecar.rb

@@ -3,7 +3,10 @@
 ##
 # Metadata for indexed documents
 class SolrDocumentSidecar < ApplicationRecord
-  include Statesman::Adapters::ActiveRecordQueries
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: SidecarImageTransition,
+    initial_state: :initialized
+  ]
 
   belongs_to :document, optional: false, polymorphic: true
   has_many :sidecar_image_transitions, autosave: false, dependent: :destroy

data/app/services/geoblacklight_sidecar_images/image_service.rb

@@ -41,8 +41,8 @@ module GeoblacklightSidecarImages
       end
 
       log_output
-    rescue Exception => invalid
-      @metadata['exception'] = invalid.inspect
+    rescue Exception => e
+      @metadata['exception'] = e.inspect
       @document.sidecar.image_state.transition_to!(:failed, @metadata)
 
       log_output
@@ -53,7 +53,6 @@ module GeoblacklightSidecarImages
     def image_tempfile(document_id)
       @metadata['viewer_protocol']      = @document.viewer_protocol
       @metadata['image_url']            = image_url
-      @metadata['service_url']          = service_url
       @metadata['gblsi_thumbnail_uri']  = gblsi_thumbnail_uri
 
       return nil unless image_data && @metadata['placeheld'] == false
@@ -151,17 +150,15 @@ module GeoblacklightSidecarImages
     # have not been set beyond the default, then a thumbnail url from
     # dct references is used instead.
     def image_url
-      @image_url ||= begin
-        if gblsi_thumbnail_uri
-          gblsi_thumbnail_uri
-        elsif restricted_scanned_map?
-          image_reference
-        elsif restricted_wms_layer? && !geoserver_credentials_valid?
-          image_reference
-        else
-          service_url || image_reference
-        end
-      end
+      @image_url ||= if gblsi_thumbnail_uri
+                       gblsi_thumbnail_uri
+                     elsif restricted_scanned_map?
+                       image_reference
+                     elsif restricted_wms_layer? && !geoserver_credentials_valid?
+                       image_reference
+                     else
+                       service_url || image_reference
+                     end
     end
 
     # Checks if the document is Local restriced access and is a scanned map.
@@ -180,11 +177,8 @@ module GeoblacklightSidecarImages
     # from the viewer protocol, and if it's loaded, the image_url
     # method is called.
     def service_url
-
       # Follow image_url instead
-      if gblsi_thumbnail_uri
-        return nil
-      end
+      return nil if gblsi_thumbnail_uri
 
       @service_url ||=
         begin

data/geoblacklight_sidecar_images.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'geoblacklight', '~> 2.0'
+  s.add_dependency 'geoblacklight', '>= 3.3'
   s.add_dependency 'mini_magick', '~> 4.9.4'
   s.add_dependency 'image_processing', '~> 1.6'
-  s.add_dependency 'statesman', '~> 3.4'
+  s.add_dependency 'statesman', '>= 3.4'
   s.add_dependency 'mimemagic', '~> 0.3'
-  s.add_dependency 'rails', '>= 5.2', '< 6'
+  s.add_dependency 'rails', '>= 5.2', '< 6.2'
 
   s.add_development_dependency 'byebug'
   s.add_development_dependency 'capybara'
@@ -31,8 +31,10 @@ Gem::Specification.new do |s|
   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 'rubocop', '~> 0.60.0'
+  s.add_development_dependency 'rubocop', '~> 1.9'
   s.add_development_dependency 'rubocop-rspec', '~> 1.30.0'
+  s.add_development_dependency 'rubocop-rails', '~> 2.9'
   s.add_development_dependency 'selenium-webdriver'
-  s.add_development_dependency 'solr_wrapper'
+  s.add_development_dependency 'solr_wrapper', '~> 3.1'
+  s.add_development_dependency 'sprockets', '< 4'
 end

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

@@ -1,5 +1,5 @@
 <% # header bar for doc items in index view -%>
-<%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+<%= 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>

data/lib/geoblacklight_sidecar_images/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightSidecarImages
-  VERSION = '0.6.2'
+  VERSION = '0.8.1'
 end

data/lib/tasks/geoblacklight_sidecar_images_tasks.rake

@@ -20,7 +20,7 @@ namespace :gblsci do
   namespace :images do
     desc 'Harvest image for specific document'
     task :harvest_doc_id, [:doc_id] => [:environment] do |_t, args|
-      StoreImageJob.perform_later(args[:doc_id])
+      GeoblacklightSidecarImages::StoreImageJob.perform_later(args[:doc_id])
     end
 
     desc 'Harvest all images'

data/spec/models/solr_document_sidecar_spec.rb

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-describe GeoblacklightSidecarImages::SolrDocumentSidecar do
+describe SolrDocumentSidecar do
   let(:document) { SolrDocument.new(document_attributes) }
 
   describe '#sidecar' do

data/spec/services/image_service_spec.rb

@@ -35,8 +35,7 @@ describe GeoblacklightSidecarImages::ImageService do
       expect(wms_imgsvc.send(:image_url)).to include 'wms'
     end
 
-    it 'returns image_url over service_url when settings thumbnail field' do
-      expect(map_imgsvc.send(:image_url)).to include 'illinois'
+    it 'returns no service_url when settings thumbnail field' do
       expect(map_imgsvc.send(:service_url)).to be_falsey
     end
   end

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

@@ -11,7 +11,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def add_gems
     gem 'blacklight', '~> 7.0'
-    gem 'geoblacklight', '~> 2.0'
+    gem 'geoblacklight', '>= 3.0'
 
     Bundler.with_clean_env do
       run 'bundle install'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight_sidecar_images
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Eric Larson
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geoblacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -57,14 +57,14 @@ dependencies:
   name: statesman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
@@ -90,7 +90,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -191,14 +191,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +213,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.30.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -231,16 +245,30 @@ dependencies:
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: 
 email:
 - ewlarson@umn.edu
@@ -252,6 +280,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".solr_wrapper.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -379,8 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Store local copies of remote imagery in GeoBlacklight