utilities.rb 16 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
      attr_reader :config, :site, :context, :prefix, :text, :offset, :max
21 22 23 24 25 26 27 28 29 30

      def split_arguments(arguments)

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

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

        [args, opts]
      end
31 32 33 34 35 36 37 38 39

      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
40 41 42 43
          opts.on('-C', '--cited_in_order') do |cited|
            @cited, @skip_sort = true, true
          end

Sylvester Keil's avatar
Sylvester Keil committed
44 45 46 47
          opts.on('-A', '--suppress_author') do |cited|
            @suppress_author = true
          end

48
          opts.on('-f', '--file FILE') do |file|
49 50
            @bibtex_files ||= []
            @bibtex_files << file
51 52 53 54 55 56 57 58 59 60 61 62 63
          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
64

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

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

Sylvester Keil's avatar
Sylvester Keil committed
73
          opts.on('-m', '--max MAX') do |max|
74
            @max = max.to_i
Sylvester Keil's avatar
Sylvester Keil committed
75 76
          end

77 78
          opts.on('-s', '--style STYLE') do |style|
            @style = style
79
          end
80 81 82 83

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

86
        argv = arguments.split(/(\B-[cCfqptTslomA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|offset|max|suppress_author|))/)
87 88 89

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

91 92 93 94
      def locators
        @locators ||= []
      end

95 96 97 98 99 100 101 102 103
      def bibtex_files
        @bibtex_files ||= [config['bibliography']]
      end

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

104
      def bibtex_options
Sylvester Keil's avatar
Sylvester Keil committed
105 106
        @bibtex_options ||=
          (config['bibtex_options'] || {}).symbolize_keys
107 108 109 110
      end

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

113 114 115 116 117 118 119
      def bibtex_paths
        @bibtex_paths ||= bibtex_files.map { |file|
          extend_path file
        }
      end

      # :nodoc: backwards compatibility
120
      def bibtex_path
121
        bibtex_paths[0]
122
      end
123

124
      def bibliography
125
        unless @bibliography
126
          @bibliography = BibTeX::Bibliography.parse(
127 128 129
            bibtex_paths.reduce('') { |s, p| s << IO.read(p) },
            bibtex_options
          )
130
          @bibliography.replace_strings if replace_strings?
131
          @bibliography.join if join_strings? && replace_strings?
132 133 134
        end

        @bibliography
135 136
      end

137 138 139 140
      def query
        interpolate @query
      end

141
      def entries
142 143
        sort bibliography[query || config['query']]
      end
144

egon w. stemle's avatar
egon w. stemle committed
145 146 147 148 149 150 151 152
      def offset
        @offset ||= 0
      end

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

Sylvester Keil's avatar
Sylvester Keil committed
153
      def limit_entries?
egon w. stemle's avatar
egon w. stemle committed
154
        !offset.nil? || !max.nil?
Sylvester Keil's avatar
Sylvester Keil committed
155 156
      end

157
      def sort(unsorted)
Sylvester Keil's avatar
Sylvester Keil committed
158
        return unsorted if skip_sort?
159

160 161 162 163 164 165 166 167 168 169 170 171
        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
172
        end
173
 
174
        sorted
175
      end
176

177
      def sort_keys
178 179 180 181 182 183
        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 }
184 185
      end

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
      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

      def group?
        config['group_by'] != 'none'
      end
 
      def group(ungrouped)
        def grouper(items,keys,order)
          groups = items
            .group_by do |item|
              group_value(keys.first,item)
            end
            .sort do |e1, e2|
205
              if (order.first || group_order.last) =~ /^(desc|reverse)/i
206
                group_compare(keys.first,e2[0],e1[0])
207
              else
208
                group_compare(keys.first,e1[0],e2[0])
209 210 211 212 213 214 215
              end
            end
            .to_h
          if keys.count == 1
            groups
          else
            groups.merge(groups) do |key,items|
216
              grouper(items,keys.drop(1),order.drop(1))
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
            end
          end
        end
        grouper(ungrouped,group_keys,group_order)
      end
 
      def group_keys
        return @group_keys unless @group_keys.nil?

        @group_keys = Array(config['group_by'])
          .map { |key| key.to_s.split(/\s*,\s*/) }
          .flatten
          .map { |key| key == 'month' ? 'month_numeric' : key }
      end
 
      def group_order
        return @group_order unless @group_order.nil?

        @group_order = Array(config['group_order'])
          .map { |key| key.to_s.split(/\s*,\s*/) }
          .flatten
      end
 
240
      def group_compare(key,v1,v2)
241 242
        case key
        when 'type'
243 244 245 246 247 248 249 250 251 252 253
          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
254
        else
255
          v1 <=> v2
256 257 258 259 260 261
        end
      end
      
      def group_value(key,item)
        case key
        when 'type'
262
          type_aliases[item.type.to_s] || item.type.to_s
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
        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
 
      def group_name(key,value)
        case key
        when 'type'
286
          type_names[value] || value.to_s
287
        when 'month_numeric'
288
          month_names[value] || "(unknown)"
