arclight 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05920211714b612a9c15488e1943502f69f46cb546642b0e93b4e23c8a2837e8'
-  data.tar.gz: 2a81f4044f38d14d591db1cd38d6e8ba5b4703e3fd24e18539a9d1837c995873
+  metadata.gz: 7371056b2eb8d6241d7113f46f593ce352afe9029c16eb6cc404bee31ebcf511
+  data.tar.gz: ccb5c2b72c6c67441d74c358568bef14d6e35117ba92be77fb01989e01a80875
 SHA512:
-  metadata.gz: 6c14920c31d58ba3315badb0b469a3227c5f0a0f4c6e98fbed5362e486698aa7eec251efb335bcceacb5e4c7e812dc4118cb59d9950ccb9d20416f4b3d0f8528
-  data.tar.gz: 69ef42b405988a76171b0d7cacf8d73180d3cdaf8557762b0492168760cb6ee0db678570e839fc0a73bbc029469c589ce5b1c5f1b74257ade6311a99689fb568
+  metadata.gz: 3bc505687178b9dbac2d809def95a1fb3fe0bb156f577bb266bc1221c651d9c188b5288a1254f1b2e054484090e2fff5225ee46fa3cbabbf8f0ce493003de7d0
+  data.tar.gz: e16678a9073c7a1c845586b968659016f62cfd7b0b8c543552c0ef29c9e92fcb38daf4c3b6f542531e57041ff26b79d2f44e661d58129898652a260bbfe1ba7f

data/.github/workflows/ruby.yml

@@ -2,19 +2,26 @@ name: CI
 
 on:
   push:
-    branches: [main]
+    branches: [main, release-*]
   pull_request:
-    branches: [main]
+    branches: [main, release-*]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: [7.1.3.4]
-        ruby: ["3.1", "3.2", "3.3"]
+        rails_version: [7.1.5.1, 7.2.2.1]
+        ruby: ["3.2", "3.3"]
+        additional_engine_cart_rails_options: [""]
+        include:
+          - ruby: "3.1"
+            rails_version: "7.1.5"
+          - ruby: "3.3"
+            rails_version: "8.0.1"
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
+      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-kamal --skip-solid --skip-coffee --skip-test --css bootstrap -a propshaft -j importmap ${{ matrix.additional_engine_cart_rails_options }}"
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby }}

data/.rubocop.yml

@@ -1,41 +1,46 @@
+plugins:
+  - rubocop-factory_bot
+
 require:
   - rubocop-rspec
   - rubocop-rails
   - rubocop-rake
+  - rubocop-rspec_rails
+  - rubocop-capybara
 
 inherit_from:
   - .rubocop_todo.yml
 
 AllCops:
   Exclude:
-    - '.internal_test_app/**/*'
-    - 'bin/**/*'
-    - 'db/**/*'
-    - 'lib/generators/arclight/templates/**/*'
-    - 'vendor/**/*'
-    - 'node_modules/**/*'
+    - ".internal_test_app/**/*"
+    - "bin/**/*"
+    - "db/**/*"
+    - "lib/generators/arclight/templates/**/*"
+    - "vendor/**/*"
+    - "node_modules/**/*"
   TargetRubyVersion: 3.0
   DisplayCopNames: true
 
 Metrics/ModuleLength:
   Exclude:
-    - 'app/helpers/arclight_helper.rb'
-    - 'app/models/concerns/arclight/solr_document.rb'
+    - "app/helpers/arclight_helper.rb"
+    - "app/models/concerns/arclight/solr_document.rb"
 
 Metrics/BlockLength:
   Exclude:
-    - 'arclight.gemspec'
-    - 'lib/arclight/traject/ead2_config.rb'
-    - 'lib/tasks/**/*'
-    - 'spec/features/traject/ead2_indexing_spec.rb'
-    - 'spec/helpers/arclight_helper_spec.rb'
-    - 'spec/features/collection_page_spec.rb'
-    - 'spec/**/*'
-    - 'tasks/**/*'
+    - "arclight.gemspec"
+    - "lib/arclight/traject/ead2_config.rb"
+    - "lib/tasks/**/*"
+    - "spec/features/traject/ead2_indexing_spec.rb"
+    - "spec/helpers/arclight_helper_spec.rb"
+    - "spec/features/collection_page_spec.rb"
+    - "spec/**/*"
+    - "tasks/**/*"
 
 Naming/PredicateName:
   ForbiddenPrefixes:
