RubyGems - geoblacklight_sidecar_images - Versions diffs - 0.0.1 - Mend

geoblacklight_sidecar_images 0.0.1

Files changed (105) hide show

data/app/assets/config/geoblacklight_sidecar_images_manifest.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ //= link_directory ../javascripts/geoblacklight_sidecar_images .js
2	+ //= link_directory ../stylesheets/geoblacklight_sidecar_images .css

data/app/assets/images/geoblacklight_sidecar_images/.keep ADDED Viewed

File without changes

data/app/assets/javascripts/geoblacklight_sidecar_images/application.js ADDED Viewed

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/geoblacklight_sidecar_images/application.css ADDED Viewed

@@ -0,0 +1,15 @@
+/*
+ * 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/controllers/geoblacklight_sidecar_images/application_controller.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module GeoblacklightSidecarImages
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/geoblacklight_sidecar_images/application_helper.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module GeoblacklightSidecarImages
+  module ApplicationHelper
+  end
+end

data/app/jobs/geoblacklight_sidecar_images/application_job.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module GeoblacklightSidecarImages
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/geoblacklight_sidecar_images/application_mailer.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module GeoblacklightSidecarImages
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/geoblacklight_sidecar_images/application_record.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module GeoblacklightSidecarImages
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/geoblacklight_sidecar_images/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Geoblacklight sidecar images</title>
+  <%= stylesheet_link_tag    "geoblacklight_sidecar_images/application", media: "all" %>
+  <%= javascript_include_tag "geoblacklight_sidecar_images/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/routes.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ GeoblacklightSidecarImages::Engine.routes.draw do
2	+ end

data/db/migrate/20180118203155_create_solr_document_sidecars.rb ADDED Viewed

@@ -0,0 +1,12 @@
+class CreateSolrDocumentSidecars < ActiveRecord::Migration[5.1]
+  def change
+    create_table :solr_document_sidecars do |t|
+      t.string "document_id"
+      t.string "document_type"
+      t.string "image"
+      t.index ["document_type", "document_id"], name: "solr_document_sidecars_solr_document"
+      t.timestamps
+    end
+  end
+end

data/geoblacklight_sidecar_images.gemspec ADDED Viewed

@@ -0,0 +1,37 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# Maintain your gem's version:
+require 'geoblacklight_sidecar_images/version'
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'geoblacklight_sidecar_images'
+  s.version     = GeoblacklightSidecarImages::VERSION
+  s.authors     = ['Eric Larson', 'Eliot Jordan']
+  s.email       = ['ewlarson@umn.edu']
+  s.homepage    = 'https://github.com/ewlarson/geoblacklight_sidecar_images'
+  s.summary     = 'Store local copies of remote imagery in GeoBlacklight'
+  s.license     = 'Apache 2.0'
+  s.files         = `git ls-files -z`.split(%Q{\x0})
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_dependency 'aasm'
+  s.add_dependency 'carrierwave'
+  s.add_dependency 'geoblacklight', '~> 1.7'
+  s.add_dependency 'mini_magick'
+  s.add_dependency 'rails', '>= 4.2', '< 6'
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'chromedriver-helper'
+  s.add_development_dependency 'database_cleaner', '~> 1.3'
+  s.add_development_dependency 'engine_cart', '~> 1.0'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.53.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.18.0'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'solr_wrapper'
+end

data/lib/generators/geoblacklight_sidecar_images/assets_generator.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'rails/generators'
+module GeoblacklightSidecarImages
+  class AssetsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Copies asset image files to host app/assets/images
+    DESCRIPTION
+    def create_images_assets
+      thumbs = [
+        'thumbnail-image.png',
+        'thumbnail-line.png',
+        'thumbnail-mixed.png',
+        'thumbnail-multipoint.png',
+        'thumbnail-paper-map.png',
+        'thumbnail-point.png',
+        'thumbnail-polygon.png',
+        'thumbnail-raster.png'
+      ]
+      thumbs.each do |tbnl|
+        copy_file("assets/images/#{tbnl}", "app/assets/images/#{tbnl}")
+      end
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/example_docs_generator.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'rails/generators'
+module GeoblacklightSidecarImages
+  class ExampleDocsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../spec/fixtures', __dir__)
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Copies the dir of example solr doc files to host app/solr/geoblacklight/example_docs
+    DESCRIPTION
+    def create_services
+      directory 'files', 'solr/geoblacklight/example_docs'
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/install_generator.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require 'rails/generators'
+module GeoblacklightSidecarImages
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Install GeoblacklightSidecarImages'
+    def add_settings_vars
+      inject_into_file 'config/settings.yml', after: "INSTITUTION: 'Stanford'\n" do
+"INSTITUTION_LOCAL_NAME: 'Princeton'
+INSTITUTION_GEOSERVER_URL: 'https://geoserver.princeton.edu'
+PROXY_GEOSERVER_URL: 'http://localhost:3000'
+PROXY_GEOSERVER_AUTH: 'Basic base64encodedusername:password'"
+      end
+    end
+    def add_carrierwave_require
+      inject_into_file 'config/application.rb', after: "require 'rails/all'" do
+        "\n  require 'carrierwave'"
+      end
+    end
+    def generate_geoblacklight_assets
+      generate 'geoblacklight_sidecar_images:assets'
+    end
+    def generate_geoblacklight_example_docs
+      generate 'geoblacklight_sidecar_images:example_docs'
+    end
+    def generate_geoblacklight_jobs
+      generate 'geoblacklight_sidecar_images:jobs'
+    end
+    def generate_geoblacklight_models
+      generate 'geoblacklight_sidecar_images:models'
+    end
+    def generate_geoblacklight_services
+      generate 'geoblacklight_sidecar_images:services'
+    end
+    def generate_geoblacklight_uploaders
+      generate 'geoblacklight_sidecar_images:uploaders'
+    end
+    def generate_geoblacklight_views
+      generate 'geoblacklight_sidecar_images:views'
+    end
+    def bundle_install
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/jobs_generator.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'rails/generators'
+module GeoblacklightSidecarImages
+  class JobsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Copies jobs files to host app/jobs
+       2. Configures a default development environment queue adapter
+    DESCRIPTION
+    def create_store_image_jobs
+      copy_file 'jobs/store_image_job.rb', 'app/jobs/store_image_job.rb'
+    end
+    def config_development_jobs_queue_adapter
+      job_config = <<-"JOBS"
+        config.active_job.queue_adapter = :inline
+      JOBS
+      inject_into_file 'config/environments/development.rb', job_config, before: /^end/
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/models_generator.rb ADDED Viewed

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/migration'
+module GeoblacklightSidecarImages
+  class ModelsGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('templates', __dir__)
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Preps engine migrations
+       2. Adds SolrDocumentSidecar ActiveRecord model
+       3. Adds WmsRewriteConcern
+    DESCRIPTION
+    # Setup the database migrations
+    def copy_migrations
+      rake 'geoblacklight_sidecar_images:install:migrations'
+    end
+    def include_sidecar_solrdocument
+      sidecar = <<-"SIDECAR"
+        def sidecar
+          SolrDocumentSidecar.find_or_create_by!(
+            document_id: id,
+            document_type: self.class.to_s
+          )
+        end
+      SIDECAR
+      inject_into_file 'app/models/solr_document.rb', sidecar, before: /^end/
+    end
+    def create_solr_document_sidecar
+      copy_file(
+        'models/solr_document_sidecar.rb',
+        'app/models/solr_document_sidecar.rb'
+      )
+    end
+    def create_wms_rewrite_concern
+      copy_file(
+        'models/concerns/wms_rewrite_concern.rb',
+        'app/models/concerns/wms_rewrite_concern.rb'
+      )
+    end
+    def include_wms_rewrite_solrdocument
+      inject_into_file(
+        'app/models/solr_document.rb',
+        after: 'include Geoblacklight::SolrDocument'
+      ) do
+        "\n include WmsRewriteConcern"
+      end
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/services_generator.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails/generators'
+module GeoblacklightSidecarImages
+  class ServicesGenerator < 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/services directory
+       2. Creates service models within the app/services directory
+    DESCRIPTION
+    def create_services
+      directory 'services', 'app/services'
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-image.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-line.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-mixed.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-multipoint.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-paper-map.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-point.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-polygon.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/images/thumbnail-raster.png ADDED Viewed

Binary file

data/lib/generators/geoblacklight_sidecar_images/templates/assets/javascripts/geoblacklight.js ADDED Viewed

@@ -0,0 +1,9 @@
+//= require geoblacklight/geoblacklight
+//= require geoblacklight/basemaps
+//= require geoblacklight/controls
+//= require geoblacklight/viewers
+//= require geoblacklight/modules
+//= require geoblacklight/downloaders
+//= require leaflet-iiif
+//= require esri-leaflet
+//= require readmore.min

data/lib/generators/geoblacklight_sidecar_images/templates/assets/stylesheets/geoblacklight.scss ADDED Viewed

@@ -0,0 +1,3 @@
+/*
+*= require geoblacklight/application
+*/

