geoblacklight 5.4.0 → 6.0.0.pre.alpha.1

data/lib/generators/geoblacklight/assets/vite_generator.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-
-module Geoblacklight
-  module Assets
-    class ViteGenerator < Rails::Generators::Base
-      source_root Geoblacklight::Engine.root.join("lib", "generators", "geoblacklight", "templates")
-
-      class_option :test, type: :boolean, default: false, aliases: "-t", desc: "Indicates that app will be installed in a test environment"
-
-      desc <<-DESCRIPTION
-      This generator sets up the app to use Vite as the bundler for styles and
-      javascript using the vite_rails gem. Existing stylesheets for Blacklight
-      are removed and replaced with a single JS entrypoint file and a single
-      SCSS entrypoint file, which will be bundled by Vite.
-
-      Geoblacklight's frontend assets are installed from the npm package. In
-      CI they automatically reference the versions from the outer directory
-      (the Geoblacklight repository) via a yarn symlink.
-      DESCRIPTION
-
-      # Install Vite
-      def install_vite_rails
-        gem "vite_rails", "~> 3.0"
-        run "bundle install"
-      end
-
-      # Symlink geoblacklight's frontend assets in CI
-      def link_geoblacklight_package
-        if options[:test]
-          run "yarn link @geoblacklight/frontend"
-        end
-      end
-
-      # Add our version of the Blacklight base layout with Vite helper tags
-      def geoblacklight_base_layout
-        copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb"
-      end
-
-      # Copy Vite config files
-      def copy_config_vite_json
-        copy_file "vite.json", "config/vite.json"
-        copy_file "vite.config.ts", "vite.config.ts"
-      end
-
-      # Run the vite install generator (create binstubs, etc.)
-      def setup_vite
-        run "bundle exec vite install"
-      end
-
-      # The vite-plugin-ruby package has a breaking change in 5.1.2,
-      # so we need to resolve to a specific version to avoid issues.
-      # Remove after https://github.com/ElMassimo/vite_ruby/issues/586 is fixed.
-      def pin_vite_plugin_ruby
-        inject_into_file "package.json", before: "  \"dependencies\": {" do
-          "  \"resolutions\": { \"vite-plugin-ruby\": \"5.1.1\" },\n"
-        end
-      end
-
-      # The vite_rails gem doesn't currently install the vite-plugin-rails
-      # node package, so we need to do that manually.
-      def install_dev_dependencies
-        run "yarn add --dev vite-plugin-rails"
-      end
-
-      # Remove generated npm scripts from rollup and replace with our own.
-      # Adds a shortcut so that 'yarn build' runs our vite pipeline
-      # No easy way to do this with yarn, so we use `npm pkg`...
-      def setup_npm_scripts
-        run "npm pkg delete scripts"
-        run "npm pkg set scripts.build=\"vite build\""
-      end
-
-      # Add our own stylesheets that reference the versions from npm
-      def add_stylesheets
-        copy_file "assets/_customizations.scss", "app/javascript/stylesheets/_customizations.scss"
-        copy_file "assets/geoblacklight.scss", "app/javascript/stylesheets/geoblacklight.scss"
-        copy_file "assets/application.scss", "app/javascript/entrypoints/application.scss"
-      end
-
-      # Replace the default generated Vite entrypoint with our own
-      def add_javascript
-        remove_file "app/javascript/entrypoints/application.js"
-        copy_file "assets/application.js", "app/javascript/entrypoints/application.js"
-      end
-    end
-  end
-end

data/lib/generators/geoblacklight/templates/assets/_customizations.scss

@@ -1,23 +0,0 @@
-// Local Application Customizations
-
-// Set Header Logo
-$logo-image: url("@geoblacklight/frontend/app/assets/images/blacklight/logo.svg");
-
-// Optional
-// Override default Bootstrap variables here
-
-// Example: Bootstrap Colors
-// $blue:    #0d6efd !default;
-// $indigo:  #6610f2 !default;
-// $purple:  #6f42c1 !default;
-// $pink:    #d63384 !default;
-// $red:     #dc3545 !default;
-// $orange:  #fd7e14 !default;
-// $yellow:  #ffc107 !default;
-// $green:   #198754 !default;
-// $teal:    #20c997 !default;
-// $cyan:    #0dcaf0 !default;
-// $dark:    #212529 !default; // $gray-900
-
-// Example: Bootstrap Link color
-// $link-color: $blue;