-    - _is
+    - is_
 
 Layout/LineLength:
   Max: 160
@@ -48,7 +53,7 @@ Bundler/DuplicatedGem:
 
 Style/FormatStringToken:
   Exclude:
-    - 'spec/test_app_templates/lib/generators/test_app_generator.rb'
+    - "spec/test_app_templates/lib/generators/test_app_generator.rb"
 
 Gemspec/DeprecatedAttributeAssignment: # new in 1.30
   Enabled: true
@@ -204,11 +209,11 @@ Capybara/SpecificFinders: # new in 2.13
   Enabled: true
 Capybara/SpecificMatcher: # new in 2.12
   Enabled: true
-RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
+RSpecRails/AvoidSetupHook: # new in 2.4
   Enabled: true
-RSpec/Rails/HaveHttpStatus: # new in 2.12
+RSpecRails/HaveHttpStatus: # new in 2.12
   Enabled: true
 Rails/ActionControllerFlashBeforeRender: # new in 2.16
   Enabled: true
@@ -318,9 +323,9 @@ Capybara/NegationMatcher: # new in 2.14
   Enabled: true
 Capybara/SpecificActions: # new in 2.14
   Enabled: true
-RSpec/FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
   Enabled: false # https://github.com/rspec/rspec-rails/issues/2635
-RSpec/Rails/InferredSpecType: # new in 2.14
+RSpecRails/InferredSpecType: # new in 2.14
   Enabled: true
 Rails/ActionOrder: # new in 2.17
   Enabled: true
@@ -354,9 +359,163 @@ RSpec/DuplicatedMetadata: # new in 2.16
   Enabled: true
 RSpec/PendingWithoutReason: # new in 2.16
   Enabled: true
-RSpec/FactoryBot/FactoryNameStyle: # new in 2.16
+FactoryBot/FactoryNameStyle: # new in 2.16
   Enabled: false # https://github.com/rubocop/rubocop-rspec/issues/1587
-RSpec/Rails/MinitestAssertions: # new in 2.17
+RSpecRails/MinitestAssertions: # new in 2.17
   Enabled: true
 Rails/ResponseParsedBody: # new in 2.18
-  Enabled: true
+  Enabled: true
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateSetElement: # new in 1.67
+  Enabled: true
+Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NumericOperationWithConstantResult: # new in 1.69
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/UnescapedBracketInRegexp: # new in 1.68
+  Enabled: true
+Lint/UselessDefined: # new in 1.69
+  Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Style/AmbiguousEndlessMethodDefinition: # new in 1.68
+  Enabled: true
+Style/BitwisePredicate: # new in 1.68
+  Enabled: true
+Style/CombinableDefined: # new in 1.68
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DigChain: # new in 1.69
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileNull: # new in 1.69
+  Enabled: true
+Style/FileTouch: # new in 1.69
+  Enabled: true
+Style/KeywordArgumentsMerging: # new in 1.68
+  Enabled: true
+Style/MapIntoArray: # new in 1.63
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantInterpolationUnfreeze: # new in 1.66
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SafeNavigationChainLength: # new in 1.68
+  Enabled: true
+Style/SendWithLiteralMethodName: # new in 1.64
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/SuperArguments: # new in 1.64
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true
+Capybara/ClickLinkOrButtonStyle: # new in 2.19
+  Enabled: true
+Capybara/RedundantWithinFind: # new in 2.20
+  Enabled: true
+Capybara/RSpec/HaveSelector: # new in 2.19
+  Enabled: true
+Capybara/RSpec/PredicateMatcher: # new in 2.19
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/ExcessiveCreateList: # new in 2.25
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/IdSequence: # new in 2.24
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+RSpecRails/NegationBeValid: # new in 2.23
+  Enabled: true
+RSpecRails/TravelAround: # new in 2.19
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/EmptyMetadata: # new in 2.24
+  Enabled: true
+RSpec/EmptyOutput: # new in 2.29
+  Enabled: true
+RSpec/Eq: # new in 2.24
+  Enabled: true
+RSpec/ExpectInLet: # new in 2.30
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/IsExpectedSpecify: # new in 2.27
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/MetadataStyle: # new in 2.24
+  Enabled: true
+RSpec/ReceiveMessages: # new in 2.23
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/RedundantPredicateMatcher: # new in 2.26
+  Enabled: true
+RSpec/RemoveConst: # new in 2.26
+  Enabled: true
+RSpec/RepeatedSubjectCall: # new in 2.27
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/SpecFilePathFormat: # new in 2.24
+  Enabled: true
+RSpec/SpecFilePathSuffix: # new in 2.24
+  Enabled: true
+RSpec/UndescriptiveLiteralsDescription: # new in 2.29
+  Enabled: true
+Rails/DangerousColumnNames: # new in 2.21
+  Enabled: true
+Rails/EnumSyntax: # new in 2.26
+  Enabled: true
+Rails/EnvLocal: # new in 2.22
+  Enabled: true
+Rails/RedundantActiveRecordAllMethod: # new in 2.21
+  Enabled: true
+Rails/SelectMap: # new in 2.21
+  Enabled: true
+Rails/ThreeStateBooleanColumn: # new in 2.19
+  Enabled: true
+Rails/UnusedRenderContent: # new in 2.21
+  Enabled: true
+Rails/WhereRange: # new in 2.25
+  Enabled: true

