zizia 3.1.0.alpha.01 → 4.0.0.alpha.01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a24728641684b8789177ad48a5a3053089f58b10258dc17d2ff580d09da8ca3a
-  data.tar.gz: 0eda7cd8f1446c5565bb4720ac8d633babc30653ef242fdf61e65fae1dd924ee
+  metadata.gz: 654b0dc7674b00f784802b512f8307f9ca68f86fdf53853ede30e2bdb643a67f
+  data.tar.gz: c132c6399545bd7b89b47d895cb397f1ccdcda5d85c34ef9864de2d8c64ce42f
 SHA512:
-  metadata.gz: 2aa309d328946d8bf4bcaeeb46a0445388941105107ff5b9d079bd15138b8ad3785bc210a1b11f7ea24c52a7ba5817becf41b0897640e32ee95ddb8be4e69b31
-  data.tar.gz: 2166ccfb776ea3ffd52a63fca25e5066ea3d867698f29bf02be4a51f33b7f4c360acb2da9d9e1588e3774b35e3d30d900d2584a82ef0065b65718c194c6308d3
+  metadata.gz: 04ea361c7696ca069519523668caf8adc9bac1ed3e3a89ef17a14de2f19807ff9c8006cd9ca3bcd2a46fdcfc1dd1c88cc90ea5c4aa2f312de72015d97606c201
+  data.tar.gz: fd69e42c506a87a830b051334cee9b5df6162dffdae2a449859d24045782be505039899e08a307c31774bca097cedf1e55268e3ff72a26e2b120859920929220

data/README.md

