Class: Fugit::Duration

Inherits:
Object
  • Object
show all
Defined in:
lib/fugit/duration.rb

Defined Under Namespace

Modules: IsoParser, Parser

Constant Summary collapse

KEYS = 
{
  yea: { a: 'Y', r: 'y', i: 'Y', s: 365 * 24 * 3600, x: 0, l: 'year' },
  mon: { a: 'M', r: 'M', i: 'M', s: 30 * 24 * 3600, x: 1, l: 'month' },
  wee: { a: 'W', r: 'w', i: 'W', s: 7 * 24 * 3600, I: true, l: 'week' },
  day: { a: 'D', r: 'd', i: 'D', s: 24 * 3600, I: true, l: 'day' },
  hou: { a: 'h', r: 'h', i: 'H', s: 3600, I: true, l: 'hour' },
  min: { a: 'm', r: 'm', i: 'M', s: 60, I: true, l: 'minute' },
  sec: { a: 's', r: 's', i: 'S', s: 1, I: true, l: 'second' },
}
SECOND_ROUND =

Round float seconds to 9 decimals when deflating

9

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#h ⇒ Object (readonly)

Returns the value of attribute h.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def h
  @h
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def options
  @options
end

#original ⇒ Object (readonly)

Returns the value of attribute original.



6
7
8
 
# File 'lib/fugit/duration.rb', line 6

def original
  @original
end

Class Method Details

.do_parse(s, opts = {}) ⇒ Object 



39
40
41
42
 
# File 'lib/fugit/duration.rb', line 39

def self.do_parse(s, opts={})

  parse(s, opts) || fail(ArgumentError.new("not a duration #{s.inspect}"))
end

.new(s) ⇒ Object 



8
9
10
11
 
# File 'lib/fugit/duration.rb', line 8

def self.new(s)

  parse(s)
end

.parse(s, opts = {}) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/fugit/duration.rb', line 13

def self.parse(s, opts={})

  return s if s.is_a?(self)

  original = s

  s = "#{s}s" if s.is_a?(Numeric)

  return nil unless s.is_a?(String)

  s = s.strip
#p [ original, s ]; Raabro.pp(Parser.parse(s, debug: 3), colours: true)

  h =
    if opts[:iso]
      IsoParser.parse(opts[:stricter] ? s : s.upcase)
    elsif opts[:plain]
      Parser.parse(s)
    else
      Parser.parse(s) || IsoParser.parse(opts[:stricter] ? s : s.upcase)
    end
#p h

  h ? self.allocate.send(:init, original, opts, h) : nil
end

.to_iso_s(o) ⇒ Object 



108
 
# File 'lib/fugit/duration.rb', line 108

def to_iso_s(o); do_parse(o).deflate.to_iso_s; end

.to_long_s(o, opts = {}) ⇒ Object 



109
 
# File 'lib/fugit/duration.rb', line 109

def to_long_s(o, opts={}); do_parse(o).deflate.to_long_s(opts); end

.to_plain_s(o) ⇒ Object 



107
 
# File 'lib/fugit/duration.rb', line 107

def to_plain_s(o); do_parse(o).deflate.to_plain_s; end

Instance Method Details

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



267
268
269
270
 
# File 'lib/fugit/duration.rb', line 267

def ==(o)

  o.is_a?(Fugit::Duration) && o.h == @h
end

#add(a) ⇒ Object Also known as: + 



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/fugit/duration.rb', line 241

def add(a)

  case a
  when Numeric then add_numeric(a)
  when Fugit::Duration then add_duration(a)
  when String then add_duration(self.class.parse(a))
  when ::Time, EtOrbi::EoTime then add_to_time(a)
  else fail ArgumentError.new(
    "cannot add #{a.class} instance to a Fugit::Duration")
  end
end

#add_duration(d) ⇒ Object 



202
203
204
205
206
207
 
# File 'lib/fugit/duration.rb', line 202

def add_duration(d)

  params = d.h.inject(@h.dup) { |h, (k, v)| h[k] = (h[k] || 0) + v; h }

  self.class.allocate.init(nil, {}, params)
end

#add_numeric(n) ⇒ Object 



194
195
196
197
198
199
200
 
# File 'lib/fugit/duration.rb', line 194

def add_numeric(n)

  h = @h.dup
  h[:sec] = (h[:sec] || 0) + n.to_i

  self.class.allocate.init(nil,{}, h)
end

#add_to_time(t) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/fugit/duration.rb', line 209

def add_to_time(t)

  t = ::EtOrbi.make_time(t)

  INFLA_KEYS.each do |k, a|

    v = @h[k]; next unless v

    t = t + v * a[:s]
  end

  NON_INFLA_KEYS.each do |k, a|

    v = @h[k]; next unless v
    at = [ t.year, t.month, t.day, t.hour, t.min, t.sec ]

    at[a[:x]] += v

    if at[1] > 12
      n, m = at[1] / 12, at[1] % 12
      at[0], at[1] = at[0] + n, m
    elsif at[1] < 1
      n, m = -at[1] / 12, -at[1] % 12
      at[0], at[1] = at[0] - n, m
    end

    t = ::EtOrbi.make_time(at, t.zone)
  end

  t
