Module: Jekyll::Scholar::Utilities

Included in:
BibTeXConverter, BibTeXTag, BibliographyCountTag, BibliographyTag, CiteDetailsTag, CiteTag, Details, DetailsGenerator, DetailsLinkTag, NoCiteTag, QuoteTag, ReferenceTag
Defined in:
lib/jekyll/scholar/utilities.rb

Overview

Utility methods used by several Scholar plugins. The methods in this module may depend on the presence of #config, #bibtex_files, and #site readers

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def config
  @config
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def context
  @context
end

#max ⇒ Object (readonly)

Returns the value of attribute max.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def max
  @max
end

#offset ⇒ Object (readonly)

Returns the value of attribute offset.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def offset
  @offset
end

#prefix ⇒ Object (readonly)

Returns the value of attribute prefix.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def prefix
  @prefix
end

#site ⇒ Object (readonly)

Returns the value of attribute site.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def site
  @site
end

#text ⇒ Object (readonly)

Returns the value of attribute text.



18
19
20
 
# File 'lib/jekyll/scholar/utilities.rb', line 18

def text
  @text
end

Instance Method Details

#allow_locale_overrides? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/jekyll/scholar/utilities.rb', line 128

def allow_locale_overrides?
  !!config['allow_locale_overrides']
end

#base_url ⇒ Object 



665
666
667
668
669
 
# File 'lib/jekyll/scholar/utilities.rb', line 665

def base_url
  @base_url ||= (
    site.config['baseurl'] || site.config['base_url'] || ''
  ).to_s
end

#bibliography ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/jekyll/scholar/utilities.rb', line 184

def bibliography
  paths = bibtex_paths

  # Clear @bibliography if sources change! See #282
  unless @paths.nil? || @paths == paths
    @bibliography = nil
  end

  unless @bibliography
    @bibliography = BibTeX::Bibliography.parse(
      paths.reduce('') { |s, p| s << IO.read(p) },
      bibtex_options
    )

    @paths = paths

    @bibliography.replace_strings if replace_strings?
    @bibliography.join if join_strings? && replace_strings?

    # Remove duplicate entries
    @bibliography.uniq!(*match_fields) if remove_duplicates?
  end

  @bibliography
end

#bibliography_list_tag ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/jekyll/scholar/utilities.rb', line 120

def bibliography_list_tag
  if @bibliography_list_tag.nil?
    config['bibliography_list_tag']
  else
    @bibliography_list_tag
  end
end

#bibliography_stale? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
 
# File 'lib/jekyll/scholar/utilities.rb', line 210

def bibliography_stale?
end

#bibliography_tag(entry, index) ⇒ Object 



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/jekyll/scholar/utilities.rb', line 522

def bibliography_tag(entry, index)
  return missing_reference unless entry

  liquid_template.render(
    reference_data(entry,index)
    .merge(site.site_payload)
    .merge({
    'index' => index,
    'page' => context.registers[:page],
    'details' => details_link_for(entry)
  }),
  {
    :registers => context.registers,
    :filters => [Jekyll::Filters]
  })
end

#bibliography_template ⇒ Object 



502
503
504
 
# File 'lib/jekyll/scholar/utilities.rb', line 502

def bibliography_template
  @bibliography_template || config['bibliography_template']
end

#bibtex_file ⇒ Object

:nodoc: backwards compatibility



155
156
157
 
# File 'lib/jekyll/scholar/utilities.rb', line 155

def bibtex_file
  bibtex_files[0]
end

#bibtex_files ⇒ Object 



145
146
147
148
149
150
151
152
 
# File 'lib/jekyll/scholar/utilities.rb', line 145

def bibtex_files
  if config['bibliography'].include? '*'
    @bibtex_files ||= Dir.glob(File.join(config["source"], config['bibliography'])).collect do |f|
      Pathname(f).relative_path_from(Pathname(config['source'])).to_s
    end
  end
  @bibtex_files ||= [config['bibliography']]
end

#bibtex_filters ⇒ Object 



164
165
166
 
