ddr-core 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5680472d74a8c3238ef7988d603d3379e9c48414bc434004623260fcd09a80d
+  data.tar.gz: c9dd0599607565c5ff2f28e9cff4eddad8423e08e8754f86002cc1e68b8d4e01
+SHA512:
+  metadata.gz: a1a2b035ba49e258cb2f79bb03df468f9ddb0e497bcc7fec429354487e70426e93f9b2396b1a6ff9c82f25c719520aea155cab6afb7bcec88626e8fdd099ee81
+  data.tar.gz: 46a32800615641b070023fd05ad6884294a717e5638d0a747e3f74320e2d3507f9a4d9fd8cfdcd31806c125ca0a342d889c19749f30b9c14b5fe2899c3929279

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2019, Duke University
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,27 @@
+# Ddr::Core
+
+A port of ddr-models based on Valkyrie.
+
+## Using the docker stack
+
+Install docker (Docker for Mac includes all the required components).
+
+Start the stack:
+
+    $ docker-compose up -d --build
+
+To run a Bash shell on the app server:
+
+    $ docker-compose run --rm app bash
+
+To connect to the development database:
+
+    $ docker-compose run --rm app psql -U postgres -h db -d ddr_core_development
+
+To run the test suite:
+
+    $ docker-compose run --rm -e RAILS_ENV=test app bundle exec rake spec
+
+Stop the stack:
+
+    $ docker-compose down

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ddr::Core'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+# Wrap in 'rescue' clause based on recommendation at https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/app/controllers/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,11 @@
+require "devise/omniauth_callbacks_controller"
+
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  def shibboleth
+    user = resource_class.from_omniauth(request.env["omniauth.auth"])
+    set_flash_message :notice, :success, kind: "Duke NetID"
+    sign_in_and_redirect user
+  end
+
+end

data/app/controllers/users/sessions_controller.rb

@@ -0,0 +1,15 @@
+require 'devise'
+
+class Users::SessionsController < Devise::SessionsController
+
+  def new
+    store_location_for(:user, request.referrer)
+    if Ddr::Auth.require_shib_user_authn
+      flash.discard(:alert)
+      redirect_to user_shibboleth_omniauth_authorize_path
+    else
+      super
+    end
+  end
+
+end

data/app/models/concerns/ddr/captionable.rb

@@ -0,0 +1,25 @@
+module Ddr
+  module Captionable
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :caption, Ddr::File.optional
+    end
+
+    def caption_type
+      caption&.media_type
+    end
+
+    # This method is used in dul-hydra 'ComponentsController' and ddr-public 'CaptionsController'
+    def caption_extension
+      if filename = caption&.original_filename
+        ::File.extname(filename)
+      end
+    end
+
+    def caption_path
+      caption&.file&.disk_path
+    end
+
+  end
+end

data/app/models/concerns/ddr/describable.rb