289 290 291 292
        else
          value.to_s
        end
      end
293 294 295 296 297

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

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

302 303 304 305 306 307 308 309
      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
310
      end
311

Sylvester Keil's avatar
Sylvester Keil committed
312 313 314 315
      def suppress_author?
        !!@suppress_author
      end

Sylvester Keil's avatar
Sylvester Keil committed
316
      def raw_bibtex?
317
        config['use_raw_bibtex_entry']
Sylvester Keil's avatar
Sylvester Keil committed
318 319
      end

320 321 322 323 324 325 326 327 328
      def repository?
        !config['repository'].nil? && !config['repository'].empty?
      end

      def repository
        @repository ||= load_repository
      end

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

331 332 333 334 335 336 337 338
        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
339 340 341 342 343 344
      end

      def repository_path
        config['repository']
      end

345 346 347 348
      def replace_strings?
        config['replace_strings']
      end

349 350 351 352
      def join_strings?
        config['join_strings']
      end

353 354 355 356
      def cited_only?
        !!@cited
      end

Sylvester Keil's avatar
Sylvester Keil committed
357 358 359 360
      def skip_sort?
        @skip_sort || config['sort_by'] == 'none'
      end

361 362
      def extend_path(name)
        if name.nil? || name.empty?
363
          name = config['bibliography']
364
        end
365

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

370 371 372 373 374 375 376 377 378 379 380 381
        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
382
      end
383

Sylvester Keil's avatar
Sylvester Keil committed
384
      def reference_tag(entry, index = nil)
Sylvester Keil's avatar
Sylvester Keil committed
385
        return missing_reference unless entry
386

387
        entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
Sylvester Keil's avatar
Sylvester Keil committed
388
        reference = render_bibliography entry, index
389

Sylvester Keil's avatar
Sylvester Keil committed
390 391 392 393
        content_tag reference_tagname, reference,
          :id => [prefix, entry.key].compact.join('-')
      end

394 395 396 397
      def style
        @style || config['style']
      end

Sylvester Keil's avatar
Sylvester Keil committed
398 399 400 401 402 403 404 405 406
      def missing_reference
        config['missing_reference']
      end

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

      def bibliography_template
407 408 409 410 411
        @bibliography_template || config['bibliography_template']
      end

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

414
        tmp = bibliography_template
415 416

        case
417
        when tmp.nil?, tmp.empty?
418 419 420 421 422
          tmp = '{{reference}}'
        when site.layouts.key?(tmp)
          tmp = site.layouts[tmp].content
        end

423
        @liquid_template = Liquid::Template.parse(tmp)
Sylvester Keil's avatar
Sylvester Keil committed
424 425
      end

426
      def bibliography_tag(entry, index)
Sylvester Keil's avatar
Sylvester Keil committed
427 428
        return missing_reference unless entry

429
        liquid_template.render(
430 431 432 433 434 435 436 437 438 439 440
          reference_data(entry,index)
            .merge(site.site_payload)
            .merge({
              'index' => index,
              'details' => details_link_for(entry)
            }),
          {
            :registers => { :site => site },
            :filters => [Jekyll::Filters]
          }
        )
441 442 443 444
      end

      def reference_data(entry, index = nil)
        {
Sylvester Keil's avatar
Sylvester Keil committed
445
          'entry' => liquidify(entry),
Sylvester Keil's avatar
Sylvester Keil committed
446
          'reference' => reference_tag(entry, index),
447
          'key' => entry.key,
448
          'type' => entry.type.to_s,
449
          'link' => repository_link_for(entry),
450 451
          'links' => repository_links_for(entry)
        }
452 453
      end

Sylvester Keil's avatar
Sylvester Keil committed
454 455 456 457
      def liquidify(entry)
        e = {}

        e['key'] = entry.key
458
        e['type'] = entry.type.to_s
Sylvester Keil's avatar
Sylvester Keil committed
459

460 461 462
        if entry.field_names(config['bibtex_skip_fields']).empty?
          e['bibtex'] = entry.to_s
        else
463
          tmp = entry.dup
464 465 466 467 468

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

469 470
          e['bibtex'] = tmp.to_s
        end
Sylvester Keil's avatar
Sylvester Keil committed
471

Sylvester Keil's avatar
Sylvester Keil committed
472 473 474 475
        if raw_bibtex?
          e['bibtex'] = "{%raw%}#{e['bibtex']}{%endraw%}"
        end

Sylvester Keil's avatar
Sylvester Keil committed
476 477 478
        entry.fields.each do |key, value|
          value = value.convert(*bibtex_filters) unless bibtex_filters.empty?
          e[key.to_s] = value.to_s
479 480 481 482 483 484 485 486

          if value.is_a?(BibTeX::Names)
            value.each.with_index do |name, idx|
              name.each_pair do |k, v|
                e["#{key}_#{idx}_#{k}"] = v.to_s
              end
            end
          end
Sylvester Keil's avatar
Sylvester Keil committed
487 488 489 490 491
        end

        e
      end

492 493 494
      def bibtex_skip_fields
      end

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

