utilities.rb 16.5 KB
Newer Older
Sylvester Keil's avatar
Sylvester Keil committed
1
module Jekyll
2
  class Scholar
3
    require 'date'
4

Sylvester Keil's avatar
Sylvester Keil committed
5 6 7 8
    # Load styles into static memory.
    # They should be thread safe as long as they are
    # treated as being read-only.
    STYLES = Hash.new do |h, k|
Sylvester Keil's avatar
Sylvester Keil committed
9 10 11
      style = CSL::Style.load k
      style = style.independent_parent unless style.independent?
      h[k.to_s] = style
Sylvester Keil's avatar
Sylvester Keil committed
12 13 14
    end


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

20

Sylvester Keil's avatar
Sylvester Keil committed
21
      attr_reader :config, :site, :context, :prefix, :text, :offset, :max, :relative
22 23


24 25 26 27 28 29 30 31 32 33

      def split_arguments(arguments)

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

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

        [args, opts]
      end
34 35 36 37 38 39 40 41 42

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

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

Sylvester Keil's avatar
Sylvester Keil committed
43 44 45 46
          opts.on('-C', '--cited_in_order') do |cited|
            @cited, @skip_sort = true, true
          end

Sylvester Keil's avatar
Sylvester Keil committed
47 48 49 50
          opts.on('-A', '--suppress_author') do |cited|
            @suppress_author = true
          end

51
          opts.on('-f', '--file FILE') do |file|
52 53
            @bibtex_files ||= []
            @bibtex_files << file
54 55 56 57
          end

          opts.on('-q', '--query QUERY') do |query|
            @query = query
58
          end
59 60 61 62 63

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

64
          opts.on('-r', '--relative RELATIVE') do |relative|
65 66
            @relative = relative.to_s.strip
          end
67

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

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

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

Sylvester Keil's avatar
Sylvester Keil committed
80
          opts.on('-m', '--max MAX') do |max|
81
            @max = max.to_i
Sylvester Keil's avatar
Sylvester Keil committed
82 83
          end

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

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

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

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

100 101 102
          opts.on('-T', '--template TEMPLATE') do |template|
            @bibliography_template = template
          end
103 104
        end

105
        argv = arguments.split(/(\B-[cCfqrptTsgGOlomA]|\B--(?:cited(_in_order)?|file|query|relative|prefix|text|style|group_(?:by|order)|type_order|template|locator|offset|max|suppress_author|))/)
106 107 108

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

110 111 112 113
      def locators
        @locators ||= []
      end

114 115 116 117 118 119 120 121 122
      def bibtex_files
        @bibtex_files ||= [config['bibliography']]
      end

      # :nodoc: backwards compatibility
      def bibtex_file
        bibtex_files[0]
      end

123
      def bibtex_options
Sylvester Keil's avatar
Sylvester Keil committed
124 125
        @bibtex_options ||=
          (config['bibtex_options'] || {}).symbolize_keys
126 127 128 129
      end

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

132 133 134 135 136 137 138
      def bibtex_paths
        @bibtex_paths ||= bibtex_files.map { |file|
          extend_path file
        }
      end

      # :nodoc: backwards compatibility
139
      def bibtex_path
140
        bibtex_paths[0]
141
      end
142

143
      def bibliography
144
        unless @bibliography
145
          @bibliography = BibTeX::Bibliography.parse(
146 147 148
            bibtex_paths.reduce('') { |s, p| s << IO.read(p) },
            bibtex_options
          )
149
          @bibliography.replace_strings if replace_strings?
150
          @bibliography.join if join_strings? && replace_strings?
151 152 153
        end

        @bibliography
154 155
      end

156 157 158 159
      def query
        interpolate @query
      end

160
      def entries
161 162
        sort bibliography[query || config['query']]
      end
163

egon w. stemle's avatar
egon w. stemle committed
164 165 166 167 168 169 170 171
      def offset
        @offset ||= 0
      end

      def max
        @max.nil? ? -1 : @max + offset - 1
      end

Sylvester Keil's avatar
Sylvester Keil committed
172
      def limit_entries?
egon w. stemle's avatar
egon w. stemle committed
173
        !offset.nil? || !max.nil?
Sylvester Keil's avatar
Sylvester Keil committed
174 175
      end

176
      def sort(unsorted)
Sylvester Keil's avatar
Sylvester Keil committed
177
        return unsorted if skip_sort?
178

179 180 181 182 183 184 185 186 187 188 189 190
        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
191
        end
192

193
        sorted
194
      end
195

196
      def sort_keys
197 198 199 200 201 202
        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 }
203 204
      end

205 206 207 208 209 210 211 212
      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

Patrick de Kok's avatar
Patrick de Kok committed
213
      def group_by
