utilities.rb 10.8 KB
Newer Older
Sylvester Keil's avatar
Sylvester Keil committed
1
module Jekyll
2
  class Scholar
3

Sylvester Keil's avatar
Sylvester Keil committed
4 5 6 7 8 9 10 11
    # 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|
      h[k.to_s] = CSL::Style.load k
    end


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

17
      attr_reader :config, :site, :context, :prefix, :text, :max
18 19 20 21 22 23 24 25 26 27

      def split_arguments(arguments)

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

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

        [args, opts]
      end
28 29 30 31 32 33 34 35 36

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

Sylvester Keil's avatar
Sylvester Keil committed
41 42 43 44
          opts.on('-A', '--suppress_author') do |cited|
            @suppress_author = true
          end

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

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

Sylvester Keil's avatar
Sylvester Keil committed
66 67 68 69
          opts.on('-m', '--max MAX') do |max|
            @max = max
          end

70 71
          opts.on('-s', '--style STYLE') do |style|
            @style = style
72
          end
73 74 75 76

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

Sylvester Keil's avatar
Sylvester Keil committed
79
        argv = arguments.split(/(\B-[cCfqptTslmA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|max|suppress_author|))/)
80 81 82

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

84 85 86 87
      def locators
        @locators ||= []
      end

88 89 90 91 92 93 94 95 96
      def bibtex_files
        @bibtex_files ||= [config['bibliography']]
      end

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

97
      def bibtex_options
98 99 100 101 102
        config['bibtex_options'] ||= {}
      end

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

105 106 107 108 109 110 111
      def bibtex_paths
        @bibtex_paths ||= bibtex_files.map { |file|
          extend_path file
        }
      end

      # :nodoc: backwards compatibility
112
      def bibtex_path
113
        bibtex_paths[0]
114
      end
115

116
      def bibliography
117
        unless @bibliography
118 119 120 121
          @bibliography = BibTeX.parse(
            bibtex_paths.reduce('') { |s, p| s << IO.read(p) },
            bibtex_options
          )
122
          @bibliography.replace_strings if replace_strings?
123
          @bibliography.join if join_strings? && replace_strings?
124 125 126
        end

        @bibliography
127 128
      end

129 130 131 132
      def query
        interpolate @query
      end

133
      def entries
134 135
        sort bibliography[query || config['query']]
      end
136

Sylvester Keil's avatar
Sylvester Keil committed
137 138 139 140
      def limit_entries?
        !max.nil?
      end

141
      def sort(unsorted)
Sylvester Keil's avatar
Sylvester Keil committed
142
        return unsorted if skip_sort?
143

144
        sorted = unsorted.sort_by { |e| e.values_at(*sort_keys) }
145 146
        sorted.reverse! if config['order'] =~ /^(desc|reverse)/i
        sorted
147
      end
148

149
      def sort_keys
150 151 152 153 154 155
        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 }
156 157
      end

Sylvester Keil's avatar
Sylvester Keil committed
158 159 160 161
      def suppress_author?
        !!@suppress_author
      end

162 163 164 165 166 167 168 169 170
      def repository?
        !config['repository'].nil? && !config['repository'].empty?
      end

      def repository
        @repository ||= load_repository
      end

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

173 174 175 176 177 178 179 180
        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
181 182 183 184 185 186
      end

      def repository_path
        config['repository']
      end

187 188 189 190
      def replace_strings?
        config['replace_strings']
      end

191 192 193 194
      def join_strings?
        config['join_strings']
      end

195 196 197 198
      def cited_only?
        !!@cited
      end

Sylvester Keil's avatar
Sylvester Keil committed
199 200 201 202
      def skip_sort?
        @skip_sort || config['sort_by'] == 'none'
      end

203 204
      def extend_path(name)
        if name.nil? || name.empty?
205
          name = config['bibliography']
206
        end
207

208 209
        # return as is if it is an absolute path
        return name if name.start_with?('/') && File.exists?(name)
210

211 212 213
        p = File.join(config['source'], name)
        p << '.bib' unless File.exists?(p)
        p
214
      end
215

Sylvester Keil's avatar
Sylvester Keil committed
216
      def reference_tag(entry, index = nil)
Sylvester Keil's avatar
Sylvester Keil committed
217
        return missing_reference unless entry
218

219
        entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
Sylvester Keil's avatar
Sylvester Keil committed
220
        reference = render_bibliography entry, index
221

Sylvester Keil's avatar
Sylvester Keil committed
222 223 224 225
        content_tag reference_tagname, reference,
          :id => [prefix, entry.key].compact.join('-')
      end

226 227 228 229
      def style
        @style || config['style']
      end

Sylvester Keil's avatar
Sylvester Keil committed
230 231 232 233 234 235 236 237 238
      def missing_reference
        config['missing_reference']
      end

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

      def bibliography_template
239 240 241 242 243
        @bibliography_template || config['bibliography_template']
      end

      def liquid_template
        return @liquid_template if @liquid_template
244

245
        tmp = bibliography_template
246 247

        case
248
        when tmp.nil?, tmp.empty?
249 250 251 252 253
          tmp = '{{reference}}'
        when site.layouts.key?(tmp)
          tmp = site.layouts[tmp].content
        end

254
        @liquid_template = Liquid::Template.parse(tmp)
Sylvester Keil's avatar
Sylvester Keil committed
255 256
      end

257
      def bibliography_tag(entry, index)
Sylvester Keil's avatar
Sylvester Keil committed
258 259
        return missing_reference unless entry

