Module: Jekyll::Scholar::Utilities

Included in:
BibTeXConverter, BibTeXTag, 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.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def config
  @config
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def context
  @context
end

#max ⇒ Object (readonly)

Returns the value of attribute max.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def max
  @max
end

#offset ⇒ Object (readonly)

Returns the value of attribute offset.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def offset
  @offset
end

#prefix ⇒ Object (readonly)

Returns the value of attribute prefix.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def prefix
  @prefix
end

#site ⇒ Object (readonly)

Returns the value of attribute site.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def site
  @site
end

#text ⇒ Object (readonly)

Returns the value of attribute text.



21
22
23
 
# File 'lib/jekyll/scholar/utilities.rb', line 21

def text
  @text
end

Instance Method Details

#base_url ⇒ Object 



570
571
572
 
# File 'lib/jekyll/scholar/utilities.rb', line 570

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

#bibliography ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/jekyll/scholar/utilities.rb', line 146

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_tag(entry, index) ⇒ Object 



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/jekyll/scholar/utilities.rb', line 456

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 



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

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

#bibtex_file ⇒ Object

:nodoc: backwards compatibility



122
123
124
 
# File 'lib/jekyll/scholar/utilities.rb', line 122

def bibtex_file
  bibtex_files[0]
end

#bibtex_files ⇒ Object 



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

def bibtex_files
  @bibtex_files ||= [config['bibliography']]
end

#bibtex_filters ⇒ Object 



131
132
133
 
# File 'lib/jekyll/scholar/utilities.rb', line 131

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

#bibtex_options ⇒ Object 



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

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

#bibtex_path ⇒ Object

:nodoc: backwards compatibility



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

def bibtex_path
  bibtex_paths[0]
end

#bibtex_paths ⇒ Object 



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

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

#citation_item_for(entry, citation_number = nil) ⇒ Object 



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

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 



615
616
617
 
# File 'lib/jekyll/scholar/utilities.rb', line 615

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

#cite(keys) ⇒ Object 



623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/jekyll/scholar/utilities.rb', line 623

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)
end

#cite_details(key, text) ⇒ Object 



636
637
638
639
640
641
642
 
# File 'lib/jekyll/scholar/utilities.rb', line 636

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_keys ⇒ Object 



611
612
613
 
# File 'lib/jekyll/scholar/utilities.rb', line 611

def cited_keys
  context['cited'] ||= []
end

#cited_only? ⇒ Boolean

Returns:

  • (Boolean) 


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

def cited_only?
  !!@cited
end

#cited_references ⇒ Object 



664
665
666
 
# File 'lib/jekyll/scholar/utilities.rb', line 664

def cited_references
  context && context['cited'] || []
end

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



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/jekyll/scholar/utilities.rb', line 644

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 



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

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

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

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

#details_link_for(entry, base = base_url) ⇒ Object 



566
567
568
 
# File 'lib/jekyll/scholar/utilities.rb', line 566

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

#details_path ⇒ Object 



574
575
576
 
# File 'lib/jekyll/scholar/utilities.rb', line 574

def details_path
  config['details_dir']
end

#entries ⇒ Object 



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

def entries
  sort bibliography[query || config['query']]
end

#extend_path(name) ⇒ Object 



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/jekyll/scholar/utilities.rb', line 387

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) 


535
536
537
 
# File 'lib/jekyll/scholar/utilities.rb', line 535

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

#group(ungrouped) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/jekyll/scholar/utilities.rb', line 224

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) 


220
221
222
 
# File 'lib/jekyll/scholar/utilities.rb', line 220

def group?
  group_by != 'none'
end

#group_by ⇒ Object 



216
217
218
 
# File 'lib/jekyll/scholar/utilities.rb', line 216

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

#group_compare(key, v1, v2) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/jekyll/scholar/utilities.rb', line 262

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 



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

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 



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/jekyll/scholar/utilities.rb', line 305

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 



251
252
253
254
 
# File 'lib/jekyll/scholar/utilities.rb', line 251

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

#group_order=(value) ⇒ Object 



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

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

#group_tags ⇒ Object 



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

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 



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

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 



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/jekyll/scholar/utilities.rb', line 225

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 



677
678
679
680
681
682
683
 
# File 'lib/jekyll/scholar/utilities.rb', line 677

def interpolate(string)
  return unless string

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

#join_strings? ⇒ Boolean

Returns:

  • (Boolean) 


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

def join_strings?
  config['join_strings']
end

#keys ⇒ Object 



668
669
670
671
672
673
674
675
 
# File 'lib/jekyll/scholar/utilities.rb', line 668

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 



