Module: Jekyll::Scholar::Utilities

Included in:
BibTeXConverter, BibTeXTag, BibliographyCountTag, BibliographyTag, CiteDetailsTag, CiteTag, Details, DetailsGenerator, 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.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def config
  @config
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def context
  @context
end

#max ⇒ Object (readonly)

Returns the value of attribute max.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def max
  @max
end

#offset ⇒ Object (readonly)

Returns the value of attribute offset.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def offset
  @offset
end

#prefix ⇒ Object (readonly)

Returns the value of attribute prefix.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def prefix
  @prefix
end

#site ⇒ Object (readonly)

Returns the value of attribute site.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def site
  @site
end

#text ⇒ Object (readonly)

Returns the value of attribute text.



16
17
18
 
# File 'lib/jekyll/scholar/utilities.rb', line 16

def text
  @text
end

Instance Method Details

#base_url ⇒ Object 



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

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

#bibliography ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/jekyll/scholar/utilities.rb', line 159

def bibliography
  unless @bibliography
    @bibliography = BibTeX::Bibliography.parse(
      bibtex_paths.reduce('') { |s, p| s << IO.read(p) },
      bibtex_options
    )
    @bibliography.replace_strings if replace_strings?
    @bibliography.join if join_strings? && replace_strings?
  end

  @bibliography
end

#bibliography_list_tag ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/jekyll/scholar/utilities.rb', line 108

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

#bibliography_tag(entry, index) ⇒ Object 



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/jekyll/scholar/utilities.rb', line 476

def bibliography_tag(entry, index)
  return missing_reference unless entry

  tmp = liquid_template.render(
    reference_data(entry,index)
      .merge(site.site_payload)
      .merge({
        'index' => index,
        'details' => details_link_for(entry)
      }),
    {
      :registers => { :site => site },
      :filters => [Jekyll::Filters]
    }
  )
  # process the generated reference with Liquid, to get the same behaviour as
  # when it is used on a page
  Liquid::Template.parse(tmp).render(
    site.site_payload,
    {
      :registers => { :site => site },
      :filters => [Jekyll::Filters]
    }
  )
end

#bibliography_template ⇒ Object 



456
457
458
 
# File 'lib/jekyll/scholar/utilities.rb', line 456

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

#bibtex_file ⇒ Object

:nodoc: backwards compatibility



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

def bibtex_file
  bibtex_files[0]
end

#bibtex_files ⇒ Object 



124
125
126
127
128
129
130
131
 
# File 'lib/jekyll/scholar/utilities.rb', line 124

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 



143
144
145
 
# File 'lib/jekyll/scholar/utilities.rb', line 143

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

#bibtex_options ⇒ Object 



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

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

#bibtex_path ⇒ Object

:nodoc: backwards compatibility



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

def bibtex_path
  bibtex_paths[0]
end

#bibtex_paths ⇒ Object 



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

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

#citation_item_for(entry, citation_number = nil) ⇒ Object 



629
630
631
632
633
634
635
 
# File 'lib/jekyll/scholar/utilities.rb', line 629

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 



641
642
643
 
# File 'lib/jekyll/scholar/utilities.rb', line 641

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

#cite(keys) ⇒ Object 



649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/jekyll/scholar/utilities.rb', line 649

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 



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

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 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/jekyll/scholar/utilities.rb', line 752

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
  end

  items
end

#cited_keys ⇒ Object 



637
638
639
 
# File 'lib/jekyll/scholar/utilities.rb', line 637

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

#cited_only? ⇒ Boolean

Returns:

  • (Boolean) 


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

def cited_only?
  !!@cited
end

#cited_references ⇒ Object 



690
691
692
 
# File 'lib/jekyll/scholar/utilities.rb', line 690

def cited_references
  context && cited_keys
end

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



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/jekyll/scholar/utilities.rb', line 670

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

#details_file_for(entry) ⇒ Object 



559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/jekyll/scholar/utilities.rb', line 559

def details_file_for(entry)
  name = entry.key.to_s.dup

  name.gsub!(/[:\s]+/, '_')

  if site.config['permalink'] == 'pretty'
    name << '/'
  elsif site.config['permalink'].end_with? '/'
    name << '/'
  else
    name << '.html'
  end
end

#details_link_for(entry, base = base_url) ⇒ Object 



592
593
594
 
# File 'lib/jekyll/scholar/utilities.rb', line 592

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

#details_path ⇒ Object 



600
601
602
 
# File 'lib/jekyll/scholar/utilities.rb', line 600

def details_path
  config['details_dir']
end

#entries ⇒ Object 



176
177
178
 
# File 'lib/jekyll/scholar/utilities.rb', line 176

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

#extend_path(name) ⇒ Object 



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

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.exists?(name)

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

#generate_details? ⇒ Boolean

Returns:

  • (Boolean) 


555
556
557
 
# File 'lib/jekyll/scholar/utilities.rb', line 555

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

#group(ungrouped) ⇒ Object 



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

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) 


233
234
235
 
# File 'lib/jekyll/scholar/utilities.rb', line 233

def group?
  group_by != 'none'
end

#group_by ⇒ Object 



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

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

#group_compare(key, v1, v2) ⇒ Object 



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

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 



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

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 



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/jekyll/scholar/utilities.rb', line 319

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 



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

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

#group_order=(value) ⇒ Object 



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

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

#group_tags ⇒ Object 



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

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 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/jekyll/scholar/utilities.rb', line 295

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 



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

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 



703
704
705
706
707
708
709
 
# File 'lib/jekyll/scholar/utilities.rb', line 703

def interpolate(string)
  return unless string

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

#join_strings? ⇒ Boolean

Returns:

  • (Boolean) 


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

def join_strings?
  config['join_strings']
end