data/.solr_wrapper

@@ -1,5 +1,6 @@
 # Place any default configuration for solr_wrapper here
 # port: 8983
 collection:
-  dir: solr/conf/
+  dir: solr/conf
   name: blacklight-core
+version: 9.7.0

data/README.md

@@ -12,7 +12,7 @@ A Rails engine supporting discovery of archival materials, based on [Blacklight]
 ## Requirements
 
 * [Ruby](https://www.ruby-lang.org/en/) 3.0.3 or later
-* [Rails](http://rubyonrails.org) 7.0 or later
+* [Rails](http://rubyonrails.org) 7.1 or later
 * Solr 8.1 or later
 
 ## Installation

data/app/assets/stylesheets/arclight/modules/mastheads.scss

@@ -28,30 +28,15 @@
 .al-masthead {
   --al-mastead-active-link-color: var(--bs-gray-700);
   --al-masthead-title-size: #{$h2-font-size};
+  --bs-nav-link-font-weight: 700;
 
   .h1 {
-    display: block;
     font-size: var(--al-masthead-title-size);
-    margin: 0;
-    padding: ($spacer * 1.5) ($spacer * 0.5);
   }
 
   .navbar-nav {
-    flex-direction: row;
-    font-weight: 700;
-
     .active a {
       color: var(--al-mastead-active-link-color);
     }
   }
-
-  @media (max-width: 767px) {
-    .nav-links {
-      justify-content: center !important;
-    }
-
-    h1 {
-      text-align: center;
-    }
-  }
 }

data/app/components/arclight/collection_sidebar_component.rb

@@ -29,7 +29,7 @@ module Arclight
     end
 
     def document_path
-      @document_path ||= solr_document_path(document.collection_id)
+      @document_path ||= solr_document_path(document.root)
     end
 
     def section_anchor(section)

data/app/components/arclight/document_components_hierarchy_component.html.erb

@@ -2,29 +2,17 @@
   <%# render the hierarchy as: outer (left) window ... window ... because our current document hierarchy is so far down the list it'd be buried %>
   <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-left", loading: 'lazy', src: hierarchy_path(limit: @left_outer_window, key: '-left') %>
   <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-gap" do %>
-    <ul>
-      <li>
-        <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @left_outer_window, limit: @target_index - @left_outer_window - (@window / 2), key: '-gap'), class: 'btn btn-secondary btn-sm' %>
-      </li>
-    </ul>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @left_outer_window, limit: @target_index - @left_outer_window - (@window / 2), key: '-gap')) %>
   <% end %>
   <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-window", src: hierarchy_path(offset: @target_index - (@window / 2), limit: @window, key: '-window') %>
   <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
-    <ul>
-      <li>
-        <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @target_index + (@window / 2), key: '-right'), class: 'btn btn-secondary btn-sm' %>
-      </li>
-    </ul>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @target_index + (@window / 2), key: '-right')) %>
   <% end %>
 <% elsif paginate? %>
   <%# render the first N documents, and let the user expand the remaining if desired %>
   <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-sidebar", loading: ('lazy' unless @target_index >= 0), src: hierarchy_path(limit: @maximum_left_gap, key: '-sidebar') %>
   <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
-    <ul>
-      <li>
-        <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @maximum_left_gap, key: '-right'), class: 'btn btn-secondary btn-sm' %>
-      </li>
-    </ul>
+    <%= render expand_hierarchy_component.new(path: hierarchy_path(offset: @maximum_left_gap, key: '-right')) %>
   <% end %>
 <% else %>
   <%# there aren't enough to bother paginating, so load them all at once %>