end

#deflate(options = {}) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/fugit/duration.rb', line 149

def deflate(options={})

  id = inflate
  h = id.h.dup
  s = h.delete(:sec) || 0

  keys = INFLA_KEYS

  mon = options[:month]
  yea = options[:year]
  keys = keys.dup if mon || yea

  if mon
    mon = 30 if mon == true
    mon = "#{mon}d" if mon.is_a?(Integer)
    keys.unshift([ :mon, { s: Fugit::Duration.parse(mon).to_sec } ])
  end
  if yea
    yea = 365 if yea == true
    yea = "#{yea}d" if yea.is_a?(Integer)
    keys.unshift([ :yea, { s: Fugit::Duration.parse(yea).to_sec } ])
  end

  keys[0..-2].each do |k, v|

    vs = v[:s]; next if s < vs

    h[k] = (h[k] || 0) + s.to_i / vs
    s = s % vs
  end

  h[:sec] = s.is_a?(Integer) ? s : s.round(SECOND_ROUND)

  self.class.allocate.init(@original, {}, h)
end

#drop_seconds ⇒ Object

Returns a copy of this duration, omitting its seconds.



285
286
287
288
289
290
291
292
 
# File 'lib/fugit/duration.rb', line 285

def drop_seconds

  h = @h.dup
  h.delete(:sec)
  h[:min] = 0 if h.empty?

  self.class.allocate.init(nil, { literal: true }, h)
end

#hash ⇒ Object 



273
274
275
276
 
# File 'lib/fugit/duration.rb', line 273

def hash

  @h.hash
end

#inflate ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/fugit/duration.rb', line 129

def inflate

  params =
    @h.inject({ sec: 0 }) { |h, (k, v)|
      a = KEYS[k]
      if a[:I]
        h[:sec] += (v * a[:s])
      else
        h[k] = v
      end
      h
    }

  self.class.allocate.init(@original, {}, params)
end

#next_time(from = ::EtOrbi::EoTime.now) ⇒ Object 



278
279
280
281
 
# File 'lib/fugit/duration.rb', line 278

def next_time(from=::EtOrbi::EoTime.now)

  add(from)
end

#opposite ⇒ Object Also known as: -@ 



185
186
187
188
189
190
 
# File 'lib/fugit/duration.rb', line 185

def opposite

  params = @h.inject({}) { |h, (k, v)| h[k] = -v; h }

  self.class.allocate.init(nil, {}, params)
end

#subtract(a) ⇒ Object Also known as: - 



254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/fugit/duration.rb', line 254

def subtract(a)

  case a
  when Numeric then add_numeric(-a)
  when Fugit::Duration then add_duration(-a)
  when String then add_duration(-self.class.parse(a))
  when ::Time, ::EtOrbi::EoTime then add_to_time(a)
  else fail ArgumentError.new(
    "cannot subtract #{a.class} instance to a Fugit::Duration")
  end
end

#to_h ⇒ Object

For now, let’s alias to #h



114
 
# File 'lib/fugit/duration.rb', line 114

def to_h; h; end

#to_iso_s ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fugit/duration.rb', line 70

def to_iso_s

  t = false

  s = StringIO.new
  s << 'P'

  KEYS.each_with_index do |(k, a), i|
    v = @h[k]; next unless v
    if i > 3 && t == false
      t = true
      s << 'T'
    end
    s << v.to_s; s << a[:i]
  end

  s.string
end

#to_long_s(opts = {}) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/fugit/duration.rb', line 89

def to_long_s(opts={})

  s = StringIO.new
  adn = [ false, 'no' ].include?(opts[:oxford]) ? ' and ' : ', and '

  a = @h.to_a
  while kv = a.shift
    k, v = kv
    aa = KEYS[k]
    s << v.to_i
    s << ' '; s << aa[:l]; s << 's' if v > 1
    s << (a.size == 1 ? adn : ', ') if a.size > 0
  end

  s.string
end

#to_plain_s ⇒ Object 



67
 
# File 'lib/fugit/duration.rb', line 67

def to_plain_s; _to_s(:a); end

#to_rufus_h ⇒ Object 



116
117
118
119
 
# File 'lib/fugit/duration.rb', line 116

def to_rufus_h

  KEYS.inject({}) { |h, (ks, kh)| v = @h[ks]; h[kh[:r].to_sym] = v if v; h }
end

#to_rufus_s ⇒ Object 



68
 
# File 'lib/fugit/duration.rb', line 68

def to_rufus_s; _to_s(:r); end

#to_sec ⇒ Object

Warning: this is an “approximation”, months are 30 days and years are 365 days, …



124
125
126
127
 
# File 'lib/fugit/duration.rb', line 124

def to_sec

  KEYS.inject(0) { |s, (k, a)| v = @h[k]; next s unless v; s += v * a[:s] }
end