dog_biscuits 0.4.0

data/lib/dog_biscuits/importers/authority.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  module Importers
+    class Authority
+      attr_reader :authority
+      attr_reader :authority_name
+
+      def initialize(authority_name)
+        @authority_name = authority_name
+        @authority = Qa::LocalAuthority.find_or_create_by(name: authority_name) if valid_authority?
+      end
+
+      def valid_authority?
+        true if Qa::Authorities::Local.subauthority_for(@authority_name)
+      rescue Qa::InvalidSubAuthority
+        Rails.logger.error("This sub-authority is not registered: #{@authority_name}")
+        false
+      end
+
+      # Create an authority record in the given local authority
+      #
+      # @param label [String] the label
+      # @param uri [String] the uri, optional
+      def create_record(label, uri = nil)
+        uri = construct_uri(label) if uri.blank?
+        Qa::LocalAuthorityEntry.create(local_authority: @authority,
+                                       label: cleanup_label(label),
+                                       uri: uri)
+      rescue ActiveRecord::RecordNotUnique
+        Rails.logger.warn("Duplicate record: #{label}")
+      end
+
+      private
+
+        # Replace & with &
+        #
+        # @param label [String] the label for cleanup
+        # @return [String] cleaned up label
+        def cleanup_label(label)
+          label.gsub('&', '&')
+        end
+
+        # Create a version of the label for use as a uri:
+        #   replace all non-alphanumeric characters with whitespace
+        #   trim to 50 characters and replace whitespace with a dash
+        #
+        # @param label [String] the label for uri-ification
+        # @return [String] uri-ified label
+        def uri_ifiy_label(label)
+          cleanup_label(label).gsub(/[^\w\s\d]/, ' ')[0..50].parameterize
+        end
+
+        # Create a default URI for the term
+        #
+        # @param label [String] the label for cleanup
+        # @return [String] cleaned up label
+        def construct_uri(label)
+          hostname = `hostname`.delete("\n")
+          hostname = "example.com" if hostname.include?('localhost')
+          "http://#{hostname}/#{@authority_name}/#{uri_ifiy_label(label)}"
+        end
+    end
+  end
+end

data/lib/dog_biscuits/indexers/collection_indexer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class CollectionIndexer < Hyrax::CollectionIndexer
+    include DogBiscuits::IndexesCommon
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/indexers/concerns/indexes_common.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  module IndexesCommon
+    def generate_solr_document
+      super.tap do |solr_doc|
+        solr_doc_for_contributors(solr_doc)
+        solr_doc_for_dates(solr_doc)
+        do_local_indexing(solr_doc)
+      end
+    end
+
+    # rubocop:disable Style/GuardClause
+
+    # Index different contributor types (relators, eg. editor, advisor) into contributor
+    # Index the contributor type itself
+    def solr_doc_for_contributors(solr_doc)
+      if respond_to? :contributors_to_index
+        contributors_to_index.each do |v|
+          labels = object.send(v).to_a
+          # If there is anything in the solr_doc, add to it
+          if solr_doc["contributor_combined_tesim"]
+            solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_combined", :stored_searchable)].push(*labels).uniq!
+            solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_combined", :facetable)].push(*labels).uniq!
+          else
+            solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_combined", :stored_searchable)] = labels
+            solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_combined", :facetable)] = labels
+          end
+          labels.each do |_label|
+            if solr_doc['contributor_type_sim']
+              solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_type", :facetable)] << v
+            else
+              solr_doc[ActiveFedora.index_field_mapper.solr_name("contributor_type", :facetable)] = [v]
+            end
+          end
+        end
+      end
+    end
+
+    # Extract years from all date fields and index into 'date_range_sim'
+    def solr_doc_for_dates(solr_doc)
+      DogBiscuits.config.date_properties.each do |d|
+        next unless object.respond_to? d
+        object.send(d).each do |dd|
+          dd.to_s.scan(/\b\d{4}\b/).each do |year|
+            if solr_doc['date_range_sim']
+              solr_doc['date_range_sim'] << year.to_i
+            else
+              solr_doc['date_range_sim'] = [year.to_i]
+            end
+          end
+        end
+      end
+    end
+
+    # rubocop:enable Style/GuardClause
+  end
+end

