bulkrax 1.0.0

data/app/parsers/bulkrax/oai_qualified_dc_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bulkrax
+  class OaiQualifiedDcParser < OaiDcParser
+    def entry_class
+      OaiQualifiedDcEntry
+    end
+  end
+end

data/app/parsers/bulkrax/xml_parser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Bulkrax
+  class XmlParser < ApplicationParser
+    def entry_class
+      Bulkrax::XmlEntry
+    end
+
+    # @todo not yet supported
+    def collection_entry_class; end
+
+    # @todo not yet supported
+    def create_collections; end
+
+    # @todo not yet supported
+    def import_fields; end
+
+    def valid_import?
+      raise StandardError, 'No metadata files found' if metadata_paths.blank?
+      raise StandardError, 'No records found' if records.blank?
+      true
+    rescue StandardError => e
+      status_info(e)
+      false
+    end
+
+    # For multiple, we expect to find metadata for multiple works in the given metadata file(s)
+    # For single, we expect to find metadata for a single work in the given metadata file(s)
+    #  if the file contains more than one record, we take only the first
+    # In either case there may be multiple metadata files returned by metadata_paths
+    def records(_opts = {})
+      @records ||=
+        if parser_fields['import_type'] == 'multiple'
+          r = []
+          metadata_paths.map do |md|
+            # Retrieve all records
+            elements = entry_class.read_data(md).xpath("//#{record_element}")
+            r += elements.map { |el| entry_class.data_for_entry(el, source_identifier) }
+          end
+          # Flatten because we may have multiple records per array
+          r.compact.flatten
+        elsif parser_fields['import_type'] == 'single'
+          metadata_paths.map do |md|
+            data = entry_class.read_data(md).xpath("//#{record_element}").first # Take only the first record
+            entry_class.data_for_entry(data, source_identifier)
+          end.compact # No need to flatten because we take only the first record
+        end
+    end
+
+    def record_element
+      parser_fields['record_element']
+    end
+
+    # Return all files in the import directory and sub-directories
+    def file_paths
+      @file_paths ||=
+        # Relative to the file
+        if file?
+          Dir.glob("#{File.dirname(import_file_path)}/**/*").reject { |f| File.file?(f) == false }
+        # In the supplied directory
+        else
+          Dir.glob("#{import_file_path}/**/*").reject { |f| File.file?(f) == false }
+        end
+    end
+
+    # If the import_file_path is an xml file, return that
+    # Otherwise return all xml files in the given folder
+    def metadata_paths
+      @metadata_paths ||=
+        if file? && MIME::Types.type_for(import_file_path).include?('application/xml')
+          [import_file_path]
+        else
+          file_paths.select do |f|
+            MIME::Types.type_for(f).include?('application/xml') &&
+              f.include?("import_#{importerexporter.id}")
+          end
+        end
+    end
+
+    def create_works
+      records.each_with_index do |record, index|
+        next unless record_has_source_identifier(record, index)
+        break if !limit.nil? && index >= limit
+
+        seen[record[source_identifier]] = true
+        new_entry = find_or_create_entry(entry_class, record[source_identifier], 'Bulkrax::Importer', record)
+        if record[:delete].present?
+          DeleteWorkJob.send(perform_method, new_entry, current_run)
+        else
+          ImportWorkJob.send(perform_method, new_entry.id, current_run.id)
+        end
+        increment_counters(index)
+      end
+      importer.record_status
+    rescue StandardError => e
+      status_info(e)
+    end
+
+    def total
+      records.size
+    end
+  end
+end

data/app/views/bulkrax/entries/_parsed_metadata.html.erb

