Class: Bolognese::Metadata

Inherits:
Object
  • Object
show all
Includes:
MetadataUtils
Defined in:
lib/bolognese/metadata.rb

Constant Summary

Constants included from Readers::SchemaOrgReader

Readers::SchemaOrgReader::SO_TO_DC_RELATION_TYPES

Constants included from Readers::RisReader

Readers::RisReader::RIS_TO_BIB_TRANSLATIONS, Readers::RisReader::RIS_TO_CP_TRANSLATIONS, Readers::RisReader::RIS_TO_SO_TRANSLATIONS

Constants included from Readers::CrossrefReader

Readers::CrossrefReader::CONTACT_EMAIL

Constants included from Readers::CiteprocReader

Readers::CiteprocReader::CP_TO_RIS_TRANSLATIONS, Readers::CiteprocReader::CP_TO_SO_TRANSLATIONS

Constants included from Readers::BibtexReader

Readers::BibtexReader::BIB_TO_CP_TRANSLATIONS, Readers::BibtexReader::BIB_TO_RIS_TRANSLATIONS, Readers::BibtexReader::BIB_TO_SO_TRANSLATIONS

Constants included from Utils

Utils::BIB_TO_CR_TRANSLATIONS, Utils::CR_TO_BIB_TRANSLATIONS, Utils::CR_TO_CP_TRANSLATIONS, Utils::CR_TO_JATS_TRANSLATIONS, Utils::CR_TO_RIS_TRANSLATIONS, Utils::CR_TO_SO_TRANSLATIONS, Utils::DC_TO_CP_TRANSLATIONS, Utils::DC_TO_RIS_TRANSLATIONS, Utils::DC_TO_SO_TRANSLATIONS, Utils::LICENSE_NAMES, Utils::SO_TO_BIB_TRANSLATIONS, Utils::SO_TO_CP_TRANSLATIONS, Utils::SO_TO_DC_TRANSLATIONS, Utils::SO_TO_JATS_TRANSLATIONS, Utils::SO_TO_RIS_TRANSLATIONS

Constants included from AuthorUtils

AuthorUtils::IDENTIFIER_SCHEME_URIS

Instance Attribute Summary collapse

Attributes included from MetadataUtils

#first_page, #last_page, #name_detector, #reverse

Instance Method Summary collapse

Methods included from MetadataUtils

#citeproc_hsh, #container_title, #graph, #locale, #raw, #should_passthru, #style, #volume

Methods included from Writers::TurtleWriter

#turtle

Methods included from Writers::SchemaOrgWriter

#schema_hsh, #schema_org

Methods included from Writers::RisWriter

#ris

Methods included from Writers::RdfXmlWriter

#rdf_xml

Methods included from Writers::JatsWriter

#date, #insert_authors, #insert_citation, #insert_citation_title, #insert_contributor, #insert_editors, #insert_fpage, #insert_issue, #insert_lpage, #insert_pub_id, #insert_publication_date, #insert_publisher_name, #insert_source, #insert_version, #insert_volume, #is_article?, #is_chapter?, #is_data?, #jats, #publication_type

Methods included from Writers::DataciteJsonWriter

#datacite_json

Methods included from Writers::DataciteWriter

#datacite

Methods included from Writers::CrossrefWriter

#crossref

Methods included from Writers::CrossciteWriter

#crosscite

Methods included from Writers::CodemetaWriter

#codemeta

Methods included from Writers::CiteprocWriter

#citeproc

Methods included from Writers::CitationWriter

#citation

Methods included from Writers::BibtexWriter

#bibtex

Methods included from Readers::SchemaOrgReader

#get_schema_org, #read_schema_org, #schema_org_has_part, #schema_org_is_identical_to, #schema_org_is_new_version_of, #schema_org_is_part_of, #schema_org_is_previous_version_of, #schema_org_is_referenced_by, #schema_org_is_supplement_to, #schema_org_is_supplemented_by, #schema_org_references, #schema_org_related_identifier, #schema_org_reverse_related_identifier

Methods included from Readers::RisReader

#read_ris, #ris_meta

Methods included from Readers::DataciteJsonReader

#read_datacite_json

Methods included from Readers::DataciteReader

#get_datacite, #read_datacite, #set_periodical

Methods included from Readers::CrossrefReader

#crossref_alternate_identifiers, #crossref_date_published, #crossref_description, #crossref_funding_reference, #crossref_is_part_of, #crossref_license, #crossref_people, #crossref_references, #get_crossref, #read_crossref

Methods included from Readers::CrossciteReader

