Class: Jekyll::Plugins::PaginateV3::Pagination::TrailReference

Inherits:
IndexReference
  • Object
show all
Defined in:
lib/jekyll-paginate-v3/pagination/paginator/trail_reference.rb

Overview

Liquid-facing trail object used by paginator.trail.

Extends IndexReference with current-page markers and relative distance.

Instance Attribute Summary collapse

Attributes inherited from IndexReference

#num, #page

Instance Method Summary collapse

Methods inherited from IndexReference

#count, #liquid_method_missing, #start

Constructor Details

#initialize(num:, page_object:, item_count:, start_item_index:, end_item_index:, current:, distance:) ⇒ TrailReference

Stores trail metadata for one visible trail index entry.



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/jekyll-paginate-v3/pagination/paginator/trail_reference.rb', line 15

def initialize(num:, page_object:, item_count:, start_item_index:, end_item_index:, current:, distance:)
	super(
		num: num,
		page_object: page_object,
		item_count: item_count,
		start_item_index: start_item_index,
		end_item_index: end_item_index
	)
	@current = !!current
	@distance = distance.to_i
end

Instance Attribute Details

#current ⇒ Object (readonly)

Returns the value of attribute current.



12
13
14
 
# File 'lib/jekyll-paginate-v3/pagination/paginator/trail_reference.rb', line 12

def current
  @current
end

#distance ⇒ Object (readonly)

Returns the value of attribute distance.



12
13
14
 
# File 'lib/jekyll-paginate-v3/pagination/paginator/trail_reference.rb', line 12

def distance
  @distance
end

Instance Method Details

#to_h ⇒ Object

Hash form used by specs and non-Liquid inspection.



28
29
30
31
32
33
 
# File 'lib/jekyll-paginate-v3/pagination/paginator/trail_reference.rb', line 28

def to_h
	super.merge(
		'current' => current,
		'distance' => distance
	)
end