# File 'lib/jekyll/scholar/utilities.rb', line 164

def bibtex_filters
  config['bibtex_filters'] ||= []
end

#bibtex_options ⇒ Object 



159
160
161
162
 
# File 'lib/jekyll/scholar/utilities.rb', line 159

def bibtex_options
  @bibtex_options ||=
    (config['bibtex_options'] || {}).symbolize_keys
end

#bibtex_path ⇒ Object

:nodoc: backwards compatibility



180
181
182
 
# File 'lib/jekyll/scholar/utilities.rb', line 180

def bibtex_path
  bibtex_paths[0]
end

#bibtex_paths ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/jekyll/scholar/utilities.rb', line 172

def bibtex_paths
  bibtex_files.map { |file|
    interpolated_file = interpolate file
    extend_path interpolated_file
  }
end

#citation_item_for(entry, citation_number = nil) ⇒ Object 



710
711
712
713
714
715
716
 
# File 'lib/jekyll/scholar/utilities.rb', line 710

def citation_item_for(entry, citation_number = nil)
  CiteProc::CitationItem.new id: entry.id do |c|
    c.data = CiteProc::Item.new entry.to_citeproc
    c.data[:'citation-number'] = citation_number
    c.data.suppress! 'author' if suppress_author?
  end
end

#citation_number(key) ⇒ Object 



722
723
724
 
# File 'lib/jekyll/scholar/utilities.rb', line 722