data/app/components/arclight/document_components_hierarchy_component.rb

@@ -24,5 +24,11 @@ module Arclight
     def hierarchy_path(**kwargs)
       helpers.hierarchy_solr_document_path(id: @document.id, hierarchy: true, nest_path: params[:nest_path], **kwargs)
     end
+
+    def expand_hierarchy_component
+      blacklight_config.show.expand_hierarchy_component || Arclight::ExpandHierarchyButtonComponent
+    end
+
+    delegate :blacklight_config, to: :helpers
   end
 end

data/app/components/arclight/expand_hierarchy_button_component.html.erb

@@ -0,0 +1,5 @@
+<ul>
+  <li>
+    <%= expand_link %>
+  </li>
+</ul>

data/app/components/arclight/expand_hierarchy_button_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Component for rendering an expand button in the hierarchy view
+  class ExpandHierarchyButtonComponent < Blacklight::Component
+    def initialize(path:, classes: 'btn btn-secondary btn-sm')
+      super
+      @path = path
+      @classes = classes
+    end
+
+    def expand_link
+      link_to t('arclight.views.show.expand'), @path, class: @classes
+    end
+  end
+end

data/app/components/arclight/masthead_component.html.erb

@@ -2,14 +2,16 @@
   <div class="container">
     <div class="row align-items-center">
       <div class="col-md-8" >
-        <span class="h1"><%= heading %></span>
+        <div class="h1 my-4 text-center text-md-start"><%= heading %></div>
       </div>
 
-      <nav class="col-md-4 nav-links d-flex justify-content-end" aria-label="browse">
-        <ul class="navbar-nav">
-          <%= render 'shared/main_menu_links' %>
-        </ul>
-      </nav>
+      <div class="col-md-4">
+        <nav class="navbar navbar-expand d-flex justify-content-md-end justify-content-center" aria-label="browse">
+          <ul class="navbar-nav">
+            <%= render 'shared/main_menu_links' %>
+          </ul>
+        </nav>
+      </div>
     </div>
   </div>
 </div>

data/app/components/arclight/online_content_filter_component.html.erb

@@ -7,7 +7,7 @@
         <%= t('arclight.views.show.online_content.title') %>
       </h2>
     </div>
-    <div class="ml-3 ms-3 ml-xl-5 ms-xl-5">
+    <div class="ms-3 ms-xl-5">
       <div><%= t('arclight.views.show.online_content.description') %></div>
       <%= link_to t('arclight.views.show.online_content.link_text'), helpers.search_action_path(f: { collection: [collection_name], access: ['online'] }) %>
     </div>

data/app/components/arclight/online_content_filter_component.rb

@@ -12,8 +12,6 @@ module Arclight
       @document.collection? && @document.online_content?
     end
 
-    def collection_name
-      @document.collection_name
-    end
+    delegate :collection_name, to: :@document
   end
 end

data/app/components/arclight/repository_breadcrumb_component.html.erb

@@ -1,5 +1,5 @@
 <li class='breadcrumb-item'>
-  <span class="ml-3 ms-3" aria-hidden="true">
+  <span class="ms-3" aria-hidden="true">
     <%= blacklight_icon(:repository, classes: 'al-repository-content-icon') %>
   </span>
   <% if repository_path %>

data/app/components/arclight/search_result_title_component.html.erb

@@ -3,8 +3,8 @@
     <%= helpers.link_to_document @document, counter: @counter %>
     <% @document.extent.each do |extent| %>
       <%= tag.span extent, class: 'al-document-extent badge' unless compact? %>
-    <% end %>    
-    <%= tag.span class: 'al-document-container text-muted ml-auto' do %>
+    <% end %>
+    <%= tag.span class: 'al-document-container text-muted' do %>
       <%= @document.containers.join(', ') %>
     <% end if @document.containers.present? %>
   </h3>
@@ -12,4 +12,4 @@
   <% actions.each do |action| %>
     <%= action %>
   <% end %>
-</header>
+</header>

data/app/models/arclight/document_downloads.rb

@@ -33,7 +33,7 @@ module Arclight
     class << self
       def config
         @config ||= begin
-          YAML.safe_load(::File.read(config_filename))
+          YAML.safe_load_file(config_filename)
         rescue Errno::ENOENT
           {}
         end

data/app/models/arclight/parents.rb

@@ -29,7 +29,7 @@ module Arclight
     # @param [SolrDocument] document
     def self.from_solr_document(document)
       ids = document.parent_ids