@@ -0,0 +1,108 @@
+module Ddr
+  module Describable
+    extend ActiveSupport::Concern
+
+    def self.term_names
+      term_names = []
+      vocabularies.each do |vocab|
+        Ddr::Vocab::Vocabulary.property_terms(vocab).each do |term|
+          term_name = Ddr::Vocab::Vocabulary.term_name(vocab, term)
+          unless term_name == :license
+            term_names << term_name
+          end
+        end
+      end
+      term_names
+    end
+
+    def self.vocabularies
+      [RDF::Vocab::DC, Ddr::Vocab::DukeTerms].freeze
+    end
+
+    def self.indexers
+      # Add term_name => [indexers] mapping to customize indexing
+      {}
+    end
+
+    def self.default_indexers
+      [:stored_searchable]
+    end
+
+    def self.indexers_for(term_name)
+      indexers.fetch(term_name, default_indexers)
+    end
+
+    included do
+      Ddr::Describable.term_names.each do |term_name|
+        attribute term_name, Valkyrie::Types::Set
+      end
+    end
+
+    # Used in dul-hydra view
+    def has_desc_metadata?
+      desc_metadata_terms(:present).present?
+    end
+
+    # Used in dul-hydra
+    ######################
+    # Commenting out the :required argument since validation is not a model concern in the Valkyrie paradigm.
+    # This will break the `desc_metadata_form_fields` helper in dul-hydra and we'll have to fix it there eventually.
+    ######################
+    def desc_metadata_terms *args
+      return Ddr::Describable.term_names if args.empty?
+      arg = args.pop
+      terms = case arg.to_sym
+              when :empty
+                desc_metadata_terms.select { |t| values(t).empty? }
+              when :present
+                desc_metadata_terms.select { |t| values(t).present? }
+              when :defined_attributes
+                desc_metadata_terms
+              # when :required
+              #   desc_metadata_terms(:defined_attributes).select {|t| required? t}
+              when :dcterms
+                Ddr::Vocab::Vocabulary.term_names(RDF::Vocab::DC11) +
+                    (Ddr::Vocab::Vocabulary.term_names(RDF::Vocab::DC) - Ddr::Vocab::Vocabulary.term_names(RDF::Vocab::DC11))
+              when :dcterms_elements11
+                Ddr::Vocab::Vocabulary.term_names(RDF::Vocab::DC11)
+              when :duke
+                Ddr::Vocab::Vocabulary.term_names(Ddr::Vocab::DukeTerms)
+              else
+                raise ArgumentError, "Invalid argument: #{arg.inspect}"
+              end
+      if args.empty?
+        terms
+      else
+        terms | desc_metadata_terms(*args)
+      end
+    end
+
+    # Used in dul-hydra helper -- replace there with Ddr::Describable.vocabularies?
+    def desc_metadata_vocabs
+      Ddr::Describable.vocabularies
+    end
+
+    # Used here and in indexing spec test but can probably be replaced with just .set_value(term, values)
+    def set_desc_metadata_values term, values
+      set_value term, values
+    end
+
+    # Used in dul-hydra
+    # Update all descMetadata terms with values in hash
+    # Note that term not having key in hash will be set to nil!
+    def set_desc_metadata term_values_hash
+      desc_metadata_terms.each { |t| set_desc_metadata_values(t, term_values_hash[t]) }
+    end
+
+    ################
+    # I do not believe this method is needed any longer since I can't find any usage of it in ddr-models, ddr-batch,
+    # dul-hydra, ddr-public, or ddr-portals
+    ################
+    # module ClassMethods
+    #   def find_by_identifier(identifier)
+    #     find(Ddr::Index::Fields::IDENTIFIER_ALL => identifier)
+    #   end
+    # end
+
+  end
+end

data/app/models/concerns/ddr/governable.rb

@@ -0,0 +1,25 @@
+module Ddr
+  module Governable
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :admin_policy_id, Valkyrie::Types::ID.optional
+     end
+
+    def admin_policy
+      if admin_policy_id.present?
+        Valkyrie.config.metadata_adapter.query_service.find_by(id: admin_policy_id)
+      end
+    end
+
+    def admin_policy=(admin_policy)
+      unless admin_policy.is_a? Ddr::Collection
+        raise ArgumentError,
+              I18n.t('ddr.core.errors.incorrect_resource_class',
+                     subject: 'Admin Policy', resource_class: 'Ddr::Core::Collection')
+      end
+      self.admin_policy_id = admin_policy.id
+    end
+
+  end
+end

data/app/models/concerns/ddr/has_admin_metadata.rb

