speedy-af 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd6d0ac71c3da9c7807fe63bf98774a75abf4796130be797e19a9eba4ac6292
-  data.tar.gz: 549a1835b24011c7ebebef142654afb7c8ab0afdd0b70e39a713e7e1c9055dca
+  metadata.gz: 0ff0f3d554f80151433f700cfae02d61d3c271fbcfb1cefe132d8a9e0e518734
+  data.tar.gz: 01433ba5beca3308fa708191c76a2be9df2b5682be1ae41a3dc08f6ad6dd42af
 SHA512:
-  metadata.gz: 50e4f754a2f59937b4d08a3ccd9d460e64ecbba50d1e5eed821a28fcb77aab99f77a62307c9185269d27ac1f0baab58e72f8e56cc9debbab71bd99c2c54700e5
-  data.tar.gz: f0f1e0fd4e04f475085ada08769cf9617a95f6ddcd2b0955cea44adc91284844862d0c3c6729c9bc17c32ba456067e448d83c81be9899520003b5dea3b142ed1
+  metadata.gz: '09e918cd65f5a0ee8a1cf5365f268f68fb265c39da957265598cfd8fa1c363ce5447b0523b7e938264505f49ac420e80af38c331390fb8c547eb5621a519e3d8'
+  data.tar.gz: e900999b19accf9c9d35c8b33480bfdd32b79375c34bd9d8108bfaf92105d67984aafdcb2b8196906d91ccb3aa7357ae5f8de373b1162898406fca6e8f378c1a

data/.circleci/config.yml

@@ -37,6 +37,14 @@ jobs:
 workflows:
   ci:
     jobs:
+      - bundle_and_test:
+          name: "ruby3-4_rails8-0"
+          ruby_version: "3.4.5"
+          rails_version: "8.0.1"
+      - bundle_and_test:
+          name: "ruby3-3_rails8-0"
+          ruby_version: "3.3.4"
+          rails_version: "8.0.1"
       - bundle_and_test:
           name: "ruby3-3_rails7-2"
           ruby_version: "3.3.4"

data/README.md

@@ -91,6 +91,12 @@ If you have questions or need help, please email [the Hydra community tech list]
   be more mindful of both local resources and Solr request limits.
 * `Base` may not play nicely with language-tagged RDF literals, as ActiveFedora does not
   currently index/encode the language tag into Solr.
+* belongs_to relationships do not respect `include_reflections` filtering and will fetch all
+  belongs_to reflections when the `include_reflections` is not false.
+
+# Development
+
+To run tests locally, spin up Fedora and Solr using `docker-compose up` then run tests using `bundle exec rspec`.
 
 # Acknowledgments
 

data/docker-compose.yml

@@ -0,0 +1,26 @@
+volumes:
+  fedora:
+  solr:
+
+services:
+  fedora:
+    image: ghcr.io/samvera/fcrepo4:4.7.5
+    volumes:
+      - fedora:/data
+    ports:
+      - '8986:8080'
+
+  solr:
+    image: solr:9
+    volumes:
+      - ./solr/conf:/opt/solr/core_conf
+      - solr:/var/solr
+    command:
+      - solr-precreate
+      - hydra-test
+      - /opt/solr/core_conf
+    environment:
+      - SOLR_MODULES=analysis-extras,extraction
+    ports:
+      - '8985:8983'
+

data/lib/speedy_af/base.rb

@@ -90,11 +90,11 @@ module SpeedyAF
         reflections
       end
 
-      def query_for_belongs_to(proxy_hash, _opts)
+      def query_for_belongs_to(proxy_hash, opts)
         proxy_hash.collect do |_id, proxy|
-          proxy.belongs_to_reflections.collect do |_name, reflection|
-            id = proxy.attrs[predicate_for_reflection(reflection).to_sym]
-            id.blank? ? nil : "id:#{id}"
+          proxy.belongs_to_reflections(only: opts[:load_reflections]).collect do |_name, reflection|
+            ids = proxy.attrs[predicate_for_reflection(reflection).to_sym]
+            ids.blank? ? nil : Array(ids).collect { |id| "id:#{id}" }.join(" OR ")
           end.compact
         end.flatten.join(" OR ")
       end