data/lib/dog_biscuits/indexers/conference_item_indexer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class ConferenceItemIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    # NB. include 'contributor' here if it is used in the form
+    def contributors_to_index
+      ['editor', 'funder']
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    #
+    # @param [Hash] solr_doc
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/indexers/dataset_indexer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class DatasetIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    def contributors_to_index
+      ['funder']
+    end
+
+    # Force the type of certain indexed fields in solr
+    # (inspired by
+    #   http://projecthydra.github.io/training/deeper_into_hydra/#slide-63,
+    #   http://projecthydra.github.io/training/deeper_into_hydra/#slide-64
+    #   and discussed at
+    #   https://groups.google.com/forum/#!topic/hydra-tech/rRsBwdvh5dE)
+    # This is to overcome limitations with solrizer and
+    #   "index.as :stored_sortable" always defaulting to string rather
+    #   than text type (solr sorting on string fields is case-sensitive,
+    #   on text fields it's case-insensitive)
+    def do_local_indexing(solr_doc)
+      solr_doc['dc_access_rights_tesi'] = object.dc_access_rights.collect { |x| x }
+    end
+  end
+end

data/lib/dog_biscuits/indexers/digital_archival_object_indexer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class DigitalArchivalObjectIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    def contributors_to_index
+      []
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    #
+    # @param [Hash] solr_doc
+    def do_local_indexing(solr_doc)
+      solr_doc['packaged_by_ids_ssim'] = object.packaged_by.map(&:id)
+      solr_doc['packaged_by_titles_sim'] = object.packaged_by.map(&:first_title)
+    end
+  end
+end

data/lib/dog_biscuits/indexers/exam_paper_indexer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class ExamPaperIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/indexers/journal_article_indexer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class JournalArticleIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    # Add any properties to ensure they are 'mixed in' with the *_labels field in solr
+    def contributors_to_index
+      ['funder']
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/indexers/package_indexer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class PackageIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    # NB. include 'contributor' here if it is used in the form
+    def contributors_to_index
+      []
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    #
+    # @param [Hash] solr_doc
+    def do_local_indexing(solr_doc)
+      solr_doc['package_ids_ssim'] = object.packages.map(&:id)
+    end
+  end
+end

data/lib/dog_biscuits/indexers/published_work_indexer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class PublishedWorkIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    def contributors_to_index
+      ['editor', 'funder']
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    #
+    # @param [Hash] solr_doc
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/indexers/thesis_indexer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class ThesisIndexer < Hyrax::WorkIndexer
+    include DogBiscuits::IndexesCommon
+
+    def contributors_to_index
+      ['advisor', 'funder']
+    end
+
+    # Add any custom indexing into here. Method must exist, but can be empty.
+    #
+    # @param [Hash] solr_doc
+    def do_local_indexing(solr_doc); end
+  end
+end

data/lib/dog_biscuits/models/authorities/agent.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # People, Groups and Organisations inherit from this.
+  class Agent < Authority
+    # HyBox
+    include DogBiscuits::AlternateName
+    include DogBiscuits::Description
+    include DogBiscuits::FoafName
+    include DogBiscuits::IdentifiedBy
+    # Additional
+    include DogBiscuits::GenericAuthorityTerms
+    include DogBiscuits::RelatedAuthority
+    include DogBiscuits::OwlSameAs
+
+    type [::RDF::Vocab::FOAF.Agent]
+
+    property :email, predicate: ::RDF::Vocab::FOAF.mbox do |index|
+      index.as :stored_searchable
+    end
+
+    # value should be foaf:OnlineAccount
+    property :account, predicate: ::RDF::Vocab::FOAF.account do |index|
+      index.as :stored_searchable
+    end
+
+    property :homepage, predicate: ::RDF::Vocab::FOAF.homepage do |index|
+      index.as :stored_searchable
+    end
+
+    def agent?
+      true
+    end
+
+    def concept?
+      false
+    end
+
+    def concept_scheme?
+      false
+    end
+
+    def event?
+      false
+    end
+
+    def group?
+      false
+    end
+
+    def organisation?
+      false
+    end
+
+    def person?
+      false
+    end
+
+    def place?
+      false
+    end
+
+    def project?
+      false
+    end
+
+    # Generate a rdfs label from the name parts. Overwrite the existing label.
+    def add_label
+      self.rdfs_label = name if name.present?
+      add_preflabel
+    end
+
+    # Generate a preflabel from rdfs label.
+    def add_preflabel
+      self.preflabel = rdfs_label if rdfs_label.present?
+    end
+  end
+end

