Class: Pagy::Calendar

Inherits:
Pagy
  • Object
show all
Includes:
FrontendHelpers::Calendar, I18nExtra::Calendar, OverflowExtra::Pagy
Defined in:
lib/pagy/calendar.rb,
lib/pagy/calendar/day.rb,
lib/pagy/calendar/week.rb,
lib/pagy/calendar/year.rb,
lib/pagy/calendar/month.rb,
lib/pagy/calendar/quarter.rb

Overview

:nodoc:

Direct Known Subclasses

Day, Month, Quarter, Week, Year

Defined Under Namespace

Classes: Day, Month, Quarter, Week, Year

Constant Summary collapse

UNITS =

List of units in desc order of duration. It can be used for custom units.

%i[year quarter month week day]

Constants inherited from Pagy

DEFAULT, ElasticsearchRails, LABEL_PLACEHOLDER, Meilisearch, PAGE_PLACEHOLDER, Searchkick, VERSION

Instance Attribute Summary collapse

Attributes inherited from Pagy

#count, #from, #in, #items, #last, #next, #offset, #page, #pages, #params, #prev, #to, #vars

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OverflowExtra::Pagy

#overflow?

Methods included from FrontendHelpers::Calendar

#label_sequels

Methods inherited from Pagy

root, #series

Methods included from SearchkickExtra::Pagy

#new_from_searchkick

Methods included from MeilisearchExtra::Pagy

#new_from_meilisearch

Methods included from ElasticsearchRailsExtra::Pagy

#new_from_elasticsearch_rails

Methods included from GearboxExtra

#setup_items_var, #setup_offset_var, #setup_pages_var

Methods included from FrontendHelpers::Pagy

#label_sequels, #sequels

Constructor Details

#initialize(vars) ⇒ Calendar

Merge and validate the options, do some simple arithmetic and set a few instance variables

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/pagy/calendar.rb', line 21

def initialize(vars) # rubocop:disable Lint/MissingSuper
  raise InternalError, 'Pagy::Calendar is a base class; use one of its subclasses' if instance_of?(Pagy::Calendar)

  vars = self.class::DEFAULT.merge(vars)  # subclass specific default
  normalize_vars(vars)                    # general default
  setup_vars(page: 1)
  setup_unit_vars
  setup_params_var
  raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last

  @prev = (@page - 1 unless @page == 1)
  @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
end

Instance Attribute Details

#order ⇒ Object (readonly)

rubocop:disable Style/MutableConstant



18
19
20
 
# File 'lib/pagy/calendar.rb', line 18

def order
  @order
end

Class Method Details

.create(unit, vars) ⇒ Object

Create a subclass instance by unit name (internal use)

Raises:



79
80
81
82
83
84
85
 
# File 'lib/pagy/calendar.rb', line 79

def create(unit, vars)
  raise InternalError, "unit must be in #{UNITS.inspect}; got #{unit}" unless UNITS.include?(unit)

  name    = unit.to_s
  name[0] = name[0].capitalize
  Object.const_get("Pagy::Calendar::#{name}").new(vars)
end

Instance Method Details

#label(opts = {}) ⇒ Object

The label for the current page (it can pass along the I18n gem opts when it’s used with the i18n extra)



36
37
38
 
# File 'lib/pagy/calendar.rb', line 36

def label(opts = {})
  label_for(@page, opts)
end

#label_for(page, opts = {}) ⇒ Object

The label for any page (it can pass along the I18n gem opts when it’s used with the i18n extra)



41
42
43
44
 
# File 'lib/pagy/calendar.rb', line 41

def label_for(page, opts = {})
  opts[:format] ||= @vars[:format]
  localize(starting_time_for(page.to_i), opts)  # page could be a string
end