-      legacy_ids = document.legacy_parent_ids.map { |legacy_id| document.collection_id == legacy_id ? legacy_id : "#{document.collection_id}#{legacy_id}" }
+      legacy_ids = document.legacy_parent_ids.map { |legacy_id| document.root == legacy_id ? legacy_id : "#{document.root}#{legacy_id}" }
       labels = document.parent_labels
       eadid = document.eadid
       levels = document.parent_levels

data/app/models/concerns/arclight/solr_document.rb

@@ -8,6 +8,7 @@ module Arclight
 
     included do
       attribute :collection_id, :string, '_root_'
+      Arclight.deprecation.deprecate_methods(self, collection_id: 'Use `root` instead')
       attribute :parent_ids, :array, 'parent_ids_ssim'
       attribute :legacy_parent_ids, :array, 'parent_ssim'
       Arclight.deprecation.deprecate_methods(self, legacy_parent_ids: 'Use `parent_ids` instead')
@@ -51,7 +52,7 @@ module Arclight
     def normalized_eadid
       Arclight::NormalizedId.new(eadid).to_s
     end
-    Arclight.deprecation.deprecate_methods(self, normalized_eadid: 'Use `collection_id` instead')
+    Arclight.deprecation.deprecate_methods(self, normalized_eadid: 'Use `root` instead')
 
     def repository
       first('repository_ssm') || collection&.first('repository_ssm')

data/app/views/shared/_main_menu_links.html.erb

@@ -1,6 +1,6 @@
 <li class="nav-item <%= repositories_active_class %>">
   <%= link_to t('arclight.routes.repositories'), arclight_engine.repositories_path, class: 'nav-link' %>
 </li>
-<li class="nav-item ml-3 ms-3 <%= collection_active_class %>">
+<li class="nav-item ms-3 <%= collection_active_class %>">
   <%= link_to t('arclight.routes.collections'), arclight_engine.collections_path, class: 'nav-link' %>
 </li>

data/arclight.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'blacklight', '>= 8.0.0', '< 9'
   spec.add_dependency 'gretel'
-  spec.add_dependency 'rails', '~> 7.0'
+  spec.add_dependency 'rails', '>= 7.1', '< 9'
   spec.add_dependency 'traject', '~> 3.0'
   spec.add_dependency 'traject_plus', '~> 2.0'
 

data/lib/arclight/repository.rb

@@ -72,7 +72,7 @@ module Arclight
     # @return [Hash<Slug,Repository>]
     def self.from_yaml(file)
       repos = {}
-      data = YAML.safe_load(File.read(file))
+      data = YAML.safe_load_file(file)
       data.each_key do |slug|
         repos[slug] = new(data[slug].merge(slug: slug))
       end

data/lib/arclight/traject/ead2_component_config.rb

@@ -86,7 +86,7 @@ to_field 'ref_ssi' do |record, accumulator, context|
                    record['id'] = hexdigest
                    hexdigest
                  else
-                   record.attribute('id')&.value&.strip&.gsub('.', '-')
+                   record.attribute('id')&.value&.strip&.gsub('.', '-') # rubocop:disable Style/SafeNavigationChainLength
                  end
 end
 to_field 'ref_ssm' do |_record, accumulator, context|

data/lib/arclight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arclight
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/generators/arclight/install_generator.rb

@@ -5,9 +5,11 @@ require 'rails/generators'
 module Arclight
   ##
   # Arclight install generator
-  class Install < Rails::Generators::Base
+  class Install < Rails::Generators::Base # rubocop:disable Metrics/ClassLength
     source_root File.expand_path('templates', __dir__)
 
+    class_option :test, type: :boolean, default: false, aliases: '-t', desc: 'Indicates that app will be installed in a test environment'
+
     def create_blacklight_catalog
       remove_file 'app/controllers/catalog_controller.rb'
       copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
@@ -41,9 +43,31 @@ module Arclight
       gsub_file 'config/routes.rb', 'root to: "catalog#index"', 'root to: "arclight/repositories#index"'
     end
 
-    def copy_styles
+    def add_frontend
+      if ENV['CI']
+        run "yarn add file:#{Arclight::Engine.root}"
+      elsif options[:test]
+        run 'yarn link arclight'
+
+      # If a branch was specified (e.g. you are running a template.rb build
+      # against a test branch), use the latest version available on npm
+      elsif ENV['BRANCH']
+        run 'yarn add arclight@latest'
+
+      # Otherwise, pick the version from npm that matches the Arclight
+      # gem version
+      else
+        run "yarn add arclight@#{arclight_yarn_version}"
+      end
+    end
+
+    def add_stylesheets
       copy_file 'arclight.scss', 'app/assets/stylesheets/arclight.scss'