def citation_number(key)
  (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
end

#cite(keys) ⇒ Object 



730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/jekyll/scholar/utilities.rb', line 730

def cite(keys)
  items = keys.map do |key|
    if bibliography.key?(key)
      entry = bibliography[key]
      entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
    else
      return missing_reference
    end
  end

  link_to link_target_for(keys[0]), render_citation(items), {class: config['cite_class']}
end

#cite_details(key, text) ⇒ Object 



755
756
757
758
759
760
761
 
# File 'lib/jekyll/scholar/utilities.rb', line 755

def cite_details(key, text)
  if bibliography.key?(key)
    link_to details_link_for(bibliography[key]), text || config['details_link']
  else
    missing_reference
  end
end

#cited_entries ⇒ Object 



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/jekyll/scholar/utilities.rb', line 858

def cited_entries
  items = entries
  if cited_only?
    items = if skip_sort?
              cited_references.uniq.map do |key|
                items.detect { |e| e.key == key }
              end
            else
              entries.select do |e|
                cited_references.include? e.key
              end
            end

    # See #90
    cited_keys.clear if clear?
  end

  items
end

#cited_keys ⇒ Object 



718
719
720
 
# File 'lib/jekyll/scholar/utilities.rb', line 718

def cited_keys
  context['cited'] = context.environments.first['page']['cited']  ||= []
end

#cited_only? ⇒ Boolean

Returns:

  • (Boolean) 


441
442
443
 
# File 'lib/jekyll/scholar/utilities.rb', line 441

def cited_only?
  !!@cited
end

#cited_references ⇒ Object 



791
792
793
 
# File 'lib/jekyll/scholar/utilities.rb', line 791

def cited_references
  context && cited_keys
end

#clear? ⇒ Boolean

Returns:

  • (Boolean) 


445
446
447
 
# File 'lib/jekyll/scholar/utilities.rb', line 445

def clear?
  !!@clear
end

#content_tag(name, content_or_attributes, attributes = {}) ⇒ Object 



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/jekyll/scholar/utilities.rb', line 771

def content_tag(name, content_or_attributes, attributes = {})
  if content_or_attributes.is_a?(Hash)
    content, attributes = nil, content_or_attributes
  else
    content = content_or_attributes
  end

  attributes = attributes.map { |k,v| %Q(#{k}="#{v}") }

  if content.nil?
    "<#{[name, attributes].flatten.compact.join(' ')}/>"
  else
    "<#{[name, attributes].flatten.compact.join(' ')}>#{content}</#{name}>"
  end
end

#csl_renderer(force = false) ⇒ Object 



675
676
677
678
679
680
 
# File 'lib/jekyll/scholar/utilities.rb', line 675

def csl_renderer(force = false)
  return @csl_renderer if @csl_renderer && !force

  @csl_renderer = CiteProc::Ruby::Renderer.new :format => 'html',
    :style => style, :locale => config['locale']
end

#details_link(key) ⇒ Object 



763
764
765
766
767
768
769
 
# File 'lib/jekyll/scholar/utilities.rb', line 763

def details_link(key)
  if bibliography.key?(key)
    details_link_for(bibliography[key])
  else
    raise Exception.new "Could not find entry for key '%s'" % key
  end
end

#details_link_for(entry, base = base_url) ⇒ Object 



625
626
627
 
# File 'lib/jekyll/scholar/utilities.rb', line 625

def details_link_for(entry, base = base_url)
  File.join(base, details_path_for(entry))
end

#details_path ⇒ Object 



671
672
673
 
# File 'lib/jekyll/scholar/utilities.rb', line 671

def details_path
  config['details_dir']
end

#details_path_for(entry) ⇒ Object 



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/jekyll/scholar/utilities.rb', line 629

def details_path_for(entry)
  # Expand the details_permalink template into the complete URL for this entry.

  # First generate placeholders for all items in the bibtex entry
  url_placeholders = {}
  entry.fields.each_pair do |k, v| 
    value = v.to_s.dup
    value = Jekyll::Utils::slugify(value, :mode => 'pretty') unless k == :doi
    url_placeholders[k] = value
  end
  # Maintain the same URLs are previous versions of jekyll-scholar
  # by replicating the way that it processed the key.
  url_placeholders[:key] = entry.key.to_s.gsub(/[:\s]+/, '_')
  url_placeholders[:details_dir] = details_path

  # Autodetect the appropriate file extension based upon the site config,
  # using the same rules as previous versions of jekyll-scholar. Users can
  # override these settings by defining a details_permalink
  # without the :extension field.
  if (site.config['permalink'] == 'pretty') || (site.config['permalink'].end_with? '/')
    url_placeholders[:extension] = '/'
  else
    url_placeholders[:extension] = '.html'
  end

  # Overwrite 'doi' key with the citation key if DOI field is empty or missing
  if !entry.has_field?('doi') || entry.doi.empty?
    url_placeholders[:doi] = url_placeholders[:key]
  end

  URL.new(
    template: config['details_permalink'],
    placeholders: url_placeholders
  ).to_s
end

#entries ⇒ Object 



218
219
220
 
# File 'lib/jekyll/scholar/utilities.rb', line 218

def entries
  sort bibliography[query || config['query']].select { |x| x.instance_of? BibTeX::Entry}
end

#extend_path(name) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/jekyll/scholar/utilities.rb', line 453

def extend_path(name)
  if name.nil? || name.empty?
    name = config['bibliography']
  end

  # Return as is if it is an absolute path
  # Improve by using Pathname from stdlib?
  return name if name.start_with?('/') && File.exist?(name)

  name = File.join scholar_source, name
  name << '.bib' if File.extname(name).empty? && !File.exist?(name)
  name
end

#generate_details? ⇒ Boolean

Returns:

  • (Boolean) 


602
603
604
 
# File 'lib/jekyll/scholar/utilities.rb', line 602

def generate_details?
  site.layouts.key?(File.basename(config['details_layout'], '.html'))
end

#generate_details_link? ⇒ Boolean

Returns:

  • (Boolean) 


595
596
597
598
599
600
 
# File 'lib/jekyll/scholar/utilities.rb', line 595

def generate_details_link?
  if !config['details_link'] then
    return false
  end
  return true
end

#group(ungrouped) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/jekyll/scholar/utilities.rb', line 279

def group(ungrouped)
  def grouper(items, keys, order)
    groups = items.group_by do |item|
      group_value(keys.first, item)
    end

    if keys.count == 1
      groups
    else
      groups.merge(groups) do |key, items|
        grouper(items, keys.drop(1), order.drop(1))
      end
    end
  end

  grouper(ungrouped, group_keys, group_order)
end

#group? ⇒ Boolean

Returns:

  • (Boolean) 


275
276
277
 
# File 'lib/jekyll/scholar/utilities.rb', line 275

def group?
  group_by != 'none'
end

#group_by ⇒ Object 



271
272
273
 
# File 'lib/jekyll/scholar/utilities.rb', line 271

def group_by
  @group_by = interpolate(@group_by) || config['group_by']
end

#group_compare(key, v1, v2) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/jekyll/scholar/utilities.rb', line 318

def group_compare(key,v1,v2)
  case key
  when 'type'
    o1 = type_order.find_index(v1)
    o2 = type_order.find_index(v2)
    if o1.nil? && o2.nil?
      0
    elsif o1.nil?
      1
    elsif o2.nil?
      -1
    else
      o1 <=> o2
    end
  else
    v1 <=> v2
  end
end

#group_keys ⇒ Object 



298
299
300
301
302
303
304
305
 
# File 'lib/jekyll/scholar/utilities.rb', line 298

def group_keys
  return @group_keys unless @group_keys.nil?

  @group_keys = Array(group_by)
    .map { |key| key.to_s.split(/\s*,\s*/) }
    .flatten
    .map { |key| key == 'month' ? 'month_numeric' : key }
end

#group_name(key, value) ⇒ Object 



361
362
363
364
365
366
367
368
369
370
 
# File 'lib/jekyll/scholar/utilities.rb', line 361

def group_name(key,value)
  case key
  when 'type'
    type_names[value] || value.to_s
  when 'month_numeric'
    month_names[value] || "(unknown)"
  else
    value.to_s
  end
end

#group_order ⇒ Object 



307
308
309
310
 
# File 'lib/jekyll/scholar/utilities.rb', line 307

def group_order
  self.group_order = config['group_order'] if @group_order.nil?
  @group_order
end

#group_order=(value) ⇒ Object 



312
313
314
315
316
 
# File 'lib/jekyll/scholar/utilities.rb', line 312

def group_order=(value)
  @group_order = Array(value)
    .map { |key| key.to_s.split(/\s*,\s*/) }
    .flatten
end

#group_tags ⇒ Object 



353
354
355
356
357
358
359
 
# File 'lib/jekyll/scholar/utilities.rb', line 353

def group_tags
  return @group_tags unless @group_tags.nil?

  @group_tags = Array(config['bibliography_group_tag'])
    .map { |key| key.to_s.split(/\s*,\s*/) }
    .flatten
end

#group_value(key, item) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/jekyll/scholar/utilities.rb', line 337

def group_value(key,item)
  case key
  when 'type'
    type_aliases[item.type.to_s] || item.type.to_s
  else
    value = item[key]
    if value.numeric?
      value.to_i
    elsif value.date?
      value.to_date
    else
      value.to_s
    end
  end
end

#grouper(items, keys, order) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/jekyll/scholar/utilities.rb', line 280

def grouper(items, keys, order)
  groups = items.group_by do |item|
    group_value(keys.first, item)
  end

  if keys.count == 1
    groups
  else
    groups.merge(groups) do |key, items|
      grouper(items, keys.drop(1), order.drop(1))
    end
  end
end

#interpolate(string) ⇒ Object 



804
805
806
807
808
809
810
 
# File 'lib/jekyll/scholar/utilities.rb', line 804

def interpolate(string)
  return unless string

  string.gsub(/{{\s*([\w\.]+)\s*}}/) do |match|
    context[$1] || match
  end
end

#join_strings? ⇒ Boolean

Returns:

  • (Boolean) 


437
438
439
 
# File 'lib/jekyll/scholar/utilities.rb', line 437

def join_strings?
  config['join_strings']
end

#keys ⇒ Object 



795
796
797
798
799
800
801
802
 
# File 'lib/jekyll/scholar/utilities.rb', line 795

def keys
  # De-reference keys (in case they are variables)
  # We need to do this every time, to support for loops,
  # where the context can change for each invocation.
  Array(@keys).map do |key|
    context[key] || key
  end
end

#labels ⇒ Object 



141
142
143
 
# File 'lib/jekyll/scholar/utilities.rb', line 141

def labels
  @labels ||= []
end

#limit_entries? ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
 
# File 'lib/jekyll/scholar/utilities.rb', line 230

def limit_entries?
  !offset.nil? || !max.nil?
end

#link_target_for(key) ⇒ Object 



726
727
728
 
# File 'lib/jekyll/scholar/utilities.rb', line 726

def link_target_for(key)
  "#{relative}##{[prefix, key].compact.join('-')}"
end

#link_to(href, content, attributes = {}) ⇒ Object 



787
788
789
 
# File 'lib/jekyll/scholar/utilities.rb', line 787

def link_to(href, content, attributes = {})
  content_tag :a, content || href, attributes.merge(:href => href)
end

#liquid_template ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/jekyll/scholar/utilities.rb', line 506

def liquid_template
  return @liquid_template if @liquid_template
  Liquid::Template.register_filter(Jekyll::Filters)

  tmp = bibliography_template

  case
  when tmp.nil?, tmp.empty?
    tmp = '{{reference}}'
  when site.layouts.key?(tmp)
    tmp = site.layouts[tmp].content
  end

  @liquid_template = Liquid::Template.parse(tmp)
end

#liquidify(entry) ⇒ Object 



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/jekyll/scholar/utilities.rb', line 550

def liquidify(entry)
  e = {}

  e['key'] = entry.key
  e['type'] = entry.type.to_s

  conv_opts = { quotes: config['bibtex_quotes'] }
  if !raw_bibtex_filters.empty?
    conv_opts[:filter] = *raw_bibtex_filters
  end

  if entry.field_names(config['bibtex_skip_fields']).empty?
    e['bibtex'] = entry.to_s(conv_opts)
  else
    tmp = entry.dup

    config['bibtex_skip_fields'].each do |name|
      tmp.delete name if tmp.field?(name)
    end

    e['bibtex'] = tmp.to_s(conv_opts)
  end

  #e['raw_bibtex'] = "{%raw%}#{e['bibtex']}{%endraw%}"

  entry.fields.each do |key, value|
    value = value.convert(*bibtex_filters) unless bibtex_filters.empty?
    e[key.to_s] = value.to_s

    if value.is_a?(BibTeX::Names)
      e["#{key}_array"] = arr = []
      value.each.with_index do |name, idx|
        parts = {}
        name.each_pair do |k, v|
          e["#{key}_#{idx}_#{k}"] = v.to_s
          parts[k.to_s] = v.to_s
        end
        arr << parts
      end
    end
  end

  e
end

#load_repository ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/jekyll/scholar/utilities.rb', line 406

def load_repository
  repo = Hash.new { |h,k| h[k] = {} }

  return repo unless repository?

  # ensure that the base directory format is literally
  # the same as the entries that are in the directory
  base = Dir[site.source][0]

  Dir[File.join(site.source, repository_path, '**/*')].each do |path|
    parts = Pathname(path).relative_path_from(Pathname(File.join(base, repository_path)))
    parts = parts.to_path.split(repository_file_delimiter, 2)
    repo[parts[0]][parts[1]] =
      Pathname(path).relative_path_from(Pathname(base))
  end

  repo
end

#load_style(uri) ⇒ Object 



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/jekyll/scholar/utilities.rb', line 819

def load_style(uri)
  begin
    style = CSL::Style.load uri
  rescue CSL::ParseError => error
    # Try to resolve local style paths
    # relative to Jekyll's source directory
    site_relative_style = File.join(site.source, uri)

    raise error unless File.exist?(site_relative_style)
    style = CSL::Style.load site_relative_style
  end

  if style.independent?
    style
  else
    style.independent_parent
  end
end

#locales(lang) ⇒ Object 



842
843
844
 
# File 'lib/jekyll/scholar/utilities.rb', line 842

def locales(lang)
  LOCALES[lang] ||= CSL::Locale.load(lang)
end

#locators ⇒ Object 



137
138
139
 
# File 'lib/jekyll/scholar/utilities.rb', line 137

def locators
  @locators ||= []
end

#match_fields ⇒ Object 



133
134
135
 
# File 'lib/jekyll/scholar/utilities.rb', line 133

def match_fields
  @match_fields ||= []
end

#missing_reference ⇒ Object 



494
495
496
 
# File 'lib/jekyll/scholar/utilities.rb', line 494

def missing_reference
  config['missing_reference']
end

#month_names ⇒ Object 



384
385
386
387
388
 
# File 'lib/jekyll/scholar/utilities.rb', line 384

def month_names
  return @month_names unless @month_names.nil?

  @month_names = config['month_names'].nil? ? Date::MONTHNAMES : [nil] + config['month_names']
end

#nocite(keys) ⇒ Object 



743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/jekyll/scholar/utilities.rb', line 743

def nocite(keys)
  items = keys.map do |key|
    if bibliography.key?(key)
      entry = bibliography[key]
      cited_keys << entry.key
      cited_keys.uniq!
    else
      return missing_reference
    end
  end
end

#optparse(arguments) ⇒ Object 



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
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/jekyll/scholar/utilities.rb', line 31

def optparse(arguments)
  return if arguments.nil? || arguments.empty?

  parser = OptionParser.new do |opts|

    opts.on('-c', '--cited') do |cited|
      @cited = true
    end

    opts.on('-C', '--cited_in_order') do |cited|
      @cited, @skip_sort = true, true
    end

    opts.on('--clear') do |cited|
      @clear = true
    end

    opts.on('-r', '--remove_duplicates [MATCH_FIELDS]') do |match_field|
      @remove_duplicates = true
      @match_fields = match_field.split(/,\s+/) if not match_field.nil? 
    end

    opts.on('-A', '--suppress_author') do |cited|
      @suppress_author = true
    end

    opts.on('-f', '--file FILE') do |file|
      @bibtex_files ||= []
      @bibtex_files << file
    end

    opts.on('-q', '--query QUERY') do |query|
      @query = query
    end

    opts.on('-h', '--bibliography_list_tag TAG') do |tag|
      @bibliography_list_tag = tag
    end

    opts.on('-p', '--prefix PREFIX') do |prefix|
      @prefix = prefix
    end

    opts.on('-t', '--text TEXT') do |text|
      @text = text
    end

    opts.on('-l', '--locator LOCATOR') do |locator|
      locators << locator
    end

    opts.on('-L', '--label LABEL') do |label|
      labels << label
    end

    opts.on('-o', '--offset OFFSET') do |offset|
      @offset = offset.to_i
    end

    opts.on('-m', '--max MAX') do |max|
      @max = max.to_i
    end

    opts.on('-s', '--style STYLE') do |style|
      @style = style
    end

    opts.on('-g', '--group_by GROUP') do |group_by|
      @group_by = group_by
    end

    opts.on('-G', '--group_order ORDER') do |group_order|
      self.group_order = group_order
    end

    opts.on('-O', '--type_order ORDER') do |type_order|
      @group_by = type_order
    end

    opts.on('-T', '--template TEMPLATE') do |template|
      @bibliography_template = template
    end
  end

  argv = arguments.split(/(\B-[cCfhqptTsgGOlLomAr]|\B--(?:cited(_in_order)?|clear|bibliography_list_tag|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|label|offset|max|suppress_author|remove_duplicates|))/)

  parser.parse argv.map(&:strip).reject(&:empty?)
end

#query ⇒ Object 



214
215
216
 
# File 'lib/jekyll/scholar/utilities.rb', line 214

def query
  interpolate @query
end

#raw_bibtex_filters ⇒ Object 



168
169
170
 
# File 'lib/jekyll/scholar/utilities.rb', line 168

def raw_bibtex_filters
  config['raw_bibtex_filters'] ||= []
end

#reference_data(entry, index = nil) ⇒ Object 



539
540
541
542
543
544
545
546
547
548
 
# File 'lib/jekyll/scholar/utilities.rb', line 539

def reference_data(entry, index = nil)
  {
    'entry' => liquidify(entry),
    'reference' => reference_tag(entry, index),
    'key' => entry.key,
    'type' => entry.type.to_s,
    'link' => repository_link_for(entry),
    'links' => repository_links_for(entry)
  }
end

#reference_tag(entry, index = nil) ⇒ Object 



480
481
482
483
484
485
486
487
488
 
# File 'lib/jekyll/scholar/utilities.rb', line 480

def reference_tag(entry, index = nil)
  return missing_reference unless entry

  entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
  reference = render_bibliography entry, index

  content_tag reference_tagname, reference,
    :id => [prefix, entry.key].compact.join('-')
end

#reference_tagname ⇒ Object 



498
499
500
 
# File 'lib/jekyll/scholar/utilities.rb', line 498

def reference_tagname
  config['reference_tagname'] || :span
end

#relative ⇒ Object 



476
477
478
 
# File 'lib/jekyll/scholar/utilities.rb', line 476

def relative
  config['relative']
end

#remove_duplicates? ⇒ Boolean

Returns:

  • (Boolean) 


390
391
392
 
# File 'lib/jekyll/scholar/utilities.rb', line 390

def remove_duplicates?
  @remove_duplicates || config['remove_duplicates']
end

#render_bibliography(entry, index = nil) ⇒ Object 



695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/jekyll/scholar/utilities.rb', line 695

def render_bibliography(entry, index = nil)
  begin
    original_locale = csl_renderer.locale
    csl_renderer.locale = locales(entry.language)
  rescue
    # Locale failed to load; just use original one!
  end if allow_locale_overrides? &&
    entry['language'] != csl_renderer.locale.language

  csl_renderer.render citation_item_for(entry, index),
    styles(style).bibliography
ensure
  csl_renderer.locale = original_locale unless original_locale.nil?
end

#render_citation(items) ⇒ Object 



682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/jekyll/scholar/utilities.rb', line 682

def render_citation(items)
  csl_renderer.render items.zip(locators.zip(labels)).map { |entry, (locator, label)|
    cited_keys << entry.key
    cited_keys.uniq!

    item = citation_item_for entry, citation_number(entry.key)
    item.locator = locator
    item.label = label unless label.nil?

    item
  }, styles(style).citation
end

#replace_strings? ⇒ Boolean

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/jekyll/scholar/utilities.rb', line 433

def replace_strings?
  config['replace_strings']
end

#repository ⇒ Object 



402
403
404
 
# File 'lib/jekyll/scholar/utilities.rb', line 402

def repository
  @repository ||= load_repository
end

#repository? ⇒ Boolean

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/jekyll/scholar/utilities.rb', line 398

def repository?
  !config['repository'].nil? && !config['repository'].empty?
end

#repository_file_delimiter ⇒ Object 



429
430
431
 
# File 'lib/jekyll/scholar/utilities.rb', line 429

def repository_file_delimiter
  config['repository_file_delimiter']
end

#repository_link_for(entry, base = base_url) ⇒ Object 



606
607
608
609
610
611
612
613
614
615
 
# File 'lib/jekyll/scholar/utilities.rb', line 606

def repository_link_for(entry, base = base_url)
  name = entry.key.to_s.dup
  name.gsub!(/[:\s]+/, '_')
  links = repository[name]
  url   = links['pdf'] || links['ps']

  return unless url

  File.join(base, url)
end

#repository_links_for(entry, base = base_url) ⇒ Object 



617
618
619
620
621
622
623
 
# File 'lib/jekyll/scholar/utilities.rb', line 617

def repository_links_for(entry, base = base_url)
  name = entry.key.to_s.dup
  name.gsub!(/[:\s]+/, '_')
  Hash[repository[name].map { |ext, url|
    [ext, File.join(base, url)]
  }]
end

#repository_path ⇒ Object 



425
426
427
 
# File 'lib/jekyll/scholar/utilities.rb', line 425

def repository_path
  config['repository']
end

#scholar_source ⇒ Object 



467
468
469
470
471
472
473
474
 
# File 'lib/jekyll/scholar/utilities.rb', line 467

def scholar_source
  source = config['source']

  # Improve by using Pathname from stdlib?
  return source if source.start_with?('/') && File.exist?(source)

  File.join site.source, source
end

#set_context_to(context) ⇒ Object 



812
813
814
815
816
817
 
# File 'lib/jekyll/scholar/utilities.rb', line 812

def set_context_to(context)
  @context, @site, page, = context, *context.registers.values_at(:site, :page)
  config.merge!(site.config['scholar'] || {})
  config.merge!(page['scholar'] || {})
  self
end

#skip_sort? ⇒ Boolean

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/jekyll/scholar/utilities.rb', line 449

def skip_sort?
  @skip_sort || config['sort_by'] == 'none'
end

#sort(unsorted) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/jekyll/scholar/utilities.rb', line 234

def sort(unsorted)
  return unsorted if skip_sort?

  sorted = unsorted.sort do |e1, e2|
    sort_keys
      .map.with_index do |key, idx|
      v1 = e1[key].nil? ? BibTeX::Value.new : e1[key]
      v2 = e2[key].nil? ? BibTeX::Value.new : e2[key]
      if (sort_order[idx] || sort_order.last) =~ /^(desc|reverse)/i
        v2 <=> v1
      else
        v1 <=> v2
      end
    end
      .find { |c| c != 0 } || 0
  end

  sorted
end

#sort_keys ⇒ Object 



254
255
256
257
258
259
260
261
 
# File 'lib/jekyll/scholar/utilities.rb', line 254

def sort_keys
  return @sort_keys unless @sort_keys.nil?

  @sort_keys = Array(config['sort_by'])
    .map { |key| key.to_s.split(/\s*,\s*/) }
    .flatten
    .map { |key| key == 'month' ? 'month_numeric' : key }
end

#sort_order ⇒ Object 



263
264
265
266
267
268
269
 
# File 'lib/jekyll/scholar/utilities.rb', line 263

def sort_order
  return @sort_order unless @sort_order.nil?

  @sort_order = Array(config['order'])
    .map { |key| key.to_s.split(/\s*,\s*/) }
    .flatten
end

#split_arguments(arguments) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def split_arguments(arguments)

  tokens = arguments.strip.split(/\s+/)

  args = tokens.take_while { |a| !a.start_with?('-') }
  opts = (tokens - args).join(' ')

  [args, opts]
end

#style ⇒ Object 



490
491
492
 
# File 'lib/jekyll/scholar/utilities.rb', line 490

def style
  interpolate(@style)|| config['style']
end

#styles(style) ⇒ Object 



838
839
840
 
# File 'lib/jekyll/scholar/utilities.rb', line 838

def styles(style)
  STYLES[style] ||= load_style(style)
end

#suppress_author? ⇒ Boolean

Returns:

  • (Boolean) 


394
395
396
 
# File 'lib/jekyll/scholar/utilities.rb', line 394

def suppress_author?
  !!@suppress_author
end

#type_aliases ⇒ Object 



376
377
378
 
# File 'lib/jekyll/scholar/utilities.rb', line 376

def type_aliases
  @type_aliases ||= Scholar.defaults['type_aliases'].merge(config['type_aliases'])
end

#type_names ⇒ Object 



380
381
382
 
# File 'lib/jekyll/scholar/utilities.rb', line 380

def type_names
  @type_names ||= Scholar.defaults['type_names'].merge(config['type_names'])
end

#type_order ⇒ Object 



372
373
374
 
# File 'lib/jekyll/scholar/utilities.rb', line 372

def type_order
  @type_order ||= config['type_order']
end

#update_dependency_tree ⇒ Object 



846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/jekyll/scholar/utilities.rb', line 846

def update_dependency_tree
  # Add bibtex files to dependency tree
  if context.registers[:page] and context.registers[:page].key? "path"
    bibtex_paths.each do |bibtex_path|
      site.regenerator.add_dependency(
        site.in_source_dir(context.registers[:page]["path"]),
        bibtex_path
      )
    end
  end
end