geoblacklight_sidecar_images 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72cc3fac516c465122adca9f440104db7d2012588d4562de7c467134208d758
-  data.tar.gz: 3c6ab484395eb53f804d1c6f916de049be21d3d18f09c9201055a87dcc226009
+  metadata.gz: fef925ce1a979f49bc5367e37df753875e9ef4342b818a902ec8e43e5e92e83d
+  data.tar.gz: 40d07638860d73938360e4c4328b17cbaca770e2bba3ae2b0fab1b2497663814
 SHA512:
-  metadata.gz: 3ce1fe5b78fa81dac0c70f09e73d7cdcdddb06136ccff8c4b75ab80a42dabc205800ddd59ce320f2ac62d8c7916be0b6713f46199d4a8a9f1ca2dba973896dc3
-  data.tar.gz: cd1e00e5b1781c95a409cbdfd8c73ef62c48c3ada88eda5a640c4cac4e0209627f40aee71a5d178ac9a4e0796f902af10dacf7f44212c9c860c7fa630a5c1d32
+  metadata.gz: 36a95037c48e9914211e3376f8c33ea5e81dcf5e067cc31b11d92433c382bd6076727a1ab6ecab339dd74c67fa768b96557d40e696d523242410171aa2960649
+  data.tar.gz: '09a55bddc96a1268b7725e4f1cbd4369e9297789a4aed5af037e83854c3094bec3c2958e7c7543f8540dc9428b915ce24324110241a3cab93e882aaca167ea12'

