Class: Bulkrax::SampleCsvService::ColumnDescriptor

Inherits:
Object
  • Object
show all
Defined in:
app/services/bulkrax/sample_csv_service/column_descriptor.rb

Overview

Manages column descriptions and metadata

Constant Summary collapse

COLUMN_DESCRIPTIONS = 
{
  include_first: [
    { "model" => "The work types configured in your repository are listed below.\nIf left blank, your default work type, #{Bulkrax.default_work_type}, is used." },
    { "source_identifier" => "This must be a unique identifier.\nIt can be alphanumeric with some special characters (e.g. hyphens, colons), and URLs are also supported." },
    { "id" => "This column would optionally be included only if it is a re-import, i.e. for updating or deleting records.\nThis is a key identifier used by the system, which you wouldn't have for new imports." },
    { "rights_statement" => "Rights statement URI for the work.\nIf not included, uses the value specified on the bulk import configuration screen." }
  ],
  visibility: [
    { "visibility" => "Uses the value specified on the bulk import configuration screen if not added here.\nValid options: open, authenticated, restricted, embargo, lease" },
    { "embargo_release_date" => "Required for embargo (yyyy-mm-dd)" },
    { "visibility_during_embargo" => "Required for embargo" },
    { "visibility_after_embargo" => "Required for embargo" },
    { "lease_expiration_date" => "Required for lease (yyyy-mm-dd)" },
    { "visibility_during_lease" => "Required for lease" },
    { "visibility_after_lease" => "Required for lease" }
  ],
  files: [
    { "file" => "Use filenames exactly matching those in your files folder.\nZip your CSV and files folder together and attach this to your importer." },
    { "remote_files" => "Use the URLs to remote files to be attached to the work." }
  ],
  relationships: [
    { "parents" => "The source_identifier or id of work or collection to be attached as parent." },
    { "children" => "The source_identifier or id of work or file to be attached as child." }
  ],
  other: [
    { "hide_from_catalog_search" => "Set to 1 to hide the collection from catalog search results." },
    { "show_pdf_download_button" => "Set to 1 to show a PDF download link on the work's page." },
    { "show_pdf_viewer" => "Set to 1 to show a PDF viewer on the work's page." },
    { "video_embed" => "A valid URL to a hosted video that can appear in an iframe, beginning with 'http://' or 'https://'." }
  ]
}.freeze

Instance Method Summary collapse

Instance Method Details

#core_columns ⇒ Object 



38
39
40
 
# File 'app/services/bulkrax/sample_csv_service/column_descriptor.rb', line 38

def core_columns
  extract_column_names(:include_first) + extract_column_names(:visibility)
end

#find_description_for(column) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'app/services/bulkrax/sample_csv_service/column_descriptor.rb', line 42

def find_description_for(column)
  COLUMN_DESCRIPTIONS.each_value do |group|
    prop = group.find { |hash| hash.key?(column) }
    return prop[column] if prop
  end
  nil
end