dog_biscuits 0.4.0

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class Project < Authority
+    include DogBiscuits::FoafName
+    include DogBiscuits::GenericAuthorityTerms
+    include DogBiscuits::Identifier
+    include DogBiscuits::Funder
+
+    type [::RDF::URI.new('http://xmlns.com/foaf/0.1/Project')]
+
+    def agent?
+      false
+    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?
+      true
+    end
+
+    # Generate a rdfs label from the name parts. Overwrite the existing label.
+    def add_label
+      self.rdfs_label = name if name.present?
+      self.rdfs_label += " (id: #{identifier.join})" if identifier.present?
+      add_preflabel
+    end
+
+    # Generate a preflabel from rdfs label.
+    def add_preflabel
+      self.preflabel = rdfs_label
+    end
+  end
+end

data/lib/dog_biscuits/models/authority.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # All authority classes inherit from this.
+  class Authority < ActiveFedora::Base
+    include DogBiscuits::CommonLabels
+    include DogBiscuits::SkosNote
+    include DogBiscuits::ValidateLabel
+
+    before_save :add_label
+
+    belongs_to :concept_scheme,
+               class_name: 'DogBiscuits::ConceptScheme',
+               predicate: ::RDF::Vocab::SKOS.inScheme
+
+    def authority?
+      true
+    end
+
+    def work?
+      false
+    end
+
+    def file_set?
+      false
+    end
+
+    def collection?
+      false
+    end
+
+    def edit_groups
+      ['admin']
+    end
+
+    # Ensure rdfs label and pref label and the same. Prefer preflabel.
+    def add_label
+      self.rdfs_label = preflabel if preflabel.present?
+      self.preflabel = rdfs_label if rdfs_label.present?
+    end
+  end
+end

data/lib/dog_biscuits/models/collections/collection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  class Collection < ActiveFedora::Base
+    include ::Hyrax::CollectionBehavior
+    include DogBiscuits::CommonMetadata
+
+    def authority?
+      false
+    end
+
+    def agent?
+      false
+    end
+
+    def work?
+      false
+    end
+
+    def file_set?
+      false
+    end
+
+    def collection?
+      true
+    end
+
+    def self.indexer
+      CollectionIndexer
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/pure_specific_behaviour.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # Behaviour only used where data is being pulled in from the PURE CRIS system.
+  module PureSpecificBehaviour
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :add_pure_type
+
+      def add_pure_type
+        rdf_type << DogBiscuits::Vocab::PureTerms.Organisation unless pure_uuid.nil? && organisation?
+        rdf_type << DogBiscuits::Vocab::PureTerms.Person unless pure_uuid.nil? && person?
+      end
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/validate_concept_related.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # Validate see also references.
+  module ValidateConceptRelated
+    extend ActiveSupport::Concern
+
+    included do
+      validates_with DogBiscuits::ConceptRelatedValidator
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/validate_concept_scheme.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # Validates members of a concept scheme.
+  module ValidateConceptScheme
+    extend ActiveSupport::Concern
+
+    included do
+      def self.type_validator
+        Hydra::PCDM::Validators::CompositeValidator.new(
+          DogBiscuits::ConceptSchemeMemberValidator
+        )
+      end
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/validate_label.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # Validate labels.
+  module ValidateLabel
+    extend ActiveSupport::Concern
+
+    included do
+      validates_with DogBiscuits::LabelValidator
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/validate_place.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  # Validate place name.
+  module ValidatePlace
+    extend ActiveSupport::Concern
+
+    included do
+      validates_with DogBiscuits::PlaceValidator
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/behaviours/work_behaviour.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  module WorkBehaviour
+    extend ActiveSupport::Concern
+
+    # In order to be used, the work classes require various 'Behaviors' from Hyrax
+    # In Hyrax, this is included like so:
+    #     include Hyrax::WorkBehavior
+
+    # When using these models within a Hyrax application, the WorkBehavior mixin is added to the model
+    # We can also include it here, but that means 'double-loading'
+    # Also, Hyrax::NestedWorks is one of the mixins included in WorkBehavior and this will cause an error:
+    #   RuntimeError: Circular dependency detected in calling app
+
+    # The approach taken is *not* to include behavior within DogBiscuits, but instead leave it to the calling Hyrax
+    # application to do so.
+
+    # For spec tests, these are performed on the generated model in Hyrax *not* on the DogBiscuits model
+  end
+end