113
114
115
 
# File 'lib/jekyll/scholar/utilities.rb', line 113

def labels
  @labels ||= []
end

#limit_entries? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#link_target_for(key) ⇒ Object 



619
620
621
 
# File 'lib/jekyll/scholar/utilities.rb', line 619

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

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



660
661
662
 
# File 'lib/jekyll/scholar/utilities.rb', line 660

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

#liquid_template ⇒ Object 



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/jekyll/scholar/utilities.rb', line 440

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 



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/jekyll/scholar/utilities.rb', line 493

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
  else
    tmp = entry.dup

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

    e['bibtex'] = tmp.to_s
  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 



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/jekyll/scholar/utilities.rb', line 350

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|
    extname = File.extname(path)
    repo[File.basename(path, extname)][extname[1..-1]] = Pathname(path).relative_path_from(Pathname(base))
  end

  repo
end

#locators ⇒ Object 



109
110
111
 
# File 'lib/jekyll/scholar/utilities.rb', line 109

def locators
  @locators ||= []
end

#missing_reference ⇒ Object 



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

def missing_reference
  config['missing_reference']
end

#month_names ⇒ Object 



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

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 



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
 
# File 'lib/jekyll/scholar/utilities.rb', line 34

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('-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-[cCfqptTsgGOlLomA]|\B--(?:cited(_in_order)?|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 



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

def query
  interpolate @query
end

#raw_bibtex? ⇒ Boolean

Returns:

  • (Boolean) 


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

def raw_bibtex?
  config['use_raw_bibtex_entry']
end

#reference_data(entry, index = nil) ⇒ Object 



482
483
484
485
486
487
488
489
490
491
 
# File 'lib/jekyll/scholar/utilities.rb', line 482

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 



414
415
416
417
418
419
420
421
422
 
# File 'lib/jekyll/scholar/utilities.rb', line 414

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 



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

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

#relative ⇒ Object 



410
411
412
 
# File 'lib/jekyll/scholar/utilities.rb', line 410

def relative
  config['relative']
end

#render_bibliography(entry, index = nil) ⇒ Object 



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

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

#render_citation(items) ⇒ Object 



585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/jekyll/scholar/utilities.rb', line 585

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 



578
579
580
581
582
583
 
# File 'lib/jekyll/scholar/utilities.rb', line 578

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) 


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

def replace_strings?
  config['replace_strings']
end

#repository ⇒ Object 



346
347
348
 
# File 'lib/jekyll/scholar/utilities.rb', line 346

def repository
  @repository ||= load_repository
end

#repository? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#repository_link_for(entry, base = base_url) ⇒ Object 



551
552
553
554
555
556
557
558
 
# File 'lib/jekyll/scholar/utilities.rb', line 551

def repository_link_for(entry, base = base_url)
  links = repository[entry.key]
  url   = links['pdf'] || links['ps']

  return unless url

  File.join(base, url)
end

#repository_links_for(entry, base = base_url) ⇒ Object 



560
561
562
563
564
 
# File 'lib/jekyll/scholar/utilities.rb', line 560

def repository_links_for(entry, base = base_url)
  Hash[repository[entry.key].map { |ext, url|
    [ext, File.join(base, url)]
  }]
end

#repository_path ⇒ Object 



367
368
369
 
# File 'lib/jekyll/scholar/utilities.rb', line 367

def repository_path
  config['repository']
end

#scholar_source ⇒ Object 



401
402
403
404
405
406
407
408
 
# File 'lib/jekyll/scholar/utilities.rb', line 401

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 



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

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

#skip_sort? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#sort(unsorted) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/jekyll/scholar/utilities.rb', line 179

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 



199
200
201
202
203
204
205
206
 
# File 'lib/jekyll/scholar/utilities.rb', line 199

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 



208
209
210
211
212
213
214
 
# File 'lib/jekyll/scholar/utilities.rb', line 208

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 



24
25
26
27
28
29
30
31
32
 
# File 'lib/jekyll/scholar/utilities.rb', line 24

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 



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

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

#suppress_author? ⇒ Boolean

Returns:

  • (Boolean) 


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

def suppress_author?
  !!@suppress_author
end

#type_aliases ⇒ Object 



320
321
322
 
# File 'lib/jekyll/scholar/utilities.rb', line 320

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

#type_names ⇒ Object 



324
325
326
 
# File 'lib/jekyll/scholar/utilities.rb', line 324

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

#type_order ⇒ Object 



316
317
318
 
# File 'lib/jekyll/scholar/utilities.rb', line 316

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