zizia 4.5.4.alpha.01 → 4.6.0.alpha.01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cda0b48e918b9f663e1cbdc458b425bf597825c3ef52b524ce148013c89fc6c
-  data.tar.gz: c8d37b6d969ac9dfc70ca683f3c02ecda50e1957eb724eed113a93627e2979f5
+  metadata.gz: e474d50c1f6b1d4e15cc79ef9546a5f747c61e03cd6d85426ce6580c8c019f22
+  data.tar.gz: f9da12668c3657384042f5e202814094720ec63b22608d1165fa08c306d633e5
 SHA512:
-  metadata.gz: 4db9363bed73c42c1ca18da5222ed3af388b3db5a5cde376b72b580963acdb1ccfa62ba840d0e247584cf83a3b8e880b82e38f83cc4658d572cb0b1cd03de7f8
-  data.tar.gz: b734026aa43137f6b24a657884b7d945eb4f69930ef96dcf1e20dea4e4dce7663c062a2bfb9a800764047deae9b2349cbdfa1943d7986e3c38461e991837bba0
+  metadata.gz: 9d602fbc263f0bc0dd8d231c93c6897e275ee195c2e19f00287c7d83af05810aac2f46551de43b21cc20f6f9918cfa826bafafce3fe175f371296284940d7fc9
+  data.tar.gz: 5b3ff29ac96a0cc5c1f820fa4c6cb184dc4c78f07f11fc078309e2b01258a197ae84d77b75cd07ca5a1a4b6febae356b312971c532a2d486cd6da71c84ab9602

data/README.md