@@ -103,7 +103,7 @@ module SpeedyAF
         hash = {}
         proxy_hash.each do |proxy_id, proxy|
           proxy.belongs_to_reflections.each do |name, reflection|
-            doc = docs.find { |d| d.id == proxy.attrs[predicate_for_reflection(reflection).to_sym] }
+            doc = docs.find { |d| proxy.attrs[predicate_for_reflection(reflection).to_sym].include?(d.id) && d["has_model_ssim"].include?(reflection.class_name) }
             next unless doc
             hash[proxy_id] ||= {}
             hash[proxy_id][name] = doc
@@ -113,9 +113,13 @@ module SpeedyAF
         hash
       end
 
-      def query_for_has_many(proxy_hash, _opts)
+      def query_for_has_many(proxy_hash, opts)
         proxy_hash.collect do |id, proxy|
-          proxy.has_many_reflections.collect { |_name, reflection| "#{predicate_for_reflection(reflection)}_ssim:#{id}" }
+          proxy.has_many_reflections(only: opts[:load_reflections]).collect do |_name, reflection|
+            query = "#{predicate_for_reflection(reflection)}_ssim:#{id}"
+            query = "(#{query} AND has_model_ssim:#{reflection.class_name})"
+            query
+          end
         end.flatten.join(" OR ")
       end
 
@@ -125,7 +129,7 @@ module SpeedyAF
         docs.each do |doc|
           has_many_reflections.each do |name, reflection|
             Array(doc["#{predicate_for_reflection(reflection)}_ssim"]).each do |proxy_id|
-              next unless proxy_hash.key?(proxy_id)
+              next unless proxy_hash.key?(proxy_id) && doc["has_model_ssim"].include?(reflection.class_name)
               hash[proxy_id] ||= {}
               hash[proxy_id][name] ||= []
               hash[proxy_id][name] << doc
@@ -137,9 +141,9 @@ module SpeedyAF
         hash
       end
 
-      def query_for_subresources(proxy_hash, _opts)
+      def query_for_subresources(proxy_hash, opts)
         proxy_hash.collect do |id, proxy|
-          proxy.subresource_reflections.collect { |name, _reflection| "id:#{id}/#{name}" }
+          proxy.subresource_reflections(only: opts[:load_reflections]).collect { |name, _reflection| "id:#{id}/#{name}" }
         end.flatten.join(" OR ")
       end
 
@@ -199,7 +203,6 @@ module SpeedyAF
 
     def method_missing(sym, *args)
       return real_object.send(sym, *args) if real?
-
       if @attrs.key?(sym)
         # Lazy convert the solr document into a speedy_af proxy object
         @attrs[sym] = SpeedyAF::Base.for(@attrs[sym]) if @attrs[sym].is_a?(ActiveFedora::SolrHit)
@@ -223,18 +226,33 @@ module SpeedyAF
       super
     end
 
-    def subresource_reflections
+    def subresource_reflections(only: nil)
       SpeedyAF::Base.model_reflections[:subresource][model] ||= model.reflections.select { |_name, reflection| reflection.is_a? ActiveFedora::Reflection::HasSubresourceReflection }
+      if only.is_a?(Array) && only.present?
+        SpeedyAF::Base.model_reflections[:subresource][model].select { |name, _reflection| only.include? name }
+      else
+        SpeedyAF::Base.model_reflections[:subresource][model]
+      end
     end
 
     # rubocop:disable Naming/PredicateName
-    def has_many_reflections
+    def has_many_reflections(only: nil)
       SpeedyAF::Base.model_reflections[:has_many][model] ||= model.reflections.select { |_name, reflection| reflection.has_many? && reflection.respond_to?(:predicate_for_solr) }
