zizia 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c996cb008f5c2688ad0268f351e7ece835fa9822c6b1d95cee5744df9efead9
-  data.tar.gz: dd746445e693cc7a941f0670cfc3eb6e0ef0c674d0844975825a94673150e097
+  metadata.gz: a2ce3c9e0a30e76c3f33a6341945b902801c6ef1efbc131e0c8a19182f71eb71
+  data.tar.gz: 37c8b43375005b6e247b87341309e9d45146bf0aebb4297bcd8efb8ccc7128a8
 SHA512:
-  metadata.gz: c9094c26f6385c215dc138d8a50495cc08f5962b732d3ba483de63d9c055a1ebebee7d7a01c5b33bb948c983777ebd2eee5b16abf0d7402e03cbe3940f7be16a
-  data.tar.gz: b595f80d8f66d3fbd0e46a14a7b2baeab74f6feccfafd7f4aa14d249f4fb7c5a01da001848bb652b0b70f17b49d03c089845edca30485ab569456621b891deef
+  metadata.gz: 970072b31940c2bacfaaa46f5889d334dffc699a4c3bbfd539994ed035bf674717e612b32a798b514ea028e7523b4df79ae7f7618ecba656572141d2a9923325
+  data.tar.gz: 6d895774afd95f9ef4a1ef90944212be27627ff70ddde86562d0471dc00c62d705c162410530836587421e1ce4d0c18fb6ca413f1af2b9721259a49d2b87367d

data/README.md

@@ -17,40 +17,58 @@ Object import for Hyrax.
 ## Usage
 
 In your project's `Gemfile`, add: `gem 'zizia'`, then run `bundle install`.
+1. Require 'zizia' in your `config/application.rb` file: 
 
-1. Add the engine to `routes.rb`:
+```
+module MyApplication
+  class Application < Rails::Application
+    require 'zizia'
+```
+
+2. Add the engine to `routes.rb`:
 ```
   mount Zizia::Engine => '/'
 ```
 
-2. Add the helpers to the `ApplicationController`
+3. Add the helpers to the `ApplicationController`
 
 ```
 helper Zizia::Engine.helpers
 ```
 
-3. Give admin users permission to import in your `Ability.custom_permissions`:
+4. Give admin users permission to import in your `Ability.custom_permissions`:
 
 ```
     can :manage, Zizia::CsvImport if current_user.admin?
     can :manage, Zizia::CsvImportDetail if current_user.admin?
 ```
 
-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. 
 
-5. In your Rails application's `application.css` and `application.js` include Zizia's assets:
+6. In your Rails application's `application.css` and `application.js` include Zizia's assets:
 
 ```
  *= require zizia/application
 ```
 
-6. Run `rake db:migrate`
+7. Run `rake db:migrate`
 
 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. 
 
