bulkrax 3.5.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d9849522210958f0a64f21b8c5737f9cf0e0a7f7b9dc7e35d91cb429e5b8fb5
-  data.tar.gz: 4be9893422301b2cbf10af36ccf90898d2bfbc816ed832dd7ad686b2d0b30fcc
+  metadata.gz: eb56d86ee90ae9e1cf0628504694e1301ab8f2d6b24ffa8fd323f8953a8ee956
+  data.tar.gz: 71056b077e300f27eee3bcccd9d7e2bee2fc7bdf2fc6ba9248b69a29f3994f9c
 SHA512:
-  metadata.gz: ae33b239d56a10d82616c7966c47a599d69a6148641b507dd7bbe5e94509e9b3afd633011fe0028e2b1949c1677ad8cb1e456478a2074fd536d9b262913b9460
-  data.tar.gz: af4ba8cc3d9d3f68e931bea1bc4023c57789c21716108416c760f303b931d2bca9b38dbd6fa704e235e286b03bd38ce214346f3b35039036326cad978879c934
+  metadata.gz: 05ea49e6f2c5e73cbddacf35dcaf9de499760d7093e3ae8f3ce4ea5ab28e25d065b7877607436fcbe02d21e17c2df940b0224f1ea7d638a602486ce807d99981
+  data.tar.gz: ecdda29924e09793e62684f16ebcd79cd90ab9e8204d011b89a577ca667a644709ff2df5b525ac6c32355426038c05d9fc3d74c6efb20ee7cfab653d9b89b67a

data/README.md

