hyrax-v2_graph_indexer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c228444cb3d0e2d5c4697fa414b161fffd0ece95d8da488d3a87b2e8216e4eb
+  data.tar.gz: be4552c5a5c335b1566b21d250379c0834d80673df06b38795b428a91621a58c
+SHA512:
+  metadata.gz: 4dec66cb7d6cbc5c042f58c669283ba91c8f756ff8d5eb4fc0eb5d31aa9d880bc8afaf99feafc9c573050d7bb2f0b1cb85f59cbe2b4e34a2a1aa1f63493d3ba5
+  data.tar.gz: c8dd13415027c00f77864c057b188658d05996d3f5ed64872f5a7f07336cd8560edd20cccb166de9b18f38ea6581f919cc5ad7cd263e06c8bb269c99a698c5b0

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in hyrax-v2_graph_indexer.gemspec.
+gemspec
+
+gem "sqlite3"
+
+# Start debugger with binding.b [https://github.com/ruby/debug]
+# gem "debug", ">= 1.0.0"

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright 2022 Software Services by Scientist.com
+
+Additional copyright may be held by others, as reflected in the commit history.
+
+Licensed 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.

data/README.md

@@ -0,0 +1,71 @@
+# Hyrax::V2GraphIndexer
+
+The `Hyrax::V2GraphIndexer` gem encapsulates a quasi-backport of the graph indexing now in [Hyrax](https://github.com/samvera/hyrax)'s `main` branch as well as the Hyrax `3.x` release.
+
+What do we mean by a quasi-backport?  Namely it doesn't attempt to make the graphing configurable; instead when you include this gem you then replace the venerable and non-performant [Samvera::NestingIndexer](https://github.com/samvera-labs/samvera-nesting_indexer).  You instead favor a the graph feature of SOLR.
+
+## Usage
+
+Add this gem to your `2.9.x` Hyrax application's Gemfile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hyrax-v2_graph_indexer"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install hyrax-v2_graph_indexer
+```
+
+## Contributing
+
+## Discussion
+
+This gem does not have much in the way of tests; it has instead been tested against production implementations.  The lack of tests is a concession to the return on investment of writing tests for a previous major version of Hyrax which no longer sees updates.
+
+This code was added to [Adventist's Hyku code-base](https://github.com/scientist-softserv/adventist-dl/) in the [fddb2863 commit](https://github.com/scientist-softserv/adventist-dl/commit/fddb28638a1f5a823399722ffb74916d0f584225).
+
+From that commit message:
+
+> Prior to this commit, we had disabled the logic for indexing the parent
+> child relationships of objects.  This results in broken behavior
+> regarding nesting collections and works.  Were we to enable the
+> "classic" strategy for indexing, we created significant (and known)
+> performance issues.
+>
+> With this commit, we are taking code that was backported to the 3.x
+> branch of Hyrax via [samvera/hyrax#5858][5858] and
+> [samvera/hyrax#5916][5916] and projecting that onto the 2.9.x
+> implementation.
+>
+> This projection means that we are not directly backporting but instead
+> structuring the code such that if you include it, it assumes you using
+> SOLR's native graph indexing.  The aforementioned PRs put those changes
+> behind a configuration variable; which is not something that makes sense
+> given this "hack."
+>
+> This PR aims to resolve three issues, which by their nature, are
+> inter-related.  The issues are:
+>
+> - [x] Adding works to a collection [#59][59]
+> - [x] Backporting graph indexing [#68][68]
+> - [x] Adding a collection to another collection [#70][70]
+>
+> [59]: #59
+> [68]: #68
+> [70]: #70
+> [5858]: samvera/hyrax#5858
+> [5916]: samvera/hyrax#5916
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/hyrax-v2_graph_indexer.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/hyrax/v2_graph_indexer/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "hyrax-v2_graph_indexer"
+  spec.version     = Hyrax::V2GraphIndexer::VERSION
+  spec.authors     = ["Jeremy Friesen"]
+  spec.email       = ["jeremy.n.friesen@gmail.com"]
+  spec.homepage    = "https://github.com/scientist-softserv/hyrax-v2_graph_indexer"
+  spec.summary     = "A quasi-backport of the Hyrax 3+ Graph Indexing."
+  spec.description = "A quasi-backport of the Hyrax 3+ Graph Indexing."
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.licenses = ["Apache-2.0"]
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "CHANGELOG.md")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hyrax", "~> 2.9"
+
+  # Instead of requiring all of Rails, let's just require the narrowest aspect of Rails to get this
+  # configuration/integration working.  Besides, Hyrax will bring Rails into this as well.
+  spec.add_dependency "railties"
+end

data/lib/hyrax/v2_graph_indexer/railtie.rb

@@ -0,0 +1,32 @@
+module Hyrax
+  module V2GraphIndexer
+    class Railtie < ::Rails::Railtie
+
+      config.to_prepare do
+        Hyrax::Collections::NestedCollectionPersistenceService.singleton_class.prepend(
+          Hyrax::V2GraphIndexer::NestedCollectionPersistenceServiceDecorator::ClassMethods
+        )
+
+        Hyrax::Forms::Dashboard::NestCollectionForm.prepend(
+          Hyrax::V2GraphIndexer::NestCollectionFormDecorator
+        )
+
+        Hyrax::Collections::NestedCollectionQueryService.singleton_class.prepend(
+          Hyrax::V2GraphIndexer::NestedCollectionQueryServiceDecorator::ClassMethods
+        )
+
+        Hyrax::WorkBehavior.prepend(
+          Hyrax::V2GraphIndexer::CollectionNestingDecorator
+        )
+
+        Hyrax::CollectionBehavior.prepend(
+          Hyrax::V2GraphIndexer::CollectionNestingDecorator
+        )
+
+        Hyrax::Dashboard::NestedCollectionsSearchBuilder.prepend(
+          Hyrax::V2GraphIndexer::NestedCollectionsSearchBuilderDecorator
+        )
+      end
+    end
+  end
+end

data/lib/hyrax/v2_graph_indexer/version.rb

@@ -0,0 +1,5 @@
+module Hyrax
+  module V2GraphIndexer
+    VERSION = "0.1.0"
+  end
+end

data/lib/hyrax/v2_graph_indexer.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "hyrax/v2_graph_indexer/version"
+require "hyrax/v2_graph_indexer/railtie"
+
+module Hyrax
+  # The purpose of this module is to consolidate the decorations necessary to leverage the native
+  # SOLR graph searches.  That native SOLR graph searches replaces the venerable and non-performant
+  # nested indexing.
+  #
+  # These decorations are inspired from the following pull requests:
+  #
+  # - https://github.com/samvera/hyrax/pull/5858/
+  # - https://github.com/samvera/hyrax/pull/5916/
+  #
+  # This `lib` file is intended to stand in the place of minting a 2.9.x release (or 2.10.0
+  # release).  In constructing these changes, I have opted not to backport the configuration.
+  # Meaning, if you include this `lib` file, you are stating that you will use the native SOLR graph
+  # searches.  This simplifies some of the logic; most notably avoiding the conditional include of
+  # the `Hyrax::CollectionNesting` based on a configuration.  Instead we have a module that shadows
+  # the methods introduced in the `Hyrax::CollectionNesting`.
+  module V2GraphIndexer
+    # @note from https://github.com/samvera/hyrax/pull/5916
+    module NestCollectionFormDecorator
+      def nesting_within_maximum_depth
+        true
+      end
+    end
+
+    # @note from https://github.com/samvera/hyrax/pull/5916
+    module NestedCollectionQueryServiceDecorator
+      module ClassMethods
+        def query_solr(collection:, access:, scope:, limit_to_id:, nest_direction:)
+          query_builder = Hyrax::Dashboard::NestedCollectionsSearchBuilder.new(
+            access: access,
+            collection: collection,
+            scope: scope,
+            nesting_attributes: nil,
+            nest_direction: nest_direction
+          )
+
+          query_builder.where(id: limit_to_id.to_s) if limit_to_id
+          query = clean_lucene_error(builder: query_builder)
+          scope.repository.search(query)
+        end
+      end
+    end
+
+    # @note from https://github.com/samvera/hyrax/pull/5858/
+    #
+    # This module is responsible for shadowing the methods of Hyrax::CollectionIndexing; we can't
+    # easily replace the inclusion of that module.  However we can override it's behavior.
+    module CollectionNestingDecorator
+      def before_update_nested_collection_relationship_indices
+        true
+      end
+
+      def after_update_nested_collection_relationship_indices
+        true
+      end
+
+      def update_nested_collection_relationship_indices
+        true
+      end
+
+      def update_child_nested_collection_relationship_indices
+        true
+      end
+
+      def find_children_of(*)
+        true
+      end
+
+      def use_nested_reindexing?
+        true
+      end
+
+      def reindex_extent
+        true
+      end
+
+      def reindex_extent=(val)
+        @reindex_extent = val
+      end
+
+      private
+
+        def reindex_nested_relationships_for(*)
+          true
+        end
+    end
+
+    # @note from https://github.com/samvera/hyrax/pull/5858/ with modifications based on v2.9.6 of
+    #       Hyrax.
+    module NestedCollectionsSearchBuilderDecorator
+      # rubocop:disable Metrics/LineLength
+      def show_only_other_collections_of_the_same_collection_type(solr_parameters)
+        solr_parameters[:fq] ||= []
+        solr_parameters[:fq] += [
+          ActiveFedora::SolrQueryBuilder.construct_query(Collection.collection_type_gid_document_field_name => @collection.collection_type_gid),
+          "-{!graph from=id to=member_of_collection_ids_ssim#{' maxDepth=1' if @nest_direction == :as_parent}}id:#{@collection.id}",
+          "-{!graph to=id from=member_of_collection_ids_ssim#{' maxDepth=1' if @nest_direction == :as_child}}id:#{@collection.id}"
+        ]
+      end
+      # rubocop:enable Metrics/LineLength
+    end
+
+    module NestedCollectionPersistenceServiceDecorator
+      # These overrides are needed because nothing in the 2.9.x implementation was explicitly
+      # **saving** the collection membership changes; they were being indexed but not saved.  It's
+      # possible the indexing service was saving the objects.
+      module ClassMethods
+        def persist_nested_collection_for(parent:, child:)
+          child.member_of_collections.push(parent)
+          child.save
+        end
+
+        def remove_nested_relationship_for(parent:, child:)
+          child.member_of_collections.delete(parent)
+          child.save
+          true
+        end
+      end
+    end
+  end
+end

data/lib/tasks/hyrax/v2_graph_indexer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hyrax_v2_graph_indexer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: hyrax-v2_graph_indexer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyrax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A quasi-backport of the Hyrax 3+ Graph Indexing.
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hyrax-v2_graph_indexer.gemspec
+- lib/hyrax/v2_graph_indexer.rb
+- lib/hyrax/v2_graph_indexer/railtie.rb
+- lib/hyrax/v2_graph_indexer/version.rb
+- lib/tasks/hyrax/v2_graph_indexer_tasks.rake
+homepage: https://github.com/scientist-softserv/hyrax-v2_graph_indexer
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/scientist-softserv/hyrax-v2_graph_indexer
+  source_code_uri: https://github.com/scientist-softserv/hyrax-v2_graph_indexer
+  changelog_uri: https://github.com/scientist-softserv/hyrax-v2_graph_indexer/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A quasi-backport of the Hyrax 3+ Graph Indexing.
+test_files: []