Class: ROF::Translators::CsvToRof

Inherits:
ROF::Translator show all
Defined in:
lib/rof/translators/csv_to_rof.rb

Overview

Turn a CSV file into a ROF file.

pass in the contents of the CSV file. Out come an array of ROF objects. Additional processing may be necessary.

Will raise an error if there are no type or owner columns, or if those columns are blank for some row.

other columns are mapped pretty much as is.

Multiple values in a single field are allowed, separate them with a pipe ‘|’

Special fields

type – mandatory. single valued, the ROF type of this object curate_id – optional. single valued, the pid or noid of the parent object (e.g. “ab12cd34j” or “und:ab12cd34j”) owner – mandatory. The owner of this object and any children objects. Must be a Curate User name access – optional. The access policy of this object. defaults to “public”. See below bendo-item – optional. The bendo item name to save this object into.

access is described by an “access string”.

fields with a name of the form XXX:YYY will be treated as descriptive metadata.

As a special case, a type of “+” will insert a generic file associated with the previous work translated into ROF. This will allow a work to have attached files with different access permissions, owners, etc… Any extra files are appended to the file list for the work.

Defined Under Namespace

Classes: MissingOwnerOrType, NoPriorWork, UnknownNamespace

Class Method Summary collapse

Class Method Details

.call(csv_contents, config = {}) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rof/translators/csv_to_rof.rb', line 49

def self.call(csv_contents, config = {})
  first_line = nil
  rof_contents = []
  previous_work = nil
  CSV.parse(csv_contents) do |row|
    if first_line.nil?
      first_line = row
      unless first_line.include?('type') && first_line.include?('owner')
        raise MissingOwnerOrType
      end
      next
    end
    next if row.length <= 1
    result = {}
    row.each_with_index do |item, i|
      next if item.nil?
      column_name = first_line[i]
      case column_name
      when 'type', 'owner', 'access', 'bendo-item'
        result[column_name] = item.strip
      when 'curate_id', 'pid'
        result['pid'] = item.strip
      when 'collections'
        result['rels-ext'] = {}
        result['rels-ext']['isMemberOfCollection'] = item.split('|').map(&:strip)
      else
        result[column_name] = item.split('|').map(&:strip)
      end
    end
    raise MissingOwnerOrType if result['type'].nil? || result['owner'].nil?
    result['rights'] = ROF::Access.decode(result.fetch('access', 'private'), result['owner'])
    result.delete('access')
    result = collect_metadata(result)
    # is this a generic file which should be attached to the previous work?
    if result['type'] == '+'
      raise NoPriorWork if previous_work.nil?
      previous_work['files'] = previous_work.fetch('files', []) + [result]
    else
      previous_work = result
      rof_contents << result
    end
  end
  rof_contents
end

.collect_metadata(rof) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rof/translators/csv_to_rof.rb', line 94

def self.collect_metadata(rof)
  # pull any fields of the form XXX:YYY into
  # a metadata section and add a "@context" key
  metadata = {}
  rof = rof.delete_if do |field, v|
    if field =~ /([^:]+):.+/
      metadata[field] = v.length == 1 ? v.first : v
      true
    else
      false
    end
  end
  return rof if metadata.empty?
  # TODO(dbrower): check there are no unknown namespaces
  metadata['@context'] = ROF::RdfContext
  rof['metadata'] = metadata
  rof
end