+      if only.is_a?(Array) && only.present?
+        SpeedyAF::Base.model_reflections[:has_many][model].select { |name, _reflection| only.include? name }
+      else
+        SpeedyAF::Base.model_reflections[:has_many][model]
+      end
     end
     # rubocop:enable Naming/PredicateName
 
-    def belongs_to_reflections
+    def belongs_to_reflections(only: nil)
       SpeedyAF::Base.model_reflections[:belongs_to][model] ||= model.reflections.select { |_name, reflection| reflection.belongs_to? && reflection.respond_to?(:predicate_for_solr) }
+      if only.is_a?(Array) && only.present?
+        SpeedyAF::Base.model_reflections[:belongs_to][model].select { |name, _reflection| only.include? name }
+      else
+        SpeedyAF::Base.model_reflections[:belongs_to][model]
+      end
     end
 
     protected
@@ -260,7 +278,7 @@ module SpeedyAF
       attr_name, type, _stored, _indexed, _multi = k.scan(/^(.+)_(.+)(s)(i?)(m?)$/).first
       return [k, v] if attr_name.nil?
       value = Array(v).map { |m| transforms.fetch(type, transforms[nil]).call(m) }
-      value = value.first unless @model.respond_to?(:properties) && multiple?(@model.properties[attr_name])
+      value = value.first unless reflection_solr_fields(@model).include?(attr_name) || (@model.respond_to?(:properties) && multiple?(@model.properties[attr_name]))
       [attr_name, value]
     end
 
@@ -268,10 +286,15 @@ module SpeedyAF
       prop.present? && prop.respond_to?(:multiple?) && prop.multiple?
     end
 
+    def reflection_solr_fields(model)
+      return [] unless model.respond_to?(:reflections)
+      model.reflections.values.select { |v| v.belongs_to? && v.respond_to?(:predicate_for_solr) }.collect(&:predicate_for_solr)
+    end
+
     def load_from_reflection(reflection, ids_only = false)
       return load_through_reflection(reflection, ids_only) if reflection.options.key?(:through)
-      return load_belongs_to_reflection(reflection.predicate_for_solr, ids_only) if reflection.belongs_to? && reflection.respond_to?(:predicate_for_solr)
-      return load_has_many_reflection(reflection.predicate_for_solr, ids_only) if reflection.has_many? && reflection.respond_to?(:predicate_for_solr)
+      return load_belongs_to_reflection(reflection, ids_only) if reflection.belongs_to? && reflection.respond_to?(:predicate_for_solr)
+      return load_has_many_reflection(reflection, ids_only) if reflection.has_many? && reflection.respond_to?(:predicate_for_solr)
       return load_subresource_content(reflection) if reflection.is_a?(ActiveFedora::Reflection::HasSubresourceReflection)
       # :nocov:
       raise NotAvailable, "`#{reflection.name}' cannot be quick-loaded. Falling back to model."
@@ -302,14 +325,18 @@ module SpeedyAF
       ids
     end
 
-    def load_belongs_to_reflection(predicate, ids_only = false)
-      id = @attrs[predicate.to_sym]
-      return id if ids_only
-      Base.find(id)
+    def load_belongs_to_reflection(reflection, ids_only = false)
+      id = @attrs[reflection.predicate_for_solr.to_sym]
+      return id.first if ids_only && Array(id).size == 1
+      return if id.blank?
+      query = Array(id).collect { |i| "id:#{i}" }.join(" OR ")
+      query = "(#{query}) AND has_model_ssim:#{reflection.class_name}"
+      obj = Base.where(query, rows: 1).first
+      ids_only ? obj&.id : obj
     end
 