data/lib/dog_biscuits/models/concerns/extended_solr_document.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  module ExtendedSolrDocument
+    extend ActiveSupport::Concern
+
+    # Duplicated from https://github.com/samvera/hyrax/blob/master/app/models/concerns/hyrax/solr_document/metadata.rb
+
+    class_methods do
+      def attribute(name, type, field)
+        define_method name do
+          type.coerce(self[field])
+        end
+      end
+
+      def solr_name(*args)
+        ActiveFedora.index_field_mapper.solr_name(*args)
+      end
+    end
+
+    module Solr
+      class Array
+        # @return [Array]
+        def self.coerce(input)
+          ::Array.wrap(input)
+        end
+      end
+
+      class String
+        # @return [String]
+        def self.coerce(input)
+          ::Array.wrap(input).first
+        end
+      end
+
+      class Date
+        # @return [Date]
+        def self.coerce(input)
+          field = String.coerce(input)
+          return if field.blank?
+          begin
+            ::Date.parse(field)
+          rescue ArgumentError
+            Rails.logger.info "Unable to parse date: #{field.first.inspect}"
+          end
+        end
+      end
+    end
+
+    # Keep these alphebetized; comments indicate those in basic_metadata
+    #   see https://github.com/samvera/hyrax/blob/master/app/models/concerns/hyrax/solr_document/metadata.rb
+    included do
+      attribute :abstract, Solr::Array, solr_name('abstract')
+      attribute :access_provided_by, Solr::Array, solr_name('access_provided_by')
+      attribute :advisor, Solr::Array, solr_name('advisor')
+      attribute :alt, Solr::Array, solr_name('alt')
+      attribute :awarding_institution, Solr::Array, solr_name('awarding_institution')
+      # based_near and based_near
+      attribute :content_version, Solr::Array, solr_name('content_version')
+      # contributor
+      # creator
+      attribute :date, Solr::Array, solr_name('date')
+      attribute :date_accepted, Solr::Array, solr_name('date_accepted')
+      attribute :date_available, Solr::Array, solr_name('date_available')
+      attribute :date_collected, Solr::Array, solr_name('date_collected')
+      attribute :date_copyrighted, Solr::Array, solr_name('date_copyrighted')
+      attribute :date_issued, Solr::Array, solr_name('date_issued')
+      # date_created
+      attribute :date_of_award, Solr::Array, solr_name('date_of_award')
+      attribute :date_published, Solr::Array, solr_name('date_published')
+      attribute :date_submitted, Solr::Array, solr_name('date_submitted')
+      attribute :date_updated, Solr::Array, solr_name('date_updated')
+      attribute :date_valid, Solr::Array, solr_name('date_valid')
+      attribute :dc_access_rights, Solr::Array, solr_name('dc_access_rights')
+      attribute :department, Solr::Array, solr_name('department')
+      # description
+      attribute :doi, Solr::Array, solr_name('doi')
+      attribute :edition, Solr::Array, solr_name('edition')
+      attribute :editor, Solr::Array, solr_name('editor')
+      attribute :end_date, Solr::Array, solr_name('end_date')
+      attribute :event_date, Solr::Array, solr_name('event_date')
+      attribute :extent, Solr::Array, solr_name('extent')
+      attribute :dc_format, Solr::Array, solr_name('dc_format')
+      attribute :former_identifier, Solr::Array, solr_name('former_identifier')
+      attribute :funder, Solr::Array, solr_name('funder')
+      attribute :resource_type_general, Solr::Array, solr_name('resource_type_general')
+      attribute :has_restriction, Solr::Array, solr_name('has_restriction')
+      # rubocop:enable Naming/PredicateName
+
+      # identifier
+      attribute :isbn, Solr::Array, solr_name('isbn')
+      attribute :issue_number, Solr::Array, solr_name('issue_number')
+      # keyword
+      # language
+      attribute :last_access, Solr::Array, solr_name('last_access')
+      attribute :lat, Solr::Array, solr_name('lat')
+      # license
+      attribute :location, Solr::Array, solr_name('location')
+      attribute :long, Solr::Array, solr_name('long')
+      attribute :managing_organisation, Solr::Array, solr_name('managing_organisation')
+      attribute :module_code, Solr::Array, solr_name('module_code')
+      attribute :note, Solr::Array, solr_name('note')
+      attribute :number_of_downloads, Solr::Array, solr_name('last_access')
+      attribute :official_url, Solr::Array, solr_name('official_url')
+      attribute :output_of, Solr::Array, solr_name('output_of')
+      attribute :official_url, Solr::Array, solr_name('official_url')
+      attribute :packaged_by_ids, Solr::Array, solr_name('packaged_by_ids', :symbol)
+      attribute :package_ids, Solr::Array, solr_name('package_ids', :symbol)
+      attribute :pagination, Solr::Array, solr_name('pagination')
+      attribute :part, Solr::Array, solr_name('part')
+      attribute :place_of_publication, Solr::Array, solr_name('place_of_publication')
+      attribute :presented_at, Solr::Array, solr_name('presented_at')
+      attribute :part_of, Solr::Array, solr_name('part_of')
+      attribute :project, Solr::Array, solr_name('project')
+      attribute :publication_status, Solr::Array, solr_name('publication_status')
+      # publisher
+      attribute :qualification_level, Solr::Array, solr_name('qualification_level')
+      attribute :qualification_name, Solr::Array, solr_name('qualification_name')
+      attribute :refereed, Solr::Array, solr_name('refereed')
+      attribute :related_url, Solr::Array, solr_name('related_url')
+      # resource_type
+      # rights_statement
+      attribute :series, Solr::Array, solr_name('series')
+      # source
+      attribute :start_date, Solr::Array, solr_name('start_date')
+      # subject
+      attribute :subtitle, Solr::Array, solr_name('subtitle')
+      attribute :volume_number, Solr::Array, solr_name('volume_number')
+      # archivematica
+      attribute :aip_uuid, Solr::Array, solr_name('aip_uuid')
+      attribute :transfer_uuid, Solr::Array, solr_name('transfer_uuid')
+      attribute :sip_uuid, Solr::Array, solr_name('sip_uuid')
+      attribute :dip_uuid, Solr::Array, solr_name('dip_uuid')
+      attribute :aip_status, Solr::Array, solr_name('aip_status')
+      attribute :dip_status, Solr::Array, solr_name('dip_status')
+      attribute :aip_size, Solr::Array, solr_name('aip_size')
+      attribute :dip_size, Solr::Array, solr_name('dip_size')
+      attribute :aip_current_path, Solr::Array, solr_name('aip_current_path')
+      attribute :dip_current_path, Solr::Array, solr_name('dip_current_path')
+      attribute :aip_current_location, Solr::Array, solr_name('aip_current_location')
+      attribute :dip_current_location, Solr::Array, solr_name('dip_current_location')
+      attribute :aip_resource_uri, Solr::Array, solr_name('aip_resource_uri')
+      attribute :dip_resource_uri, Solr::Array, solr_name('dip_resource_uri')
+      attribute :origin_pipeline, Solr::Array, solr_name('origin_pipeline')
+    end
+  end
+end

