geoblacklight_admin 0.0.1

data/geoblacklight_admin.gemspec

@@ -0,0 +1,67 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "geoblacklight_admin/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = "geoblacklight_admin"
+  s.version = GeoblacklightAdmin::VERSION
+  s.authors = ["Eric Larson"]
+  s.email = ["ewlarson@gmail.com"]
+  s.homepage = "https://github.com/geobtaa/geoblacklight_admin"
+  s.summary = "Administrative UI for GeoBlacklight. Built on Kithe."
+  s.license = "MIT"
+
+  s.files = `git ls-files -z`.split(%(\x0))
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "active_storage_validations", "~> 1.0"
+  s.add_dependency "amazing_print"
+  s.add_dependency "bootstrap", "~> 4.0"
+  s.add_dependency "cocoon", "~> 1.2"
+  s.add_dependency "config", "~> 4.0"
+  s.add_dependency "chosen-rails", "1.0"
+  s.add_dependency "devise", "~> 4.7"
+  s.add_dependency "devise-bootstrap-views", "~> 1.0"
+  s.add_dependency "devise_invitable", "~> 2.0"
+  s.add_dependency "blacklight", "~> 7.33"
+  s.add_dependency "blacklight_advanced_search"
+  s.add_dependency "geoblacklight", "~> 4.0"
+  s.add_dependency "haml", "~> 5.2.0"
+  s.add_dependency "httparty", "~> 0.21"
+  s.add_dependency "inline_svg", "~> 1.9"
+  s.add_dependency "jquery-rails", "~> 4.4"
+  s.add_dependency "kithe", "~> 2.0"
+  s.add_dependency "noticed", "~> 1.6"
+  s.add_dependency "pagy", "~> 3.8"
+  s.add_dependency "paper_trail", "~> 14.0"
+  s.add_dependency "pg", "~> 1.4"
+  s.add_dependency "qa", "~> 5.0"
+  s.add_dependency "rails", ">= 6.1", "< 7.1"
+  s.add_dependency "ruby-progressbar"
+  s.add_dependency "simple_form", "~> 5.0"
+  s.add_dependency "sprockets", "< 4"
+  s.add_dependency "statesman", "~> 7.1.0"
+
+  s.add_development_dependency "byebug", "~> 11.1"
+  s.add_development_dependency "capybara", "~> 3.0"
+  s.add_development_dependency "capybara-screenshot", "~> 1.0"
+  s.add_development_dependency "database_cleaner", "~> 1.3"
+  s.add_development_dependency "database_cleaner-active_record", "~> 2.1"
+  s.add_development_dependency "engine_cart", "~> 2.4"
+  s.add_development_dependency "m", "~> 1.5"
+  s.add_development_dependency "minitest", "~> 5.18"
+  s.add_development_dependency "minitest-ci", "~> 3.4"
+  s.add_development_dependency "minitest-rails", "~> 6.1"
+  s.add_development_dependency "minitest-reporters", "~> 1.6"
+  s.add_development_dependency "rspec-rails", "~> 3.0"
+  s.add_development_dependency "selenium-webdriver"
+  s.add_development_dependency "shoulda-context", "~> 2.0"
+  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 "webdrivers"
+end

data/lib/generators/geoblacklight_admin/config_generator.rb

