Module: Reading::Parsing::Attributes::Shared

Defined in:
lib/reading/parsing/attributes/shared.rb

Overview

Sub-attributes that are shared across multiple attributes.

Class Method Summary collapse

Class Method Details

.length(hash, format:, key_name: :length, episodic: false, ignore_repetitions: false) ⇒ Float, ...

Extracts the :length sub-attribute (pages or time) from the given hash.

Parameters:

  • hash (Hash) —

    any parsed hash that contains length.

  • format (Symbol) —

    the item format, which affects length in cases where Config.hash[:format] is customized.

  • key_name (Symbol) (defaults to: :length) —

    the first part of the keys to be checked.

  • episodic (Boolean) (defaults to: false) —

    whether to look for episodic (not total) length. If false, returns nil if hash contains :each. If true, returns a length only if hash contains :each or if it has repetitions, in which case repetitions are ignored. Examples of episodic lengths (before parsing) are “0:30 each” and “1:00 x14” (where the episodic length is 1:00). Examples of non-episodic lengths are “0:30” and “14:00”.

  • ignore_repetitions (Boolean) (defaults to: false) —

    if true, ignores repetitions so that e.g. “1:00 x14” gives a length of 1 hour instead of 14 hours. This is useful for the History column, where that 1 hour can be used as the default amount.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/reading/parsing/attributes/shared.rb', line 41

def self.length(hash, format:, key_name: :length, episodic: false, ignore_repetitions: false)
  return nil unless hash

  length = hash[:"#{key_name}_pages"]&.to_i ||
    hash[:"#{key_name}_time"]&.then { Item::TimeLength.parse(_1) }

  return nil unless length

  if hash[:each] && !hash[:repetitions]
    # Length is calculated based on History column in this case.
    if episodic
      return length
    else
      return nil
    end
  end

  if hash[:repetitions]
    return length if episodic
    length *= hash[:repetitions].to_i unless ignore_repetitions
  else
    return nil if episodic && !hash[:each]
  end

  speed = Config.hash.deep_fetch(:speed, :format)[format] || 1.0

  (length / speed).to_i_if_whole
end

.progress(hash, no_end_date: nil) ⇒ Float, ...

Extracts the :progress sub-attribute (percent, pages, or time) from the given hash.

Parameters:

  • hash (Hash) —

    any parsed hash that contains progress.

  • no_end_date (Boolean) (defaults to: nil) —

    for start and end dates (as opposed to the History column), whether an end date is present.

Returns:



15
16
17
18
19
20
21
22
23
 
# File 'lib/reading/parsing/attributes/shared.rb', line 15

def self.progress(hash, no_end_date: nil)
  hash[:progress_percent]&.to_f&./(100) ||
    hash[:progress_pages]&.to_i ||
    hash[:progress_time]&.then { Item::TimeLength.parse(_1) } ||
    (0 if hash[:progress_dnf]) ||
    (1.0 if hash[:progress_done]) ||
    (0.0 if no_end_date) ||
    nil
end