@@ -0,0 +1,19 @@
+<% if @entry.parsed_metadata.present? %>
+  <div class="accordion-container">
+    <div class="accordion-heading" role="tab" id="parsed-metadata-heading">
+      <a class="accordion-title" role="button" data-toggle="collapse" data-target="#parsed-metadata-show" aria-expanded="true" aria-controls="parsed-metadata-show">
+        Parsed Metadata:
+      </a>
+      <a role="button" data-toggle="collapse" data-target="#parsed-metadata-show" aria-expanded="true" aria-controls="parsed-metadata-show">
+        <div class="accordion-icon glyphicon glyphicon-remove-circle" aria-hidden="true"></div>
+      </a>
+    </div>
+    <div id="parsed-metadata-show" class="accordion-collapse collapse" role="tabpanel" aria-labelledby="parsed-metadata-show">
+      <div class="accordion-body">
+        <% @entry.parsed_metadata.each do |k, v| %>
+          <strong><%= k %>:</strong> <%= v %><br>
+        <% end %>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/bulkrax/entries/_raw_metadata.html.erb

@@ -0,0 +1,19 @@
+<% if @entry.raw_metadata.present? %>
+  <div class="accordion-container">
+    <div class="accordion-heading" role="tab" id="raw-metadata-heading">
+      <a class="accordion-title" role="button" data-toggle="collapse" data-target="#raw-metadata-show" aria-expanded="true" aria-controls="raw-metadata-show">
+        Raw Metadata:
+      </a>
+      <a role="button" data-toggle="collapse" data-target="#raw-metadata-show" aria-expanded="true" aria-controls="raw-metadata-show">
+        <div class="accordion-icon glyphicon glyphicon-remove-circle" aria-hidden="true"></div>
+      </a>
+    </div>
+    <div id="raw-metadata-show" class="accordion-collapse collapse" role="tabpanel" aria-labelledby="raw-metadata-show">
+      <div class="accordion-body">
+        <% @entry.raw_metadata.each do |k, v| %>
+          <strong><%= k %>:</strong> <%= v %><br>
+        <% end %>
+      </div>
+    </div>
+  </div>
+<% end %>

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

@@ -0,0 +1,63 @@
+<p id="notice"><%= notice %></p>
+<div class="panel panel-default">
+  <div class="panel-body">
+    <p class='bulkrax-p-align'>
+      <strong>Identifier:</strong>
+      <%= @entry.identifier %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong>Entry ID:</strong>
+      <%= @entry.id %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong>Type:</strong>
+      <%= @entry.factory_class || 'Unknown' %>
+    </p>
+    <%= render partial: 'raw_metadata'%>
+
+    <%= render partial: 'parsed_metadata'%>
+
+    <%= render partial: 'bulkrax/shared/bulkrax_errors', locals: {item: @entry} %>
+
+    <p class="bulkrax-p-align">
+      <% if @importer.present? %>
+        <strong>Importer:</strong>
+        <%= link_to @importer.name, importer_path(@importer) %>
+      <% elsif @exporter.present? %>
+        <strong>Exporter:</strong>
+        <%= link_to @exporter.name, exporter_path(@exporter) %>
+      <% end %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <% if @importer.present? %>
+        <% factory_record = @entry.factory.find %>
+        <% if factory_record.present? && @entry.factory_class %>
+          <strong><%= @entry.factory_class.to_s %> Link:</strong>
+          <% if @entry.factory_class.to_s == 'Collection' %>
+            <%= link_to @entry.factory_class.to_s, hyrax.polymorphic_path(factory_record) %>
+          <% else %>
+            <%= link_to @entry.factory_class.to_s, main_app.polymorphic_path(factory_record) %>
+          <% end %>
+        <% else %>
+          <strong>Item Link:</strong> Item has not yet been imported successfully
+        <% end %>
+      <% else %>
+        <% record = @entry&.hyrax_record %>
+        <% if record.present? && @entry.factory_class %>
+          <strong><%= record.class.to_s %> Link:</strong>
+          <% if record.is_a?(Collection) %>
+            <%= link_to record.class.to_s, hyrax.polymorphic_path(record) %>
+          <% else %>
+            <%= link_to record.class.to_s, main_app.polymorphic_path(record) %>
+          <% end %>
+        <% else %>
+          <strong>Item Link:</strong> No item associated with this entry or class unknown
+        <% end %>
+      <% end %>
+    </p>
+
+  </div>
+</div>

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

