speedy-af 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd6d0ac71c3da9c7807fe63bf98774a75abf4796130be797e19a9eba4ac6292
-  data.tar.gz: 549a1835b24011c7ebebef142654afb7c8ab0afdd0b70e39a713e7e1c9055dca
+  metadata.gz: 172c12ad71984a304a61ef5ac110109eec26907ad11d73f2fd58d0ced0b88f6a
+  data.tar.gz: 0be67e88288ee13d853619cb91a2608450824d908230713ec3f8a9d535bde91f
 SHA512:
-  metadata.gz: 50e4f754a2f59937b4d08a3ccd9d460e64ecbba50d1e5eed821a28fcb77aab99f77a62307c9185269d27ac1f0baab58e72f8e56cc9debbab71bd99c2c54700e5
-  data.tar.gz: f0f1e0fd4e04f475085ada08769cf9617a95f6ddcd2b0955cea44adc91284844862d0c3c6729c9bc17c32ba456067e448d83c81be9899520003b5dea3b142ed1
+  metadata.gz: 7ff404cde599d7b7111cbceca64ca13f400740b1b4e794d93906b0c9e2987403f289f99294d3e7002946efd18d2cd41bfbdd7810f385a10e860bb6af33de0ec7
+  data.tar.gz: a38247cc3afe52ce3db0b9dce0b4f12b456ffe03654e8fab460f4489f60744ec7b8b602454b3853ecbf520699684caf96364e2736b8a6deec5c4593a9aca8460

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 Array(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.1'
 end

data/solr/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/conf/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"

data/solr/conf/protwords.txt

@@ -0,0 +1,21 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#-----------------------------------------------------------------------
+# Use a protected word file to protect against the stemmer reducing two
+# unrelated words to the same base word.
+
+# Some non-words that normally won't be encountered,
+# just to test that they won't be stemmed.
+dontstems
+zwhacky
+