Class: TimeFrame

Inherits:
Object
  • Object
show all
Defined in:
lib/time_frame/version.rb,
lib/time_frame/empty.rb,
lib/time_frame/tree_node.rb,
lib/time_frame/collection.rb,
lib/time_frame/time_frame.rb,
lib/time_frame/time_frame_uniter.rb,
lib/time_frame/time_frame_covered.rb,
lib/time_frame/time_frame_handler.rb,
lib/time_frame/time_frame_overlaps.rb,
lib/time_frame/time_frame_splitter.rb

Overview

The time frame class provides an specialized and enhanced range for time values.

Direct Known Subclasses

Empty

Defined Under Namespace

Classes: Collection, CoveredFrame, Empty, Handler, Overlaps, Splitter, Uniter

Constant Summary collapse

VERSION = 
'0.5.0'
EMPTY = 
Empty.instance

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ TimeFrame

Returns a new instance of TimeFrame.



13
14
15
16
17
18
19
 
# File 'lib/time_frame/time_frame.rb', line 13

def initialize(args)
  min = args.fetch(:min)
  max = args.fetch(:max) { min + args.fetch(:duration) }
  check_bounds(max, min)
  @max = max
  @min = min
end

Instance Attribute Details

#max ⇒ Object (readonly)

Returns the value of attribute max.



9
10
11
 
# File 'lib/time_frame/time_frame.rb', line 9

def max
  @max
end

#min ⇒ Object (readonly)

Returns the value of attribute min.



9
10
11
 
# File 'lib/time_frame/time_frame.rb', line 9

def min
  @min
end

Class Method Details

.covering_time_frame_for(time_frames) ⇒ Object 



125
126
127
 
# File 'lib/time_frame/time_frame.rb', line 125

def self.covering_time_frame_for(time_frames)
  CoveredFrame.new(time_frames).frame
end

.each_overlap(frames1, frames2) ⇒ Object 



129
130
131
132
133
 
# File 'lib/time_frame/time_frame.rb', line 129

def self.each_overlap(frames1, frames2)
  Overlaps.new(frames1, frames2).each do |first, second|
    yield(first, second)
  end
end

.intersection(time_frames) ⇒ Object 



84
85
86
87
88
 
# File 'lib/time_frame/time_frame.rb', line 84

def self.intersection(time_frames)
  time_frames.reduce(time_frames.first) do |intersection, time_frame|
    intersection & time_frame
  end
end

.union(time_frames, options = {}) ⇒ Object 



80
81
82
 
# File 'lib/time_frame/time_frame.rb', line 80

def self.union(time_frames, options = {})
  Uniter.new(time_frames, options).unite
end

Instance Method Details

#&(other) ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/time_frame/time_frame.rb', line 96

def &(other)
  return EMPTY if other.empty?
  new_min = [min, other.min].max
  new_max = [max, other.max].min
  new_min <= new_max ? TimeFrame.new(min: new_min, max: new_max) : EMPTY
end

#==(other) ⇒ Object Also known as: eql? 



25
26
27
28
 
# File 'lib/time_frame/time_frame.rb', line 25

def ==(other)
  min == other.min &&
    max == other.max
end

#after?(item) ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
57
58
59
60
61
62
 
# File 'lib/time_frame/time_frame.rb', line 54

def after?(item)
  case
  when rangy?(item)
    fail_if_empty item
    item.max < min
  else
    item < min
  end
end

#before?(item) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
52
 
# File 'lib/time_frame/time_frame.rb', line 44

def before?(item)
  case
  when rangy?(item)
    fail_if_empty item
    item.min > max
  else
    item > max
  end
end

#cover?(element) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
39
40
41
42
 
# File 'lib/time_frame/time_frame.rb', line 36

def cover?(element)
  if rangy?(element)
    element.empty? || min <= element.min && element.max <= max
  else
    min <= element && element <= max
  end
end

#duration ⇒ Object 



21
22
23
 
# File 'lib/time_frame/time_frame.rb', line 21

def duration
  (max - min).seconds
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/time_frame/time_frame.rb', line 76

def empty?
  false
end

#hash ⇒ Object 



32
33
34
 
# File 'lib/time_frame/time_frame.rb', line 32

def hash
  [min, max].hash
end

#inspect ⇒ Object 



135
136
137
 
# File 'lib/time_frame/time_frame.rb', line 135

def inspect
  "#{min}..#{max}"
end

#overlaps?(other) ⇒ Boolean

Returns true if the interior intersect.

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'lib/time_frame/time_frame.rb', line 91

def overlaps?(other)
  return false if other.duration == 0
  other.max > min && other.min < max
end

#shift_by(duration) ⇒ Object 



103
104
105
 
# File 'lib/time_frame/time_frame.rb', line 103

def shift_by(duration)
  TimeFrame.new(min: @min + duration, duration: self.duration)
end

#shift_to(time) ⇒ Object 



107
108
109
 
# File 'lib/time_frame/time_frame.rb', line 107

def shift_to(time)
  TimeFrame.new(min: time, duration: duration)
end

#split_by_interval(interval) ⇒ Object 



121
122
123
 
# File 'lib/time_frame/time_frame.rb', line 121

def split_by_interval(interval)
  Splitter.new(self).split_by interval
end

#time_between(item) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/time_frame/time_frame.rb', line 64

def time_between(item)
  case
  when rangy?(item)
    fail_if_empty item
    [time_between(item.min), time_between(item.max)].min_by(&:abs)
  when cover?(item)
    0
  else
    [(item - min).abs, (item - max).abs].min
  end
end

#without(*args) ⇒ Object 



111
112
113
114
115
116
117
118
119
 
# File 'lib/time_frame/time_frame.rb', line 111

def without(*args)
  frames = args.select { |frame| overlaps?(frame) }
  frames = TimeFrame.union(frames)

  frames.reduce([self]) do |result, frame_to_exclude|
    last_frame = result.pop
    result + last_frame.without_frame(frame_to_exclude)
  end
end