geoblacklight_admin 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c753d49a11dda454f74746f46edbcbc094ab8ed65e5a6ea4a3addd1850efa9
-  data.tar.gz: db199042de538a4e2d0548db3444a86ef81b78f2d88216dfbcae1d05b53f9923
+  metadata.gz: f18e2477b4c86505e2db4f96deecdd1cb1c7a3da7e6a5ec914d62cb03d96462f
+  data.tar.gz: 65686ca5de9a294a3232e87c9639b0ee4dec85e2eb6f4d858f0dd47da81b3e97
 SHA512:
-  metadata.gz: 757f8f91ff005aeaa92a11dfa2d292b68383781cfdbd9cf9db5f54bb39aea4c25be30b81d9b493ee1383bcbb210d1239a68eab436c0d54e41078e69f14a11003
-  data.tar.gz: 107dbebee2ed281bd0284e2fe4e0b60c25344cc38952d6b3363703c3ffe4ae492fdcc6aac1d6da6f8b9f5caa825375e42e7c2d190da9202a5e7f835f27bb8335
+  metadata.gz: 9a55943084756c68c07211e72de617cf1440f7128912bac6549ffcc95ac51733d2e3d21c165fb8f24acd6dda315c9a316056bda088e5eae65081552c9e6ce302
+  data.tar.gz: '090b8cdcac146e2fc720004f923dc73e4cedb3a00c75ea13d90f1ec0c3786b57be9ae65a9d29858e09dea66eb43bfcfbf68b3e0288c5414ff3b0b04bbe41cc92'

data/README.md

@@ -1,13 +1,14 @@
 # geoblacklight_admin
 