#read_crosscite

Methods included from Readers::CodemetaReader

#get_codemeta, #read_codemeta

Methods included from Readers::CiteprocReader

#read_citeproc

Methods included from Readers::BibtexReader

#read_bibtex

Methods included from Utils

#find_from_format, #find_from_format_by_ext, #find_from_format_by_id, #find_from_format_by_string, #from_citeproc, #from_datacite_json, #from_schema_org, #get_contributor, #get_date, #get_date_from_date_parts, #get_date_from_parts, #get_date_parts, #get_date_parts_from_parts, #get_datetime_from_iso8601, #get_year_month, #get_year_month_day, #github_as_codemeta_url, #github_as_owner_url, #github_as_release_url, #github_as_repo_url, #github_from_url, #github_owner_from_url, #github_release_from_url, #github_repo_from_url, #jsonlint, #map_hash_keys, #normalize_id, #normalize_ids, #normalize_licenses, #normalize_orcid, #normalize_url, #orcid_as_url, #orcid_from_url, #parse_attributes, #sanitize, #to_citeproc, #to_datacite_json, #to_identifier, #to_ris, #to_schema_org, #to_schema_org_container, #to_schema_org_funder, #to_schema_org_identifier, #to_schema_org_relation, #to_schema_org_spatial_coverage, #validate_orcid, #validate_orcid_scheme, #validate_url

Methods included from DataciteUtils

#datacite_errors, #datacite_xml, #insert_alternate_identifiers, #insert_contributors, #insert_creators, #insert_dates, #insert_descriptions, #insert_funding_references, #insert_identifier, #insert_person, #insert_publication_year, #insert_publisher, #insert_related_identifiers, #insert_resource_type, #insert_rights_list, #insert_subjects, #insert_titles, #insert_version, #insert_work, #root_attributes

Methods included from AuthorUtils

#authors_as_string, #cleanup_author, #get_authors, #get_name_identifiers, #get_one_author, #is_personal_name?, #name_exists?

Methods included from DoiUtils

#doi_as_url, #doi_from_url, #doi_resolver, #doi_search, #get_doi_ra, #normalize_doi, #validate_doi, #validate_prefix

Constructor Details

#initialize(input: nil, from: nil, **options) ⇒ Metadata

Returns a new instance of Metadata.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/bolognese/metadata.rb', line 18

def initialize(input: nil, from: nil, **options)
  id = normalize_id(input, options)

  if id.present?
    @from = from || find_from_format(id: id)

    # generate name for method to call dynamically
    hsh = @from.present? ? send("get_" + @from, id: id, sandbox: options[:sandbox]) : {}
    string = hsh.fetch("string", nil)
  elsif input.present? && File.exist?(input)
    ext = File.extname(input)
    if %w(.bib .ris .xml .json).include?(ext)
      hsh = { "url" => options[:url],
        "state" => options[:state],
        "date_registered" => options[:date_registered],
        "date_updated" => options[:date_updated],
        "provider_id" => options[:provider_id],
        "client_id" => options[:client_id],
        "content_url" => options[:content_url] }
      string = IO.read(input)
      @from = from || find_from_format(string: string, ext: ext)
    else
      $stderr.puts "File type #{ext} not supported"
      exit 1
    end
  else
    hsh = { "url" => options[:url],
            "state" => options[:state],
            "date_registered" => options[:date_registered],
            "date_updated" => options[:date_updated],
            "provider_id" => options[:provider_id],
            "client_id" => options[:client_id],
            "content_url" => options[:content_url],
            "creators" => options[:creators],
            "contributors" => options[:creators],
            "titles" => options[:titles],
            "publisher" => options[:publisher],
            "publication_year" => options[:publication_year] }
    string = input
    @from = from || find_from_format(string: string)
  end

  # make sure input is encoded as utf8
  string = string.force_encoding("UTF-8") if string.present?
  @string = string

  # input options for citation formatting
  @style = options[:style]
  @locale = options[:locale]

  @regenerate = options[:regenerate]
  @sandbox = options[:sandbox]

  # options that come from the datacite database
  @url = hsh.to_h["url"].presence || options[:url].presence
  @state = hsh.to_h["state"].presence
  @date_registered = hsh.to_h["date_registered"].presence
  @date_updated = hsh.to_h["date_updated"].presence
  @provider_id = hsh.to_h["provider_id"].presence
  @client_id = hsh.to_h["client_id"].presence
  @content_url = hsh.to_h["content_url"].presence

  # set attributes directly
  read_options = options.slice(
    :creators,
    :contributors,
    :titles,
    :types,
    :alternate_identifiers,
    :periodical,
    :publisher,
    :funding_references,
    :dates,
    :publication_year,
    :descriptions,
    :rights_list,
    :version_info,
    :subjects,
    :language,
    :geo_locations,
    :related_identifiers,
    :formats,
    :sizes
  ).compact

  # generate name for method to call dynamically
  @meta = @from.present? ? send("read_" + @from, { string: string, sandbox: options[:sandbox] }.merge(read_options)) : {}
  @identifier = normalize_doi(options[:doi] || input, options) || @meta.fetch("id", nil) || @meta.fetch("identifier", nil)
