Class: ScheduledValue::Timespan

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/scheduled_value/timespan.rb

Direct Known Subclasses

TimespanWithValue

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(start: nil, finish: nil) ⇒ Timespan

Returns a new instance of Timespan.



6
7
8
9
10
11
 
# File 'lib/scheduled_value/timespan.rb', line 6

def initialize(start: nil, finish: nil)
  @start = start
  @finish = finish

  raise "Finish must be after start" if start && finish && start >= finish
end

Instance Attribute Details

#finish ⇒ Object

Returns the value of attribute finish.



4
5
6
 
# File 'lib/scheduled_value/timespan.rb', line 4

def finish
  @finish
end

#start ⇒ Object

Returns the value of attribute start.



4
5
6
 
# File 'lib/scheduled_value/timespan.rb', line 4

def start
  @start
end

Instance Method Details

#<=>(other) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/scheduled_value/timespan.rb', line 42

def <=>(other)
  case other
  when Timespan then compare_timespan(other)
  when Date, Time, DateTime then compare_datetime(other)
  end
end

#attributes ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/scheduled_value/timespan.rb', line 13

def attributes
  {
    start: start,
    finish: finish
  }
end

#contains?(timestamp) ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
31
32
33
 
# File 'lib/scheduled_value/timespan.rb', line 28

def contains?(timestamp)
  return false if start && timestamp < start
  return false if finish && timestamp >= finish

  true
end

#finish_description(format = nil) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/scheduled_value/timespan.rb', line 65

def finish_description(format = nil)
  if finish
    "up to #{finish.to_s(format)}"
  elsif start
    "indefinitely"
  end
end

#inspect ⇒ Object 



49
50
51
 
# File 'lib/scheduled_value/timespan.rb', line 49

def inspect
  "#<#{self.class.name}: #{self}>"
end

#overlaps?(other) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
40
 
# File 'lib/scheduled_value/timespan.rb', line 35

def overlaps?(other)
  return false if finish && other.start && other.start >= finish
  return false if start && other.finish && start >= other.finish

  true
end

#start_description(format = nil) ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/scheduled_value/timespan.rb', line 57

def start_description(format = nil)
  if start
    "from #{start.to_s(format)}"
  else
    'anytime'
  end
end

#to_s(format = nil) ⇒ Object 



53
54
55
 
# File 'lib/scheduled_value/timespan.rb', line 53

def to_s(format = nil)
  "#{start_description(format)} #{finish_description(format)}"
end