Sylvester Keil's avatar
Sylvester Keil committed
214
        @group_by ||= config['group_by']
215
      end
Sylvester Keil's avatar
Sylvester Keil committed
216

Patrick de Kok's avatar
Patrick de Kok committed
217 218 219 220
      def group?
        group_by != 'none'
      end

221
      def group(ungrouped)
222 223 224 225 226
        def grouper(items, keys, order)
          groups = items.group_by do |item|
            group_value(keys.first, item)
          end

227 228 229
          if keys.count == 1
            groups
          else
230 231
            groups.merge(groups) do |key, items|
              grouper(items, keys.drop(1), order.drop(1))
232 233 234
            end
          end
        end
235 236

        grouper(ungrouped, group_keys, group_order)
237
      end
Sylvester Keil's avatar
Sylvester Keil committed
238

239 240 241
      def group_keys
        return @group_keys unless @group_keys.nil?

Patrick de Kok's avatar
Patrick de Kok committed
242
        @group_keys = Array(group_by)
243 244 245 246
          .map { |key| key.to_s.split(/\s*,\s*/) }
          .flatten
          .map { |key| key == 'month' ? 'month_numeric' : key }
      end
Sylvester Keil's avatar
Sylvester Keil committed
247

248
      def group_order
249 250 251
        self.group_order = config['group_order'] if @group_order.nil?
        @group_order
      end
252

253 254
      def group_order=(value)
        @group_order = Array(value)
255 256 257
          .map { |key| key.to_s.split(/\s*,\s*/) }
          .flatten
      end
Sylvester Keil's avatar
Sylvester Keil committed
258

259
      def group_compare(key,v1,v2)
260 261
        case key
        when 'type'
262 263 264 265 266 267 268 269 270 271 272
          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
273
        else
274
          v1 <=> v2
275 276
        end
      end
Sylvester Keil's avatar
Sylvester Keil committed
277

278 279 280
      def group_value(key,item)
        case key
        when 'type'
281
          type_aliases[item.type.to_s] || item.type.to_s
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
        else
          value = item[key]
          if value.numeric?
            value.to_i
          elsif value.date?
            value.to_date
          else
            value.to_s
          end
        end
      end

      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
301

302 303 304
      def group_name(key,value)
        case key
        when 'type'
305
          type_names[value] || value.to_s
306
        when 'month_numeric'
307
          month_names[value] || "(unknown)"
308 309 310 311
        else
          value.to_s
        end
      end
312 313 314 315 316

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

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

321 322 323 324 325 326 327 328
      def type_names
        @type_names ||= Scholar.defaults['type_names'].merge(config['type_names'])
      end

      def month_names
        return @month_names unless @month_names.nil?

        @month_names = config['month_names'].nil? ? Date::MONTHNAMES : config['month_names'].unshift(nil)
Hendrik van Antwerpen's avatar
Hendrik van Antwerpen committed
329
      end
330

Sylvester Keil's avatar
Sylvester Keil committed
331 332 333 334
      def suppress_author?
        !!@suppress_author
      end

Sylvester Keil's avatar
Sylvester Keil committed
335
      def raw_bibtex?
336
        config['use_raw_bibtex_entry']
Sylvester Keil's avatar
Sylvester Keil committed
337 338
      end

339 340 341 342 343 344 345 346 347
      def repository?
        !config['repository'].nil? && !config['repository'].empty?
      end

      def repository
        @repository ||= load_repository
      end

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

350 351 352 353 354 355 356 357
        return repo unless repository?

        Dir[File.join(repository_path, '**/*')].each do |path|
          extname = File.extname(path)
          repo[File.basename(path, extname)][extname[1..-1]] = path
        end

        repo
358 359 360 361 362 363
      end

      def repository_path
        config['repository']
      end

364 365 366 367
      def replace_strings?
        config['replace_strings']
      end

368 369 370 371
      def join_strings?
        config['join_strings']
      end

372 373 374 375
      def cited_only?
        !!@cited
      end

Sylvester Keil's avatar
Sylvester Keil committed
376 377 378 379
      def skip_sort?
        @skip_sort || config['sort_by'] == 'none'
      end

380 381
      def extend_path(name)
        if name.nil? || name.empty?
382
          name = config['bibliography']
383
        end
384

Sylvester Keil's avatar
Sylvester Keil committed
385 386
        # Return as is if it is an absolute path
        # Improve by using Pathname from stdlib?
387
        return name if name.start_with?('/') && File.exists?(name)
388

Sylvester Keil's avatar
Sylvester Keil committed
389 390 391 392 393 394 395 396 397 398 399 400
        name = File.join scholar_source, name
        name << '.bib' if File.extname(name).empty? && !File.exists?(name)
        name
      end

      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