#keys ⇒ Object 



694
695
696
697
698
699
700
701
 
# File 'lib/jekyll/scholar/utilities.rb', line 694

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 



120
121
122
 
# File 'lib/jekyll/scholar/utilities.rb', line 120

def labels
  @labels ||= []
end

#limit_entries? ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/jekyll/scholar/utilities.rb', line 188

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

#link_target_for(key) ⇒ Object 



645
646
647
 
# File 'lib/jekyll/scholar/utilities.rb', line 645

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

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



686
687
688
 
# File 'lib/jekyll/scholar/utilities.rb', line 686

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

#liquid_template ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/jekyll/scholar/utilities.rb', line 460

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 



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/jekyll/scholar/utilities.rb', line 513

def liquidify(entry)
  e = {}

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

  if entry.field_names(config['bibtex_skip_fields']).empty?
    e['bibtex'] = entry.to_s({ quotes: config['bibtex_quotes'] })
  else
    tmp = entry.dup

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

    e['bibtex'] = tmp.to_s({ quotes: config['bibtex_quotes'] })
  end

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

  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 



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/jekyll/scholar/utilities.rb', line 364

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 



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/jekyll/scholar/utilities.rb', line 717

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

#locators ⇒ Object 



116
117
118
 
# File 'lib/jekyll/scholar/utilities.rb', line 116

def locators
  @locators ||= []
end

#missing_reference ⇒ Object 



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

def missing_reference
  config['missing_reference']
end

#month_names ⇒ Object 



342
343
344
345
346
 
# File 'lib/jekyll/scholar/utilities.rb', line 342

def month_names
  return @month_names unless @month_names.nil?

  @month_names = config['month_names'].nil? ? Date::MONTHNAMES : config['month_names'].unshift(nil)
end

#optparse(arguments) ⇒ Object 



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/jekyll/scholar/utilities.rb', line 29

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('-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-[cCfhqptTsgGOlLomA]|\B--(?:cited(_in_order)?|bibliography_list_tag|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|label|offset|max|suppress_author|))/)

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

#query ⇒ Object 



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

def query
  interpolate @query
end

#raw_bibtex? ⇒ Boolean

Returns:

  • (Boolean) 


352
353
354
 
# File 'lib/jekyll/scholar/utilities.rb', line 352

def raw_bibtex?
  config['use_raw_bibtex_entry']
end

#reference_data(entry, index = nil) ⇒ Object 



502
503
504
505
506
507
508
509
510
511
 
# File 'lib/jekyll/scholar/utilities.rb', line 502

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 



434
435
436
437
438
439
440
441
442
 
# File 'lib/jekyll/scholar/utilities.rb', line 434

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 



452
453
454
 
# File 'lib/jekyll/scholar/utilities.rb', line 452

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

#relative ⇒ Object 



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

def relative
  config['relative']
end

#render_bibliography(entry, index = nil) ⇒ Object 



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

def render_bibliography(entry, index = nil)
  renderer.render citation_item_for(entry, index),
    styles(style).bibliography
end

#render_citation(items) ⇒ Object 



611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/jekyll/scholar/utilities.rb', line 611

def render_citation(items)
  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

#renderer(force = false) ⇒ Object 



604
605
606
607
608
609
 
# File 'lib/jekyll/scholar/utilities.rb', line 604

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

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

#replace_strings? ⇒ Boolean

Returns:

  • (Boolean) 


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

def replace_strings?
  config['replace_strings']
end

#repository ⇒ Object 



360
361
362
 
# File 'lib/jekyll/scholar/utilities.rb', line 360

def repository
  @repository ||= load_repository
end

#repository? ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
 
# File 'lib/jekyll/scholar/utilities.rb', line 356

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

#repository_file_delimiter ⇒ Object 



387
388
389
 
# File 'lib/jekyll/scholar/utilities.rb', line 387

def repository_file_delimiter
  config['repository_file_delimiter']
end

#repository_link_for(entry, base = base_url) ⇒ Object 



573
574
575
576
577
578
579
580
581
582
 
# File 'lib/jekyll/scholar/utilities.rb', line 573

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 



584
585
586
587
588
589
590
 
# File 'lib/jekyll/scholar/utilities.rb', line 584

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 



383
384
385
 
# File 'lib/jekyll/scholar/utilities.rb', line 383

def repository_path
  config['repository']
end

#scholar_source ⇒ Object 



421
422
423
424
425
426
427
428
 
# File 'lib/jekyll/scholar/utilities.rb', line 421

def scholar_source
  source = config['source']

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

  File.join site.source, source
end

#set_context_to(context) ⇒ Object 



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

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

#skip_sort? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#sort(unsorted) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/jekyll/scholar/utilities.rb', line 192

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 



212
213
214
215
216
217
218
219
 
# File 'lib/jekyll/scholar/utilities.rb', line 212

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 



221
222
223
224
225
226
227
 
# File 'lib/jekyll/scholar/utilities.rb', line 221

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 



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

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 



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

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

#styles(style) ⇒ Object 



736
737
738
 
# File 'lib/jekyll/scholar/utilities.rb', line 736

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

#suppress_author? ⇒ Boolean

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/jekyll/scholar/utilities.rb', line 348

def suppress_author?
  !!@suppress_author
end

#type_aliases ⇒ Object 



334
335
336
 
# File 'lib/jekyll/scholar/utilities.rb', line 334

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

#type_names ⇒ Object 



338
339
340
 
# File 'lib/jekyll/scholar/utilities.rb', line 338

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

#type_order ⇒ Object 



330
331
332
 
# File 'lib/jekyll/scholar/utilities.rb', line 330

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

#update_dependency_tree ⇒ Object 



740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/jekyll/scholar/utilities.rb', line 740

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