data/lib/dog_biscuits/models/concerns/metadata_properties/archivematica/archivematica.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module DogBiscuits
+  module Archivematica
+    extend ActiveSupport::Concern
+
+    included do
+      property :aip_uuid,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.aipUuid do |index|
+        index.as :stored_searchable
+      end
+      property :transfer_uuid,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.transferUuid do |index|
+        index.as :stored_searchable
+      end
+      property :sip_uuid,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.sipUuid do |index|
+        index.as :stored_searchable
+      end
+      property :dip_uuid,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.dipUuid do |index|
+        index.as :stored_searchable
+      end
+      property :aip_status,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.aipStatus do |index|
+        index.as :stored_searchable
+      end
+      property :dip_status,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.dipStatus do |index|
+        index.as :stored_searchable
+      end
+      property :aip_size,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.aipSize do |index|
+        index.as :stored_searchable
+      end
+      property :dip_size,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.dipSize do |index|
+        index.as :stored_searchable
+      end
+      property :aip_current_path,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.aipCurrentPath do |index|
+        index.as :stored_searchable
+      end
+      property :dip_current_path,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.dipCurrentPath do |index|
+        index.as :stored_searchable
+      end
+      property :aip_current_location,
+               predicate:
+                   DogBiscuits::Vocab::OaisArchivematica.aipCurrentLocation do |index|
+        index.as :stored_searchable
+      end
+      property :dip_current_location,
+               predicate:
+                   DogBiscuits::Vocab::OaisArchivematica.dipCurrentLocation do |index|
+        index.as :stored_searchable
+      end
+      property :aip_resource_uri,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.aipResourceUri do |index|
+        index.as :stored_searchable
+      end
+      property :dip_resource_uri,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.dipResourceUri do |index|
+        index.as :stored_searchable
+      end
+      # This will always be the same for both AIP and DIP
+      property :origin_pipeline,
+               predicate: DogBiscuits::Vocab::OaisArchivematica.originPipeline do |index|
+        index.as :stored_searchable
+      end
+    end
+  end
+end