-To do a basic Hyrax import, first ensure that a [work type is registered](http://www.rubydoc.info/github/samvera/hyrax/Hyrax/Configuration#register_curation_concern-instance_method)
+8. Add a deduplication_key to your default work type's medata:
+
+```
+  property :deduplication_key, predicate: "http://curationexperts.com/vocab/predicates#deduplicationKey", multiple: false do |index|
+    index.as :stored_searchable
+  end
+```
+
+9. If you are using the default [Hyrax metadata profile](https://samvera.github.io/metadata_application_profile.html) aka `Hyrax::BasicMetadata`, you are ready to download a sample CSV and start importing. 
+
+
+If you aren't using `Hyrax::BasicMedata` you'll need to create a custom `importer` and `mapper` class. First ensure that a [work type is registered](http://www.rubydoc.info/github/samvera/hyrax/Hyrax/Configuration#register_curation_concern-instance_method)
 with your `Hyrax` application. Then write a class like this:
 
 ```ruby
@@ -84,9 +102,9 @@ environment variables called `IMPORT_PATH`. If `IMPORT_PATH` is not set, `HyraxR
 
 ## Testing
 
-To run Solr and Fedora for testing purposes: 
+To run Solr and Fedora for testing purposes, open a new terminal session for each and run the following commads: 
 
-`solr_wrapper --config spec/dummy/config/solr_wrapper_test.yml`
+`solr_wrapper --config spec/dummy/config/solr_wrapper_test.yml`  
 `fcrepo_wrapper --config spec/dummy/config/fcrepo_wrapper_test.yml`
 
 After this you can run the whole suite, or individual specs. System specs are located

data/app/importers/modular_importer.rb

@@ -32,11 +32,12 @@ class ModularImporter
     }
 
     Rails.logger.info "[zizia] event: start_import, batch_id: #{@csv_import.id}, collection_id: #{@collection_id}, user: #{@user_email}"
+
     importer = Zizia::Importer.new(parser: Zizia::CsvParser.new(file: file), record_importer: Zizia::HyraxRecordImporter.new(attributes: attrs))
 
     importer.records.each_with_index do |record, index|
-      pre_ingest_work = Zizia::PreIngestWork.new(csv_import_detail_id: csv_import_detail.id, deduplication_key: record.mapper.metadata["deduplication_key"])
-
+      pre_ingest_work = Zizia::PreIngestWork.find_or_create_by(deduplication_key: record.mapper.metadata['deduplication_key'])
+      pre_ingest_work.csv_import_detail_id = csv_import_detail.id
       record.mapper.files.each do |child_file|
         full_path = Dir.glob("#{ENV['IMPORT_PATH']}/**/#{child_file}").first
         pre_ingest_file = Zizia::PreIngestFile.new(row_number: index + 1,

data/app/models/zizia/pre_ingest_work.rb

@@ -2,5 +2,15 @@
 module Zizia
   class PreIngestWork < ::ApplicationRecord
     has_many :pre_ingest_files
+
+    # Returns the title based on the deduplication_key if the work has been indexed to solr
+    # @return [String] the work's title
+    def title
+      return 'This work does not have a deduplication key.' if deduplication_key.nil?
+      solr_title = ActiveFedora::SolrService.get("deduplication_key_tesim:#{deduplication_key}")
+                                            .dig('response', 'docs', 0, 'title_tesim', 0)
+      return solr_title unless solr_title.nil?
+      'This work\'s metadata has not been indexed yet.'
+    end
   end
 end

data/app/views/zizia/csv_import_details/_pre_ingest_files_table.html.erb

@@ -0,0 +1,24 @@
+<table id="files-table" class="dataTable display responsive nowrap table table-striped works-list" style="width:100%">
+  <tr>
+    <th>Filename</th>
+    <th>Size</th>
+    <th>Row Number</th>
+    <th>Date Created</th>
+  </tr>
+  <% pre_ingest_work.pre_ingest_files.each do |pre_ingest_file| %>
+    <tr>
+      <td>
+        <%= pre_ingest_file.basename %>
+      </td>
+      <td>
+        <%= number_to_human_size(pre_ingest_file.size) %>
+      </td>
+      <td>
+        <%= pre_ingest_file.row_number %>
+      </td>
+      <td>
+        <%= pre_ingest_file.created_at.strftime("%B %-d, %Y %H:%M") %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/zizia/csv_import_details/show.html.erb

@@ -7,26 +7,30 @@
     <li>Total Size: <%= number_to_human_size(@csv_import_detail.total_size) %></li>
   </ul>
 
-  <h3>Files</h3>
-  <table id="files-table" class="dataTable display responsive nowrap table table-striped works-list" style="width:100%">
+  <h3>Works & Files</h3>
+
+  <table id="works-table" class="table works-list">
     <tr>
-      <th>Filename</th>
-      <th>Size</th>
-      <th>Row Number</th>
+      <th>Deduplication Key</th>
+      <th>Title</th>
+      <th>Files</th>
+      <th>Date</th>
     </tr>
-
-    <% @csv_import_detail.pre_ingest_files.each do |pre_ingest_file| %>
-      <tr>
-        <td>
-          <%= pre_ingest_file.basename %>
-        </td>
-        <td>
-          <%= number_to_human_size(pre_ingest_file.size) %>
-        </td>
-        <td>
-          <%= pre_ingest_file.row_number %>
-        </td>
-      </tr>
-    <% end %>
+  <% @csv_import_detail.pre_ingest_works.each do |pre_ingest_work| %>
+    <tr>
+      <td>
+        <%= pre_ingest_work.deduplication_key%>
+      </td>
+      <td>
+        <%= pre_ingest_work.title %>
+      </td>
+      <td>
+        <%= render 'pre_ingest_files_table', pre_ingest_work: pre_ingest_work %>
+      </td>
+      <td>
+        <%= pre_ingest_work.created_at.strftime("%B %-d, %Y %H:%M") %>
+      </td>
+    </tr>
+  <% end %>
   </table>
 </div>

data/db/migrate/20191105165518_add_uniqueness_constraint_to_pre_ingest_work_deduplication_key.rb

@@ -0,0 +1,7 @@
+class AddUniquenessConstraintToPreIngestWorkDeduplicationKey < ActiveRecord::Migration[5.1]
+  def change
+    remove_index :zizia_pre_ingest_works, :deduplication_key if index_exists?(:zizia_pre_ingest_works, :deduplication_key)
+
+    add_index :zizia_pre_ingest_works, :deduplication_key, unique: true
+  end
+end

data/db/migrate/20191105211127_remove_uniqueness_constraint_to_pre_ingest_work_deduplication_key.rb

@@ -0,0 +1,7 @@
+class RemoveUniquenessConstraintToPreIngestWorkDeduplicationKey < ActiveRecord::Migration[5.1]
+  def change
+    remove_index :zizia_pre_ingest_works, :deduplication_key if index_exists?(:zizia_pre_ingest_works, :deduplication_key)
+
+    add_index :zizia_pre_ingest_works, :deduplication_key, unique: false
+  end
+end

data/lib/zizia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zizia
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/spec/dummy/.fcrepo_wrapper

@@ -1,4 +1,5 @@
 # Place any default configuration for solr_wrapper here
+version: 4.7.5
 port: 8984
 enable_jms: false
 fcrepo_home_dir: tmp/fcrepo4-development-data

data/spec/dummy/.solr_wrapper

@@ -1,5 +1,5 @@
 # Place any default configuration for solr_wrapper here
-# version: 6.0.0
+version: 7.7.2
 # port: 8983
 instance_dir: tmp/solr-development
 collection:

data/spec/dummy/app/models/work.rb

@@ -8,6 +8,10 @@ class Work < ActiveFedora::Base
   # self.valid_child_concerns = []
   validates :title, presence: { message: 'Your work must have a title.' }
 
+
+  property :deduplication_key, predicate: 'http://metadata.example.com/vocab/predicates#deduplicationKey', multiple: false do |index|
+    index.as :stored_searchable
+  end
   # This must be included at the end, because it finalizes the metadata
   # schema (by adding accepts_nested_attributes)
   include ::Hyrax::BasicMetadata

data/spec/dummy/config/fcrepo_wrapper_test.yml

@@ -1,4 +1,5 @@
 #config/fcrepo_wrapper_test.yml.sample
 port: 8986
 enable_jms: false
+version: 4.7.5
 fcrepo_home_dir: tmp/fcrepo4-test-data

data/spec/dummy/config/solr_wrapper_test.yml

@@ -1,5 +1,5 @@
 #config/solr_wrapper_test.yml
-version: 6.1.0
+version: 7.7.2
 port: 8985
 instance_dir: tmp/solr-test
 collection:

data/spec/dummy/spec/system/csv_import_details_page_spec.rb

@@ -33,6 +33,7 @@ RSpec.describe 'viewing the csv import detail page' do
     expect(page).to have_content('undetermined')
     click_on '1'
     expect(page).to have_content('Total Size')
+    expect(page).to have_content('Deduplication Key')
   end
 
   it 'has links to sort' do

data/spec/dummy/spec/system/import_from_csv_spec.rb

@@ -246,9 +246,13 @@ RSpec.describe 'Importing records from a CSV file', :perform_jobs, :clean, type:
       # Viewing additional details after an import
       visit "/csv_import_details/index"
       expect(page).to have_content('Total Size')
-      find(:xpath, '//*[@id="content-wrapper"]/div[2]/table/tbody/tr[3]/td[1]/a').click
+      click_on '4'
       expect(page).to have_content('dog.jpg')
+      expect(page).to have_content('cat.jpg')
       expect(page).to have_content('5.74 MB')
+      expect(page).to have_content('abc/123')
+      expect(page).to have_content('This work\'s metadata has not been indexed yet.')
+      expect(page).to have_content('Date Created')
     end
   end
 end

data/spec/models/zizia/pre_ingest_work_spec.rb

@@ -2,8 +2,23 @@
 require 'rails_helper'
 
 RSpec.describe Zizia::PreIngestWork do
-  let(:pre_ingest_work) { FactoryBot.create(:pre_ingest_work, deduplication_key: "42") }
+  let(:pre_ingest_work) { FactoryBot.create(:pre_ingest_work, deduplication_key: '42') }
+  let(:pre_ingest_work_indexed) { FactoryBot.create(:pre_ingest_work, deduplication_key: '43') }
+  let(:work) { Work.new(title: ['A Nice Title'], deduplication_key: '43') }
+
+  before do
+    work.save
+  end
+
   it 'has a deduplication_key' do
-    expect(pre_ingest_work.deduplication_key).to eq "42"
+    expect(pre_ingest_work.deduplication_key).to eq '42'
+  end
+
+  it 'can return that metadata has not been indexed yet' do
+    expect(pre_ingest_work.title).to eq('This work\'s metadata has not been indexed yet.')
+  end
+
+  it 'can return a title for a work based on the deduplication key' do
+    expect(pre_ingest_work_indexed.title).to eq('A Nice Title')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zizia
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Data Curation Experts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -682,6 +682,7 @@ files:
 - app/uploaders/zizia/csv_manifest_uploader.rb
 - app/uploaders/zizia/csv_manifest_validator.rb
 - app/views/layouts/zizia/application.html.erb
+- app/views/zizia/csv_import_details/_pre_ingest_files_table.html.erb
 - app/views/zizia/csv_import_details/_toggle_my_imports.html.erb
 - app/views/zizia/csv_import_details/index.html.erb
 - app/views/zizia/csv_import_details/show.html.erb
@@ -720,6 +721,8 @@ files:
 - db/migrate/20190923182946_add_update_actor_stack_to_csv_import_detail.rb
 - db/migrate/20191029162902_add_status_to_csv_import_detail.rb
 - db/migrate/20191031131041_add_deduplication_key_to_pre_ingest_work.rb
+- db/migrate/20191105165518_add_uniqueness_constraint_to_pre_ingest_work_deduplication_key.rb
+- db/migrate/20191105211127_remove_uniqueness_constraint_to_pre_ingest_work_deduplication_key.rb
 - docs/_config.yml
 - docs/customizing_metadata.md
 - docs/index.md
@@ -775,7 +778,6 @@ files:
 - spec/dummy/.rspec
 - spec/dummy/.ruby-version
 - spec/dummy/.solr_wrapper
-- spec/dummy/.solr_wrapper.yml
 - spec/dummy/Gemfile
 - spec/dummy/README.md
 - spec/dummy/Rakefile
@@ -1563,7 +1565,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Hyrax importers.

data/spec/dummy/.solr_wrapper.yml

@@ -1,5 +0,0 @@
-# Place any default configuration for solr_wrapper here
-# port: 8983
-collection:
-  dir: solr/conf/
-  name: blacklight-core