Class: Jekyll::J1LunrSearch::SearchEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/starter_web/_plugins/index/lunr.rb

Overview

noinspection RubyTooManyInstanceVariablesInspection

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(title, tagline, url, date, tags, categories, description, is_post, body, collection) ⇒ SearchEntry

Returns a new instance of SearchEntry.



360
361
362
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 360

def initialize(title, tagline, url, date, tags, categories, description, is_post, body, collection)
  @title, @tagline, @url, @date,@tags,  @categories, @description, @is_post, @body, @collection = title, tagline, url, date, tags, categories, description, is_post, body, collection
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def body
  @body
end

#categories ⇒ Object (readonly)

Returns the value of attribute categories.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def categories
  @categories
end

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def collection
  @collection
end

#date ⇒ Object (readonly)

Returns the value of attribute date.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def date
  @date
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def description
  @description
end

#is_post ⇒ Object (readonly)

Returns the value of attribute is_post.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def is_post
  @is_post
end

#tagline ⇒ Object (readonly)

Returns the value of attribute tagline.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def tagline
  @tagline
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def tags
  @tags
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def title
  @title
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



358
359
360
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 358

def url
  @url
end

Class Method Details

.create(site, renderer) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 307

def self.create(site, renderer)
  if site.is_a?(Jekyll::Page) or site.is_a?(Jekyll::Document)

    if defined?(site.date)
      date = site.date
    elsif defined?(site.data['date'])
      date = site.data['date']
    else
      date = '2022-01-01 00:00:00'
    end

    tagline           = site.data['tagline']
    tags              = site.data['tags']
    categories        = site.data['categories']
    description       = site.data['description']
    title, url        = extract_title_and_url(site)
    is_post           = site.is_a?(Jekyll::Document)
    body              = renderer.render(site)

    # For posts, the description is taken from the excerpt
    if site.is_a?(Jekyll::Document)
      excerpt = extract_excerpt(site)
      unless excerpt.nil? || excerpt.length == 0
        description = excerpt
      end
    end

    if description.nil? || description.length == 0
      description = 'No description available.'
    end

    SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)

  else
    raise 'Not supported'
  end
end

.extract_excerpt(item) ⇒ Object 



350
351
352
353
354
355
356
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 350

def self.extract_excerpt(item)
  data = item.to_liquid
  parsed_data = Nokogiri::HTML.parse(data['excerpt']).text
  parsed_data.gsub!(/\n+/, ' ')
  parsed_data.gsub!(/^\s+/, '')
  parsed_data.gsub!(/\s+$/, '')
end

.extract_title_and_url(item) ⇒ Object 



345
346
347
348
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 345

def self.extract_title_and_url(item)
  data = item.to_liquid
  [ data['title'], data['url'] ]
end

Instance Method Details

#strip_index_suffix_from_url! ⇒ Object 



364
365
366
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 364

def strip_index_suffix_from_url!
  @url.gsub!(/index\.html$/, '')
end

#strip_stopwords!(stopwords, min_length) ⇒ Object

remove anything that is in the stop words list from the text to be indexed



371
372
373
374
375
376
377
 
# File 'lib/starter_web/_plugins/index/lunr.rb', line 371

def strip_stopwords!(stopwords, min_length)
  #noinspection RubyParenthesesAfterMethodCallInspection
  @body = @body.split.delete_if() do |x|
    t = x.downcase.gsub(/[^a-z]/, '')
    t.length < min_length || stopwords.include?(t)
  end.join(' ')
end