@@ -12,7 +12,7 @@ information. See the <a href="https://curationexperts.github.io/zizia/">Getting
 
 [![Gem Version](https://badge.fury.io/rb/zizia.svg)](https://badge.fury.io/rb/zizia)
 [![CircleCI](https://circleci.com/gh/curationexperts/zizia.svg?style=svg)](https://circleci.com/gh/curationexperts/zizia)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/zizia) [![Coverage Status](https://coveralls.io/repos/github/curationexperts/zizia/badge.svg?branch=coveralls)](https://coveralls.io/github/curationexperts/zizia?branch=coveralls)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/zizia) [![Coverage Status](https://coveralls.io/repos/github/curationexperts/zizia/badge.svg?branch=master)](https://coveralls.io/github/curationexperts/zizia?branch=master)
 
 </td></tr>
 </table>
@@ -72,7 +72,13 @@ Zizia can be installed as a Rails Engine in a Hyrax application. To use the Zizi
 helper Zizia::Engine.helpers
 ```
 
-3. Add documentation and sample csv files to your project at
+3. Give admin users permission to import in your `Ability.custom_permissions`:
+
+```
+    can :manage, Zizia::CsvImport if current_user.admin?
+```
+
+4. Add documentation and sample csv files to your project at
 
 `app/assets/csv/import_manifest.csv`
 
@@ -80,7 +86,12 @@ and
 
 `app/assets/markdown/importer_guide.md`
 
-4. Add links to `/csv_imports/new` and `/importer_documentation/csv` in the Hyrax dashboard
+5. Add links to `/csv_imports/new` and `/importer_documentation/csv` in the Hyrax dashboard
+
+The `spec/dummy` folder in this application is a complete Hyrax application with Zizia installed. 
+You can use that as an example for adding this to your current Hyrax application or copy that
+to create a new application with Zizia installed. 
+
 
 ## Development
 

data/lib/zizia/engine.rb

@@ -4,11 +4,19 @@ require 'rails/all'
 require 'carrierwave'
 require 'carrierwave/orm/activerecord'
 require 'redcarpet'
+require 'devise'
+require 'hyrax'
+require 'riiif'
+require 'hydra-role-management'
 
 module Zizia
   class Engine < ::Rails::Engine
     isolate_namespace Zizia
 
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
     initializer :zizia_assets_precompile do |app|
       app.config.assets.precompile << %w[zizia/application.js zizia/application.css]
     end

data/lib/zizia/hyrax/hyrax_default_updater.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Zizia
+  class HyraxDefaultUpdater < HyraxMetadataOnlyUpdater
+    attr_reader :attrs
+
+    def actor_stack
+      terminator = Hyrax::Actors::Terminator.new
+      Hyrax::DefaultMiddlewareStack.build_stack.build(terminator)
+    end
+  end
+end

data/lib/zizia/hyrax/hyrax_delete_files_updater.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Zizia
+  class HyraxDeleteFilesUpdater < HyraxMetadataOnlyUpdater
+    attr_reader :attrs
+
+    def actor_stack
+      terminator = Hyrax::Actors::Terminator.new
+      Hyrax::DefaultMiddlewareStack.build_stack.build(terminator)
+    end
+
+    def update
+      existing_record.file_sets.map(&:destroy)
+      super
+    end
+  end
+end

data/lib/zizia/hyrax/hyrax_metadata_only_updater.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Zizia
+  class HyraxMetadataOnlyUpdater
+    attr_accessor :depositor,
+                  :existing_record,
+                  :update_record,
+                  :based_near_attributes,
+                  :csv_import_detail
+
+    def initialize(csv_import_detail:,
+                   existing_record:,
+                   update_record:,
+                   attrs:)
+      @csv_import_detail = csv_import_detail
+      @depositor = ::User.find(csv_import_detail.depositor_id)
+      @update_record = update_record
+      @existing_record = existing_record
+      @attrs = attrs
+    end
+
+    def attrs
+      @attrs.reject { |k, _v| k == :uploaded_files }
+    end
+
+    def actor_stack
+      terminator = Hyrax::Actors::Terminator.new
+      Zizia::MetadataOnlyStack.build_stack.build(terminator)
+    end
+
+    def started
+      Rails.logger.info "[zizia] event: record_update_started, batch_id: #{csv_import_detail.batch_id}, collection_id: #{csv_import_detail.collection_id}, #{csv_import_detail.deduplication_field}: #{update_record.respond_to?(csv_import_detail.deduplication_field) ? update_record.send(csv_import_detail.deduplication_field.deduplication_field) : update_record}"
+    end
+
+    def succeeded
+      Rails.logger.info "[zizia] event: record_updated, batch_id: #{csv_import_detail.batch_id}, record_id: #{csv_import_detail.existing_record.id}, collection_id: #{csv_import_detail.collection_id}, #{csv_import_detail.deduplication_field}: #{existing_record.respond_to?(csv_import_detail.deduplication_field) ? existing_record.send(csv_import_detail.deduplication_field) : existing_record}"
+    end
+
+    def failed(attr)
+      Rails.logger.error "[zizia] event: validation_failed, batch_id: #{csv_import_detail.batch_id}, collection_id: #{csv_import_detail.collection_id}, attribute: #{attr.capitalize}, message: #{msg}, record_title: record_title: #{attrs[:title] ? attrs[:title] : attrs}"
+    end
+
+    def create_actor_env
+      Hyrax::Actors::Environment.new(existing_record, ::Ability.new(depositor), attrs)
+    end
+
+    def update
+      if actor_stack.update(create_actor_env)
+        csv_import_detail.success_count += 1
+      else
+        existing_record.errors.each_key do |attr, _msg|
+          failed(attr)
+        end
+        csv_import_detail.failure_count += 1
+      end
+      csv_import_detail.save
+    end
+  end
+end

data/lib/zizia/{hyrax_record_importer.rb → hyrax/hyrax_record_importer.rb}

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-
 module Zizia
   class HyraxRecordImporter < RecordImporter
     # TODO: Get this from Hyrax config
     DEFAULT_CREATOR_KEY = 'batchuser@example.com'
 
+    attr_accessor :csv_import_detail
+
     # @!attribute [rw] depositor
     # @return [User]
     attr_accessor :depositor
@@ -45,18 +46,20 @@ module Zizia
     #                 deduplication_field: 'legacy_id'
     #               }
     def initialize(attributes: {})
-      self.collection_id = attributes[:collection_id]
-      self.batch_id = attributes[:batch_id]
-      self.deduplication_field = attributes[:deduplication_field]
-      set_depositor(attributes[:depositor_id])
-      @success_count = 0
-      @failure_count = 0
+      # These attributes are persisted in the CsvImportDetail model
+      @csv_import_detail = attributes[:csv_import_detail]
+      @deduplication_field = csv_import_detail.deduplication_field
+      @collection_id = csv_import_detail.collection_id
+      @batch_id = csv_import_detail.batch_id
+      @success_count = csv_import_detail.success_count
+      @failure_count = csv_import_detail.failure_count
+      find_depositor(csv_import_detail.depositor_id)
     end
 
     # "depositor" is a required field for Hyrax.  If
     # it hasn't been set, set it to the Hyrax default
     # batch user.
-    def set_depositor(user_key)
+    def find_depositor(user_key)
       user = ::User.find_by_user_key(user_key) if user_key
       user ||= ::User.find(user_key) if user_key
       user ||= ::User.find_or_create_system_user(DEFAULT_CREATOR_KEY)
@@ -118,7 +121,7 @@ module Zizia
       uploaded_file_ids = []
       files_to_attach.each do |filename|
         file = File.open(find_file_path(filename))
-        uploaded_file = Hyrax::UploadedFile.create(user: @depositor, file: file)
+        uploaded_file = Hyrax::UploadedFile.create(user: depositor, file: file)
         uploaded_file_ids << uploaded_file.id
         file.close
       end
@@ -177,45 +180,45 @@ module Zizia
 
     private
 
-      # Build a pared down actor stack that will not re-attach files,
-      # or set workflow, or do anything except update metadata.
-      # TODO: We should be able to set an environment variable that would allow updates to go through the regular
-      # actor stack instead of the stripped down one, in case we want to re-import files.
-      def metadata_only_middleware
-        terminator = Hyrax::Actors::Terminator.new
-        Zizia::MetadataOnlyStack.build_stack.build(terminator)
-      end
-
       # Update an existing object using the Hyrax actor stack
       # We assume the object was created as expected if the actor stack returns true.
       # Note that for now the update stack will only update metadata and update collection membership, it will not re-import files.
       def update_for(existing_record:, update_record:)
-        Rails.logger.info "[zizia] event: record_update_started, batch_id: #{batch_id}, collection_id: #{collection_id}, #{deduplication_field}: #{update_record.respond_to?(deduplication_field) ? update_record.send(deduplication_field) : update_record}"
+        updater = case csv_import_detail.update_actor_stack
+                  when 'HyraxMetadataOnly'
+                    Zizia::HyraxMetadataOnlyUpdater.new(csv_import_detail: csv_import_detail,
+                                                        existing_record: existing_record,
+                                                        update_record: update_record,
+                                                        attrs: process_attrs(record: update_record))
+                  when 'HyraxDelete'
+                    Zizia::HyraxDeleteFilesUpdater.new(csv_import_detail: csv_import_detail,
+                                                       existing_record: existing_record,
+                                                       update_record: update_record,
+                                                       attrs: process_attrs(record: update_record))
+                  when 'HyraxOnlyNew'
+                    return unless existing_record[deduplication_field] != update_record.try(deduplication_field)
+                    Zizia::HyraxDefaultUpdater.new(csv_import_detail: csv_import_detail,
+                                                   existing_record: existing_record,
+                                                   update_record: update_record,
+                                                   attrs: process_attrs(record: update_record))
+                  end
+        updater.update
+      end
+
+      def process_attrs(record:)
         additional_attrs = {
-          depositor: @depositor.user_key
+          uploaded_files: create_upload_files(record),
+          depositor: depositor.user_key
         }
-        attrs = update_record.attributes.merge(additional_attrs)
+
+        attrs = record.attributes.merge(additional_attrs)
         attrs = attrs.merge(member_of_collections_attributes: { '0' => { id: collection_id } }) if collection_id
+
         # Ensure nothing is passed in the files field,
         # since this is reserved for Hyrax and is where uploaded_files will be attached
         attrs.delete(:files)
-
-        # We aren't using the attach remote files actor, so make sure any remote files are removed from the params before we try to save the object.
-        attrs.delete(:remote_files)
-
         based_near = attrs.delete(:based_near)
-        attrs = attrs.merge(based_near_attributes: based_near_attributes(based_near)) unless based_near.nil? || based_near.empty?
-
-        actor_env = Hyrax::Actors::Environment.new(existing_record, ::Ability.new(@depositor), attrs)
-        if metadata_only_middleware.update(actor_env)
-          Rails.logger.info "[zizia] event: record_updated, batch_id: #{batch_id}, record_id: #{existing_record.id}, collection_id: #{collection_id}, #{deduplication_field}: #{existing_record.respond_to?(deduplication_field) ? existing_record.send(deduplication_field) : existing_record}"
-          @success_count += 1
-        else
-          existing_record.errors.each do |attr, msg|
-            Rails.logger.error "[zizia] event: validation_failed, batch_id: #{batch_id}, collection_id: #{collection_id}, attribute: #{attr.capitalize}, message: #{msg}, record_title: record_title: #{attrs[:title] ? attrs[:title] : attrs}"
-          end
-          @failure_count += 1
-        end
+        attrs.merge(based_near_attributes: based_near_attributes(based_near)) unless based_near.nil? || based_near.empty?
       end
 
       # Create an object using the Hyrax actor stack
@@ -223,36 +226,22 @@ module Zizia
       def create_for(record:)
         Rails.logger.info "[zizia] event: record_import_started, batch_id: #{batch_id}, collection_id: #{collection_id}, record_title: #{record.respond_to?(:title) ? record.title : record}"
 
-        additional_attrs = {
-          uploaded_files: create_upload_files(record),
-          depositor: @depositor.user_key
-        }
-
         created = import_type.new
-
-        attrs = record.attributes.merge(additional_attrs)
-        attrs = attrs.merge(member_of_collections_attributes: { '0' => { id: collection_id } }) if collection_id
-
-        # Ensure nothing is passed in the files field,
-        # since this is reserved for Hyrax and is where uploaded_files will be attached
-        attrs.delete(:files)
-
-        based_near = attrs.delete(:based_near)
-        attrs = attrs.merge(based_near_attributes: based_near_attributes(based_near)) unless based_near.nil? || based_near.empty?
-
+        attrs = process_attrs(record: record)
         actor_env = Hyrax::Actors::Environment.new(created,
-                                                   ::Ability.new(@depositor),
+                                                   ::Ability.new(depositor),
                                                    attrs)
 
         if Hyrax::CurationConcern.actor.create(actor_env)
           Rails.logger.info "[zizia] event: record_created, batch_id: #{batch_id}, record_id: #{created.id}, collection_id: #{collection_id}, record_title: #{attrs[:title]&.first}"
-          @success_count += 1
+          csv_import_detail.success_count += 1
         else
           created.errors.each do |attr, msg|
             Rails.logger.error "[zizia] event: validation_failed, batch_id: #{batch_id}, collection_id: #{collection_id}, attribute: #{attr.capitalize}, message: #{msg}, record_title: record_title: #{attrs[:title] ? attrs[:title] : attrs}"
           end
-          @failure_count += 1
+          csv_import_detail.failure_count += 1
         end
+        csv_import_detail.save
       end
   end
 end

data/lib/zizia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zizia
-  VERSION = '3.1.0.alpha.01'
+  VERSION = '4.0.0.alpha.01'
 end

data/lib/zizia.rb

@@ -35,10 +35,10 @@ module Zizia
   require 'zizia/version'
   require 'zizia/metadata_mapper'
   require 'zizia/hash_mapper'
-  require 'zizia/hyrax_basic_metadata_mapper'
+  require 'zizia/hyrax/hyrax_basic_metadata_mapper'
   require 'zizia/importer'
   require 'zizia/record_importer'
-  require 'zizia/hyrax_record_importer'
+  require 'zizia/hyrax/hyrax_record_importer'
   require 'zizia/input_record'
   require 'zizia/validator'
   require 'zizia/validators/csv_format_validator'
@@ -59,5 +59,8 @@ module Zizia
   @configuration = Configuration.new
 
   require 'zizia/parsers/csv_parser'
-  require 'zizia/metadata_only_stack'
+  require 'zizia/hyrax/metadata_only_stack'
+  require 'zizia/hyrax/hyrax_metadata_only_updater'
+  require 'zizia/hyrax/hyrax_default_updater'
+  require 'zizia/hyrax/hyrax_delete_files_updater'
 end