401
      end
402

Sylvester Keil's avatar
Sylvester Keil committed
403
      def reference_tag(entry, index = nil)
Sylvester Keil's avatar
Sylvester Keil committed
404
        return missing_reference unless entry
405

406
        entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
Sylvester Keil's avatar
Sylvester Keil committed
407
        reference = render_bibliography entry, index
408

Sylvester Keil's avatar
Sylvester Keil committed
409 410 411 412
        content_tag reference_tagname, reference,
          :id => [prefix, entry.key].compact.join('-')
      end

413 414 415 416
      def style
        @style || config['style']
      end

Sylvester Keil's avatar
Sylvester Keil committed
417 418 419 420 421 422 423 424 425
      def missing_reference
        config['missing_reference']
      end

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

      def bibliography_template
426 427 428 429 430
        @bibliography_template || config['bibliography_template']
      end

      def liquid_template
        return @liquid_template if @liquid_template
egon w. stemle's avatar
egon w. stemle committed
431
        Liquid::Template.register_filter(Jekyll::Filters)
432

433
        tmp = bibliography_template
434 435

        case
436
        when tmp.nil?, tmp.empty?
437 438 439 440 441
          tmp = '{{reference}}'
        when site.layouts.key?(tmp)
          tmp = site.layouts[tmp].content
        end

442
        @liquid_template = Liquid::Template.parse(tmp)
Sylvester Keil's avatar
Sylvester Keil committed
443 444
      end

445
      def bibliography_tag(entry, index)
Sylvester Keil's avatar
Sylvester Keil committed
446 447
        return missing_reference unless entry

448
        liquid_template.render(
449 450 451 452 453 454 455 456 457 458 459
          reference_data(entry,index)
            .merge(site.site_payload)
            .merge({
              'index' => index,
              'details' => details_link_for(entry)
            }),
          {
            :registers => { :site => site },
            :filters => [Jekyll::Filters]
          }
        )
460 461 462 463
      end

      def reference_data(entry, index = nil)
        {
Sylvester Keil's avatar
Sylvester Keil committed
464
          'entry' => liquidify(entry),
Sylvester Keil's avatar
Sylvester Keil committed
465
          'reference' => reference_tag(entry, index),
466
          'key' => entry.key,
467
          'type' => entry.type.to_s,
468
          'link' => repository_link_for(entry),
469 470
          'links' => repository_links_for(entry)
        }
471 472
      end

Sylvester Keil's avatar
Sylvester Keil committed
473 474 475 476
      def liquidify(entry)
        e = {}

        e['key'] = entry.key
477
        e['type'] = entry.type.to_s
Sylvester Keil's avatar
Sylvester Keil committed
478

479 480 481
        if entry.field_names(config['bibtex_skip_fields']).empty?
          e['bibtex'] = entry.to_s
        else
Sylvester Keil's avatar
Sylvester Keil committed
482
          tmp = entry.dup
483 484 485 486 487

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

Sylvester Keil's avatar
Sylvester Keil committed
488 489
          e['bibtex'] = tmp.to_s
        end
Sylvester Keil's avatar
Sylvester Keil committed
490

Sylvester Keil's avatar
Sylvester Keil committed
491 492 493 494
        if raw_bibtex?
          e['bibtex'] = "{%raw%}#{e['bibtex']}{%endraw%}"
        end

Sylvester Keil's avatar
Sylvester Keil committed
495 496 497
        entry.fields.each do |key, value|
          value = value.convert(*bibtex_filters) unless bibtex_filters.empty?
          e[key.to_s] = value.to_s
498 499

          if value.is_a?(BibTeX::Names)
500
            e["#{key}_array"] = arr = []
501
            value.each.with_index do |name, idx|
502
              parts = {}
503 504
              name.each_pair do |k, v|
                e["#{key}_#{idx}_#{k}"] = v.to_s
505
                parts[k.to_s] = v.to_s
506
              end
507
              arr << parts
508 509
            end
          end
Sylvester Keil's avatar
Sylvester Keil committed
510 511 512 513 514
        end

        e
      end

515 516 517
      def bibtex_skip_fields
      end

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

522 523
      def details_file_for(entry)
        name = entry.key.to_s.dup
524

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

527
        if site.config['permalink'] == 'pretty'
528
          name << '/'
529 530 531
        else
          name << '.html'
        end
532
      end
533

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

538 539 540 541 542
        return unless url

        File.join(base, url)
      end

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

Sylvester Keil's avatar
Sylvester Keil committed
549
      def details_link_for(entry, base = base_url)
550
        File.join(base, details_path, details_file_for(entry))
Sylvester Keil's avatar
Sylvester Keil committed
551
      end
552