-    def load_has_many_reflection(predicate, ids_only = false)
-      query = %(#{predicate}_ssim:#{id})
+    def load_has_many_reflection(reflection, ids_only = false)
+      query = "#{reflection.predicate_for_solr}_ssim:#{id} AND has_model_ssim:#{reflection.class_name}"
       return Base.where(query) unless ids_only
       docs = ActiveFedora::SolrService.query query, rows: SOLR_ALL
       docs.collect { |doc| doc['id'] }

data/lib/speedy_af/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SpeedyAF
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/fixture_classes.rb

@@ -3,6 +3,10 @@ class IndexedFile < ActiveFedora::File
   include SpeedyAF::IndexedContent
 end
 
+class SampleResource < ActiveFedora::File
+  include SpeedyAF::IndexedContent
+end
+
 class Chapter < ActiveFedora::Base
   property :title, predicate: ::RDF::Vocab::DC.title, multiple: false do |index|
     index.as :stored_searchable
@@ -12,18 +16,23 @@ class Chapter < ActiveFedora::Base
   end
 end
 
-module DowncaseBehavior
+module TitleBehavior
   def lowercase_title
     title.downcase
   end
+
+  def uppercase_title
+    title.upcase
+  end
 end
 
 class Book < ActiveFedora::Base
-  include DowncaseBehavior
+  include TitleBehavior
   include SpeedyAF::OrderedAggregationIndex
 
   belongs_to :library, predicate: ::RDF::Vocab::DC.isPartOf
   has_subresource 'indexed_file', class_name: 'IndexedFile'
+  has_subresource 'descMetadata', class_name: 'SampleResource'
   has_subresource 'unindexed_file', class_name: 'ActiveFedora::File'
   property :title, predicate: ::RDF::Vocab::DC.title, multiple: false do |index|
     index.as :stored_searchable
@@ -33,14 +42,28 @@ class Book < ActiveFedora::Base
   end
   ordered_aggregation :chapters, through: :list_source
   indexed_ordered_aggregation :chapters
+end
 
-  def uppercase_title
-    title.upcase
+class Comic < ActiveFedora::Base
+  include TitleBehavior
+
+  belongs_to :library, predicate: ::RDF::Vocab::DC.isPartOf
+  belongs_to :comic_shop, predicate: ::RDF::Vocab::DC.isPartOf
+  property :title, predicate: ::RDF::Vocab::DC.title, multiple: false do |index|
+    index.as :stored_searchable
+  end
+  property :publisher, predicate: ::RDF::Vocab::DC.publisher, multiple: false do |index|
+    index.as :stored_searchable
   end
 end
 
 class Library < ActiveFedora::Base
-  has_many :books, predicate: ::RDF::Vocab::DC.isPartOf
+  has_many :books, class_name: 'Book', predicate: ::RDF::Vocab::DC.isPartOf
+  has_many :comics, class_name: 'Comic', predicate: ::RDF::Vocab::DC.isPartOf
+end
+
+class ComicShop < ActiveFedora::Base
+  has_many :comics, predicate: ::RDF::Vocab::DC.isPartOf
 end
 
 module SpeedySpecs

data/spec/integration/base_spec.rb

@@ -3,11 +3,13 @@ require 'spec_helper'
 require 'rdf/vocab/dc'
 
 describe SpeedyAF::Base do
-  before { load_fixture_classes!   }
+  before { load_fixture_classes! }
   after  { unload_fixture_classes! }
 
   let!(:library) { Library.create }
+  let!(:comic_shop) { ComicShop.create }
   let!(:book) { Book.new title: 'Ordered Things', publisher: 'ActiveFedora Performance LLC', library: library }
+  let!(:comic) { Comic.new title: 'Vestibulum velit nulla', publisher: 'SpeedyAF LLC', library: library, comic_shop: comic_shop }
   let!(:chapters) do
     [
       Chapter.create(title: 'Chapter 3', contributor: ['Hopper', 'Lovelace', 'Johnson']),
@@ -31,12 +33,22 @@ describe SpeedyAF::Base do
     Nigh tofth eliv ingdead.
     IPSUM
   end
+  let!(:metadata) do
+    <<-IPSUM
+    In scelerisque volutpat rutrum. Phasellus dictum velit at orci luctus convallis. Nulla rutrum
+    eget libero at sodales. Suspendisse potenti. Donec ut lobortis mi, ut venenatis diam. Phasellus
+    mi felis, cursus at lacinia vitae, aliquam vitae eros. Suspendisse tincidunt a massa in
+    condimentum. Nulla finibus risus quam, vel elementum enim sodales at.
+    IPSUM
+  end
   let(:book_presenter) { described_class.find(book.id) }
+  let(:comic_presenter) { described_class.find(comic.id) }
 
   context 'lightweight presenter' do
     before do
       book.indexed_file.content = indexed_content
       book.unindexed_file.content = unindexed_content
+      book.descMetadata.content = metadata
       book.chapters = chapters
       book.ordered_chapters = chapters.sort_by(&:title)
       book.save!
@@ -66,6 +78,7 @@ describe SpeedyAF::Base do
 
     context 'reflections' do
       let!(:library_presenter) { described_class.find(library.id) }
+      let!(:comic_shop_presenter) { described_class.find(comic_shop.id) }
 
       it 'loads via indexed proxies' do
         expect(book_presenter.chapter_ids).to match_array(book.chapter_ids)
@@ -82,27 +95,38 @@ describe SpeedyAF::Base do
 
       it 'loads indexed subresources' do
         ipsum_presenter = book_presenter.indexed_file
+        lorem_presenter = book_presenter.descMetadata
         expect(ipsum_presenter.model).to eq(IndexedFile)
+        expect(lorem_presenter.model).to eq(SampleResource)
         expect(ipsum_presenter.content).to eq(indexed_content)
+        expect(lorem_presenter.content).to eq(metadata)
         expect(book_presenter).not_to be_real
         expect(ipsum_presenter).not_to be_real
+        expect(lorem_presenter).not_to be_real
       end
 
       it 'loads has_many reflections' do
         library.books.create(title: 'Ordered Things II')
+        library.comics.create(title: 'Comet in Moominland')
         library.save
-        presenter = library_presenter.books
-        expect(presenter.length).to eq(2)
-        expect(presenter.all? { |bp| bp.is_a?(described_class) }).to be_truthy
+        expect(library_presenter.books.length).to eq(2)
+        expect(library_presenter.books.all? { |bp| bp.is_a?(described_class) }).to be_truthy
         expect(library_presenter.book_ids).to match_array(library.book_ids)
+        expect(library_presenter.comics.length).to eq(1)
+        expect(library_presenter.comics.all? { |bp| bp.is_a?(described_class) }).to be_truthy
+        expect(library_presenter.comic_ids).to match_array(library.comic_ids)
         expect(library_presenter).not_to be_real
       end
 
       it 'loads belongs_to reflections' do
-        expect(book_presenter.library_id).to eq(library.id)
-        expect(book_presenter.library).to be_a(described_class)
-        expect(book_presenter.library.model).to eq(library.class)
-        expect(book_presenter).not_to be_real
+        comic.save!
+        expect(comic_presenter.library_id).to eq(library.id)
+        expect(comic_presenter.library).to be_a(described_class)
+        expect(comic_presenter.library.model).to eq(library.class)
+        expect(comic_presenter.comic_shop_id).to eq(comic_shop.id)
+        expect(comic_presenter.comic_shop).to be_a(described_class)
+        expect(comic_presenter.comic_shop.model).to eq(comic_shop.class)
+        expect(comic_presenter).not_to be_real
       end
 
       context 'missing parent id' do
@@ -129,15 +153,22 @@ describe SpeedyAF::Base do
 
         it 'has already loaded has_many reflections' do
           library.books.create(title: 'Ordered Things II')
+          library.comics.create(title: 'Comet in Moominland')
           library.save
           book_ids = library.book_ids
+          comic_ids = library.comic_ids
           library_presenter = described_class.find(library.id, load_reflections: true)
           expect(library_presenter.attrs).to include :books
+          expect(library_presenter.attrs).to include :comics
           allow(ActiveFedora::SolrService).to receive(:query).and_call_original
-          presenter = library_presenter.books
-          expect(presenter.length).to eq(2)
-          expect(presenter.all? { |bp| bp.is_a?(described_class) }).to be_truthy
+          books_presenter = library_presenter.books
+          comics_presenter = library_presenter.comics
+          expect(books_presenter.length).to eq(2)
+          expect(books_presenter.all? { |bp| bp.is_a?(described_class) }).to be_truthy
+          expect(comics_presenter.length).to eq(1)
+          expect(comics_presenter.all? { |bp| bp.is_a?(described_class) }).to be_truthy
           expect(library_presenter.book_ids).to match_array(book_ids)
+          expect(library_presenter.comic_ids).to match_array(comic_ids)
           expect(library_presenter).not_to be_real
           expect(ActiveFedora::SolrService).not_to have_received(:query)
         end
@@ -151,13 +182,61 @@ describe SpeedyAF::Base do
           expect(book_presenter).not_to be_real
           expect(ActiveFedora::SolrService).not_to have_received(:query)
         end
+
+        context 'filtering' do
+          let(:book_presenter) { described_class.find(book.id, load_reflections: [:indexed_file]) }
+          let(:comic_presenter) { described_class.find(comic.id, load_reflections: [:comic_shop]) }
+          before { comic.save! }
+
+          it 'has already loaded filtered subresources' do
+            expect(book_presenter.attrs).to include :indexed_file
+            expect(book_presenter.attrs).to_not include :descMetadata
+            allow(ActiveFedora::SolrService).to receive(:query).and_call_original
+            ipsum_presenter = book_presenter.indexed_file
+            expect(ipsum_presenter.model).to eq(IndexedFile)
+            expect(ipsum_presenter.content).to eq(indexed_content)
+            expect(ipsum_presenter).not_to be_real
+            expect(ActiveFedora::SolrService).not_to have_received(:query)
+          end
+
+          it 'has already loaded filtered has_many reflections' do
+            library.books.create(title: 'Ordered Things II')
+            library.save
+            book_ids = library.book_ids
+            library_presenter = described_class.find(library.id, load_reflections: [:books])
+            expect(library_presenter.attrs).to include :books
+            expect(library_presenter.attrs).to_not include :comics
+            allow(ActiveFedora::SolrService).to receive(:query).and_call_original
+            presenter = library_presenter.books
+            expect(presenter.length).to eq(2)
+            expect(presenter.all? { |bp| bp.is_a?(described_class) }).to be_truthy
+            expect(library_presenter.book_ids).to match_array(book_ids)
+            expect(library_presenter).not_to be_real
+            expect(ActiveFedora::SolrService).not_to have_received(:query)
+          end
+
+          it 'has already loaded belongs_to reflections and does not filter' do
+            expect(comic_presenter.attrs).to include :comic_shop
+            expect(comic_presenter.attrs).to include :library
+            allow(ActiveFedora::SolrService).to receive(:query).and_call_original
+            expect(comic_presenter.comic_shop_id).to eq(comic_shop.id)
+            expect(comic_presenter.comic_shop).to be_a(described_class)
+            expect(comic_presenter.comic_shop.model).to eq(comic_shop.class)
+            expect(comic_presenter).not_to be_real
+            expect(comic_presenter.library_id).to eq(library.id)
+            expect(comic_presenter.library).to be_a(described_class)
+            expect(comic_presenter.library.model).to eq(library.class)
+            expect(comic_presenter).not_to be_real
+            expect(ActiveFedora::SolrService).not_to have_received(:query)
+          end
+        end
       end
     end
 
     context 'configuration' do
       before do
         described_class.config Book do
-          include DowncaseBehavior
+          include TitleBehavior
           self.defaults = { foo: 'bar!' }
         end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: speedy-af
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -196,6 +195,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - lib/speedy-af.rb
 - lib/speedy_af.rb
 - lib/speedy_af/base.rb
@@ -211,7 +211,6 @@ homepage: http://github.com/samvera-labs/speedy_af
 licenses:
 - APACHE2
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -226,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Performance enhancements for ActiveFedora
 test_files: []