end

Instance Attribute Details

#agency ⇒ Object 



209
210
211
 
# File 'lib/bolognese/metadata.rb', line 209

def agency
  @agency ||= meta.fetch("agency", nil)
end

#alternate_identifiers ⇒ Object 



201
202
203
 
# File 'lib/bolognese/metadata.rb', line 201

def alternate_identifiers
  @alternate_identifiers ||= meta.fetch("alternate_identifiers", nil)
end

#client_id ⇒ Object 



120
121
122
 
# File 'lib/bolognese/metadata.rb', line 120

def client_id
  @client_id ||= meta.fetch("client_id", nil)
end

#content_url ⇒ Object 



205
206
207
 
# File 'lib/bolognese/metadata.rb', line 205

def content_url
  @content_url ||= meta.fetch("content_url", nil)
end

#contributor=(value) ⇒ Object (writeonly)

Sets the attribute contributor

Parameters:

  • value —

    the value to set the attribute contributor to.



11
12
13
 
# File 'lib/bolognese/metadata.rb', line 11

def contributor=(value)
  @contributor = value
end

#contributors ⇒ Object 



233
234
235
 
# File 'lib/bolognese/metadata.rb', line 233

def contributors
  @contributors ||= meta.fetch("contributors", nil)
end

#creators ⇒ Object 



229
230
231
 
# File 'lib/bolognese/metadata.rb', line 229

def creators
  @creators ||= meta.fetch("creators", nil)
end

#dates ⇒ Object 



193
194
195
 
# File 'lib/bolognese/metadata.rb', line 193

def dates
  @dates ||= meta.fetch("dates", nil)
end

#descriptions ⇒ Object 



137
138
139
 
# File 'lib/bolognese/metadata.rb', line 137

def descriptions
  @descriptions ||= meta.fetch("descriptions", nil)
end

#doc ⇒ Object (readonly)

Returns the value of attribute doc.



10
11
12
 
# File 'lib/bolognese/metadata.rb', line 10

def doc
  @doc
end

#doi ⇒ Object 



112
113
114
 
# File 'lib/bolognese/metadata.rb', line 112

def doi
  @doi ||= @identifier.present? ? doi_from_url(@identifier) : meta.fetch("doi", nil)
end

#format=(value) ⇒ Object (writeonly)

Sets the attribute format

Parameters:

  • value —

    the value to set the attribute format to.



11
12
13
 
# File 'lib/bolognese/metadata.rb', line 11

def format=(value)
  @format = value
end

#formats ⇒ Object 



157
158
159
 
# File 'lib/bolognese/metadata.rb', line 157

def formats
  @formats ||= meta.fetch("formats", nil)
end

#from ⇒ Object

Returns the value of attribute from.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def from
  @from
end

#funding_references ⇒ Object 



165
166
167
 
# File 'lib/bolognese/metadata.rb', line 165

def funding_references
  @funding_references ||= meta.fetch("funding_references", nil)
end

#geo_locations ⇒ Object 



189
190
191
 
# File 'lib/bolognese/metadata.rb', line 189

def geo_locations
  @geo_locations ||= meta.fetch("geo_locations", nil)
end

#id ⇒ Object 



108
109
110
 
# File 'lib/bolognese/metadata.rb', line 108

def id
  @id ||= meta.fetch("id", nil)
end

#identifier ⇒ Object 



217
218
219
 
# File 'lib/bolognese/metadata.rb', line 217

def identifier
  @identifier ||= meta.fetch("id", nil)
end

#issue ⇒ Object

Returns the value of attribute issue.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def issue
  @issue
end

#language ⇒ Object 



149
150
151
 
# File 'lib/bolognese/metadata.rb', line 149

def language
  @language ||= meta.fetch("language", nil)
end

#locale=(value) ⇒ Object (writeonly)

Sets the attribute locale

Parameters:

  • value —

    the value to set the attribute locale to.