@@ -0,0 +1,141 @@
+module Ddr
+  module HasAdminMetadata
+    extend ActiveSupport::Concern
+
+    TERMS = { access_role:            Valkyrie::Types::Set.of(Ddr::Auth::Roles::Role),
+              admin_set:              Valkyrie::Types::Strict::String.optional,
+              affiliation:            Valkyrie::Types::Set,
+              aleph_id:               Valkyrie::Types::Strict::String.optional,
+              aspace_id:              Valkyrie::Types::Strict::String.optional,
+              depositor:              Valkyrie::Types::Strict::String.optional,
+              display_format:         Valkyrie::Types::Strict::String.optional,
+              doi:                    Valkyrie::Types::Strict::String.optional,
+              ead_id:                 Valkyrie::Types::Strict::String.optional,
+              ingested_by:            Valkyrie::Types::Strict::String.optional,
+              ingestion_date:         Valkyrie::Types::DateTime.optional,
+              is_locked:              Valkyrie::Types::Strict::Bool.optional,
+              license:                Valkyrie::Types::Strict::String.optional,
+              local_id:               Valkyrie::Types::Strict::String.optional,
+              nested_path:            Valkyrie::Types::Strict::String.optional,
+              permanent_id:           Valkyrie::Types::Strict::String.optional,
+              permanent_url:          Valkyrie::Types::Strict::String.optional,
+              research_help_contact:  Valkyrie::Types::Strict::String.optional,
+              rights_note:            Valkyrie::Types::Set,
+              workflow_state:         Valkyrie::Types::Strict::String.optional
+            }
+
+    def self.term_names
+      TERMS.keys
+    end
+
+    included do
+      Ddr::HasAdminMetadata::TERMS.each do |term, type|
+        attribute term, type
+      end
+
+      alias_method :roles, :access_role
+      alias_method :roles=, :access_role=
+    end
+
+    def locked?
+      !!is_locked || Ddr.repository_locked
+    end
+
+    def published?
+      workflow_state == Ddr::Workflow::PUBLISHED
+    end
+
+    def research_help
+      Ddr::Contact.call(research_help_contact) if research_help_contact
+    end
+
+    def unpublished?
+      workflow_state == Ddr::Workflow::UNPUBLISHED
+    end
+
+    ##############
+    # Move to dul-hydra?
+    ##############
+    # def lock
+    #   self.is_locked = true
+    # end
+    #
+    # def unlock
+    #   self.is_locked = false
+    # end
+    #
+    # def lock!
+    #   lock
+    #   save
+    # end
+    #
+    # def unlock!
+    #   unlock
+    #   save
+    # end
+    #
+    # Same with publish! and unpublish!, which is currently delegated to Ddr::Managers::WorkflowManager
+    #
+    ###############
+
+    ###############
+    # attribute defined in has_content, single-valued, stored in adminMetadata datastream
+    ###############
+    # property :original_filename,
+    #          predicate: Ddr::Vocab::PREMIS.hasOriginalName do |index|
+    #   index.as :stored_sortable
+    # end
+    #
+
+    # included do
+    #
+    #   delegate :publish!, :unpublish!, :published?, :unpublished?,
+    #            to: :workflow
+    # end
+    #
+
+    def resource_roles
+      roles.select(&:in_resource_scope?)
+    end
+
+    def policy_roles
+      roles.select(&:in_policy_scope?)
+    end
+
+    def inherited_roles
+      ( has_admin_policy? && admin_policy.policy_roles ) || []
+    end
+
+    # def effective_roles(agents)
+    #   ( resource_roles | policy_roles ).select { |r| agents.include?(r.agent) }
+    # end
+
+    # def workflow
+    #   @workflow ||= Ddr::Managers::WorkflowManager.new(self)
+    # end
+    #
+    # def grant_roles_to_creator(creator)
+    #   roles.grant type: Ddr::Auth::Roles::EDITOR,
+    #               agent: creator,
+    #               scope: Ddr::Auth::Roles::RESOURCE_SCOPE
+    # end
+    #
+    # def copy_resource_roles_from(other)
+    #   roles.grant *(other.roles.in_resource_scope)
+    # end
+    #
+
+    def effective_permissions(agents)
+      Ddr::Auth::EffectivePermissions.call(self, agents)
+    end
+
+    #
+    # def finding_aid
+    #   if ead_id
+    #     FindingAid.new(ead_id)
+    #   end
+    # end
+    #
+
+  end
+end

data/app/models/concerns/ddr/has_attachments.rb

@@ -0,0 +1,10 @@
+module Ddr
+  module HasAttachments
+    extend ActiveSupport::Concern
+
+    def attachments
+      Ddr.query_service.find_inverse_references_by(resource: self, property: 'attached_to_id')
+    end
+
+  end
+end