260
        liquid_template.render({
Sylvester Keil's avatar
Sylvester Keil committed
261
          'entry' => liquidify(entry),
Sylvester Keil's avatar
Sylvester Keil committed
262
          'reference' => reference_tag(entry, index),
263
          'key' => entry.key,
264
          'type' => entry.type.to_s,
265
          'link' => repository_link_for(entry),
266
          'links' => repository_links_for(entry),
267 268
          'index' => index,
          'details' => details_link_for(entry)
269
        })
270 271
      end

Sylvester Keil's avatar
Sylvester Keil committed
272 273 274 275
      def liquidify(entry)
        e = {}

        e['key'] = entry.key
276
        e['type'] = entry.type.to_s
Sylvester Keil's avatar
Sylvester Keil committed
277

Sylvester Keil's avatar
Sylvester Keil committed
278 279 280 281 282 283 284
        if entry.field?(:abstract)
          tmp = entry.dup
          tmp.delete :abstract
          e['bibtex'] = tmp.to_s
        else
          e['bibtex'] = entry.to_s
        end
Sylvester Keil's avatar
Sylvester Keil committed
285 286 287 288 289 290 291 292 293

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

        e
      end

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

298 299
      def details_file_for(entry)
        name = entry.key.to_s.dup
300

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

303 304
        [name, 'html'].join('.')
      end
305

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

310 311 312 313 314
        return unless url

        File.join(base, url)
      end

315 316 317 318 319 320
      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
321
      def details_link_for(entry, base = base_url)
322
        File.join(base, details_path, details_file_for(entry))
Sylvester Keil's avatar
Sylvester Keil committed
323
      end
324

Sylvester Keil's avatar
Sylvester Keil committed
325
      def base_url
326
        @base_url ||= site.config['baseurl'] || site.config['base_url'] || ''
327
      end
328

329 330 331
      def details_path
        config['details_dir']
      end
332

Sylvester Keil's avatar
Sylvester Keil committed
333 334 335 336
      def renderer
        @renderer ||= CiteProc::Ruby::Renderer.new :format => 'html',
          :style => style, :locale => config['locale']
      end
337

338 339
      def render_citation(items)
        renderer.render items.zip(locators).map { |entry, locator|
Sylvester Keil's avatar
Sylvester Keil committed
340
          cited_keys << entry.key
Sylvester Keil's avatar
4.2.1  
Sylvester Keil committed
341
          cited_keys.uniq!
342

Sylvester Keil's avatar
Sylvester Keil committed
343
          item = citation_item_for entry, citation_number(entry.key)
344
          item.locator = locator
345

346 347
          item
        }, STYLES[style].citation
Sylvester Keil's avatar
Sylvester Keil committed
348 349
      end

Sylvester Keil's avatar
Sylvester Keil committed
350 351 352
      def render_bibliography(entry, index = nil)
        renderer.render citation_item_for(entry, index),
          STYLES[style].bibliography
Sylvester Keil's avatar
Sylvester Keil committed
353 354
      end

Sylvester Keil's avatar
Sylvester Keil committed
355
      def citation_item_for(entry, citation_number = nil)
Sylvester Keil's avatar
Sylvester Keil committed
356 357
        CiteProc::CitationItem.new id: entry.id do |c|
          c.data = CiteProc::Item.new entry.to_citeproc
Sylvester Keil's avatar
Sylvester Keil committed
358
          c.data[:'citation-number'] = citation_number
Sylvester Keil's avatar
Sylvester Keil committed
359
          c.data.suppress! 'author' if suppress_author?
Sylvester Keil's avatar
Sylvester Keil committed
360 361 362
        end
      end

363
      def cited_keys
364
        context['cited'] ||= []
365
      end
366

Sylvester Keil's avatar
Sylvester Keil committed
367 368
      def citation_number(key)
        (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
Sylvester Keil's avatar
Sylvester Keil committed
369 370
      end

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

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

384
      def cite_details(key, text)
Hiren Patel's avatar
Hiren Patel committed
385
        if bibliography.key?(key)
Sylvester Keil's avatar
Sylvester Keil committed
386
          link_to details_link_for(bibliography[key]), text || config['details_link']
Hiren Patel's avatar
Hiren Patel committed
387
        else
388
          missing_reference
Hiren Patel's avatar
Hiren Patel committed
389 390
        end
      end
391

Sylvester Keil's avatar
Sylvester Keil committed
392 393 394 395 396 397
      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
398

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

Sylvester Keil's avatar
Sylvester Keil committed
401 402 403 404 405 406
        if content.nil?
          "<#{[name, attributes].flatten.compact.join(' ')}/>"
        else
          "<#{[name, attributes].flatten.compact.join(' ')}>#{content}</#{name}>"
        end
      end
407

Sylvester Keil's avatar
Sylvester Keil committed
408 409 410
      def link_to(href, content, attributes = {})
        content_tag :a, content || href, attributes.merge(:href => href)
      end
411

412 413 414 415
      def cited_references
        context && context['cited'] || []
      end

416 417
      def keys
        # De-reference keys (in case they are variables)
Sylvester Keil's avatar
Sylvester Keil committed
418 419
        # We need to do this every time, to support for loops,
        # where the context can change for each invocation.
420 421 422 423 424
        Array(@keys).map do |key|
          context.send(:resolve, key) || key
        end
      end

425 426 427 428 429 430 431 432
      def interpolate(string)
        return unless string

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

Sylvester Keil's avatar
Sylvester Keil committed
433
      def set_context_to(context)
434
        @context, @site, = context, context.registers[:site]
Sylvester Keil's avatar
Sylvester Keil committed
435
        config.merge!(site.config['scholar'] || {})
436
        self
Sylvester Keil's avatar
Sylvester Keil committed
437
      end
438
    end
439

440
  end
Hiren Patel's avatar
Hiren Patel committed
441
end