data/lib/generators/geoblacklight/templates/assets/application.js

@@ -1,17 +0,0 @@
-/* Main application javascript entrypoint */
-
-// Turbo & Stimulus
-import "@hotwired/turbo-rails";
-import { application } from "~/controllers/application";
-
-// Blacklight & Geoblacklight
-import githubAutoCompleteElement from "@github/auto-complete-element";
-import Blacklight from "blacklight-frontend";
-import Geoblacklight from "@geoblacklight/frontend";
-
-// Make imports available globally to your code
-window.Blacklight = Blacklight;
-window.Geoblacklight = Geoblacklight;
-
-// Your javascript code goes here
-// console.log("Hello Geoblacklight!");

data/lib/generators/geoblacklight/templates/assets/application.scss

@@ -1,9 +0,0 @@
-/* Main application styles entrypoint */
-
-// Leaflet, OpenLayers, GeoBlacklight (includes Blacklight and Bootstrap)
-@import "leaflet/dist/leaflet.css";
-@import "leaflet.fullscreen/dist/Control.FullScreen.css";
-@import "ol/ol.css";
-@import "~/stylesheets/geoblacklight.scss";
-
-// Your styles here!

data/lib/generators/geoblacklight/templates/assets/geoblacklight.scss

@@ -1,11 +0,0 @@
-// Local customizations (import first, so that variables take precedence)
-@import 'customizations.scss';
-
-// Bootstrap (will use variables defined in customizations, if present)
-@import 'bootstrap/scss/bootstrap.scss';
-
-// Blacklight, imported from blacklight-frontend package
-@import 'blacklight-frontend/app/assets/stylesheets/blacklight/blacklight.scss';
-
-// Geoblacklight, imported from @geoblacklight/frontend package
-@import '@geoblacklight/frontend/app/assets/stylesheets/geoblacklight/geoblacklight.scss';

data/lib/generators/geoblacklight/templates/base.html.erb

@@ -1,46 +0,0 @@
-<!DOCTYPE html>
-<%= content_tag :html, class: 'no-js', **html_tag_attributes do %>
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="geoblacklight-version" content="<%= Geoblacklight::VERSION %>">
-
-    <!-- Internet Explorer use the highest version available -->
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-
-    <title><%= render_page_title %></title>
-    <script>
-      document.querySelector('html').classList.remove('no-js');
-    </script>
-    <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
-    <%= favicon_link_tag %>
-  
-    <%= vite_client_tag %>
-    <%= vite_stylesheet_tag 'application.scss', media: 'all' %>
-    <%= vite_javascript_tag 'application' %>
-
-    <%= csrf_meta_tags %>
-    <%= content_for(:head) %>
-  </head>
-  <body class="<%= render_body_class %>">
-    <%= render blacklight_config.skip_link_component.new do %>
-      <%= content_for(:skip_links) %>
-    <% end %>
-
-    <%= render partial: 'shared/header_navbar' %>
-
-    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
-      <%= content_for(:container_header) %>
-
-      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
-
-      <div class="row">
-        <%= content_for?(:content) ? yield(:content) : yield %>
-      </div>
-    </main>
-
-    <%= render partial: 'shared/footer' %>
-    <%= render partial: 'shared/modal' %>
-  </body>
-<% end %>

data/lib/generators/geoblacklight/templates/vite.config.ts

@@ -1,23 +0,0 @@
-import { defineConfig, searchForWorkspaceRoot } from "vite";
-import rails from "vite-plugin-rails";
-
-export default defineConfig(({ mode }) => {
-  return {
-    build: {
-      minify: mode === "production",
-      manifest: true,
-      sourcemap: true,
-    },
-    server: {
-      fs: {
-        allow: [
-          // search up for workspace root
-          searchForWorkspaceRoot(process.cwd()),
-          // One directory up (from .internal_test_app where we do `yarn link @geoblacklight`)
-          `${process.cwd()}/..`,
-        ],
-      },
-    },
-    plugins: [rails()],
-  };
-});

data/lib/generators/geoblacklight/templates/vite.json

@@ -1,16 +0,0 @@
-{
-  "all": {
-    "sourceCodeDir": "app/javascript",
-    "watchAdditionalPaths": []
-  },
-  "development": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-dev",
-    "port": 3036
-  },
-  "test": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-test",
-    "port": 3037
-  }
-}