data/app/models/concerns/ddr/has_children.rb

@@ -0,0 +1,10 @@
+module Ddr
+  module HasChildren
+    extend ActiveSupport::Concern
+
+    def children
+      Ddr.query_service.find_inverse_references_by(resource: self, property: 'parent_id')
+    end
+
+  end
+end

data/app/models/concerns/ddr/has_content.rb

@@ -0,0 +1,132 @@
+module Ddr
+  module HasContent
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :content, Ddr::File.optional
+      attribute :fits_file, Ddr::File.optional
+
+      ### DDRevo ################################################
+      # Extracted text factored out to separate concern -- Ddr::HasExtractedText
+      ### DDRevo ################################################
+      # has_file_datastream \
+      #     name: Ddr::Datastreams::EXTRACTED_TEXT,
+      #     type: Ddr::Datastreams::PlainTextDatastream,
+      #     versionable: true,
+      #     label: "Text extracted from the content file",
+      #     control_group: "M"
+      #
+
+      delegate :original_filename, to: :content, allow_nil: true
+
+      #######DDRevo#########
+      # expect that the FileManagement module will go to staff app
+      #######DDRevo#########
+      # include FileManagement
+      #
+      #######DDRevo#########
+      # to staff app
+      #######DDRevo#########
+      # delegate :validate_checksum!, to: :content
+    end
+
+    #######DDRevo#########
+    # to staff app
+    #######DDRevo#########
+    # # Convenience method wrapping FileManagement#add_file
+    # def upload file, opts={}
+    #   add_file(file, Ddr::Datastreams::CONTENT, opts)
+    # end
+    #
+    #######DDRevo#########
+    # to staff app
+    #######DDRevo#########
+    # # Set content to file and save
+    # def upload! file, opts={}
+    #   upload(file, opts)
+    #   save
+    # end
+    #
+    #######DDRevo#########
+    # DerivativesManager will go to staff app.  Need to determine if there is a need for a '#derivatives' method on
+    # content-bearing objects and, if so, what it should return
+    #######DDRevo#########
+    # def derivatives
+    #   @derivatives ||= Ddr::Managers::DerivativesManager.new(self)
+    # end
+    #
+    def techmd
+      @techmd ||= Ddr::Managers::TechnicalMetadataManager.new(self)
+    end
+
+    def content_size
+      content&.file&.size
+    end
+
+    def content_human_size
+      ActiveSupport::NumberHelper.number_to_human_size(content_size) if content_size
+    end
+
+    def content_type
+      content&.media_type
+    end
+
+    def content_major_type
+      content_type&.split("/")&.first
+    end
+
+    def content_sub_type
+      content_type&.split("/")&.last
+    end
+
+    # def content_type= mime_type
+    #   self.content.mimeType = mime_type
+    # end
+    #
+    def image?
+      content_major_type == "image"
+    end
+
+    def pdf?
+      content_type == "application/pdf"
+    end
+
+    # def virus_checks
+    #   Ddr::Events::VirusCheckEvent.for_object(self)
+    # end
+    #
+    # def last_virus_check
+    #   virus_checks.last
+    # end
+    #
+    # def last_virus_check_on
+    #   last_virus_check && last_virus_check.event_date_time
+    # end
+    #
+    # def last_virus_check_outcome
+    #   last_virus_check && last_virus_check.outcome
+    # end
+    #
+    # def content_changed?
+    #   content.external? ? content.dsLocation_changed? : content.content_changed?
+    # end
+    #
+    ### DDRevo ###########################################
+    # Moved to Ddr::Resource where other 'has_<file>?' methods reside
+    ### DDRevo ###########################################
+    # def has_extracted_text?
+    #   extractedText.has_content?
+    # end
+    #
+    # def with_content_file(&block)
+    #   WithContentFile.new(self, &block)
+    # end
+    #
+    # protected
+    #
+    # def default_content_type
+    #   "application/octet-stream"
+    # end
+
+  end
+end