@@ -78,15 +78,7 @@ helper Zizia::Engine.helpers
     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`
-
-and
-
-`app/assets/markdown/importer_guide.md`
-
-5. Add links to `/csv_imports/new` and `/importer_documentation/csv` in the Hyrax dashboard
+4. 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

data/app/assets/stylesheets/zizia/_field_guide.scss

@@ -0,0 +1,10 @@
+.system-field { display: none; }
+.field-guide-intro {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  font-size: large;
+}
+.delimiter {
+  font-weight: 800;
+  font-family: monospace;
+}

data/app/assets/stylesheets/zizia/zizia.scss

@@ -1,4 +1,5 @@
 @import 'file_upload';
+@import 'field_guide';
 
 .btn {
     white-space:normal !important;

data/app/config/zizia/usage.yml

@@ -0,0 +1,39 @@
+---
+# Metadata usage hints
+# attribute: usage
+
+arkivo_checksum:        "-- system field - not directly editable --"
+based_near:             "A place name related to the work, such as its site of publication, or the city, state, or country the work contents are about. This field is a URI. The URIs should be GeoNames identifiers. You can look these up at GeoNames (http://www.geonames.org/). Example: http://www.geonames.org/4500546/"
+bibliographic_citation: "Used to store the preferred bibliographic citation."
+contributor:            "A person or group you want to recognize for playing a role in the creation of the work, but not the primary role. Example: Smith, Mary"
+create_date:            "-- system field - not directly editable --"
+creator:                "The person or group responsible for the work. Usually this is the author, artist, or other person or people responsible for creating the content. Example: Leffler, Warren K., photographer."
+date_created:           "The date the work was created. Typically entered using ISO 8601 format; however, and local convention can be supported. Example: 1964-08-21 (also '1964', 'Aug. 22 '64', '19th C.' or '8/22/1964')  NOTE: the system treats this field as a string and does not attempt to interpret the value entered."
+date_modified:          "-- system field - not directly editable --"
+date_uploaded:          "-- system field - not directly editable --"
+depositor:              "-- system field - not directly editable --"
+description:            "Free-text notes about the work, such as abstracts of a paper or citation information for a journal article. Example: Photograph shows half-length portrait of Hamer seated at a table."
+has_model:              "-- system field - not directly editable --"
+head:                   "-- system field - not directly editable --"
+identifier:             "A unique handle identifying the work. An example would be a DOI for a journal article, or an ISBN or OCLC number for a book. Example: LC-U9-12470B-17"
+import_url:             "-- system field - not directly editable --"
+keywords:               "Words or phrases you select to describe what the work is about. Example: New Orleans or Music "
+label:                  "-- system field - not directly editable --"
+language:               "The language of the source content being described. Example: English"
+license:                "Licensing and distribution information governing access to the work. This field is a URI. You can choose rights statements from this vocabulary (https://github.com/curationexperts/tenejo/blob/master/config/authorities/licenses.yml). Example: http://creativecommons.org/licenses/by/3.0/us/"
+modified_date:          "-- system field - not directly editable --"
+on_behalf_of:           "-- system field - not directly editable --"
+owner:                  "-- system field - not directly editable --"
+proxy_depositor:        "-- system field - not directly editable --"
+publisher:              "The person or group making the work available. Generally this is the institution. Example: Library of Congress"
+related_url:            "A link to a website or other specific content (audio, video, PDF document) related to the work such as the URL of a research project from which the work was derived. Example: https://www.loc.gov/free-to-use/african-american-women-changemakers/"
+relative_path:          "-- system field - not directly editable --"
+resource_type:          "Pre-defined categories to describe the type of content. You must choose from one of the types listed here (https://github.com/curationexperts/tenejo/blob/master/config/authorities/resource_types.yml) Examples: Image, Article, or Dataset"
+rights_statement:       "This field is a URI. You can choose rights statements from this vocabulary (https://github.com/curationexperts/tenejo/blob/master/config/authorities/rights_statements.yml). Example: http://rightsstatements.org/vocab/UND/1.0/"
+source:                 "A related resource from which the described resource is derived. Example: Library of Congress Online Catalog (976,247)"
+state:                  "-- system field - not directly editable --"
+subject:                "Headings or index terms describing what the work is about. These should conform to an existing vocabulary, like LCSH. Example: Hamer, Fannie Lou--Public appearances--New Jersey--Atlantic City."
+tail:                   "-- system field - not directly editable --"
+title:                  "A name to aid in identifying a work. Example: [Fannie Lou Hamer, Mississippi Freedom Democratic Party delegate, at the Democratic National Convention, Atlantic City, New Jersey, August 1964] / [WKL]."
+visibility:             "The desired visiblity setting for the work and it's files. You can use 'open', 'registered', or 'restricted'. Example: 'open'"
+files:                  "The file(s) you want to attach to your work. Must match the filenames you have uploaded to the server.  Example: 01267_150px.jpg. You can attach multiple files to a work by providing multiple filenames separated by the separator configured for your application."

data/app/controllers/zizia/csv_import_details_controller.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 module Zizia
   class CsvImportDetailsController < ApplicationController
+    load_and_authorize_resource
+    with_themed_layout 'dashboard'
+
     def index
       @csv_import_details = Zizia::CsvImportDetail.order(:id).page csv_import_detail_params[:page]
     end

data/app/controllers/zizia/metadata_details_controller.rb

@@ -4,6 +4,9 @@ module Zizia
     def show
       @details = MetadataDetails.instance.details(work_attributes:
                                                      WorkAttributes.instance)
+
+      @delimiter = Zizia::HyraxBasicMetadataMapper.new.delimiter
+
       respond_to do |format|
         format.html
         format.json { render json: @details.to_json }

data/app/helpers/zizia/metadata_details_helper.rb

@@ -5,5 +5,27 @@ module Zizia
       return 'missing' if value == 'not configured'
       return 'missing' if value.match?(/translation missing/)
     end
+
+    def system_field(detail)
+      return "" if detail.nil?
+      return "non-system-field" unless detail[:usage]
+      return "system-field" if detail[:usage].match?("system field")
+      "non-system-field"
+    end
+
+    def hide_system_field(detail)
+      return "" if detail.nil?
+      return "" unless detail[:usage]
+      # rubocop: disable Rails/OutputSafety
+      return "style='display: none'".html_safe if detail[:usage].match?("system field")
+      # rubocop: enable Rails/OutputSafety
+      ""
+    end
+
+    def true_false_to_yes_no(value)
+      return "" if value.nil?
+      return "yes" if value == "true"
+      "no"
+    end
   end
 end

data/app/lib/zizia/metadata_details.rb

@@ -7,19 +7,9 @@ module Zizia
 
     def details(work_attributes:)
       validators = work_attributes.validators
-      work_attributes.properties.sort.map do |p|
-        Hash[
-          attribute: p[0],
-          predicate: p[1].predicate.to_s,
-          multiple: p[1].try(:multiple?).to_s,
-          type: type_to_s(p[1].type),
-          validator: validator_to_string(validator: validators[p[0].to_sym][0]),
-          label: I18n.t("simple_form.labels.defaults.#{p[0]}"),
-          csv_header: csv_header(p[0]),
-          required_on_form: required_on_form_to_s(p[0]),
-          usage: MetadataUsage.instance.usage[p[0]]
-        ]
-      end
+      detail_list = work_attributes.properties.sort.map { |p| definition_hash_for(p, validators) }
+      detail_list << visibility_definition
+      detail_list << file_definition
     end
 
     def to_csv(work_attributes:)
@@ -64,5 +54,47 @@ module Zizia
           'No validation present in the model.'
         end
       end
+
+      def definition_hash_for(field_properties, validators)
+        Hash[
+          attribute: field_properties[0],
+          predicate: field_properties[1].predicate.to_s,
+          multiple: field_properties[1].try(:multiple?).to_s,
+          type: type_to_s(field_properties[1].type),
+          validator: validator_to_string(validator: validators[field_properties[0].to_sym][0]),
+          label: I18n.t("simple_form.labels.defaults.#{field_properties[0]}"),
+          csv_header: csv_header(field_properties[0]),
+          required_on_form: required_on_form_to_s(field_properties[0]),
+          usage: MetadataUsage.instance.usage[field_properties[0]]
+        ]
+      end
+
+      def file_definition
+        {
+          attribute:  'files',
+          predicate:  'n/a',
+          multiple: 	'true',
+          type:       'String',
+          validator: 	'Required, must name a file on the server',
+          label: 	    'Items (listed at bottom of page)',
+          csv_header: 'files',
+          required_on_form: 	'true',
+          usage: MetadataUsage.instance.usage['files']
+        }
+      end
+
+      def visibility_definition
+        {
+          attribute:  'visibility',
+          predicate:  'n/a',
+          multiple: 	'false',
+          type:       'String',
+          validator: 	'Required, must exist in the application\'s controlled vocabulary for visiblity levels.',
+          label: 	    'Visibility',
+          csv_header: 'visibility',
+          required_on_form: 	'true',
+          usage: MetadataUsage.instance.usage['visibility']
+        }
+      end
   end
 end

data/app/lib/zizia/metadata_usage.rb

@@ -11,12 +11,12 @@ module Zizia
     private
 
       def default_location
-        File.join(File.dirname(__FILE__), '../../config/usage.yml')
+        File.join(File.dirname(__FILE__), '../../config/zizia/usage.yml')
       end
 
       def config
-        return default_location unless File.exist?(Rails.root.join("config", "usage.yml"))
-        Rails.root.join("config", "usage.yml")
+        return default_location unless File.exist?(Rails.root.join("config", "zizia", "usage.yml"))
+        Rails.root.join("config", "zizia", "usage.yml")
       end
   end
 end

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

@@ -1,14 +1,25 @@
+<h2>Metadata Field Guide</h2>
+<div class="field-guide-intro">
+  <p>
+  This is a dynamically generated guide to the metadata used in this application.
+  Many fields are multi-valued. To include multiple values in a single CSV cell,
+  separate them with the delimiter that has been configured for this application:
+  <span class="delimiter"><%= @delimiter %></span>
+  </p>
+  <p>
+  Example:   <span class="delimiter">Value 1<%= @delimiter %>Value 2</span>
+  </p>
+</div>
+
 <% content_for :title, 'Importer Field Guide' %>
 <div class="guide-container">
   <a class="btn btn-primary" href="/importer_documentation/profile">Download as CSV</a>
-  <dl>
+  <div class="metadata-field-guide">
     <% @details.each do |detail| %>
-      <h2>
-        <dt>
+      <div class="metadata-field <%= system_field(detail) %>" <%= hide_system_field(detail) %>>
+        <h2 class="field-label">
           <%= detail[:attribute] %>
-        </dt>
-      </h2>
-      <dd>
+        </h2>
         <div>
           <b>Predicate:</b>
           <a href="<%= detail[:predicate] %>"><%= detail[:predicate] %></a>
@@ -22,8 +33,8 @@
           <%= detail[:validator] %>
         </div>
         <div>
-          <b>Multiple:</b>
-          <%= detail[:multiple] %>
+          <b>Multiple values accepted:</b>
+          <%= true_false_to_yes_no(detail[:multiple]) %>
         </div>
         <div>
           <b>Edit Form Label:</b>
@@ -43,7 +54,7 @@
           <b>Usage:</b>
           <%= detail[:usage] %>
         </div>
-      </dd>
+      </div>
     <% end  %>
-  </dl>
+  </div>
 </div>

data/lib/zizia/version.rb

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

data/spec/controllers/metadata_details_spec.rb

@@ -54,11 +54,27 @@ RSpec.describe Zizia::MetadataDetailsController, type: :controller do
       expect(first_row).to include('required_on_form')
     end
 
-    it 'includes usage' do
+    it 'includes `usage`' do
       get :profile
       profile_table = CSV.parse(response.body, headers: :first_row)
       title_definition = profile_table.find { |r| r.field('attribute') == 'title' }
-      expect(title_definition.field('usage')).to include 'name of the resource being described' # match text extracted from ./config/emory/usage.yml
+      expect(title_definition.field('usage')).to include 'name to aid in identifying a work' # match text extracted from ./config/emory/usage.yml
+    end
+
+    it 'includes `files`' do
+      get :profile
+      profile_table = CSV.parse(response.body, headers: :first_row)
+      files_definition = profile_table.find { |r| r.field('attribute') == 'files' }
+      expect(files_definition.field('csv_header')).to eq('files')
+      expect(files_definition.field('validator')).to match(/Required/)
+    end
+
+    it 'includes `visibility`' do
+      get :profile
+      profile_table = CSV.parse(response.body, headers: :first_row)
+      visibility_definition = profile_table.find { |r| r.field('attribute') == 'visibility' }
+      expect(visibility_definition.field('csv_header')).to eq('visibility')
+      expect(visibility_definition.field('validator')).to match(/Required/)
     end
 
     it 'includes a date in the filename' do

data/spec/dummy/app/assets/stylesheets/application.css

@@ -13,4 +13,5 @@
  *= require_tree .
  *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
  *= require_self
+ *= require zizia/application
  */

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

@@ -8,6 +8,8 @@ class Ability
   # Define any customized permissions here.
   def custom_permissions
     can :manage, Zizia::CsvImport if current_user.admin?
+    can :manage, Zizia::CsvImportDetail if current_user.admin?
+
     # Limits deleting objects to a the admin user
     #
     # if current_user.admin?