-GeoBlacklight Admin is a [GeoBlacklight](https://github.com/geoblacklight/geoblacklight) plugin, built on [Kithe](https://github.com/sciencehistory/kithe), that provides a complex web-form for editing documents and an CSV-based import/export workflow for OpenGeoMetadata's [Aardvark schema](https://opengeometadata.org/ogm-aardvark/). It's a Rubygem port of the Big Ten Academic Alliance's production workflow tool [GEOMG](https://github.com/geobtaa/geomg).
+![CI](https://github.com/geobtaa/geoblacklight_admin/actions/workflows/ci.yml/badge.svg)
 
-## Warning: Pre-Alpha
+GeoBlacklight Admin is a [GeoBlacklight](https://github.com/geoblacklight/geoblacklight) plugin, built on [Kithe](https://github.com/sciencehistory/kithe), that provides a complex web-form for editing documents and an CSV-based import/export workflow for OpenGeoMetadata's [Aardvark schema](https://opengeometadata.org/ogm-aardvark/). GBL Admin is based on the Big Ten Academic Alliance's production workflow tool [GEOMG](https://github.com/geobtaa/geomg).
 
-> :warning: This gem is not ready for public adoption yet, but hopefully someday soon (Late Summer 2023?). Feel free to kick the tires if you are curious and know GeoBlacklight's codebase/stack well.
+[![GeoBlackliht Admin](https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/docs/gbl_admin_screenshot.png)](https://youtu.be/lWjcr-Ow228 "GeoBlacklight Admin")
 
 ## Requirements
 
+* Rails v6.1 (not v7 yet)
 * Blacklight v7 (not v8)
 * GeoBlacklight v4 (not v3)
 * Solr v8.4+
@@ -15,38 +16,26 @@ GeoBlacklight Admin is a [GeoBlacklight](https://github.com/geoblacklight/geobla
 * Redis (for Sidekiq)
 * OpenGeoMetadata's Aardvark Schema
 
-## Install Notes
+## Installation
 
-### Terminal 1 - Drop/Create application PG database
-```bash
-psql postgres
-DROP DATABASE geoblacklight_development;
-CREATE DATABASE geoblacklight_development;
-```
+### PostgreSQL
 
-### Terminal 2 - Bundle and run generator
-```bash
-bundle install
-bundle exec rake engine_cart:generate
-```
+You need a PostgreSQL database to use this project.
 
-When the .internal_test_app is built, edit `geoblacklight_admin_helper.rb`, and uncomment this Pagy include. Why including Pagy here breaks the entire generator build is beyond me...
+* Homebrew: https://wiki.postgresql.org/wiki/Homebrew
+* Docker: https://www.docker.com/blog/how-to-use-the-postgres-docker-official-image/
 
-```bash
-  # @TODO:
-  # Cannot generate app if uncommented...
-  # Uncomment after app is generated to fix view errors
-  # include ::Pagy::Frontend
-```
+### Install Template
+
+Use Ruby v3.2 and Rails v6.1.7.4 to bootstrap a new GeoBlacklight + GBL Admin application using the template script:
 
-### Terminal 2 - Seed and spin up server
 ```bash
-cd .internal_test_app
-bundle exec rake db:seed
+rails _6.1.7.4_ new gbl_admin -m https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/template.rb
+cd gbl_admin
 bundle exec rake gbl_admin:server
 ```
 
-You're now done generating the test app and populating the Elements / FormElements tables with the basic Aardvark controls.
+You have now generated the .internal_test_app and populated the Elements / FormElements tables for OMG Aardvark support.
 
 ### View App in Browser
 
@@ -54,12 +43,48 @@ You're now done generating the test app and populating the Elements / FormElemen
 2. Click on the "Sign in" link
 3. Enter email: admin@geoblacklight.org and password: 123456
 4. Click on the "GBL Admin" link
-5. Import some CSV
+5. Import some CSV (test/fixtures/files/btaa_sample_records.csv)
 
 -----
 
-### TODOs - Running list of things to accomplish
+## Run Project for Local Development
+Drop and recreate databases (or engine_cart:generate will fail)
+
+### Drop/Create application PG database
+```bash
+psql postgres
+DROP DATABASE geoblacklight_development;
+CREATE DATABASE geoblacklight_development;
+```
+
+```bash
+cd project root
+bundle install
+bundle exec rake engine_cart:regenerate
+```
+
+### Run Solr
+```bash
+bin/rails geoblacklight:solr
+```
+
+### Run App
+```bash
+cd .internal_test_app
+bundle exec rails server
+```
 
+### Lint App
+```bash
+standardrb .
+```
+
+### Test App
+```bash
+RAILS_ENV=test bundle exec rails test
+```
+
+## TODOs
 * ~~SolrWrapper - Add persist option~~
 * ~~BlacklightApi returns not auth'd message (not requiring auth for now (not sensitive data))~~
 * ~~Facet links need /admin nesting~~
@@ -72,13 +97,11 @@ You're now done generating the test app and populating the Elements / FormElemen
 * ~~Add GBL Admin link to nav~~
 * ~~Routes - Get devise user~~
 * ~~No route matches [GET] "/users/sign_out"~~
-* Bookmarks need to be Admin::Bookmarks
+* ~~Bookmarks need to be Admin::Bookmarks~~
+* ~~GitHub Actions / CI integration~~
+* ~~Port the GEOMG test suite~~
+* ~~Project gem dependency injection redundancy...~~
+* DRY up Engine routing
 * Remove legacy GEOMG / B1G everywhere...
 * Send GBLADMIN JavaScript pack to NPM like Blacklight
-* Port the GEOMG test suite
-* GitHub Actions / CI integration
-* Project gem dependency injection redundancy...
-* Likely a lot more polish to be uncovered...
-
-
-
+* Likely some more polish to be uncovered...

data/Rakefile

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+require "rubygems"
 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
 
-Bundler::GemHelper.install_tasks
+require "bundler/setup"
+
+# Not using test/dummy app; using engine_cart
+# APP_RAKEFILE = File.expand_path(".internal_test_app/Rakefile", __dir__) if
+# load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
 
 require "solr_wrapper"
 
@@ -21,20 +24,48 @@ RuboCop::RakeTask.new(:rubocop)
 require "solr_wrapper/rake_task"
 require "engine_cart/rake_task"
 require "geoblacklight_admin/version"
+require "rake/testtask"
+
+# Searches for files ending in _test.rb in the test directory
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+# Will use test as defaut task if rake is run by itself
+task default: :test
 
 desc "Run test suite"
-task ci: ["engine_cart:generate"] do
-  ENV["environment"] = "test"
-  # run the tests
-  Rake::Task["test"].invoke
+task ci: ["geoblacklight:generate"] do
+  within_test_app do
+    system "RAILS_ENV=test bin/rails db:migrate"
+    system "RAILS_ENV=test rake db:seed"
+    system "RAILS_ENV=test rails webpacker:compile"
+  end
+
+  # Run RSpec tests with Coverage
+  Rake::Task["geoblacklight:coverage"].invoke
 end
 
 namespace :geoblacklight do
+  desc "Run tests with coverage"
+  task :coverage do
+    ENV["COVERAGE"] = "true"
+    # Rake::Task["spec"].invoke
+    Rake::Task["test"].invoke
+  end
+
+  desc "Create the test rails app"
+  task generate: ["engine_cart:generate"] do
+    # Intentionally Empty Block
+  end
+
   namespace :internal do
     task seed: ["engine_cart:generate"] do
       within_test_app do
-        # @TODO - Seed Elements / FormElements
-        # system "bundle exec rake gbl_admin:seed"
+        system "bundle exec rake db:seed"
         system "bundle exec rake geoblacklight:downloads:mkdir"
       end
     end
@@ -51,7 +82,9 @@ namespace :geoblacklight do
     end
 
     SolrWrapper.wrap(port: "8983") do |solr|
-      solr.with_collection(name: "blacklight-core", dir: File.join(File.expand_path(".", File.dirname(__FILE__)), "solr", "conf")) do
+      solr.with_collection(name: "blacklight-core",
+        dir: File.join(File.expand_path(".", File.dirname(__FILE__)),
+          "solr", "conf")) do
         Rake::Task["geoblacklight:internal:seed"].invoke
 
         within_test_app do

data/app/assets/javascripts/geoblacklight_admin.js

@@ -12,7 +12,8 @@
 //
 
 //= require jquery3
-//= require cocoon
+//= require rails-ujs
+//= require @nathanvda/cocoon/cocoon.js
 //= require chosen-jquery/lib/chosen.jquery.js
 
 // VENDOR

data/app/assets/stylesheets/geoblacklight_admin/_core.scss

@@ -19,6 +19,7 @@
 // Modules
 @import "modules/autocomplete";
 @import "modules/blazer";
+@import "modules/chosen";
 @import "modules/code";
 @import "modules/datepicker";
 @import "modules/elements";
@@ -44,4 +45,8 @@ footer {
 
 div.container-fluid {
   margin-top: 5rem;
+}
+
+.navbar-brand.gbl-admin {
+  background: none;
 }

data/app/assets/stylesheets/geoblacklight_admin/modules/_chosen.scss

@@ -0,0 +1,425 @@
+$chosen-sprite: image-url('chosen-sprite.png') !default;
+$chosen-sprite-retina: image-url('chosen-sprite@2x.png') !default;
+
+/* @group Base */
+.chosen-container {
+  position: relative;
+  display: inline-block;
+  vertical-align: middle;
+  font-size: 13px;
+  user-select: none;
+  * {
+    box-sizing: border-box;
+  }
+  .chosen-drop {
+    position: absolute;
+    top: 100%;
+    z-index: 1010;
+    width: 100%;
+    border: 1px solid #aaa;
+    border-top: 0;
+    background: #fff;
+    box-shadow: 0 4px 5px rgba(#000,.15);
+    clip: rect(0,0,0,0);
+    clip-path: inset(100% 100%);
+  }
+  &.chosen-with-drop .chosen-drop {
+    clip: auto;
+    clip-path: none;
+  }
+  a{
+    cursor: pointer;
+  }
+
+  .search-choice, .chosen-single{
+    .group-name{
+      margin-right: 4px;
+      overflow: hidden;
+      white-space: nowrap;
+      text-overflow: ellipsis;
+      font-weight: normal;
+      color: #999999;
+      &:after {
+        content: ":";
+        padding-left: 2px;
+        vertical-align: top;
+      }
+    }
+  }
+}
+/* @end */
+
+/* @group Single Chosen */
+.chosen-container-single{
+  .chosen-single {
+    position: relative;
+    display: block;
+    overflow: hidden;
+    padding: 0 0 0 8px;
+    height: 25px;
+    border: 1px solid #aaa;
+    border-radius: 5px;
+    background-color: #fff;
+    background: linear-gradient(#fff 20%, #f6f6f6 50%, #eee 52%, #f4f4f4 100%);
+    background-clip: padding-box;
+    box-shadow: 0 0 3px #fff inset, 0 1px 1px rgba(#000,.1);
+    color: #444;
+    text-decoration: none;
+    white-space: nowrap;
+    line-height: 24px;
+  }
+  .chosen-default {
+    color: #999;
+  }
+  .chosen-single span {
+    display: block;
+    overflow: hidden;
+    margin-right: 26px;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+  }
+  .chosen-single-with-deselect span {
+    margin-right: 38px;
+  }
+  .chosen-single abbr {
+    position: absolute;
+    top: 6px;
+    right: 26px;
+    display: block;
+    width: 12px;
+    height: 12px;
+    background: $chosen-sprite -42px 1px no-repeat;
+    font-size: 1px;
+    &:hover {
+      background-position: -42px -10px;
+    }
+  }
+  &.chosen-disabled .chosen-single abbr:hover {
+    background-position: -42px -10px;
+  }
+  .chosen-single div {
+    position: absolute;
+    top: 0;
+    right: 0;
+    display: block;
+    width: 18px;
+    height: 100%;
+    b {
+      display: block;
+      width: 100%;
+      height: 100%;
+      background: $chosen-sprite no-repeat 0px 2px;
+    }
+  }
+  .chosen-search {
+    position: relative;
+    z-index: 1010;
+    margin: 0;
+    padding: 3px 4px;
+    white-space: nowrap;
+
+    input[type="text"] {
+      margin: 1px 0;
+      padding: 4px 20px 4px 5px;
+      width: 100%;
+      height: auto;
+      outline: 0;
+      border: 1px solid #aaa;
+      background: $chosen-sprite no-repeat 100% -20px;
+      font-size: 1em;
+      font-family: sans-serif;
+      line-height: normal;
+      border-radius: 0;
+    }
+  }
+  .chosen-drop {
+    margin-top: -1px;
+    border-radius: 0 0 4px 4px;
+    background-clip: padding-box;
+  }
+  &.chosen-container-single-nosearch .chosen-search {
+    position: absolute;
+    clip: rect(0,0,0,0);
+    clip-path: inset(100% 100%);
+  }
+}
+/* @end */
+
+/* @group Results */
+.chosen-container .chosen-results {
+  color: #444;
+  position: relative;
+  overflow-x: hidden;
+  overflow-y: auto;
+  margin: 0 4px 4px 0;
+  padding: 0 0 0 4px;
+  max-height: 240px;
+  -webkit-overflow-scrolling: touch;
+  li {
+    display: none;
+    margin: 0;
+    padding: 5px 6px;
+    list-style: none;
+    line-height: 15px;
+    word-wrap: break-word;
+    -webkit-touch-callout: none;
+    &.active-result {
+      display: list-item;
+      cursor: pointer;
+    }
+    &.disabled-result {
+      display: list-item;
+      color: #ccc;
+      cursor: default;
+    }
+    &.highlighted {
+      background-color: #3875d7;
+      background-image: linear-gradient(#3875d7 20%, #2a62bc 90%);
+      color: #fff;
+    }
+    &.no-results {
+      color: #777;
+      display: list-item;
+      background: #f4f4f4;
+    }
+    &.group-result {
+      display: list-item;
+      font-weight: bold;
+      cursor: default;
+    }
+    &.group-option {
+      padding-left: 15px;
+    }
+    em {
+      font-style: normal;
+      text-decoration: underline;
+    }
+  }
+}
+/* @end */
+
+/* @group Multi Chosen */
+.chosen-container-multi{
+  .chosen-choices {
+    position: relative;
+    overflow: hidden;
+    margin: 0;
+    padding: 0 5px;
+    width: 100%;
+    height: auto;
+    border: 1px solid #aaa;
+    background-color: #fff;
+    background-image: linear-gradient(#eee 1%, #fff 15%);
+    cursor: text;
+  }
+  .chosen-choices li {
+    float: left;
+    list-style: none;
+    &.search-field {
+      margin: 0;
+      padding: 0;
+      white-space: nowrap;
+      input[type="text"] {
+        margin: 1px 0;
+        padding: 0;
+        height: 25px;
+        outline: 0;
+        border: 0 !important;
+        background: transparent !important;
+        box-shadow: none;
+        color: #999;
+        font-size: 100%;
+        font-family: sans-serif;
+        line-height: normal;
+        border-radius: 0;
+        width: 25px;
+      }
+    }
+    &.search-choice {
+      position: relative;
+      margin: 3px 5px 3px 0;
+      padding: 3px 20px 3px 5px;
+      border: 1px solid #aaa;
+      max-width: 100%;
+      border-radius: 3px;
+      background-color: #eeeeee;
+      background-image: linear-gradient(#f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eee 100%);
+      background-size: 100% 19px;
+      background-repeat: repeat-x;
+      background-clip: padding-box;
+      box-shadow: 0 0 2px #fff inset, 0 1px 0 rgba(#000,.05);
+      color: #333;
+      line-height: 13px;
+      cursor: default;
+      span {
+        word-wrap: break-word;
+      }
+      .search-choice-close {
+        position: absolute;
+        top: 4px;
+        right: 3px;
+        display: block;
+        width: 12px;
+        height: 12px;
+        background: $chosen-sprite -42px 1px no-repeat;
+        font-size: 1px;
+        &:hover {
+          background-position: -42px -10px;
+        }
+      }
+    }
+    &.search-choice-disabled {
+      padding-right: 5px;
+      border: 1px solid #ccc;
+      background-color: #e4e4e4;
+      background-image: linear-gradient(#f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eee 100%);
+      color: #666;
+    }
+    &.search-choice-focus {
+      background: #d4d4d4;
+      .search-choice-close {
+        background-position: -42px -10px;
+      }
+    }
+  }
+  .chosen-results {
+    margin: 0;
+    padding: 0;
+  }
+  .chosen-drop .result-selected {
+    display: list-item;
+    color: #ccc;
+    cursor: default;
+  }
+}
+/* @end */
+
+/* @group Active  */
+.chosen-container-active{
+  .chosen-single {
+    border: 1px solid #5897fb;
+    box-shadow: 0 0 5px rgba(#000,.3);
+  }
+  &.chosen-with-drop{
+    .chosen-single {
+      border: 1px solid #aaa;
+      -moz-border-radius-bottomright: 0;
+      border-bottom-right-radius: 0;
+      -moz-border-radius-bottomleft: 0;
+      border-bottom-left-radius: 0;
+      background-image: linear-gradient(#eee 20%, #fff 80%);
+      box-shadow: 0 1px 0 #fff inset;
+    }
+    .chosen-single div {
+      border-left: none;
+      background: transparent;
+      b {
+        background-position: -18px 2px;
+      }
+    }
+  }
+  .chosen-choices {
+    border: 1px solid #5897fb;
+    box-shadow: 0 0 5px rgba(#000,.3);
+    li.search-field input[type="text"] {
+      color: #222 !important;
+    }
+  }
+}
+/* @end */
+
+/* @group Disabled Support */
+.chosen-disabled {
+  opacity: 0.5 !important;
+  cursor: default;
+  .chosen-single {
+    cursor: default;
+  }
+  .chosen-choices .search-choice .search-choice-close {
+    cursor: default;
+  }
+}
+/* @end */
+
+/* @group Right to Left */
+.chosen-rtl {
+  text-align: right;
+  .chosen-single {
+    overflow: visible;
+    padding: 0 8px 0 0;
+  }
+  .chosen-single span {
+    margin-right: 0;
+    margin-left: 26px;
+    direction: rtl;
+  }
+  .chosen-single-with-deselect span {
+    margin-left: 38px;
+  }
+  .chosen-single div {
+    right: auto;
+    left: 3px;
+  }
+  .chosen-single abbr {
+    right: auto;
+    left: 26px;
+  }
+  .chosen-choices li {
+    float: right;
+    &.search-field input[type="text"] {
+      direction: rtl;
+    }
+    &.search-choice {
+      margin: 3px 5px 3px 0;
+      padding: 3px 5px 3px 19px;
+      .search-choice-close {
+        right: auto;
+        left: 4px;
+      }
+    }
+  }
+  &.chosen-container-single .chosen-results {
+    margin: 0 0 4px 4px;
+    padding: 0 4px 0 0;
+  }
+  .chosen-results li.group-option {
+    padding-right: 15px;
+    padding-left: 0;
+  }
+  &.chosen-container-active.chosen-with-drop .chosen-single div {
+    border-right: none;
+  }
+  .chosen-search input[type="text"] {
+    padding: 4px 5px 4px 20px;
+    background: $chosen-sprite no-repeat -30px -20px;
+    direction: rtl;
+  }
+  &.chosen-container-single{
+    .chosen-single div b {
+      background-position: 6px 2px;
+    }
+    &.chosen-with-drop{
+      .chosen-single div b {
+        background-position: -12px 2px;
+      }
+    }
+  }
+}
+
+/* @end */
+
+/* @group Retina compatibility */
+@media only screen and (-webkit-min-device-pixel-ratio: 1.5), only screen and (min-resolution: 144dpi), only screen and (min-resolution: 1.5dppx) {
+  .chosen-rtl .chosen-search input[type="text"],
+  .chosen-container-single .chosen-single abbr,
+  .chosen-container-single .chosen-single div b,
+  .chosen-container-single .chosen-search input[type="text"],
+  .chosen-container-multi .chosen-choices .search-choice .search-choice-close,
+  .chosen-container .chosen-results-scroll-down span,
+  .chosen-container .chosen-results-scroll-up span {
+    background-image: $chosen-sprite-retina !important;
+    background-size: 52px 37px !important;
+    background-repeat: no-repeat !important;
+  }
+}
+/* @end */