data/lib/dog_biscuits/models/authorities/agents/group.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class Group < DogBiscuits::Agent
+    # Additional
+    include DogBiscuits::GenericQualifier
+    include DogBiscuits::HubDates
+
+    type [::RDF::Vocab::FOAF.Agent,
+          ::RDF::Vocab::FOAF.Group]
+
+    property :group_type, predicate: DogBiscuits::Vocab::Generic.groupType do |index|
+      index.as :stored_searchable
+    end
+
+    property :foaf_member, predicate: ::RDF::Vocab::FOAF.member do |index|
+      index.as :stored_searchable
+    end
+
+    def concept?
+      false
+    end
+
+    def concept_scheme?
+      false
+    end
+
+    def group?
+      true
+    end
+
+    def organisation?
+      false
+    end
+
+    def person?
+      false
+    end
+
+    def place?
+      false
+    end
+
+    def project?
+      false
+    end
+
+    # Generate a rdfs label from the name parts. Overwrite the existing label.
+    def add_label
+      label = ''
+      label += ", #{name}" if name.present?
+      label += ", #{dates}" if dates.present?
+      label += ", #{qualifier}" if qualifier.present?
+      label = label.sub(', ', '') if label.starts_with? ', '
+      self.rdfs_label = label if label.present?
+      add_preflabel
+    end
+  end
+end

data/lib/dog_biscuits/models/authorities/agents/historic_person.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class HistoricPerson < DogBiscuits::Person
+    before_save :add_label
+
+    type [::RDF::Vocab::FOAF.Agent,
+          ::RDF::Vocab::FOAF.Person,
+          DogBiscuits::Vocab::BorthwickRegisters.HistoricPerson]
+
+    # Eg. NCA Rules 2.5C.
+    property :pre_title, predicate: DogBiscuits::Vocab::Generic.preTitle,
+                         multiple: false do |index|
+      index.as :stored_searchable
+    end
+
+    # Eg. NCA Rules 2.5B.
+    property :post_title,
+             predicate: ::RDF::URI.new('http://data.archiveshub.ac.uk/def/title'),
+             multiple: false do |index|
+      index.as :stored_searchable
+    end
+
+    # Eg. NCA Rules 2.5D.
+    property :epithet,
+             predicate: ::RDF::URI.new('http://data.archiveshub.ac.uk/def/epithet'),
+             multiple: false do |index|
+      index.as :stored_searchable
+    end
+
+    property :dates_of_office,
+             predicate: DogBiscuits::Vocab::Generic.datesOfOffice,
+             multiple: false do |index|
+      index.as :stored_searchable
+    end
+
+    def historic_person?
+      true
+    end
+
+    # Generate a rdfs label from the name parts. Overwrite the existing label.
+    def add_label
+      label = ''
+      label += ", #{family_name}" if family_name.present?
+      label += ", #{pre_title}" if pre_title.present?
+      label += ", #{given_name}" if given_name.present?
+      label += ", #{dates}" if dates.present?
+      label += ", #{post_title}" if post_title.present?
+      label += ", #{epithet}" if epithet.present?
+      label = label.sub(', ', '') if label.starts_with? ', '
+      self.rdfs_label = label
+      add_preflabel
+    end
+  end
+end