11
12
13
 
# File 'lib/bolognese/metadata.rb', line 11

def locale=(value)
  @locale = value
end

#meta ⇒ Object

Returns the value of attribute meta.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def meta
  @meta
end

#page_end ⇒ Object (readonly)

Returns the value of attribute page_end.



10
11
12
 
# File 'lib/bolognese/metadata.rb', line 10

def page_end
  @page_end
end

#page_start ⇒ Object (readonly)

Returns the value of attribute page_start.



10
11
12
 
# File 'lib/bolognese/metadata.rb', line 10

def page_start
  @page_start
end

#periodical ⇒ Object 



185
186
187
 
# File 'lib/bolognese/metadata.rb', line 185

def periodical
  @periodical ||= meta.fetch("periodical", nil)
end

#provider_id ⇒ Object 



116
117
118
 
# File 'lib/bolognese/metadata.rb', line 116

def provider_id
  @provider_id ||= meta.fetch("provider_id", nil)
end

#publication_year ⇒ Object 



181
182
183
 
# File 'lib/bolognese/metadata.rb', line 181

def publication_year
  @publication_year ||= meta.fetch("publication_year", nil)
end

#publisher ⇒ Object 



197
198
199
 
# File 'lib/bolognese/metadata.rb', line 197

def publisher
  @publisher ||= meta.fetch("publisher", nil)
end

#regenerate ⇒ Object

Returns the value of attribute regenerate.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def regenerate
  @regenerate
end

#related_identifiers ⇒ Object 



169
170
171
 
# File 'lib/bolognese/metadata.rb', line 169

def related_identifiers
  @related_identifiers ||= meta.fetch("related_identifiers", nil)
end

#rights_list ⇒ Object 



141
142
143
 
# File 'lib/bolognese/metadata.rb', line 141

def rights_list
  @rights_list ||= meta.fetch("rights_list", nil)
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def sandbox
  @sandbox
end

#schema_version ⇒ Object 



161
162
163
 
# File 'lib/bolognese/metadata.rb', line 161

def schema_version
  @schema_version ||= meta.fetch("schema_version", nil)
end

#sizes ⇒ Object 



153
154
155
 
# File 'lib/bolognese/metadata.rb', line 153

def sizes
  @sizes ||= meta.fetch("sizes", nil)
end

#state ⇒ Object 



213
214
215
 
# File 'lib/bolognese/metadata.rb', line 213

def state
  @state ||= meta.fetch("state", nil)
end

#string ⇒ Object

Returns the value of attribute string.



9
10
11
 
# File 'lib/bolognese/metadata.rb', line 9

def string
  @string
end

#style=(value) ⇒ Object (writeonly)

Sets the attribute style

Parameters:

  • value —

    the value to set the attribute style to.



11
12
13
 
# File 'lib/bolognese/metadata.rb', line 11

def style=(value)
  @style = value
end

#subjects ⇒ Object 



145
146
147
 
# File 'lib/bolognese/metadata.rb', line 145

def subjects
  @subjects ||= meta.fetch("subjects", nil)
end

#titles ⇒ Object 



225
226
227
 
# File 'lib/bolognese/metadata.rb', line 225

def titles
  @titles ||= meta.fetch("titles", nil)
end

#types ⇒ Object 



221
222
223
 
# File 'lib/bolognese/metadata.rb', line 221

def types
  @types ||= meta.fetch("types", nil)
end

#url ⇒ Object 



173
174
175
 
# File 'lib/bolognese/metadata.rb', line 173

def url
  @url ||= meta.fetch("url", nil)
end

#version_info ⇒ Object 



177
178
179
 
# File 'lib/bolognese/metadata.rb', line 177

def version_info
  @version_info ||= meta.fetch("version_info", nil)
end

#volume=(value) ⇒ Object (writeonly)

Sets the attribute volume

Parameters:

  • value —

    the value to set the attribute volume to.



11
12
13
 
# File 'lib/bolognese/metadata.rb', line 11

def volume=(value)
  @volume = value
end

Instance Method Details

#errors ⇒ Object

validate against DataCite schema, unless there are already errors in the reader



133
134
135
 
# File 'lib/bolognese/metadata.rb', line 133

def errors
  meta.fetch("errors", nil) || datacite_errors(xml: datacite, schema_version: schema_version)
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/bolognese/metadata.rb', line 124

def exists?
  (@state || meta.fetch("state", "not_found")) != "not_found"
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/bolognese/metadata.rb', line 128

def valid?
  exists? && errors.nil?
end