@@ -0,0 +1,120 @@
+<div class="panel-body">
+  <% if exporter.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(exporter.errors.count, "error") %> prohibited this exporter from being saved:</h2>
+
+      <ul>
+        <% exporter.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <%= form.input :name, label: t('bulkrax.exporter.labels.name') %>
+
+  <%= form.hidden_field :user_id, value: current_user.id %>
+
+  <%= form.input :export_type, 
+    collection:  form.object.export_type_list, 
+    label: t('bulkrax.exporter.labels.export_type'), 
+    required: true,
+    prompt: 'Please select an export type' %>
+
+  <%= form.input :export_from, 
+    collection: form.object.export_from_list, 
+    label: t('bulkrax.exporter.labels.export_from'), 
+    required: true,
+    prompt: 'Please select an export source' %>
+
+  <%= form.input :export_source_importer,
+    label: t('bulkrax.exporter.labels.importer'),
+    prompt: 'Select from the list',
+    label_html: { class: 'importer export-source-option hidden' },
+    input_html: { class: 'importer export-source-option hidden' },
+    collection:  form.object.importers_list %>
+
+  <%= form.input :export_source_collection,
+    prompt: 'Start typing ...',
+    label: t('bulkrax.exporter.labels.collection'),
+    placeholder: @collection&.title&.first,
+    label_html: { class: 'collection export-source-option hidden' },
+    input_html: {
+      class: 'collection export-source-option hidden',
+      data: {
+        'autocomplete-url' => '/authorities/search/collections',
+        'autocomplete' => 'collection'
+      }
+    }
+  %>
+
+  <%= form.input :export_source_worktype,
+    label: t('bulkrax.exporter.labels.worktype'),
+    prompt: 'Select from the list',
+    label_html: { class: 'worktype export-source-option hidden' },
+    input_html: { class: 'worktype export-source-option hidden' },
+    collection: Hyrax.config.curation_concerns.map {|cc| [cc.to_s, cc.to_s] } %>
+
+  <%= form.input :limit, 
+    as: :integer, 
+    hint: 'leave blank or 0 for all records',
+    label: t('bulkrax.exporter.labels.limit') %>
+
+  <%= form.input :date_filter,
+                 as: :boolean,
+                 label: t('bulkrax.exporter.labels.filter_by_date') %>
+  <div id="date_filter_picker" class="hidden">
+    <%= form.input :start_date,
+                   as: :date,
+                   label: t('bulkrax.exporter.labels.start_date') %>
+
+    <%= form.input :finish_date,
+                   as: :date,
+                   label: t('bulkrax.exporter.labels.finish_date') %>
+  </div>
+  <%= form.input :work_visibility,
+                 collection: form.object.work_visibility_list,
+                 label: t('bulkrax.exporter.labels.visibility') %>
+
+  <%= form.input :workflow_status,
+                 collection: form.object.workflow_status_list,
+                 label: t('bulkrax.exporter.labels.status') %>
+
+  <%= form.input :parser_klass, 
+    collection: Bulkrax.parsers.map {|p| [p[:name], p[:class_name], {'data-partial' => p[:partial]}] if p[:class_name].constantize.export_supported? }.compact, 
+    label: t('bulkrax.exporter.labels.export_format') %>
+</div>
+
+<%# Find definitions for the functions called in this script in
+    app/assets/javascripts/bulkrax/exporters.js %>
+<script>
+  $(function() {
+    // show the selected export_source option
+    var selectedVal = $('.exporter_export_from option:selected').val();
+    hideUnhide(selectedVal);
+
+    // Select2 dropdowns don't like taking a value param. Thus,
+    // if export_source_collection is present, we populate the input.
+    var selectedCollectionId = "<%= @collection&.id %>"
+    if (selectedCollectionId.length > 0) {
+      $('#exporter_export_source_collection').val(selectedCollectionId)
+    }
+
+    // get the selected export_from option and show the corresponding export_source
+    $('.exporter_export_from').change(function() {
+      var selectedVal = $('.exporter_export_from option:selected').val();
+      hideUnhide(selectedVal);
+    });
+
+    // get the date filter option and show the corresponding date selectors
+    $('.exporter_date_filter').change(function() {
+        if($('.exporter_date_filter').find(".boolean").is(":checked"))
+            $('#date_filter_picker').removeClass('hidden');
+        else
+            $('#date_filter_picker').addClass('hidden');
+    });
+
+    if($('.exporter_date_filter').find(".boolean").is(":checked"))
+        $('#date_filter_picker').removeClass('hidden');
+  });
+</script>

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