499 500
      def details_file_for(entry)
        name = entry.key.to_s.dup
501

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

504
        if site.config['permalink'] == 'pretty'
505
          name << '/'
506 507 508
        else
          name << '.html'
        end
509
      end
510

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

515 516 517 518 519
        return unless url

        File.join(base, url)
      end

520 521 522 523 524 525
      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
526
      def details_link_for(entry, base = base_url)
527
        File.join(base, details_path, details_file_for(entry))
Sylvester Keil's avatar
Sylvester Keil committed
528
      end
529

Sylvester Keil's avatar
Sylvester Keil committed
530
      def base_url
531
        @base_url ||= site.config['baseurl'] || site.config['base_url'] || ''
532
      end
533

534 535 536
      def details_path
        config['details_dir']
      end
537

538 539 540 541
      def renderer(force = false)
        return @renderer if @renderer && !force
          
        @renderer = CiteProc::Ruby::Renderer.new :format => 'html',
Sylvester Keil's avatar
Sylvester Keil committed
542 543
          :style => style, :locale => config['locale']
      end
544

545 546
      def render_citation(items)
        renderer.render items.zip(locators).map { |entry, locator|
Sylvester Keil's avatar
Sylvester Keil committed
547
          cited_keys << entry.key
Sylvester Keil's avatar
4.2.1  
Sylvester Keil committed
548
          cited_keys.uniq!
549

Sylvester Keil's avatar
Sylvester Keil committed
550
          item = citation_item_for entry, citation_number(entry.key)
551
          item.locator = locator
552

553 554
          item
        }, STYLES[style].citation
Sylvester Keil's avatar
Sylvester Keil committed
555 556
      end

Sylvester Keil's avatar
Sylvester Keil committed
557 558 559
      def render_bibliography(entry, index = nil)
        renderer.render citation_item_for(entry, index),
          STYLES[style].bibliography
Sylvester Keil's avatar
Sylvester Keil committed
560 561
      end

Sylvester Keil's avatar
Sylvester Keil committed
562
      def citation_item_for(entry, citation_number = nil)
Sylvester Keil's avatar
Sylvester Keil committed
563 564
        CiteProc::CitationItem.new id: entry.id do |c|
          c.data = CiteProc::Item.new entry.to_citeproc
Sylvester Keil's avatar
Sylvester Keil committed
565
          c.data[:'citation-number'] = citation_number
Sylvester Keil's avatar
Sylvester Keil committed
566
          c.data.suppress! 'author' if suppress_author?
Sylvester Keil's avatar
Sylvester Keil committed
567 568 569
        end
      end

570
      def cited_keys
571
        context['cited'] ||= []
572
      end
573

Sylvester Keil's avatar
Sylvester Keil committed
574 575
      def citation_number(key)
        (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
Sylvester Keil's avatar
Sylvester Keil committed
576 577
      end

578 579 580 581 582 583 584 585
      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
586
        end
587 588

        link_to "##{[prefix, keys[0]].compact.join('-')}", render_citation(items)
Sylvester Keil's avatar
Sylvester Keil committed
589
      end
Sylvester Keil's avatar
Sylvester Keil committed
590

591
      def cite_details(key, text)
Hiren Patel's avatar
Hiren Patel committed
592
        if bibliography.key?(key)
Sylvester Keil's avatar
Sylvester Keil committed
593
          link_to details_link_for(bibliography[key]), text || config['details_link']
Hiren Patel's avatar
Hiren Patel committed
594
        else
595
          missing_reference
Hiren Patel's avatar
Hiren Patel committed
596 597
        end
      end
598

Sylvester Keil's avatar
Sylvester Keil committed
599 600 601 602 603 604
      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
605

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

Sylvester Keil's avatar
Sylvester Keil committed
608 609 610 611 612 613
        if content.nil?
          "<#{[name, attributes].flatten.compact.join(' ')}/>"
        else
          "<#{[name, attributes].flatten.compact.join(' ')}>#{content}</#{name}>"
        end
      end
614

Sylvester Keil's avatar
Sylvester Keil committed
615 616 617
      def link_to(href, content, attributes = {})
        content_tag :a, content || href, attributes.merge(:href => href)
      end
618

619 620 621 622
      def cited_references
        context && context['cited'] || []
      end

623 624
      def keys
        # De-reference keys (in case they are variables)
Sylvester Keil's avatar
Sylvester Keil committed
625 626
        # We need to do this every time, to support for loops,
        # where the context can change for each invocation.
627
        Array(@keys).map do |key|
628
          context[key] || key
629 630 631
        end
      end

632 633 634 635
      def interpolate(string)
        return unless string

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

Sylvester Keil's avatar
Sylvester Keil committed
640
      def set_context_to(context)
641
        @context, @site, = context, context.registers[:site]
Sylvester Keil's avatar
Sylvester Keil committed
642
        config.merge!(site.config['scholar'] || {})
643
        self
Sylvester Keil's avatar
Sylvester Keil committed
644
      end
645
    end
646

647
  end
Hiren Patel's avatar
Hiren Patel committed
648
end