dor_indexing 1.0.0

data/lib/dor_indexing/workflow_solr_document.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+class DorIndexing
+  # Represents that part of the solr document that holds workflow data
+  class WorkflowSolrDocument
+    WORKFLOW_SOLR = 'wf_ssim'
+    # field that indexes workflow name, process status then process name
+    WORKFLOW_WPS_SOLR = 'wf_wps_ssim'
+    # field that indexes workflow name, process name then process status
+    WORKFLOW_WSP_SOLR = 'wf_wsp_ssim'
+    # field that indexes process status, workflowname then process name
+    WORKFLOW_SWP_SOLR = 'wf_swp_ssim'
+    WORKFLOW_ERROR_SOLR = 'wf_error_ssim'
+    WORKFLOW_STATUS_SOLR = 'workflow_status_ssim'
+
+    KEYS_TO_MERGE = [
+      WORKFLOW_SOLR,
+      WORKFLOW_WPS_SOLR,
+      WORKFLOW_WSP_SOLR,
+      WORKFLOW_SWP_SOLR,
+      WORKFLOW_STATUS_SOLR,
+      WORKFLOW_ERROR_SOLR
+    ].freeze
+
+    def initialize
+      @data = empty_document
+      yield self if block_given?
+    end
+
+    def name=(wf_name)
+      data[WORKFLOW_SOLR] += [wf_name]
+      data[WORKFLOW_WPS_SOLR] += [wf_name]
+      data[WORKFLOW_WSP_SOLR] += [wf_name]
+    end
+
+    def status=(status)
+      data[WORKFLOW_STATUS_SOLR] += [status]
+    end
+
+    def error=(message)
+      data[WORKFLOW_ERROR_SOLR] += [message]
+    end
+
+    # Add to the field that indexes workflow name, process status then process name
+    def add_wps(*messages)
+      data[WORKFLOW_WPS_SOLR] += messages
+    end
+
+    # Add to the field that indexes workflow name, process name then process status
+    def add_wsp(*messages)
+      data[WORKFLOW_WSP_SOLR] += messages
+    end
+
+    # Add to the field that indexes process status, workflow name then process name
+    def add_swp(*messages)
+      data[WORKFLOW_SWP_SOLR] += messages
+    end
+
+    # Add the processes data_time attribute to the solr document
+    # @param [String] wf_name
+    # @param [String] process_name
+    # @param [Time] time
+    def add_process_time(wf_name, process_name, time)
+      data["wf_#{wf_name}_#{process_name}_dttsi"] = time.utc.iso8601
+    end
+
+    def to_h
+      KEYS_TO_MERGE.each { |k| data[k].uniq! }
+      data
+    end
+
+    delegate :except, :[], to: :data
+
+    # @param [WorkflowSolrDocument] doc
+    def merge!(doc)
+      # This is going to get the date fields, e.g. `wf_assemblyWF_jp2-create_dttsi'
+      @data.merge!(doc.except(*KEYS_TO_MERGE))
+
+      # Combine the non-unique fields together
+      KEYS_TO_MERGE.each do |k|
+        data[k] += doc[k]
+      end
+    end
+
+    private
+
+    attr_reader :data
+
+    def empty_document
+      KEYS_TO_MERGE.index_with { |_k| [] }
+    end
+  end
+end

data/lib/dor_indexing.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'stanford-mods'
+require 'cocina/models'
+require 'solrizer'
+require 'marc/vocab'
+require 'honeybadger'
+
+Zeitwerk::Loader.for_gem.setup
+
+# Builds solr documents for indexing.
+class DorIndexing
+  # @return [Hash] the solr document
+  def self.build(cocina_with_metadata:, workflow_client:, cocina_repository:)
+    Honeybadger.context({ identifier: cocina_with_metadata.externalIdentifier })
+    DorIndexing::Builders::DocumentBuilder.for(model: cocina_with_metadata, workflow_client:, cocina_repository:).to_solr
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: dor_indexing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Littman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocina-models
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  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'
+- !ruby/object:Gem::Dependency
+  name: marc-vocab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: solrizer
+  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'
+- !ruby/object:Gem::Dependency
+  name: stanford-mods
+  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'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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: Library for creating Solr documents for SDR indexing.
+email:
+- justinlittman@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- dor_indexing.gemspec
+- lib/dor_indexing.rb
+- lib/dor_indexing/builders/all_search_text_builder.rb
+- lib/dor_indexing/builders/author_builder.rb
+- lib/dor_indexing/builders/collection_rights_description_builder.rb
+- lib/dor_indexing/builders/document_builder.rb
+- lib/dor_indexing/builders/event_date_builder.rb
+- lib/dor_indexing/builders/event_place_builder.rb
+- lib/dor_indexing/builders/geographic_builder.rb
+- lib/dor_indexing/builders/name_builder.rb
+- lib/dor_indexing/builders/orcid_builder.rb
+- lib/dor_indexing/builders/publisher_name_builder.rb
+- lib/dor_indexing/builders/temporal_builder.rb
+- lib/dor_indexing/builders/topic_builder.rb
+- lib/dor_indexing/cocina_repository.rb
+- lib/dor_indexing/indexers/administrative_tag_indexer.rb
+- lib/dor_indexing/indexers/collection_title_indexer.rb
+- lib/dor_indexing/indexers/composite_indexer.rb
+- lib/dor_indexing/indexers/content_metadata_indexer.rb
+- lib/dor_indexing/indexers/data_indexer.rb
+- lib/dor_indexing/indexers/default_object_rights_indexer.rb
+- lib/dor_indexing/indexers/descriptive_metadata_indexer.rb
+- lib/dor_indexing/indexers/embargo_metadata_indexer.rb
+- lib/dor_indexing/indexers/identifiable_indexer.rb
+- lib/dor_indexing/indexers/identity_metadata_indexer.rb
+- lib/dor_indexing/indexers/process_indexer.rb
+- lib/dor_indexing/indexers/releasable_indexer.rb
+- lib/dor_indexing/indexers/rights_metadata_indexer.rb
+- lib/dor_indexing/indexers/role_metadata_indexer.rb
+- lib/dor_indexing/indexers/workflow_indexer.rb
+- lib/dor_indexing/indexers/workflows_indexer.rb
+- lib/dor_indexing/marc_country.rb
+- lib/dor_indexing/selectors/event_selector.rb
+- lib/dor_indexing/selectors/pub_year_selector.rb
+- lib/dor_indexing/version.rb
+- lib/dor_indexing/workflow_fields.rb
+- lib/dor_indexing/workflow_solr_document.rb
+homepage: https://github.com/sul-dlss/dor_indexing
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss/dor_indexing
+  source_code_uri: https://github.com/sul-dlss/dor_indexing
+  changelog_uri: https://github.com/sul-dlss/folio_client/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Library for creating Solr documents for SDR indexing.
+test_files: []