geoblacklight_sidecar_images 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e89b436bb5ef1c4905c614eb923397f8837fe7169095e5ec784c8631cfe04e1
-  data.tar.gz: 18b958b4b4b274ae213281220f00f8557ccc2249807799d467a09fdce33e1986
+  metadata.gz: 8ae3e9ab51f23610aac2e673df45127839969fd50605b78754d5e7ce6a5f7301
+  data.tar.gz: ec8d5992aa11cec13dc91cb307207186def7113f0079ebf8cca95ec13c1eb410
 SHA512:
-  metadata.gz: bda9efbc7d361c8c171ff39179f63f8b7046d4aff1892c38a58d92a4cede4c6314838778a07a179809ce7c223a4996b910ba48446f6d6405e012dc3332ed9b99
-  data.tar.gz: 8b0a0b1a0e2a6a6de19b441e192656f0a224505b19f5130f998668084b3698476afbec31b55320609adca7ef16b3967f0a63a7f6b9b7dcebebcd7cb22b4b743a
+  metadata.gz: 017b1d571f0589de1e0e28188fa1c2536bf3889fde482293bd7e2f0c3c04fd86facea0ba7b5c2c2eafff863361b17ba58919bfd6f0d063ea8fb94c0ea91f133d
+  data.tar.gz: 570c963adb6102ab3d8576c78e07b809053713d0fa8685c3e81ea0cddf7db48d1859bd35228bc493fa36a5c4c19887c018bb6616260f08c58ee07519fc558922

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.
 
@@ -19,7 +25,7 @@ This GeoBlacklight plugin captures remote images from geographic web services an
 * [GeoBlacklight](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
 

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/services/geoblacklight_sidecar_images/image_service.rb

@@ -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,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

@@ -34,5 +34,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop', '~> 0.60.0'
   s.add_development_dependency 'rubocop-rspec', '~> 1.30.0'
   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/geoblacklight_sidecar_images/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightSidecarImages
-  VERSION = '0.6.2'
+  VERSION = '0.6.4'
 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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight_sidecar_images
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.4
 platform: ruby
 authors:
 - Eric Larson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geoblacklight
@@ -231,16 +231,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
@@ -379,8 +393,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.2
 signing_key: 
 specification_version: 4
 summary: Store local copies of remote imagery in GeoBlacklight