@@ -70,7 +70,7 @@ Bulkrax.setup do |config|
 end
 ```
 
-The [configuration guide](https://github.com/samvera-labs/bulkrax/wiki/Configuration) provides detailed instructions on the various available configurations.
+The [configuration guide](https://github.com/samvera-labs/bulkrax/wiki/Configuring-Bulkrax) provides detailed instructions on the various available configurations.
 
 Example:
 
@@ -120,7 +120,7 @@ It's unlikely that the incoming import data has fields that exactly match those
 
 By default, a mapping for the OAI parser has been added to map standard oai_dc fields to Hyrax basic_metadata. The other parsers have no default mapping, and will map any incoming fields to Hyrax properties with the same name. Configurations can be added in `config/intializers/bulkrax.rb`
 
-Configuring field mappings is documented in the [Bulkrax Configuration Guide](https://github.com/samvera-labs/bulkrax/wiki/Configuration).
+Configuring field mappings is documented in the [Bulkrax Configuration Guide](https://github.com/samvera-labs/bulkrax/wiki/Configuring-Bulkrax).
 
 ## Importing Files
 
@@ -151,7 +151,7 @@ end
 
 ## Customizing Bulkrax
 
-For further information on how to extend and customize Bulkrax, please see the [Bulkrax Customization Guide](https://github.com/samvera-labs/bulkrax/wiki/Customizing).
+For further information on how to extend and customize Bulkrax, please see the [Bulkrax Customization Guide](https://github.com/samvera-labs/bulkrax/wiki/Customizing-Bulkrax).
 
 ## How it Works
 Once you have Bulkrax installed, you will have access to an easy to use interface with which you are able to create, edit, delete, run, and re-run imports and exports.
@@ -191,8 +191,6 @@ We encourage everyone to help improve this project.  Bug reports and pull reques
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
-All Contributors should have signed the Samvera Contributor License Agreement (CLA)
-
 ## Questions
 Questions can be sent to support@notch8.com. Please make sure to include "Bulkrax" in the subject line of your email.
 

data/app/controllers/bulkrax/exporters_controller.rb

@@ -127,7 +127,7 @@ module Bulkrax
     # Download methods
 
     def file_path
-      @exporter.exporter_export_zip_path
+      "#{@exporter.exporter_export_zip_path}/#{params['exporter']['exporter_export_zip_files']}"
     end
   end
 end

data/app/models/bulkrax/entry.rb

@@ -4,8 +4,6 @@ module Bulkrax
   # Custom error class for collections_created?
   class CollectionsCreatedError < RuntimeError; end
   class OAIError < RuntimeError; end
-  # TODO: remove when ApplicationParser#bagit_zip_file_size_check is removed
-  class BagitZipError < RuntimeError; end
   class Entry < ApplicationRecord
     include Bulkrax::HasMatchers
     include Bulkrax::ImportBehavior

data/app/models/bulkrax/exporter.rb

@@ -124,9 +124,13 @@ module Bulkrax
     end
 
     def exporter_export_zip_path
-      @exporter_export_zip_path ||= File.join(parser.base_path('export'), "export_#{self.id}_#{self.exporter_runs.last.id}.zip")
+      @exporter_export_zip_path ||= File.join(parser.base_path('export'), "export_#{self.id}_#{self.exporter_runs.last.id}")
     rescue
-      @exporter_export_zip_path ||= File.join(parser.base_path('export'), "export_#{self.id}_0.zip")
+      @exporter_export_zip_path ||= File.join(parser.base_path('export'), "export_#{self.id}_0")
+    end
+
+    def exporter_export_zip_files
+      @exporter_export_zip_files ||= Dir["#{exporter_export_zip_path}/**"].map { |zip| Array(zip.split('/').last) }
     end
 
     def export_properties
@@ -137,5 +141,14 @@ module Bulkrax
     def metadata_only?
       export_type == 'metadata'
     end
+
+    def sort_zip_files(zip_files)
+      zip_files.sort_by do |item|
+        number = item.split('_').last.match(/\d+/)&.[](0) || 0.to_s
+        sort_number = number.rjust(4, "0")
+
+        sort_number
+      end
+    end
   end
 end

data/app/models/concerns/bulkrax/export_behavior.rb

@@ -7,9 +7,6 @@ module Bulkrax
 
     def build_for_exporter
       build_export_metadata
-      # TODO(alishaevn): determine if the line below is still necessary
-      # the csv and bagit parsers also have write_files methods
-      write_files if export_type == 'full' && !importerexporter.parser_klass.include?('Bagit')
     rescue RSolr::Error::Http, CollectionsCreatedError => e
       raise e
     rescue StandardError => e
@@ -26,25 +23,6 @@ module Bulkrax
       @hyrax_record ||= ActiveFedora::Base.find(self.identifier)
     end
 
-    def write_files
-      return if hyrax_record.is_a?(Collection)
-
-      file_sets = hyrax_record.file_set? ? Array.wrap(hyrax_record) : hyrax_record.file_sets
-      file_sets << hyrax_record.thumbnail if hyrax_record.thumbnail.present? && hyrax_record.work? && exporter.include_thumbnails
-      file_sets.each do |fs|
-        path = File.join(exporter_export_path, 'files')
-        FileUtils.mkdir_p(path)
-        file = filename(fs)
-        require 'open-uri'
-        io = open(fs.original_file.uri)
-        next if file.blank?
-        File.open(File.join(path, file), 'wb') do |f|
-          f.write(io.read)
-          f.close
-        end
-      end
-    end
-
     # Prepend the file_set id to ensure a unique filename and also one that is not longer than 255 characters
     def filename(file_set)
       return if file_set.original_file.blank?

data/app/parsers/bulkrax/application_parser.rb

@@ -247,8 +247,6 @@ module Bulkrax
     def write
       write_files
       zip
-      # uncomment next line to debug for faulty zipping during bagit export
-      bagit_zip_file_size_check if importerexporter.parser_klass.include?('Bagit')
     end
 
     def unzip(file_to_unzip)
@@ -262,30 +260,13 @@ module Bulkrax
     end
 
     def zip
-      FileUtils.rm_rf(exporter_export_zip_path)
-      Zip::File.open(exporter_export_zip_path, create: true) do |zip_file|
-        Dir["#{exporter_export_path}/**/**"].each do |file|
-          zip_file.add(file.sub("#{exporter_export_path}/", ''), file)
-        end
-      end
-    end
+      FileUtils.mkdir_p(exporter_export_zip_path)
 
-    # TODO: remove Entry::BagitZipError as well as this method when we're sure it's not needed
-    def bagit_zip_file_size_check
-      Zip::File.open(exporter_export_zip_path) do |zip_file|
-        zip_file.select { |entry| entry.name.include?('data/') && entry.file? }.each do |zipped_file|
-          Dir["#{exporter_export_path}/**/data/*"].select { |file| file.include?(zipped_file.name) }.each do |file|
-            begin
-              raise BagitZipError, "Invalid Bag, file size mismatch for #{file.sub("#{exporter_export_path}/", '')}" if File.size(file) != zipped_file.size
-            rescue BagitZipError => e
-              matched_entry_ids = importerexporter.entry_ids.select do |id|
-                Bulkrax::Entry.find(id).identifier.include?(zipped_file.name.split('/').first)
-              end
-              matched_entry_ids.each do |entry_id|
-                Bulkrax::Entry.find(entry_id).status_info(e)
-                status_info('Complete (with failures)')
-              end
-            end
+      Dir["#{exporter_export_path}/**"].each do |folder|
+        zip_path = "#{exporter_export_zip_path.split('/').last}_#{folder.split('/').last}.zip"
+        Zip::File.open(File.join("#{exporter_export_zip_path}/#{zip_path}"), create: true) do |zip_file|
+          Dir["#{folder}/**/**"].each do |file|
+            zip_file.add(file.sub("#{folder}/", ''), file)
           end
         end
       end

data/app/parsers/bulkrax/bagit_parser.rb

@@ -113,6 +113,9 @@ module Bulkrax
       when 'importer'
         set_ids_for_exporting_from_importer
       end
+
+      find_child_file_sets(@work_ids) if importerexporter.export_from == 'collection' || importerexporter.export_from == 'worktype'
+
       @work_ids + @collection_ids + @file_set_ids
     end
 
@@ -122,18 +125,27 @@ module Bulkrax
     def write_files
       require 'open-uri'
       require 'socket'
+
+      folder_count = 1
+      records_in_folder = 0
+
       importerexporter.entries.where(identifier: current_record_ids)[0..limit || total].each do |entry|
         record = ActiveFedora::Base.find(entry.identifier)
         next unless Hyrax.config.curation_concerns.include?(record.class)
-        bag = BagIt::Bag.new setup_bagit_folder(entry.identifier)
+
         bag_entries = [entry]
+        file_set_entries = Bulkrax::CsvFileSetEntry.where(importerexporter_id: importerexporter.id).where("parsed_metadata LIKE '%#{record.id}%'")
+        file_set_entries.each { |fse| bag_entries << fse }
 
-        record.file_sets.each do |fs|
-          if @file_set_ids.present?
-            file_set_entry = Bulkrax::CsvFileSetEntry.where("parsed_metadata LIKE '%#{fs.id}%'").first
-            bag_entries << file_set_entry unless file_set_entry.nil?
-          end
+        records_in_folder += bag_entries.count
+        if records_in_folder > records_split_count
+          folder_count += 1
+          records_in_folder = bag_entries.count
+        end
+
+        bag ||= BagIt::Bag.new setup_bagit_folder(folder_count, entry.identifier)
 
+        record.file_sets.each do |fs|
           file_name = filename(fs)
           next if file_name.blank?
           io = open(fs.original_file.uri)
@@ -148,17 +160,21 @@ module Bulkrax
           end
         end
 
-        CSV.open(setup_csv_metadata_export_file(entry.identifier), "w", headers: export_headers, write_headers: true) do |csv|
+        CSV.open(setup_csv_metadata_export_file(folder_count, entry.identifier), "w", headers: export_headers, write_headers: true) do |csv|
           bag_entries.each { |csv_entry| csv << csv_entry.parsed_metadata }
         end
-        write_triples(entry)
+
+        write_triples(folder_count, entry)
         bag.manifest!(algo: 'sha256')
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
-    def setup_csv_metadata_export_file(id)
-      File.join(importerexporter.exporter_export_path, id, 'metadata.csv')
+    def setup_csv_metadata_export_file(folder_count, id)
+      path = File.join(importerexporter.exporter_export_path, folder_count.to_s)
+      FileUtils.mkdir_p(path) unless File.exist?(path)
+
+      File.join(path, id, 'metadata.csv')
     end
 
     def key_allowed(key)
@@ -167,21 +183,27 @@ module Bulkrax
         key != source_identifier.to_s
     end
 
-    def setup_triple_metadata_export_file(id)
-      File.join(importerexporter.exporter_export_path, id, 'metadata.nt')
+    def setup_triple_metadata_export_file(folder_count, id)
+      path = File.join(importerexporter.exporter_export_path, folder_count.to_s)
+      FileUtils.mkdir_p(path) unless File.exist?(path)
+
+      File.join(path, id, 'metadata.nt')
     end
 
-    def setup_bagit_folder(id)
-      File.join(importerexporter.exporter_export_path, id)
+    def setup_bagit_folder(folder_count, id)
+      path = File.join(importerexporter.exporter_export_path, folder_count.to_s)
+      FileUtils.mkdir_p(path) unless File.exist?(path)
+
+      File.join(path, id)
     end
 
-    def write_triples(e)
+    def write_triples(folder_count, e)
       sd = SolrDocument.find(e.identifier)
       return if sd.nil?
 
       req = ActionDispatch::Request.new({ 'HTTP_HOST' => Socket.gethostname })
       rdf = Hyrax::GraphExporter.new(sd, req).fetch.dump(:ntriples)
-      File.open(setup_triple_metadata_export_file(e.identifier), "w") do |triples|
+      File.open(setup_triple_metadata_export_file(folder_count, e.identifier), "w") do |triples|
         triples.write(rdf)
       end
     end

data/app/parsers/bulkrax/csv_parser.rb

@@ -4,6 +4,7 @@ require 'csv'
 module Bulkrax
   class CsvParser < ApplicationParser # rubocop:disable Metrics/ClassLength
     include ErroredEntries
+    include ExportBehavior
     attr_writer :collections, :file_sets, :works
 
     def self.export_supported?
@@ -207,6 +208,13 @@ module Bulkrax
       @work_ids + @collection_ids + @file_set_ids
     end
 
+    # find the related file set ids so entries can be made for export
+    def find_child_file_sets(work_ids)
+      work_ids.each do |id|
+        ActiveFedora::Base.find(id).file_set_ids.each { |fs_id| @file_set_ids << fs_id }
+      end
+    end
+
     # Set the following instance variables: @work_ids, @collection_ids, @file_set_ids
     # @see #current_record_ids
     def set_ids_for_exporting_from_importer
@@ -283,6 +291,10 @@ module Bulkrax
       @total = 0
     end
 
+    def records_split_count
+      1000
+    end
+
     # @todo - investigate getting directory structure
     # @todo - investigate using perform_later, and having the importer check for
     #   DownloadCloudFileJob before it starts
@@ -307,9 +319,37 @@ module Bulkrax
     # export methods
 
     def write_files
-      CSV.open(setup_export_file, "w", headers: export_headers, write_headers: true) do |csv|
-        importerexporter.entries.where(identifier: current_record_ids)[0..limit || total].each do |e|
-          csv << e.parsed_metadata
+      require 'open-uri'
+      folder_count = 0
+
+      importerexporter.entries.where(identifier: current_record_ids)[0..limit || total].in_groups_of(records_split_count, false) do |group|
+        folder_count += 1
+
+        CSV.open(setup_export_file(folder_count), "w", headers: export_headers, write_headers: true) do |csv|
+          group.each do |entry|
+            csv << entry.parsed_metadata
+            next if importerexporter.metadata_only? || entry.type == 'Bulkrax::CsvCollectionEntry'
+
+            store_files(entry.identifier, folder_count.to_s)
+          end
+        end
+      end
+    end
+
+    def store_files(identifier, folder_count)
+      record = ActiveFedora::Base.find(identifier)
+      file_sets = record.file_set? ? Array.wrap(record) : record.file_sets
+      file_sets << record.thumbnail if exporter.include_thumbnails && record.thumbnail.present? && record.work?
+      file_sets.each do |fs|
+        path = File.join(exporter_export_path, folder_count, 'files')
+        FileUtils.mkdir_p(path) unless File.exist? path
+        file = filename(fs)
+        io = open(fs.original_file.uri)
+        next if file.blank?
+
+        File.open(File.join(path, file), 'wb') do |f|
+          f.write(io.read)
+          f.close
         end
       end
     end
@@ -356,8 +396,11 @@ module Bulkrax
     end
 
     # in the parser as it is specific to the format
-    def setup_export_file
-      File.join(importerexporter.exporter_export_path, "export_#{importerexporter.export_source}_from_#{importerexporter.export_from}.csv")
+    def setup_export_file(folder_count)
+      path = File.join(importerexporter.exporter_export_path, folder_count.to_s)
+      FileUtils.mkdir_p(path) unless File.exist?(path)
+
+      File.join(path, "export_#{importerexporter.export_source}_from_#{importerexporter.export_from}_#{folder_count}.csv")
     end
 
     # Retrieve file paths for [:file] mapping in records

data/app/views/bulkrax/exporters/_downloads.html.erb

@@ -0,0 +1,8 @@
+<%= form.select :exporter_export_zip_files,
+  exporter.sort_zip_files(form.object.exporter_export_zip_files.flatten),
+  {},
+  {
+    class: 'btn btn-default form-control',
+    style: 'width: 200px'
+  }
+%>

data/app/views/bulkrax/exporters/index.html.erb

@@ -21,7 +21,7 @@
               <th scope="col">Name</th>
               <th scope="col">Status</th>
               <th scope="col">Date Exported</th>
-              <th scope="col"></th>
+              <th scope="col">Downloadable Files</th>
               <th scope="col"></th>
               <th scope="col"></th>
               <th scope="col"></th>
@@ -35,7 +35,10 @@
                 <td><%= exporter.created_at %></td>
                 <td>
                   <% if File.exist?(exporter.exporter_export_zip_path) %>
-                    <%= link_to raw('<span class="glyphicon glyphicon-download"></span>'), exporter_download_path(exporter) %>
+                    <%= simple_form_for(exporter, method: :get, url: exporter_download_path(exporter)) do |form| %>
+                      <%= render 'downloads', exporter: exporter, form: form %>
+                      <%= form.button :submit, value: 'Download', data: { disable_with: false } %>
+                    <% end %>
                   <% end%>
                 </td>
                 <td><%= link_to raw('<span class="glyphicon glyphicon-info-sign"></span>'), exporter_path(exporter) %></td>

data/app/views/bulkrax/exporters/show.html.erb

@@ -8,10 +8,11 @@
   <div class='panel-body'>
 
     <% if File.exist?(@exporter.exporter_export_zip_path) %>
-      <p class='bulkrax-p-align'>
+      <%= simple_form_for @exporter, method: :get, url: exporter_download_path(@exporter), html: { class: 'form-inline bulkrax-p-align' } do |form| %>
         <strong>Download:</strong>
-        <%= link_to raw('<span class="glyphicon glyphicon-download"></span>'), exporter_download_path(@exporter) %>
-      </p>
+        <%= render 'downloads', exporter: @exporter, form: form %>
+        <%= form.button :submit, value: 'Download', data: { disable_with: false } %>
+      <% end %>
     <% end %>
 
     <p class='bulkrax-p-align'>
@@ -135,10 +136,6 @@
       <%= page_entries_info(@work_entries) %><br>
       <%= paginate(@work_entries, param_name: :work_entries_page) %>
       <br>
-      <% if File.exist?(@exporter.exporter_export_zip_path) %>
-        <%= link_to 'Download', exporter_download_path(@exporter) %>
-        |
-      <% end %>
       <%= link_to 'Edit', edit_exporter_path(@exporter) %>
       |
       <%= link_to 'Back', exporters_path %>

data/lib/bulkrax/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bulkrax
-  VERSION = '3.5.1'
+  VERSION = '4.0.0'
 end

data/lib/tasks/bulkrax_tasks.rake

@@ -1,6 +1,30 @@
 # frozen_string_literal: true
 
-# desc "Explaining what the task does"
-# task :bulkrax do
-#   # Task goes here
-# end
+namespace :bulkrax do
+  desc "Remove old exported zips and create new ones with the new file structure"
+  task rerun_all_exporters: :environment do
+    if defined?(::Hyku)
+      Account.find_each do |account|
+        puts "=============== updating #{account.name} ============"
+        next if account.name == "search"
+        switch!(account)
+
+        rerun_exporters_and_delete_zips
+
+        puts "=============== finished updating #{account.name} ============"
+      end
+    else
+      rerun_exporters_and_delete_zips
+    end
+  end
+
+  def rerun_exporters_and_delete_zips
+    begin
+      Bulkrax::Exporter.all.each { |e| Bulkrax::ExporterJob.perform_later(e.id) }
+    rescue => e
+      puts "(#{e.message})"
+    end
+
+    Dir["tmp/exports/**.zip"].each { |zip_path| FileUtils.rm_rf(zip_path) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulkrax
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -331,6 +331,7 @@ files:
 - app/views/bulkrax/entries/_parsed_metadata.html.erb
 - app/views/bulkrax/entries/_raw_metadata.html.erb
 - app/views/bulkrax/entries/show.html.erb
+- app/views/bulkrax/exporters/_downloads.html.erb
 - app/views/bulkrax/exporters/_form.html.erb
 - app/views/bulkrax/exporters/edit.html.erb
 - app/views/bulkrax/exporters/index.html.erb