speedy-af 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed5f4d42ff93fc2fb41bbc8096025cd873767f3f01e9182ea87f309dbb7f6b0
-  data.tar.gz: def94b1cb7b8f0dd8e8241d4e8dba0b1f80e849cb10ebe0346d788f18bf8b3b2
+  metadata.gz: 0fd6d0ac71c3da9c7807fe63bf98774a75abf4796130be797e19a9eba4ac6292
+  data.tar.gz: 549a1835b24011c7ebebef142654afb7c8ab0afdd0b70e39a713e7e1c9055dca
 SHA512:
-  metadata.gz: 2607efe588e3b14c24712c27cfa847be6eec358abc77adbe0e47d0f68ac93e7a551184c4ac9b5486e3ba75b41989b85cf2d3a865fe00c8a0aed1460abb1b1839
-  data.tar.gz: e79f5bb789b2527dbd728eae084ba42600d637a8284818eedbed2a7c2af2d1a7068b50830c35b6092d9f911c25df31dc49e2da2a60e0a934851200f050306b69
+  metadata.gz: 50e4f754a2f59937b4d08a3ccd9d460e64ecbba50d1e5eed821a28fcb77aab99f77a62307c9185269d27ac1f0baab58e72f8e56cc9debbab71bd99c2c54700e5
+  data.tar.gz: f0f1e0fd4e04f475085ada08769cf9617a95f6ddcd2b0955cea44adc91284844862d0c3c6729c9bc17c32ba456067e448d83c81be9899520003b5dea3b142ed1

data/.circleci/config.yml

@@ -10,14 +10,14 @@ jobs:
         type: string
       bundler_version:
         type: string
-        default: 2.0.2
+        default: 2.5.18
       ffmpeg_version:
         type: string
         default: 4.1.4
     executor:
       name: 'samvera/ruby_fcrepo_solr'
       ruby_version: << parameters.ruby_version >>
-      solr_version: 7-alpine
+      solr_version: 8-slim
     environment:
       RAILS_VERSION: << parameters.rails_version >>
     working_directory: ~/project
@@ -38,10 +38,22 @@ workflows:
   ci:
     jobs:
       - bundle_and_test:
-          name: "ruby2-7_rails6-0"
-          ruby_version: "2.7.5"
-          rails_version: "6.0.4.4"
+          name: "ruby3-3_rails7-2"
+          ruby_version: "3.3.4"
+          rails_version: "7.2.1"
       - bundle_and_test:
-          name: "ruby2-7_rails5-2"
-          ruby_version: "2.7.5"
-          rails_version: "5.2.6"
+          name: "ruby3-2_rails7-1"
+          ruby_version: "3.2.5"
+          rails_version: "7.1.4"
+      - bundle_and_test:
+          name: "ruby3-1_rails7-1"
+          ruby_version: "3.1.6"
+          rails_version: "7.1.4"
+      - bundle_and_test:
+          name: "ruby3-2_rails7-0"
+          ruby_version: "3.2.5"
+          rails_version: "7.0.8.4"
+      - bundle_and_test:
+          name: "ruby3-1_rails7-0"
+          ruby_version: "3.1.6"
+          rails_version: "7.0.8.4"

data/.rubocop_todo.yml

@@ -11,21 +11,34 @@
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 143
+  Exclude:
+    - 'spec/**/*_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 165
+  Exclude:
+    - 'lib/speedy_af/base.rb'
 
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 40
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.

data/Rakefile

@@ -5,6 +5,15 @@ require 'active_fedora/rake_support'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+# This is to fix a breaking change with Ruby 3.2 where some methods
+# in fcrepo_wrapper use the removed `File.exists?` alias, preventing
+# tests from being set up.
+class File
+  class << self
+    alias exists? exist?
+  end
+end
+
 require 'rspec/core/rake_task'
 desc 'Run tests only'
 RSpec::Core::RakeTask.new(:rspec) do |spec|

data/lib/speedy_af/base.rb

@@ -7,55 +7,154 @@ module SpeedyAF
 
     SOLR_ALL = 10_000_000
 
+    class_attribute :model_reflections, :reflection_predicates
+    SpeedyAF::Base.model_reflections = { belongs_to: {}, has_many: {}, subresource: {} }
+    SpeedyAF::Base.reflection_predicates = {}
+
     attr_reader :attrs, :model
 
-    def self.defaults
-      @defaults ||= {}
-    end
+    class << self
+      def defaults
+        @defaults ||= {}
+      end
 
-    def self.defaults=(value)
-      raise ArgumentError unless value.respond_to?(:merge)
-      @defaults = value
-    end
+      def defaults=(value)
+        raise ArgumentError unless value.respond_to?(:merge)
+        @defaults = value
+      end
 