@@ -0,0 +1,23 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-edit" aria-hidden="true"></span> Edit Exporter</h1>
+<% end %>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default tabs">
+      <%= simple_form_for @exporter do |form| %>
+        <%= render 'form', exporter: @exporter, form: form %>
+        <div class="panel-footer">
+          <div class='pull-right'>
+            <%= form.button :submit, value: 'Update Exporter', class: 'btn btn-primary' %>
+            |
+            <%= form.button :submit, value: 'Update and Re-Export All Items', class: 'btn btn-primary' %>
+            |
+            <% cancel_path = form.object.persisted? ? exporter_path(form.object) : exporters_path %>
+            <%= link_to t('.cancel'), cancel_path, class: 'btn btn-default ' %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,67 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-cloud-download" aria-hidden="true"></span> Exporters</h1>
+  <div class="pull-right">
+    <%= link_to new_exporter_path, class: 'btn btn-primary' do %>
+      <span class="fa fa-edit" aria-hidden="true"></span> <%= t(:'helpers.action.exporter.new') %>
+    <% end %>
+  </div>
+<% end %>
+
+<div class="panel panel-default">
+  <div class="panel-body">
+    <% if @exporters.present? %>
+      <div class="table-responsive">
+        <table class="table table-striped datatable">
+          <thead>
+            <tr>
+              <th scope="col">Name</th>
+              <th scope="col">Status</th>
+              <th scope="col">Date Exported</th>
+              <th scope="col"></th>
+              <th scope="col"></th>
+              <th scope="col"></th>
+              <th scope="col"></th>
+            </tr>
+          </thead>
+          <tbody>
+            <% @exporters.each do |exporter| %>
+              <tr>
+                <th scope="row"><%= link_to exporter.name, exporter_path(exporter) %></th>
+                <td><%= exporter.status %></td>
+                <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) %>
+                  <% end%>
+                </td>
+                <td><%= link_to raw('<span class="glyphicon glyphicon-info-sign"></span>'), exporter_path(exporter) %></td>
+                <td><%= link_to raw('<span class="glyphicon glyphicon-pencil"></span>'), edit_exporter_path(exporter) %></td>
+                <td><%= link_to raw('<span class="glyphicon glyphicon-remove"></span>'), exporter, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+      <% else %>
+        <p>No exporters have been created.</p>
+      <% end %>
+  </div>
+</div>
+
+<script>
+  $(function() {
+    $('#DataTables_Table_0').DataTable({
+      destroy: true, /* Reinitialize DataTable with config below */
+      'columnDefs': [
+          { 'orderable': true, 'targets': [0, 1, 2] },
+          { 'orderable': false, 'targets': [3, 4, 5, 6] }
+      ],
+      'language': {
+        'info': 'Showing _START_ to _END_ of _TOTAL_ exporters',
+        'infoEmpty': 'No exporters to show',
+        'infoFiltered': '(filtered from _MAX_ total exporters)',
+        'lengthMenu': 'Show _MENU_ exporters'
+      }
+    })
+  })
+</script>

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

@@ -0,0 +1,23 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-edit" aria-hidden="true"></span> New Exporter</h1>
+<% end %>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default tabs">
+      <%= simple_form_for @exporter do |form| %>
+        <%= render 'form', exporter: @exporter, form: form %>
+        <div class="panel-footer">
+          <div class='pull-right'>
+            <%= form.button :submit, value: 'Create and Export', class: 'btn btn-primary' %>
+            |
+            <%= form.button :submit, value: 'Create', class: 'btn btn-primary' %>
+            |
+            <% cancel_path = form.object.persisted? ? exporter_path(form.object) : exporters_path %>
+            <%= link_to t('.cancel'), cancel_path, class: 'btn btn-default ' %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>