Sylvester Keil's avatar
Sylvester Keil committed
553
      def base_url
554
        @base_url ||= site.config['baseurl'] || site.config['base_url'] || ''
555
      end
556

557 558 559
      def details_path
        config['details_dir']
      end
560

561 562 563 564
      def renderer(force = false)
        return @renderer if @renderer && !force
          
        @renderer = CiteProc::Ruby::Renderer.new :format => 'html',
Sylvester Keil's avatar
Sylvester Keil committed
565 566
          :style => style, :locale => config['locale']
      end
567

568 569
      def render_citation(items)
        renderer.render items.zip(locators).map { |entry, locator|
Sylvester Keil's avatar
Sylvester Keil committed
570
          cited_keys << entry.key
Sylvester Keil's avatar
4.2.1  
Sylvester Keil committed
571
          cited_keys.uniq!
572

Sylvester Keil's avatar
Sylvester Keil committed
573
          item = citation_item_for entry, citation_number(entry.key)
574
          item.locator = locator
575

576 577
          item
        }, STYLES[style].citation
Sylvester Keil's avatar
Sylvester Keil committed
578 579
      end

Sylvester Keil's avatar
Sylvester Keil committed
580 581 582
      def render_bibliography(entry, index = nil)
        renderer.render citation_item_for(entry, index),
          STYLES[style].bibliography
Sylvester Keil's avatar
Sylvester Keil committed
583 584
      end

Sylvester Keil's avatar
Sylvester Keil committed
585
      def citation_item_for(entry, citation_number = nil)
Sylvester Keil's avatar
Sylvester Keil committed
586 587
        CiteProc::CitationItem.new id: entry.id do |c|
          c.data = CiteProc::Item.new entry.to_citeproc
Sylvester Keil's avatar
Sylvester Keil committed
588
          c.data[:'citation-number'] = citation_number
Sylvester Keil's avatar
Sylvester Keil committed
589
          c.data.suppress! 'author' if suppress_author?
Sylvester Keil's avatar
Sylvester Keil committed
590 591 592
        end
      end

593
      def cited_keys
594
        context['cited'] ||= []
595
      end
596

Sylvester Keil's avatar
Sylvester Keil committed
597 598
      def citation_number(key)
        (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
Sylvester Keil's avatar
Sylvester Keil committed
599 600
      end

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

605 606 607 608 609 610 611 612
      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
Sylvester Keil's avatar
Sylvester Keil committed
613
        end
614

615
        link_to link_target_for(keys[0]), render_citation(items)
Sylvester Keil's avatar
Sylvester Keil committed
616
      end
Sylvester Keil's avatar
Sylvester Keil committed
617

618
      def cite_details(key, text)
Hiren Patel's avatar
Hiren Patel committed
619
        if bibliography.key?(key)
Sylvester Keil's avatar
Sylvester Keil committed
620
          link_to details_link_for(bibliography[key]), text || config['details_link']
Hiren Patel's avatar
Hiren Patel committed
621
        else
622
          missing_reference
Hiren Patel's avatar
Hiren Patel committed
623 624
        end
      end
625

Sylvester Keil's avatar
Sylvester Keil committed
626 627 628 629 630 631
      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
632

Sylvester Keil's avatar
Sylvester Keil committed
633
        attributes = attributes.map { |k,v| %Q(#{k}="#{v}") }
634

Sylvester Keil's avatar
Sylvester Keil committed
635 636 637 638 639 640
        if content.nil?
          "<#{[name, attributes].flatten.compact.join(' ')}/>"
        else
          "<#{[name, attributes].flatten.compact.join(' ')}>#{content}</#{name}>"
        end
      end
641

Sylvester Keil's avatar
Sylvester Keil committed
642 643 644
      def link_to(href, content, attributes = {})
        content_tag :a, content || href, attributes.merge(:href => href)
      end
645

646 647 648 649
      def cited_references
        context && context['cited'] || []
      end

650 651
      def keys
        # De-reference keys (in case they are variables)
Sylvester Keil's avatar
Sylvester Keil committed
652 653
        # We need to do this every time, to support for loops,
        # where the context can change for each invocation.
654
        Array(@keys).map do |key|
655
          context[key] || key
656 657 658
        end
      end

659 660 661 662
      def interpolate(string)
        return unless string

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

Sylvester Keil's avatar
Sylvester Keil committed
667
      def set_context_to(context)
668
        @context, @site, = context, context.registers[:site]
Sylvester Keil's avatar
Sylvester Keil committed
669
        config.merge!(site.config['scholar'] || {})
670
        self
Sylvester Keil's avatar
Sylvester Keil committed
671
      end
672
    end
673

674
  end
Hiren Patel's avatar
Hiren Patel committed
675
end