data/lib/generators/geoblacklight_sidecar_images/templates/jobs/store_image_job.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class StoreImageJob < ApplicationJob
+  queue_as :default
+  def perform(document_hash)
+    doc = SolrDocument.new(document_hash)
+    ImageService.new(doc).store
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/models/concerns/wms_rewrite_concern.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module WmsRewriteConcern
+  extend Geoblacklight::SolrDocument
+  def viewer_endpoint
+    if local_restricted?
+      # replace wms prefix with cas authed proxy
+      super.gsub(Settings.INSTITUTION_GEOSERVER_URL, Settings.PROXY_GEOSERVER_URL)
+    else
+      super
+    end
+  end
+  def local_restricted?
+    local? && restricted?
+  end
+  def local?
+    fetch(:dct_provenance_s, '').casecmp(Settings.INSTITUTION_LOCAL_NAME).zero?
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/models/solr_document_sidecar.rb ADDED Viewed

@@ -0,0 +1,16 @@
+##
+# Metadata for indexed documents
+class SolrDocumentSidecar < ApplicationRecord
+  mount_uploader :image, ImageUploader
+  belongs_to :document, required: true, polymorphic: true
+  # Roll our own polymorphism because our documents are not AREL-able
+  def document
+    document_type.new document_type.unique_key => document_id
+  end
+  def document_type
+    (super.constantize if defined?(super)) || default_document_type
+  end
+end