-    def self.proxy_class_for(model)
-      klass = "::SpeedyAF::Proxy::#{model.name}".safe_constantize
-      if klass.nil?
-        namespace = model.name.deconstantize
-        name = model.name.demodulize
-        klass_module = namespace.split(/::/).inject(::SpeedyAF::Proxy) do |mod, ns|
-          mod.const_defined?(ns, false) ? mod.const_get(ns, false) : mod.const_set(ns, Module.new)
+      def proxy_class_for(model)
+        klass = "::SpeedyAF::Proxy::#{model.name}".safe_constantize
+        if klass.nil?
+          namespace = model.name.deconstantize
+          name = model.name.demodulize
+          klass_module = namespace.split(/::/).inject(::SpeedyAF::Proxy) do |mod, ns|
+            mod.const_defined?(ns, false) ? mod.const_get(ns, false) : mod.const_set(ns, Module.new)
+          end
+          klass = klass_module.const_set(name, Class.new(self))
         end
-        klass = klass_module.const_set(name, Class.new(self))
+        klass
       end
-      klass
-    end
 
-    def self.config(model, &block)
-      proxy_class = proxy_class_for(model) { Class.new(self) }
-      proxy_class.class_eval(&block) if block_given?
-    end
+      def config(model, &block)
+        proxy_class = proxy_class_for(model) { Class.new(self) }
+        proxy_class.class_eval(&block) if block_given?
+      end
 
-    def self.find(id, opts = {})
-      where(%(id:"#{id}"), opts).first
-    end
+      def find(id, opts = {})
+        where(%(id:"#{id}"), opts.merge(rows: 1)).first
+      end
 
-    def self.where(query, opts = {})
-      docs = ActiveFedora::SolrService.query(query, rows: SOLR_ALL)
-      from(docs, opts)
-    end
+      def where(query, opts = {})
+        docs = ActiveFedora::SolrService.query(query, rows: opts[:rows] || SOLR_ALL)
+        from(docs, opts)
+      end
 
-    def self.from(docs, opts = {})
-      hash = docs.each_with_object({}) do |doc, h|
+      def for(doc, opts = {})
         proxy = proxy_class_for(model_for(doc))
-        h[doc['id']] = proxy.new(doc, opts[:defaults])
+        proxy.new(doc, opts[:defaults])
       end
-      return hash.values if opts[:order].nil?
-      opts[:order].call.collect { |id| hash[id] }.to_a
-    end
 
-    def self.model_for(solr_document)
-      solr_document[:has_model_ssim].first.safe_constantize
+      def from(docs, opts = {})
+        hash = docs.each_with_object({}) do |doc, h|
+          h[doc['id']] = self.for(doc, opts)
+        end
+
+        if opts[:load_reflections]
+          reflections_hash = gather_reflections(hash, opts)
+          reflections_hash.each { |parent_id, reflections| hash[parent_id].attrs.merge!(reflections) }
+        end
+
+        return hash.values if opts[:order].nil?
+        opts[:order].call.collect { |id| hash[id] }.to_a
+      end
+
+      def model_for(solr_document)
+        solr_document[:has_model_ssim].first.safe_constantize
+      end
+
+      protected
+
+      def predicate_for_reflection(reflection)
+        SpeedyAF::Base.reflection_predicates[reflection.name] ||= reflection.predicate_for_solr
+      end
+
+      def gather_reflections(proxy_hash, opts)
+        query = [query_for_belongs_to(proxy_hash, opts), query_for_has_many(proxy_hash, opts), query_for_subresources(proxy_hash, opts)].reject(&:blank?).join(" OR ")
+        docs = ActiveFedora::SolrService.query query, rows: SOLR_ALL
+
+        reflections = {}
+        reflections.deep_merge!(gather_belongs_to(docs, proxy_hash, opts))
+        reflections.deep_merge!(gather_has_many(docs, proxy_hash, opts))
+        reflections.deep_merge!(gather_subresources(docs, proxy_hash, opts))
+        reflections
+      end
+
+      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}"
+          end.compact
+        end.flatten.join(" OR ")
+      end
+
+      def gather_belongs_to(docs, proxy_hash, _opts)
+        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] }
+            next unless doc
+            hash[proxy_id] ||= {}
+            hash[proxy_id][name] = doc
+            hash[proxy_id]["#{name}_id".to_sym] = doc.id
+          end
+        end
+        hash
+      end
+
+      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}" }
+        end.flatten.join(" OR ")
+      end
+
+      def gather_has_many(docs, proxy_hash, _opts)
+        hash = {}
+        has_many_reflections = SpeedyAF::Base.model_reflections[:has_many].values.reduce(:merge)
+        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)
+              hash[proxy_id] ||= {}
+              hash[proxy_id][name] ||= []
+              hash[proxy_id][name] << doc
+              hash[proxy_id]["#{name.to_s.singularize}_ids".to_sym] ||= []
+              hash[proxy_id]["#{name.to_s.singularize}_ids".to_sym] << doc.id
+            end
+          end
+        end
+        hash
+      end
+
+      def query_for_subresources(proxy_hash, _opts)
+        proxy_hash.collect do |id, proxy|
+          proxy.subresource_reflections.collect { |name, _reflection| "id:#{id}/#{name}" }
+        end.flatten.join(" OR ")
+      end
+
+      def gather_subresources(docs, proxy_hash, _opts)
+        docs.each_with_object({}) do |doc, hash|
+          doc_id = doc.id
+          parent_id = proxy_hash.keys.find { |id| doc_id.start_with? id }
+          next unless parent_id
+          subresource_id = proxy_hash[parent_id].subresource_reflections.keys.find { |name| doc_id == "#{parent_id}/#{name}" }
+          next unless subresource_id
+          hash[parent_id] ||= {}
+          hash[parent_id][subresource_id.to_sym] = doc
+          hash[parent_id]["#{subresource_id}_id".to_sym] = doc_id
+        end
+      end
     end
 
     def initialize(solr_document, instance_defaults = {})