@@ -0,0 +1,336 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module GeoblacklightAdmin
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Copies GBL Admin initializer file to host config 
+       2. Copies Kithe initializer file to host config
+       3. Copies Pagy initializer file to host config
+       4. Copies Statesman initializer file to host config
+       5. Copies PG database.yml connection to host config
+       6. Copies .env.development to host
+       7. Copies solr/* to host
+       8. Sets Routes
+       9. Sets Gems
+       10.Sets MimeTypes
+       11.Sets DB Seeds
+       12.Sets Pagy Backend
+
+    DESCRIPTION
+
+    def create_gbl_admin_initializer
+      copy_file "config/initializers/geoblacklight_admin.rb", "config/initializers/geoblacklight_admin.rb"
+    end
+
+    def create_kithe_initializer
+      copy_file "config/initializers/kithe.rb", "config/initializers/kithe.rb"
+    end
+
+    def create_pagy_initializer
+      copy_file "config/initializers/pagy.rb", "config/initializers/pagy.rb"
+    end
+
+    def create_statesman_initializer
+      copy_file "config/initializers/statesman.rb", "config/initializers/statesman.rb"
+    end
+
+    def create_database_yml
+      copy_file "config/database.yml", "config/database.yml", force: true
+    end
+
+    def create_dotenv
+      copy_file ".env.development.example", ".env.development"
+    end
+
+    def copy_json_schema
+      copy_file "config/geomg_aardvark_schema.json", "config/geomg_aardvark_schema.json"
+    end
+
+    def copy_solr
+      directory 'solr', 'solr', force: true
+    end
+
+    def create_solr_yml
+      copy_file ".solr_wrapper.yml", ".solr_wrapper.yml", force: true
+    end
+
+    def set_routes
+      gbl_admin_routes = <<-"ROUTES"
+        ####################
+        # GBL‡ADMIN
+
+        # Bulk Actions
+        resources :bulk_actions do
+          patch :run, on: :member
+          patch :revert, on: :member
+        end
+
+        # Users
+        devise_for :users, controllers: {invitations: "devise/invitations"}, skip: [:registrations]
+        as :user do
+          get "/sign_in" => "devise/sessions#new" # custom path to login/sign_in
+          get "/sign_up" => "devise/registrations#new", :as => "new_user_registration" # custom path to sign_up/registration
+          get "users/edit" => "devise/registrations#edit", :as => "edit_user_registration"
+          put "users" => "devise/registrations#update", :as => "user_registration"
+        end
+
+        namespace :admin do
+          # Root
+          root to: "documents#index"
+
+          # Bulk Actions
+          resources :bulk_actions do
+            patch :run, on: :member
+            patch :revert, on: :member
+          end
+        
+          # Imports
+          resources :imports do
+            resources :mappings
+            resources :import_documents, only: [:show]
+            patch :run, on: :member
+          end
+        
+          # Elements
+          resources :elements do
+            post :sort, on: :collection
+          end
+
+          # Form Elements
+          resources :form_elements do
+            post :sort, on: :collection
+          end
+          resources :form_header, path: :form_elements, controller: :form_elements
+          resources :form_group, path: :form_elements, controller: :form_elements
+          resources :form_control, path: :form_elements, controller: :form_elements
+          resources :form_feature, path: :form_elements, controller: :form_elements
+        
+          # Notifications
+          resources :notifications do
+            put "batch", on: :collection
+          end
+
+          # Users
+          get "users/index"
+
+          # Bookmarks
+          resources :bookmarks
+          delete "/bookmarks", to: "bookmarks#destroy", as: :bookmarks_destroy_by_fkeys
+          
+          # AdvancedSearch controller
+          get '/advanced_search' => 'advanced_search#index', constraints: lambda { |req| req.format == :json }
+          get '/advanced_search/facets' => 'advanced_search#facets', constraints: lambda { |req| req.format == :json }
+          get '/advanced_search/facet/:id' => 'advanced_search#facet', constraints: lambda { |req| req.format == :json }, as: 'advanced_search_facet'
+
+          # Ids controller
+          get '/api/ids' => 'ids#index', constraints: lambda { |req| req.format == :json }
+          get '/api' => 'api#index', constraints: lambda { |req| req.format == :json }
+          get '/api/fetch' => 'api#fetch', constraints: lambda { |req| req.format == :json }
+          get '/api/facet/:id' => 'api#facet', constraints: lambda { |req| req.format == :json }
+
+          # Documents
+          resources :documents do
+            get "versions"
+            
+            # DocumentAccesses
+            resources :document_accesses, path: "access" do
+              collection do
+                get "import"
+                post "import"
+        
+                get "destroy_all"
+                post "destroy_all"
+              end
+            end
+            
+            # DocumentDownloads
+            resources :document_downloads, path: "downloads" do
+              collection do
+                get "import"
+                post "import"
+        
+                get "destroy_all"
+                post "destroy_all"
+              end
+            end
+            
+            # Document Assets
+            resources :document_assets, path: "assets" do
+              collection do
+                get "display_attach_form"
+                post "attach_files"
+        
+                get "destroy_all"
+                post "destroy_all"
+              end
+            end
+        
+            collection do
+              get "fetch"
+            end
+          end
+          
+          # Document Accesses
+          resources :document_accesses, path: "access" do
+            collection do
+              get "import"
+              post "import"
+        
+              get "destroy_all"
+              post "destroy_all"
+            end
+          end
+        
+          # Document Downloads
+          resources :document_downloads, path: "downloads" do
+            collection do
+              get "import"
+              post "import"
+        
+              get "destroy_all"
+              post "destroy_all"
+            end
+          end
+        
+          # Document Assets
+          resources :document_assets, path: "assets" do
+            collection do
+              get "display_attach_form"
+              post "attach_files"
+        
+              get "destroy_all"
+              post "destroy_all"
+            end
+          end
+        
+          get "/documents/:id/ingest", to: "document_assets#display_attach_form", as: "asset_ingest"
+          post "/documents/:id/ingest", to: "document_assets#attach_files"
+          #mount Kithe::AssetUploader.upload_endpoint(:cache) => "/direct_upload", :as => :direct_app_upload
+        
+          resources :collections, except: [:show]
+        
+          # Note "assets" is Rails reserved word for routing, oops. So we use
+          # asset_files.
+          resources :assets, path: "asset_files", except: [:new, :create] do
+            member do
+              put "convert_to_child_work"
+            end
+          end
+        
+          # @TODO
+          # mount Qa::Engine => "/authorities"
+          mount ActionCable.server => "/cable"
+        
+          # @TODO
+          # authenticate :user, ->(user) { user } do
+            # mount Blazer::Engine, at: "blazer"
+          # end
+        end
+      ROUTES
+
+      inject_into_file "config/routes.rb", gbl_admin_routes, before: /^end/
+    end
+
+    def set_gems
+      append_to_file "Gemfile" do
+        "
+# GBL‡ADMIN // @TODO: Why is this necessary? Shouldn't the engine dependencies get installed on their own?
+gem 'active_storage_validations', '~> 1.0'
+gem 'amazing_print'
+gem 'blacklight_advanced_search'
+gem 'bootstrap', '~> 4.0'
+gem 'cocoon', '~> 1.2'
+# gem 'devise', '~> 4.7'
+gem 'devise-bootstrap-views', '~> 1.0'
+gem 'devise_invitable', '~> 2.0'
+gem 'dotenv-rails'
+gem 'haml', '~> 5.2'
+gem 'httparty'
+gem 'inline_svg'
+# gem 'jquery-rails', '~> 4.4'
+gem 'kithe', '~> 2.0'
+gem 'noticed'
+gem 'pagy'
+gem 'paper_trail'
+gem 'qa', '~> 5.0'
+gem 'ruby-progressbar'
+gem 'simple_form', '~> 5.0'
+gem 'statesman', '~> 7.1.0'
+        "
+      end
+    end
+
+    def set_mime_types
+      append_to_file "config/initializers/mime_types.rb" do
+        '
+# GBL‡ADMIN
+# Order is important. ActiveStorage needs :json to be last
+Mime::Type.register "application/json", :json_aardvark
+Mime::Type.register "application/json", :json_btaa_aardvark
+Mime::Type.register "application/json", :json_gbl_v1
+Mime::Type.register "application/json", :json
+Mime::Type.register "text/csv", :csv_document_downloads
+Mime::Type.register "text/csv", :csv_document_access_links
+        '
+      end
+    end
+
+    def set_seeds
+      append_to_file "db/seeds.rb" do
+        'GeoblacklightAdmin::Engine.load_seed'
+      end
+    end
+
+    def add_pagy
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  include Pagy::Backend\n" \
+      end
+    end
+
+    def add_activestorage
+      append_to_file "app/assets/javascripts/application.js" do
+"
+
+// Required by GBL Admin
+//= require activestorage"
+      end
+    end
+
+    def add_user_util_links
+      copy_file "_user_util_links.html.erb", "app/views/shared/_user_util_links.html.erb"
+    end
+
+    # @TODO
+    # I'm certain this is not the best way to inject our JS behaviors into the root app
+    # But for now, this will do...
+    # Long term I hope to avoid webpack here altogether.
+    def copy_app_javascript
+      directory 'javascript', 'app/javascript', force: true
+    end
+
+    def add_package_json
+      copy_file "package.json", "package.json", force: true
+    end
+
+    def add_assets_initialier
+      append_to_file "config/initializers/assets.rb" do
+        "
+        # GBL ADMIN
+        Rails.application.config.assets.paths << Rails.root.join('node_modules')
+        Rails.application.config.assets.precompile += %w( geoblacklight_admin.js )
+        Rails.application.config.assets.precompile += %w[application.js]"
+      end
+    end
+
+    def add_catalog_controller_default_params
+      inject_into_file "app/controllers/catalog_controller.rb", after: "'q.alt' => '*:*'" do
+        ",\n      'fq' => ['b1g_publication_state_s:published']"
+      end
+    end
+  end
+end

data/lib/generators/geoblacklight_admin/example_docs_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module GeoblacklightAdmin
+  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_admin/helpers_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module GeoblacklightAdmin
+  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
+      # @TODO
+    end
+  end
+end

data/lib/generators/geoblacklight_admin/install_generator.rb

@@ -0,0 +1,60 @@
+require "rails/generators"
+
+module GeoblacklightAdmin
+  class Install < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Install GeoblacklightAdmin"
+
+    def add_settings_vars
+    end
+
+    def bundle_install
+      Bundler.with_unbundled_env do
+        run "bundle install"
+      end
+    end
+
+    def generate_gbl_admin_assets
+      inject_into_file "app/assets/stylesheets/application.scss", after: "@import 'geoblacklight';\n" do
+        "@import 'geoblacklight_admin/core';"
+      end
+    end
+
+    def generate_gbl_admin_example_docs
+      generate "geoblacklight_admin:example_docs"
+    end
+
+    def generate_gbl_admin_jobs
+      generate "geoblacklight_admin:jobs"
+    end
+
+    def generate_gbl_admin_models
+      generate "geoblacklight_admin:models"
+    end
+
+    def generate_gbl_admin_views
+      generate "geoblacklight_admin:views"
+    end
+
+    def generate_gbl_admin_helpers
+      generate "geoblacklight_admin:helpers"
+    end
+
+    def generate_gbl_admin_config
+      generate "geoblacklight_admin:config"
+    end
+
+    def kithe_install
+      run "bundle exec rails generate simple_form:install --bootstrap"
+    end
+
+    def install_active_storage
+      run "bin/rails active_storage:install"
+    end
+
+    def yarn_install
+      run "yarn install"
+    end
+  end
+end

data/lib/generators/geoblacklight_admin/jobs_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module GeoblacklightAdmin  class JobsGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Configures a default development environment queue adapter
+    DESCRIPTION
+
+    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_admin/models_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+
+module GeoblacklightAdmin
+  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
+    DESCRIPTION
+
+    # Setup the database migrations
+    def copy_migrations
+      rake "geoblacklight_admin:install:migrations"
+    end
+
+  end
+end

data/lib/generators/geoblacklight_admin/templates/.env.development.example

@@ -0,0 +1,28 @@
+SOLR_VERSION=8.11.1
+
+# Solr - Local development
+SOLR_URL=http://127.0.0.1:8983/solr/blacklight-core
+
+# Solr - Remote development
+# SOLR_URL=https://remote_server/solr/core
+# SOLR_BASIC_AUTH_USER=user
+# SOLR_BASIC_AUTH_PASSWORD=password
+
+# BL API
+BLACKLIGHT_URL=http://localhost:3000
+BLACKLIGHT_JSON_API=http://localhost:3000/admin/api.json
+BLACKLIGHT_JSON_API_IDS=http://localhost:3000/admin/api/ids.json
+BLACKLIGHT_JSON_API_FACETS=http://localhost:3000/admin/advanced_search/facets.json
+
+# BL IDS
+BLACKLIGHT_JSON_IDS=http://localhost:3000/admin/ids.json
+
+GEOMG_DB_DATABASE=geoblacklight_development
+GEOMG_DB_USER=
+GEOMG_DB_PASSWORD=
+
+GEOMG_DEVISE_SECRET_KEY=generated-by-rake-secret
+
+# Blazer
+BLAZER_UPLOADS_URL=postgresql://127.0.0.1:5432/geoblacklight_development
+MAPBOX_ACCESS_TOKEN=your-key-here

data/lib/generators/geoblacklight_admin/templates/.solr_wrapper.yml

@@ -0,0 +1,7 @@
+validate: false
+instance_dir: tmp/solr
+download_dir: tmp/solr
+collection:
+  dir: solr/conf/
+  name: blacklight-core
+  persist: true

data/lib/generators/geoblacklight_admin/templates/_user_util_links.html.erb

@@ -0,0 +1,30 @@
+<ul class="navbar-nav">
+  <%= render_nav_actions do |config, action|%>
+    <li class="nav-item"><%= action %></li>
+  <% end %>
+
+  <% if has_user_authentication_provider? %>
+    <% if current_user %>
+
+    <% if current_user.admin? %>
+        <li class="nav-item">
+          <%= link_to "GBL Admin", admin_documents_path, {class: 'nav-link'} %>
+        </li>
+      <% end %>
+
+    <li class="nav-item">
+      <%= link_to "Sign out", destroy_user_session_path, { :method => :delete, class: 'nav-link'} %>
+    </li>
+
+    <% unless current_user.to_s.blank? -%>
+    <li class="nav-item">
+      <%= link_to(current_user.email, edit_user_registration_path, {class: 'nav-link'}) %>
+    </li>
+    <% end %>
+    <% else %>
+    <li class="nav-item">
+      <%= link_to "Sign in", new_user_session_path, class: 'nav-link' %>
+    </li>
+    <% end %>
+  <% end %>
+</ul>

data/lib/generators/geoblacklight_admin/templates/config/database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  host:     <%= ENV['GBL_ADMIN_DB_HOST'] || '127.0.0.1' %>
+  port:     <%= ENV['GBL_ADMIN_DB_PORT'] || '5432' %>
+  database: <%= ENV['GBL_ADMIN_DB_DATABASE'] || 'geoblacklight_development' %>
+  username: <%= ENV['GBL_ADMIN_DB_USER'] %>
+  password: <%= ENV['GBL_ADMIN_DB_PASSWORD'] %>
+  pool: 5
+
+test:
+  <<: *default
+
+development:
+  <<: *default
+
+production:
+  <<: *default