data/.rubocop.yml

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

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 'rails', '>= 5.2', '< 6.2'
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -7,6 +7,12 @@
 
 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](https://weblog.rubyonrails.org/releases/)
+* [GeoBlacklight >= 2.0](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,6 @@ 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.7.0 to 0.9.0 - Feedback; Improve test coverage; Collect additional real-world issues
+* 1.0.0 - Final release

data/Rakefile

@@ -16,17 +16,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/assets/stylesheets/geoblacklight_sidecar_images/modules/_results.scss

@@ -2,6 +2,7 @@
 .media {
   img,span {
     min-width: 100px;
+    max-width: 100px;
     text-align: center;
   }
   span.icon.square {

data/app/models/solr_document_sidecar.rb

@@ -3,15 +3,15 @@
 ##
 # 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
   has_one_attached :image
 
-  # If the sidecar solr document is updated, re-fetch thumbnail image
-  after_update :reimage, if: :saved_change_to_version?
-
   def document
     document_type.new document_type.unique_key => document_id
   end
@@ -39,12 +39,10 @@ class SolrDocumentSidecar < ApplicationRecord
     Rails.application.routes.url_helpers.rails_blob_path(image, only_path: true)
   end
 
-  private_class_method :initial_state
-
-  private
-
-  def reimage
+  def reimage!
     image.purge if image.attached?
     GeoblacklightSidecarImages::StoreImageJob.perform_later(document.id)
   end
+
+  private_class_method :initial_state
 end

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
@@ -180,11 +179,15 @@ module GeoblacklightSidecarImages
     # from the viewer protocol, and if it's loaded, the image_url
     # method is called.
     def service_url
+      # Follow image_url instead
+      return nil if gblsi_thumbnail_uri
+
       @service_url ||=
         begin
           return unless @document.available?
 
           protocol = @document.viewer_protocol
+
           if protocol == 'map' || protocol.nil?
             @metadata['error'] = 'Unsupported viewer protocol'
             @metadata['placeheld'] = true

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', '>= 2.0'
   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', '~> 2.2'
+  s.add_development_dependency 'sprockets', '< 4'
 end

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

@@ -15,7 +15,7 @@
     <div class='media'>
       <% if document.sidecar.image.attached? %>
         <% if document.sidecar.image.variable? %>
-          <%= image_tag document.sidecar.image.variant(resize: "100x100"), {class: 'mr-3'} %>
+          <%= image_tag document.sidecar.image.variant(resize: "200"), {class: 'mr-3'} %>
         <% else %>
           <%= image_tag document.sidecar.image, {class: 'mr-3'} %>
         <% end %>

data/lib/geoblacklight_sidecar_images/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightSidecarImages
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 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/fixtures/files/b1g_thumbnail.json

@@ -0,0 +1,42 @@
+{
+  "geoblacklight_version": "1.0",
+  "dc_description_s": "The Illinois Environmental Protection Agency's collection of geospatial resources on their Open Data Geoportal include vehicle emissions testing locations and waste disposal sites.",
+  "layer_modified_dt": "2019-08-29T16:54:48Z",
+  "solr_geom": "ENVELOPE(-91.51308, -87.49520, 42.50848, 36.97030)",
+  "dct_references_s": "{\"http://schema.org/url\":\"https://illinoisepaopendata-illinois-epa.opendata.arcgis.com\"}",
+  "dc_rights_s": "Public",
+  "b1g_centroid_ss": "39.73939,-89.50414",
+  "layer_geom_type_s": "Table",
+  "b1g_status_s": "Active",
+  "dct_provenance_s": "Illinois",
+  "dc_subject_sm": [
+    "State agencies geospatial data"
+  ],
+  "dct_temporal_sm": [
+    "2015-2018"
+  ],
+  "b1g_code_s": "02a-02",
+  "b1g_genre_sm": [
+    "Geospatial data"
+  ],
+  "b1g_keyword_sm": [
+    "Environment,Health,Transportation,Location"
+  ],
+  "dc_creator_sm": [
+    "Illinois Environmental Protection Agency"
+  ],
+  "dc_identifier_s": "02a-02",
+  "solr_year_i": 2015,
+  "thumbnail_path_ss": "https://www2.illinois.gov/epa/Style%20Library/SOISierra/Images/SiteLogo.png",
+  "dct_spatial_sm": [
+    "Illinois"
+  ],
+  "dc_publisher_sm": [
+    "State of Illinois"
+  ],
+  "dc_type_sm": [
+    "Collection"
+  ],
+  "dc_title_s": "Illinois EPA Open Data",
+  "layer_slug_s": "02a-02"
+}

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

@@ -9,6 +9,8 @@ describe GeoblacklightSidecarImages::ImageService do
   let(:wms_imgsvc) { described_class.new(wms_document) }
   let(:thumb_document) { SolrDocument.new(json_data('umn_solr_thumb')) }
   let(:thumb_imgsvc) { described_class.new(thumb_document) }
+  let(:map_document) { SolrDocument.new(json_data('b1g_thumbnail')) }
+  let(:map_imgsvc) { described_class.new(map_document) }
 
   # @TODO: bdcbcd3e-f6db-4ee4-b7b7-d75fe35f1d92 - Michigan State - thumbnail_path_ss
 
@@ -32,6 +34,10 @@ describe GeoblacklightSidecarImages::ImageService do
     it 'returns references without a settings thumbnail field value' do
       expect(wms_imgsvc.send(:image_url)).to include 'wms'
     end
+
+    it 'returns no service_url when settings thumbnail field' do
+      expect(map_imgsvc.send(:service_url)).to be_falsey
+    end
   end
 
   context 'when #iiif' do

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.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Eric Larson
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2021-02-09 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -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: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
+- !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
@@ -316,6 +344,7 @@ files:
 - spec/fixtures/files/actual-point1.json
 - spec/fixtures/files/actual-polygon1.json
 - spec/fixtures/files/actual-raster1.json
+- spec/fixtures/files/b1g_thumbnail.json
 - spec/fixtures/files/baruch_ancestor1.json
 - spec/fixtures/files/baruch_ancestor2.json
 - spec/fixtures/files/baruch_documentation_download.json
@@ -378,8 +407,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
@@ -389,6 +417,7 @@ test_files:
 - spec/fixtures/files/actual-point1.json
 - spec/fixtures/files/actual-polygon1.json
 - spec/fixtures/files/actual-raster1.json
+- spec/fixtures/files/b1g_thumbnail.json
 - spec/fixtures/files/baruch_ancestor1.json
 - spec/fixtures/files/baruch_ancestor2.json
 - spec/fixtures/files/baruch_documentation_download.json