@@ -101,7 +200,12 @@ module SpeedyAF
     def method_missing(sym, *args)
       return real_object.send(sym, *args) if real?
 
-      return @attrs[sym] if @attrs.key?(sym)
+      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)
+        @attrs[sym] = @attrs[sym].map { |doc| SpeedyAF::Base.for(doc) } if @attrs[sym].is_a?(Array) && @attrs[sym].all? { |d| d.is_a?(ActiveFedora::SolrHit) }
+        return @attrs[sym]
+      end
 
       reflection = reflection_for(sym)
       unless reflection.nil?
@@ -119,6 +223,20 @@ module SpeedyAF
       super
     end
 
+    def subresource_reflections
+      SpeedyAF::Base.model_reflections[:subresource][model] ||= model.reflections.select { |_name, reflection| reflection.is_a? ActiveFedora::Reflection::HasSubresourceReflection }
+    end
+
+    # rubocop:disable Naming/PredicateName
+    def has_many_reflections
+      SpeedyAF::Base.model_reflections[:has_many][model] ||= model.reflections.select { |_name, reflection| reflection.has_many? && reflection.respond_to?(:predicate_for_solr) }
+    end
+    # rubocop:enable Naming/PredicateName
+
+    def belongs_to_reflections
+      SpeedyAF::Base.model_reflections[:belongs_to][model] ||= model.reflections.select { |_name, reflection| reflection.belongs_to? && reflection.respond_to?(:predicate_for_solr) }
+    end
+
     protected
 
     def reflection_for(sym)

data/lib/speedy_af/version.rb

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

data/spec/integration/base_spec.rb

@@ -61,7 +61,7 @@ describe SpeedyAF::Base do
     end
 
     it '.to_query' do
-      expect(book.to_query('book_id')).to eq("book_id=#{URI.encode(book.id, /[^\-_.!~*'()a-zA-Z\d;?:@&=+$,\[\]]/)}")
+      expect(book.to_query('book_id')).to eq("book_id=#{URI::Parser.new.escape(book.id, /[^\-_.!~*'()a-zA-Z\d;?:@&=+$,\[\]]/)}")
     end
 
     context 'reflections' do
@@ -104,6 +104,54 @@ describe SpeedyAF::Base do
         expect(book_presenter.library.model).to eq(library.class)
         expect(book_presenter).not_to be_real
       end
+
+      context 'missing parent id' do
+        let(:book) { Book.new title: 'Ordered Things', publisher: 'ActiveFedora Performance LLC', library: nil }
+        it 'does not cause belongs_to reflections to error' do
+          expect(book_presenter.library_id).to be_nil
+          expect(book_presenter.library).to be_nil
+          expect(book_presenter).not_to be_real
+        end
+      end
+
+      context 'preloaded subresources' do
+        let(:book_presenter) { described_class.find(book.id, load_reflections: true) }
+
+        it 'has already loaded indexed subresources' do
+          expect(book_presenter.attrs).to include :indexed_file
+          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 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: true)
+          expect(library_presenter.attrs).to include :books
+          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' do
+          expect(book_presenter.attrs).to include :library
+          allow(ActiveFedora::SolrService).to receive(:query).and_call_original
+          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
+          expect(ActiveFedora::SolrService).not_to have_received(:query)
+        end
+      end
     end
 
     context 'configuration' do

data/speedy-af.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
   s.add_dependency 'active-fedora', '>= 11.0.0'
-  s.add_dependency 'activesupport', '> 5.2', '< 6.1'
+  s.add_dependency 'activesupport', '> 5.2'
   s.add_development_dependency 'solr_wrapper'
   s.add_development_dependency 'fcrepo_wrapper'
   s.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speedy-af
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -31,9 +31,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +38,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -232,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Performance enhancements for ActiveFedora