hyrax-preservation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b640e48b5f2c1c7671aafe3cedbfa3c9eddd13e47a0b42aa710e814845bcbf6
+  data.tar.gz: a0046c6f6ad64f5b2ec63feb340c74699073e4d1bc47802d0ede9d59c572bbe9
+SHA512:
+  metadata.gz: d19413cfa69f75cb3e03b8c7bd83615c55e2c6859ec6f6911099a7c9851f6b2b7f094235bd11d2a71cc28e09c232f807638730485b170e51be14cdd2fb3f0abd
+  data.tar.gz: 4453203e60f1de3df9360fad1dbbdabba447e0c82197cd256b5bb40f35c5ad08cde371fd124d093d8b701bd9b6b30eeb6a531621682c410a33798e6163e279ae

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Andrew Myers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,5 @@
+![Travis Build Status](https://travis-ci.org/WGBH/hydradam-preservation.svg?branch=master)
+
+# Hydradam Preservation
+
+Gem for adding preservation functionality to an existing Hydra head.

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+load 'rails/tasks/statistics.rake'
+require 'engine_cart/rake_task'
+
+# Load tasks for gem development
+Dir.glob('gem_development_rake_tasks/*.rake').each { |r| import r }
+
+# Set the default rake task when developing this gem.
+task :default => ['ci']

data/app/assets/config/preservation_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/preservation .js
+//= link_directory ../stylesheets/preservation .css

data/app/assets/javascripts/hyrax/preservation/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/hyrax/preservation/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/hyrax/preservation/events_controller.rb

@@ -0,0 +1,133 @@
+require 'hyrax/preservation/search_state'
+
+module Hyrax
+  module Preservation
+    class EventsController < ActionController::Base
+      include Blacklight::Controller
+      include Hydra::Controller::ControllerBehavior
+      include Hydra::Catalog
+      include Hyrax::Controller
+
+      # Include Blacklight helpers that are needed to avoid breakage when using
+      # Blacklight views.
+      helper CatalogHelper
+      helper ComponentHelper
+      helper LayoutHelper
+
+      # Include Hyrax helpers that are needed to avoid breakage when rendering
+      # Hyrax views.
+      helper HyraxHelper
+
+      # Override Hyrax::UrlHelper#url_for_document
+      # helper_method :url_for_document
+      helper_method :display_premis_agent
+      helper_method :display_premis_event_date_time
+      helper_method :display_related_file
+
+      # TODO: We used to include CurationConcerns::ApplicationControllerBehavior
+      # here, but that module was merged into Sufia::Controller, which was later
+      # converted to Hyrax::Controller. But we're not sure if it's still needed.
+      # TODO: Determine whether or not we need to include Hyrax::Controller, and
+      # upadate (or delete) these commets accordingly.
+      # include Hyrax::Controller
+      include Hyrax::ThemedLayoutController
+      with_themed_layout '1_column'
+
+      # Prevent CSRF attacks by raising an exception.
+      # For APIs, you may want to use :null_session instead.
+      protect_from_forgery with: :exception
+
+      # Override rails path for the views by appending 'catalog' as a
+      # place to look for views. This allows using default blacklight
+      # views if you don't want to override each one.
+      def _prefixes
+        @_prefixes ||= super + ['catalog']
+      end
+
+      configure_blacklight do |config|
+
+        config.search_builder_class = EventsSearchBuilder
+
+        # Index view config
+        config.index.document_presenter_class = EventIndexPresenter
+        # NOTE: setting `config.index.title_field` here has no effect, because
+        # we're currently overriding the presenter class, and the partial that
+        # would normally be looking for it. Instead, see the overridden partial
+        # in app/views/preservation/events/_index_header_list_default.html.erb
+        # and the EventIndexPresenter#search_result_title method.
+        config.add_index_field solr_name(:hasEventRelatedObject, :symbol), label: "File", helper_method: :display_related_file
+        config.add_index_field solr_name(:premis_event_date_time, :stored_searchable, type: :date), label: "Date", helper_method: :display_premis_event_date_time
+        config.add_index_field solr_name(:premis_agent, :symbol), label: "Agent", helper_method: :display_premis_agent
+
+        # Show view config
+        config.show.document_presenter_class = EventShowPresenter
+        config.add_show_field solr_name(:premis_agent, :symbol), label: "PREMIS Agent"
+        config.add_show_field solr_name(:premis_event_date_time, :stored_searchable, type: :date), label: "Date"
+        config.add_show_field solr_name(:hasEventRelatedObject, :symbol), label: "File", helper_method: :display_related_file
+
+        # Remove unused actions from the show view. Enabling these breaks the
+        # show view because Blacklight generates urls that don't exist. Figuring
+        # out how to make them work will take more digging.
+        config.show.document_actions.delete(:bookmark)
+        config.show.document_actions.delete(:email)
+        config.show.document_actions.delete(:sms)
+        config.show.document_actions.delete(:citation)
+
+        # Facet config
+        # config.add_facet_fields_to_solr_request!
+        # config.add_facet_field :premis_event_date_time_ltsi, label: 'Date', range: { segments: false }
+        # config.add_facet_field solr_name(:premis_event_type, :symbol), label: 'Type'
+      end
+
+      # Overrides CatalogController::UrlHelper#url_for_document. It would be
+      # nice to put this method in our own Preservation::UrlHelper module but I
+      # couldn't get the helper to load after Hyrax::UrlHelper in
+      # order to overwrite the #url_for_document method. NOTE: In any event,
+      # this method needs to behave roughly the same way as
+      # CurationCocerns::UrlHelper#url_for_document, so if that method changes
+      # change this one accordingly.
+      # def url_for_document(doc, _options = {})
+      #   polymorphic_path([preservation, doc])
+      # end
+
+      def search_state
+        @search_state ||= Hyrax::Preservation::SearchState.new(params, blacklight_config, self)
+      end
+
+      def display_premis_agent(opts={})
+        solr_doc = opts[:document]
+        premis_agent_mailto_uri = solr_doc[opts[:field]]
+        premis_agent_mailto_uri.first.sub(/^mailto\:/, '')
+      end
+
+      def display_premis_event_date_time(opts={})
+        solr_doc = opts[:document]
+        premis_event_date_time = solr_doc[opts[:field]]
+        Date.parse(premis_event_date_time.to_s).strftime('%Y-%m-%d')
+      end
+
+      def display_related_file(opts={})
+        # TODO: Is there a better way than having the controller send back HTML?
+        # TODO: Is there a better way to fetch the FileSet ID and Title? This way is confusing.
+        solr_doc = opts[:document]
+        file_set_id = solr_doc[:hasEventRelatedObject_ssim].first
+        file_set_url = Rails.application.routes.url_helpers.hyrax_file_set_path(id: file_set_id)
+
+        # TODO: this is totally klugey. We're pulling back the FileSet object from Fedora in order to get
+        # a good name to display it with. Originally, we were getting this value from the Solr document of
+        # the PreservationEvent object, but we ran into an issue where the PreservationEventIndexer does
+        # not know which FileSet property has been populated with a good, representative name for the FileSet
+        # at the time of indexing, because that is determined by configuration within the host app in any one of:
+        #  1. the FileSet model
+        #  1. the ingest configuration of the FileSet if using hyrax-ingest.
+        #  1. the FileSet indexer
+        # So either this value needs to be configurable within the host app,
+        # or the PreservationEventIndexer (in the hyrax-preservation gem) needs to have similar fallback logic
+        # when indexing a representative name for the FileSet.
+        file_set = ::FileSet.find(file_set_id)
+        file_set_title = file_set&.title&.first ||  file_set&.label || file_set&.filename&.first
+        "<a href='#{file_set_url}'>#{file_set_title}</a>".html_safe
+      end
+    end
+  end
+end

data/app/helpers/hyrax/preservation/application_helper.rb

@@ -0,0 +1,6 @@
+module Hyrax
+  module Preservation
+    module ApplicationHelper
+    end
+  end
+end

data/app/indexers/hyrax/preservation/event_indexer.rb

@@ -0,0 +1,73 @@
+module Hyrax
+  module Preservation
+    class EventIndexer < ActiveFedora::IndexingService
+      def generate_solr_document
+        super.tap do |solr_doc|
+          # TODO: Some of the conditionals checking for existence of properties
+          # may be removed after require those fields with validations on the
+          # model.
+
+          if object.premis_event_related_object
+            Solrizer.set_field(solr_doc,
+                               'related_file_title',
+                               object.premis_event_related_object.label,
+                               :stored_searchable)
+          end
+
+          unless object.premis_event_type.empty?
+            # Index the PREMIS event type.
+            # NOTE: the value we index is only the last URI segment, which is a
+            # 3-letter abbreviation.
+            Solrizer.set_field(solr_doc,
+                               'premis_event_type',
+                               shortened_field_val = URI(object.premis_event_type.first.id).path.split('/').last,
+                               :symbol)
+          end
+
+          unless object.premis_agent.empty?
+            # Index the PREMIS agent, under the assumption that is a mailto: URI.
+            # NOTE: The value we index is only the amil address, without the "mailto:" part.
+            Solrizer.set_field(solr_doc,
+                               'premis_agent',
+                               object.premis_agent.first.id.sub(/^mailto:/, ''),
+                               :symbol)
+          end
+
+
+          # If the PreservationEvent's agent is found in the db,
+          # then index that user's full name as well.
+          # TODO: Not sure if this is a good idea.
+          #   How much metadata about the agent should we index for PreservationEvents?
+          # if object.premis_agent_db_user
+          #   Solrizer.set_field(solr_doc,
+          #                      'premis_agent_full_name',
+          #                      object.premis_agent_db_user.first.id,
+          #                      :stored_searchable)
+          # end
+
+          unless object.premis_event_date_time.empty?
+            # Index the PREMIS event date time as a date.
+            Solrizer.set_field(solr_doc,
+                               'premis_event_date_time',
+                               object.premis_event_date_time.first,
+                               :stored_searchable)
+
+            # Index the PREMIS event date time as an integer, for range queries.
+            Solrizer.set_field(solr_doc,
+                               'premis_event_date_time_integer',
+                               object.premis_event_date_time.first.strftime('%Y%m%d').to_i,
+                               Solrizer::Descriptor.new(:long, :stored, :indexed))
+          end
+
+          unless object.premis_event_outcome.empty?
+            # Index the PREMIS event outcome.
+            Solrizer.set_field(solr_doc,
+                               'premis_event_outcome',
+                               object.premis_event_outcome.first,
+                               :stored_searchable)
+          end
+        end
+      end
+    end
+  end
+end

data/app/jobs/hyrax/preservation/application_job.rb

@@ -0,0 +1,6 @@
+module Hyrax
+  module Preservation
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/hyrax/preservation/application_mailer.rb

@@ -0,0 +1,8 @@
+module Hyrax
+  module Preservation
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/hyrax/preservation/event.rb

@@ -0,0 +1,41 @@
+module Hyrax
+  module Preservation
+    class Event < ActiveFedora::Base
+      type ::RDF::Vocab::PREMIS.Event
+
+      belongs_to :premis_event_related_object, predicate: ::RDF::Vocab::PREMIS.hasEventRelatedObject, class_name: ::FileSet
+
+      property :premis_event_type, predicate: ::RDF::Vocab::PREMIS.hasEventType
+      property :premis_agent, predicate: ::RDF::Vocab::PREMIS.hasAgent
+      property :premis_event_date_time, predicate: ::RDF::Vocab::PREMIS.hasEventDateTime
+      property :premis_event_outcome, predicate: ::RDF::Vocab::PREMIS.hasEventOutcome
+      property :premis_event_detail, predicate: ::RDF::Vocab::PREMIS.hasEventDetail
+
+      def user_from_db
+        @user_from_db ||= User.where(email: premis_agent)
+      end
+
+      # @return [String] the label of the PREMIS event type that corresponds
+      #   with the URI from the first value of the #premis_event_type property.
+      def premis_event_type_label
+        premis_event_type_object.label
+      end
+
+      def premis_event_type_abbr
+        premis_event_type_object.abbr
+      end
+
+      def self.indexer
+        EventIndexer
+      end
+
+      private
+        # @return [Preservation::PremisEventType] first PremisEventType instance
+        #   found where Preservation::PremisEventType#uri matches first value
+        #   found in #premis_event_type property.
+        def premis_event_type_object
+          @premis_event_type_object ||= Preservation::PremisEventType.find_by_uri(premis_event_type.first.id)
+        end
+    end
+  end
+end

data/app/models/hyrax/preservation/premis_event_type.rb

@@ -0,0 +1,64 @@
+# A basic PORO model for PREMIS event types.
+#
+# The data for this model is not persisted to any data store. It is just
+# hardcoded (see Preservation::PremisEventyType.all).
+#
+# While only the URI of a PREMIS event type is stored on the
+# Preservation::Event#premis_event_type property, this PORO is used to pair
+# the URI with an abbreviation and a label.
+module Hyrax
+  module Preservation
+    class PremisEventType
+      attr_reader :abbr, :label
+
+      def initialize(abbr, label='')
+        @abbr = abbr
+        @label = label
+      end
+
+      def uri
+        ::RDF::Vocab::PremisEventType.send(abbr)
+      end
+
+      # @return [Array] list of all available PremisEventType instances.
+      def self.all
+        @all ||= [
+          new('cap', 'PREMIS Capture'),
+          new('com', 'PREMIS Compression'),
+          new('cre', 'PREMIS Creation'),
+          new('dea', 'PREMIS Deaccession'),
+          new('dec', 'PREMIS Decryption'),
+          new('del', 'PREMIS Deletion'),
+          new('dig', 'PREMIS Digital Signature Validation'),
+          new('fix', 'PREMIS Fixity Check'),
+          new('ing', 'PREMIS Ingestion'),
+          new('mes', 'PREMIS Message Digest Calculation'),
+          new('mig', 'PREMIS Migration'),
+          new('nor', 'PREMIS Normalization'),
+          new('rep', 'PREMIS Replication'),
+          new('val', 'PREMIS Validation'),
+          new('vir', 'PREMIS Virus Check')
+        ]
+      end
+
+      # @param [String] URI to use for comparison. Note #to_s is called on the
+      #   param before comparing.
+      # @return [Preservation::PremisEventType] first found instance with URI
+      #   that matches parameter.
+      def self.find_by_uri(uri)
+        result = all.find { |record| record.uri.to_s == uri.to_s }
+        raise NotFound.new("PremisEventType with URI \"#{uri.to_s}\" was not found") unless result
+        result
+      end
+
+      def self.find_by_abbr(abbr)
+        result = all.find { |record| record.abbr == abbr }
+        raise NotFound.new("PremisEventType with abbreviation \"#{abbr}\" was not found") unless result
+        result
+      end
+
+      # Custom Error Classes
+      class NotFound < StandardError; end
+    end
+  end
+end

data/app/presenters/hyrax/preservation/event_index_presenter.rb

@@ -0,0 +1,12 @@
+module Hyrax
+  module Preservation
+    class EventIndexPresenter < Blacklight::IndexPresenter
+      # Returns the value of PremisEventType#label for the PremisEventType instance
+      # whose #abbr value matches that which is in the solr document.
+      def search_result_title
+        premis_event_type = PremisEventType.all.find { |premis_event_type| premis_event_type.abbr == document.first(:premis_event_type_ssim) }
+        premis_event_type.label
+      end
+    end
+  end
+end

data/app/presenters/hyrax/preservation/event_show_presenter.rb

@@ -0,0 +1,11 @@
+module Hyrax
+  module Preservation
+    class EventShowPresenter < Blacklight::ShowPresenter
+      def heading
+        premis_event_type_abbr = document[Solrizer.solr_name(:premis_event_type, :symbol)].first
+        premis_event_type = Preservation::PremisEventType.all.find { |premis_event_type| premis_event_type.abbr == premis_event_type_abbr }
+        premis_event_type.label
+      end
+    end
+  end
+end

data/app/search_builders/hyrax/preservation/events_search_builder.rb

@@ -0,0 +1,105 @@
+module Hyrax
+  module Preservation
+    class EventsSearchBuilder < Blacklight::SearchBuilder
+      include Blacklight::Solr::SearchBuilderBehavior
+
+      self.default_processor_chain += [:only_models_for_preservation_events, :apply_premis_event_date_time_filter,
+                                       :apply_premis_event_type_filter, :apply_premis_agent_filter,
+                                       :apply_premis_event_related_object_filter]
+
+
+      def only_models_for_preservation_events(solr_params)
+        solr_params[:fq] ||= []
+        solr_params[:fq] << "{!terms f=has_model_ssim}Hyrax::Preservation::Event"
+      end
+
+      def apply_premis_event_date_time_filter(solr_params)
+        if premis_event_date_time_filter
+          solr_params[:fq] ||= []
+          solr_params[:fq] << premis_event_date_time_filter
+        end
+        solr_params
+      end
+
+      def apply_premis_event_type_filter(solr_params)
+        if premis_event_type_filter
+          solr_params[:fq] ||= []
+          solr_params[:fq] << premis_event_type_filter
+        end
+        solr_params
+      end
+
+      def apply_premis_agent_filter(solr_params)
+        if premis_agent_filter
+          solr_params[:fq] ||= []
+          solr_params[:fq] << premis_agent_filter
+        end
+      end
+
+      def apply_premis_event_related_object_filter(solr_params)
+        if premis_event_related_object_filter
+          solr_params[:fq] ||= []
+          solr_params[:fq] << premis_event_related_object_filter
+        end
+      end
+
+      private
+
+      # Returns a date/time range for a Solr query for the 'after' and 'before'
+      # URL params.
+      def premis_event_date_time_filter
+        @premis_event_date_time_filter ||= begin
+          if premis_event_date_time_before || premis_event_date_time_after
+            range = "#{premis_event_date_time_after || '*'} TO #{premis_event_date_time_before || '*'}"
+            "premis_event_date_time_dtsim:[#{range}]"
+          end
+        end
+      end
+
+      # Returns the 'before' date time formatted for a Solr query.
+      def premis_event_date_time_before
+        @premis_event_date_time_before ||= formatted_premis_event_date_time(blacklight_params['before'])
+      end
+
+      # Returns the 'after' date time formatted for a Solr query.
+      def premis_event_date_time_after
+        @premis_event_date_time_after ||= formatted_premis_event_date_time(blacklight_params['after'])
+      end
+
+      # Converts an unformatted date (as passed in via URL) to a date formatted
+      # for a Solr query.
+      def formatted_premis_event_date_time(unformatted_date)
+        DateTime.parse(unformatted_date.to_s).utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+      rescue ArgumentError => e
+        nil
+      end
+
+      def premis_event_type_filter
+        @premis_event_type_filter ||= begin
+          if blacklight_params['premis_event_type']
+            valid_premis_abbrs = blacklight_params['premis_event_type'] & Hyrax::Preservation::PremisEventType.all.map(&:abbr)
+            "(#{valid_premis_abbrs.map { |abbr| "premis_event_type_ssim:#{abbr}"}.join(" OR ")})"
+          end
+        end
+      end
+
+      def premis_agent_filter
+        @premis_agent_filter ||= begin
+          if blacklight_params['agent'].present?
+            # TODO: sanitize URL parameters. Do not simply trust user input.
+            "premis_agent_ssim:#{blacklight_params['agent']}"
+          end
+        end
+      end
+
+      def premis_event_related_object_filter
+        @premis_event_related_object_filter ||= begin
+          if blacklight_params['related_object'].present?
+            # TODO: sanitize URL parameters. Do not simply trust user input.
+            "hasEventRelatedObject_ssim:#{blacklight_params['related_object']}"
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/hyrax/preservation/events/_event.html.erb

@@ -0,0 +1 @@
+<%= render 'catalog/document', document: event, document_counter: event_counter  %>

data/app/views/hyrax/preservation/events/_filter_search.html.erb

@@ -0,0 +1,6 @@
+<div>
+  <%= link_to "Clear All Filters", hyrax_preservation.events_url %>
+</div>
+<%= render 'hyrax/preservation/events/filter_search/date_range' %>
+<%= render 'hyrax/preservation/events/filter_search/premis_event_type' %>
+<%= render 'hyrax/preservation/events/filter_search/premis_agent' %>

data/app/views/hyrax/preservation/events/_index_header_list_default.html.erb

@@ -0,0 +1,20 @@
+<%
+# NOTE: This overrides Hyrax's
+# app/views/catalog/_index_header_list_default.html.erb which (at the time of
+# this writing) only calls `document.title_or_label`, where `document` is a
+# `SolrDocument` instance. We need to use a presenter object, because we use a
+# small bit of logic to return the title of a search result. Hyrax will
+# probably be upgraded to use a presenter in it's own version of this view
+# partial in the near future, but until then, we override it here.
+
+# Furthermore, since we are using our own custom presenter, and our own custom
+# view partial, configuring the title field using `config.index.title_file` in
+# the EventsController's `configure_blacklight` block has no effect here. Instead,
+# we're just overriding the default index presenter, giving it a special
+# method, and calling that special method from this overridden partial.
+
+# Confused yet? Yeah, me too.
+%>
+  <h2>
+    <%= link_to index_presenter(document).search_result_title, document %>
+  </h2>

data/app/views/hyrax/preservation/events/_previous_next_doc.html.erb

@@ -0,0 +1,29 @@
+<%
+# This is an override of a partial from Blacklight 6.7.3
+# in app/views/catalog/_previous_next_doc.html.erb.
+# See inline comment below for details of why the override is needed.
+%>
+
+<% #Using the Bootstrap Pagination class  -%>
+<% #DEPRECATED - using id="previousNextDocument" as a selector is deprecated and will be removed in Blacklight 6.0 %>
+<div id='previousNextDocument' class='pagination-search-widgets'>
+  <% if @previous_document || @next_document %>
+    <div class="page_links">
+      <%= link_to_previous_document @previous_document %> |
+
+      <%= item_page_entry_info %> |
+
+      <%= link_to_next_document @next_document %>
+    </div>
+  <% end %>
+  <% if current_search_session %>
+    <div class="pull-right search-widgets">
+      <%
+      # Calling #link_back_to_catalog here results in a routing error: no route matches "preservatio/catalog"
+      # Filed a detailed bug: https://github.com/projectblacklight/blacklight/issues/1647
+      # In the meantime, just skip the link back to the catalog.
+      %>
+      <%=link_to t('blacklight.search.start_over'), start_over_path(current_search_session.try(:query_params) || {}), id: 'startOverLink', class: 'btn' %>
+    </div>
+  <% end %>
+</div>

data/app/views/hyrax/preservation/events/filter_search/_date_range.html.erb

@@ -0,0 +1,18 @@
+<h2>Date</h2>
+<form id="date_time_range_filter" action="<%= hyrax_preservation.events_url %>">
+  <label>From</label>
+  <input name="after" value="<%= params['after'] %>" />
+  <label>To</label>
+  <input name="before" value="<%= params['before'] %>" />
+
+  <!-- TODO: This logic needs to be replicated for all filter forms. Better in a helper method? -->
+  <% Rack::Utils.parse_query(request.query_string).except("after", "before").each do |param, val| %>
+    <% # Sometimes `val` may be an array, but not always. So we just array-ify
+       # it here to cover both cases. %>
+    <% Array(val).each do |single_val| %>
+      <input type="hidden" name="<%= param %>" value="<%= single_val %>" />
+    <% end %>
+  <% end %>
+
+  <button type="submit">Submit</button>
+</form>

data/app/views/hyrax/preservation/events/filter_search/_premis_agent.html.erb

@@ -0,0 +1,15 @@
+<h2>PREMIS Agent</h2>
+<form id="premis_agent_filter" action="<%= hyrax_preservation.events_url %>">
+  <label for="agent">Agent</label>
+  <input id="agent" name="agent" value="<%= params['agent'] %>" />
+  <!-- TODO: This logic needs to be replicated for all filter forms. Better in a helper method? -->
+  <% Rack::Utils.parse_query(request.query_string).except("agent").each do |param, val| %>
+    <% # Sometimes `val` may be an array, but not always. So we just array-ify
+       # it here to cover both cases. %>
+    <% Array(val).each do |single_val| %>
+      <input type="hidden" name="<%= param %>" value="<%= single_val %>" />
+    <% end %>
+  <% end %>
+
+  <button type="submit">Submit</button>
+</form>

data/app/views/hyrax/preservation/events/filter_search/_premis_event_type.html.erb

@@ -0,0 +1,18 @@
+<h2>PREMIS Event Type</h2>
+<form id="premis_event_type_filter" action="<%= hyrax_preservation.events_url %>">
+  <% Hyrax::Preservation::PremisEventType.all.each do |premis_event_type| %>
+    <input type="checkbox" id="premis_event_type_<%= premis_event_type.abbr %>" name="premis_event_type[]" value="<%= premis_event_type.abbr %>" <%= Array(request.params['premis_event_type']).include?(premis_event_type.abbr) ? 'checked="checked"' : '' %>/>
+    <label for="premis_event_type_<%= premis_event_type.abbr %>"><%= premis_event_type.label.sub(/^PREMIS/ , '') %></label>
+  <% end %>
+
+  <!-- TODO: This logic needs to be replicated for all filter forms. Better in a helper method? -->
+  <% Rack::Utils.parse_query(request.query_string).except("premis_event_type[]").each do |param, val| %>
+    <% # Sometimes `val` may be an array, but not always. So we just array-ify
+       # it here to cover both cases. %>
+    <% Array(val).each do |single_val| %>
+      <input type="hidden" name="<%= param %>" value="<%= single_val %>" />
+    <% end %>
+  <% end %>
+
+  <button type="submit">Submit</button>
+</form>

data/app/views/hyrax/preservation/events/index.html.erb

@@ -0,0 +1,10 @@
+<% provide :page_title, "#{application_name} Search Results" %>
+<% provide :page_class, 'search' %>
+
+<% provide :sidebar do %>
+  <%= render 'filter_search' %>
+<% end %>
+
+<div id="content">
+  <%= render 'search_results' %>
+</div>

data/app/views/layouts/hyrax/preservation/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Preservation</title>
+  <%= stylesheet_link_tag    "preservation/application", media: "all" %>
+  <%= javascript_include_tag "preservation/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Hyrax::Preservation::Engine.routes.draw do
+  resources :events, only: [:index, :show]
+end

data/lib/generators/hyrax/preservation/install_generator.rb

@@ -0,0 +1,21 @@
+module Hyrax
+  module Preservation
+    class InstallGenerator < Rails::Generators::Base
+
+      desc <<-EOS
+        This generator makes the following changes to your application:
+         1. Adds Preservation routes to your ./config/routes.rb
+      EOS
+
+      # def inject_search_builder_behavior
+      #   inject_into_file 'app/models/search_builder.rb', after: "include Hyrax::SearchFilters\n" do
+      #     "\tinclude Hydradam::SearchBuilderBehavior\n"
+      #   end
+      # end
+
+      def add_routes
+        route "mount Hyrax::Preservation::Engine, at: '/preservation'"
+      end
+    end
+  end
+end

data/lib/hyrax/preservation.rb

@@ -0,0 +1,12 @@
+if defined? Rails
+  require "hyrax/preservation/engine"
+  require 'hyrax'
+end
+
+module Hyrax
+  module Preservation
+    def self.root
+      Pathname.new(File.expand_path('../../../', __FILE__))
+    end
+  end
+end

data/lib/hyrax/preservation/demo.rb

@@ -0,0 +1,80 @@
+require_relative 'event_logger'
+
+
+module Hyrax
+  module Preservation
+    class Demo
+      def self.clean_slate!
+        delete_all_file_sets!
+        delete_all_preservation_events!
+        delete_all_hydra_access_controls!
+      end
+
+      def self.delete_all_file_sets!
+        FileSet.all.each { |fs| fs.delete }
+      end
+
+      def self.delete_all_preservation_events!
+        Preservation::Event.all.each { |pe| pe.delete }
+      end
+
+      def self.delete_all_hydra_access_controls!
+        ::Hydra::AccessControl.all.each { |ac| ac.delete }
+      end
+
+      def self.new_file_set
+        FileSet.new.tap do |fs|
+          fs.apply_depositor_metadata(User.first)
+          fs.save!
+        end
+      end
+
+      def self.run_once!
+        file_set = new_file_set
+
+        # NOTE: PreservationEventLogger is a stateless service object that provides a "use anywhere" interface
+        # for logging preservation events. We don't have to use this pattern, but it has it's advantages.
+
+        # Create two sets of people for some realistic randomness in the demo records.
+        preservation_people = ['jlhardes@iu.edu', 'heidowdi@indiana.edu']
+        ingest_people = ['akhedkar@iu.edu', 'afredmyers@gmail.com']
+
+
+        # Create a fake capture date of sometime between now and 90 days ago.
+        capture_date = DateTime.now - rand(2..90).days
+        # Create a fake fixity check date sometime between the capture date and now.
+        fixity_date = rand(capture_date..DateTime.now)
+        # Create a fake ingest date of sometime beetween the capture date and now.
+        ingest_date = rand(capture_date..DateTime.now)
+
+        # Create an event for the file's capture.
+        Preservation::EventLogger.log_preservation_event(
+          file_set: file_set,
+          premis_event_type: 'cap',
+          premis_agent: preservation_people.sample,
+          premis_event_date_time: capture_date
+        )
+
+        # Create an event for the file's fixity check.
+        Preservation::EventLogger.log_preservation_event(
+          file_set: file_set,
+          premis_event_type: 'fix',
+          premis_agent: preservation_people.sample,
+          premis_event_date_time: fixity_date
+        )
+
+        # Create an event for the file's ingestion.
+        Preservation::EventLogger.log_preservation_event(
+          file_set: file_set,
+          premis_event_type: 'ing',
+          premis_agent: ingest_people.sample,
+          premis_event_date_time: ingest_date
+        )
+      end
+
+      def self.run!(iterations=1)
+        iterations.times { self.run_once! }
+      end
+    end
+  end
+end

data/lib/hyrax/preservation/engine.rb

@@ -0,0 +1,13 @@
+module Hyrax::Preservation
+  class Engine < ::Rails::Engine
+    isolate_namespace Hyrax::Preservation
+
+    config.autoload_paths += %W(
+      #{config.root}/app/helpers
+      #{config.root}/app/indexers
+      #{config.root}/app/presenters
+      #{config.root}/app/search_builders
+      #{config.root}/lib/preservation
+    )
+  end
+end

data/lib/hyrax/preservation/event_logger.rb

@@ -0,0 +1,18 @@
+# TODO: Only use this as-is for Demo. If you want to use it as a service object
+# it should be moved to a different location probably.
+module Hyrax
+  module Preservation
+    class EventLogger
+      def self.log_preservation_event(opts={})
+        Preservation::Event.new.tap do |pe|
+          pe.premis_event_type += [ Preservation::PremisEventType.all.select { |premis_event_type| premis_event_type.abbr == opts[:premis_event_type].to_sym } ]
+          pe.premis_event_related_object = opts[:file_set]
+          # Assume opts[:premis_agent] is an email address, and make a 'mailto:' RDF::URI out of it.
+          pe.premis_agent += [::RDF::URI.new("mailto:#{opts[:premis_agent]}")]
+          pe.premis_event_date_time += [opts[:premis_event_date_time]]
+          pe.save!
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/preservation/search_state.rb

@@ -0,0 +1,9 @@
+module Hyrax
+  module Preservation
+    class SearchState < Hyrax::SearchState
+      def url_for_document(doc, options = {})
+        [controller.hyrax_preservation, doc]
+      end
+    end
+  end
+end

data/lib/hyrax/preservation/service_environment.rb

@@ -0,0 +1,65 @@
+require 'hyrax/preservation'
+require 'solr_wrapper'
+require 'fcrepo_wrapper'
+require 'active_support/core_ext/hash/keys'
+
+module Hyrax
+  module Preservation
+    class ServiceEnvironment
+      attr_reader :env
+
+      def initialize(env)
+        @env = (env || 'development').to_s
+      end
+
+      def start
+        wrap do
+          begin
+            puts "\nServices started. Ctrl+C to stop.\n\n"
+            sleep
+          rescue Interrupt
+            # TODO: Why doesn't this message get printed?
+            puts "Stopping services..."
+          end
+        end
+      end
+
+      def wrap
+        SolrWrapper.wrap(solr_wrapper_config) do |solr_wrapper_instance|
+          # If a solr collection exists, but is not configured to persist,
+          # then we must delete it before we try to re-create it. Otherwise
+          # SolrWrapper with throw an error. Note this is kind of an awkward
+          # way to check for existence of the core, but it's due to current
+          # limitation of the SolrWrapper interfaces.
+          if !solr_wrapper_config[:collection][:persist] && SolrWrapper::Client.new(solr_wrapper_instance.url).exists?(solr_wrapper_config[:collection][:name])
+            solr_wrapper_instance.delete solr_wrapper_config[:collection][:name]
+          end
+
+          solr_wrapper_instance.with_collection(solr_wrapper_config[:collection]) do
+            FcrepoWrapper.wrap(fcrepo_wrapper_config) do
+              yield
+            end
+          end
+        end
+      end
+
+      private
+
+      def solr_wrapper_config
+        @solr_wrapper_config ||= YAML.load(File.read(solr_wrapper_config_path)).deep_symbolize_keys
+      end
+
+      def solr_wrapper_config_path
+        File.join(Hyrax::Preservation.root, ".solr_wrapper.#{env}.yml")
+      end
+
+      def fcrepo_wrapper_config
+        @fcrepo_wrapper_config ||= YAML.load(File.read(fcrepo_wrapper_config_path)).deep_symbolize_keys
+      end
+
+      def fcrepo_wrapper_config_path
+        File.join(Hyrax::Preservation.root, ".fcrepo_wrapper.#{env}.yml")
+      end
+    end
+  end
+end

data/lib/hyrax/preservation/version.rb

@@ -0,0 +1,5 @@
+module Hyrax
+  module Preservation
+    VERSION = '0.1.1'
+  end
+end

metadata

@@ -0,0 +1,307 @@
+--- !ruby/object:Gem::Specification
+name: hyrax-preservation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew Myers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyrax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: jquery-ui-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+- !ruby/object:Gem::Dependency
+  name: solr_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: fcrepo_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Hyrax Preservation provides models for storing and searching for preservation
+  metadata.
+email:
+- afredmyers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/preservation_manifest.js
+- app/assets/javascripts/hyrax/preservation/application.js
+- app/assets/stylesheets/hyrax/preservation/application.css
+- app/controllers/hyrax/preservation/events_controller.rb
+- app/helpers/hyrax/preservation/application_helper.rb
+- app/indexers/hyrax/preservation/event_indexer.rb
+- app/jobs/hyrax/preservation/application_job.rb
+- app/mailers/hyrax/preservation/application_mailer.rb
+- app/models/hyrax/preservation/event.rb
+- app/models/hyrax/preservation/premis_event_type.rb
+- app/presenters/hyrax/preservation/event_index_presenter.rb
+- app/presenters/hyrax/preservation/event_show_presenter.rb
+- app/search_builders/hyrax/preservation/events_search_builder.rb
+- app/views/hyrax/preservation/events/_event.html.erb
+- app/views/hyrax/preservation/events/_filter_search.html.erb
+- app/views/hyrax/preservation/events/_index_header_list_default.html.erb
+- app/views/hyrax/preservation/events/_previous_next_doc.html.erb
+- app/views/hyrax/preservation/events/filter_search/_date_range.html.erb
+- app/views/hyrax/preservation/events/filter_search/_premis_agent.html.erb
+- app/views/hyrax/preservation/events/filter_search/_premis_event_type.html.erb
+- app/views/hyrax/preservation/events/index.html.erb
+- app/views/layouts/hyrax/preservation/application.html.erb
+- config/routes.rb
+- lib/generators/hyrax/preservation/install_generator.rb
+- lib/hyrax/preservation.rb
+- lib/hyrax/preservation/demo.rb
+- lib/hyrax/preservation/engine.rb
+- lib/hyrax/preservation/event_logger.rb
+- lib/hyrax/preservation/search_state.rb
+- lib/hyrax/preservation/service_environment.rb
+- lib/hyrax/preservation/version.rb
+homepage: https://github.com/IUBLibTech/hyrax-preservation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Preservation features for Hydra
+test_files: []