-      remove_file 'app/assets/stylesheets/blacklight.scss' # Avoid two copies of bootstrap
+      append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+        <<~CONTENT
+          @import "arclight";
+        CONTENT
+      end
     end
 
     def add_arclight_search_behavior
@@ -122,5 +146,18 @@ module Arclight
     def import_arclight_javascript
       append_to_file 'app/javascript/application.js', "\nimport \"arclight\""
     end
+
+    def package_yarn_version(package_name, requested_version)
+      versions = JSON.parse(`yarn info #{package_name} versions --json`)['data']
+      exact_match = versions.find { |v| v == requested_version }
+      return exact_match if exact_match
+
+      major_version = Gem::Version.new(requested_version).segments.first
+      "^#{major_version}"
+    end
+
+    def arclight_yarn_version
+      package_yarn_version('arclight', Arclight::VERSION)
+    end
   end
 end

data/lib/generators/arclight/templates/arclight.scss

@@ -1,5 +1,6 @@
-$breadcrumb-divider: quote("»");
-$logo-image: image_url('arclight/logo.png') !default;
-@import 'bootstrap';
-@import 'blacklight/blacklight';
-@import 'arclight/application';
+:root {
+  --bs-breadcrumb-divider: "»";
+}
+
+// Arclight, imported from arclight frontend package
+@import 'arclight/app/assets/stylesheets/arclight/application';

data/lib/generators/arclight/templates/catalog_controller.rb

@@ -78,6 +78,7 @@ class CatalogController < ApplicationController
     config.show.embed_component = Arclight::EmbedComponent
     config.show.access_component = Arclight::AccessComponent
     config.show.online_status_component = Arclight::OnlineStatusIndicatorComponent
+    config.show.expand_hierarchy_component = Arclight::ExpandHierarchyButtonComponent
     config.show.display_type_field = 'level_ssm'
     # config.show.thumbnail_field = 'thumbnail_path_ss'
     config.show.document_presenter_class = Arclight::ShowPresenter

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arclight",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "The frontend for arclight",
   "main": "app/assets/javascript/arclight/arclight.js",
   "files": ["app/assets"],

data/tasks/arclight.rake

@@ -7,13 +7,20 @@ require 'arclight'
 
 class DependencyNotInstalled < StandardError; end
 
+# Build with our opinionated defaults if none are provided.
+rails_options = ENV.fetch('ENGINE_CART_RAILS_OPTIONS', '')
+rails_options = "#{rails_options} -a propshaft" unless rails_options.match?(/-a\s|--asset-pipeline/)
+rails_options = "#{rails_options} -j importmap" unless rails_options.match?(/-j\s|--javascript/)
+rails_options = "#{rails_options} --css bootstrap" unless rails_options.match?(/--css/)
+ENV['ENGINE_CART_RAILS_OPTIONS'] = rails_options
+
 desc 'Run test suite'
 task ci: %w[arclight:generate] do
   SolrWrapper.wrap do |solr|
     solr.with_collection do
       Rake::Task['arclight:seed'].invoke
       within_test_app do
-        ## Do stuff inside arclight app here
+        system 'bin/rake spec:prepare'
       end
       Rake::Task['spec'].invoke
     end
@@ -47,7 +54,7 @@ namespace :arclight do
       solr.with_collection do
         Rake::Task['arclight:seed'].invoke
         within_test_app do
-          system "bundle exec rails s #{args[:rails_server_args]}"
+          system "bin/dev #{args[:rails_server_args]}"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arclight
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Darren Hardy
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -51,16 +51,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: traject
   requirement: !ruby/object:Gem::Requirement
@@ -356,6 +362,8 @@ files:
 - app/components/arclight/document_download_component.rb
 - app/components/arclight/embed_component.html.erb
 - app/components/arclight/embed_component.rb
+- app/components/arclight/expand_hierarchy_button_component.html.erb
+- app/components/arclight/expand_hierarchy_button_component.rb
 - app/components/arclight/group_component.html.erb
 - app/components/arclight/group_component.rb
 - app/components/arclight/header_component.html.erb
@@ -502,7 +510,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A Blacklight-based environment to support discovery and delivery for archives